diff --git a/.devcontainer.json b/.devcontainer.json index 10a610b4e7..c2812d7b6b 100644 --- a/.devcontainer.json +++ b/.devcontainer.json @@ -2,13 +2,12 @@ // For format details, see https://aka.ms/vscode-remote/devcontainer.json { "name": "docs.github.com", - "service": "container-doc", "settings": { "terminal.integrated.shell.linux": "/bin/bash", "cSpell.language": ",en" }, - // Install pre-requisites, and start to serve docs.github.com locally - "postCreateCommand": "npm install && npm start", + // Install pre-requisites and run a build to ensure we are ready to start serving docs.github.com locally (via `npm start`) + "postCreateCommand": "npm ci && npm run build", "forwardPorts": [4000], // Visual Studio Code extensions which help authoring for docs.github.com. "extensions": [ diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 9d87656bb8..b07cb1e945 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -1,12 +1,14 @@ # Order is important. The LAST matching pattern has the MOST precedence. # gitignore style patterns are used, not globs. -# https://help.github.com/articles/about-codeowners +# https://docs.github.com/articles/about-codeowners # https://git-scm.com/docs/gitignore # Engineering *.js @github/docs-engineering /.github/ @github/docs-engineering /script/ @github/docs-engineering +/includes/ @github/docs-engineering +/layouts/ @github/docs-engineering app.json @github/docs-engineering Dockerfile @github/docs-engineering package-lock.json @github/docs-engineering diff --git a/.github/ISSUE_COMMENT_TEMPLATE/target-date.yml b/.github/ISSUE_COMMENT_TEMPLATE/target-date.yml new file mode 100644 index 0000000000..1aaa0e3a08 --- /dev/null +++ b/.github/ISSUE_COMMENT_TEMPLATE/target-date.yml @@ -0,0 +1,14 @@ +--- +name: Target Date Update +about: Target date update +body: + - type: input + attributes: + name: Target completion date + placeholder: With context if the target completion date has changed + inputType: text + - type: input + attributes: + name: 'Attribution' + value: '_created with :heart: by typing_ `/status`' + inputType: text diff --git a/.github/ISSUE_TEMPLATE/partner-contributed-documentation.md b/.github/ISSUE_TEMPLATE/partner-contributed-documentation.md new file mode 100644 index 0000000000..bcc8053160 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/partner-contributed-documentation.md @@ -0,0 +1,45 @@ +--- +name: Partner-owned product documentation +about: Initiate a set of tasks to be completed by a GitHub partner wishing to document how their product works with GitHub +title: '' +labels: +- partner +assignees: '' +--- + + + +## Pre-requisites + +- [ ] Prior to submitting documentation, please apply to join the GitHub Technology Partner Program: [partner.github.com/apply](https://partner.github.com/apply?partnershipType=Technology+Partner). Please feel free to proceed once your application is approved. + +## Tasks + +Please be sure to complete each of the following: + +**Third-party product documentation:** + +- [ ] MUST follow our [general contributing guidelines](CONTRIBUTING.md) for voice and markup format. +- [ ] MUST emphasize how the third-party product works with GitHub. +- [ ] MUST be written in Markdown format, using [one of the templates provided](contributing/github-partners/README.md#templates) +- [ ] MUST include the name and URL of the GitHub technology partner responsible for maintenance of the documentation being contributed. This should be added via the `contributor.name` and `contributor.URL` properties in the template's YAML frontmatter. +- [ ] MUST be proposed via a pull request to this repo following [the GitHub Flow](https://guides.github.com/introduction/flow/). +- [ ] MUST be located in the root of [the `content` folder](content). Your filename MUST match the GitHub technology partner name, and use the `.md` file extension. + +**The `Pull Request`:** + +- [ ] MUST reference this issue, e.g. via `closes #` +- [ ] MUST pass the automated CI checks +- [ ] MUST include links to supporting material demonstrating the functionality being documented (this can be a link to a public GitHub repo, _or_ a video / screencast walkthrough) + +Once all tasks are completed, please mention `@github/docs-content` for next steps. + +/cc @github/partner-engineering for :eyes: diff --git a/.github/ISSUE_TEMPLATE/production-config-change.md b/.github/ISSUE_TEMPLATE/production-config-change.md new file mode 100644 index 0000000000..5096b3c64e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/production-config-change.md @@ -0,0 +1,24 @@ +--- +name: Change production configuration +about: Track changes to the production docs.github.com site +title: '' +labels: engineering +assignees: '' +--- + +A configuration change would be something outside of our code that we change with our production environment, such as environment variables, virtual machine tier or quantity, or service providers. + +- _Primary person_: +- _Second person_: +- _When_: +- _Zoom URL_: + +### What is the configuration change? + +### Why are we updating this configuration? + +### What risks are there with this configuration change? + +### If an issue happens, how do we roll back? + +Once the change is verified good, please close this issue. diff --git a/.github/allowed-actions.js b/.github/allowed-actions.js index f36a680b34..2aaed21b79 100644 --- a/.github/allowed-actions.js +++ b/.github/allowed-actions.js @@ -11,6 +11,8 @@ module.exports = [ "actions/setup-node@c46424eee26de4078d34105d3de3cc4992202b1e", //actions/setup-node@v2.1.4 "ruby/setup-ruby@fdcfbcf14ec9672f6f615cb9589a1bc5dd69d262", //ruby/setup-ruby@vv1.64.1 "actions/stale@9d6f46564a515a9ea11e7762ab3957ee58ca50da", //actions/stale@v3.0.16 + "alex-page/github-project-automation-plus@fdb7991b72040d611e1123d2b75ff10eda9372c9", + "andymckay/labeler@22d5392de2b725cea4b284df5824125054049d84", "archive/github-actions-slack@d368c5a4ad757515a9344918f84c490b05777d94", "ashley-taylor/regex-property-action@93a24f845cd20790924208225cc72da8b4c6d46d", "crowdin/github-action@fd9429dd63d6c0f8a8cb4b93ad8076990bd6e688", @@ -21,21 +23,22 @@ module.exports = [ "fkirc/skip-duplicate-actions@36feb0d8d062137530c2e00bd278d138fe191289", "github/codeql-action/analyze@v1", "github/codeql-action/init@v1", - "ianwalter/puppeteer-container@2466ba8ecf689ccf4e5dfadeff3ac2db227b2e17", "juliangruber/approve-pull-request-action@c530832d4d346c597332e20e03605aa94fa150a8", "juliangruber/find-pull-request-action@2fc55e82a6d5d36fe1e7f1848f7e64fd02d99de9", "juliangruber/read-file-action@e0a316da496006ffd19142f0fd594a1783f3b512", "lee-dohm/close-matching-issues@22002609b2555fe18f52b8e2e7c07cbf5529e8a8", + "octokit/graphql-action@5b3e01d42dee4509b0ac6b1cb2cf7778cdce85c2", "pascalgn/automerge-action@c9bd1823770819dc8fb8a5db2d11a3a95fbe9b07", //pascalgn/automerge@0.12.0 "peter-evans/create-issue-from-file@a04ce672e3acedb1f8e416b46716ddfd09905326", "peter-evans/create-or-update-comment@5221bf4aa615e5c6e95bb142f9673a9c791be2cd", "peter-evans/create-pull-request@8c603dbb04b917a9fc2dd991dc54fef54b640b43", "rachmari/actions-add-new-issue-to-column@1a459ef92308ba7c9c9dc2fcdd72f232495574a9", "rachmari/labeler@832d42ec5523f3c6d46e8168de71cd54363e3e2e", + "rachmari/puppeteer-container@6d56d6e132a3df76cf60bc290a4282f7fbaed05e", "repo-sync/github-sync@3832fe8e2be32372e1b3970bbae8e7079edeec88", "repo-sync/pull-request@33777245b1aace1a58c87a29c90321aa7a74bd7d", "someimportantcompany/github-actions-slack-message@0b470c14b39da4260ed9e3f9a4f1298a74ccdefd", "tjenkinson/gh-action-auto-merge-dependency-updates@4d7756c04d9d999c5968697a621b81c47f533d61", - "EndBug/add-and-commit@9358097a71ad9fb9e2f9624c6098c89193d83575", + "EndBug/add-and-commit@b3c7c1e078a023d75fb0bd326e02962575ce0519", "dorny/paths-filter@eb75a1edc117d3756a18ef89958ee59f9500ba58", ]; diff --git a/.github/commands/remove.yaml b/.github/commands/remove.yaml new file mode 100644 index 0000000000..e527282ee3 --- /dev/null +++ b/.github/commands/remove.yaml @@ -0,0 +1,10 @@ +trigger: remove-from-fr-board +title: Remove from FR board +description: Remove the current issue or pull request from the project board for the docs content first responder +surfaces: + - issue + - pull_request + - discussion +steps: + - type: repository_dispatch + eventType: remove_from_FR_board diff --git a/.github/workflows/browser-test.yml b/.github/workflows/browser-test.yml index 752c100f6e..70f518555a 100644 --- a/.github/workflows/browser-test.yml +++ b/.github/workflows/browser-test.yml @@ -39,12 +39,14 @@ jobs: - if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }} name: Install - uses: ianwalter/puppeteer-container@2466ba8ecf689ccf4e5dfadeff3ac2db227b2e17 + uses: rachmari/puppeteer-container@6d56d6e132a3df76cf60bc290a4282f7fbaed05e + timeout-minutes: 5 with: args: npm ci - if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }} name: Test - uses: ianwalter/puppeteer-container@2466ba8ecf689ccf4e5dfadeff3ac2db227b2e17 + timeout-minutes: 10 + uses: rachmari/puppeteer-container@6d56d6e132a3df76cf60bc290a4282f7fbaed05e with: args: npm run browser-test diff --git a/.github/workflows/build-docker-image.yml b/.github/workflows/build-docker-image.yml index dda06fef44..33ab553694 100644 --- a/.github/workflows/build-docker-image.yml +++ b/.github/workflows/build-docker-image.yml @@ -14,7 +14,7 @@ env: jobs: build: # Do not run this job for translations PRs - if: ${{ github.ref != 'refs/heads/translations' }} + if: ${{ github.head_ref != 'translations' && github.ref != 'refs/heads/translations' }} runs-on: ubuntu-latest steps: diff --git a/.github/workflows/close-external-repo-sync-prs.yml b/.github/workflows/close-external-repo-sync-prs.yml index c94e0cf889..ec287b239a 100644 --- a/.github/workflows/close-external-repo-sync-prs.yml +++ b/.github/workflows/close-external-repo-sync-prs.yml @@ -11,7 +11,7 @@ on: jobs: invalid-repo-sync-check: name: Close external Repo Sync PRs - if: ${{ github.repository == 'github/docs' && github.ref == 'refs/heads/repo-sync' }} + if: ${{ github.repository == 'github/docs' && github.head_ref == 'repo-sync' }} runs-on: ubuntu-latest steps: - uses: actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9 diff --git a/.github/workflows/link-check-dotcom.yml b/.github/workflows/link-check-dotcom.yml index bb057dd262..bee98f6380 100644 --- a/.github/workflows/link-check-dotcom.yml +++ b/.github/workflows/link-check-dotcom.yml @@ -47,7 +47,7 @@ jobs: # run: npm run heroku-postbuild # env: # DOCUBOT_REPO_PAT: ${{ secrets.DOCUBOT_REPO_PAT }} - # GIT_BRANCH: ${{ github.ref }} + # GIT_BRANCH: ${{ github.head_ref || github.ref }} - if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }} name: Build diff --git a/.github/workflows/link-check-ghae.yml b/.github/workflows/link-check-ghae.yml index ea35077e55..a94d939510 100644 --- a/.github/workflows/link-check-ghae.yml +++ b/.github/workflows/link-check-ghae.yml @@ -47,7 +47,7 @@ jobs: # run: npm run heroku-postbuild # env: # DOCUBOT_REPO_PAT: ${{ secrets.DOCUBOT_REPO_PAT }} - # GIT_BRANCH: ${{ github.ref }} + # GIT_BRANCH: ${{ github.head_ref || github.ref }} - if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }} name: Build diff --git a/.github/workflows/link-check-ghes.yml b/.github/workflows/link-check-ghes.yml index 36ed88e942..5049c89d0e 100644 --- a/.github/workflows/link-check-ghes.yml +++ b/.github/workflows/link-check-ghes.yml @@ -47,7 +47,7 @@ jobs: # run: npm run heroku-postbuild # env: # DOCUBOT_REPO_PAT: ${{ secrets.DOCUBOT_REPO_PAT }} - # GIT_BRANCH: ${{ github.ref }} + # GIT_BRANCH: ${{ github.head_ref || github.ref }} - if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }} name: Build diff --git a/.github/workflows/merged-notification.yml b/.github/workflows/merged-notification.yml index 270fd862a8..fa49a204d0 100644 --- a/.github/workflows/merged-notification.yml +++ b/.github/workflows/merged-notification.yml @@ -15,5 +15,5 @@ jobs: github.issues.createComment({ ...context.repo, issue_number: context.payload.pull_request.number, - body: 'Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our [help wanted issues](https://github.com/github/docs/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) :zap:' + body: "Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our [help wanted issues](https://github.com/github/docs/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) :zap:" }) diff --git a/.github/workflows/move-help-wanted-issues.yml b/.github/workflows/move-help-wanted-issues.yml new file mode 100644 index 0000000000..f6984f1d5a --- /dev/null +++ b/.github/workflows/move-help-wanted-issues.yml @@ -0,0 +1,17 @@ +name: Move help wanted issues +on: + issues: + types: + - labeled + +jobs: + move_issues: + if: github.repository == 'github/docs' && (github.event.label.name == 'help wanted' || github.event.label.name == 'good first issue') + runs-on: ubuntu-latest + + steps: + - uses: alex-page/github-project-automation-plus@fdb7991b72040d611e1123d2b75ff10eda9372c9 + with: + project: Docs team reviews + column: Help wanted + repo-token: ${{ secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES }} diff --git a/.github/workflows/move-ready-to-merge-issues.yaml b/.github/workflows/move-ready-to-merge-issues.yaml new file mode 100644 index 0000000000..e3a3605ba7 --- /dev/null +++ b/.github/workflows/move-ready-to-merge-issues.yaml @@ -0,0 +1,22 @@ +name: Move and unlabel ready to merge issues +on: + issues: + types: + - labeled + +jobs: + unmark_for_review: + if: github.repository == 'github/docs' && github.event.label.name == 'ready to merge' + runs-on: ubuntu-latest + steps: + - name: move issue + uses: alex-page/github-project-automation-plus@fdb7991b72040d611e1123d2b75ff10eda9372c9 + with: + project: Docs team reviews + column: Triage + repo-token: ${{ secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES }} + - name: remove label + uses: andymckay/labeler@22d5392de2b725cea4b284df5824125054049d84 + with: + remove-labels: 'waiting for review' + repo-token: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/openapi-decorate.yml b/.github/workflows/openapi-decorate.yml index 435bfac1d0..d59b305a3d 100644 --- a/.github/workflows/openapi-decorate.yml +++ b/.github/workflows/openapi-decorate.yml @@ -25,13 +25,10 @@ jobs: run: script/rest/update-files.js --decorate-only - name: Check in the decorated files - uses: EndBug/add-and-commit@9358097a71ad9fb9e2f9624c6098c89193d83575 + uses: EndBug/add-and-commit@b3c7c1e078a023d75fb0bd326e02962575ce0519 with: # The arguments for the `git add` command add: 'lib/rest/static/decorated' # The message for the commit message: 'Add decorated OpenAPI schema files' - - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # Leave this line unchanged diff --git a/.github/workflows/post-status-updates-to-slack.yml b/.github/workflows/post-status-updates-to-slack.yml index 484557026c..bec7cfb879 100644 --- a/.github/workflows/post-status-updates-to-slack.yml +++ b/.github/workflows/post-status-updates-to-slack.yml @@ -19,5 +19,5 @@ jobs: id: notify with: slack-channel: 'C01EEKVR0Q7' - slack-bot-user-oauth-access-token: ${{ secrets.SLACK_DOCS_BOT_TOKEN }} + slack-bot-user-oauth-access-token: ${{ secrets.SLACK_BOT_TOKEN }} slack-text: \n><${{ github.event.comment.html_url}}|*${{github.event.issue.title}}*>\nstatus update posted by ${{github.event.comment.user.login}}\n\n${{ steps.trimmed.outputs.value }} diff --git a/.github/workflows/ready-for-doc-review.yml b/.github/workflows/ready-for-doc-review.yml new file mode 100644 index 0000000000..74243dac55 --- /dev/null +++ b/.github/workflows/ready-for-doc-review.yml @@ -0,0 +1,22 @@ +name: Ready for docs-content review + +# **What it does**: Adds pull requests in the docs-internal repository to the docs-content first responder project board +# **Why we have it**: So that other GitHub teams can easily request reviews from the docs-content team, and so that writers can see when a PR is ready for review +# **Who does it impact**: Writers working in the docs-internal repository + +on: + pull_request: + types: [labeled] + +jobs: + request_doc_review: + name: Request a review from the docs-content team + if: github.event.label.name == 'ready-for-doc-review' && github.repository == 'github/docs-internal' + runs-on: ubuntu-latest + steps: + - name: Add pull request to FR project board + uses: rachmari/actions-add-new-issue-to-column@1a459ef92308ba7c9c9dc2fcdd72f232495574a9 + with: + action-token: ${{ secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES }} + project-url: 'https://github.com/orgs/github/projects/1367' + column-name: 'Docs-internal external contributor PRs' diff --git a/.github/workflows/remove-from-fr-board.yaml b/.github/workflows/remove-from-fr-board.yaml new file mode 100644 index 0000000000..6a116b2432 --- /dev/null +++ b/.github/workflows/remove-from-fr-board.yaml @@ -0,0 +1,64 @@ +name: Remove card from FR board + +on: + repository_dispatch: + types: remove_from_docs_FR_board + +jobs: + remove_from_FR_board: + if: github.repository == 'github/docs-internal' + runs-on: ubuntu-latest + steps: + - id: find_project_cards + uses: octokit/graphql-action@5b3e01d42dee4509b0ac6b1cb2cf7778cdce85c2 + with: + query: | + query($issue_node_id:ID!) { + node(id:$issue_node_id) { + ... on Issue { + projectCards(first: 10) { + nodes { + id + project { + name + id + } + } + } + } + ... on PullRequest { + projectCards(first: 10) { + nodes { + id + project { + name + id + } + } + } + } + } + } + issue_node_id: ${{ github.event.client_payload.command.resource.id }} + env: + GITHUB_TOKEN: ${{ secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES }} + + - run: "echo 'Project cards found: ${{ steps.find_project_cards.outputs.data }}'" + + - name: Get FR card + env: + QUERY_DATA: ${{ steps.find_project_cards.outputs.data }} + run: | + echo 'FR_CARDS='$(jq '.node.projectCards.nodes | .[] | select(.project.id == "MDc6UHJvamVjdDQ1NzI0ODI=") | .id' <<< "$QUERY_DATA") >> $GITHUB_ENV + + - name: Delete card + id: delete_project_card + if: ${{ env.FR_CARDS }} + uses: octokit/graphql-action@5b3e01d42dee4509b0ac6b1cb2cf7778cdce85c2 + with: + query: | + mutation DeleteCard { + deleteProjectCard(input:{cardId:${{ env.FR_CARDS }}}) {deletedCardId} + } + env: + GITHUB_TOKEN: ${{ secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES }} diff --git a/.github/workflows/repo-freeze-check.yml b/.github/workflows/repo-freeze-check.yml index b50ebc2754..c9c892e2a3 100644 --- a/.github/workflows/repo-freeze-check.yml +++ b/.github/workflows/repo-freeze-check.yml @@ -22,7 +22,7 @@ jobs: runs-on: ubuntu-latest steps: - name: Fail if repo merges are paused - if: ${{ env.FREEZE == 'true' && github.ref != 'refs/heads/repo-sync' }} + if: ${{ env.FREEZE == 'true' && github.head_ref != 'repo-sync' }} run: | echo 'Merges into the "main" branch on this repo are currently paused!' exit 1 diff --git a/.github/workflows/send-eng-issues-to-backlog.yml b/.github/workflows/send-eng-issues-to-backlog.yml deleted file mode 100644 index 11ca0afd2f..0000000000 --- a/.github/workflows/send-eng-issues-to-backlog.yml +++ /dev/null @@ -1,30 +0,0 @@ -name: Send Issue to EPD backlog - -on: - issues: - types: - - labeled - - reopened - -jobs: - triage: - if: github.repository == 'github/docs-internal' - runs-on: ubuntu-latest - continue-on-error: true - steps: - - name: Add issues with engineering label to project board - if: contains(github.event.issue.labels.*.name, 'engineering') || contains(github.event.issue.labels.*.name, 'design') || contains(github.event.issue.labels.*.name, 'Design') - uses: actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9 - with: - github-token: ${{ secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES }} - script: | - var column_id = 9659080; - try { - github.projects.createCard({ - column_id: column_id, - content_id: context.payload.issue.id, - content_type: "Issue" - }); - } catch (error) { - console.log(error); - } diff --git a/.github/workflows/send-issues-to-how-how-we-work-boards.yml b/.github/workflows/send-issues-to-how-how-we-work-boards.yml new file mode 100644 index 0000000000..bf6e279ef5 --- /dev/null +++ b/.github/workflows/send-issues-to-how-how-we-work-boards.yml @@ -0,0 +1,58 @@ +name: Send Issue to How We Work Boards + +on: + issues: + types: + - labeled + - reopened + +jobs: + triage: + runs-on: ubuntu-latest + continue-on-error: true + steps: + - if: contains(github.event.issue.labels.*.name, 'engineering') && !contains(github.event.issue.labels.*.name, 'feature') && !contains(github.event.issue.labels.*.name, 'epic') + uses: actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9 + with: + github-token: ${{ secrets.DOCUBOT_READORG_REPO_WORKFLOW_SCOPES }} + script: | + var column_id = 9659080; + try { + github.projects.createCard({ + column_id: column_id, + content_id: context.payload.issue.id, + content_type: "Issue" + }); + } catch (error) { + console.log(error); + } + - if: contains(github.event.issue.labels.*.name, 'engineering') && contains(github.event.issue.labels.*.name, 'feature') + uses: actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9 + with: + github-token: ${{ secrets.DOCUBOT_READORG_REPO_WORKFLOW_SCOPES }} + script: | + var column_id = 13445681; + try { + github.projects.createCard({ + column_id: column_id, + content_id: context.payload.issue.id, + content_type: "Issue" + }); + } catch (error) { + console.log(error); + } + - if: contains(github.event.issue.labels.*.name, 'engineering') && contains(github.event.issue.labels.*.name, 'epic') + uses: actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9 + with: + github-token: ${{ secrets.DOCUBOT_READORG_REPO_WORKFLOW_SCOPES }} + script: | + var column_id = 13445932; + try { + github.projects.createCard({ + column_id: column_id, + content_id: context.payload.issue.id, + content_type: "Issue" + }); + } catch (error) { + console.log(error); + } diff --git a/.github/workflows/site-policy-sync.yml b/.github/workflows/site-policy-sync.yml index 3b76939af7..d7c168b18a 100644 --- a/.github/workflows/site-policy-sync.yml +++ b/.github/workflows/site-policy-sync.yml @@ -18,7 +18,7 @@ on: jobs: # This workflow contains a single job called "build" copy-file: - if: github.repository == 'github/docs-internal' || github.repository == 'github/docs' + if: github.repository == 'github/docs-internal' # The type of runner that the job will run on runs-on: ubuntu-latest diff --git a/.github/workflows/test-windows.yml b/.github/workflows/test-windows.yml index a30d60173a..7f2042634f 100644 --- a/.github/workflows/test-windows.yml +++ b/.github/workflows/test-windows.yml @@ -1,4 +1,4 @@ -# NOTE: Changes to this file should also be applied to './test.yml' and './test-translations.yml' +# NOTE: Changes to this file should also be applied to './test.yml' name: Node.js Tests - Windows @@ -8,10 +8,14 @@ on: schedule: - cron: '50 19 * * *' # once a day at 19:50 UTC / 11:50 PST +env: + CI: true + jobs: test: runs-on: windows-latest if: (github.event_name != 'pull_request') || (github.event_name == 'pull_request' && (contains(github.event.pull_request.labels.*.name, 'Windows') || contains(github.event.pull_request.labels.*.name, 'windows'))) + timeout-minutes: 60 strategy: fail-fast: false matrix: @@ -19,6 +23,9 @@ jobs: steps: - name: Check out repo uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f + with: + # Enables cloning the Early Access repo later with the relevant PAT + persist-credentials: 'false' - name: Setup node uses: actions/setup-node@c46424eee26de4078d34105d3de3cc4992202b1e @@ -41,7 +48,15 @@ jobs: - name: Install dependencies run: npm ci - - name: Run build script + - if: ${{ github.repository == 'github/docs-internal' }} + name: Clone early access + run: npm run heroku-postbuild + env: + DOCUBOT_REPO_PAT: ${{ secrets.DOCUBOT_REPO_PAT }} + GIT_BRANCH: ${{ github.head_ref || github.ref }} + + - if: ${{ github.repository != 'github/docs-internal' }} + name: Run build script run: npm run build - name: Run tests diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 978b6ed29b..ab5f8d14fc 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -77,7 +77,7 @@ jobs: run: npm run heroku-postbuild env: DOCUBOT_REPO_PAT: ${{ secrets.DOCUBOT_REPO_PAT }} - GIT_BRANCH: ${{ github.ref }} + GIT_BRANCH: ${{ github.head_ref || github.ref }} - if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' && github.repository != 'github/docs-internal' }} name: Run build script diff --git a/.github/workflows/triage-pull-requests.yml b/.github/workflows/triage-pull-requests.yml index f83ff5c9e8..abff3a84c3 100644 --- a/.github/workflows/triage-pull-requests.yml +++ b/.github/workflows/triage-pull-requests.yml @@ -7,7 +7,7 @@ on: jobs: triage_pulls: - if: github.repository == 'github/docs' + if: github.repository != 'github/docs-internal' runs-on: ubuntu-latest steps: diff --git a/.github/workflows/update-graphql-files.yml b/.github/workflows/update-graphql-files.yml index a610bf5bf8..7e61137b57 100644 --- a/.github/workflows/update-graphql-files.yml +++ b/.github/workflows/update-graphql-files.yml @@ -56,7 +56,7 @@ jobs: If CI does not pass or other problems arise, contact #docs-engineering on slack." labels: automerge,autoupdate branch: graphql-schema-update - - if: ${{ failure() }} + - if: ${{ failure() && env.FREEZE != 'true'}} name: Delete remote branch (if previous steps failed) uses: dawidd6/action-delete-branch@47743101a121ad657031e6704086271ca81b1911 with: diff --git a/assets/images/enterprise/configuration/ae-discard-email.png b/assets/images/enterprise/configuration/ae-discard-email.png new file mode 100644 index 0000000000..a11a3b12ce Binary files /dev/null and b/assets/images/enterprise/configuration/ae-discard-email.png differ diff --git a/assets/images/enterprise/configuration/ae-email-configure.png b/assets/images/enterprise/configuration/ae-email-configure.png new file mode 100644 index 0000000000..b82b859594 Binary files /dev/null and b/assets/images/enterprise/configuration/ae-email-configure.png differ diff --git a/assets/images/enterprise/configuration/ae-enable-email-configure.png b/assets/images/enterprise/configuration/ae-enable-email-configure.png new file mode 100644 index 0000000000..796bc6f9a2 Binary files /dev/null and b/assets/images/enterprise/configuration/ae-enable-email-configure.png differ diff --git a/assets/images/enterprise/configuration/ae-send-test-email.png b/assets/images/enterprise/configuration/ae-send-test-email.png new file mode 100644 index 0000000000..74c1d3ec12 Binary files /dev/null and b/assets/images/enterprise/configuration/ae-send-test-email.png differ diff --git a/assets/images/enterprise/configuration/ae-test-email.png b/assets/images/enterprise/configuration/ae-test-email.png new file mode 100644 index 0000000000..e88dc8bb16 Binary files /dev/null and b/assets/images/enterprise/configuration/ae-test-email.png differ diff --git a/assets/images/enterprise/configuration/enterprise-account-email-tab.png b/assets/images/enterprise/configuration/enterprise-account-email-tab.png new file mode 100644 index 0000000000..b84ceae136 Binary files /dev/null and b/assets/images/enterprise/configuration/enterprise-account-email-tab.png differ diff --git a/assets/images/enterprise/github-ae/organizations/security-and-analysis-disable-or-enable-all-ghae.png b/assets/images/enterprise/github-ae/organizations/security-and-analysis-disable-or-enable-all-ghae.png new file mode 100644 index 0000000000..3765b1155f Binary files /dev/null and b/assets/images/enterprise/github-ae/organizations/security-and-analysis-disable-or-enable-all-ghae.png differ diff --git a/assets/images/enterprise/github-ae/organizations/security-and-analysis-enable-or-disable-secret-scanning-checkbox-ghae.png b/assets/images/enterprise/github-ae/organizations/security-and-analysis-enable-or-disable-secret-scanning-checkbox-ghae.png new file mode 100644 index 0000000000..5f4f5d34f4 Binary files /dev/null and b/assets/images/enterprise/github-ae/organizations/security-and-analysis-enable-or-disable-secret-scanning-checkbox-ghae.png differ diff --git a/assets/images/enterprise/github-ae/organizations/security-and-analysis-enable-secret-scanning-existing-repos-ghae.png b/assets/images/enterprise/github-ae/organizations/security-and-analysis-enable-secret-scanning-existing-repos-ghae.png new file mode 100644 index 0000000000..c7248c0415 Binary files /dev/null and b/assets/images/enterprise/github-ae/organizations/security-and-analysis-enable-secret-scanning-existing-repos-ghae.png differ diff --git a/assets/images/enterprise/github-ae/repository/enable-ghas-confirmation-ghae.png b/assets/images/enterprise/github-ae/repository/enable-ghas-confirmation-ghae.png new file mode 100644 index 0000000000..b603c02f30 Binary files /dev/null and b/assets/images/enterprise/github-ae/repository/enable-ghas-confirmation-ghae.png differ diff --git a/assets/images/enterprise/github-ae/repository/enable-ghas-ghae.png b/assets/images/enterprise/github-ae/repository/enable-ghas-ghae.png new file mode 100644 index 0000000000..8387f81d64 Binary files /dev/null and b/assets/images/enterprise/github-ae/repository/enable-ghas-ghae.png differ diff --git a/assets/images/enterprise/github-ae/repository/enable-ghas-secret-scanning-ghae.png b/assets/images/enterprise/github-ae/repository/enable-ghas-secret-scanning-ghae.png new file mode 100644 index 0000000000..806400be61 Binary files /dev/null and b/assets/images/enterprise/github-ae/repository/enable-ghas-secret-scanning-ghae.png differ diff --git a/assets/images/enterprise/github-ae/repository/enable-secret-scanning-ghae.png b/assets/images/enterprise/github-ae/repository/enable-secret-scanning-ghae.png new file mode 100644 index 0000000000..2a076623bc Binary files /dev/null and b/assets/images/enterprise/github-ae/repository/enable-secret-scanning-ghae.png differ diff --git a/assets/images/enterprise/github-ae/repository/secret-scanning-click-alert-ghae.png b/assets/images/enterprise/github-ae/repository/secret-scanning-click-alert-ghae.png new file mode 100644 index 0000000000..c10b46c96a Binary files /dev/null and b/assets/images/enterprise/github-ae/repository/secret-scanning-click-alert-ghae.png differ diff --git a/assets/images/enterprise/github-ae/repository/security-and-analysis-security-alerts-person-or-team-search-ghae.png b/assets/images/enterprise/github-ae/repository/security-and-analysis-security-alerts-person-or-team-search-ghae.png new file mode 100644 index 0000000000..01aba08f89 Binary files /dev/null and b/assets/images/enterprise/github-ae/repository/security-and-analysis-security-alerts-person-or-team-search-ghae.png differ diff --git a/assets/images/enterprise/github-ae/repository/security-and-analysis-security-alerts-save-changes-ghae.png b/assets/images/enterprise/github-ae/repository/security-and-analysis-security-alerts-save-changes-ghae.png new file mode 100644 index 0000000000..e05d591e66 Binary files /dev/null and b/assets/images/enterprise/github-ae/repository/security-and-analysis-security-alerts-save-changes-ghae.png differ diff --git a/assets/images/enterprise/github-ae/repository/security-and-analysis-security-alerts-username-x-ghae.png b/assets/images/enterprise/github-ae/repository/security-and-analysis-security-alerts-username-x-ghae.png new file mode 100644 index 0000000000..c78c072677 Binary files /dev/null and b/assets/images/enterprise/github-ae/repository/security-and-analysis-security-alerts-username-x-ghae.png differ diff --git a/assets/images/enterprise/github-ae/repository/sidebar-secrets-ghae.png b/assets/images/enterprise/github-ae/repository/sidebar-secrets-ghae.png new file mode 100644 index 0000000000..c2b799d781 Binary files /dev/null and b/assets/images/enterprise/github-ae/repository/sidebar-secrets-ghae.png differ diff --git a/assets/images/enterprise/github-ae/settings/access-token-scopes-for-ghae.png b/assets/images/enterprise/github-ae/settings/access-token-scopes-for-ghae.png new file mode 100644 index 0000000000..31015adef6 Binary files /dev/null and b/assets/images/enterprise/github-ae/settings/access-token-scopes-for-ghae.png differ diff --git a/assets/images/enterprise/github-ae/teams/choose-an-idp-group.png b/assets/images/enterprise/github-ae/teams/choose-an-idp-group.png new file mode 100644 index 0000000000..7c6f730d55 Binary files /dev/null and b/assets/images/enterprise/github-ae/teams/choose-an-idp-group.png differ diff --git a/assets/images/enterprise/github-ae/teams/unselect-idp-group.png b/assets/images/enterprise/github-ae/teams/unselect-idp-group.png new file mode 100644 index 0000000000..a9cc3d1ffe Binary files /dev/null and b/assets/images/enterprise/github-ae/teams/unselect-idp-group.png differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/enterprise/business-accounts/settings-options-tab.png b/assets/images/enterprise/legacy-format/2.20/assets/images/enterprise/business-accounts/settings-options-tab.png deleted file mode 100644 index f7e163d033..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/enterprise/business-accounts/settings-options-tab.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/enterprise/enterprises/license.png b/assets/images/enterprise/legacy-format/2.20/assets/images/enterprise/enterprises/license.png deleted file mode 100644 index 679a7a6310..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/enterprise/enterprises/license.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/enterprise/management-console/management-console-tab.png b/assets/images/enterprise/legacy-format/2.20/assets/images/enterprise/management-console/management-console-tab.png deleted file mode 100644 index 103434c7f1..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/enterprise/management-console/management-console-tab.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/enterprise/management-console/save-settings.png b/assets/images/enterprise/legacy-format/2.20/assets/images/enterprise/management-console/save-settings.png deleted file mode 100644 index 722e49a05d..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/enterprise/management-console/save-settings.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/enterprise/management-console/sidebar-authentication.png b/assets/images/enterprise/legacy-format/2.20/assets/images/enterprise/management-console/sidebar-authentication.png deleted file mode 100644 index 68e2fb5ff5..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/enterprise/management-console/sidebar-authentication.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/enterprise/site-admin-settings/access-new-settings.png b/assets/images/enterprise/legacy-format/2.20/assets/images/enterprise/site-admin-settings/access-new-settings.png deleted file mode 100644 index 1cb09395a1..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/enterprise/site-admin-settings/access-new-settings.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/enterprise/site-admin-settings/edit-message.png b/assets/images/enterprise/legacy-format/2.20/assets/images/enterprise/site-admin-settings/edit-message.png deleted file mode 100644 index d7a61a4562..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/enterprise/site-admin-settings/edit-message.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/enterprise/site-admin-settings/enable-vulnerability-scanning-in-repositories.png b/assets/images/enterprise/legacy-format/2.20/assets/images/enterprise/site-admin-settings/enable-vulnerability-scanning-in-repositories.png deleted file mode 100644 index 12a788db07..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/enterprise/site-admin-settings/enable-vulnerability-scanning-in-repositories.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/enterprise/site-admin-settings/enterprise-tab.png b/assets/images/enterprise/legacy-format/2.20/assets/images/enterprise/site-admin-settings/enterprise-tab.png deleted file mode 100644 index f39403c665..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/enterprise/site-admin-settings/enterprise-tab.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/enterprise/site-admin-settings/repo/repo-security-top-tab.png b/assets/images/enterprise/legacy-format/2.20/assets/images/enterprise/site-admin-settings/repo/repo-security-top-tab.png deleted file mode 100644 index fe43aa9de0..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/enterprise/site-admin-settings/repo/repo-security-top-tab.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/enterprise/site-admin-settings/sign-out-add-message-button.png b/assets/images/enterprise/legacy-format/2.20/assets/images/enterprise/site-admin-settings/sign-out-add-message-button.png deleted file mode 100644 index 1dd271ada4..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/enterprise/site-admin-settings/sign-out-add-message-button.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/enterprise/site-admin-settings/suspend.png b/assets/images/enterprise/legacy-format/2.20/assets/images/enterprise/site-admin-settings/suspend.png deleted file mode 100644 index 433cbf69cd..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/enterprise/site-admin-settings/suspend.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/environments-sidebar.png b/assets/images/enterprise/legacy-format/2.20/assets/images/environments-sidebar.png deleted file mode 100644 index cbc82f139e..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/environments-sidebar.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/github-apps/github_apps_delete_key.png b/assets/images/enterprise/legacy-format/2.20/assets/images/github-apps/github_apps_delete_key.png deleted file mode 100644 index 5dc7807cf9..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/github-apps/github_apps_delete_key.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/github-apps/github_apps_private_key_fingerprint.png b/assets/images/enterprise/legacy-format/2.20/assets/images/github-apps/github_apps_private_key_fingerprint.png deleted file mode 100644 index 0748413ffe..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/github-apps/github_apps_private_key_fingerprint.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/branch/branch-creation-text-box.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/branch/branch-creation-text-box.png deleted file mode 100644 index f95a7942b1..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/branch/branch-creation-text-box.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/branch/branch-selection-dropdown.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/branch/branch-selection-dropdown.png deleted file mode 100644 index 4e0bde9736..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/branch/branch-selection-dropdown.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/branches/branches-link.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/branches/branches-link.png deleted file mode 100644 index dda96dadb2..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/branches/branches-link.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/branches/branches-overview-atom.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/branches/branches-overview-atom.png deleted file mode 100644 index 9c3e7dd791..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/branches/branches-overview-atom.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/business-accounts/billing-license-info.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/business-accounts/billing-license-info.png deleted file mode 100644 index 95b5a02094..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/business-accounts/billing-license-info.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/business-accounts/enterprise-account-settings-security-tab.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/business-accounts/enterprise-account-settings-security-tab.png deleted file mode 100644 index 3c33270e85..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/business-accounts/enterprise-account-settings-security-tab.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/business-accounts/enterprise-account-settings-tab.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/business-accounts/enterprise-account-settings-tab.png deleted file mode 100644 index 90da18a222..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/business-accounts/enterprise-account-settings-tab.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/business-accounts/upload-ghe-server-usage-link.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/business-accounts/upload-ghe-server-usage-link.png deleted file mode 100644 index f01f6df79d..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/business-accounts/upload-ghe-server-usage-link.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/commits/Commit-master-label.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/commits/Commit-master-label.png deleted file mode 100644 index 1b0bd03220..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/commits/Commit-master-label.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/desktop/mac-choose-preferences.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/desktop/mac-choose-preferences.png deleted file mode 100644 index de1f5cacf1..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/desktop/mac-choose-preferences.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/desktop/push-origin-button.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/desktop/push-origin-button.png deleted file mode 100644 index 3f23fa7af4..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/desktop/push-origin-button.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/desktop/sign-in-button-browser.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/desktop/sign-in-button-browser.png deleted file mode 100644 index 5019df8c1a..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/desktop/sign-in-button-browser.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/desktop/windows-choose-options.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/desktop/windows-choose-options.png deleted file mode 100644 index d780876ee8..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/desktop/windows-choose-options.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/education/upgrade-org-button.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/education/upgrade-org-button.png deleted file mode 100644 index 6080201baa..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/education/upgrade-org-button.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/graphs/dependents_graph.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/graphs/dependents_graph.png deleted file mode 100644 index f70b6bf9c9..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/graphs/dependents_graph.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/issues/delete-issue.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/issues/delete-issue.png deleted file mode 100644 index 1ce65f8556..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/issues/delete-issue.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/notifications/notifications_general_existence_indicator.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/notifications/notifications_general_existence_indicator.png deleted file mode 100644 index af949a6f41..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/notifications/notifications_general_existence_indicator.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/organizations/disallow-members-to-change-repo-visibility.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/organizations/disallow-members-to-change-repo-visibility.png deleted file mode 100644 index 988cc9562b..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/organizations/disallow-members-to-change-repo-visibility.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/organizations/name-of-business.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/organizations/name-of-business.png deleted file mode 100644 index ffc26c3f93..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/organizations/name-of-business.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/organizations/org-settings-member-privileges.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/organizations/org-settings-member-privileges.png deleted file mode 100644 index bfd09369eb..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/organizations/org-settings-member-privileges.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/organizations/org-settings-security-tab.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/organizations/org-settings-security-tab.png deleted file mode 100644 index ae4e9ccf29..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/organizations/org-settings-security-tab.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/organizations/organization-belongs-to.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/organizations/organization-belongs-to.png deleted file mode 100644 index 8a57e382d4..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/organizations/organization-belongs-to.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/organizations/organization-settings-tab.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/organizations/organization-settings-tab.png deleted file mode 100644 index 35c18741e5..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/organizations/organization-settings-tab.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/organizations/people-tab-invite-member.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/organizations/people-tab-invite-member.png deleted file mode 100644 index 9677218aad..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/organizations/people-tab-invite-member.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/organizations/repo-labels-tab.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/organizations/repo-labels-tab.png deleted file mode 100644 index df9402d855..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/organizations/repo-labels-tab.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/organizations/trash-button.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/organizations/trash-button.png deleted file mode 100644 index ab46a09ec5..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/organizations/trash-button.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/package-registry/packages-link.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/package-registry/packages-link.png deleted file mode 100644 index e9e52bfcd6..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/package-registry/packages-link.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/pages/click-pages-url-to-preview.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/pages/click-pages-url-to-preview.png deleted file mode 100644 index 61437b8be5..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/pages/click-pages-url-to-preview.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/pages/create-repository-name-pages.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/pages/create-repository-name-pages.png deleted file mode 100644 index 36ba1e59fe..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/pages/create-repository-name-pages.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/pages/publishing-source-drop-down.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/pages/publishing-source-drop-down.png deleted file mode 100644 index 04be864683..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/pages/publishing-source-drop-down.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/pages/save-custom-domain.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/pages/save-custom-domain.png deleted file mode 100644 index 8670b4b8ee..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/pages/save-custom-domain.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/profile/display-pro-badge-checkbox.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/profile/display-pro-badge-checkbox.png deleted file mode 100644 index 877dfd6bbe..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/profile/display-pro-badge-checkbox.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/profile/profile-block-or-report-button.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/profile/profile-block-or-report-button.png deleted file mode 100644 index a4adf3ee72..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/profile/profile-block-or-report-button.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/profile/profile_orgs_box.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/profile/profile_orgs_box.png deleted file mode 100644 index 6b7ff4d08e..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/profile/profile_orgs_box.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/profile/top_right_avatar.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/profile/top_right_avatar.png deleted file mode 100644 index a3893678ed..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/profile/top_right_avatar.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/projects/team-discussions-comment-button.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/projects/team-discussions-comment-button.png deleted file mode 100644 index b253bd099a..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/projects/team-discussions-comment-button.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/projects/team-discussions-comment.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/projects/team-discussions-comment.png deleted file mode 100644 index bf40d3a62f..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/projects/team-discussions-comment.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/projects/team-discussions-privacy-menu.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/projects/team-discussions-privacy-menu.png deleted file mode 100644 index e1e2b18404..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/projects/team-discussions-privacy-menu.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/pull_requests/branch-dropdown.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/pull_requests/branch-dropdown.png deleted file mode 100644 index 7ba69b1f1d..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/pull_requests/branch-dropdown.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/pull_requests/choose-base-and-compare-branches.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/pull_requests/choose-base-and-compare-branches.png deleted file mode 100644 index c9ffd3f1b0..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/pull_requests/choose-base-and-compare-branches.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/pull_requests/choose-base-fork-and-branch.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/pull_requests/choose-base-fork-and-branch.png deleted file mode 100644 index 4510354847..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/pull_requests/choose-base-fork-and-branch.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/pull_requests/choose-head-fork-compare-branch.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/pull_requests/choose-head-fork-compare-branch.png deleted file mode 100644 index 1db5fe09a6..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/pull_requests/choose-head-fork-compare-branch.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/pull_requests/compare-across-forks-link.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/pull_requests/compare-across-forks-link.png deleted file mode 100644 index 6676a282cb..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/pull_requests/compare-across-forks-link.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/pull_requests/compare-branch-example.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/pull_requests/compare-branch-example.png deleted file mode 100644 index b3831912b2..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/pull_requests/compare-branch-example.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/pull_requests/pull-request-edit-base-branch.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/pull_requests/pull-request-edit-base-branch.png deleted file mode 100644 index 9e87a5dc4d..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/pull_requests/pull-request-edit-base-branch.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/pull_requests/pull-request-edit.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/pull_requests/pull-request-edit.png deleted file mode 100644 index bd05b7b0e6..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/pull_requests/pull-request-edit.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/pull_requests/pull-request-review-edit-branch.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/pull_requests/pull-request-review-edit-branch.png deleted file mode 100644 index 0382a63fcf..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/pull_requests/pull-request-review-edit-branch.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/pull_requests/pull-request-start-review-button.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/pull_requests/pull-request-start-review-button.png deleted file mode 100644 index 1620899cd0..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/pull_requests/pull-request-start-review-button.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/pull_requests/revert-pull-request-link.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/pull_requests/revert-pull-request-link.png deleted file mode 100644 index e46cf9d512..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/pull_requests/revert-pull-request-link.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/releases/release-link.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/releases/release-link.png deleted file mode 100644 index 4fe6ea286b..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/releases/release-link.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/releases/release-name-link.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/releases/release-name-link.png deleted file mode 100644 index 27108a2b4e..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/releases/release-name-link.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/releases/releases-tag-branch.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/releases/releases-tag-branch.png deleted file mode 100644 index ff613680df..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/releases/releases-tag-branch.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/releases/releases-tag-version.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/releases/releases-tag-version.png deleted file mode 100644 index 693573cd55..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/releases/releases-tag-version.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/PR-review-required-code-owner.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/PR-review-required-code-owner.png deleted file mode 100644 index 715495c21d..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/PR-review-required-code-owner.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/PR-review-required-dismissals.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/PR-review-required-dismissals.png deleted file mode 100644 index 1c78f9dcd3..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/PR-review-required-dismissals.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/PR-reviews-required-dismiss-stale.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/PR-reviews-required-dismiss-stale.png deleted file mode 100644 index 28014adc21..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/PR-reviews-required-dismiss-stale.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/PR-reviews-required.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/PR-reviews-required.png deleted file mode 100644 index 5a98890ecb..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/PR-reviews-required.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/add-topic-form.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/add-topic-form.png deleted file mode 100644 index 02dbf8be42..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/add-topic-form.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/choose-commit-branch.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/choose-commit-branch.png deleted file mode 100644 index 2e59501633..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/choose-commit-branch.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/choose-reason-for-hiding-comment-ghe.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/choose-reason-for-hiding-comment-ghe.png deleted file mode 100644 index 2d72784233..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/choose-reason-for-hiding-comment-ghe.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/create-commit-open-readme.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/create-commit-open-readme.png deleted file mode 100644 index bf622bcbd8..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/create-commit-open-readme.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/create-repository-owner.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/create-repository-owner.png deleted file mode 100644 index 8988cc96a6..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/create-repository-owner.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/create-repository-public-private.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/create-repository-public-private.png deleted file mode 100644 index fab4254b7d..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/create-repository-public-private.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/create_new_file.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/create_new_file.png deleted file mode 100644 index a065ca72f1..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/create_new_file.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/https-url-clone.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/https-url-clone.png deleted file mode 100644 index cae1728887..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/https-url-clone.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/include-admins-protected-branches.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/include-admins-protected-branches.png deleted file mode 100644 index c116702484..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/include-admins-protected-branches.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/initialize-with-readme.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/initialize-with-readme.png deleted file mode 100644 index 221178f55e..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/initialize-with-readme.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/issue-template-commit-message-field.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/issue-template-commit-message-field.png deleted file mode 100644 index 55121147dc..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/issue-template-commit-message-field.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/issue-template-commit-to-master-or-open-pull-request.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/issue-template-commit-to-master-or-open-pull-request.png deleted file mode 100644 index a234ab3480..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/issue-template-commit-to-master-or-open-pull-request.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/manage-access-invite-button.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/manage-access-invite-button.png deleted file mode 100644 index 9569973c62..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/manage-access-invite-button.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/new-file-commit-button.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/new-file-commit-button.png deleted file mode 100644 index 0d0444f395..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/new-file-commit-button.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/number-of-required-review-approvals.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/number-of-required-review-approvals.png deleted file mode 100644 index 23c4d4ffef..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/number-of-required-review-approvals.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/os-repo-with-topics.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/os-repo-with-topics.png deleted file mode 100644 index e2aba0e148..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/os-repo-with-topics.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/propose-file-change-quick-pull.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/propose-file-change-quick-pull.png deleted file mode 100644 index e0f91e56dd..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/propose-file-change-quick-pull.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/protecting-branch-loose-status.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/protecting-branch-loose-status.png deleted file mode 100644 index eee5f254b9..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/protecting-branch-loose-status.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/repo-actions-settings.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/repo-actions-settings.png deleted file mode 100644 index fe1ae3308b..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/repo-actions-settings.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/repo-with-readme.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/repo-with-readme.png deleted file mode 100644 index 89594e645e..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/repo-with-readme.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/repository-options-branch.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/repository-options-branch.png deleted file mode 100644 index fdf36c69c0..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/repository-options-branch.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/repository-options-defaultbranch.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/repository-options-defaultbranch.png deleted file mode 100644 index d45e6ee8ca..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/repository-options-defaultbranch.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/require-signed-commits.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/require-signed-commits.png deleted file mode 100644 index 6aba04bf44..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/require-signed-commits.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/required-linear-history.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/required-linear-history.png deleted file mode 100644 index b7a3201ffb..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/required-linear-history.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/required-status-checks.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/required-status-checks.png deleted file mode 100644 index 18cd40fc31..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/required-status-checks.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/required-statuses-list.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/required-statuses-list.png deleted file mode 100644 index 41880593ba..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/required-statuses-list.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/restrict-branch-search.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/restrict-branch-search.png deleted file mode 100644 index a9cd955963..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/restrict-branch-search.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/restrict-branch.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/restrict-branch.png deleted file mode 100644 index 4129635888..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/restrict-branch.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/run-name.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/run-name.png deleted file mode 100644 index bf8988b4ae..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/run-name.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/upload-files-button.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/upload-files-button.png deleted file mode 100644 index a77f7974e2..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/upload-files-button.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/workflow-sidebar.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/workflow-sidebar.png deleted file mode 100644 index 1c0597f149..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/workflow-sidebar.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/write-commit-message-co-author-trailer.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/write-commit-message-co-author-trailer.png deleted file mode 100644 index 92aebb55db..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/write-commit-message-co-author-trailer.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/search/find-file-button.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/search/find-file-button.png deleted file mode 100644 index 156aa39e47..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/search/find-file-button.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/search/find-file-search-field.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/search/find-file-search-field.png deleted file mode 100644 index 612a6c6863..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/search/find-file-search-field.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/search/search-field.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/search/search-field.png deleted file mode 100644 index 68f542a851..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/search/search-field.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/security/advisories-tab.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/security/advisories-tab.png deleted file mode 100644 index a3659d0f66..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/security/advisories-tab.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/security/security-advisory-description.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/security/security-advisory-description.png deleted file mode 100644 index ac89833db9..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/security/security-advisory-description.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/security/security-advisory-metadata.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/security/security-advisory-metadata.png deleted file mode 100644 index 9a0f83e105..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/security/security-advisory-metadata.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/settings/actions-runner-remove.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/settings/actions-runner-remove.png deleted file mode 100644 index 9a82a91c8e..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/settings/actions-runner-remove.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/settings/audit-log-tab.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/settings/audit-log-tab.png deleted file mode 100644 index c310a8b68d..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/settings/audit-log-tab.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/settings/scheduled-reminders-prs-without-requests.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/settings/scheduled-reminders-prs-without-requests.png deleted file mode 100644 index 251e134dc6..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/settings/scheduled-reminders-prs-without-requests.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/settings/settings-sidebar-account-settings.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/settings/settings-sidebar-account-settings.png deleted file mode 100644 index cf8a7402e9..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/settings/settings-sidebar-account-settings.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/settings/settings-sidebar-ssh-keys.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/settings/settings-sidebar-ssh-keys.png deleted file mode 100644 index c48d203519..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/settings/settings-sidebar-ssh-keys.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/settings/settings-ssh-key-review.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/settings/settings-ssh-key-review.png deleted file mode 100644 index 992d130778..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/settings/settings-ssh-key-review.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/settings/userbar-account-settings.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/settings/userbar-account-settings.png deleted file mode 100644 index f54ce518cd..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/settings/userbar-account-settings.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/setup/keychain-access.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/setup/keychain-access.png deleted file mode 100644 index 7628dd83b4..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/setup/keychain-access.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/sponsors/activity-tab.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/sponsors/activity-tab.png deleted file mode 100644 index c6497f73ff..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/sponsors/activity-tab.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/sponsors/description-highlighted-org-members.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/sponsors/description-highlighted-org-members.png deleted file mode 100644 index 7f89ae045d..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/sponsors/description-highlighted-org-members.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/sponsors/edit-org-members-profile-button.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/sponsors/edit-org-members-profile-button.png deleted file mode 100644 index a20c081863..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/sponsors/edit-org-members-profile-button.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/sponsors/introduction-box.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/sponsors/introduction-box.png deleted file mode 100644 index 8130b22c76..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/sponsors/introduction-box.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/sponsors/manage-your-sponsorship-button.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/sponsors/manage-your-sponsorship-button.png deleted file mode 100644 index 3c094ea2fc..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/sponsors/manage-your-sponsorship-button.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/sponsors/payouts-tab.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/sponsors/payouts-tab.png deleted file mode 100644 index f24e0e6e56..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/sponsors/payouts-tab.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/sponsors/profile-tab.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/sponsors/profile-tab.png deleted file mode 100644 index 6a04eb6a0c..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/sponsors/profile-tab.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/sponsors/select-highlighted-org-members.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/sponsors/select-highlighted-org-members.png deleted file mode 100644 index 1f7a488b41..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/sponsors/select-highlighted-org-members.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/sponsors/sponsor-tiers-tab.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/sponsors/sponsor-tiers-tab.png deleted file mode 100644 index 14131e4ae3..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/sponsors/sponsor-tiers-tab.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/sponsors/sponsors-tab.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/sponsors/sponsors-tab.png deleted file mode 100644 index 5ca1f6a431..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/sponsors/sponsors-tab.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/sponsors/updates-tab.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/sponsors/updates-tab.png deleted file mode 100644 index 023ad32976..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/sponsors/updates-tab.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/sponsors/webhooks-tab.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/sponsors/webhooks-tab.png deleted file mode 100644 index d9569c5cd1..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/sponsors/webhooks-tab.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/teams/choose-an-idp-group.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/teams/choose-an-idp-group.png deleted file mode 100644 index 233aeff889..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/teams/choose-an-idp-group.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/teams/enable-team-synchronization.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/teams/enable-team-synchronization.png deleted file mode 100644 index 92b9da1bb5..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/teams/enable-team-synchronization.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/teams/list-of-members-selected-bulk.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/teams/list-of-members-selected-bulk.png deleted file mode 100644 index d1bd946c7f..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/teams/list-of-members-selected-bulk.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/enterprise/business-accounts/settings-options-tab.png b/assets/images/enterprise/legacy-format/2.21/assets/images/enterprise/business-accounts/settings-options-tab.png deleted file mode 100644 index f7e163d033..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/enterprise/business-accounts/settings-options-tab.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/enterprise/enterprises/license.png b/assets/images/enterprise/legacy-format/2.21/assets/images/enterprise/enterprises/license.png deleted file mode 100644 index 679a7a6310..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/enterprise/enterprises/license.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/enterprise/management-console/management-console-tab.png b/assets/images/enterprise/legacy-format/2.21/assets/images/enterprise/management-console/management-console-tab.png deleted file mode 100644 index 103434c7f1..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/enterprise/management-console/management-console-tab.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/enterprise/management-console/save-settings.png b/assets/images/enterprise/legacy-format/2.21/assets/images/enterprise/management-console/save-settings.png deleted file mode 100644 index 722e49a05d..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/enterprise/management-console/save-settings.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/enterprise/management-console/sidebar-authentication.png b/assets/images/enterprise/legacy-format/2.21/assets/images/enterprise/management-console/sidebar-authentication.png deleted file mode 100644 index 68e2fb5ff5..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/enterprise/management-console/sidebar-authentication.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/enterprise/site-admin-settings/access-new-settings.png b/assets/images/enterprise/legacy-format/2.21/assets/images/enterprise/site-admin-settings/access-new-settings.png deleted file mode 100644 index 1cb09395a1..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/enterprise/site-admin-settings/access-new-settings.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/enterprise/site-admin-settings/edit-message.png b/assets/images/enterprise/legacy-format/2.21/assets/images/enterprise/site-admin-settings/edit-message.png deleted file mode 100644 index d7a61a4562..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/enterprise/site-admin-settings/edit-message.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/enterprise/site-admin-settings/enterprise-tab.png b/assets/images/enterprise/legacy-format/2.21/assets/images/enterprise/site-admin-settings/enterprise-tab.png deleted file mode 100644 index f39403c665..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/enterprise/site-admin-settings/enterprise-tab.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/enterprise/site-admin-settings/repo/repo-security-top-tab.png b/assets/images/enterprise/legacy-format/2.21/assets/images/enterprise/site-admin-settings/repo/repo-security-top-tab.png deleted file mode 100644 index fe43aa9de0..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/enterprise/site-admin-settings/repo/repo-security-top-tab.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/enterprise/site-admin-settings/sign-out-add-message-button.png b/assets/images/enterprise/legacy-format/2.21/assets/images/enterprise/site-admin-settings/sign-out-add-message-button.png deleted file mode 100644 index 1dd271ada4..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/enterprise/site-admin-settings/sign-out-add-message-button.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/enterprise/site-admin-settings/suspend.png b/assets/images/enterprise/legacy-format/2.21/assets/images/enterprise/site-admin-settings/suspend.png deleted file mode 100644 index 433cbf69cd..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/enterprise/site-admin-settings/suspend.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/environments-sidebar.png b/assets/images/enterprise/legacy-format/2.21/assets/images/environments-sidebar.png deleted file mode 100644 index cbc82f139e..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/environments-sidebar.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/github-apps/github_apps_delete_key.png b/assets/images/enterprise/legacy-format/2.21/assets/images/github-apps/github_apps_delete_key.png deleted file mode 100644 index 5dc7807cf9..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/github-apps/github_apps_delete_key.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/github-apps/github_apps_private_key_fingerprint.png b/assets/images/enterprise/legacy-format/2.21/assets/images/github-apps/github_apps_private_key_fingerprint.png deleted file mode 100644 index 0748413ffe..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/github-apps/github_apps_private_key_fingerprint.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/branch/branch-creation-text-box.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/branch/branch-creation-text-box.png deleted file mode 100644 index f95a7942b1..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/branch/branch-creation-text-box.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/branch/branch-selection-dropdown.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/branch/branch-selection-dropdown.png deleted file mode 100644 index 4e0bde9736..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/branch/branch-selection-dropdown.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/branches/branches-link.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/branches/branches-link.png deleted file mode 100644 index dda96dadb2..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/branches/branches-link.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/branches/branches-overview-atom.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/branches/branches-overview-atom.png deleted file mode 100644 index 9c3e7dd791..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/branches/branches-overview-atom.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/business-accounts/billing-license-info.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/business-accounts/billing-license-info.png deleted file mode 100644 index bd5e610ece..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/business-accounts/billing-license-info.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/business-accounts/enterprise-account-settings-security-tab.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/business-accounts/enterprise-account-settings-security-tab.png deleted file mode 100644 index 3c33270e85..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/business-accounts/enterprise-account-settings-security-tab.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/business-accounts/enterprise-account-settings-tab.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/business-accounts/enterprise-account-settings-tab.png deleted file mode 100644 index 90da18a222..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/business-accounts/enterprise-account-settings-tab.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/codespaces/click-remote-explorer-icon-vscode.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/codespaces/click-remote-explorer-icon-vscode.png deleted file mode 100644 index b4081b262e..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/codespaces/click-remote-explorer-icon-vscode.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/commits/Commit-master-label.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/commits/Commit-master-label.png deleted file mode 100644 index 1b0bd03220..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/commits/Commit-master-label.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/desktop/mac-choose-preferences.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/desktop/mac-choose-preferences.png deleted file mode 100644 index 45494d166e..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/desktop/mac-choose-preferences.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/desktop/push-origin-button.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/desktop/push-origin-button.png deleted file mode 100644 index 3f23fa7af4..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/desktop/push-origin-button.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/desktop/sign-in-button-browser.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/desktop/sign-in-button-browser.png deleted file mode 100644 index 5019df8c1a..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/desktop/sign-in-button-browser.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/desktop/windows-choose-options.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/desktop/windows-choose-options.png deleted file mode 100644 index d780876ee8..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/desktop/windows-choose-options.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/graphs/dependents_graph.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/graphs/dependents_graph.png deleted file mode 100644 index f70b6bf9c9..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/graphs/dependents_graph.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/issues/delete-issue.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/issues/delete-issue.png deleted file mode 100644 index 1ce65f8556..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/issues/delete-issue.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/organizations/disallow-members-to-change-repo-visibility.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/organizations/disallow-members-to-change-repo-visibility.png deleted file mode 100644 index 988cc9562b..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/organizations/disallow-members-to-change-repo-visibility.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/organizations/org-settings-member-privileges.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/organizations/org-settings-member-privileges.png deleted file mode 100644 index bfd09369eb..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/organizations/org-settings-member-privileges.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/organizations/org-settings-security-tab.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/organizations/org-settings-security-tab.png deleted file mode 100644 index ae4e9ccf29..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/organizations/org-settings-security-tab.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/organizations/organization-settings-tab.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/organizations/organization-settings-tab.png deleted file mode 100644 index 35c18741e5..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/organizations/organization-settings-tab.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/organizations/repo-labels-tab.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/organizations/repo-labels-tab.png deleted file mode 100644 index df9402d855..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/organizations/repo-labels-tab.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/package-registry/packages-link.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/package-registry/packages-link.png deleted file mode 100644 index e9e52bfcd6..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/package-registry/packages-link.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/pages/click-pages-url-to-preview.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/pages/click-pages-url-to-preview.png deleted file mode 100644 index 61437b8be5..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/pages/click-pages-url-to-preview.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/pages/create-repository-name-pages.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/pages/create-repository-name-pages.png deleted file mode 100644 index 36ba1e59fe..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/pages/create-repository-name-pages.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/pages/publishing-source-drop-down.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/pages/publishing-source-drop-down.png deleted file mode 100644 index 04be864683..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/pages/publishing-source-drop-down.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/pages/save-custom-domain.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/pages/save-custom-domain.png deleted file mode 100644 index 8670b4b8ee..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/pages/save-custom-domain.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/profile/display-pro-badge-checkbox.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/profile/display-pro-badge-checkbox.png deleted file mode 100644 index 877dfd6bbe..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/profile/display-pro-badge-checkbox.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/profile/profile-block-or-report-button.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/profile/profile-block-or-report-button.png deleted file mode 100644 index a4adf3ee72..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/profile/profile-block-or-report-button.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/profile/profile_orgs_box.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/profile/profile_orgs_box.png deleted file mode 100644 index 6b7ff4d08e..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/profile/profile_orgs_box.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/profile/top_right_avatar.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/profile/top_right_avatar.png deleted file mode 100644 index a3893678ed..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/profile/top_right_avatar.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/projects/team-discussions-comment-button.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/projects/team-discussions-comment-button.png deleted file mode 100644 index 56627406c9..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/projects/team-discussions-comment-button.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/projects/team-discussions-comment.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/projects/team-discussions-comment.png deleted file mode 100644 index bf40d3a62f..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/projects/team-discussions-comment.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/projects/team-discussions-privacy-menu.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/projects/team-discussions-privacy-menu.png deleted file mode 100644 index e1e2b18404..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/projects/team-discussions-privacy-menu.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/pull_requests/branch-dropdown.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/pull_requests/branch-dropdown.png deleted file mode 100644 index 7ba69b1f1d..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/pull_requests/branch-dropdown.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/pull_requests/choose-base-and-compare-branches.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/pull_requests/choose-base-and-compare-branches.png deleted file mode 100644 index c9ffd3f1b0..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/pull_requests/choose-base-and-compare-branches.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/pull_requests/choose-base-fork-and-branch.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/pull_requests/choose-base-fork-and-branch.png deleted file mode 100644 index 4510354847..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/pull_requests/choose-base-fork-and-branch.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/pull_requests/choose-head-fork-compare-branch.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/pull_requests/choose-head-fork-compare-branch.png deleted file mode 100644 index 1db5fe09a6..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/pull_requests/choose-head-fork-compare-branch.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/pull_requests/compare-across-forks-link.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/pull_requests/compare-across-forks-link.png deleted file mode 100644 index 6676a282cb..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/pull_requests/compare-across-forks-link.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/pull_requests/compare-branch-example.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/pull_requests/compare-branch-example.png deleted file mode 100644 index b3831912b2..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/pull_requests/compare-branch-example.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/pull_requests/pull-request-edit-base-branch.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/pull_requests/pull-request-edit-base-branch.png deleted file mode 100644 index 9e87a5dc4d..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/pull_requests/pull-request-edit-base-branch.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/pull_requests/pull-request-edit.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/pull_requests/pull-request-edit.png deleted file mode 100644 index bd05b7b0e6..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/pull_requests/pull-request-edit.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/pull_requests/pull-request-review-edit-branch.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/pull_requests/pull-request-review-edit-branch.png deleted file mode 100644 index 0382a63fcf..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/pull_requests/pull-request-review-edit-branch.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/pull_requests/pull-request-start-review-button.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/pull_requests/pull-request-start-review-button.png deleted file mode 100644 index 1620899cd0..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/pull_requests/pull-request-start-review-button.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/pull_requests/revert-pull-request-link.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/pull_requests/revert-pull-request-link.png deleted file mode 100644 index 57e7fdade0..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/pull_requests/revert-pull-request-link.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/releases/release-link.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/releases/release-link.png deleted file mode 100644 index 4fe6ea286b..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/releases/release-link.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/releases/releases-tag-branch.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/releases/releases-tag-branch.png deleted file mode 100644 index ff613680df..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/releases/releases-tag-branch.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/releases/releases-tag-version.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/releases/releases-tag-version.png deleted file mode 100644 index 693573cd55..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/releases/releases-tag-version.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/add-topic-form.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/add-topic-form.png deleted file mode 100644 index 02dbf8be42..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/add-topic-form.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/choose-commit-branch.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/choose-commit-branch.png deleted file mode 100644 index 2e59501633..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/choose-commit-branch.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/code-scanning-click-alert.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/code-scanning-click-alert.png deleted file mode 100644 index f1ea07b843..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/code-scanning-click-alert.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/create-commit-open-readme.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/create-commit-open-readme.png deleted file mode 100644 index dc0fec4ace..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/create-commit-open-readme.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/create-repository-owner.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/create-repository-owner.png deleted file mode 100644 index 8988cc96a6..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/create-repository-owner.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/create-repository-public-private.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/create-repository-public-private.png deleted file mode 100644 index fab4254b7d..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/create-repository-public-private.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/create_new_file.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/create_new_file.png deleted file mode 100644 index a065ca72f1..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/create_new_file.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/https-url-clone.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/https-url-clone.png deleted file mode 100644 index cae1728887..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/https-url-clone.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/include-all-branches.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/include-all-branches.png deleted file mode 100644 index 4d81d46872..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/include-all-branches.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/initialize-with-readme.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/initialize-with-readme.png deleted file mode 100644 index 221178f55e..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/initialize-with-readme.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/issue-template-commit-message-field.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/issue-template-commit-message-field.png deleted file mode 100644 index 55121147dc..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/issue-template-commit-message-field.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/issue-template-commit-to-master-or-open-pull-request.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/issue-template-commit-to-master-or-open-pull-request.png deleted file mode 100644 index a234ab3480..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/issue-template-commit-to-master-or-open-pull-request.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/new-file-commit-button.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/new-file-commit-button.png deleted file mode 100644 index 0d0444f395..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/new-file-commit-button.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/os-repo-with-topics.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/os-repo-with-topics.png deleted file mode 100644 index e2aba0e148..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/os-repo-with-topics.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/propose-file-change-quick-pull.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/propose-file-change-quick-pull.png deleted file mode 100644 index e0f91e56dd..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/propose-file-change-quick-pull.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/repo-actions-settings.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/repo-actions-settings.png deleted file mode 100644 index fe1ae3308b..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/repo-actions-settings.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/repo-with-readme.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/repo-with-readme.png deleted file mode 100644 index 89594e645e..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/repo-with-readme.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/repository-options-branch.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/repository-options-branch.png deleted file mode 100644 index fdf36c69c0..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/repository-options-branch.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/repository-options-defaultbranch.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/repository-options-defaultbranch.png deleted file mode 100644 index d45e6ee8ca..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/repository-options-defaultbranch.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/run-name.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/run-name.png deleted file mode 100644 index bf8988b4ae..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/run-name.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/upload-files-button.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/upload-files-button.png deleted file mode 100644 index a77f7974e2..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/upload-files-button.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/workflow-sidebar.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/workflow-sidebar.png deleted file mode 100644 index 1c0597f149..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/workflow-sidebar.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/write-commit-message-co-author-trailer.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/write-commit-message-co-author-trailer.png deleted file mode 100644 index 92aebb55db..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/write-commit-message-co-author-trailer.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/saml/okta-provisioning-tab.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/saml/okta-provisioning-tab.png deleted file mode 100644 index 6a7ea9ef90..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/saml/okta-provisioning-tab.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/search/find-file-button.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/search/find-file-button.png deleted file mode 100644 index 156aa39e47..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/search/find-file-button.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/search/find-file-search-field.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/search/find-file-search-field.png deleted file mode 100644 index 612a6c6863..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/search/find-file-search-field.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/settings/actions-runner-manage-permissions.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/settings/actions-runner-manage-permissions.png deleted file mode 100644 index 214be7f529..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/settings/actions-runner-manage-permissions.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/settings/actions-runner-remove.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/settings/actions-runner-remove.png deleted file mode 100644 index ae62f5b6e4..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/settings/actions-runner-remove.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/settings/audit-log-tab.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/settings/audit-log-tab.png deleted file mode 100644 index c310a8b68d..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/settings/audit-log-tab.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/settings/settings-sidebar-account-settings.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/settings/settings-sidebar-account-settings.png deleted file mode 100644 index cf8a7402e9..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/settings/settings-sidebar-account-settings.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/settings/settings-sidebar-ssh-keys.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/settings/settings-sidebar-ssh-keys.png deleted file mode 100644 index c48d203519..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/settings/settings-sidebar-ssh-keys.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/settings/settings-ssh-key-review.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/settings/settings-ssh-key-review.png deleted file mode 100644 index 992d130778..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/settings/settings-ssh-key-review.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/settings/userbar-account-settings.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/settings/userbar-account-settings.png deleted file mode 100644 index f54ce518cd..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/settings/userbar-account-settings.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/setup/keychain-access.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/setup/keychain-access.png deleted file mode 100644 index 7628dd83b4..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/setup/keychain-access.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/sponsors/manage-your-sponsorship-button.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/sponsors/manage-your-sponsorship-button.png deleted file mode 100644 index 3c094ea2fc..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/sponsors/manage-your-sponsorship-button.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/enterprise/business-accounts/settings-options-tab.png b/assets/images/enterprise/legacy-format/2.22/assets/images/enterprise/business-accounts/settings-options-tab.png deleted file mode 100644 index f7e163d033..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/enterprise/business-accounts/settings-options-tab.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/enterprise/management-console/code-scanning-disable.png b/assets/images/enterprise/legacy-format/2.22/assets/images/enterprise/management-console/code-scanning-disable.png deleted file mode 100644 index 3b5fbd47c9..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/enterprise/management-console/code-scanning-disable.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/enterprise/management-console/enable-code-scanning-checkbox.png b/assets/images/enterprise/legacy-format/2.22/assets/images/enterprise/management-console/enable-code-scanning-checkbox.png deleted file mode 100644 index 396a52387f..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/enterprise/management-console/enable-code-scanning-checkbox.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/enterprise/management-console/management-console-tab.png b/assets/images/enterprise/legacy-format/2.22/assets/images/enterprise/management-console/management-console-tab.png deleted file mode 100644 index 103434c7f1..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/enterprise/management-console/management-console-tab.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/enterprise/management-console/sidebar-advanced-security.png b/assets/images/enterprise/legacy-format/2.22/assets/images/enterprise/management-console/sidebar-advanced-security.png deleted file mode 100644 index dc1097dae2..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/enterprise/management-console/sidebar-advanced-security.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/enterprise/management-console/sidebar-authentication.png b/assets/images/enterprise/legacy-format/2.22/assets/images/enterprise/management-console/sidebar-authentication.png deleted file mode 100644 index 68e2fb5ff5..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/enterprise/management-console/sidebar-authentication.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/enterprise/site-admin-settings/access-new-settings.png b/assets/images/enterprise/legacy-format/2.22/assets/images/enterprise/site-admin-settings/access-new-settings.png deleted file mode 100644 index 1cb09395a1..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/enterprise/site-admin-settings/access-new-settings.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/enterprise/site-admin-settings/add-announcement-button.png b/assets/images/enterprise/legacy-format/2.22/assets/images/enterprise/site-admin-settings/add-announcement-button.png deleted file mode 100644 index 1a8822138d..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/enterprise/site-admin-settings/add-announcement-button.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/enterprise/site-admin-settings/edit-message.png b/assets/images/enterprise/legacy-format/2.22/assets/images/enterprise/site-admin-settings/edit-message.png deleted file mode 100644 index d7a61a4562..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/enterprise/site-admin-settings/edit-message.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/enterprise/site-admin-settings/enterprise-tab.png b/assets/images/enterprise/legacy-format/2.22/assets/images/enterprise/site-admin-settings/enterprise-tab.png deleted file mode 100644 index f39403c665..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/enterprise/site-admin-settings/enterprise-tab.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/enterprise/site-admin-settings/repo/repo-security-top-tab.png b/assets/images/enterprise/legacy-format/2.22/assets/images/enterprise/site-admin-settings/repo/repo-security-top-tab.png deleted file mode 100644 index fe43aa9de0..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/enterprise/site-admin-settings/repo/repo-security-top-tab.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/enterprise/site-admin-settings/sign-out-add-message-button.png b/assets/images/enterprise/legacy-format/2.22/assets/images/enterprise/site-admin-settings/sign-out-add-message-button.png deleted file mode 100644 index 1dd271ada4..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/enterprise/site-admin-settings/sign-out-add-message-button.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/enterprise/site-admin-settings/suspend.png b/assets/images/enterprise/legacy-format/2.22/assets/images/enterprise/site-admin-settings/suspend.png deleted file mode 100644 index 433cbf69cd..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/enterprise/site-admin-settings/suspend.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/environments-sidebar.png b/assets/images/enterprise/legacy-format/2.22/assets/images/environments-sidebar.png deleted file mode 100644 index cbc82f139e..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/environments-sidebar.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/github-apps/github_apps_delete_key.png b/assets/images/enterprise/legacy-format/2.22/assets/images/github-apps/github_apps_delete_key.png deleted file mode 100644 index 5dc7807cf9..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/github-apps/github_apps_delete_key.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/github-apps/github_apps_private_key_fingerprint.png b/assets/images/enterprise/legacy-format/2.22/assets/images/github-apps/github_apps_private_key_fingerprint.png deleted file mode 100644 index 0748413ffe..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/github-apps/github_apps_private_key_fingerprint.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/branch/branch-creation-text-box.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/branch/branch-creation-text-box.png deleted file mode 100644 index f95a7942b1..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/branch/branch-creation-text-box.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/branch/branch-selection-dropdown.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/branch/branch-selection-dropdown.png deleted file mode 100644 index 4e0bde9736..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/branch/branch-selection-dropdown.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/branches/branches-link.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/branches/branches-link.png deleted file mode 100644 index dda96dadb2..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/branches/branches-link.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/branches/branches-overview-atom.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/branches/branches-overview-atom.png deleted file mode 100644 index 9c3e7dd791..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/branches/branches-overview-atom.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/business-accounts/billing-license-info.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/business-accounts/billing-license-info.png deleted file mode 100644 index bd5e610ece..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/business-accounts/billing-license-info.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/business-accounts/enterprise-account-settings-security-tab.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/business-accounts/enterprise-account-settings-security-tab.png deleted file mode 100644 index 3c33270e85..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/business-accounts/enterprise-account-settings-security-tab.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/codespaces/click-remote-explorer-icon-vscode.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/codespaces/click-remote-explorer-icon-vscode.png deleted file mode 100644 index b4081b262e..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/codespaces/click-remote-explorer-icon-vscode.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/commits/Commit-master-label.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/commits/Commit-master-label.png deleted file mode 100644 index 1b0bd03220..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/commits/Commit-master-label.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/notifications-v2/dependabot-alerts-options.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/notifications-v2/dependabot-alerts-options.png deleted file mode 100644 index 0d8bc26f96..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/notifications-v2/dependabot-alerts-options.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/organizations/org-settings-member-privileges.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/organizations/org-settings-member-privileges.png deleted file mode 100644 index bfd09369eb..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/organizations/org-settings-member-privileges.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/organizations/repo-labels-tab.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/organizations/repo-labels-tab.png deleted file mode 100644 index df9402d855..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/organizations/repo-labels-tab.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/profile/profile-block-or-report-button.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/profile/profile-block-or-report-button.png deleted file mode 100644 index a4adf3ee72..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/profile/profile-block-or-report-button.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/projects/team-discussions-comment-button.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/projects/team-discussions-comment-button.png deleted file mode 100644 index e625d210cb..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/projects/team-discussions-comment-button.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/projects/team-discussions-comment.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/projects/team-discussions-comment.png deleted file mode 100644 index bf40d3a62f..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/projects/team-discussions-comment.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/projects/team-discussions-privacy-menu.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/projects/team-discussions-privacy-menu.png deleted file mode 100644 index e1e2b18404..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/projects/team-discussions-privacy-menu.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/pull_requests/branch-dropdown.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/pull_requests/branch-dropdown.png deleted file mode 100644 index 7ba69b1f1d..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/pull_requests/branch-dropdown.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/pull_requests/choose-base-and-compare-branches.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/pull_requests/choose-base-and-compare-branches.png deleted file mode 100644 index c9ffd3f1b0..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/pull_requests/choose-base-and-compare-branches.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/pull_requests/choose-base-fork-and-branch.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/pull_requests/choose-base-fork-and-branch.png deleted file mode 100644 index 4510354847..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/pull_requests/choose-base-fork-and-branch.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/pull_requests/choose-head-fork-compare-branch.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/pull_requests/choose-head-fork-compare-branch.png deleted file mode 100644 index 1db5fe09a6..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/pull_requests/choose-head-fork-compare-branch.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/pull_requests/compare-across-forks-link.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/pull_requests/compare-across-forks-link.png deleted file mode 100644 index 6676a282cb..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/pull_requests/compare-across-forks-link.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/pull_requests/compare-branch-example.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/pull_requests/compare-branch-example.png deleted file mode 100644 index b3831912b2..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/pull_requests/compare-branch-example.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/pull_requests/pull-request-edit-base-branch.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/pull_requests/pull-request-edit-base-branch.png deleted file mode 100644 index 9e87a5dc4d..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/pull_requests/pull-request-edit-base-branch.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/pull_requests/pull-request-edit.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/pull_requests/pull-request-edit.png deleted file mode 100644 index bd05b7b0e6..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/pull_requests/pull-request-edit.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/pull_requests/pull-request-review-edit-branch.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/pull_requests/pull-request-review-edit-branch.png deleted file mode 100644 index 0382a63fcf..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/pull_requests/pull-request-review-edit-branch.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/pull_requests/revert-pull-request-link.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/pull_requests/revert-pull-request-link.png deleted file mode 100644 index 57e7fdade0..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/pull_requests/revert-pull-request-link.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/releases/releases-tag-branch.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/releases/releases-tag-branch.png deleted file mode 100644 index ff613680df..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/releases/releases-tag-branch.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/releases/releases-tag-version.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/releases/releases-tag-version.png deleted file mode 100644 index 693573cd55..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/releases/releases-tag-version.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/actions-delete-artifact.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/actions-delete-artifact.png deleted file mode 100644 index 62322ba6a6..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/actions-delete-artifact.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/artifact-drop-down.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/artifact-drop-down.png deleted file mode 100644 index d045551cbd..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/artifact-drop-down.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/code-scanning-alert-close-drop-down.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/code-scanning-alert-close-drop-down.png deleted file mode 100644 index ccf03f8f1e..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/code-scanning-alert-close-drop-down.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/code-scanning-alert.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/code-scanning-alert.png deleted file mode 100644 index 437ef4af99..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/code-scanning-alert.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/code-scanning-click-alert.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/code-scanning-click-alert.png deleted file mode 100644 index f1ea07b843..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/code-scanning-click-alert.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/code-scanning-pr-alert.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/code-scanning-pr-alert.png deleted file mode 100644 index ef13d6a66b..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/code-scanning-pr-alert.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/code-scanning-pr-annotation.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/code-scanning-pr-annotation.png deleted file mode 100644 index f71a65cebd..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/code-scanning-pr-annotation.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/code-scanning-set-up-this-workflow.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/code-scanning-set-up-this-workflow.png deleted file mode 100644 index 8875fdbae3..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/code-scanning-set-up-this-workflow.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/code-scanning-show-paths.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/code-scanning-show-paths.png deleted file mode 100644 index c2e69d8fc4..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/code-scanning-show-paths.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/create-commit-open-readme.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/create-commit-open-readme.png deleted file mode 100644 index bf622bcbd8..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/create-commit-open-readme.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/delete-all-logs.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/delete-all-logs.png deleted file mode 100644 index d4570352b8..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/delete-all-logs.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/dependency-graph-enable-button.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/dependency-graph-enable-button.png deleted file mode 100644 index e9e059df95..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/dependency-graph-enable-button.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/download-logs-drop-down.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/download-logs-drop-down.png deleted file mode 100644 index 19919eb2f8..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/download-logs-drop-down.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/include-all-branches.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/include-all-branches.png deleted file mode 100644 index 4d81d46872..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/include-all-branches.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/issue-template-commit-message-field.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/issue-template-commit-message-field.png deleted file mode 100644 index 55121147dc..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/issue-template-commit-message-field.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/issue-template-commit-to-master-or-open-pull-request.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/issue-template-commit-to-master-or-open-pull-request.png deleted file mode 100644 index a234ab3480..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/issue-template-commit-to-master-or-open-pull-request.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/propose-file-change-quick-pull.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/propose-file-change-quick-pull.png deleted file mode 100644 index e0f91e56dd..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/propose-file-change-quick-pull.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/repo-with-readme.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/repo-with-readme.png deleted file mode 100644 index 89594e645e..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/repo-with-readme.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/repository-options-branch.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/repository-options-branch.png deleted file mode 100644 index fdf36c69c0..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/repository-options-branch.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/repository-options-defaultbranch.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/repository-options-defaultbranch.png deleted file mode 100644 index d45e6ee8ca..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/repository-options-defaultbranch.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/run-name.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/run-name.png deleted file mode 100644 index bf8988b4ae..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/run-name.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/username-repo-with-readme.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/username-repo-with-readme.png deleted file mode 100644 index f518b6d41f..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/username-repo-with-readme.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/workflow-sidebar.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/workflow-sidebar.png deleted file mode 100644 index 1c0597f149..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/workflow-sidebar.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/write-commit-message-co-author-trailer.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/write-commit-message-co-author-trailer.png deleted file mode 100644 index 92aebb55db..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/write-commit-message-co-author-trailer.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/settings/actions-enterprise-account-add-runner-group-options.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/settings/actions-enterprise-account-add-runner-group-options.png deleted file mode 100644 index b61b6207a9..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/settings/actions-enterprise-account-add-runner-group-options.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/settings/actions-org-add-runner-group-options.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/settings/actions-org-add-runner-group-options.png deleted file mode 100644 index a06d0354fb..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/settings/actions-org-add-runner-group-options.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/settings/audit-log-tab.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/settings/audit-log-tab.png deleted file mode 100644 index c310a8b68d..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/settings/audit-log-tab.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/settings/settings-sidebar-account-settings.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/settings/settings-sidebar-account-settings.png deleted file mode 100644 index cf8a7402e9..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/settings/settings-sidebar-account-settings.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/settings/settings-sidebar-ssh-keys.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/settings/settings-sidebar-ssh-keys.png deleted file mode 100644 index c48d203519..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/settings/settings-sidebar-ssh-keys.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/settings/settings-ssh-key-review.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/settings/settings-ssh-key-review.png deleted file mode 100644 index 992d130778..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/settings/settings-ssh-key-review.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/settings/userbar-account-settings.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/settings/userbar-account-settings.png deleted file mode 100644 index f54ce518cd..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/settings/userbar-account-settings.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/setup/keychain-access.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/setup/keychain-access.png deleted file mode 100644 index 7628dd83b4..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/setup/keychain-access.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/sponsors/manage-your-sponsorship-button.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/sponsors/manage-your-sponsorship-button.png deleted file mode 100644 index 3c094ea2fc..0000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/sponsors/manage-your-sponsorship-button.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/3.0/assets/images/enterprise/management-console/code-scanning-disable.png b/assets/images/enterprise/legacy-format/3.0/assets/images/enterprise/management-console/code-scanning-disable.png deleted file mode 100644 index 3b5fbd47c9..0000000000 Binary files a/assets/images/enterprise/legacy-format/3.0/assets/images/enterprise/management-console/code-scanning-disable.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/3.0/assets/images/enterprise/management-console/enable-code-scanning-checkbox.png b/assets/images/enterprise/legacy-format/3.0/assets/images/enterprise/management-console/enable-code-scanning-checkbox.png deleted file mode 100644 index 396a52387f..0000000000 Binary files a/assets/images/enterprise/legacy-format/3.0/assets/images/enterprise/management-console/enable-code-scanning-checkbox.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/3.0/assets/images/enterprise/management-console/sidebar-advanced-security.png b/assets/images/enterprise/legacy-format/3.0/assets/images/enterprise/management-console/sidebar-advanced-security.png deleted file mode 100644 index dc1097dae2..0000000000 Binary files a/assets/images/enterprise/legacy-format/3.0/assets/images/enterprise/management-console/sidebar-advanced-security.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/3.0/assets/images/enterprise/site-admin-settings/add-announcement-button.png b/assets/images/enterprise/legacy-format/3.0/assets/images/enterprise/site-admin-settings/add-announcement-button.png deleted file mode 100644 index 1a8822138d..0000000000 Binary files a/assets/images/enterprise/legacy-format/3.0/assets/images/enterprise/site-admin-settings/add-announcement-button.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/3.0/assets/images/enterprise/site-admin-settings/edit-message.png b/assets/images/enterprise/legacy-format/3.0/assets/images/enterprise/site-admin-settings/edit-message.png deleted file mode 100644 index d7a61a4562..0000000000 Binary files a/assets/images/enterprise/legacy-format/3.0/assets/images/enterprise/site-admin-settings/edit-message.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/3.0/assets/images/enterprise/site-admin-settings/sign-out-add-message-button.png b/assets/images/enterprise/legacy-format/3.0/assets/images/enterprise/site-admin-settings/sign-out-add-message-button.png deleted file mode 100644 index 1dd271ada4..0000000000 Binary files a/assets/images/enterprise/legacy-format/3.0/assets/images/enterprise/site-admin-settings/sign-out-add-message-button.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/3.0/assets/images/enterprise/site-admin-settings/suspend.png b/assets/images/enterprise/legacy-format/3.0/assets/images/enterprise/site-admin-settings/suspend.png deleted file mode 100644 index 433cbf69cd..0000000000 Binary files a/assets/images/enterprise/legacy-format/3.0/assets/images/enterprise/site-admin-settings/suspend.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/3.0/assets/images/help/business-accounts/billing-license-info.png b/assets/images/enterprise/legacy-format/3.0/assets/images/help/business-accounts/billing-license-info.png deleted file mode 100644 index 9339722b3b..0000000000 Binary files a/assets/images/enterprise/legacy-format/3.0/assets/images/help/business-accounts/billing-license-info.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/3.0/assets/images/help/repository/code-scanning-click-alert.png b/assets/images/enterprise/legacy-format/3.0/assets/images/help/repository/code-scanning-click-alert.png deleted file mode 100644 index aeddd97f32..0000000000 Binary files a/assets/images/enterprise/legacy-format/3.0/assets/images/help/repository/code-scanning-click-alert.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/3.0/assets/images/help/repository/code-scanning-set-up-this-workflow.png b/assets/images/enterprise/legacy-format/3.0/assets/images/help/repository/code-scanning-set-up-this-workflow.png deleted file mode 100644 index 8ad80d52af..0000000000 Binary files a/assets/images/enterprise/legacy-format/3.0/assets/images/help/repository/code-scanning-set-up-this-workflow.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/3.0/assets/images/help/repository/dependency-graph-enable-button.png b/assets/images/enterprise/legacy-format/3.0/assets/images/help/repository/dependency-graph-enable-button.png deleted file mode 100644 index 813b0ada5a..0000000000 Binary files a/assets/images/enterprise/legacy-format/3.0/assets/images/help/repository/dependency-graph-enable-button.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/3.0/assets/images/help/repository/secret-scanning-click-alert.png b/assets/images/enterprise/legacy-format/3.0/assets/images/help/repository/secret-scanning-click-alert.png deleted file mode 100644 index f3f57f311f..0000000000 Binary files a/assets/images/enterprise/legacy-format/3.0/assets/images/help/repository/secret-scanning-click-alert.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/3.0/assets/images/help/repository/secret-scanning-resolve-alert.png b/assets/images/enterprise/legacy-format/3.0/assets/images/help/repository/secret-scanning-resolve-alert.png deleted file mode 100644 index 3454284124..0000000000 Binary files a/assets/images/enterprise/legacy-format/3.0/assets/images/help/repository/secret-scanning-resolve-alert.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/3.0/assets/images/help/sponsors/manage-your-sponsorship-button.png b/assets/images/enterprise/legacy-format/3.0/assets/images/help/sponsors/manage-your-sponsorship-button.png deleted file mode 100644 index 3c094ea2fc..0000000000 Binary files a/assets/images/enterprise/legacy-format/3.0/assets/images/help/sponsors/manage-your-sponsorship-button.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/README.md b/assets/images/enterprise/legacy-format/README.md deleted file mode 100644 index 7205e99284..0000000000 --- a/assets/images/enterprise/legacy-format/README.md +++ /dev/null @@ -1,7 +0,0 @@ -### Legacy assets - -**Do not add new images to this directory.** This directory will be removed after GHES 3.0 is deprecated. - -This directory stores images that were migrated to this repository from AWS S3. These images are not referenced directly in Markdown content. Images in this directory are rendered conditionally using a Unified.js plugin located at [`lib/render-content/plugins/rewite-legacy-asset-paths.js`](lib/render-content/plugins/rewite-legacy-asset-paths.js). When a page is rendered, the plugin checks whether the image referenced in the Markdown content (e.g., /assets/images/foo/bar.png) has a corresponding image in this directory for the version being rendered (e.g., /assets/images/enterprise/legacy-format//assets/images/foo/bar.png. If a corresponding image does exist in the `legacy-format` directory, the image from the `legacy-format` directory is rendered. If not, the image path referenced in the Markdown is used (e.g., /assets/images/foo/bar.png). - -This directory and the `rewrite-legacy-asset-paths` plugin will be removed when GHES 3.0 is deprecated in favor of single-sourcing the images referenced in Markdown, which requires versioning the images in the Markdown content using Liquid conditionals. \ No newline at end of file diff --git a/assets/images/enterprise/migration/restore-complete-screen.png b/assets/images/enterprise/migration/restore-complete-screen.png deleted file mode 100644 index 62105dadad..0000000000 Binary files a/assets/images/enterprise/migration/restore-complete-screen.png and /dev/null differ diff --git a/assets/images/github-apps/github_apps_content_reference_attachment.png b/assets/images/github-apps/content_reference_attachment.png similarity index 100% rename from assets/images/github-apps/github_apps_content_reference_attachment.png rename to assets/images/github-apps/content_reference_attachment.png diff --git a/assets/images/help/apps/github_apps_app_name.png b/assets/images/help/apps/github_apps_app_name.png deleted file mode 100644 index 8110688432..0000000000 Binary files a/assets/images/help/apps/github_apps_app_name.png and /dev/null differ diff --git a/assets/images/help/apps/github_apps_create_github_app.png b/assets/images/help/apps/github_apps_create_github_app.png deleted file mode 100644 index f828cdaf0c..0000000000 Binary files a/assets/images/help/apps/github_apps_create_github_app.png and /dev/null differ diff --git a/assets/images/help/apps/github_apps_homepage_url.png b/assets/images/help/apps/github_apps_homepage_url.png deleted file mode 100644 index f5b321725c..0000000000 Binary files a/assets/images/help/apps/github_apps_homepage_url.png and /dev/null differ diff --git a/assets/images/help/apps/github_apps_new.png b/assets/images/help/apps/github_apps_new.png deleted file mode 100644 index fb86904b8e..0000000000 Binary files a/assets/images/help/apps/github_apps_new.png and /dev/null differ diff --git a/assets/images/help/apps/github_apps_user_authorization.png b/assets/images/help/apps/github_apps_user_authorization.png deleted file mode 100644 index 31c8644bdb..0000000000 Binary files a/assets/images/help/apps/github_apps_user_authorization.png and /dev/null differ diff --git a/assets/images/help/apps/github_apps_webhook_secret.png b/assets/images/help/apps/github_apps_webhook_secret.png deleted file mode 100644 index b1626fbaa7..0000000000 Binary files a/assets/images/help/apps/github_apps_webhook_secret.png and /dev/null differ diff --git a/assets/images/help/apps/github_apps_webhook_url.png b/assets/images/help/apps/github_apps_webhook_url.png deleted file mode 100644 index cf9e1607e0..0000000000 Binary files a/assets/images/help/apps/github_apps_webhook_url.png and /dev/null differ diff --git a/assets/images/help/enterprises/ghas-orgs-list-click-org.png b/assets/images/help/billing/ghas-orgs-list-enterprise-click-org.png similarity index 100% rename from assets/images/help/enterprises/ghas-orgs-list-click-org.png rename to assets/images/help/billing/ghas-orgs-list-enterprise-click-org.png diff --git a/assets/images/help/enterprises/ghas-orgs-list.png b/assets/images/help/billing/ghas-orgs-list-enterprise.png similarity index 100% rename from assets/images/help/enterprises/ghas-orgs-list.png rename to assets/images/help/billing/ghas-orgs-list-enterprise.png diff --git a/assets/images/help/billing/settings_organization_billing_planning_tab.png b/assets/images/help/billing/settings_organization_billing_planning_tab.png new file mode 100644 index 0000000000..12fc994216 Binary files /dev/null and b/assets/images/help/billing/settings_organization_billing_planning_tab.png differ diff --git a/assets/images/help/dependabot/dependabot-secrets.png b/assets/images/help/dependabot/dependabot-secrets.png new file mode 100644 index 0000000000..74aba9a0bb Binary files /dev/null and b/assets/images/help/dependabot/dependabot-secrets.png differ diff --git a/assets/images/help/dependabot/secret-repository-access.png b/assets/images/help/dependabot/secret-repository-access.png new file mode 100644 index 0000000000..a4bd312861 Binary files /dev/null and b/assets/images/help/dependabot/secret-repository-access.png differ diff --git a/assets/images/help/dependabot/update-remove-org-secret.png b/assets/images/help/dependabot/update-remove-org-secret.png new file mode 100644 index 0000000000..94b7a0b804 Binary files /dev/null and b/assets/images/help/dependabot/update-remove-org-secret.png differ diff --git a/assets/images/help/dependabot/update-remove-repo-secret.png b/assets/images/help/dependabot/update-remove-repo-secret.png new file mode 100644 index 0000000000..dcbc3a0df4 Binary files /dev/null and b/assets/images/help/dependabot/update-remove-repo-secret.png differ diff --git a/assets/images/help/desktop/click-branch-in-drop-down-mac.png b/assets/images/help/desktop/click-branch-in-drop-down-mac.png index 54deda6f23..2099567450 100644 Binary files a/assets/images/help/desktop/click-branch-in-drop-down-mac.png and b/assets/images/help/desktop/click-branch-in-drop-down-mac.png differ diff --git a/assets/images/help/desktop/click-branch-in-drop-down.png b/assets/images/help/desktop/click-branch-in-drop-down.png deleted file mode 100644 index 2099567450..0000000000 Binary files a/assets/images/help/desktop/click-branch-in-drop-down.png and /dev/null differ diff --git a/assets/images/help/desktop/mac-changed-file-header.png b/assets/images/help/desktop/mac-changed-file-header.png new file mode 100644 index 0000000000..064f825973 Binary files /dev/null and b/assets/images/help/desktop/mac-changed-file-header.png differ diff --git a/assets/images/help/desktop/mac-discard-stashed-changes-button.png b/assets/images/help/desktop/mac-discard-stashed-changes-button.png new file mode 100644 index 0000000000..be1631765e Binary files /dev/null and b/assets/images/help/desktop/mac-discard-stashed-changes-button.png differ diff --git a/assets/images/help/desktop/mac-restore-stashed-changes-button.png b/assets/images/help/desktop/mac-restore-stashed-changes-button.png new file mode 100644 index 0000000000..1a0ae797d6 Binary files /dev/null and b/assets/images/help/desktop/mac-restore-stashed-changes-button.png differ diff --git a/assets/images/help/desktop/mac-stash-all-changes.png b/assets/images/help/desktop/mac-stash-all-changes.png new file mode 100644 index 0000000000..454f631f41 Binary files /dev/null and b/assets/images/help/desktop/mac-stash-all-changes.png differ diff --git a/assets/images/help/desktop/select-branch-to-delete.png b/assets/images/help/desktop/select-branch-from-dropdown.png similarity index 100% rename from assets/images/help/desktop/select-branch-to-delete.png rename to assets/images/help/desktop/select-branch-from-dropdown.png diff --git a/assets/images/help/desktop/mac-sign-in-browser.png b/assets/images/help/desktop/sign-in-browser.png similarity index 100% rename from assets/images/help/desktop/mac-sign-in-browser.png rename to assets/images/help/desktop/sign-in-browser.png diff --git a/assets/images/help/desktop/windows-changed-file-header.png b/assets/images/help/desktop/windows-changed-file-header.png new file mode 100644 index 0000000000..e1051eacd8 Binary files /dev/null and b/assets/images/help/desktop/windows-changed-file-header.png differ diff --git a/assets/images/help/desktop/windows-discard-stashed-changes-button.png b/assets/images/help/desktop/windows-discard-stashed-changes-button.png new file mode 100644 index 0000000000..5437acfea7 Binary files /dev/null and b/assets/images/help/desktop/windows-discard-stashed-changes-button.png differ diff --git a/assets/images/help/desktop/windows-restore-stashed-changes-button.png b/assets/images/help/desktop/windows-restore-stashed-changes-button.png new file mode 100644 index 0000000000..289d2f420f Binary files /dev/null and b/assets/images/help/desktop/windows-restore-stashed-changes-button.png differ diff --git a/assets/images/help/desktop/windows-sign-in-browser.png b/assets/images/help/desktop/windows-sign-in-browser.png deleted file mode 100644 index 20e28f8081..0000000000 Binary files a/assets/images/help/desktop/windows-sign-in-browser.png and /dev/null differ diff --git a/assets/images/help/desktop/windows-stash-all-changes.png b/assets/images/help/desktop/windows-stash-all-changes.png new file mode 100644 index 0000000000..2bf3afad8d Binary files /dev/null and b/assets/images/help/desktop/windows-stash-all-changes.png differ diff --git a/assets/images/help/enterprises/enterprise-licensing-tab-ghas-no-seats.png b/assets/images/help/enterprises/enterprise-licensing-tab-ghas-no-seats.png new file mode 100644 index 0000000000..0c962fc6a1 Binary files /dev/null and b/assets/images/help/enterprises/enterprise-licensing-tab-ghas-no-seats.png differ diff --git a/assets/images/help/enterprises/enterprise-licensing-tab-ghas.png b/assets/images/help/enterprises/enterprise-licensing-tab-ghas.png new file mode 100644 index 0000000000..c8b4089113 Binary files /dev/null and b/assets/images/help/enterprises/enterprise-licensing-tab-ghas.png differ diff --git a/assets/images/help/enterprises/settings-security-analysis-ghas-repos-list.png b/assets/images/help/enterprises/settings-security-analysis-ghas-repos-list.png new file mode 100644 index 0000000000..519b42620a Binary files /dev/null and b/assets/images/help/enterprises/settings-security-analysis-ghas-repos-list.png differ diff --git a/assets/images/help/issues/issues_assignee_dropdown.png b/assets/images/help/issues/issues_assignee_dropdown.png index 36b54dccaa..f4b4d7f6b5 100644 Binary files a/assets/images/help/issues/issues_assignee_dropdown.png and b/assets/images/help/issues/issues_assignee_dropdown.png differ diff --git a/assets/images/help/issues/issues_assigning_dropdown.png b/assets/images/help/issues/issues_assigning_dropdown.png index d16bd1b9e9..cd1742ae77 100644 Binary files a/assets/images/help/issues/issues_assigning_dropdown.png and b/assets/images/help/issues/issues_assigning_dropdown.png differ diff --git a/assets/images/help/notifications-v2/mobile-watch-button.png b/assets/images/help/notifications-v2/mobile-watch-button.png new file mode 100644 index 0000000000..b5a3fa3af0 Binary files /dev/null and b/assets/images/help/notifications-v2/mobile-watch-button.png differ diff --git a/assets/images/help/notifications-v2/mobile-watch-settings.png b/assets/images/help/notifications-v2/mobile-watch-settings.png new file mode 100644 index 0000000000..9b6a485bfa Binary files /dev/null and b/assets/images/help/notifications-v2/mobile-watch-settings.png differ diff --git a/assets/images/help/organizations/dependabot-private-repo-choose.png b/assets/images/help/organizations/dependabot-private-repo-choose.png new file mode 100644 index 0000000000..78774eeeb2 Binary files /dev/null and b/assets/images/help/organizations/dependabot-private-repo-choose.png differ diff --git a/assets/images/help/organizations/dependabot-private-repository-access.png b/assets/images/help/organizations/dependabot-private-repository-access.png new file mode 100644 index 0000000000..1d2e622bca Binary files /dev/null and b/assets/images/help/organizations/dependabot-private-repository-access.png differ diff --git a/assets/images/help/organizations/dependabot-private-repository-list.png b/assets/images/help/organizations/dependabot-private-repository-list.png new file mode 100644 index 0000000000..e1af566130 Binary files /dev/null and b/assets/images/help/organizations/dependabot-private-repository-list.png differ diff --git a/assets/images/help/organizations/ghas-repos-list.png b/assets/images/help/organizations/ghas-repos-list.png deleted file mode 100644 index daa5230cf9..0000000000 Binary files a/assets/images/help/organizations/ghas-repos-list.png and /dev/null differ diff --git a/assets/images/help/organizations/org-invite-modal-ghe.png b/assets/images/help/organizations/org-invite-modal-ghe.png deleted file mode 100644 index 2bd6fcefca..0000000000 Binary files a/assets/images/help/organizations/org-invite-modal-ghe.png and /dev/null differ diff --git a/assets/images/help/organizations/org-settings-security-tab.png b/assets/images/help/organizations/org-settings-security-tab.png deleted file mode 100644 index 64c8a259b0..0000000000 Binary files a/assets/images/help/organizations/org-settings-security-tab.png and /dev/null differ diff --git a/assets/images/help/organizations/repositories-dialog.png b/assets/images/help/organizations/repositories-dialog.png deleted file mode 100644 index 7743ed2e6b..0000000000 Binary files a/assets/images/help/organizations/repositories-dialog.png and /dev/null differ diff --git a/assets/images/help/organizations/repository-access-cog-button.png b/assets/images/help/organizations/repository-access-cog-button.png deleted file mode 100644 index 94cab6198c..0000000000 Binary files a/assets/images/help/organizations/repository-access-cog-button.png and /dev/null differ diff --git a/assets/images/help/organizations/security-and-analysis-highlight-ghas.png b/assets/images/help/organizations/security-and-analysis-highlight-ghas.png deleted file mode 100644 index cd4856c503..0000000000 Binary files a/assets/images/help/organizations/security-and-analysis-highlight-ghas.png and /dev/null differ diff --git a/assets/images/help/organizations/settings-security-analysis-ghas-repos-list.png b/assets/images/help/organizations/settings-security-analysis-ghas-repos-list.png new file mode 100644 index 0000000000..c9121bc5b9 Binary files /dev/null and b/assets/images/help/organizations/settings-security-analysis-ghas-repos-list.png differ diff --git a/assets/images/help/package-registry/ghes-packages-diagram.png b/assets/images/help/package-registry/ghes-packages-diagram.png deleted file mode 100644 index 7006ce5c96..0000000000 Binary files a/assets/images/help/package-registry/ghes-packages-diagram.png and /dev/null differ diff --git a/assets/images/help/package-registry/make-all-container-versions-visible.png b/assets/images/help/package-registry/make-all-container-versions-visible.png deleted file mode 100644 index 29a7e88a40..0000000000 Binary files a/assets/images/help/package-registry/make-all-container-versions-visible.png and /dev/null differ diff --git a/assets/images/help/package-registry/packages-overview-diagram.png b/assets/images/help/package-registry/packages-overview-diagram.png index adf499d586..50f07869cc 100644 Binary files a/assets/images/help/package-registry/packages-overview-diagram.png and b/assets/images/help/package-registry/packages-overview-diagram.png differ diff --git a/assets/images/help/pages/gemfile-instructions.png b/assets/images/help/pages/gemfile-instructions.png deleted file mode 100644 index d7e1105097..0000000000 Binary files a/assets/images/help/pages/gemfile-instructions.png and /dev/null differ diff --git a/assets/images/help/repository/code-scanning-branch-dropdown.png b/assets/images/help/repository/code-scanning-branch-dropdown.png index c78415529f..9671a8c891 100644 Binary files a/assets/images/help/repository/code-scanning-branch-dropdown.png and b/assets/images/help/repository/code-scanning-branch-dropdown.png differ diff --git a/assets/images/help/repository/code-scanning-click-alert.png b/assets/images/help/repository/code-scanning-click-alert.png index b546930cfd..f62f131530 100644 Binary files a/assets/images/help/repository/code-scanning-click-alert.png and b/assets/images/help/repository/code-scanning-click-alert.png differ diff --git a/assets/images/help/repository/sidebar-code-scanning-alerts.png b/assets/images/help/repository/sidebar-code-scanning-alerts.png index 1703205b5b..6dab36ebf6 100644 Binary files a/assets/images/help/repository/sidebar-code-scanning-alerts.png and b/assets/images/help/repository/sidebar-code-scanning-alerts.png differ diff --git a/assets/images/help/repository/sidebar-secrets.png b/assets/images/help/repository/sidebar-secrets.png index b92c4537b9..4053a57065 100644 Binary files a/assets/images/help/repository/sidebar-secrets.png and b/assets/images/help/repository/sidebar-secrets.png differ diff --git a/assets/images/help/security/ip-address-delete-button.png b/assets/images/help/security/ip-address-delete-button.png index a1dc64631a..9f0508910b 100644 Binary files a/assets/images/help/security/ip-address-delete-button.png and b/assets/images/help/security/ip-address-delete-button.png differ diff --git a/assets/images/help/security/ip-address-edit-button.png b/assets/images/help/security/ip-address-edit-button.png index 206d6a74c2..46718c2b20 100644 Binary files a/assets/images/help/security/ip-address-edit-button.png and b/assets/images/help/security/ip-address-edit-button.png differ diff --git a/assets/images/help/security/ip-address-edit-field.png b/assets/images/help/security/ip-address-edit-field.png index b2e7d4540c..88fcf76614 100644 Binary files a/assets/images/help/security/ip-address-edit-field.png and b/assets/images/help/security/ip-address-edit-field.png differ diff --git a/assets/images/help/security/ip-address-edit-name-field.png b/assets/images/help/security/ip-address-edit-name-field.png index c2e4935986..e3586a1954 100644 Binary files a/assets/images/help/security/ip-address-edit-name-field.png and b/assets/images/help/security/ip-address-edit-name-field.png differ diff --git a/assets/images/help/security/ip-address-field.png b/assets/images/help/security/ip-address-field.png index 2dee7c8871..0b5d837937 100644 Binary files a/assets/images/help/security/ip-address-field.png and b/assets/images/help/security/ip-address-field.png differ diff --git a/assets/images/help/security/ip-address-name-field.png b/assets/images/help/security/ip-address-name-field.png index 98ad82a08d..1937af4bcc 100644 Binary files a/assets/images/help/security/ip-address-name-field.png and b/assets/images/help/security/ip-address-name-field.png differ diff --git a/assets/images/help/security/new-allowlist-entry-button.png b/assets/images/help/security/new-allowlist-entry-button.png index 67a7f7336c..639ddbd2af 100644 Binary files a/assets/images/help/security/new-allowlist-entry-button.png and b/assets/images/help/security/new-allowlist-entry-button.png differ diff --git a/assets/images/help/security/overview-set-up-code-scanning.png b/assets/images/help/security/overview-set-up-code-scanning.png index 604380502f..8743911b29 100644 Binary files a/assets/images/help/security/overview-set-up-code-scanning.png and b/assets/images/help/security/overview-set-up-code-scanning.png differ diff --git a/assets/images/help/settings/actions-enterprise-account-add-runner-group-options.png b/assets/images/help/settings/actions-enterprise-account-add-runner-group-options.png index 8c8d2b8b91..2ad8cbc630 100644 Binary files a/assets/images/help/settings/actions-enterprise-account-add-runner-group-options.png and b/assets/images/help/settings/actions-enterprise-account-add-runner-group-options.png differ diff --git a/assets/images/help/settings/actions-enterprise-policies.png b/assets/images/help/settings/actions-enterprise-policies.png new file mode 100644 index 0000000000..b53045e0f0 Binary files /dev/null and b/assets/images/help/settings/actions-enterprise-policies.png differ diff --git a/assets/images/help/settings/actions-hosted-runner-add-new-group.png b/assets/images/help/settings/actions-hosted-runner-add-new-group.png new file mode 100644 index 0000000000..1fa8f059ea Binary files /dev/null and b/assets/images/help/settings/actions-hosted-runner-add-new-group.png differ diff --git a/assets/images/help/settings/actions-hosted-runner-group-kebab.png b/assets/images/help/settings/actions-hosted-runner-group-kebab.png new file mode 100644 index 0000000000..fb805f6fb3 Binary files /dev/null and b/assets/images/help/settings/actions-hosted-runner-group-kebab.png differ diff --git a/assets/images/help/settings/actions-hosted-runner-group-member-move-destination.png b/assets/images/help/settings/actions-hosted-runner-group-member-move-destination.png new file mode 100644 index 0000000000..5380086c5b Binary files /dev/null and b/assets/images/help/settings/actions-hosted-runner-group-member-move-destination.png differ diff --git a/assets/images/help/settings/actions-hosted-runner-group-member-move.png b/assets/images/help/settings/actions-hosted-runner-group-member-move.png new file mode 100644 index 0000000000..e698056a7c Binary files /dev/null and b/assets/images/help/settings/actions-hosted-runner-group-member-move.png differ diff --git a/assets/images/help/settings/actions-hosted-runner-group-members.png b/assets/images/help/settings/actions-hosted-runner-group-members.png new file mode 100644 index 0000000000..72acf1201a Binary files /dev/null and b/assets/images/help/settings/actions-hosted-runner-group-members.png differ diff --git a/assets/images/help/settings/actions-hosted-runner-group-remove.png b/assets/images/help/settings/actions-hosted-runner-group-remove.png new file mode 100644 index 0000000000..eea19694b9 Binary files /dev/null and b/assets/images/help/settings/actions-hosted-runner-group-remove.png differ diff --git a/assets/images/help/settings/actions-hosted-runner-list-label.png b/assets/images/help/settings/actions-hosted-runner-list-label.png new file mode 100644 index 0000000000..c0705c7b34 Binary files /dev/null and b/assets/images/help/settings/actions-hosted-runner-list-label.png differ diff --git a/assets/images/help/settings/actions-org-add-runner-group-options.png b/assets/images/help/settings/actions-org-add-runner-group-options.png index f68e357a60..e81f26dbd7 100644 Binary files a/assets/images/help/settings/actions-org-add-runner-group-options.png and b/assets/images/help/settings/actions-org-add-runner-group-options.png differ diff --git a/assets/images/help/settings/settings-sidebar-actions.png b/assets/images/help/settings/settings-sidebar-actions.png index 8fa42ac068..99fe42b0cf 100644 Binary files a/assets/images/help/settings/settings-sidebar-actions.png and b/assets/images/help/settings/settings-sidebar-actions.png differ diff --git a/assets/images/help/writing/content-attachment.png b/assets/images/help/writing/content-attachment.png deleted file mode 100644 index 0d530dd933..0000000000 Binary files a/assets/images/help/writing/content-attachment.png and /dev/null differ diff --git a/assets/images/settings/oauth_apps_post2dot12.png b/assets/images/settings/oauth_apps_post2dot12.png deleted file mode 100644 index 23b2d90029..0000000000 Binary files a/assets/images/settings/oauth_apps_post2dot12.png and /dev/null differ diff --git a/content/README.md b/content/README.md index 5659f2928a..45b571c323 100644 --- a/content/README.md +++ b/content/README.md @@ -25,6 +25,7 @@ See the [contributing docs](/CONTRIBUTING.md) for general information about work - [`includeGuides`](#includeGuides) - [`type`](#type) - [`topics`](#topics) + - [`contributor`](#contributor) - [Escaping single quotes](#escaping-single-quotes) - [Autogenerated mini TOCs](#autogenerated-mini-tocs) - [Versioning](#versioning) @@ -227,10 +228,22 @@ includeGuides: - Optional. ### `topics` -- Purpose: Indicate the topics covered by the article. -- Type: `String` +- Purpose: Indicate the topics covered by the article. The topics are used to filter guides on some landing pages. For example, the guides at the bottom of [this page](https://docs.github.com/en/actions/guides) can be filtered by topics and the topics are listed under the guide intro. Topics are also added to all search records that get created for each page. The search records contain a `topics` property that is used to filter search results by topics. For more information, see the [Search](/contributing/search.md) contributing guide. Refer to the content models for more details around adding topics. A full list of existing topics is located in the [allowed topics file](/data/allowed-topics.js). If topics in article frontmatter and the allow-topics list become out of sync, the [topics CI test](/tests/unit/search/topics.js) will fail. +- Type: Array of `String`s +- Optional: Topics are preferred for each article, but, there may be cases where existing articles don't yet have topics or a adding a topic to a new article may not add value. + +### `contributor` +- Purpose: Indicate an article is contributed and maintained by a third-party organization, typically a GitHub Technology Partner. +- Type: `Object`. Properties are `name` and `URL`. - Optional. +Example: + +```yml +contributor: + name: ACME, inc. + URL: https://acme.example.com/ +``` ### Escaping single quotes diff --git a/content/actions/creating-actions/about-actions.md b/content/actions/creating-actions/about-actions.md index 4c9b2e16ea..d3cd0448b4 100644 --- a/content/actions/creating-actions/about-actions.md +++ b/content/actions/creating-actions/about-actions.md @@ -10,6 +10,7 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'overview' topics: - 'Action development' @@ -18,6 +19,7 @@ topics: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### About actions @@ -125,7 +127,7 @@ steps: #### Using a commit's SHA for release management -Each Git commit receives a calculated SHA value, which is unique and immutable. Your action's users might prefer to rely on a commit's SHA value, as this approach can be more reliable than specifying a tag, which could be deleted or moved. However, this means that users will not receive further updates made to the action. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}You must use a commit's full SHA value, and not an abbreviated value.{% else %}Using a commit's full SHA value instead of the abbreviated value can help prevent people from using a malicious commit that uses the same abbreviation.{% endif %} +Each Git commit receives a calculated SHA value, which is unique and immutable. Your action's users might prefer to rely on a commit's SHA value, as this approach can be more reliable than specifying a tag, which could be deleted or moved. However, this means that users will not receive further updates made to the action. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %}You must use a commit's full SHA value, and not an abbreviated value.{% else %}Using a commit's full SHA value instead of the abbreviated value can help prevent people from using a malicious commit that uses the same abbreviation.{% endif %} ```yaml steps: diff --git a/content/actions/creating-actions/creating-a-composite-run-steps-action.md b/content/actions/creating-actions/creating-a-composite-run-steps-action.md index efd8430a3c..52b38993e9 100644 --- a/content/actions/creating-actions/creating-a-composite-run-steps-action.md +++ b/content/actions/creating-actions/creating-a-composite-run-steps-action.md @@ -5,6 +5,7 @@ product: '{% data reusables.gated-features.actions %}' versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'tutorial' topics: - 'Action development' @@ -12,6 +13,7 @@ topics: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### Introduction 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 33fa426b4b..844766f6cb 100644 --- a/content/actions/creating-actions/creating-a-docker-container-action.md +++ b/content/actions/creating-actions/creating-a-docker-container-action.md @@ -10,6 +10,7 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'tutorial' topics: - 'Action development' @@ -18,6 +19,7 @@ topics: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### Introduction @@ -32,9 +34,13 @@ Once you complete this project, you should understand how to build your own Dock You may find it helpful to have a basic understanding of {% data variables.product.prodname_actions %} environment variables and the Docker container filesystem: - "[Using environment variables](/actions/automating-your-workflow-with-github-actions/using-environment-variables)" +{% if currentVersion == "github-ae@latest" %} +- "[Docker container filesystem](/actions/using-github-hosted-runners/about-ae-hosted-runners#docker-container-filesystem)." +{% else %} - "[Virtual environments for {% data variables.product.prodname_dotcom %}](/actions/automating-your-workflow-with-github-actions/virtual-environments-for-github-hosted-runners#docker-container-filesystem)" +{% endif %} -Before you begin, you'll need to create a GitHub repository. +Before you begin, you'll need to create a {% data variables.product.prodname_dotcom %} repository. 1. Create a new repository on {% data variables.product.product_location %}. You can choose any repository name or use "hello-world-docker-action" like this example. For more information, see "[Create a new repository](/articles/creating-a-new-repository)." @@ -229,9 +235,9 @@ jobs: ``` {% endraw %} -From your repository, click the **Actions** tab, and select the latest workflow run. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}Under **Jobs** or in the visualization graph, click **A job to say hello**. {% endif %}You should see "Hello Mona the Octocat" or the name you used for the `who-to-greet` input and the timestamp printed in the log. +From your repository, click the **Actions** tab, and select the latest workflow run. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %}Under **Jobs** or in the visualization graph, click **A job to say hello**. {% endif %}You should see "Hello Mona the Octocat" or the name you used for the `who-to-greet` input and the timestamp printed in the log. -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %} ![A screenshot of using your action in a workflow](/assets/images/help/repository/docker-action-workflow-run-updated.png) {% else %} ![A screenshot of using your action in a workflow](/assets/images/help/repository/docker-action-workflow-run.png) diff --git a/content/actions/creating-actions/creating-a-javascript-action.md b/content/actions/creating-actions/creating-a-javascript-action.md index 0068ed60a5..960241781f 100644 --- a/content/actions/creating-actions/creating-a-javascript-action.md +++ b/content/actions/creating-actions/creating-a-javascript-action.md @@ -10,6 +10,7 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'tutorial' topics: - 'Action development' @@ -18,6 +19,7 @@ topics: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### Introduction @@ -265,9 +267,9 @@ jobs: ``` {% endraw %} -From your repository, click the **Actions** tab, and select the latest workflow run. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}Under **Jobs** or in the visualization graph, click **A job to say hello**. {% endif %}You should see "Hello Mona the Octocat" or the name you used for the `who-to-greet` input and the timestamp printed in the log. +From your repository, click the **Actions** tab, and select the latest workflow run. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %}Under **Jobs** or in the visualization graph, click **A job to say hello**. {% endif %}You should see "Hello Mona the Octocat" or the name you used for the `who-to-greet` input and the timestamp printed in the log. -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %} ![A screenshot of using your action in a workflow](/assets/images/help/repository/javascript-action-workflow-run-updated-2.png) {% elsif currentVersion ver_gt "enterprise-server@2.22" %} ![A screenshot of using your action in a workflow](/assets/images/help/repository/javascript-action-workflow-run-updated.png) diff --git a/content/actions/creating-actions/dockerfile-support-for-github-actions.md b/content/actions/creating-actions/dockerfile-support-for-github-actions.md index dba9c8dd1e..5fa52db771 100644 --- a/content/actions/creating-actions/dockerfile-support-for-github-actions.md +++ b/content/actions/creating-actions/dockerfile-support-for-github-actions.md @@ -8,11 +8,13 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'reference' --- {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### About Dockerfile instructions diff --git a/content/actions/creating-actions/index.md b/content/actions/creating-actions/index.md index 966e98032b..69567c4378 100644 --- a/content/actions/creating-actions/index.md +++ b/content/actions/creating-actions/index.md @@ -10,10 +10,12 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} {% link_in_list /about-actions %} {% link_in_list /creating-a-docker-container-action %} diff --git a/content/actions/creating-actions/metadata-syntax-for-github-actions.md b/content/actions/creating-actions/metadata-syntax-for-github-actions.md index 4dfb33bcf8..1052bd4b76 100644 --- a/content/actions/creating-actions/metadata-syntax-for-github-actions.md +++ b/content/actions/creating-actions/metadata-syntax-for-github-actions.md @@ -11,11 +11,13 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'reference' --- {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### About YAML syntax for {% data variables.product.prodname_actions %} @@ -247,7 +249,7 @@ For more information, see "[`github context`](/actions/reference/context-and-exp ##### `runs.steps[*].env` -**Optional** Sets a `map` of environment variables for only that step. If you want to modify the environment variable stored in the workflow, use {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}`echo "{name}={value}" >> $GITHUB_ENV`{% else %}`echo "::set-env name={name}::{value}"`{% endif %} in a composite run step. +**Optional** Sets a `map` of environment variables for only that step. If you want to modify the environment variable stored in the workflow, use {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %}`echo "{name}={value}" >> $GITHUB_ENV`{% else %}`echo "::set-env name={name}::{value}"`{% endif %} in a composite run step. ##### `runs.steps[*].working-directory` @@ -297,7 +299,7 @@ runs: #### `runs.image` -**Required** The Docker image to use as the container to run the action. The value can be the Docker base image name, a local `Dockerfile` in your repository, or a public image in Docker Hub or another registry. To reference a `Dockerfile` local to your repository, use a path relative to your action metadata file. The `docker` application will execute this file. +**Required** The Docker image to use as the container to run the action. The value can be the Docker base image name, a local `Dockerfile` in your repository, or a public image in Docker Hub or another registry. To reference a `Dockerfile` local to your repository, the file must be named `Dockerfile` and you must use a path relative to your action metadata file. The `docker` application will execute this file. #### `runs.env` diff --git a/content/actions/creating-actions/publishing-actions-in-github-marketplace.md b/content/actions/creating-actions/publishing-actions-in-github-marketplace.md index b69b89065b..564cc04531 100644 --- a/content/actions/creating-actions/publishing-actions-in-github-marketplace.md +++ b/content/actions/creating-actions/publishing-actions-in-github-marketplace.md @@ -11,6 +11,8 @@ versions: type: 'how_to' --- +{% data reusables.actions.ae-beta %} + You must accept the terms of service to publish actions in {% data variables.product.prodname_marketplace %}. ### About publishing actions diff --git a/content/actions/creating-actions/setting-exit-codes-for-actions.md b/content/actions/creating-actions/setting-exit-codes-for-actions.md index 2a733849d5..5a65cac300 100644 --- a/content/actions/creating-actions/setting-exit-codes-for-actions.md +++ b/content/actions/creating-actions/setting-exit-codes-for-actions.md @@ -8,11 +8,13 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'how_to' --- {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### About exit codes diff --git a/content/actions/guides/about-continuous-integration.md b/content/actions/guides/about-continuous-integration.md index c85d6cd06b..305d9cbdee 100644 --- a/content/actions/guides/about-continuous-integration.md +++ b/content/actions/guides/about-continuous-integration.md @@ -10,6 +10,7 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'overview' topics: - 'CI' @@ -18,6 +19,7 @@ topics: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### About continuous integration @@ -29,7 +31,9 @@ Building and testing your code requires a server. You can build and test updates ### About continuous integration using {% data variables.product.prodname_actions %} -CI using {% data variables.product.prodname_actions %} offers workflows that can build the code in your repository and run your tests. Workflows can run on {% data variables.product.prodname_dotcom %}-hosted virtual machines, or on machines that you host yourself. For more information, see "[Virtual environments for {% data variables.product.prodname_dotcom %}-hosted runners](/actions/automating-your-workflow-with-github-actions/virtual-environments-for-github-hosted-runners)" and "[About self-hosted runners](/actions/automating-your-workflow-with-github-actions/about-self-hosted-runners)." +{% if currentVersion == "github-ae@latest" %}CI using {% data variables.product.prodname_actions %} offers workflows that can build the code in your repository and run your tests. Workflows can run on virtual machines hosted by {% data variables.product.prodname_dotcom %}. For more information, see "[About {% data variables.actions.hosted_runner %}s](/actions/using-github-hosted-runners/about-ae-hosted-runners)." +{% else %} CI using {% data variables.product.prodname_actions %} offers workflows that can build the code in your repository and run your tests. Workflows can run on {% data variables.product.prodname_dotcom %}-hosted virtual machines, or on machines that you host yourself. For more information, see "[Virtual environments for {% data variables.product.prodname_dotcom %}-hosted runners](/actions/automating-your-workflow-with-github-actions/virtual-environments-for-github-hosted-runners)" and "[About self-hosted runners](/actions/automating-your-workflow-with-github-actions/about-self-hosted-runners)." +{% endif %} You can configure your CI workflow to run when a {% data variables.product.product_name %} event occurs (for example, when new code is pushed to your repository), on a set schedule, or when an external event occurs using the repository dispatch webhook. @@ -49,6 +53,26 @@ For a definition of common terms, see "[Core concepts for {% data variables.prod Browse the complete list of CI workflow templates offered by {% data variables.product.product_name %} in the {% if currentVersion == "free-pro-team@latest" %}[actions/starter-workflows](https://github.com/actions/starter-workflows/tree/main/ci) repository{% else %} `actions/starter-workflows` repository on {% data variables.product.product_location %}{% endif %}. +### Skipping workflow runs + +If you want to temporarily prevent a workflow from being triggered, you can add a skip instruction to the commit message. Workflows that would otherwise be triggered `on: push` or `on: pull_request`, won't be triggered if you add any any of the following strings to the commit message in a push, or the HEAD commit of a pull request: + +* `[skip ci]` +* `[ci skip]` +* `[no ci]` +* `[skip actions]` +* `[actions skip]` + +Alternatively, you can end the commit message with two empty lines followed by either `skip-checks: true` or `skip-checks:true`. + +You won't be able to merge the pull request if your repository is configured to require specific checks to pass first. To allow the pull request to be merged you can push a new commit to the pull request without the skip instruction in the commit message. + +{% note %} + +**Note:** Skip instructions only apply to the `push` and `pull_request` events. For example, adding `[skip ci]` to a commit message won't stop a workflow that's triggered `on: pull_request_target` from running. + +{% endnote %} + ### Notifications for workflow runs {% data reusables.repositories.workflow-notifications %} diff --git a/content/actions/guides/about-packaging-with-github-actions.md b/content/actions/guides/about-packaging-with-github-actions.md index 77fbd944bd..0b3d9fb516 100644 --- a/content/actions/guides/about-packaging-with-github-actions.md +++ b/content/actions/guides/about-packaging-with-github-actions.md @@ -8,6 +8,7 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'overview' topics: - 'Packaging' @@ -15,6 +16,7 @@ topics: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### About packaging steps @@ -28,7 +30,7 @@ Creating a package at the end of a continuous integration workflow can help duri Now, when reviewing a pull request, you'll be able to look at the workflow run and download the artifact that was produced. -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %} ![Download artifact drop-down menu](/assets/images/help/repository/artifact-drop-down-updated.png) {% else %} ![Download artifact drop-down menu](/assets/images/help/repository/artifact-drop-down.png) diff --git a/content/actions/guides/about-service-containers.md b/content/actions/guides/about-service-containers.md index 5c5172fd92..ae58afd85d 100644 --- a/content/actions/guides/about-service-containers.md +++ b/content/actions/guides/about-service-containers.md @@ -8,6 +8,7 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'overview' topics: - 'Containers' @@ -16,6 +17,7 @@ topics: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### About service containers diff --git a/content/actions/guides/adding-labels-to-issues.md b/content/actions/guides/adding-labels-to-issues.md new file mode 100644 index 0000000000..618af66b80 --- /dev/null +++ b/content/actions/guides/adding-labels-to-issues.md @@ -0,0 +1,68 @@ +--- +title: Adding labels to issues +intro: You can use {% data variables.product.prodname_actions %} to automatically label issues. +product: '{% data reusables.gated-features.actions %}' +versions: + free-pro-team: '*' + enterprise-server: '>=2.22' + github-ae: '*' +type: 'tutorial' +topics: + - 'Workflows' + - 'Project management' +--- + +{% data reusables.actions.enterprise-beta %} +{% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} +{% data reusables.actions.ae-self-hosted-runners-notice %} + +### Introduction + +This tutorial demonstrates how to use the [`andymckay/labeler` action](https://github.com/marketplace/actions/simple-issue-labeler) in a workflow to label newly opened or reopened issues. For example, you can add the `triage` label every time an issue is opened or reopened. Then, you can see all issues that need to be triaged by filtering for issues with the `triage` label. + +In the tutorial, you will first make a workflow file that uses the [`andymckay/labeler` action](https://github.com/marketplace/actions/simple-issue-labeler). Then, you will customize the workflow to suit your needs. + +### Creating the workflow + +1. {% data reusables.actions.choose-repo %} +2. {% data reusables.actions.make-workflow-file %} +3. Copy the following YAML contents into your workflow file. + + {% raw %} + ```yaml{:copy} + name: Label issues + on: + issues: + types: + - reopened + - opened + jobs: + label_issues: + runs-on: ubuntu-latest + steps: + - name: Label issues + uses: andymckay/labeler@1.0.2 + with: + add-labels: "triage" + ``` + {% endraw %} +4. Customize the parameters in your workflow file: + - Change the value for `add-labels` to the list of labels that you want to add to the issue. Separate multiple labels with commas. For example, `"help wanted, good first issue"`. For more information about labels, see "[Managing labels](/github/managing-your-work-on-github/managing-labels#applying-labels-to-issues-and-pull-requests)." +5. {% data reusables.actions.commit-workflow %} + +### Testing the workflow + +Every time an issue in your repository is opened or reopened, this workflow will add the labels that you specified to the issue. + +Test out your workflow by creating an issue in your repository. + +1. Create an issue in your repository. For more information, see "[Creating an issue](/github/managing-your-work-on-github/creating-an-issue)." +2. To see the workflow run that was triggered by creating the issue, view the history of your workflow runs. For more information, see "[Viewing workflow run history](/actions/managing-workflow-runs/viewing-workflow-run-history)." +3. When the workflow completes, the issue that you created should have the specified labels added. + +### Next steps + +- To learn more about additional things you can do with the `andymckay/labeler` action, like removing labels or skipping this action if the issue is assigned or has a specific label, see the [`andymckay/labeler` action documentation](https://github.com/marketplace/actions/simple-issue-labeler). +- To learn more about different events that can trigger your workflow, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows#issues)." The `andymckay/labeler` action only works on `issues`, `pull_request`, or `project_card` events. +- [Search GitHub](https://github.com/search?q=%22uses:+andymckay/labeler%22&type=code) for examples of workflows using this action. 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 4fa691d578..e118039190 100644 --- a/content/actions/guides/building-and-testing-java-with-ant.md +++ b/content/actions/guides/building-and-testing-java-with-ant.md @@ -7,6 +7,7 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'tutorial' topics: - 'CI' @@ -16,12 +17,16 @@ topics: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### Introduction This guide shows you how to create a workflow that performs continuous integration (CI) for your Java project using the Ant build system. The workflow you create will allow you to see when commits to a pull request cause build or test failures against your default branch; this approach can help ensure that your code is always healthy. You can extend your CI workflow to upload artifacts from a workflow run. +{% if currentVersion == "github-ae@latest" %}For instructions on how to make sure your {% data variables.actions.hosted_runner %} has the required software installed, see "[Creating custom images](/actions/using-github-hosted-runners/creating-custom-images)." +{% else %} {% data variables.product.prodname_dotcom %}-hosted runners have a tools cache with pre-installed software, which includes Java Development Kits (JDKs) and Ant. For a list of software and the pre-installed versions for JDK and Ant, see "[Specifications for {% data variables.product.prodname_dotcom %}-hosted runners](/actions/reference/specifications-for-github-hosted-runners/#supported-software)". +{% endif %} ### Prerequisites 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 b1349bbb21..38ca522caf 100644 --- a/content/actions/guides/building-and-testing-java-with-gradle.md +++ b/content/actions/guides/building-and-testing-java-with-gradle.md @@ -7,6 +7,7 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'tutorial' topics: - 'CI' @@ -16,12 +17,16 @@ topics: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### Introduction This guide shows you how to create a workflow that performs continuous integration (CI) for your Java project using the Gradle build system. The workflow you create will allow you to see when commits to a pull request cause build or test failures against your default branch; this approach can help ensure that your code is always healthy. You can extend your CI workflow to cache files and upload artifacts from a workflow run. +{% if currentVersion == "github-ae@latest" %}For instructions on how to make sure your {% data variables.actions.hosted_runner %} has the required software installed, see "[Creating custom images](/actions/using-github-hosted-runners/creating-custom-images)." +{% else %} {% data variables.product.prodname_dotcom %}-hosted runners have a tools cache with pre-installed software, which includes Java Development Kits (JDKs) and Gradle. For a list of software and the pre-installed versions for JDK and Gradle, see "[Specifications for {% data variables.product.prodname_dotcom %}-hosted runners](/actions/reference/specifications-for-github-hosted-runners/#supported-software)". +{% endif %} ### Prerequisites 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 84c68b6dae..483caa962f 100644 --- a/content/actions/guides/building-and-testing-java-with-maven.md +++ b/content/actions/guides/building-and-testing-java-with-maven.md @@ -7,6 +7,7 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'tutorial' topics: - 'CI' @@ -16,12 +17,16 @@ topics: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### Introduction This guide shows you how to create a workflow that performs continuous integration (CI) for your Java project using the Maven software project management tool. The workflow you create will allow you to see when commits to a pull request cause build or test failures against your default branch; this approach can help ensure that your code is always healthy. You can extend your CI workflow to cache files and upload artifacts from a workflow run. +{% if currentVersion == "github-ae@latest" %}For instructions on how to make sure your {% data variables.actions.hosted_runner %} has the required software installed, see "[Creating custom images](/actions/using-github-hosted-runners/creating-custom-images)." +{% else %} {% data variables.product.prodname_dotcom %}-hosted runners have a tools cache with pre-installed software, which includes Java Development Kits (JDKs) and Maven. For a list of software and the pre-installed versions for JDK and Maven, see "[Specifications for {% data variables.product.prodname_dotcom %}-hosted runners](/actions/reference/specifications-for-github-hosted-runners/#supported-software)". +{% endif %} ### Prerequisites diff --git a/content/actions/guides/building-and-testing-net.md b/content/actions/guides/building-and-testing-net.md index 0bedcb2931..7d7b16173e 100644 --- a/content/actions/guides/building-and-testing-net.md +++ b/content/actions/guides/building-and-testing-net.md @@ -5,13 +5,20 @@ product: '{% data reusables.gated-features.actions %}' versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- +{% data reusables.actions.enterprise-beta %} +{% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} + ### Introduction This guide shows you how to build, test, and publish a .NET package. -{% data variables.product.prodname_dotcom %}-hosted runners have a tools cache with preinstalled software, which includes the .NET Core SDK. For a full list of up-to-date software and the preinstalled versions of .NET Core SDK, see [software installed on {% data variables.product.prodname_dotcom %}-hosted runners](/actions/reference/specifications-for-github-hosted-runners). +{% if currentVersion == "github-ae@latest" %} To build and test your .NET project on {% data variables.product.prodname_ghe_managed %}, you will need to create a custom operating system image that includes the .NET Core SDK. For instructions on how to make sure your {% data variables.actions.hosted_runner %} has the required software installed, see "[Creating custom images](/actions/using-github-hosted-runners/creating-custom-images)." +{% else %} {% data variables.product.prodname_dotcom %}-hosted runners have a tools cache with preinstalled software, which includes the .NET Core SDK. For a full list of up-to-date software and the preinstalled versions of .NET Core SDK, see [software installed on {% data variables.product.prodname_dotcom %}-hosted runners](/actions/reference/specifications-for-github-hosted-runners). +{% endif %} ### Prerequisites @@ -42,7 +49,7 @@ jobs: steps: - uses: actions/checkout@v2 - name: Setup .NET Core SDK ${{ matrix.dotnet }} - uses: actions/setup-dotnet@v1.6.0 + uses: actions/setup-dotnet@v1.7.2 with: dotnet-version: ${{ matrix.dotnet-version }} - name: Install dependencies @@ -79,7 +86,7 @@ jobs: steps: - uses: actions/checkout@v2 - name: Setup dotnet ${{ matrix.dotnet-version }} - uses: actions/setup-dotnet@v1.6.0 + uses: actions/setup-dotnet@v1.7.2 with: dotnet-version: ${{ matrix.dotnet-version }} # You can test your matrix by printing the current dotnet version @@ -111,7 +118,7 @@ You can configure your job to use a specific version of .NET, such as `3.1.3`. A steps: - uses: actions/checkout@v2 - name: Setup dotnet - uses: actions/setup-dotnet@v1.6.0 + uses: actions/setup-dotnet@v1.7.2 with: dotnet-version: '3.1.x' - name: Install dependencies @@ -132,7 +139,7 @@ For more information, see "[Caching dependencies to speed up workflows](/actions steps: - uses: actions/checkout@v2 - name: Setup dotnet - uses: actions/setup-dotnet@v1.6.0 + uses: actions/setup-dotnet@v1.7.2 with: dotnet-version: '3.1.x' - uses: actions/cache@v2 @@ -164,7 +171,7 @@ You can use the same commands that you use locally to build and test your code. steps: - uses: actions/checkout@v2 - name: Setup dotnet - uses: actions/setup-dotnet@v1.6.0 + uses: actions/setup-dotnet@v1.7.2 with: dotnet-version: '3.1.x' - name: Install dependencies @@ -199,7 +206,7 @@ jobs: steps: - uses: actions/checkout@v2 - name: Setup dotnet - uses: actions/setup-dotnet@v1.6.0 + uses: actions/setup-dotnet@v1.7.2 with: dotnet-version: ${{ matrix.dotnet-version }} - name: Install dependencies diff --git a/content/actions/guides/building-and-testing-nodejs.md b/content/actions/guides/building-and-testing-nodejs.md index bd06e9851c..9d37882676 100644 --- a/content/actions/guides/building-and-testing-nodejs.md +++ b/content/actions/guides/building-and-testing-nodejs.md @@ -8,6 +8,7 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'tutorial' topics: - 'CI' @@ -17,6 +18,7 @@ topics: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### Introduction @@ -128,7 +130,10 @@ jobs: ``` {% endraw %} -If you don't specify a Node.js version, {% data variables.product.prodname_dotcom %} uses the environment's default Node.js version. For more information, see "[Specifications for {% data variables.product.prodname_dotcom %}-hosted runners](/actions/reference/specifications-for-github-hosted-runners/#supported-software)". +If you don't specify a Node.js version, {% data variables.product.prodname_dotcom %} uses the environment's default Node.js version. +{% if currentVersion == "github-ae@latest" %} For instructions on how to make sure your {% data variables.actions.hosted_runner %} has the required software installed, see "[Creating custom images](/actions/using-github-hosted-runners/creating-custom-images)." +{% else %} For more information, see "[Specifications for {% data variables.product.prodname_dotcom %}-hosted runners](/actions/reference/specifications-for-github-hosted-runners/#supported-software)". +{% endif %} ### Installing dependencies diff --git a/content/actions/guides/building-and-testing-powershell.md b/content/actions/guides/building-and-testing-powershell.md index 73db57f053..fe09913820 100644 --- a/content/actions/guides/building-and-testing-powershell.md +++ b/content/actions/guides/building-and-testing-powershell.md @@ -5,6 +5,7 @@ product: '{% data reusables.gated-features.actions %}' versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' authors: - potatoqualitee type: 'tutorial' @@ -15,12 +16,17 @@ topics: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### Introduction This guide shows you how to use PowerShell for CI. It describes how to use Pester, install dependencies, test your module, and publish to the PowerShell Gallery. -{% data variables.product.prodname_dotcom %}-hosted runners have a tools cache with pre-installed software, which includes PowerShell and Pester. For a full list of up-to-date software and the pre-installed versions of PowerShell and Pester, see "[Specifications for {% data variables.product.prodname_dotcom %}-hosted runners](/actions/reference/specifications-for-github-hosted-runners/#supported-software)". +{% data variables.product.prodname_dotcom %}-hosted runners have a tools cache with pre-installed software, which includes PowerShell and Pester. + +{% if currentVersion == "github-ae@latest" %}For instructions on how to make sure your {% data variables.actions.hosted_runner %} has the required software installed, see "[Creating custom images](/actions/using-github-hosted-runners/creating-custom-images)." +{% else %}For a full list of up-to-date software and the pre-installed versions of PowerShell and Pester, see "[Specifications for {% data variables.product.prodname_dotcom %}-hosted runners](/actions/reference/specifications-for-github-hosted-runners/#supported-software)". +{% endif %} ### Prerequisites @@ -64,7 +70,7 @@ jobs: * `run: Test-Path resultsfile.log` - Check whether a file called `resultsfile.log` is present in the repository's root directory. * `Should -Be $true` - Uses Pester to define an expected result. If the result is unexpected, then {% data variables.product.prodname_actions %} flags this as a failed test. For example: - {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} + {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %} ![Failed Pester test](/assets/images/help/repository/actions-failed-pester-test-updated.png) {% else %} ![Failed Pester test](/assets/images/help/repository/actions-failed-pester-test.png) diff --git a/content/actions/guides/building-and-testing-python.md b/content/actions/guides/building-and-testing-python.md index 5ee9c6b4b6..8c663e8533 100644 --- a/content/actions/guides/building-and-testing-python.md +++ b/content/actions/guides/building-and-testing-python.md @@ -7,6 +7,7 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'tutorial' topics: - 'CI' @@ -15,12 +16,15 @@ topics: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### Introduction This guide shows you how to build, test, and publish a Python package. -{% data variables.product.prodname_dotcom %}-hosted runners have a tools cache with pre-installed software, which includes Python and PyPy. You don't have to install anything! For a full list of up-to-date software and the pre-installed versions of Python and PyPy, see "[Specifications for {% data variables.product.prodname_dotcom %}-hosted runners](/actions/reference/specifications-for-github-hosted-runners/#supported-software)". +{% if currentVersion == "github-ae@latest" %} For instructions on how to make sure your {% data variables.actions.hosted_runner %} has the required software installed, see "[Creating custom images](/actions/using-github-hosted-runners/creating-custom-images)." +{% else %} {% data variables.product.prodname_dotcom %}-hosted runners have a tools cache with pre-installed software, which includes Python and PyPy. You don't have to install anything! For a full list of up-to-date software and the pre-installed versions of Python and PyPy, see "[Specifications for {% data variables.product.prodname_dotcom %}-hosted runners](/actions/reference/specifications-for-github-hosted-runners/#supported-software)". +{% endif %} ### Prerequisites diff --git a/content/actions/guides/building-and-testing-ruby.md b/content/actions/guides/building-and-testing-ruby.md index 03c85c0a50..c2dde2eef5 100644 --- a/content/actions/guides/building-and-testing-ruby.md +++ b/content/actions/guides/building-and-testing-ruby.md @@ -5,6 +5,7 @@ product: '{% data reusables.gated-features.actions %}' versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'tutorial' topics: - 'CI' @@ -13,6 +14,7 @@ topics: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### Introduction 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 571e3ef820..963e410b3e 100644 --- a/content/actions/guides/caching-dependencies-to-speed-up-workflows.md +++ b/content/actions/guides/caching-dependencies-to-speed-up-workflows.md @@ -14,13 +14,15 @@ topics: - 'Workflows' --- +{% data reusables.actions.ae-beta %} + ### About caching workflow dependencies Workflow runs often reuse the same outputs or downloaded dependencies from one run to another. For example, package and dependency management tools such as Maven, Gradle, npm, and Yarn keep a local cache of downloaded dependencies. Jobs on {% data variables.product.prodname_dotcom %}-hosted runners start in a clean virtual environment and must download dependencies each time, causing increased network utilization, longer runtime, and increased cost. To help speed up the time it takes to recreate these files, {% data variables.product.prodname_dotcom %} can cache dependencies you frequently use in workflows. -To cache dependencies for a job, you'll need to use {% data variables.product.prodname_dotcom %}'s `cache` action. The action retrieves a cache identified by a unique key. For more information, see [`actions/cache`](https://github.com/actions/cache). +To cache dependencies for a job, you'll need to use {% data variables.product.prodname_dotcom %}'s `cache` action. The action retrieves a cache identified by a unique key. For more information, see [`actions/cache`](https://github.com/actions/cache). If you are caching Ruby gems, instead consider using the Ruby maintained action, which can cache bundle installs on initiation. For more information, see [`ruby/setup-ruby`](https://github.com/ruby/setup-ruby#caching-bundle-install-automatically). {% warning %} diff --git a/content/actions/guides/closing-inactive-issues.md b/content/actions/guides/closing-inactive-issues.md new file mode 100644 index 0000000000..461ef0aca2 --- /dev/null +++ b/content/actions/guides/closing-inactive-issues.md @@ -0,0 +1,77 @@ +--- +title: Closing inactive issues +intro: You can use {% data variables.product.prodname_actions %} to comment on or close issues that have been inactive for a certain period of time. +product: '{% data reusables.gated-features.actions %}' +versions: + free-pro-team: '*' + enterprise-server: '>=2.22' + github-ae: '*' +type: 'tutorial' +topics: + - 'Workflows' + - 'Project management' +--- + +{% data reusables.actions.enterprise-beta %} +{% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} +{% data reusables.actions.ae-self-hosted-runners-notice %} + +### Introduction + +This tutorial demonstrates how to use the [`actions/stale` action](https://github.com/marketplace/actions/close-stale-issues) to comment on and close issues that have been inactive for a certain period of time. For example, you can comment if an issue has been inactive for 30 days to prompt participants to take action. Then, if no additional activity occurs after 14 days, you can close the issue. + +In the tutorial, you will first make a workflow file that uses the [`actions/stale` action](https://github.com/marketplace/actions/close-stale-issues). Then, you will customize the workflow to suit your needs. + +### Creating the workflow + +1. {% data reusables.actions.choose-repo %} +2. {% data reusables.actions.make-workflow-file %} +3. Copy the following YAML contents into your workflow file. + + {% raw %} + ```yaml{:copy} + name: Close inactive issues + on: + schedule: + - cron: "30 1 * * *" + + jobs: + close-issues: + runs-on: ubuntu-latest + steps: + - uses: actions/stale@v3 + with: + days-before-issue-stale: 30 + days-before-issue-close: 14 + stale-issue-label: "stale" + stale-issue-message: "This issue is stale because it has been open for 30 days with no activity." + close-issue-message: "This issue was closed because it has been inactive for 14 days since being marked as stale." + days-before-pr-stale: -1 + days-before-pr-close: -1 + repo-token: ${{ secrets.GITHUB_TOKEN }} + ``` + {% endraw %} +4. Customize the parameters in your workflow file: + - Change the value for `on.schedule` to dictate when you want this workflow to run. In the example above, the workflow will run every day at 1:30 UTC. For more information about scheduled workflows, see "[Scheduled events](/actions/reference/events-that-trigger-workflows#scheduled-events)." + - Change the value for `days-before-issue-stale` to the number of days without activity before the `actions/stale` action labels an issue. If you never want this action to label issues, set this value to `-1`. + - Change the value for `days-before-issue-close` to the number of days without activity before the `actions/stale` action closes an issue. If you never want this action to close issues, set this value to `-1`. + - Change the value for `stale-issue-label` to the label that you want to apply to issues that have been inactive for the amount of time specified by `days-before-issue-stale`. + - Change the value for `stale-issue-message` to the comment that you want to add to issues that are labeled by the `actions/stale` action. + - Change the value for `close-issue-message` to the comment that you want to add to issues that are closed by the `actions/stale` action. +5. {% data reusables.actions.commit-workflow %} + +### Expected results + +Based on the `schedule` parameter (for example, every day at 1:30 UTC), your workflow will find issues that have been inactive for the specified period of time and will add the specified comment and label. Additionally, your workflow will close any previously labeled issues if no additional activity has occurred for the specified period of time. + +{% data reusables.actions.schedule-delay %} + +You can view the history of your workflow runs to see this workflow run periodically. For more information, see "[Viewing workflow run history](/actions/managing-workflow-runs/viewing-workflow-run-history)." + +This workflow will only label and/or close 30 issues at a time in order to avoid rate limit abuse. You can configure this with the `operations-per-run` setting. For more information, see the [`actions/stale` action documentation](https://github.com/marketplace/actions/close-stale-issues). + +### Next steps + +- To learn more about additional things you can do with the `actions/stale` action, like closing inactive pull requests, ignoring issues with certain labels or milestones, or only checking issues with certain labels, see the [`actions/stale` action documentation](https://github.com/marketplace/actions/close-stale-issues). +- [Search GitHub](https://github.com/search?q=%22uses%3A+actions%2Fstale%22&type=code) for examples of workflows using this action. diff --git a/content/actions/guides/commenting-on-an-issue-when-a-label-is-added.md b/content/actions/guides/commenting-on-an-issue-when-a-label-is-added.md new file mode 100644 index 0000000000..50f5ad45a4 --- /dev/null +++ b/content/actions/guides/commenting-on-an-issue-when-a-label-is-added.md @@ -0,0 +1,70 @@ +--- +title: Commenting on an issue when a label is added +intro: You can use {% data variables.product.prodname_actions %} to automatically comment on issues when a specific label is applied. +product: '{% data reusables.gated-features.actions %}' +versions: + free-pro-team: '*' + enterprise-server: '>=2.22' + github-ae: '*' +type: 'tutorial' +topics: + - 'Workflows' + - 'Project management' +--- + +{% data reusables.actions.enterprise-beta %} +{% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} +{% data reusables.actions.ae-self-hosted-runners-notice %} + +### Introduction + +This tutorial demonstrates how to use the [`peter-evans/create-or-update-comment` action](https://github.com/marketplace/actions/create-or-update-comment) to comment on an issue when a specific label is applied. For example, when the `help-wanted` label is added to an issue, you can add a comment to encourage contributors to work on the issue. + +In the tutorial, you will first make a workflow file that uses the [`peter-evans/create-or-update-comment` action](https://github.com/marketplace/actions/create-or-update-comment). Then, you will customize the workflow to suit your needs. + +### Creating the workflow + +1. {% data reusables.actions.choose-repo %} +2. {% data reusables.actions.make-workflow-file %} +3. Copy the following YAML contents into your workflow file. + + {% raw %} + ```yaml{:copy} + name: Add comment + on: + issues: + types: + - labeled + jobs: + add-comment: + if: github.event.label.name == 'help-wanted' + runs-on: ubuntu-latest + steps: + - name: Add comment + uses: peter-evans/create-or-update-comment@v1 + with: + issue-number: ${{ github.event.issue.number }} + body: | + This issue is available for anyone to work on. **Make sure to reference this issue in your pull request.** :sparkles: Thank you for your contribution! :sparkles: + ``` + {% endraw %} +4. Customize the parameters in your workflow file: + - Replace `help-wanted` in `if: github.event.label.name == 'help-wanted'` with the label that you want to act on. If you want to act on more than one label, separate the conditions with `||`. For example, `if: github.event.label.name == 'bug' || github.event.label.name == 'fix me'` will comment whenever the `bug` or `fix me` labels are added to an issue. + - Change the value for `body` to the comment that you want to add. GitHub flavored markdown is supported. For more information about markdown, see "[Basic writing and formatting syntax](/github/writing-on-github/basic-writing-and-formatting-syntax)." +5. {% data reusables.actions.commit-workflow %} + +### Testing the workflow + +Every time an issue in your repository is labeled, this workflow will run. If the label that was added is one of the labels that you specified in your workflow file, the `peter-evans/create-or-update-comment` action will add the comment that you specified to the issue. + +Test your workflow by applying your specified label to an issue. + +1. Open an issue in your repository. For more information, see "[Creating an issue](/github/managing-your-work-on-github/creating-an-issue)." +2. Label the issue with the specified label in your workflow file. For more information, see "[Managing labels](/github/managing-your-work-on-github/managing-labels#applying-labels-to-issues-and-pull-requests)." +3. To see the workflow run triggered by labeling the issue, view the history of your workflow runs. For more information, see "[Viewing workflow run history](/actions/managing-workflow-runs/viewing-workflow-run-history)." +4. When the workflow completes, the issue that you labeled should have a comment added. + +### Next steps + +- To learn more about additional things you can do with the `peter-evans/create-or-update-comment` action, like adding reactions, visit the [`peter-evans/create-or-update-comment` action documentation](https://github.com/marketplace/actions/create-or-update-comment). diff --git a/content/actions/guides/creating-postgresql-service-containers.md b/content/actions/guides/creating-postgresql-service-containers.md index 61e3ee9124..5c95d88d4e 100644 --- a/content/actions/guides/creating-postgresql-service-containers.md +++ b/content/actions/guides/creating-postgresql-service-containers.md @@ -9,6 +9,7 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'tutorial' topics: - 'Containers' @@ -17,6 +18,7 @@ topics: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### Introduction diff --git a/content/actions/guides/creating-redis-service-containers.md b/content/actions/guides/creating-redis-service-containers.md index de5c677210..84b714f01d 100644 --- a/content/actions/guides/creating-redis-service-containers.md +++ b/content/actions/guides/creating-redis-service-containers.md @@ -9,6 +9,7 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'tutorial' topics: - 'Containers' @@ -17,6 +18,7 @@ topics: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### Introduction diff --git a/content/actions/guides/deploying-to-amazon-elastic-container-service.md b/content/actions/guides/deploying-to-amazon-elastic-container-service.md index 628d47a4db..6e32e331f3 100644 --- a/content/actions/guides/deploying-to-amazon-elastic-container-service.md +++ b/content/actions/guides/deploying-to-amazon-elastic-container-service.md @@ -5,6 +5,7 @@ product: '{% data reusables.gated-features.actions %}' versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'tutorial' topics: - 'CD' @@ -14,6 +15,7 @@ topics: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### Introduction diff --git a/content/actions/guides/deploying-to-azure-app-service.md b/content/actions/guides/deploying-to-azure-app-service.md index 391bcdd288..68e4cf4715 100644 --- a/content/actions/guides/deploying-to-azure-app-service.md +++ b/content/actions/guides/deploying-to-azure-app-service.md @@ -5,6 +5,7 @@ product: '{% data reusables.gated-features.actions %}' versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'tutorial' topics: - 'CD' @@ -14,6 +15,7 @@ topics: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### Introduction diff --git a/content/actions/guides/deploying-to-google-kubernetes-engine.md b/content/actions/guides/deploying-to-google-kubernetes-engine.md index 8728dde11f..42bf9afef8 100644 --- a/content/actions/guides/deploying-to-google-kubernetes-engine.md +++ b/content/actions/guides/deploying-to-google-kubernetes-engine.md @@ -5,6 +5,7 @@ product: '{% data reusables.gated-features.actions %}' versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'tutorial' topics: - 'CD' @@ -14,6 +15,7 @@ topics: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### Introduction diff --git a/content/actions/guides/index.md b/content/actions/guides/index.md index bb3ae78614..85043ac3f7 100644 --- a/content/actions/guides/index.md +++ b/content/actions/guides/index.md @@ -17,6 +17,7 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' learningTracks: - getting_started - continuous_integration @@ -61,6 +62,13 @@ includeGuides: - /actions/learn-github-actions/migrating-from-gitlab-cicd-to-github-actions - /actions/learn-github-actions/migrating-from-jenkins-to-github-actions - /actions/learn-github-actions/migrating-from-travis-ci-to-github-actions + - /actions/guides/using-github-actions-for-project-management + - /actions/guides/closing-inactive-issues + - /actions/guides/scheduling-issue-creation + - /actions/guides/adding-labels-to-issues + - /actions/guides/commenting-on-an-issue-when-a-label-is-added + - /actions/guides/moving-assigned-issues-on-project-boards + - /actions/guides/removing-a-label-when-a-card-is-added-to-a-project-board-column --- @@ -86,3 +94,11 @@ includeGuides: + + + + + + + + diff --git a/content/actions/guides/moving-assigned-issues-on-project-boards.md b/content/actions/guides/moving-assigned-issues-on-project-boards.md new file mode 100644 index 0000000000..650cbea90d --- /dev/null +++ b/content/actions/guides/moving-assigned-issues-on-project-boards.md @@ -0,0 +1,75 @@ +--- +title: Moving assigned issues on project boards +intro: You can use {% data variables.product.prodname_actions %} to automatically move an issue to a specific column on a project board when the issue is assigned. +product: '{% data reusables.gated-features.actions %}' +versions: + free-pro-team: '*' + enterprise-server: '>=2.22' + github-ae: '*' +type: 'tutorial' +topics: + - 'Workflows' + - 'Project management' +--- + +{% data reusables.actions.enterprise-beta %} +{% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} +{% data reusables.actions.ae-self-hosted-runners-notice %} + +### Introduction + +This tutorial demonstrates how to use the [`alex-page/github-project-automation-plus` action](https://github.com/marketplace/actions/github-project-automation) to automatically move an issue to a specific column on a project board when the issue is assigned. For example, when an issue is assigned, you can move it into the `In Progress` column your project board. + +In the tutorial, you will first make a workflow file that uses the [`alex-page/github-project-automation-plus` action](https://github.com/marketplace/actions/github-project-automation). Then, you will customize the workflow to suit your needs. + +### Creating the workflow + +1. {% data reusables.actions.choose-repo %} +2. In your repository, choose a project board. You can use an existing project, or you can create a new project. For more information about creating a project, see "[Creating a project board](/github/managing-your-work-on-github/creating-a-project-board)." +3. {% data reusables.actions.make-workflow-file %} +4. Copy the following YAML contents into your workflow file. + + {% raw %} + ```yaml{:copy} + name: Move assigned card + on: + issues: + types: + - assigned + jobs: + move-assigned-card: + runs-on: ubuntu-latest + steps: + - uses: alex-page/github-project-automation-plus@v0.3.0 + with: + project: Docs Work + column: In Progress + repo-token: ${{ secrets.PERSONAL_ACCESS_TOKEN }} + ``` + {% endraw %} +5. Customize the parameters in your workflow file: + - Change the value for `project` to the name of your project board. If you have multiple project boards with the same name, the `alex-page/github-project-automation-plus` action will act on all projects with the specified name. + - Change the value for `column` to the name of the column where you want issues to move when they are assigned. + - Change the value for `repo-token`: + 1. Create a personal access token with the `repo` scope. For more information, see "[Creating a personal access token](/github/authenticating-to-github/creating-a-personal-access-token)." + 1. Store this personal access token as a secret in your repository. For more information about storing secrets, see "[Encrypted secrets](/actions/reference/encrypted-secrets)." + 1. In your workflow file, replace `PERSONAL_ACCESS_TOKEN` with the name of your secret. +6. {% data reusables.actions.commit-workflow %} + +### Testing the workflow + +Whenever an issue in your repository is assigned, the issue will be moved to the specified project board column. If the issue is not already on the project board, it will be added to the project board. + +If your repository is user-owned, the `alex-page/github-project-automation-plus` action will act on all projects in your repository or user account that have the specified project name and column. Likewise, if your repository is organization-owned, the action will act on all projects in your repository or organization that have the specified project name and column. + +Test your workflow by assigning an issue in your repository. + +1. Open an issue in your repository. For more information, see "[Creating an issue](/github/managing-your-work-on-github/creating-an-issue)." +2. Assign the issue. For more information, see "[Assigning issues and pull requests to other GitHub users](/github/managing-your-work-on-github/assigning-issues-and-pull-requests-to-other-github-users)." +3. To see the workflow run that assigning the issue triggered, view the history of your workflow runs. For more information, see "[Viewing workflow run history](/actions/managing-workflow-runs/viewing-workflow-run-history)." +4. When the workflow completes, the issue that you assigned should be added to the specified project board column. + +### Next steps + +- To learn more about additional things you can do with the `alex-page/github-project-automation-plus` action, like deleting or archiving project cards, visit the [`alex-page/github-project-automation-plus` action documentation](https://github.com/marketplace/actions/github-project-automation). diff --git a/content/actions/guides/publishing-docker-images.md b/content/actions/guides/publishing-docker-images.md index 815b28215c..0421ca4cf9 100644 --- a/content/actions/guides/publishing-docker-images.md +++ b/content/actions/guides/publishing-docker-images.md @@ -7,6 +7,7 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'tutorial' topics: - 'Packaging' @@ -16,6 +17,7 @@ topics: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### Introduction diff --git a/content/actions/guides/publishing-java-packages-with-gradle.md b/content/actions/guides/publishing-java-packages-with-gradle.md index 407d446447..b9901a18d7 100644 --- a/content/actions/guides/publishing-java-packages-with-gradle.md +++ b/content/actions/guides/publishing-java-packages-with-gradle.md @@ -7,6 +7,7 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'tutorial' topics: - 'Packaging' @@ -17,6 +18,7 @@ topics: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### Introduction diff --git a/content/actions/guides/publishing-java-packages-with-maven.md b/content/actions/guides/publishing-java-packages-with-maven.md index 48a533fbf2..507f4cc9af 100644 --- a/content/actions/guides/publishing-java-packages-with-maven.md +++ b/content/actions/guides/publishing-java-packages-with-maven.md @@ -7,6 +7,7 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'tutorial' topics: - 'Packaging' @@ -17,6 +18,7 @@ topics: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### Introduction diff --git a/content/actions/guides/publishing-nodejs-packages.md b/content/actions/guides/publishing-nodejs-packages.md index d1a3800318..3e359adce8 100644 --- a/content/actions/guides/publishing-nodejs-packages.md +++ b/content/actions/guides/publishing-nodejs-packages.md @@ -8,6 +8,7 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'tutorial' topics: - 'Packaging' @@ -18,6 +19,7 @@ topics: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### Introduction diff --git a/content/actions/guides/removing-a-label-when-a-card-is-added-to-a-project-board-column.md b/content/actions/guides/removing-a-label-when-a-card-is-added-to-a-project-board-column.md new file mode 100644 index 0000000000..7ab58f6308 --- /dev/null +++ b/content/actions/guides/removing-a-label-when-a-card-is-added-to-a-project-board-column.md @@ -0,0 +1,75 @@ +--- +title: Removing a label when a card is added to a project board column +intro: You can use {% data variables.product.prodname_actions %} to automatically remove a label when an issue or pull request is added to a specific column on a project board. +product: '{% data reusables.gated-features.actions %}' +versions: + free-pro-team: '*' + enterprise-server: '>=2.22' + github-ae: '*' +type: 'tutorial' +topics: + - 'Workflows' + - 'Project management' +--- + +{% data reusables.actions.enterprise-beta %} +{% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} +{% data reusables.actions.ae-self-hosted-runners-notice %} + +### Introduction + +This tutorial demonstrates how to use the [`andymckay/labeler` action](https://github.com/marketplace/actions/simple-issue-labeler) along with a conditional to remove a label from issues and pull requests that are added to a specific column on a project board. For example, you can remove the `needs review` label when project cards are moved into the `Done` column. + +In the tutorial, you will first make a workflow file that uses the [`andymckay/labeler` action](https://github.com/marketplace/actions/simple-issue-labeler). Then, you will customize the workflow to suit your needs. + +### Creating the workflow + +1. {% data reusables.actions.choose-repo %} +2. Choose a project that belongs to the repository. This workflow cannot be used with projects that belong to users or organizations. You can use an existing project, or you can create a new project. For more information about creating a project, see "[Creating a project board](/github/managing-your-work-on-github/creating-a-project-board)." +3. {% data reusables.actions.make-workflow-file %} +4. Copy the following YAML contents into your workflow file. + + {% raw %} + ```yaml{:copy} + name: Remove labels + on: + project_card: + types: + - moved + jobs: + remove_labels: + if: github.event.project_card.column_id == '12345678' + runs-on: ubuntu-latest + steps: + - name: remove labels + uses: andymckay/labeler@master + with: + remove-labels: "needs review" + ``` + {% endraw %} +5. Customize the parameters in your workflow file: + - In `github.event.project_card.column_id == '12345678'`, replace `12345678` with the ID of the column where you want to un-label issues and pull requests that are moved there. + + To find the column ID, navigate to your project board. Next to the title of the column, click {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %} then click **Copy column link**. The column ID is the number at the end of the copied link. For example, `24687531` is the column ID for `https://github.com/octocat/octo-repo/projects/1#column-24687531`. + + If you want to act on more than one column, separate the conditions with `||`. For example, `if github.event.project_card.column_id == '12345678' || github.event.project_card.column_id == '87654321'` will act whenever a project card is added to column `12345678` or column `87654321`. The columns may be on different project boards. + - Change the value for `remove-labels` to the list of labels that you want to remove from issues or pull requests that are moved to the specified column(s). Separate multiple labels with commas. For example, `"help wanted, good first issue"`. For more information on labels, see "[Managing labels](/github/managing-your-work-on-github/managing-labels#applying-labels-to-issues-and-pull-requests)." +6. {% data reusables.actions.commit-workflow %} + +### Testing the workflow + +Every time a project card on a project in your repository moves, this workflow will run. If the card is an issue or a pull request and is moved into the column that you specified, then the workflow will remove the specified labels from the issue or a pull request. Cards that are notes will not be affected. + +Test your workflow out by moving an issue on your project into the target column. + +1. Open an issue in your repository. For more information, see "[Creating an issue](/github/managing-your-work-on-github/creating-an-issue)." +2. Label the issue with the labels that you want the workflow to remove. For more information, see "[Managing labels](/github/managing-your-work-on-github/managing-labels#applying-labels-to-issues-and-pull-requests)." +3. Add the issue to the project column that you specified in your workflow file. For more information, see "[Adding issues and pull requests to a project board](/github/managing-your-work-on-github/adding-issues-and-pull-requests-to-a-project-board)." +4. To see the workflow run that was triggered by adding the issue to the project, view the history of your workflow runs. For more information, see "[Viewing workflow run history](/actions/managing-workflow-runs/viewing-workflow-run-history)." +5. When the workflow completes, the issue that you added to the project column should have the specified labels removed. + +### Next steps + +- To learn more about additional things you can do with the `andymckay/labeler` action, like adding labels or skipping this action if the issue is assigned or has a specific label, visit the [`andymckay/labeler` action documentation](https://github.com/marketplace/actions/simple-issue-labeler). +- [Search GitHub](https://github.com/search?q=%22uses:+andymckay/labeler%22&type=code) for examples of workflows using this action. diff --git a/content/actions/guides/scheduling-issue-creation.md b/content/actions/guides/scheduling-issue-creation.md new file mode 100644 index 0000000000..d61c7f7ea6 --- /dev/null +++ b/content/actions/guides/scheduling-issue-creation.md @@ -0,0 +1,89 @@ +--- +title: Scheduling issue creation +intro: You can use {% data variables.product.prodname_actions %} to create an issue on a regular basis for things like daily meetings or quarterly reviews. +product: '{% data reusables.gated-features.actions %}' +versions: + free-pro-team: '*' + enterprise-server: '>=2.22' + github-ae: '*' +type: 'tutorial' +topics: + - 'Workflows' + - 'Project management' +--- + +{% data reusables.actions.enterprise-beta %} +{% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} +{% data reusables.actions.ae-self-hosted-runners-notice %} + +### Introduction + +This tutorial demonstrates how to use the [`imjohnbo/issue-bot` action](https://github.com/marketplace/actions/issue-bot-action) to create an issue on a regular basis. For example, you can create an issue each week to use as the agenda for a team meeting. + +In the tutorial, you will first make a workflow file that uses the [`imjohnbo/issue-bot` action](https://github.com/marketplace/actions/issue-bot-action). Then, you will customize the workflow to suit your needs. + +### Creating the workflow + +1. {% data reusables.actions.choose-repo %} +2. {% data reusables.actions.make-workflow-file %} +3. Copy the following YAML contents into your workflow file. + + {% raw %} + ```yaml{:copy} + name: Weekly Team Sync + on: + schedule: + - cron: 0 07 * * 1 + + jobs: + create_issue: + name: Create team sync issue + runs-on: ubuntu-latest + steps: + - name: Create team sync issue + uses: imjohnbo/issue-bot@v3.0 + with: + assignees: "monalisa, doctocat, hubot" + labels: "weekly sync, docs-team" + title: "Team sync" + body: | + ### Agenda + + - [ ] Start the recording + - [ ] Check-ins + - [ ] Discussion points + - [ ] Post the recording + + ### Discussion Points + Add things to discuss below + + - [Work this week](https://github.com/orgs/github/projects/3) + pinned: false + close-previous: false + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + ``` + {% endraw %} +4. Customize the parameters in your workflow file: + - Change the value for `on.schedule` to dictate when you want this workflow to run. In the example above, the workflow will run every Monday at 7:00 UTC. For more information about scheduled workflows, see "[Scheduled events](/actions/reference/events-that-trigger-workflows#scheduled-events)." + - Change the value for `assignees` to the list of {% data variables.product.prodname_dotcom %} usernames that you want to assign to the issue. + - Change the value for `labels` to the list of labels that you want to apply to the issue. + - Change the value for `title` to the title that you want the issue to have. + - Change the value for `body` to the text that you want in the issue body. The `|` character allows you to use a multi-line value for this parameter. + - If you want to pin this issue in your repository, set `pinned` to `true`. For more information about pinned issues, see "[Pinning an issue to your repository](/articles/pinning-an-issue-to-your-repository)." + - If you want to close the previous issue generated by this workflow each time a new issue is created, set `close-previous` to `true`. The workflow will close the most recent issue that has the labels defined in the `labels` field. To avoid closing the wrong issue, use a unique label or combination of labels. +5. {% data reusables.actions.commit-workflow %} + +### Expected results + +Based on the `schedule` parameter (for example, every Monday at 7:00 UTC), your workflow will create a new issue with the assignees, labels, title, and body that you specified. If you set `pinned` to `true`, the workflow will pin the issue to your repository. If you set `close-previous` to true, the workflow will close the most recent issue with matching labels. + +{% data reusables.actions.schedule-delay %} + +You can view the history of your workflow runs to see this workflow run periodically. For more information, see "[Viewing workflow run history](/actions/managing-workflow-runs/viewing-workflow-run-history)." + +### Next steps + +- To learn more about additional things you can do with the `imjohnbo/issue-bot` action, like rotating assignees or using an issue template, see the [`imjohnbo/issue-bot` action documentation](https://github.com/marketplace/actions/issue-bot-action). +- [Search GitHub](https://github.com/search?q=%22uses%3A+imjohnbo%2Fissue-bot%22&type=code) for examples of workflows using this action. diff --git a/content/actions/guides/setting-up-continuous-integration-using-workflow-templates.md b/content/actions/guides/setting-up-continuous-integration-using-workflow-templates.md index fd3a776b09..d8a7318375 100644 --- a/content/actions/guides/setting-up-continuous-integration-using-workflow-templates.md +++ b/content/actions/guides/setting-up-continuous-integration-using-workflow-templates.md @@ -11,6 +11,7 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'tutorial' topics: - 'Workflows' @@ -19,6 +20,7 @@ topics: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} Anyone with write permission to a repository can set up continuous integration (CI) using {% data variables.product.prodname_actions %}. diff --git a/content/actions/guides/storing-workflow-data-as-artifacts.md b/content/actions/guides/storing-workflow-data-as-artifacts.md index 898bf40efe..ad3eed3782 100644 --- a/content/actions/guides/storing-workflow-data-as-artifacts.md +++ b/content/actions/guides/storing-workflow-data-as-artifacts.md @@ -11,6 +11,7 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'tutorial' topics: - 'Workflows' @@ -18,6 +19,7 @@ topics: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### About workflow artifacts @@ -111,7 +113,7 @@ jobs: path: output/test/code-coverage.html ``` -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} ### Configuring a custom artifact retention period 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`: @@ -240,7 +242,7 @@ jobs: ``` The workflow run will archive any artifacts that it generated. For more information on downloading archived artifacts, see "[Downloading workflow artifacts](/actions/managing-workflow-runs/downloading-workflow-artifacts)." -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %} ![Workflow that passes data between jobs to perform math](/assets/images/help/repository/passing-data-between-jobs-in-a-workflow-updated.png) {% else %} ![Workflow that passes data between jobs to perform math](/assets/images/help/repository/passing-data-between-jobs-in-a-workflow.png) diff --git a/content/actions/guides/using-github-actions-for-project-management.md b/content/actions/guides/using-github-actions-for-project-management.md new file mode 100644 index 0000000000..d023cb4e2c --- /dev/null +++ b/content/actions/guides/using-github-actions-for-project-management.md @@ -0,0 +1,40 @@ +--- +title: Using GitHub Actions for project management +intro: You can use {% data variables.product.prodname_actions %} to automate many of your project management tasks. +product: '{% data reusables.gated-features.actions %}' +versions: + free-pro-team: '*' + enterprise-server: '>=2.22' + github-ae: '*' +type: 'overview' +topics: + - 'Project management' +--- + +You can use {% data variables.product.prodname_actions %} to automate your project management tasks by creating workflows. Each workflow contains a series of tasks that are performed automatically every time the workflow runs. For example, you can create a workflow that runs every time an issue is created to add a label, leave a comment, and move the issue onto a project board. + +### When do workflows run? + +You can configure your workflows to run on a schedule or be triggered when an event occurs. For example, you can set your workflow to run when someone creates an issue in a repository. + +Many workflow triggers are useful for automating project management. + +- An issue is opened, assigned, or labeled. +- A comment is added to an issue. +- A project card is created or moved. +- A scheduled time. + +For a full list of events that can trigger workflows, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows)." + +### What can workflows do? + +Workflows can do many things, such as commenting on an issue, adding or removing labels, moving cards on project boards, and opening issues. + +You can learn about using {% data variables.product.prodname_actions %} for project management by following these tutorials, which include example workflows that you can adapt to meet your needs. + +- "[Adding labels to issues](/actions/guides/adding-labels-to-issues)" +- "[Removing a label when a card is added to a project board column](/actions/guides/removing-a-label-when-a-card-is-added-to-a-project-board-column)" +- "[Moving assigned issues on project boards](/actions/guides/moving-assigned-issues-on-project-boards)" +- "[Commenting on an issue when a label is added](/actions/guides/commenting-on-an-issue-when-a-label-is-added)" +- "[Closing inactive issues](/actions/guides/closing-inactive-issues)" +- "[Scheduling issue creation](/actions/guides/scheduling-issue-creation)" diff --git a/content/actions/hosting-your-own-runners/about-self-hosted-runners.md b/content/actions/hosting-your-own-runners/about-self-hosted-runners.md index 5efa07952c..1c76fa56cf 100644 --- a/content/actions/hosting-your-own-runners/about-self-hosted-runners.md +++ b/content/actions/hosting-your-own-runners/about-self-hosted-runners.md @@ -7,11 +7,14 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'overview' --- +{% data reusables.actions.ae-self-hosted-runners-notice %} {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### About self-hosted runners @@ -63,6 +66,10 @@ There are some limits on {% data variables.product.prodname_actions %} usage whe {% data reusables.github-actions.usage-api-requests %} - **Job matrix** - {% data reusables.github-actions.usage-matrix-limits %} +### Workflow continuity for self-hosted runners + +{% data reusables.github-actions.runner-workflow-continuity %} + ### Supported architectures and operating systems for self-hosted runners The following operating systems are supported for the self-hosted runner application. @@ -112,6 +119,13 @@ Some extra configuration might be required to use actions from {% data variables The self-hosted runner polls {% data variables.product.product_name %} to retrieve application updates and to check if any jobs are queued for processing. The self-hosted runner uses a HTTPS _long poll_ that opens a connection to {% data variables.product.product_name %} for 50 seconds, and if no response is received, it then times out and creates a new long poll. The application must be running on the machine to accept and run {% data variables.product.prodname_actions %} jobs. +{% if currentVersion == "github-ae@latest" %} +You must ensure that the self-hosted runner has appropriate network access to communicate with the {% data variables.product.prodname_ghe_managed %} URL. +For example, if your instance name is `octoghae`, then you will need to allow the self-hosted runner to access `octoghae.github.com`. + +If you use an IP address allow list for your {% data variables.product.prodname_dotcom %} organization or enterprise account, you must add your self-hosted runner's IP address to the allow list. For more information, see "[Managing allowed IP addresses for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-allowed-ip-addresses-for-your-organization#using-github-actions-with-an-ip-allow-list)." +{% endif %} + {% if currentVersion == "free-pro-team@latest" %} You must ensure that the machine has the appropriate network access to communicate with the {% data variables.product.prodname_dotcom %} URLs listed below. @@ -121,7 +135,12 @@ github.com api.github.com *.actions.githubusercontent.com github-releases.githubusercontent.com +github-registry-files.githubusercontent.com codeload.github.com +*.pkg.github.com +pkg-cache.githubusercontent.com +pkg-containers.githubusercontent.com +pkg-containers-az.githubusercontent.com ``` If you use an IP address allow list for your {% data variables.product.prodname_dotcom %} organization or enterprise account, you must add your self-hosted runner's IP address to the allow list. For more information, see "[Managing allowed IP addresses for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-allowed-ip-addresses-for-your-organization#using-github-actions-with-an-ip-allow-list)" or "[Enforcing security settings in your enterprise account](/github/setting-up-and-managing-your-enterprise/enforcing-security-settings-in-your-enterprise-account#using-github-actions-with-an-ip-allow-list)". diff --git a/content/actions/hosting-your-own-runners/adding-self-hosted-runners.md b/content/actions/hosting-your-own-runners/adding-self-hosted-runners.md index e8a3ec454b..454da2e307 100644 --- a/content/actions/hosting-your-own-runners/adding-self-hosted-runners.md +++ b/content/actions/hosting-your-own-runners/adding-self-hosted-runners.md @@ -7,11 +7,14 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'tutorial' --- +{% data reusables.actions.ae-self-hosted-runners-notice %} {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} You can add a self-hosted runner to a repository, an organization, or an enterprise. @@ -57,7 +60,7 @@ You can add self-hosted runners to an enterprise, where they can be assigned to {% if currentVersion == "free-pro-team@latest" %} To add a self-hosted runner to an enterprise account, you must be an enterprise owner. -{% elsif enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.21"%} +{% elsif enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %} To add a self-hosted runner at the enterprise level of {% data variables.product.product_location %}, you must be a site administrator. {% endif %} diff --git a/content/actions/hosting-your-own-runners/configuring-the-self-hosted-runner-application-as-a-service.md b/content/actions/hosting-your-own-runners/configuring-the-self-hosted-runner-application-as-a-service.md index e74b6cdeab..bbde1784c8 100644 --- a/content/actions/hosting-your-own-runners/configuring-the-self-hosted-runner-application-as-a-service.md +++ b/content/actions/hosting-your-own-runners/configuring-the-self-hosted-runner-application-as-a-service.md @@ -6,12 +6,15 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'tutorial' defaultPlatform: linux --- +{% data reusables.actions.ae-self-hosted-runners-notice %} {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} {% capture service_first_step %}1. Stop the self-hosted runner application if it is currently running.{% endcapture %} {% capture service_non_windows_intro_shell %}On the runner machine, open a shell in the directory where you installed the self-hosted runner application. Use the commands below to install and manage the self-hosted runner service.{% endcapture %} diff --git a/content/actions/hosting-your-own-runners/index.md b/content/actions/hosting-your-own-runners/index.md index f73801b2ed..09276f2c2a 100644 --- a/content/actions/hosting-your-own-runners/index.md +++ b/content/actions/hosting-your-own-runners/index.md @@ -7,10 +7,13 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- +{% data reusables.actions.ae-self-hosted-runners-notice %} {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} {% link_in_list /about-self-hosted-runners %} {% link_in_list /adding-self-hosted-runners %} diff --git a/content/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups.md b/content/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups.md index 583e24c0b2..e045f57422 100644 --- a/content/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups.md +++ b/content/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups.md @@ -6,11 +6,14 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'tutorial' --- +{% data reusables.actions.ae-self-hosted-runners-notice %} {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### About self-hosted runner groups @@ -44,7 +47,7 @@ When creating a group, you must choose a policy that defines which repositories ![Add runner group](/assets/images/help/settings/actions-org-add-runner-group.png) 1. Enter a name for your runner group, and assign a policy for repository access. - {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} You can configure a runner group to be accessible to a specific list of repositories, or to all repositories in the organization. By default, public repositories can't access runners in a runner group, but you can use the **Allow public repositories** option to override this.{% else if currentVersion == "enterprise-server@2.22"%}You can configure a runner group to be accessible to a specific list of repositories, all private repositories, or all repositories in the organization.{% endif %} + {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} You can configure a runner group to be accessible to a specific list of repositories, or to all repositories in the organization. By default, only private repositories can access runners in a runner group, but you can override this.{% elsif currentVersion == "enterprise-server@2.22"%}You can configure a runner group to be accessible to a specific list of repositories, all private repositories, or all repositories in the organization.{% endif %} {% warning %} @@ -76,7 +79,7 @@ When creating a group, you must choose a policy that defines which organizations ![Add runner group](/assets/images/help/settings/actions-enterprise-account-add-runner-group.png) 1. Enter a name for your runner group, and assign a policy for organization access. - {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} You can configure a runner group to be accessible to a specific list of organizations, or all organizations in the enterprise. By default, public repositories can't access runners in a runner group, but you can use the **Allow public repositories** option to override this.{% else if currentVersion == "enterprise-server@2.22"%}You can configure a runner group to be accessible to all organizations in the enterprise or choose specific organizations.{% endif %} + {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} You can configure a runner group to be accessible to a specific list of organizations, or all organizations in the enterprise. By default, only private repositories can access runners in a runner group, but you can override this.{% elsif currentVersion == "enterprise-server@2.22"%}You can configure a runner group to be accessible to all organizations in the enterprise or choose specific organizations.{% endif %} {% warning %} @@ -101,7 +104,7 @@ You can update the access policy of a runner group, or rename a runner group. New self-hosted runners are automatically assigned to the default group, and can then be moved to another group. -1. In the **Self-hosted runners** section of the settings page, locate the current group of the runner you want to move group and expand the list of group members. +1. In the **Self-hosted runners** section of the settings page, locate the current group of the runner you want to move and expand the list of group members. ![View runner group members](/assets/images/help/settings/actions-org-runner-group-members.png) 1. Select the checkbox next to the self-hosted runner, and then click **Move to group** to see the available destinations. ![Runner group member move](/assets/images/help/settings/actions-org-runner-group-member-move.png) diff --git a/content/actions/hosting-your-own-runners/monitoring-and-troubleshooting-self-hosted-runners.md b/content/actions/hosting-your-own-runners/monitoring-and-troubleshooting-self-hosted-runners.md index 36a11e07c2..42b189fcb5 100644 --- a/content/actions/hosting-your-own-runners/monitoring-and-troubleshooting-self-hosted-runners.md +++ b/content/actions/hosting-your-own-runners/monitoring-and-troubleshooting-self-hosted-runners.md @@ -8,12 +8,15 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'tutorial' defaultPlatform: linux --- +{% data reusables.actions.ae-self-hosted-runners-notice %} {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### Checking the status of a self-hosted runner diff --git a/content/actions/hosting-your-own-runners/removing-self-hosted-runners.md b/content/actions/hosting-your-own-runners/removing-self-hosted-runners.md index cd29dcd43b..3880818b21 100644 --- a/content/actions/hosting-your-own-runners/removing-self-hosted-runners.md +++ b/content/actions/hosting-your-own-runners/removing-self-hosted-runners.md @@ -7,11 +7,14 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'tutorial' --- +{% data reusables.actions.ae-self-hosted-runners-notice %} {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### Removing a runner from a repository @@ -63,7 +66,7 @@ To remove a self-hosted runner from an organization, you must be an organization {% if currentVersion == "free-pro-team@latest" %} To remove a self-hosted runner from an enterprise account, you must be an enterprise owner. We recommend that you also have access to the self-hosted runner machine. -{% elsif enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.21"%} +{% elsif enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.21"% or currentVersion == "github-ae@latest" } To remove a self-hosted runner at the enterprise level of {% data variables.product.product_location %}, you must be a site administrator. We recommend that you also have access to the self-hosted runner machine. {% endif %} diff --git a/content/actions/hosting-your-own-runners/using-a-proxy-server-with-self-hosted-runners.md b/content/actions/hosting-your-own-runners/using-a-proxy-server-with-self-hosted-runners.md index c3b60531c3..faa10a7ddd 100644 --- a/content/actions/hosting-your-own-runners/using-a-proxy-server-with-self-hosted-runners.md +++ b/content/actions/hosting-your-own-runners/using-a-proxy-server-with-self-hosted-runners.md @@ -6,11 +6,14 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'tutorial' --- +{% data reusables.actions.ae-self-hosted-runners-notice %} {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### Configuring a proxy server using environment variables diff --git a/content/actions/hosting-your-own-runners/using-labels-with-self-hosted-runners.md b/content/actions/hosting-your-own-runners/using-labels-with-self-hosted-runners.md index 87ce2bbde1..91ad8eb2ba 100644 --- a/content/actions/hosting-your-own-runners/using-labels-with-self-hosted-runners.md +++ b/content/actions/hosting-your-own-runners/using-labels-with-self-hosted-runners.md @@ -4,11 +4,14 @@ intro: You can use labels to organize your self-hosted runners based on their ch versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'tutorial' --- +{% data reusables.actions.ae-self-hosted-runners-notice %} {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} For information on how to use labels to route jobs to specific types of self-hosted runners, see "[Using self-hosted runners in a workflow](/actions/hosting-your-own-runners/using-self-hosted-runners-in-a-workflow)." diff --git a/content/actions/hosting-your-own-runners/using-self-hosted-runners-in-a-workflow.md b/content/actions/hosting-your-own-runners/using-self-hosted-runners-in-a-workflow.md index 3124b22d3d..823d47baf0 100644 --- a/content/actions/hosting-your-own-runners/using-self-hosted-runners-in-a-workflow.md +++ b/content/actions/hosting-your-own-runners/using-self-hosted-runners-in-a-workflow.md @@ -7,11 +7,14 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'tutorial' --- +{% data reusables.actions.ae-self-hosted-runners-notice %} {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} For information on creating custom and default labels, see "[Using labels with self-hosted runners](/actions/hosting-your-own-runners/using-labels-with-self-hosted-runners)." @@ -66,7 +69,7 @@ These labels operate cumulatively, so a self-hosted runner’s labels must match When routing a job to a self-hosted runner, {% data variables.product.prodname_dotcom %} looks for a runner that matches the job's `runs-on` labels: -1. {% data variables.product.prodname_dotcom %} first searches for a runner at the repository level, then at the organization level{% if currentVersion ver_gt "enterprise-server@2.21" %}, then at the enterprise level{% endif %}. +1. {% data variables.product.prodname_dotcom %} first searches for a runner at the repository level, then at the organization level{% if currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %}, then at the enterprise level{% endif %}. 2. The job is then sent to the first matching runner that is online and idle. - If all matching online runners are busy, the job will queue at the level with the highest number of matching online runners. - If all matching runners are offline, the job will queue at the level with the highest number of matching offline runners. diff --git a/content/actions/index.md b/content/actions/index.md index a868a2f1fb..48ff80ce2c 100644 --- a/content/actions/index.md +++ b/content/actions/index.md @@ -45,6 +45,7 @@ layout: product-landing versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- @@ -52,6 +53,7 @@ versions: + diff --git a/content/actions/learn-github-actions/essential-features-of-github-actions.md b/content/actions/learn-github-actions/essential-features-of-github-actions.md index 4e1c1907ef..e129ae1919 100644 --- a/content/actions/learn-github-actions/essential-features-of-github-actions.md +++ b/content/actions/learn-github-actions/essential-features-of-github-actions.md @@ -5,6 +5,7 @@ intro: '{% data variables.product.prodname_actions %} are designed to help you b versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'overview' topics: - 'Fundamentals' @@ -12,6 +13,7 @@ topics: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### Overview @@ -73,7 +75,7 @@ jobs: run: | expr 1 + 1 > output.log - name: Upload output file - uses: actions/upload-artifact@v1 + uses: actions/upload-artifact@v2 with: name: output-log-file path: output.log diff --git a/content/actions/learn-github-actions/finding-and-customizing-actions.md b/content/actions/learn-github-actions/finding-and-customizing-actions.md index bf6ef136ca..c44792eb81 100644 --- a/content/actions/learn-github-actions/finding-and-customizing-actions.md +++ b/content/actions/learn-github-actions/finding-and-customizing-actions.md @@ -10,6 +10,7 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'how_to' topics: - 'Fundamentals' @@ -17,6 +18,7 @@ topics: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### Overview @@ -73,7 +75,7 @@ steps: #### Using SHAs -If you need more reliable versioning, you should use the SHA value associated with the version of the action. SHAs are immutable and therefore more reliable than tags or branches. However this approach means you will not automatically receive updates for an action, including important bug fixes and security updates. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}You must use a commit's full SHA value, and not an abbreviated value. {% endif %}This example targets an action's SHA: +If you need more reliable versioning, you should use the SHA value associated with the version of the action. SHAs are immutable and therefore more reliable than tags or branches. However this approach means you will not automatically receive updates for an action, including important bug fixes and security updates. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %}You must use a commit's full SHA value, and not an abbreviated value. {% endif %}This example targets an action's SHA: ```yaml steps: @@ -112,6 +114,12 @@ outputs: description: "Path to results file" ``` +{% if currentVersion == "github-ae@latest" %} +### Using the actions included with {% data variables.product.prodname_ghe_managed %} + +By default, you can use most of the official {% data variables.product.prodname_dotcom %}-authored actions in {% data variables.product.prodname_ghe_managed %}. For more information, see "[Using actions in {% data variables.product.prodname_ghe_managed %}](/admin/github-actions/using-actions-in-github-ae)." +{% endif %} + ### Referencing an action in the same repository where a workflow file uses the action If an action is defined in the same repository where your workflow file uses the action, you can reference the action with either the ‌`{owner}/{repo}@{ref}` or `./path/to/dir` syntax in your workflow file. diff --git a/content/actions/learn-github-actions/index.md b/content/actions/learn-github-actions/index.md index e120b015a2..0ca62e32dc 100644 --- a/content/actions/learn-github-actions/index.md +++ b/content/actions/learn-github-actions/index.md @@ -28,6 +28,7 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% link_with_intro /introduction-to-github-actions %} @@ -40,4 +41,4 @@ versions: {% link_with_intro /migrating-from-circleci-to-github-actions %} {% link_with_intro /migrating-from-gitlab-cicd-to-github-actions %} {% link_with_intro /migrating-from-jenkins-to-github-actions %} -{% link_with_intro /migrating-from-travis-ci-to-github-actions %} \ No newline at end of file +{% link_with_intro /migrating-from-travis-ci-to-github-actions %} diff --git a/content/actions/learn-github-actions/introduction-to-github-actions.md b/content/actions/learn-github-actions/introduction-to-github-actions.md index 495818104e..c5bbb91f6b 100644 --- a/content/actions/learn-github-actions/introduction-to-github-actions.md +++ b/content/actions/learn-github-actions/introduction-to-github-actions.md @@ -9,6 +9,7 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'overview' topics: - 'Fundamentals' @@ -16,6 +17,7 @@ topics: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### Overview @@ -53,9 +55,10 @@ _Actions_ are standalone commands that are combined into _steps_ to create a _jo #### Runners -A runner is a server that has the [{% data variables.product.prodname_actions %} runner application](https://github.com/actions/runner) installed. You can use a runner hosted by {% data variables.product.prodname_dotcom %}, or you can host your own. A runner listens for available jobs, runs one job at a time, and reports the progress, logs, and results back to {% data variables.product.prodname_dotcom %}. For {% data variables.product.prodname_dotcom %}-hosted runners, each job in a workflow runs in a fresh virtual environment. - -{% data variables.product.prodname_dotcom %}-hosted runners are based on Ubuntu Linux, Microsoft Windows, and macOS. For information on {% data variables.product.prodname_dotcom %}-hosted runners, see "[Virtual environments for {% data variables.product.prodname_dotcom %}-hosted runners](/actions/reference/virtual-environments-for-github-hosted-runners)." If you need a different operating system or require a specific hardware configuration, you can host your own runners. For information on self-hosted runners, see "[Hosting your own runners](/actions/hosting-your-own-runners)." +{% if currentVersion == "github-ae@latest" %}A runner is a server that has the [{% data variables.product.prodname_actions %} runner application](https://github.com/actions/runner) installed. For {% data variables.product.prodname_ghe_managed %}, you can use the security hardened {% data variables.actions.hosted_runner %}s which are bundled with your instance in the cloud. A runner listens for available jobs, runs one job at a time, and reports the progress, logs, and results back to {% data variables.product.prodname_dotcom %}. {% data variables.actions.hosted_runner %}s run each workflow job in a fresh virtual environment. For more information, see "[About {% data variables.actions.hosted_runner %}s](/actions/using-github-hosted-runners/about-ae-hosted-runners)." +{% else %} +A runner is a server that has the [{% data variables.product.prodname_actions %} runner application](https://github.com/actions/runner) installed. You can use a runner hosted by {% data variables.product.prodname_dotcom %}, or you can host your own. A runner listens for available jobs, runs one job at a time, and reports the progress, logs, and results back to {% data variables.product.prodname_dotcom %}. {% data variables.product.prodname_dotcom %}-hosted runners are based on Ubuntu Linux, Microsoft Windows, and macOS, and each job in a workflow runs in a fresh virtual environment. For information on {% data variables.product.prodname_dotcom %}-hosted runners, see "[About {% data variables.product.prodname_dotcom %}-hosted runners](/actions/using-github-hosted-runners/about-github-hosted-runners)." If you need a different operating system or require a specific hardware configuration, you can host your own runners. For information on self-hosted runners, see "[Hosting your own runners](/actions/hosting-your-own-runners)." +{% endif %} ### Create an example workflow @@ -207,7 +210,7 @@ In this diagram, you can see the workflow file you just created and how the {% d ### Viewing the job's activity -Once your job has started running, you can {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}see a visualization graph of the run's progress and {% endif %}view each step's activity on {% data variables.product.prodname_dotcom %}. +Once your job has started running, you can {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %}see a visualization graph of the run's progress and {% endif %}view each step's activity on {% data variables.product.prodname_dotcom %}. {% data reusables.repositories.navigate-to-repo %} 1. Under your repository name, click **Actions**. @@ -216,11 +219,11 @@ Once your job has started running, you can {% if currentVersion == "free-pro-tea ![Screenshot of workflow results](/assets/images/help/images/learn-github-actions-workflow.png) 1. Under "Workflow runs", click the name of the run you want to see. ![Screenshot of workflow runs](/assets/images/help/images/learn-github-actions-run.png) -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %} 1. Under **Jobs** or in the visualization graph, click the job you want to see. ![Select job](/assets/images/help/images/overview-actions-result-navigate.png) {% endif %} -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %} 1. View the results of each step. ![Screenshot of workflow run details](/assets/images/help/images/overview-actions-result-updated-2.png) {% elsif currentVersion ver_gt "enterprise-server@2.22" %} diff --git a/content/actions/learn-github-actions/managing-complex-workflows.md b/content/actions/learn-github-actions/managing-complex-workflows.md index 17dc573c37..cb773b32c8 100644 --- a/content/actions/learn-github-actions/managing-complex-workflows.md +++ b/content/actions/learn-github-actions/managing-complex-workflows.md @@ -1,10 +1,11 @@ --- title: Managing complex workflows shortTitle: Managing complex workflows -intro: 'This guide shows you how to use the advanced features of {% data variables.product.prodname_actions %}, with secret management, dependent jobs, caching, build matrices,{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} environments,{% endif %} and labels.' +intro: 'This guide shows you how to use the advanced features of {% data variables.product.prodname_actions %}, with secret management, dependent jobs, caching, build matrices,{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %} environments,{% endif %} and labels.' versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'how_to' topics: - 'Workflows' @@ -12,6 +13,7 @@ topics: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### Overview @@ -86,6 +88,7 @@ jobs: For more information, see [`jobs..strategy.matrix`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstrategymatrix). +{% if currentVersion == "free-pro-team@latest" %} ### Caching dependencies {% data variables.product.prodname_dotcom %}-hosted runners are started as fresh environments for each job, so if your jobs regularly reuse dependencies, you can consider caching these files to help improve performance. Once the cache is created, it is available to all workflows in the same repository. @@ -110,6 +113,7 @@ jobs: {% endraw %} For more information, see "Caching dependencies to speed up workflows." +{% endif %} ### Using databases and service containers @@ -139,17 +143,27 @@ For more information, see "[Using databases and service containers](/actions/con ### Using labels to route workflows -This feature helps you assign jobs to a specific self-hosted runner. If you want to be sure that a particular type of runner will process your job, you can use labels to control where jobs are executed. You can assign labels to a self-hosted runner, and then refer to these labels in your YAML workflow, ensuring that the job is routed in a predictable way. +This feature helps you assign jobs to a specific hosted runner. If you want to be sure that a particular type of runner will process your job, you can use labels to control where jobs are executed. You can assign labels to a hosted runner, and then refer to these labels in your YAML workflow, ensuring that the job is routed in a predictable way. +{% if currentVersion == "github-ae@latest" %} This example shows how a workflow can use labels to specify the required runner: +```yaml +jobs: + example-job: + runs-on: [AE-runner-for-CI] +``` + +For more information, see ["Using labels with {% data variables.actions.hosted_runner %}](/actions/using-github-hosted-runners/using-labels-with-ae-hosted-runners)." +{% else %} ```yaml jobs: example-job: runs-on: [self-hosted, linux, x64, gpu] ``` -For more information, see ["Using labels with self-hosted runners](/actions/hosting-your-own-runners/using-labels-with-self-hosted-runners)." +For more information, see ["Using labels with self-hosted runners](/actions/hosting-your-own-runners/using-labels-with-self-hosted-runners)." +{% endif %} {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} ### Using environments diff --git a/content/actions/learn-github-actions/migrating-from-azure-pipelines-to-github-actions.md b/content/actions/learn-github-actions/migrating-from-azure-pipelines-to-github-actions.md index b7ac0eaf55..f43c7e05d3 100644 --- a/content/actions/learn-github-actions/migrating-from-azure-pipelines-to-github-actions.md +++ b/content/actions/learn-github-actions/migrating-from-azure-pipelines-to-github-actions.md @@ -6,6 +6,7 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'tutorial' topics: - 'Azure Pipelines' @@ -16,6 +17,7 @@ topics: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### Introduction diff --git a/content/actions/learn-github-actions/migrating-from-circleci-to-github-actions.md b/content/actions/learn-github-actions/migrating-from-circleci-to-github-actions.md index 6e1684ec0d..cbb1130988 100644 --- a/content/actions/learn-github-actions/migrating-from-circleci-to-github-actions.md +++ b/content/actions/learn-github-actions/migrating-from-circleci-to-github-actions.md @@ -6,6 +6,7 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'tutorial' topics: - 'CircleCI' @@ -16,6 +17,7 @@ topics: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### Introduction @@ -33,7 +35,9 @@ For more information, see "[Core concepts for {% data variables.product.prodname When migrating from CircleCI, consider the following differences: - CircleCI’s automatic test parallelism automatically groups tests according to user-specified rules or historical timing information. This functionality is not built into {% data variables.product.prodname_actions %}. -- Actions that execute in Docker containers are sensitive to permissions problems since containers have a different mapping of users. You can avoid many of these problems by not using the `USER` instruction in your *Dockerfile*. For more information about the Docker filesystem on {% data variables.product.product_name %}-hosted runners, see "[Virtual environments for {% data variables.product.product_name %}-hosted runners](/actions/reference/virtual-environments-for-github-hosted-runners#docker-container-filesystem)." +- Actions that execute in Docker containers are sensitive to permissions problems since containers have a different mapping of users. You can avoid many of these problems by not using the `USER` instruction in your *Dockerfile*. {% if currentVersion == "github-ae@latest" %}For instructions on how to make sure your {% data variables.actions.hosted_runner %} has the required software installed, see "[Creating custom images](/actions/using-github-hosted-runners/creating-custom-images).". +{% else %}For more information about the Docker filesystem on {% data variables.product.product_name %}-hosted runners, see "[Virtual environments for {% data variables.product.product_name %}-hosted runners](/actions/reference/virtual-environments-for-github-hosted-runners#docker-container-filesystem)." +{% endif %} ### Migrating workflows and jobs @@ -56,9 +60,15 @@ CircleCI provides a set of pre-built images with common dependencies. These imag We recommend that you move away from CircleCI's pre-built images when you migrate to {% data variables.product.prodname_actions %}. In many cases, you can use actions to install the additional dependencies you need. +{% if currentVersion == "github-ae@latest" %} +For more information about the Docker filesystem, see "[Docker container filesystem](/actions/using-github-hosted-runners/about-ae-hosted-runners#docker-container-filesystem)." + +For instructions on how to make sure your {% data variables.actions.hosted_runner %} has the required software installed, see "[Creating custom images](/actions/using-github-hosted-runners/creating-custom-images)." +{% else %} For more information about the Docker filesystem, see "[Virtual environments for {% data variables.product.product_name %}-hosted runners](/actions/reference/virtual-environments-for-github-hosted-runners#docker-container-filesystem)." For more information about the tools and packages available on {% data variables.product.prodname_dotcom %}-hosted virtual environments, see "[Specifications for {% data variables.product.prodname_dotcom %}-hosted runners](/actions/reference/specifications-for-github-hosted-runners/#supported-software)". +{% endif %} ### Using variables and secrets @@ -107,7 +117,7 @@ GitHub Actions -{% data variables.product.prodname_actions %} caching is only applicable to {% data variables.product.prodname_dotcom %}-hosted runners. For more information, see "Caching dependencies to speed up workflows." +{% data variables.product.prodname_actions %} caching is only applicable for repositories hosted on {% data variables.product.prodname_dotcom_the_website %}. For more information, see "Caching dependencies to speed up workflows." {% data variables.product.prodname_actions %} does not have an equivalent of CircleCI’s Docker Layer Caching (or DLC). diff --git a/content/actions/learn-github-actions/migrating-from-gitlab-cicd-to-github-actions.md b/content/actions/learn-github-actions/migrating-from-gitlab-cicd-to-github-actions.md index e146bc6988..19661d238b 100644 --- a/content/actions/learn-github-actions/migrating-from-gitlab-cicd-to-github-actions.md +++ b/content/actions/learn-github-actions/migrating-from-gitlab-cicd-to-github-actions.md @@ -4,6 +4,7 @@ intro: '{% data variables.product.prodname_actions %} and GitLab CI/CD share sev versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'tutorial' topics: - 'GitLab' @@ -14,6 +15,7 @@ topics: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### Introduction diff --git a/content/actions/learn-github-actions/migrating-from-jenkins-to-github-actions.md b/content/actions/learn-github-actions/migrating-from-jenkins-to-github-actions.md index bbcc743aac..6ea896566d 100644 --- a/content/actions/learn-github-actions/migrating-from-jenkins-to-github-actions.md +++ b/content/actions/learn-github-actions/migrating-from-jenkins-to-github-actions.md @@ -6,6 +6,7 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'tutorial' topics: - 'Jenkins' @@ -16,6 +17,7 @@ topics: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### Introduction @@ -69,7 +71,7 @@ Jenkins uses directives to manage _Declarative Pipelines_. These directives defi | [`triggers { upstreamprojects() }`](https://jenkins.io/doc/book/pipeline/syntax/#triggers) | [`jobs..needs`](/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idneeds) | | [Jenkins cron syntax](https://jenkins.io/doc/book/pipeline/syntax/#cron-syntax) | [`on.schedule`](/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#onschedule) | | [`stage`](https://jenkins.io/doc/book/pipeline/syntax/#stage) | [`jobs.`](/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_id)
[`jobs..name`](/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idname) | -| [`tools`](https://jenkins.io/doc/book/pipeline/syntax/#tools) | [Specifications for {% data variables.product.prodname_dotcom %}-hosted runners](/actions/reference/specifications-for-github-hosted-runners/#supported-software) | +| [`tools`](https://jenkins.io/doc/book/pipeline/syntax/#tools) | {% if currentVersion == "github-ae@latest" %}For instructions on how to make sure your {% data variables.actions.hosted_runner %} has the required software installed, see "[Creating custom images](/actions/using-github-hosted-runners/creating-custom-images)."{% else %}[Specifications for {% data variables.product.prodname_dotcom %}-hosted runners](/actions/reference/specifications-for-github-hosted-runners/#supported-software) |{% endif %} | [`input`](https://jenkins.io/doc/book/pipeline/syntax/#input) | [`inputs`](/actions/automating-your-workflow-with-github-actions/metadata-syntax-for-github-actions#inputs) | | [`when`](https://jenkins.io/doc/book/pipeline/syntax/#when) | [`jobs..if`](/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idif) | diff --git a/content/actions/learn-github-actions/migrating-from-travis-ci-to-github-actions.md b/content/actions/learn-github-actions/migrating-from-travis-ci-to-github-actions.md index 9daceeafc0..9bcccc2b47 100644 --- a/content/actions/learn-github-actions/migrating-from-travis-ci-to-github-actions.md +++ b/content/actions/learn-github-actions/migrating-from-travis-ci-to-github-actions.md @@ -6,6 +6,7 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'tutorial' topics: - 'Travis CI' @@ -14,6 +15,10 @@ topics: - 'CD' --- +{% data reusables.actions.enterprise-beta %} +{% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} + ### Introduction This guide helps you migrate from Travis CI to {% data variables.product.prodname_actions %}. It compares their concepts and syntax, describes the similarities, and demonstrates their different approaches to common tasks. @@ -182,7 +187,7 @@ When migrating from Travis CI, consider the following key features in {% data va #### Storing secrets -{% data variables.product.prodname_actions %} allows you to store secrets and reference them in your jobs. {% data variables.product.prodname_actions %} organizations can limit which repositories can access organization secrets. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}Environment protection rules can require manual approval for a workflow to access environment secrets. {% endif %}For more information, see "[Encrypted secrets](/actions/reference/encrypted-secrets)." +{% data variables.product.prodname_actions %} allows you to store secrets and reference them in your jobs. {% data variables.product.prodname_actions %} organizations can limit which repositories can access organization secrets. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %}Environment protection rules can require manual approval for a workflow to access environment secrets. {% endif %}For more information, see "[Encrypted secrets](/actions/reference/encrypted-secrets)." #### Sharing files between jobs and workflows diff --git a/content/actions/learn-github-actions/security-hardening-for-github-actions.md b/content/actions/learn-github-actions/security-hardening-for-github-actions.md index 7185fae05b..d5b53f25cf 100644 --- a/content/actions/learn-github-actions/security-hardening-for-github-actions.md +++ b/content/actions/learn-github-actions/security-hardening-for-github-actions.md @@ -8,6 +8,7 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'overview' topics: - 'Security' @@ -15,6 +16,7 @@ topics: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### Overview @@ -22,7 +24,7 @@ This guide explains how to configure security hardening for certain {% data vari ### Using secrets -Sensitive values should never be stored as plaintext in workflow files, but rather as secrets. [Secrets](/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets) can be configured at the organization{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}, repository, or environment{% else %} or repository{% endif %} level, and allow you to store sensitive information in {% data variables.product.product_name %}. +Sensitive values should never be stored as plaintext in workflow files, but rather as secrets. [Secrets](/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets) can be configured at the organization{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %}, repository, or environment{% else %} or repository{% endif %} level, and allow you to store sensitive information in {% data variables.product.product_name %}. Secrets use [Libsodium sealed boxes](https://libsodium.gitbook.io/doc/public-key_cryptography/sealed_boxes), so that they are encrypted before reaching {% data variables.product.product_name %}. This occurs when the secret is submitted [using the UI](/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets#creating-encrypted-secrets-for-a-repository) or through the [REST API](/rest/reference/actions#secrets). This client-side encryption helps the minimize risks related to accidental logging (for example, exception logs and request logs, among others) within {% data variables.product.product_name %}'s infrastructure. Once the secret is uploaded, {% data variables.product.product_name %} is then able to decrypt it so that it can be injected into the workflow runtime. @@ -41,7 +43,7 @@ To help prevent accidental disclosure, {% data variables.product.product_name %} - **Audit and rotate registered secrets** - Periodically review the registered secrets to confirm they are still required. Remove those that are no longer needed. - Rotate secrets periodically to reduce the window of time during which a compromised secret is valid. -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %} - **Consider requiring review for access to secrets** - You can use required reviewers to protect environment secrets. A workflow job cannot access environment secrets until approval is granted by a reviewer. For more information about storing secrets in environments or requiring reviews for environments, see "[Encrypted secrets](/actions/reference/encrypted-secrets)" and "[Environments](/actions/reference/environments)." {% endif %} @@ -75,7 +77,7 @@ This means that a compromise of a single action within a workflow can be very si ### Considering cross-repository access -{% data variables.product.product_name %} is intentionally scoped for a single repository at a time. The `GITHUB_TOKEN` grants the same level of access as a write-access user, because any write-access user can access this token by creating or modifying workflow files. Users have specific permissions for each repository, so having the `GITHUB_TOKEN` for one repository grant access to another would impact the {% data variables.product.prodname_dotcom %} permission model if not implemented carefully. Similarly, caution must be taken when adding {% data variables.product.prodname_dotcom %} authentication tokens to a workflow, because this can also affect the {% data variables.product.prodname_dotcom %} permission model by inadvertently granting broad access to collaborators. +{% data variables.product.prodname_actions %} is intentionally scoped for a single repository at a time. The `GITHUB_TOKEN` grants the same level of access as a write-access user, because any write-access user can access this token by creating or modifying workflow files. Users have specific permissions for each repository, so allowing the `GITHUB_TOKEN` for one repository to grant access to another would impact the {% data variables.product.prodname_dotcom %} permission model if not implemented carefully. Similarly, caution must be taken when adding {% data variables.product.prodname_dotcom %} authentication tokens to a workflow, because this can also affect the {% data variables.product.prodname_dotcom %} permission model by inadvertently granting broad access to collaborators. We have [a plan on the {% data variables.product.prodname_dotcom %} roadmap](https://github.com/github/roadmap/issues/74) to support a flow that allows cross-repository access within {% data variables.product.product_name %}, but this is not yet a supported feature. Currently, the only way to perform privileged cross-repository interactions is to place a {% data variables.product.prodname_dotcom %} authentication token or SSH key as a secret within the workflow. Because many authentication token types do not allow for granular access to specific resources, there is significant risk in using the wrong token type, as it can grant much broader access than intended. @@ -121,6 +123,24 @@ For example, you can use the audit log to track the `org.update_actions_secret` The following tables describe the {% data variables.product.prodname_actions %} events that you can find in the audit log. For more information on using the audit log, see "[Reviewing the audit log for your organization](/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log)." +{% if currentVersion == "free-pro-team@latest" %} +#### Events for environments + +| Action | Description +|------------------|------------------- +| `environment.create_actions_secret` | Triggered when a secret is created in an environment. For more information, see ["Environment secrets](/actions/reference/environments#environment-secrets)." +| `environment.delete` | Triggered when an environment is deleted. For more information, see ["Deleting an environment](/actions/reference/environments#deleting-an-environment)." +| `environment.remove_actions_secret` | Triggered when a secret is removed from an environment. For more information, see ["Environment secrets](/actions/reference/environments#environment-secrets)." +| `environment.update_actions_secret` | Triggered when a secret in an environment is updated. For more information, see ["Environment secrets](/actions/reference/environments#environment-secrets)." +{% endif %} + +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %} +#### Events for configuration changes +| Action | Description +|------------------|------------------- +| `repo.actions_enabled` | Triggered when {% data variables.product.prodname_actions %} is enabled for a repository. Can be viewed using the UI. This event is not visible when you access the audit log using the REST API. For more information, see "[Using the REST API](#using-the-rest-api)." +{% endif %} + #### Events for secret management | Action | Description |------------------|------------------- @@ -131,38 +151,35 @@ The following tables describe the {% data variables.product.prodname_actions %} | `repo.remove_actions_secret` | Triggered when a {% data variables.product.prodname_actions %} secret is removed. | `repo.update_actions_secret` | Triggered when a {% data variables.product.prodname_actions %} secret is updated. -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %} #### Events for self-hosted runners | Action | Description -|------------------|------------------- +|------------------|-------------------{% if currentVersion ver_gt "enterprise-server@2.21" %}{% else %} | `enterprise.register_self_hosted_runner` | Triggered when a new self-hosted runner is registered. For more information, see "[Adding a self-hosted runner to an enterprise](/actions/hosting-your-own-runners/adding-self-hosted-runners#adding-a-self-hosted-runner-to-an-enterprise)." -| `enterprise.self_hosted_runner_updated` | Triggered when the runner application is updated. Can be viewed using the REST API and the UI; not visible in the JSON/CSV export. For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners#about-self-hosted-runners)." +| `enterprise.remove_self_hosted_runner` | Triggered when a self-hosted runner is removed. +| `enterprise.runner_group_runners_updated` | Triggered when a runner group's list of members is updated. For more information, see "[Set self-hosted runners in a group for an organization](/rest/reference/actions#set-self-hosted-runners-in-a-group-for-an-organization)." +| `enterprise.self_hosted_runner_updated` | Triggered when the runner application is updated. Can be viewed using the REST API and the UI. This event is not included when you export the audit log as JSON data or a CSV file. For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners#about-self-hosted-runners)" and "[Reviewing the audit log for your organization](/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#exporting-the-audit-log)."{% endif %} | `org.register_self_hosted_runner` | Triggered when a new self-hosted runner is registered. For more information, see "[Adding a self-hosted runner to an organization](/actions/hosting-your-own-runners/adding-self-hosted-runners#adding-a-self-hosted-runner-to-an-organization)." | `org.remove_self_hosted_runner` | Triggered when a self-hosted runner is removed. For more information, see [Removing a runner from an organization](/actions/hosting-your-own-runners/removing-self-hosted-runners#removing-a-runner-from-an-organization). +| `org.runner_group_runners_updated` | Triggered when a runner group's list of members is updated. For more information, see "[Set self-hosted runners in a group for an organization](/rest/reference/actions#set-self-hosted-runners-in-a-group-for-an-organization)." +| `org.runner_group_updated` | Triggered when the configuration of a self-hosted runner group is changed. For more information, see "[Changing the access policy of a self-hosted runner group](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#changing-the-access-policy-of-a-self-hosted-runner-group)." | `org.self_hosted_runner_updated` | Triggered when the runner application is updated. Can be viewed using the REST API and the UI; not visible in the JSON/CSV export. For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners#about-self-hosted-runners)." | `repo.register_self_hosted_runner` | Triggered when a new self-hosted runner is registered. For more information, see "[Adding a self-hosted runner to a repository](/actions/hosting-your-own-runners/adding-self-hosted-runners#adding-a-self-hosted-runner-to-a-repository)." | `repo.remove_self_hosted_runner` | Triggered when a self-hosted runner is removed. For more information, see "[Removing a runner from a repository](/actions/hosting-your-own-runners/removing-self-hosted-runners#removing-a-runner-from-a-repository)." | `repo.self_hosted_runner_updated` | Triggered when the runner application is updated. Can be viewed using the REST API and the UI; not visible in the JSON/CSV export. For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners#about-self-hosted-runners)." -{% endif %} -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %} #### Events for self-hosted runner groups | Action | Description |------------------|------------------- | `enterprise.runner_group_created` | Triggered when a self-hosted runner group is created. For more information, see "[Creating a self-hosted runner group for an enterprise](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#creating-a-self-hosted-runner-group-for-an-enterprise)." | `enterprise.runner_group_removed` | Triggered when a self-hosted runner group is removed. For more information, see "[Removing a self-hosted runner group](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#removing-a-self-hosted-runner-group)." -| `enterprise.runner_group_runner_removed` | Triggered when a self-hosted runner is removed from a group. +| `enterprise.runner_group_runner_removed` | Triggered when the REST API is used to remove a self-hosted runner from a group. | `enterprise.runner_group_runners_added` | Triggered when a self-hosted runner is added to a group. For more information, see "[Moving a self-hosted runner to a group](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#moving-a-self-hosted-runner-to-a-group)." | `enterprise.runner_group_updated` |Triggered when the configuration of a self-hosted runner group is changed. For more information, see "[Changing the access policy of a self-hosted runner group](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#changing-the-access-policy-of-a-self-hosted-runner-group)." | `org.runner_group_created` | Triggered when a self-hosted runner group is created. For more information, see "[Creating a self-hosted runner group for an organization](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#creating-a-self-hosted-runner-group-for-an-organization)." | `org.runner_group_removed` | Triggered when a self-hosted runner group is removed. For more information, see "[Removing a self-hosted runner group](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#removing-a-self-hosted-runner-group)." | `org.runner_group_runners_added` | Triggered when a self-hosted runner is added to a group. For more information, see "[Moving a self-hosted runner to a group](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#moving-a-self-hosted-runner-to-a-group)." -| `org.runner_group_runner_removed` | Triggered when a self-hosted runner is removed from a group. -{% endif %} +| `org.runner_group_runner_removed` | Triggered when the REST API is used to remove a self-hosted runner from a group. For more information, see "[Remove a self-hosted runner from a group for an organization](/rest/reference/actions#remove-a-self-hosted-runner-from-a-group-for-an-organization)." -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %} #### Events for workflow activities {% data reusables.actions.actions-audit-events-workflow %} - -{% endif %} diff --git a/content/actions/learn-github-actions/sharing-workflows-with-your-organization.md b/content/actions/learn-github-actions/sharing-workflows-with-your-organization.md index 264a15171f..9031151f9d 100644 --- a/content/actions/learn-github-actions/sharing-workflows-with-your-organization.md +++ b/content/actions/learn-github-actions/sharing-workflows-with-your-organization.md @@ -7,11 +7,13 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'how_to' --- {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### Overview diff --git a/content/actions/managing-workflow-runs/adding-a-workflow-status-badge.md b/content/actions/managing-workflow-runs/adding-a-workflow-status-badge.md index 92fa7fc3d7..a5f04694bc 100644 --- a/content/actions/managing-workflow-runs/adding-a-workflow-status-badge.md +++ b/content/actions/managing-workflow-runs/adding-a-workflow-status-badge.md @@ -5,10 +5,12 @@ product: '{% data reusables.gated-features.actions %}' versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} {% data reusables.repositories.actions-workflow-status-badge-into %} diff --git a/content/actions/managing-workflow-runs/canceling-a-workflow.md b/content/actions/managing-workflow-runs/canceling-a-workflow.md index 153659d966..14c6714dd2 100644 --- a/content/actions/managing-workflow-runs/canceling-a-workflow.md +++ b/content/actions/managing-workflow-runs/canceling-a-workflow.md @@ -5,10 +5,12 @@ product: '{% data reusables.gated-features.actions %}' versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} {% data reusables.repositories.permissions-statement-write %} @@ -20,7 +22,7 @@ versions: 1. From the list of workflow runs, click the name of the `queued` or `in progress` run that you want to cancel. ![Name of workflow run](/assets/images/help/repository/in-progress-run.png) 1. In the upper-right corner of the workflow, click **Cancel workflow**. -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %} ![Cancel check suite button](/assets/images/help/repository/cancel-check-suite-updated.png) {% else %} ![Cancel check suite button](/assets/images/help/repository/cancel-check-suite.png) diff --git a/content/actions/managing-workflow-runs/deleting-a-workflow-run.md b/content/actions/managing-workflow-runs/deleting-a-workflow-run.md index 18ebe8c5cc..f81c479711 100644 --- a/content/actions/managing-workflow-runs/deleting-a-workflow-run.md +++ b/content/actions/managing-workflow-runs/deleting-a-workflow-run.md @@ -5,10 +5,12 @@ product: '{% data reusables.gated-features.actions %}' versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} {% data reusables.repositories.permissions-statement-write %} diff --git a/content/actions/managing-workflow-runs/disabling-and-enabling-a-workflow.md b/content/actions/managing-workflow-runs/disabling-and-enabling-a-workflow.md index c4dbd75645..9cd84a31fa 100644 --- a/content/actions/managing-workflow-runs/disabling-and-enabling-a-workflow.md +++ b/content/actions/managing-workflow-runs/disabling-and-enabling-a-workflow.md @@ -5,10 +5,12 @@ product: '{% data reusables.gated-features.actions %}' versions: free-pro-team: '*' enterprise-server: '>=2.23' + github-ae: '*' --- {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} Disabling a workflow allows you to stop a workflow from being triggered without having to delete the file from the repo. You can easily re-enable the workflow again on {% data variables.product.prodname_dotcom %}. You can also disable and enable a workflow using the REST API. For more information, see the "[Actions REST API](/rest/reference/actions#workflows)." diff --git a/content/actions/managing-workflow-runs/downloading-workflow-artifacts.md b/content/actions/managing-workflow-runs/downloading-workflow-artifacts.md index 11843c3cec..df597aa7ac 100644 --- a/content/actions/managing-workflow-runs/downloading-workflow-artifacts.md +++ b/content/actions/managing-workflow-runs/downloading-workflow-artifacts.md @@ -5,12 +5,14 @@ product: '{% data reusables.gated-features.actions %}' versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} By default, {% data variables.product.product_name %} stores build logs and artifacts for 90 days, and you can customize this retention period, depending on the type of repository. For more information, see "[Configuring the retention period for GitHub Actions artifacts and logs in your repository](/github/administering-a-repository/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-repository)."{% endif %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} By default, {% data variables.product.product_name %} stores build logs and artifacts for 90 days, and you can customize this retention period, depending on the type of repository. For more information, see "[Configuring the retention period for GitHub Actions artifacts and logs in your repository](/github/administering-a-repository/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-repository)."{% endif %} {% if currentVersion == "enterprise-server@2.22" %} {% data variables.product.product_name %} stores full build logs and artifacts for 90 days.{% endif %} {% data reusables.repositories.permissions-statement-read %} @@ -20,7 +22,7 @@ versions: {% data reusables.repositories.navigate-to-workflow %} {% data reusables.repositories.view-run %} 1. Under **Artifacts**, click the artifact you want to download. - {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} + {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %} ![Download artifact drop-down menu](/assets/images/help/repository/artifact-drop-down-updated.png) {% else %} ![Download artifact drop-down menu](/assets/images/help/repository/artifact-drop-down.png) diff --git a/content/actions/managing-workflow-runs/enabling-debug-logging.md b/content/actions/managing-workflow-runs/enabling-debug-logging.md index a4787be05a..a4e5ac69a0 100644 --- a/content/actions/managing-workflow-runs/enabling-debug-logging.md +++ b/content/actions/managing-workflow-runs/enabling-debug-logging.md @@ -5,15 +5,17 @@ product: '{% data reusables.gated-features.actions %}' versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} These extra logs are enabled by setting secrets in the repository containing the workflow, so the same permissions requirements will apply: - {% data reusables.github-actions.permissions-statement-secrets-repository %} -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %} - {% data reusables.github-actions.permissions-statement-secrets-environment %} {% endif %} - {% data reusables.github-actions.permissions-statement-secrets-organization %} diff --git a/content/actions/managing-workflow-runs/index.md b/content/actions/managing-workflow-runs/index.md index 4d5e7554b1..2606df2f97 100644 --- a/content/actions/managing-workflow-runs/index.md +++ b/content/actions/managing-workflow-runs/index.md @@ -1,7 +1,7 @@ --- title: Managing workflow runs shortTitle: Managing workflow runs -intro: 'You can view the status and results of each step in your workflow, cancel a pending workflow, {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}review deployments, {% endif %}view billable job execution minutes, debug and re-run a failed workflow, search and download logs, and download artifacts.' +intro: 'You can view the status and results of each step in your workflow, cancel a pending workflow, {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %}review deployments, {% endif %}view billable job execution minutes, debug and re-run a failed workflow, search and download logs, and download artifacts.' redirect_from: - /actions/configuring-and-managing-workflows/managing-a-workflow-run - /articles/viewing-your-repository-s-workflows @@ -13,12 +13,14 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}{% link_in_list /using-the-visualization-graph %}{% endif %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %}{% link_in_list /using-the-visualization-graph %}{% endif %} {% link_in_list /viewing-workflow-run-history %} {% link_in_list /using-workflow-run-logs %} {% link_in_list /manually-running-a-workflow %} diff --git a/content/actions/managing-workflow-runs/manually-running-a-workflow.md b/content/actions/managing-workflow-runs/manually-running-a-workflow.md index 753dda70cb..55a78bf07c 100644 --- a/content/actions/managing-workflow-runs/manually-running-a-workflow.md +++ b/content/actions/managing-workflow-runs/manually-running-a-workflow.md @@ -5,10 +5,12 @@ product: '{% data reusables.gated-features.actions %}' versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### Configuring a workflow to run manually diff --git a/content/actions/managing-workflow-runs/re-running-a-workflow.md b/content/actions/managing-workflow-runs/re-running-a-workflow.md index 323ebab2d3..f72ee39863 100644 --- a/content/actions/managing-workflow-runs/re-running-a-workflow.md +++ b/content/actions/managing-workflow-runs/re-running-a-workflow.md @@ -5,10 +5,12 @@ product: '{% data reusables.gated-features.actions %}' versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} {% data reusables.repositories.permissions-statement-write %} @@ -16,4 +18,4 @@ versions: {% data reusables.repositories.actions-tab %} {% data reusables.repositories.navigate-to-workflow %} {% data reusables.repositories.view-run %} -1. In the upper-right corner of the workflow, use the **Re-run jobs** drop-down menu, and select **Re-run all jobs**.{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}![Re-run checks drop-down menu](/assets/images/help/repository/rerun-checks-drop-down-updated.png){% else %}![Re-run checks drop-down menu](/assets/images/help/repository/rerun-checks-drop-down.png){% endif %} +1. In the upper-right corner of the workflow, use the **Re-run jobs** drop-down menu, and select **Re-run all jobs**.{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %}![Re-run checks drop-down menu](/assets/images/help/repository/rerun-checks-drop-down-updated.png){% else %}![Re-run checks drop-down menu](/assets/images/help/repository/rerun-checks-drop-down.png){% endif %} diff --git a/content/actions/managing-workflow-runs/removing-workflow-artifacts.md b/content/actions/managing-workflow-runs/removing-workflow-artifacts.md index 33595a42cf..a433c07caa 100644 --- a/content/actions/managing-workflow-runs/removing-workflow-artifacts.md +++ b/content/actions/managing-workflow-runs/removing-workflow-artifacts.md @@ -5,10 +5,12 @@ product: '{% data reusables.gated-features.actions %}' versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### Deleting an artifact @@ -27,13 +29,13 @@ versions: {% data reusables.repositories.navigate-to-workflow %} {% data reusables.repositories.view-run %} 1. Under **Artifacts**, click {% octicon "trashcan" aria-label="The trashcan icon" %} next to the artifact you want to remove. - {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} + {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %} ![Delete artifact drop-down menu](/assets/images/help/repository/actions-delete-artifact-updated.png) {% else %} ![Delete artifact drop-down menu](/assets/images/help/repository/actions-delete-artifact.png) {% endif %} -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} ### Setting the retention period for an artifact Retention periods for artifacts and logs can be configured at the repository, organization, and enterprise level. For more information, see "[Usage limits, billing, and administration](/actions/reference/usage-limits-billing-and-administration#artifact-and-log-retention-policy)." diff --git a/content/actions/managing-workflow-runs/reviewing-deployments.md b/content/actions/managing-workflow-runs/reviewing-deployments.md index 3df0e34763..a2fb11eb67 100644 --- a/content/actions/managing-workflow-runs/reviewing-deployments.md +++ b/content/actions/managing-workflow-runs/reviewing-deployments.md @@ -5,9 +5,11 @@ product: '{% data reusables.gated-features.environments %}' versions: free-pro-team: '*' enterprise-server: '>=3.1' + github-ae: '*' --- {% data reusables.actions.environments-beta %} +{% data reusables.actions.ae-beta %} ### About required reviews in workflows diff --git a/content/actions/managing-workflow-runs/using-the-visualization-graph.md b/content/actions/managing-workflow-runs/using-the-visualization-graph.md index 2fe6753a30..2fbeb2a9ae 100644 --- a/content/actions/managing-workflow-runs/using-the-visualization-graph.md +++ b/content/actions/managing-workflow-runs/using-the-visualization-graph.md @@ -5,11 +5,13 @@ product: '{% data reusables.gated-features.actions %}' versions: free-pro-team: '*' enterprise-server: '>=3.1' + github-ae: '*' --- {% data reusables.actions.enterprise-beta %} {% data reusables.actions.visualization-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.actions-tab %} diff --git a/content/actions/managing-workflow-runs/using-workflow-run-logs.md b/content/actions/managing-workflow-runs/using-workflow-run-logs.md index 9cffb45bc3..fa3973fb94 100644 --- a/content/actions/managing-workflow-runs/using-workflow-run-logs.md +++ b/content/actions/managing-workflow-runs/using-workflow-run-logs.md @@ -5,10 +5,12 @@ product: '{% data reusables.gated-features.actions %}' versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} You can see whether a workflow run is in progress or complete from the workflow run page. You must be logged in to a {% data variables.product.prodname_dotcom %} account to view workflow run information, including for public repositories. For more information, see "[Access permissions on GitHub](/articles/access-permissions-on-github)." @@ -43,9 +45,9 @@ You can search the build logs for a particular step. When you search logs, only {% data reusables.repositories.navigate-to-workflow-superlinter %} {% data reusables.repositories.view-run-superlinter %} {% data reusables.repositories.navigate-to-job-superlinter %} -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} 1. In the upper-right corner of the log output, in the **Search logs** search box, type a search query. -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %} ![Search box to search logs](/assets/images/help/repository/search-log-box-updated-2.png) {% else %} ![Search box to search logs](/assets/images/help/repository/search-log-box-updated.png) @@ -66,9 +68,9 @@ You can download the log files from your workflow run. You can also download a w {% data reusables.repositories.navigate-to-workflow-superlinter %} {% data reusables.repositories.view-run-superlinter %} {% data reusables.repositories.navigate-to-job-superlinter %} -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} -1. In the upper right corner, click {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}{% octicon "gear" aria-label="The gear icon" %}{% else %}{% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}{% endif %} and select **Download log archive**. - {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} +1. In the upper right corner, click {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %}{% octicon "gear" aria-label="The gear icon" %}{% else %}{% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}{% endif %} and select **Download log archive**. + {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %} ![Download logs drop-down menu](/assets/images/help/repository/download-logs-drop-down-updated-2.png) {% else %} ![Download logs drop-down menu](/assets/images/help/repository/download-logs-drop-down-updated.png) @@ -86,15 +88,15 @@ You can delete the log files from your workflow run. {% data reusables.repositor {% data reusables.repositories.actions-tab %} {% data reusables.repositories.navigate-to-workflow-superlinter %} {% data reusables.repositories.view-run-superlinter %} -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} 1. In the upper right corner, click {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}. - {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} + {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %} ![Kebab-horizontal icon](/assets/images/help/repository/workflow-run-kebab-horizontal-icon-updated-2.png) {% else %} ![Kebab-horizontal icon](/assets/images/help/repository/workflow-run-kebab-horizontal-icon-updated.png) {% endif %} 2. To delete the log files, click the **Delete all logs** button and review the confirmation prompt. - {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} + {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %} ![Delete all logs](/assets/images/help/repository/delete-all-logs-updated-2.png) {% else %} ![Delete all logs](/assets/images/help/repository/delete-all-logs-updated.png) diff --git a/content/actions/managing-workflow-runs/viewing-job-execution-time.md b/content/actions/managing-workflow-runs/viewing-job-execution-time.md index e1b7bd9ac0..87c41449d4 100644 --- a/content/actions/managing-workflow-runs/viewing-job-execution-time.md +++ b/content/actions/managing-workflow-runs/viewing-job-execution-time.md @@ -8,6 +8,7 @@ versions: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} Billable job execution minutes are only shown for jobs run on private repositories that use {% data variables.product.prodname_dotcom %}-hosted runners. There are no billable minutes when using {% data variables.product.prodname_actions %} in public repositories or for jobs run on self-hosted runners. diff --git a/content/actions/managing-workflow-runs/viewing-workflow-run-history.md b/content/actions/managing-workflow-runs/viewing-workflow-run-history.md index 47ca04068e..284bd3fcd9 100644 --- a/content/actions/managing-workflow-runs/viewing-workflow-run-history.md +++ b/content/actions/managing-workflow-runs/viewing-workflow-run-history.md @@ -5,10 +5,12 @@ product: '{% data reusables.gated-features.actions %}' versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} {% data reusables.repositories.permissions-statement-read %} diff --git a/content/actions/quickstart.md b/content/actions/quickstart.md index 3463cb3406..fa57cf9deb 100644 --- a/content/actions/quickstart.md +++ b/content/actions/quickstart.md @@ -7,6 +7,7 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'quick_start' topics: - 'Fundamentals' @@ -14,6 +15,7 @@ topics: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### Introduction @@ -63,7 +65,7 @@ Committing the workflow file in your repository triggers the `push` event and ru {% data reusables.repositories.actions-tab %} {% data reusables.repositories.navigate-to-workflow-superlinter %} {% data reusables.repositories.view-run-superlinter %} -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %} 1. Under **Jobs** or in the visualization graph, click the **Lint code base** job. ![Lint code base job](/assets/images/help/repository/superlinter-lint-code-base-job-updated.png) {% else %} diff --git a/content/actions/reference/authentication-in-a-workflow.md b/content/actions/reference/authentication-in-a-workflow.md index 5db39077b9..eac1b060d0 100644 --- a/content/actions/reference/authentication-in-a-workflow.md +++ b/content/actions/reference/authentication-in-a-workflow.md @@ -9,10 +9,12 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### About the `GITHUB_TOKEN` secret @@ -38,7 +40,7 @@ This example workflow uses the [labeler action](https://github.com/actions/label ```yaml name: Pull request labeler on: - - pull_request + - pull_request_target jobs: triage: runs-on: ubuntu-latest @@ -93,6 +95,8 @@ For information about the API endpoints {% data variables.product.prodname_githu | repository projects | read/write | read | | statuses | read/write | read | +{% data reusables.actions.workflow-runs-dependabot-note %} + If you need a token that requires permissions that aren't available in the `GITHUB_TOKEN`, you can create a personal access token and set it as a secret in your repository: 1. Use or create a token with the appropriate permissions for that repository. For more information, see "[Creating a personal access token](/github/authenticating-to-github/creating-a-personal-access-token)." diff --git a/content/actions/reference/context-and-expression-syntax-for-github-actions.md b/content/actions/reference/context-and-expression-syntax-for-github-actions.md index 3fa953b677..8bdfedc6e8 100644 --- a/content/actions/reference/context-and-expression-syntax-for-github-actions.md +++ b/content/actions/reference/context-and-expression-syntax-for-github-actions.md @@ -11,10 +11,12 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### About contexts and expressions @@ -156,7 +158,8 @@ The `runner` context contains information about the runner that is executing the |---------------|------|-------------| | `runner.os` | `string` | The operating system of the runner executing the job. Possible values are `Linux`, `Windows`, or `macOS`. | | `runner.temp` | `string` | The path of the temporary directory for the runner. This directory is guaranteed to be empty at the start of each job, even on self-hosted runners. | -| `runner.tool_cache` | `string` | The path of the directory containing some of the preinstalled tools for {% data variables.product.prodname_dotcom %}-hosted runners. For more information, see "[Specifications for {% data variables.product.prodname_dotcom %}-hosted runners](/actions/reference/specifications-for-github-hosted-runners/#supported-software)". | +| `runner.tool_cache` | `string` | {% if currentVersion == "github-ae@latest" %}For instructions on how to make sure your {% data variables.actions.hosted_runner %} has the required software installed, see "[Creating custom images](/actions/using-github-hosted-runners/creating-custom-images)." +{% else %}The path of the directory containing some of the preinstalled tools for {% data variables.product.prodname_dotcom %}-hosted runners. For more information, see "[Specifications for {% data variables.product.prodname_dotcom %}-hosted runners](/actions/reference/specifications-for-github-hosted-runners/#supported-software)". {% endif %}| #### `needs` context diff --git a/content/actions/reference/encrypted-secrets.md b/content/actions/reference/encrypted-secrets.md index f7f502c99d..c6dda65cfd 100644 --- a/content/actions/reference/encrypted-secrets.md +++ b/content/actions/reference/encrypted-secrets.md @@ -9,19 +9,21 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.actions.enterprise-beta %} {% data reusables.actions.environments-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### About encrypted secrets -Secrets are encrypted environment variables that you create in an organization{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}, repository, or repository environment{% else %} or repository{% endif %}. The secrets that you create are available to use in {% data variables.product.prodname_actions %} workflows. {% data variables.product.prodname_dotcom %} uses a [libsodium sealed box](https://libsodium.gitbook.io/doc/public-key_cryptography/sealed_boxes) to help ensure that secrets are encrypted before they reach {% data variables.product.prodname_dotcom %} and remain encrypted until you use them in a workflow. +Secrets are encrypted environment variables that you create in an organization{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %}, repository, or repository environment{% else %} or repository{% endif %}. The secrets that you create are available to use in {% data variables.product.prodname_actions %} workflows. {% data variables.product.prodname_dotcom %} uses a [libsodium sealed box](https://libsodium.gitbook.io/doc/public-key_cryptography/sealed_boxes) to help ensure that secrets are encrypted before they reach {% data variables.product.prodname_dotcom %} and remain encrypted until you use them in a workflow. {% data reusables.github-actions.secrets-org-level-overview %} -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %} For secrets stored at the environment level, you can enable required reviewers to control access to the secrets. A workflow job cannot access environment secrets until approval is granted by required approvers. {% endif %} @@ -33,9 +35,9 @@ The following rules apply to secret names: * Secret names must not start with the `GITHUB_` prefix. * Secret names must not start with a number. * Secret names are not case-sensitive. -* Secret names must be unique at the level they are created at. For example, {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}a secret created at the environment level must have a unique name in that environment, {% endif %}a secret created at the repository level must have a unique name in that repository, and a secret created at the organization level must have a unique name at that level. +* Secret names must be unique at the level they are created at. For example, {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %}a secret created at the environment level must have a unique name in that environment, {% endif %}a secret created at the repository level must have a unique name in that repository, and a secret created at the organization level must have a unique name at that level. - If a secret with the same name exists at multiple levels, the secret at the lower level takes precedence. For example, if an organization-level secret has the same name as a repository-level secret, then the repository-level secret takes precedence.{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} Similarly, if an organization, repository, and environment all have a secret with the same name, the environment-level secret takes precedence.{% endif %} + If a secret with the same name exists at multiple levels, the secret at the lower level takes precedence. For example, if an organization-level secret has the same name as a repository-level secret, then the repository-level secret takes precedence.{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %} Similarly, if an organization, repository, and environment all have a secret with the same name, the environment-level secret takes precedence.{% endif %} To help ensure that {% data variables.product.prodname_dotcom %} redacts your secret in logs, avoid using structured data as the values of secrets. For example, avoid creating secrets that contain JSON or encoded Git blobs. @@ -51,7 +53,7 @@ You can use and read encrypted secrets in a workflow file if you have access to {% endwarning %} -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %} Organization and repository secrets are read when a workflow run is queued, and environment secrets are read when a job referencing the environment starts. {% endif %} @@ -73,9 +75,15 @@ When generating credentials, we recommend that you grant the minimum permissions 1. Enter the value for your secret. 1. Click **Add secret**. -If your repository {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}has environment secrets or {% endif %}can access secrets from the parent organization, then those secrets are also listed on this page. +If your repository {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0"or currentVersion == "github-ae@latest" %}has environment secrets or {% endif %}can access secrets from the parent organization, then those secrets are also listed on this page. -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} +{% note %} + +**Note:** Users with collaborator access can use the REST API to manage secrets for a repository. For more information, see "[{% data variables.product.prodname_actions %} secrets API](/rest/reference/actions#secrets)." + +{% endnote %} + +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" } ### Creating encrypted secrets for an environment {% data reusables.github-actions.permissions-statement-secrets-environment %} @@ -178,7 +186,7 @@ steps: ### Limits for secrets -You can store up to 1,000 secrets per organization{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}, 100 secrets per repository, and 100 secrets per environment{% else %} and 100 secrets per repository{% endif %}. A workflow may use up to 100 organization secrets and 100 repository secrets.{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} Additionally, a job referencing an environment may use up to 100 environment secrets.{% endif %} +You can store up to 1,000 secrets per organization{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %}, 100 secrets per repository, and 100 secrets per environment{% else %} and 100 secrets per repository{% endif %}. A workflow may use up to 100 organization secrets and 100 repository secrets.{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %} Additionally, a job referencing an environment may use up to 100 environment secrets.{% endif %} Secrets are limited to 64 KB in size. To use secrets that are larger than 64 KB, you can store encrypted secrets in your repository and save the decryption passphrase as a secret on {% data variables.product.prodname_dotcom %}. For example, you can use `gpg` to encrypt your credentials locally before checking the file in to your repository on {% data variables.product.prodname_dotcom %}. For more information, see the "[gpg manpage](https://www.gnupg.org/gph/de/manual/r1023.html)." diff --git a/content/actions/reference/environment-variables.md b/content/actions/reference/environment-variables.md index 2677930a56..78b6e0a93b 100644 --- a/content/actions/reference/environment-variables.md +++ b/content/actions/reference/environment-variables.md @@ -9,10 +9,12 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### About environment variables @@ -40,7 +42,7 @@ To use the value of an environment variable in a workflow file, you should use t If you use the workflow file's `run` key to read environment variables from within the runner operating system (as shown in the example above), the variable is substituted in the runner operating system after the job is sent to the runner. For other parts of a workflow file, you must use the `env` context to read environment variables; this is because workflow keys (such as `if`) require the variable to be substituted during workflow processing before it is sent to the runner. -You can also use the {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}`GITHUB_ENV` environment file{% else %} `set-env` workflow command{% endif %} to set an environment variable that the following steps in a workflow can use. The {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}environment file{% else %} `set-env` command{% endif %} can be used directly by an action or as a shell command in a workflow file using the `run` keyword. For more information, see "[Workflow commands for {% data variables.product.prodname_actions %}](/actions/reference/workflow-commands-for-github-actions/#setting-an-environment-variable)." +You can also use the {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %}`GITHUB_ENV` environment file{% else %} `set-env` workflow command{% endif %} to set an environment variable that the following steps in a workflow can use. The {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %}environment file{% else %} `set-env` command{% endif %} can be used directly by an action or as a shell command in a workflow file using the `run` keyword. For more information, see "[Workflow commands for {% data variables.product.prodname_actions %}](/actions/reference/workflow-commands-for-github-actions/#setting-an-environment-variable)." ### Default environment variables diff --git a/content/actions/reference/environments.md b/content/actions/reference/environments.md index cfbdbfc1cd..24221ac7b9 100644 --- a/content/actions/reference/environments.md +++ b/content/actions/reference/environments.md @@ -5,9 +5,11 @@ product: '{% data reusables.gated-features.environments %}' versions: free-pro-team: '*' enterprise-server: '>=3.1' + github-ae: '*' --- {% data reusables.actions.environments-beta %} +{% data reusables.actions.ae-beta %} ### About environments diff --git a/content/actions/reference/events-that-trigger-workflows.md b/content/actions/reference/events-that-trigger-workflows.md index 7bb9d38713..d1e9e8de83 100644 --- a/content/actions/reference/events-that-trigger-workflows.md +++ b/content/actions/reference/events-that-trigger-workflows.md @@ -10,10 +10,12 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### Configuring workflow events @@ -41,11 +43,7 @@ The following steps occur to trigger a workflow run: The `schedule` event allows you to trigger a workflow at a scheduled time. -{% note %} - -Note: Due to load, the `schedule` event may be delayed - -{% endnote %} +{% data reusables.actions.schedule-delay %} #### `schedule` @@ -586,7 +584,7 @@ on: {% data reusables.developer-site.pull_request_forked_repos_link %} -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} #### `pull_request_target` @@ -594,7 +592,7 @@ This event runs in the context of the base of the pull request, rather than in t {% warning %} -**Warning:** The `pull_request_target` event is granted a read/write repository token and can access secrets, even when it is triggered from a fork. Although the workflow runs in the context of the base of the pull request, you should make sure that you do not check out, build, or run untrusted code from the pull request with this event. Additionally, any caches share the same scope as the base branch, and to help prevent cache poisoning, you should not save the cache if there is a possibility that the cache contents were altered. +**Warning:** The `pull_request_target` event is granted a read/write repository token and can access secrets, even when it is triggered from a fork. Although the workflow runs in the context of the base of the pull request, you should make sure that you do not check out, build, or run untrusted code from the pull request with this event. Additionally, any caches share the same scope as the base branch, and to help prevent cache poisoning, you should not save the cache if there is a possibility that the cache contents were altered. For more information, see "[Keeping your GitHub Actions and workflows secure: Preventing pwn requests](https://securitylab.github.com/research/github-actions-preventing-pwn-requests)" on the GitHub Security Lab website. {% endwarning %} @@ -714,7 +712,7 @@ on: types: [started] ``` -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} #### `workflow_run` @@ -723,12 +721,14 @@ on: {% data reusables.github-actions.branch-requirement %} | Webhook event payload | Activity types | `GITHUB_SHA` | `GITHUB_REF` | -| --------------------- | -------------- | ------------ | -------------| -| [`workflow_run`](/webhooks/event-payloads/#workflow_run) | - n/a | Last commit on default branch | Default branch | +| --------------------- | -------------- | ------------ | -------------| +| [`workflow_run`](/webhooks/event-payloads/#workflow_run) | - `completed`
- `requested` | Last commit on default branch | Default branch | + +{% data reusables.developer-site.limit_workflow_to_activity_types %} If you need to filter branches from this event, you can use `branches` or `branches-ignore`. -In this example, a workflow is configured to run after the separate “Run Tests” workflow completes. +In this example, a workflow is configured to run after the separate "Run Tests" workflow completes. ```yaml on: @@ -742,6 +742,27 @@ on: {% endif %} +To run a workflow job conditionally based on the result of the previous workflow run, you can use the [`jobs..if`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idif) or [`jobs..steps[*].if`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstepsif) conditional combined with the `conclusion` of the previous run. For example: + +```yaml +on: + workflow_run: + workflows: ["Build"] + types: [completed] + +jobs: + on-success: + runs-on: ubuntu-latest + if: {% raw %}${{ github.event.workflow_run.conclusion == 'success' }}{% endraw %} + steps: + ... + on-failure: + runs-on: ubuntu-latest + if: {% raw %}${{ github.event.workflow_run.conclusion == 'failure' }}{% endraw %} + steps: + ... +``` + ### Triggering new workflows using a personal access token {% data reusables.github-actions.actions-do-not-trigger-workflows %} For more information, see "[Authenticating with the GITHUB_TOKEN](/actions/configuring-and-managing-workflows/authenticating-with-the-github_token)." diff --git a/content/actions/reference/index.md b/content/actions/reference/index.md index c94ae2f4eb..11a946236e 100644 --- a/content/actions/reference/index.md +++ b/content/actions/reference/index.md @@ -6,10 +6,12 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### Workflow syntax @@ -27,12 +29,12 @@ You can configure workflows to run when specific GitHub events occur, at a sched ### Authentication and secrets -{% data variables.product.prodname_dotcom %} provides a token that you can use to authenticate on behalf of {% data variables.product.prodname_actions %}. You can also store sensitive information as a secret in your organization{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}, repository, or environments{% else %} or repository{% endif %}. {% data variables.product.prodname_dotcom %} encrypts all secrets. +{% data variables.product.prodname_dotcom %} provides a token that you can use to authenticate on behalf of {% data variables.product.prodname_actions %}. You can also store sensitive information as a secret in your organization{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %}, repository, or environments{% else %} or repository{% endif %}. {% data variables.product.prodname_dotcom %} encrypts all secrets. {% link_in_list /authentication-in-a-workflow %} {% link_in_list /encrypted-secrets %} -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %} ### Environments Workflow jobs can reference environments that have protection rules or environment-specific secrets. @@ -40,12 +42,11 @@ Workflow jobs can reference environments that have protection rules or environme {% link_in_list /environments %} {% endif %} -### {% data variables.product.prodname_dotcom %}-hosted runners +### Environment variables -GitHub offers hosted virtual machines to run workflows. The virtual machine contains an environment with tools, packages, and environment variables for GitHub Actions to use. +{% data variables.product.prodname_dotcom %} sets default environment variables for each {% data variables.product.prodname_actions %} workflow run. You can also set custom environment variables in your workflow file. {% link_in_list /environment-variables %} -{% link_in_list /specifications-for-github-hosted-runners %} {% if currentVersion == "free-pro-team@latest" %} ### Administration diff --git a/content/actions/reference/usage-limits-billing-and-administration.md b/content/actions/reference/usage-limits-billing-and-administration.md index 9029966809..2ab089a0ed 100644 --- a/content/actions/reference/usage-limits-billing-and-administration.md +++ b/content/actions/reference/usage-limits-billing-and-administration.md @@ -7,17 +7,21 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' +topics: + - billing --- {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### About billing for {% data variables.product.prodname_actions %} {% if currentVersion == "free-pro-team@latest" %} {% data reusables.github-actions.actions-billing %} For more information, see "[About billing for {% data variables.product.prodname_actions %}](/github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-actions)." {% else %} -GitHub Actions usage is free for {% data variables.product.prodname_ghe_server %} that use self-hosted runners. +GitHub Actions usage is free for {% data variables.product.prodname_ghe_server %}s that use self-hosted runners. {% endif %} ### Usage limits @@ -53,7 +57,7 @@ Usage limits apply to self-hosted runners. For more information, see "[About sel In addition to the usage limits, you must ensure that you use {% data variables.product.prodname_actions %} within the [GitHub Terms of Service](/articles/github-terms-of-service/). For more information on {% data variables.product.prodname_actions %}-specific terms, see the [GitHub Additional Product Terms](/github/site-policy/github-additional-product-terms#a-actions-usage). {% endif %} -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} ### Artifact and log retention policy You can configure the artifact and log retention period for your repository, organization, or enterprise account. @@ -76,7 +80,7 @@ For more information, see: - "[Disabling or limiting {% data variables.product.prodname_actions %} for your organization](/github/setting-up-and-managing-organizations-and-teams/disabling-or-limiting-github-actions-for-your-organization)"{% if currentVersion == "free-pro-team@latest" %} - "[Enforcing {% data variables.product.prodname_actions %} policies in your enterprise account](/github/setting-up-and-managing-your-enterprise/enforcing-github-actions-policies-in-your-enterprise-account)" for {% data variables.product.prodname_ghe_cloud %}{% endif %} -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} ### Disabling and enabling workflows You can enable and disable individual workflows in your repository on {% data variables.product.prodname_dotcom %}. diff --git a/content/actions/reference/workflow-commands-for-github-actions.md b/content/actions/reference/workflow-commands-for-github-actions.md index 9ed021e035..3c2e13b996 100644 --- a/content/actions/reference/workflow-commands-for-github-actions.md +++ b/content/actions/reference/workflow-commands-for-github-actions.md @@ -12,16 +12,18 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### About workflow commands Actions can communicate with the runner machine to set environment variables, output values used by other actions, add debug messages to the output logs, and other tasks. -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} Most workflow commands use the `echo` command in a specific format, while others are invoked by writing to a file. For more information, see ["Environment files".](#environment-files) {% else %} Workflow commands use the `echo` command in a specific format. @@ -67,11 +69,11 @@ The following table shows which toolkit functions are available within a workflo | Toolkit function | Equivalent workflow command | | ----------------- | ------------- | -| `core.addPath` | {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}Accessible using environment file `GITHUB_PATH`{% else %} `add-path` {% endif %} | +| `core.addPath` | {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %}Accessible using environment file `GITHUB_PATH`{% else %} `add-path` {% endif %} | | `core.debug` | `debug` | | `core.error` | `error` | | `core.endGroup` | `endgroup` | -| `core.exportVariable` | {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}Accessible using environment file `GITHUB_ENV`{% else %} `set-env` {% endif %} | +| `core.exportVariable` | {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %}Accessible using environment file `GITHUB_ENV`{% else %} `set-env` {% endif %} | | `core.getInput` | Accessible using environment variable `INPUT_{NAME}` | | `core.getState` | Accessible using environment variable `STATE_{NAME}` | | `core.isDebug` | Accessible using environment variable `RUNNER_DEBUG` | @@ -244,7 +246,7 @@ The `STATE_processID` variable is then exclusively available to the cleanup scri console.log("The running PID from the main action is: " + process.env.STATE_processID); ``` -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} ## Environment Files During the execution of a workflow, the runner generates temporary files that can be used to perform certain actions. The path to these files are exposed via environment variables. You will need to use UTF-8 encoding when writing to these files to ensure proper processing of the commands. Multiple commands can be written to the same file, separated by newlines. diff --git a/content/actions/reference/workflow-syntax-for-github-actions.md b/content/actions/reference/workflow-syntax-for-github-actions.md index 8ccdc04e3f..c5431f7372 100644 --- a/content/actions/reference/workflow-syntax-for-github-actions.md +++ b/content/actions/reference/workflow-syntax-for-github-actions.md @@ -10,10 +10,12 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### About YAML syntax for workflows @@ -288,6 +290,20 @@ In this example, `job3` uses the `always()` conditional expression so that it al **Required**. The type of machine to run the job on. The machine can be either a {% data variables.product.prodname_dotcom %}-hosted runner or a self-hosted runner. +{% if currentVersion == "github-ae@latest" %} +#### {% data variables.actions.hosted_runner %}s + +If you use an {% data variables.actions.hosted_runner %}, each job runs in a fresh instance of a virtual environment specified by `runs-on`. + +##### Example + +```yaml +runs-on: [AE-runner-for-CI] +``` + +For more information, see "[About {% data variables.actions.hosted_runner %}s](/actions/using-github-hosted-runners/about-ae-hosted-runners)." + +{% else %} {% data reusables.actions.enterprise-github-hosted-runners %} #### {% data variables.product.prodname_dotcom %}-hosted runners @@ -298,7 +314,6 @@ Available {% data variables.product.prodname_dotcom %}-hosted runner types are: {% data reusables.github-actions.supported-github-runners %} -{% data reusables.github-actions.ubuntu-runner-preview %} {% data reusables.github-actions.macos-runner-preview %} ##### Example @@ -308,9 +323,12 @@ runs-on: ubuntu-latest ``` For more information, see "[Virtual environments for {% data variables.product.prodname_dotcom %}-hosted runners](/github/automating-your-workflow-with-github-actions/virtual-environments-for-github-hosted-runners)." +{% endif %} #### Self-hosted runners +{% data reusables.actions.ae-self-hosted-runners-notice %} + {% data reusables.github-actions.self-hosted-runner-labels-runs-on %} ##### Example @@ -321,7 +339,7 @@ runs-on: [self-hosted, linux] For more information, see "[About self-hosted runners](/github/automating-your-workflow-with-github-actions/about-self-hosted-runners)" and "[Using self-hosted runners in a workflow](/github/automating-your-workflow-with-github-actions/using-self-hosted-runners-in-a-workflow)." -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %} ### `jobs..environment` The environment that the job references. All environment protection rules must pass before a job referencing the environment is sent to a runner. For more information, see "[Environments](/actions/reference/environments)." @@ -619,6 +637,27 @@ jobs: uses: docker://gcr.io/cloud-builders/gradle ``` +#### Example using action inside a different private repository than the workflow + +Your workflow must checkout the private repository and reference the action locally. + +{% raw %} +```yaml +jobs: + my_first_job: + steps: + - name: Check out repository + uses: actions/checkout@v2 + with: + repository: octocat/my-private-repo + ref: v1.0 + token: ${{ secrets.GITHUB_TOKEN }} + path: ./.github/actions/my-private-repo + - name: Run my action + uses: ./.github/actions/my-private-repo/my-action +``` +{% endraw %} + ### `jobs..steps[*].run` Runs command-line programs using the operating system's shell. If you do not provide a `name`, the step name will default to the text specified in the `run` command. @@ -726,7 +765,13 @@ steps: shell: perl {0} ``` -The command used, `perl` in this example, must be installed on the runner. For information about the software included on GitHub-hosted runners, see "[Specifications for GitHub-hosted runners](/actions/reference/specifications-for-github-hosted-runners#supported-software)." +The command used, `perl` in this example, must be installed on the runner. + + +{% if currentVersion == "github-ae@latest" %}For instructions on how to make sure your {% data variables.actions.hosted_runner %} has the required software installed, see "[Creating custom images](/actions/using-github-hosted-runners/creating-custom-images)." +{% else %} +For information about the software included on GitHub-hosted runners, see "[Specifications for GitHub-hosted runners](/actions/reference/specifications-for-github-hosted-runners#supported-software)." +{% endif %} #### Exit codes and error action preference @@ -897,7 +942,9 @@ steps: ``` {% endraw %} -To find supported configuration options for {% data variables.product.prodname_dotcom %}-hosted runners, see "[Virtual environments for {% data variables.product.prodname_dotcom %}-hosted runners](/actions/automating-your-workflow-with-github-actions/virtual-environments-for-github-hosted-runners)." +{% if currentVersion == "github-ae@latest" %}To find supported configuration options for {% data variables.actions.hosted_runner %}s, see "[Software specifications](/actions/using-github-hosted-runners/about-ae-hosted-runners#software-specifications)." +{% else %}To find supported configuration options for {% data variables.product.prodname_dotcom %}-hosted runners, see "[Virtual environments for {% data variables.product.prodname_dotcom %}-hosted runners](/actions/automating-your-workflow-with-github-actions/virtual-environments-for-github-hosted-runners)." +{% endif %} #### Example including additional values into combinations @@ -1039,7 +1086,7 @@ jobs: The Docker image to use as the container to run the action. The value can be the Docker Hub image name or a {% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.23" %}public{% endif %} registry name. -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} ### `jobs..container.credentials` @@ -1123,7 +1170,7 @@ services: The Docker image to use as the service container to run the action. The value can be the Docker Hub image name or a {% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.23" %}public{% endif %} registry name. -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} ### `jobs..services..credentials` diff --git a/content/actions/using-github-hosted-runners/about-ae-hosted-runners.md b/content/actions/using-github-hosted-runners/about-ae-hosted-runners.md new file mode 100644 index 0000000000..e64ad9dd84 --- /dev/null +++ b/content/actions/using-github-hosted-runners/about-ae-hosted-runners.md @@ -0,0 +1,107 @@ +--- +title: About AE hosted runners +intro: '{% data variables.product.prodname_ghe_managed %} offers customizable and security hardened hosted virtual machines to run {% data variables.product.prodname_actions %} workflows. You can select the hardware, bring your own machine image, and enable an IP address for networking with your {% data variables.actions.hosted_runner %}.' +product: '{% data reusables.gated-features.actions %}' +versions: + github-ae: '*' +--- + + + + +{% data reusables.actions.ae-beta %} + +### About {% data variables.actions.hosted_runner %}s + +An {% data variables.actions.hosted_runner %} is a virtual machine hosted by {% data variables.product.prodname_dotcom %} with the {% data variables.product.prodname_actions %} runner service installed. + +{% data variables.product.prodname_ghe_managed %} lets you create and customize {% data variables.actions.hosted_runner %}s using Ubuntu or Windows images; you can select the size of machine you want and configure security hardened networking for them. {% data variables.actions.hosted_runner %}s are fully managed and auto-scaled by {% data variables.product.prodname_dotcom %}. + +Each workflow job is executed in a fresh instance of the {% data variables.actions.hosted_runner %}, and you can run workflows directly on the virtual machine or in a Docker container. All steps in the job execute in the same instance, allowing the actions in that job to share information using the {% data variables.actions.hosted_runner %}'s filesystem. + +{% note %} +{% data variables.actions.hosted_runner %}s are the only runners available for {% data variables.product.prodname_ghe_managed %}, and self-hosted runners are not available. +{% endnote %} + +To add {% data variables.actions.hosted_runner %}s to your organization or enterprise, see ["Adding {% data variables.actions.hosted_runner %}s](/actions/using-github-hosted-runners/adding-ae-hosted-runners)." + +### Pool assignments for {% data variables.actions.hosted_runner %}s + +Your {% data variables.actions.hosted_runner %}s are allocated to the same pool as your {% data variables.product.prodname_ghe_managed %} instance. No other customers have access to this pool, and as a result, {% data variables.actions.hosted_runner %}s are not shared with any other customers. + +### Managing your {% data variables.actions.hosted_runner %}s + +During the {% data variables.actions.hosted_runner %} beta, you can manage your {% data variables.actions.hosted_runner %}s by contacting {% data variables.product.prodname_dotcom %} support. For example, {% data variables.product.prodname_dotcom %} support can assist you with adding a new {% data variables.actions.hosted_runner %}, assigning labels, or moving a {% data variables.actions.hosted_runner %} to a different group. + +### Billing + +{% data variables.product.prodname_actions %} is currently in beta for {% data variables.product.prodname_ghe_managed %}. During this beta period, {% data variables.actions.hosted_runner %}s are not billed, and can be used for free. + +Once the beta ends, billed usage will include the full uptime of active instances in your AE hosted runner sets. This includes: +- Job time - minutes spent running Actions job. +- Management - minutes spent re-imaging machines and any idle time created as a result of desired auto-scale behavior. + +Pricing will scale linearly with cores. For example, 4 cores will be twice the price of 2 cores. Windows VMs will be priced higher than Linux VMs. + +### Hardware specifications + +{% data variables.actions.hosted_runner %}s are available on a range of virtual machines hosted in Microsoft Azure. Depending on regional availability, you can choose from `Standard_Das_v4`, `Standard_DS_v2`, `Standard_Fs_v2 series`. Certain regions also include GPU runners based on `Standard_NCs_v3`. + +For more information about these Azure machine resources, see "[Sizes for virtual machines in Azure](https://docs.microsoft.com/en-gb/azure/virtual-machines/sizes)" in the Microsoft Azure documentation. + +To determine which runner executed a job, you can review the workflow logs. For more information, see "[Viewing workflow run history](/actions/managing-workflow-runs/viewing-workflow-run-history)." + +### Software specifications + +You can use {% data variables.actions.hosted_runner %}s with standard operating system images, or you can add images that you've created. + +#### Default operating system images + +These images only include the standard operating system tools: + +- Ubuntu 18.04 LTS (Canonical) +- Ubuntu 16.04 LTS (Canonical) +- Windows Server 2019 (Microsoft) +- Windows Server 2016 (Microsoft) + +#### Custom operating system images + +You can create your own OS images in Azure and have them added to {% data variables.product.prodname_ghe_managed %} as {% data variables.actions.hosted_runner %}s. For more information, see "[Adding an {% data variables.actions.hosted_runner %} with a custom image"](/actions/using-github-hosted-runners/adding-ae-hosted-runners#adding-an-ae-hosted-runner-with-a-custom-image). + +### Network specifications + +You can optionally enable a fixed static public IP address for your {% data variables.actions.hosted_runner %}s. If enabled, all {% data variables.actions.hosted_runner %}s in your instance will share a range of 2 to 4 IP addresses, and will communicate using ports on those addresses. + +If you don't enable static public IP addresses, then your {% data variables.actions.hosted_runner %}s will subsequently have the same IP address ranges as the Azure datacenters. Inbound ICMP packets are blocked, so `ping` or `traceroute` commands are not expected to work. + +To get a list of IP address ranges that {% data variables.product.prodname_actions %} uses for {% data variables.actions.hosted_runner %}s, you can use the {% data variables.product.prodname_dotcom %} REST API . For more information, see the `actions` key in the response of the "[Get GitHub meta information](/rest/reference/meta#get-github-meta-information)" endpoint. You can use this list of IP addresses if you require an allow-list to prevent unauthorized access to your internal resources. + +The list of {% data variables.product.prodname_actions %} IP addresses returned by the API is updated once a week. + +### Administrative privileges for {% data variables.actions.hosted_runner %}s + +The Linux virtual machines run using passwordless `sudo`. When you need to execute commands or install tools that require more privileges than the current user, you can use `sudo` without needing to provide a password. For more information, see the "[Sudo Manual](https://www.sudo.ws/man/1.8.27/sudo.man.html)." + +Windows virtual machines are configured to run as administrators with User Account Control (UAC) disabled. For more information, see "[How User Account Control works](https://docs.microsoft.com/windows/security/identity-protection/user-account-control/how-user-account-control-works)" in the Windows documentation. + +### File systems + +{% data variables.product.prodname_dotcom %} executes actions and shell commands in specific directories on the virtual machine. The file paths on virtual machines are not static. Use the environment variables {% data variables.product.prodname_dotcom %} provides to construct file paths for the `home`, `workspace`, and `workflow` directories. + +| Directory | Environment variable | Description | +|-----------|----------------------|-------------| +| `home` | `HOME` | Contains user-related data. For example, this directory could contain credentials from a login attempt. | +| `workspace` | `GITHUB_WORKSPACE` | Actions and shell commands execute in this directory. An action can modify the contents of this directory, which subsequent actions can access. | +| `workflow/event.json` | `GITHUB_EVENT_PATH` | The `POST` payload of the webhook event that triggered the workflow. {% data variables.product.prodname_dotcom %} rewrites this each time an action executes to isolate file content between actions. + +For a list of the environment variables {% data variables.product.prodname_dotcom %} creates for each workflow, see "[Using environment variables](/github/automating-your-workflow-with-github-actions/using-environment-variables)." + +#### Docker container filesystem + +Actions that run in Docker containers have static directories under the `/github` path. However, we strongly recommend using the default environment variables to construct file paths in Docker containers. + +{% data variables.product.prodname_dotcom %} reserves the `/github` path prefix and creates three directories for actions. + +- `/github/home` +- `/github/workspace` - {% data reusables.repositories.action-root-user-required %} +- `/github/workflow` diff --git a/content/actions/reference/specifications-for-github-hosted-runners.md b/content/actions/using-github-hosted-runners/about-github-hosted-runners.md similarity index 92% rename from content/actions/reference/specifications-for-github-hosted-runners.md rename to content/actions/using-github-hosted-runners/about-github-hosted-runners.md index 77dcfae8a3..e31cad845d 100644 --- a/content/actions/reference/specifications-for-github-hosted-runners.md +++ b/content/actions/using-github-hosted-runners/about-github-hosted-runners.md @@ -1,5 +1,5 @@ --- -title: Specifications for GitHub-hosted runners +title: About GitHub-hosted runners intro: '{% data variables.product.prodname_dotcom %} offers hosted virtual machines to run workflows. The virtual machine contains an environment of tools, packages, and settings available for {% data variables.product.prodname_actions %} to use.' product: '{% data reusables.gated-features.actions %}' redirect_from: @@ -9,6 +9,7 @@ redirect_from: - /actions/automating-your-workflow-with-github-actions/virtual-environments-for-github-hosted-runners - /actions/reference/virtual-environments-for-github-hosted-runners - /actions/reference/software-installed-on-github-hosted-runners + - /actions/reference/specifications-for-github-hosted-runners versions: free-pro-team: '*' enterprise-server: '>=2.22' @@ -33,6 +34,12 @@ You can specify the runner type for each job in a workflow. Each job in a workfl {% data variables.product.prodname_dotcom %} hosts macOS runners in {% data variables.product.prodname_dotcom %}'s own macOS Cloud. +#### Workflow continuity for {% data variables.product.prodname_dotcom %}-hosted runners + +{% data reusables.github-actions.runner-workflow-continuity %} + +In addition, if the workflow run has been successfully queued, but has not been processed by a {% data variables.product.prodname_dotcom %}-hosted runner within 45 minutes, then the queued workflow run is discarded. + #### Administrative privileges of {% data variables.product.prodname_dotcom %}-hosted runners The Linux and macOS virtual machines both run using passwordless `sudo`. When you need to execute commands or install tools that require more privileges than the current user, you can use `sudo` without needing to provide a password. For more information, see the "[Sudo Manual](https://www.sudo.ws/man/1.8.27/sudo.man.html)." @@ -41,7 +48,6 @@ Windows virtual machines are configured to run as administrators with User Accou ### Supported runners and hardware resources - Hardware specification for Windows and Linux virtual machines: - 2-core CPU - 7 GB of RAM memory @@ -54,31 +60,32 @@ Hardware specification for macOS virtual machines: {% data reusables.github-actions.supported-github-runners %} -{% data reusables.github-actions.ubuntu-runner-preview %} {% data reusables.github-actions.macos-runner-preview %} Workflow logs list the runner used to run a job. For more information, see "[Viewing workflow run history](/actions/managing-workflow-runs/viewing-workflow-run-history)." ### Supported software -The software tools included in {% data variables.product.prodname_dotcom %}-hosted runners are updated weekly. For the latest list of included tools for each runner operating system, see the links below: +The software tools included in {% data variables.product.prodname_dotcom %}-hosted runners are updated weekly. The update process takes several days, and the list of preinstalled software on the `main` branch is updated after the whole deployment ends. +#### Preinstalled software + +Workflow logs include a link to the preinstalled tools on the exact runner. To find this information in the workflow log, expand the `Set up job` section. Under that section, expand the `Virtual Environment` section. The link following `Included Software` will tell you the the preinstalled tools on the runner that ran the workflow. +![Installed software link](/assets/images/actions-runner-installed-software-link.png) +For more information, see "[Viewing workflow run history](/actions/managing-workflow-runs/viewing-workflow-run-history)." + +For the overall list of included tools for each runner operating system, see the links below: * [Ubuntu 20.04 LTS](https://github.com/actions/virtual-environments/blob/main/images/linux/Ubuntu2004-README.md) * [Ubuntu 18.04 LTS](https://github.com/actions/virtual-environments/blob/main/images/linux/Ubuntu1804-README.md) * [Ubuntu 16.04 LTS](https://github.com/actions/virtual-environments/blob/main/images/linux/Ubuntu1604-README.md) * [Windows Server 2019](https://github.com/actions/virtual-environments/blob/main/images/win/Windows2019-Readme.md) * [Windows Server 2016](https://github.com/actions/virtual-environments/blob/main/images/win/Windows2016-Readme.md) -* [macOS 10.15](https://github.com/actions/virtual-environments/blob/main/images/macos/macos-10.15-Readme.md) * [macOS 11.0](https://github.com/actions/virtual-environments/blob/main/images/macos/macos-11.0-Readme.md) - -{% data reusables.github-actions.ubuntu-runner-preview %} -{% data reusables.github-actions.macos-runner-preview %} +* [macOS 10.15](https://github.com/actions/virtual-environments/blob/main/images/macos/macos-10.15-Readme.md) {% data variables.product.prodname_dotcom %}-hosted runners include the operating system's default built-in tools, in addition to the packages listed in the above references. For example, Ubuntu and macOS runners include `grep`, `find`, and `which`, among other default tools. -Workflow logs include a link to the preinstalled tools on the exact runner. To find this information in the workflow log, expand the `Set up job` section. Under that section, expand the `Virtual Environment` section. The link following `Included Software` will tell you the the preinstalled tools on the runner that ran the workflow. -![Installed software link](/assets/images/actions-runner-installed-software-link.png) -For more information, see "[Viewing workflow run history](/actions/managing-workflow-runs/viewing-workflow-run-history)." +#### Using preinstalled software We recommend using actions to interact with the software installed on runners. This approach has several benefits: - Usually, actions provide more flexible functionality like versions selection, ability to pass arguments, and parameters diff --git a/content/actions/using-github-hosted-runners/adding-ae-hosted-runners.md b/content/actions/using-github-hosted-runners/adding-ae-hosted-runners.md new file mode 100644 index 0000000000..bd36ee97cc --- /dev/null +++ b/content/actions/using-github-hosted-runners/adding-ae-hosted-runners.md @@ -0,0 +1,45 @@ +--- +title: Adding AE hosted runners +intro: 'You can add an {% data variables.actions.hosted_runner %} to an organization or an enterprise.' +versions: + github-ae: '*' +--- + +{% data reusables.actions.ae-beta %} + +{% note %} + +**Note:** To add {% data variables.actions.hosted_runner %}s to {% data variables.product.prodname_ghe_managed %}, you will need to contact {% data variables.product.prodname_dotcom %} support. This article describes the information that support will need in order to complete this process. + +{% endnote %} + +{% data variables.actions.hosted_runner %}s can use the base Azure operating system images, or you can create your own custom images. + +### Adding an {% data variables.actions.hosted_runner %} from the base Azure image + +You can add {% data variables.actions.hosted_runner %}s that use the base Azure operating system images. +To add {% data variables.actions.hosted_runner %}s to your organization or enterprise, contact {% data variables.product.prodname_dotcom %} support and have the following information ready: + - Required operating system: Available options are listed at ["Software specifications](/actions/using-github-hosted-runners/about-ae-hosted-runners#software-specifications)." + - Choose a name for each pool of {% data variables.actions.hosted_runner %}s. These names are created as labels, allowing you to route your workflows to these runners. For more information, see ["Using {% data variables.actions.hosted_runner %}s in a workflow](/actions/using-github-hosted-runners/using-ae-hosted-runners-in-a-workflow)." + - Where to add the {% data variables.actions.hosted_runner %}: Identify the names of the organizations and enterprises that will receive the runners. + +### Adding an {% data variables.actions.hosted_runner %} with a custom image + +To create a custom operating system image, see the steps at ["Creating custom images"](/actions/using-github-hosted-runners/creating-custom-images). + +Once you've created a custom image using the above steps, contact {% data variables.product.prodname_dotcom %} support and provide the following details: + + - The SAS URI you generated when following the custom image creation steps. + - Type of operating system used by the image: This can be Linux or Windows. + - Image name. + - Version. + - VM SKU for the new pool. + - Choose a name for each pool of {% data variables.actions.hosted_runner %}s. These names are created as labels, allowing you to route your workflows to these runners. For more information, see ["Using {% data variables.actions.hosted_runner %}s in a workflow](/actions/using-github-hosted-runners/using-ae-hosted-runners-in-a-workflow)." + - Where to add the {% data variables.actions.hosted_runner %}: Identify the names of the organizations and enterprises that will receive the runners. + +### Reviewing your {% data variables.actions.hosted_runner %}s + +Once your runners have been added by {% data variables.product.prodname_dotcom %} support, you'll be able to find them in your list of runners: + +{% data reusables.github-actions.hosted-runner-navigate-to-repo-org-enterprise %} +{% data reusables.github-actions.hosted-runner-list %} diff --git a/content/actions/using-github-hosted-runners/creating-custom-images.md b/content/actions/using-github-hosted-runners/creating-custom-images.md new file mode 100644 index 0000000000..b1ea396386 --- /dev/null +++ b/content/actions/using-github-hosted-runners/creating-custom-images.md @@ -0,0 +1,52 @@ +--- +title: Creating custom images +intro: 'You can create custom images for {% data variables.actions.hosted_runner %}s.' +versions: + github-ae: '*' +--- + +{% data reusables.actions.ae-beta %} + +### Creating an {% data variables.actions.hosted_runner %} with a custom image + +{% data variables.actions.hosted_runner %}s can use operating system images that you've customized to suit your needs. This article includes the high level steps for creating the image in Azure and preparing it for {% data variables.product.prodname_ghe_managed %}. For more information, refer to [the Azure documentation](https://docs.microsoft.com/en-us/azure/virtual-machines/). + +During this beta, to be able to create a custom image for {% data variables.actions.hosted_runner %}s, you will need an Azure subscription that is able to provision a virtual machine. + + +1. Provision a new VM in your tenant using a marketplace image or a virtual hard drive(VHD). +2. Optionally, install your required software on the VM. +3. Deprovision the VM: + - For Linux: `ssh` to the VM and run: + ```sh + $ sudo waagent -deprovision+user + ``` + - For Windows: Follow the steps described at ["Generalize the source VM by using Sysprep](https://docs.microsoft.com/en-us/azure/virtual-machines/windows/upload-generalized-managed#generalize-the-source-vm-by-using-sysprep)." + +4. Use the Azure CLI to deallocate and generalize the VM: + ```powershell + $resourceGroupName = "octocat-testgroup" + $vmName = "octo-vm" + + Stop-AzVM -ResourceGroupName $resourceGroupName -Name $vmName + Set-AzVM -ResourceGroupName $resourceGroupName -Name $vmName -Generalized + ``` + - Replace `octo-vm` with the name of your virtual machine. + - For more information regarding these steps, see "[How to create a managed image of a virtual machine or VHD](https://docs.microsoft.com/en-us/azure/virtual-machines/linux/capture-image#step-1-deprovision-the-vm)." +5. Generate a SAS URI for the VM's operating system disk. + - Using the Azure Portal: On the disk resource, navigate to **Disk Export**, set `URL expires in (seconds)` to `86400` (24 hours), and generate the URL. + - Using the Azure CLI: + ```powershell + $resourceGroupName = "octocat-testgroup" + $vmName = "octo-vm" + + $vm = Get-AzVM -ResourceGroupName $resourceGroupName -Name $vmName + Grant-AzDiskAccess ` + -ResourceGroupName $resourceGroupName ` + -DiskName $vm.StorageProfile.OsDisk.Name ` + -Access Read ` + -DurationInSecond 86400 + ``` + - Replace `octo-vm` with the name of your virtual machine. + +Once you've created the image, you can have it added to {% data variables.product.prodname_ghe_managed %}. For more information, see ["Adding an {% data variables.actions.hosted_runner %} with a custom image"](/actions/using-github-hosted-runners/adding-ae-hosted-runners#adding-an-ae-hosted-runner-with-a-custom-image). diff --git a/content/actions/using-github-hosted-runners/index.md b/content/actions/using-github-hosted-runners/index.md new file mode 100644 index 0000000000..681269a253 --- /dev/null +++ b/content/actions/using-github-hosted-runners/index.md @@ -0,0 +1,19 @@ +--- +title: Using GitHub-hosted runners +intro: You can use GitHub's runners to execute your GitHub Actions workflows. +versions: + free-pro-team: '*' + enterprise-server: '>=2.22' + github-ae: '*' +--- + +{% data reusables.actions.enterprise-beta %} +{% data reusables.actions.enterprise-github-hosted-runners %} + +{% link_in_list /about-github-hosted-runners %} +{% link_in_list /about-ae-hosted-runners %} +{% link_in_list /adding-ae-hosted-runners %} +{% link_in_list /using-ae-hosted-runners-in-a-workflow %} +{% link_in_list /using-labels-with-ae-hosted-runners %} +{% link_in_list /using-groups-to-manage-access-to-ae-hosted-runners %} +{% link_in_list /creating-custom-images %} diff --git a/content/actions/using-github-hosted-runners/using-ae-hosted-runners-in-a-workflow.md b/content/actions/using-github-hosted-runners/using-ae-hosted-runners-in-a-workflow.md new file mode 100644 index 0000000000..8dbbb95ebe --- /dev/null +++ b/content/actions/using-github-hosted-runners/using-ae-hosted-runners-in-a-workflow.md @@ -0,0 +1,38 @@ +--- +title: Using AE hosted runners in a workflow +intro: 'You can use labels to send jobs to a pool of {% data variables.actions.hosted_runner %}s.' +versions: + github-ae: '*' +--- + +{% data reusables.actions.ae-beta %} + +### Using {% data variables.actions.hosted_runner %}s in a workflow + +Labels allow you to send workflow jobs to any {% data variables.actions.hosted_runner %} that includes that label. You can use the default labels, and you can create your own custom labels. + +### Using default labels to route jobs + +An {% data variables.actions.hosted_runner %} receives a label when it is added to {% data variables.product.prodname_actions %}. The label is used to indicate where it was assigned. + +You can use your workflow's YAML to send jobs to a specific {% data variables.actions.hosted_runner %} pool. This example demonstrates how to configure a workflow to run on a label called `AE-runner-for-CI`: + +```yaml +runs-on: [AE-runner-for-CI] +``` + +For more information, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/github/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idruns-on)." + +### Using custom labels to route jobs + +You can create custom labels and assign them to your {% data variables.actions.hosted_runner %}s at any time. Custom labels let you send jobs to particular types of runners, based on how they're labeled. + +For example, if you have a job that requires a specific software package, you can create a custom label called `octocat` and assign it to the runners that have the package installed. An {% data variables.actions.hosted_runner %} that matches all the assigned labels will then be eligible to run the job. + +This example shows a job that uses multiple labels: + +```yaml +runs-on: [AE-runner-for-CI, octocat, linux] +``` + +These labels operate cumulatively, so an {% data variables.actions.hosted_runner %}'s labels must match all of them for it to be eligible to process the job. diff --git a/content/actions/using-github-hosted-runners/using-groups-to-manage-access-to-ae-hosted-runners.md b/content/actions/using-github-hosted-runners/using-groups-to-manage-access-to-ae-hosted-runners.md new file mode 100644 index 0000000000..0ba75bac96 --- /dev/null +++ b/content/actions/using-github-hosted-runners/using-groups-to-manage-access-to-ae-hosted-runners.md @@ -0,0 +1,91 @@ +--- +title: Using groups to manage access to AE hosted runners +intro: You can use policies to limit access to {% data variables.actions.hosted_runner %}s that have been added to an organization or enterprise. +versions: + github-ae: '*' +--- + +{% data reusables.actions.ae-beta %} + +### About {% data variables.actions.hosted_runner %} groups + +{% data variables.actions.hosted_runner %} groups are used to control access to {% data variables.actions.hosted_runner %}s at the organization and enterprise level. Enterprise admins can configure access policies that control which organizations in an enterprise have access to the runner group. Organization admins can configure access policies that control which repositories in an organization have access to the runner group. + +When an enterprise admin grants an organization access to a runner group, organization admins can see the runner group listed in the organization's {% data variables.actions.hosted_runner %} settings. The organizations admins can then assign additional granular repository access policies to the enterprise runner group. + +When new runners are created, they are automatically assigned to the default group. Runners can only be in one group at a time. You can move runners from the default group to another group. For more information, see "[Moving an {% data variables.actions.hosted_runner %} to a group](#moving-an-ae-hosted-runner-to-a-group)." + +### Creating an {% data variables.actions.hosted_runner %} group for an organization + +All organizations have a single default {% data variables.actions.hosted_runner %} group. Organizations within an enterprise account can create additional runner groups. Organization admins can allow individual repositories access to a runner group. + +{% data variables.actions.hosted_runner %}s are automatically assigned to the default group when created, and can only be members of one group at a time. You can move a runner from the default group to any group you create. + +When creating a group, you must choose a policy that defines which repositories have access to the runner group. + +{% data reusables.organizations.navigate-to-org %} +{% data reusables.organizations.org_settings %} +{% data reusables.organizations.settings-sidebar-actions %} +1. In the **Self-hosted runners** section, click **Add new**, and then **New group**. + + ![Add runner group](/assets/images/help/settings/actions-hosted-runner-add-new-group.png) + +1. Enter a name for your runner group, and assign a policy for repository access. + + You can configure a runner group to be accessible to a specific list of repositories, or to all repositories in the organization. By default, only private repositories can access runners in a runner group, but you can override this. + ![Add runner group options](/assets/images/help/settings/actions-org-add-runner-group-options.png) + +1. Click **Save group** to create the group and apply the policy. + +### Creating an {% data variables.actions.hosted_runner %} group for an enterprise + +Enterprises can add their {% data variables.actions.hosted_runner %}s to groups for access management. Enterprises can create groups of {% data variables.actions.hosted_runner %}s that are accessible to specific organizations in the enterprise account. Organization admins can then assign additional granular repository access policies to the enterprise runner groups. + +{% data variables.actions.hosted_runner %}s are automatically assigned to the default group when created, and can only be members of one group at a time. You can assign the runner to a specific group during the registration process, or you can later move the runner from the default group to a custom group. + +When creating a group, you must choose a policy that defines which organizations have access to the runner group. + +{% data reusables.enterprise-accounts.access-enterprise %} +{% data reusables.enterprise-accounts.policies-tab %} +{% data reusables.enterprise-accounts.actions-tab %} +1. Click the **Self-hosted runners** tab. +1. Click **Add new**, and then **New group**. + + ![Add runner group](/assets/images/help/settings/actions-hosted-runner-add-new-group.png) + +1. Enter a name for your runner group, and assign a policy for organization access. + + You can configure a runner group to be accessible to a specific list of organizations, or all organizations in the enterprise. By default, only private repositories can access runners in a runner group, but you can override this. + ![Add runner group options](/assets/images/help/settings/actions-enterprise-account-add-runner-group-options.png) + +1. Click **Save group** to create the group and apply the policy. + +### Changing the access policy of an {% data variables.actions.hosted_runner %} group + +You can update the access policy of a runner group, or rename a runner group. + +{% data reusables.github-actions.hosted-runner-configure-runner-group-access %} + +### Moving an {% data variables.actions.hosted_runner %} to a group + +New {% data variables.actions.hosted_runner %}s are automatically assigned to the default group, and can then be moved to another group. + +1. In the **Self-hosted runners** section of the settings page, locate the current group of the runner you want to move and expand the list of group members. +![View runner group members](/assets/images/help/settings/actions-hosted-runner-group-members.png) +1. Select the checkbox next to the runner, and then click **Move to group** to see the available destinations. +![Runner group member move](/assets/images/help/settings/actions-hosted-runner-group-member-move.png) +1. To move the runner, click on the destination group. +![Runner group member move](/assets/images/help/settings/actions-hosted-runner-group-member-move-destination.png) + +### Removing an {% data variables.actions.hosted_runner %} group + +{% data variables.actions.hosted_runner %}s are automatically returned to the default group when their group is removed. + +1. In the **Self-hosted runners** section of the settings page, locate the group you want to delete, and click the {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %} button. + ![View runner group settings](/assets/images/help/settings/actions-hosted-runner-group-kebab.png) + +1. To remove the group, click **Remove group**. + + ![View runner group settings](/assets/images/help/settings/actions-hosted-runner-group-remove.png) + +1. Review the confirmation prompts, and click **Remove this runner group**. diff --git a/content/actions/using-github-hosted-runners/using-labels-with-ae-hosted-runners.md b/content/actions/using-github-hosted-runners/using-labels-with-ae-hosted-runners.md new file mode 100644 index 0000000000..9fdd1f63c4 --- /dev/null +++ b/content/actions/using-github-hosted-runners/using-labels-with-ae-hosted-runners.md @@ -0,0 +1,25 @@ +--- +title: Using labels with AE hosted runners +intro: You can use labels to organize your {% data variables.actions.hosted_runner %}s based on their characteristics. +versions: + github-ae: '*' +--- + +{% data reusables.actions.ae-beta %} + +For information on how to use labels to route jobs to specific types of {% data variables.actions.hosted_runner %}s, see "[Using {% data variables.actions.hosted_runner %}s in a workflow](/actions/using-github-hosted-runners/using-ae-hosted-runners-in-a-workflow)." + + +{% note %} + +**Note:** To manage labels for your {% data variables.actions.hosted_runner %}s, you will need to contact {% data variables.product.prodname_dotcom %} support. + +{% endnote %} + +### Viewing the labels for your {% data variables.actions.hosted_runner %}s +{% data reusables.github-actions.hosted-runner-navigate-to-repo-org-enterprise %} +{% data reusables.github-actions.hosted-runner-list %} +{% data reusables.github-actions.hosted-runner-list-group %} +1. Locate the runner you want to check, and click {% octicon "triangle-down" aria-label="The downward triangle" %} to view the label selection menu. Labels already assigned to your runner have a {% octicon "check" aria-label="Check mark" %} next to them. + +![Change runner label](/assets/images/help/settings/actions-hosted-runner-list-label.png) diff --git a/content/admin/authentication/about-identity-and-access-management-for-your-enterprise.md b/content/admin/authentication/about-identity-and-access-management-for-your-enterprise.md index 018ebf2daf..b6075d5322 100644 --- a/content/admin/authentication/about-identity-and-access-management-for-your-enterprise.md +++ b/content/admin/authentication/about-identity-and-access-management-for-your-enterprise.md @@ -13,7 +13,7 @@ versions: {% data reusables.saml.ae-uses-saml-sso %} {% data reusables.saml.ae-enable-saml-sso-during-bootstrapping %} -After you configure the application for {% data variables.product.product_name %} on your IdP, you can grant access to {% data variables.product.product_location %} by assigning the application to users on your IdP. For more information about SAML SSO for {% data variables.product.product_name %}, see "[Configuring SAML single sign-on for your enterprise](/admin/authentication/configuring-saml-single-sign-on-for-your-enterprise)." +After you configure the application for {% data variables.product.product_name %} on your IdP, you can grant access to {% data variables.product.product_location %} by assigning the application to users and groups on your IdP. For more information about SAML SSO for {% data variables.product.product_name %}, see "[Configuring SAML single sign-on for your enterprise](/admin/authentication/configuring-saml-single-sign-on-for-your-enterprise)." {% data reusables.scim.after-you-configure-saml %} For more information, see "[Configuring user provisioning for your enterprise](/admin/authentication/configuring-user-provisioning-for-your-enterprise)." @@ -25,3 +25,4 @@ To learn how to configure both authentication and user provisioning for {% data - [SAML Wiki](https://wiki.oasis-open.org/security) on the OASIS website - [System for Cross-domain Identity Management: Protocol (RFC 7644)](https://tools.ietf.org/html/rfc7644) on the IETF website +- [Restricting network traffic to your enterprise](/admin/configuration/restricting-network-traffic-to-your-enterprise) diff --git a/content/admin/authentication/allowing-built-in-authentication-for-users-outside-your-identity-provider.md b/content/admin/authentication/allowing-built-in-authentication-for-users-outside-your-identity-provider.md index c1ccb9a417..097850a133 100644 --- a/content/admin/authentication/allowing-built-in-authentication-for-users-outside-your-identity-provider.md +++ b/content/admin/authentication/allowing-built-in-authentication-for-users-outside-your-identity-provider.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/authentication/allowing-built-in-authentication-for-users-outside-your-identity-provider versions: enterprise-server: '*' +topics: + - enterprise --- ### About built-in authentication for users outside your identity provider diff --git a/content/admin/authentication/authenticating-users-for-your-github-enterprise-server-instance.md b/content/admin/authentication/authenticating-users-for-your-github-enterprise-server-instance.md index e21b5d8ae4..cc0d48b47c 100644 --- a/content/admin/authentication/authenticating-users-for-your-github-enterprise-server-instance.md +++ b/content/admin/authentication/authenticating-users-for-your-github-enterprise-server-instance.md @@ -11,5 +11,7 @@ redirect_from: mapTopic: true versions: enterprise-server: '*' +topics: + - enterprise --- diff --git a/content/admin/authentication/changing-authentication-methods.md b/content/admin/authentication/changing-authentication-methods.md index b3f8f58c05..b9a864ebe2 100644 --- a/content/admin/authentication/changing-authentication-methods.md +++ b/content/admin/authentication/changing-authentication-methods.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/authentication/changing-authentication-methods versions: enterprise-server: '*' +topics: + - enterprise --- User accounts on {% data variables.product.product_location %} are preserved when you change the authentication method and users will continue to log into the same account as long as their username doesn't change. diff --git a/content/admin/authentication/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad.md b/content/admin/authentication/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad.md index 7af09e12dc..a4c0796611 100644 --- a/content/admin/authentication/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad.md +++ b/content/admin/authentication/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad.md @@ -12,9 +12,16 @@ versions: Azure Active Directory (Azure AD) is a service from Microsoft that allows you to centrally manage user accounts and access to web applications. For more information, see [What is Azure Active Directory?](https://docs.microsoft.com/azure/active-directory/fundamentals/active-directory-whatis) in the Microsoft Docs. -To manage identity and access for {% data variables.product.product_name %}, you can use an Azure AD tenant as a SAML IdP for authentication. You can also configure Azure AD to automatically provision accounts and access with SCIM. This configuration allows you to assign or unassign the {% data variables.product.prodname_ghe_managed %} application for a user account in your Azure AD tenant to automatically create, grant access to, or deactivate a corresponding user account on {% data variables.product.product_name %}. +To manage identity and access for {% data variables.product.product_name %}, you can use an Azure AD tenant as a SAML IdP for authentication. You can also configure Azure AD to automatically provision accounts and access membership with SCIM, which allows you to create {% data variables.product.prodname_ghe_managed %} users and manage team and organization membership from your Azure AD tenant. -For more information about managing identity and access for your enterprise on {% data variables.product.product_location %}, see "[Managing identity and access for your enterprise](/admin/authentication/managing-identity-and-access-for-your-enterprise)." +After you enable SAML SSO and SCIM for {% data variables.product.prodname_ghe_managed %} using Azure AD, you can accomplish the following from your Azure AD tenant. + +* Assign the {% data variables.product.prodname_ghe_managed %} application on Azure AD to a user account to automatically create and grant access to a corresponding user account on {% data variables.product.product_name %}. +* Unassign the {% data variables.product.prodname_ghe_managed %} application to a user account on Azure AD to deactivate the corresponding user account on {% data variables.product.product_name %}. +* Assign the {% data variables.product.prodname_ghe_managed %} application to an IdP group on Azure AD to automatically create and grant access to user accounts on {% data variables.product.product_name %} for all members of the IdP group. In addition, the IdP group is available on {% data variables.product.prodname_ghe_managed %} for connection to a team and its parent organization. +* Unassign the {% data variables.product.prodname_ghe_managed %} application from an IdP group to deactivate the {% data variables.product.product_name %} user accounts of all IdP users who had access only through that IdP group and remove the users from the parent organization. The IdP group will be disconnected from any teams on {% data variables.product.product_name %}. + +For more information about managing identity and access for your enterprise on {% data variables.product.product_location %}, see "[Managing identity and access for your enterprise](/admin/authentication/managing-identity-and-access-for-your-enterprise)." For more information about synchronizing teams with IdP groups, see "[Synchronizing a team with an identity provider group](/github/setting-up-and-managing-organizations-and-teams/synchronizing-a-team-with-an-identity-provider-group)." ### Prerequisites diff --git a/content/admin/authentication/configuring-user-provisioning-for-your-enterprise.md b/content/admin/authentication/configuring-user-provisioning-for-your-enterprise.md index 5801f401dd..a0bd008285 100644 --- a/content/admin/authentication/configuring-user-provisioning-for-your-enterprise.md +++ b/content/admin/authentication/configuring-user-provisioning-for-your-enterprise.md @@ -28,6 +28,8 @@ The provisioning application on your IdP communicates with {% data variables.pro {% data reusables.scim.supported-idps %} +When you set up user provisioning with a supported IdP, you can also assign or unassign the application for {% data variables.product.product_name %} to groups of users. These groups are then available to organization owners and team maintainers in {% data variables.product.product_location %} to map to {% data variables.product.product_name %} teams. For more information, see "[Synchronizing a team with an identity provider group](/github/setting-up-and-managing-organizations-and-teams/synchronizing-a-team-with-an-identity-provider-group)." + ### Prerequisites {% if currentVersion == "github-ae@latest" %} diff --git a/content/admin/authentication/disabling-unauthenticated-sign-ups.md b/content/admin/authentication/disabling-unauthenticated-sign-ups.md index 5987411ce0..cd9861decc 100644 --- a/content/admin/authentication/disabling-unauthenticated-sign-ups.md +++ b/content/admin/authentication/disabling-unauthenticated-sign-ups.md @@ -7,6 +7,8 @@ redirect_from: intro: 'If you''re using built-in authentication, you can block unauthenticated people from being able to create an account.' versions: enterprise-server: '*' +topics: + - enterprise --- {% data reusables.enterprise_site_admin_settings.access-settings %} diff --git a/content/admin/authentication/index.md b/content/admin/authentication/index.md index deacdaf76f..b55ee5094f 100644 --- a/content/admin/authentication/index.md +++ b/content/admin/authentication/index.md @@ -1,11 +1,13 @@ --- title: Authentication -intro: You can configure how users sign into {% data variables.product.product_name %}. +intro: 'You can configure how users sign into {% data variables.product.product_name %}.' redirect_from: - /enterprise/admin/authentication versions: enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- diff --git a/content/admin/authentication/using-built-in-authentication.md b/content/admin/authentication/using-built-in-authentication.md index 4df510e488..0e05f30cd0 100644 --- a/content/admin/authentication/using-built-in-authentication.md +++ b/content/admin/authentication/using-built-in-authentication.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/authentication/using-built-in-authentication versions: enterprise-server: '*' +topics: + - enterprise --- You can create custom messages that users will see on the sign in and sign out pages. For more information, see "[Customizing user messages on your instance](/enterprise/admin/user-management/customizing-user-messages-on-your-instance)." diff --git a/content/admin/authentication/using-cas.md b/content/admin/authentication/using-cas.md index fa765d66b8..d5c2985090 100644 --- a/content/admin/authentication/using-cas.md +++ b/content/admin/authentication/using-cas.md @@ -8,6 +8,8 @@ redirect_from: intro: 'CAS is a single sign-on (SSO) protocol for multiple web applications. A CAS user account does not take up a {% if currentVersion ver_gt "enterprise-server@2.16" %}user license{% else %}seat{% endif %} until the user signs in.' versions: enterprise-server: '*' +topics: + - enterprise --- {% data reusables.enterprise_user_management.built-in-authentication %} diff --git a/content/admin/authentication/using-ldap.md b/content/admin/authentication/using-ldap.md index 959c6df2fb..53858a708b 100644 --- a/content/admin/authentication/using-ldap.md +++ b/content/admin/authentication/using-ldap.md @@ -11,6 +11,8 @@ redirect_from: intro: 'LDAP lets you authenticate {% data variables.product.prodname_ghe_server %} against your existing accounts and centrally manage repository access. LDAP is a popular application protocol for accessing and maintaining directory information services, and is one of the most common protocols used to integrate third-party software with large company user directories.' versions: enterprise-server: '*' +topics: + - enterprise --- {% data reusables.enterprise_user_management.built-in-authentication %} diff --git a/content/admin/authentication/using-saml.md b/content/admin/authentication/using-saml.md index e4cdd3808e..2da3fd18cc 100644 --- a/content/admin/authentication/using-saml.md +++ b/content/admin/authentication/using-saml.md @@ -8,6 +8,8 @@ redirect_from: intro: 'SAML is an XML-based standard for authentication and authorization. {% data variables.product.prodname_ghe_server %} can act as a service provider (SP) with your internal SAML identity provider (IdP).' versions: enterprise-server: '*' +topics: + - enterprise --- {% data reusables.enterprise_user_management.built-in-authentication %} diff --git a/content/admin/configuration/about-enterprise-configuration.md b/content/admin/configuration/about-enterprise-configuration.md index 8f90db0622..1436036526 100644 --- a/content/admin/configuration/about-enterprise-configuration.md +++ b/content/admin/configuration/about-enterprise-configuration.md @@ -4,6 +4,8 @@ intro: 'You can use the site admin dashboard{% if enterpriseServerVersions conta versions: enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- {% if enterpriseServerVersions contains currentVersion %} diff --git a/content/admin/configuration/accessing-the-administrative-shell-ssh.md b/content/admin/configuration/accessing-the-administrative-shell-ssh.md index 73cf3530c7..939c25bd37 100644 --- a/content/admin/configuration/accessing-the-administrative-shell-ssh.md +++ b/content/admin/configuration/accessing-the-administrative-shell-ssh.md @@ -13,6 +13,8 @@ redirect_from: intro: '{% data reusables.enterprise_site_admin_settings.about-ssh-access %}' versions: enterprise-server: '*' +topics: + - enterprise --- ### About administrative shell access diff --git a/content/admin/configuration/accessing-the-management-console.md b/content/admin/configuration/accessing-the-management-console.md index b107ad6dbc..62921a128c 100644 --- a/content/admin/configuration/accessing-the-management-console.md +++ b/content/admin/configuration/accessing-the-management-console.md @@ -12,6 +12,8 @@ redirect_from: - /enterprise/admin/configuration/accessing-the-management-console versions: enterprise-server: '*' +topics: + - enterprise --- ### About the {% data variables.enterprise.management_console %} @@ -19,7 +21,7 @@ versions: Use the {% data variables.enterprise.management_console %} for basic administrative activities: - **Initial setup**: Walk through the initial setup process when first launching {% data variables.product.product_location %} by visiting {% data variables.product.product_location %}'s IP address in your browser. - **Configuring basic settings for your instance**: Configure DNS, hostname, SSL, user authentication, email, monitoring services, and log forwarding on the Settings page. -- **Scheduling maintenance windows**: Take your {% data variables.product.product_location %} offline while performing maintenance using the {% data variables.enterprise.management_console %} or administrative shell. +- **Scheduling maintenance windows**: Take {% data variables.product.product_location %} offline while performing maintenance using the {% data variables.enterprise.management_console %} or administrative shell. - **Troubleshooting**: Generate a support bundle or view high level diagnostic information. - **License management**: View or update your {% data variables.product.prodname_enterprise %} license. diff --git a/content/admin/configuration/command-line-utilities.md b/content/admin/configuration/command-line-utilities.md index 188d0e4936..6abacadb3c 100644 --- a/content/admin/configuration/command-line-utilities.md +++ b/content/admin/configuration/command-line-utilities.md @@ -9,6 +9,8 @@ redirect_from: miniTocMaxHeadingLevel: 4 versions: enterprise-server: '*' +topics: + - enterprise --- You can execute these commands from anywhere on the VM after signing in as an SSH admin user. For more information, see "[Accessing the administrative shell (SSH)](/enterprise/{{ currentVersion }}/admin/guides/installation/accessing-the-administrative-shell-ssh/)." @@ -209,7 +211,7 @@ You can use these options with the utility: This utility cannot promote a non-site admin to be an owner of all organizations. You can promote an ordinary user account to a site admin with [ghe-user-promote](#ghe-user-promote). -Give organization owner privileges in a specific organization to a single user +Give organization owner privileges in a specific organization to a specific site admin ```shell ghe-org-admin-promote -u USERNAME -o ORGANIZATION diff --git a/content/admin/configuration/configuring-a-hostname.md b/content/admin/configuration/configuring-a-hostname.md index 3e7bd4b662..981e4abd9f 100644 --- a/content/admin/configuration/configuring-a-hostname.md +++ b/content/admin/configuration/configuring-a-hostname.md @@ -7,6 +7,8 @@ redirect_from: - /enterprise/admin/configuration/configuring-a-hostname versions: enterprise-server: '*' +topics: + - enterprise --- If you configure a hostname instead of a hard-coded IP address, you will be able to change the physical hardware that {% data variables.product.product_location %} runs on without affecting users or client software. diff --git a/content/admin/configuration/configuring-advanced-security-features.md b/content/admin/configuration/configuring-advanced-security-features.md index e9a8a1113f..353c1e4246 100644 --- a/content/admin/configuration/configuring-advanced-security-features.md +++ b/content/admin/configuration/configuring-advanced-security-features.md @@ -7,5 +7,7 @@ redirect_from: - /enterprise/admin/configuration/configuring-advanced-security-features versions: enterprise-server: '>=2.22' +topics: + - enterprise --- diff --git a/content/admin/configuration/configuring-an-outbound-web-proxy-server.md b/content/admin/configuration/configuring-an-outbound-web-proxy-server.md index 8a398553fa..b58ca8f400 100644 --- a/content/admin/configuration/configuring-an-outbound-web-proxy-server.md +++ b/content/admin/configuration/configuring-an-outbound-web-proxy-server.md @@ -7,6 +7,8 @@ redirect_from: - /enterprise/admin/configuration/configuring-an-outbound-web-proxy-server versions: enterprise-server: '*' +topics: + - enterprise --- When a proxy server is enabled for {% data variables.product.product_location %}, outbound messages sent by {% data variables.product.prodname_ghe_server %} are first sent through the proxy server, unless the destination host is added as an HTTP proxy exclusion. Types of outbound messages include outgoing webhooks, uploading bundles, and fetching legacy avatars. The proxy server's URL is the protocol, domain or IP address, plus the port number, for example `http://127.0.0.1:8123`. diff --git a/content/admin/configuration/configuring-applications.md b/content/admin/configuration/configuring-applications.md index 534c4c76d9..da0908fc88 100644 --- a/content/admin/configuration/configuring-applications.md +++ b/content/admin/configuration/configuring-applications.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/configuration/configuring-applications versions: enterprise-server: '*' +topics: + - enterprise --- ### Adjusting image caching diff --git a/content/admin/configuration/configuring-backups-on-your-appliance.md b/content/admin/configuration/configuring-backups-on-your-appliance.md index dbea15fc26..62754fac24 100644 --- a/content/admin/configuration/configuring-backups-on-your-appliance.md +++ b/content/admin/configuration/configuring-backups-on-your-appliance.md @@ -15,6 +15,8 @@ redirect_from: intro: 'As part of a disaster recovery plan, you can protect production data on {% data variables.product.product_location %} by configuring automated backups.' versions: enterprise-server: '*' +topics: + - enterprise --- ### About {% data variables.product.prodname_enterprise_backup_utilities %} diff --git a/content/admin/configuration/configuring-built-in-firewall-rules.md b/content/admin/configuration/configuring-built-in-firewall-rules.md index 1ee5bcda80..73415a9df1 100644 --- a/content/admin/configuration/configuring-built-in-firewall-rules.md +++ b/content/admin/configuration/configuring-built-in-firewall-rules.md @@ -7,6 +7,8 @@ redirect_from: - /enterprise/admin/configuration/configuring-built-in-firewall-rules versions: enterprise-server: '*' +topics: + - enterprise --- ### About {% data variables.product.product_location %}'s firewall diff --git a/content/admin/configuration/configuring-code-scanning-for-your-appliance.md b/content/admin/configuration/configuring-code-scanning-for-your-appliance.md index 7b579bfe1d..152e36452e 100644 --- a/content/admin/configuration/configuring-code-scanning-for-your-appliance.md +++ b/content/admin/configuration/configuring-code-scanning-for-your-appliance.md @@ -8,6 +8,8 @@ redirect_from: - /enterprise/admin/configuration/configuring-code-scanning-for-your-appliance versions: enterprise-server: '>=2.22' +topics: + - enterprise --- {% data reusables.code-scanning.beta %} diff --git a/content/admin/configuration/configuring-data-encryption-for-your-enterprise.md b/content/admin/configuration/configuring-data-encryption-for-your-enterprise.md index d6da59782a..b6ee9e150f 100644 --- a/content/admin/configuration/configuring-data-encryption-for-your-enterprise.md +++ b/content/admin/configuration/configuring-data-encryption-for-your-enterprise.md @@ -18,7 +18,7 @@ To provide a high level of security, {% data variables.product.product_name %} e For encryption in transit, {% data variables.product.product_name %} uses Transport Layer Security (TLS). For encryption at rest, {% data variables.product.product_name %} provides a default RSA key. After you've initialized your enterprise, you can choose to provide your own key instead. Your key should be a 2048 bit RSA private key in PEM format. -The key that you provide is stored in a hardware security module (HSM) in a key vault that {% data variables.product.company_short %} manages. +The key that you provide is stored in a FIPS 140-2 compliant hardware security module (HSM) in a key vault that {% data variables.product.company_short %} manages. To configure your encryption key, use the REST API. There are a number of API endpoints, for example to check the status of encryption, update your encryption key, and disable your encryption key. Note that disabling your key will freeze your enterprise. For more information about the API endpoints, see "[Encryption at rest](/rest/reference/enterprise-admin#encryption-at-rest)" in the REST API documentation. diff --git a/content/admin/configuration/configuring-dns-nameservers.md b/content/admin/configuration/configuring-dns-nameservers.md index 5e3dd8edbf..89d69a723c 100644 --- a/content/admin/configuration/configuring-dns-nameservers.md +++ b/content/admin/configuration/configuring-dns-nameservers.md @@ -7,6 +7,8 @@ redirect_from: - /enterprise/admin/configuration/configuring-dns-nameservers versions: enterprise-server: '*' +topics: + - enterprise --- The nameservers you specify must resolve {% data variables.product.product_location %}'s hostname. diff --git a/content/admin/configuration/configuring-email-for-notifications.md b/content/admin/configuration/configuring-email-for-notifications.md index cc3aac5d7c..25ae0e9c52 100644 --- a/content/admin/configuration/configuring-email-for-notifications.md +++ b/content/admin/configuration/configuring-email-for-notifications.md @@ -1,33 +1,25 @@ --- title: Configuring email for notifications +intro: 'To make it easy for users to respond quickly to activity on {% data variables.product.product_name %}, you can configure {% data variables.product.product_location %} to send email notifications for issue, pull request, and commit comments.' redirect_from: - /enterprise/admin/guides/installation/email-configuration/ - /enterprise/admin/articles/configuring-email/ - /enterprise/admin/articles/troubleshooting-email/ - /enterprise/admin/articles/email-configuration-and-troubleshooting/ - /enterprise/admin/user-management/configuring-email-for-notifications -intro: 'To make it easy for users to respond quickly to activity on {% data variables.product.product_name %}, you can configure your enterprise to send email notifications on issue, pull request, and commit comments{% if enterpriseServerVersions contains currentVersion %}, as well as additional settings to allow inbound email replies{% endif %}.' versions: enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- -Notification emails are sent if there is activity on a repository a user is watching, if there is activity in a pull request or issue they are participating in, or if the user or team they're a member of are @mentioned in a comment. - {% if currentVersion == "github-ae@latest" %} -Your dedicated technical account manager in {% data variables.contact.github_support %} can configure email for notifications to be sent through your SMTP server. Make sure you include the following details in your support request. - -- Your SMTP server address -- Login information to authenticate to the server: username and password -- The port your SMTP server uses to send email -- The domain name that your SMTP server will send with a HELO response, if any -- The type of encryption used by your SMTP server -- The no-reply email address to use in the `From` and `To` field for all notifications - -For more information about contacting support, see "[About {% data variables.contact.enterprise_support %}](/enterprise/admin/guides/enterprise-support/about-github-enterprise-support)." -{% else %} -### Configuring SMTP +Enterprise owners can configure email for notifications. +{% endif %} +### Configuring SMTP for your enterprise +{% if enterpriseServerVersions contains currentVersion %} {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} 2. At the top of the page, click **Settings**. @@ -37,32 +29,42 @@ For more information about contacting support, see "[About {% data variables.con 4. Select **Enable email**. This will enable both outbound and inbound email, however for inbound email to work you will also need to configure your DNS settings as described below in "[Configuring DNS and firewall settings to allow incoming emails](#configuring-dns-and-firewall-settings-to-allow-incoming-emails)." ![Enable outbound email](/assets/images/enterprise/management-console/enable-outbound-email.png) -5. Fill in your email server settings: - - In the **Server address** field, type the address of your SMTP server. - - In the **Port** field, type the port that your SMTP server uses to send email. - - In the **Domain** field, type the domain name that your SMTP server will send with a HELO response, if any. - - In the **Authentication** dropdown, choose the type of encryption used by your SMTP server. - - In the **No-reply email address** field, type the email address to use in the From and To fields for all notification emails. - +5. Type the settings for your SMTP server. + - In the **Server address** field, type the address of your SMTP server. + - In the **Port** field, type the port that your SMTP server uses to send email. + - In the **Domain** field, type the domain name that your SMTP server will send with a HELO response, if any. + - Select the **Authentication** dropdown, and choose the type of encryption used by your SMTP server. + - In the **No-reply email address** field, type the email address to use in the From and To fields for all notification emails. 6. If you want to discard all incoming emails that are addressed to the no-reply email address, select **Discard email addressed to the no-reply email address**. ![Checkbox to discard emails addressed to the no-reply email address](/assets/images/enterprise/management-console/discard-noreply-emails.png) -7. Under **Support**, choose a type of link to offer additional support to your users: +7. Under **Support**, choose a type of link to offer additional support to your users. - **Email:** An internal email address. - **URL:** A link to an internal support site. You must include either `http://` or `https://`. ![Support email or URL](/assets/images/enterprise/management-console/support-email-url.png) 8. [Test email delivery](#testing-email-delivery). +{% elsif currentVersion == "github-ae@latest" %} +{% data reusables.enterprise-accounts.access-enterprise %} +{% data reusables.enterprise-accounts.settings-tab %} +{% data reusables.enterprise-accounts.email-tab %} +2. Select **Enable email**. + !["Enable" checkbox for email settings configuration](/assets/images/enterprise/configuration/ae-enable-email-configure.png) +3. Type the settings for your email server. + - In the **Server address** field, type the address of your SMTP server. + - In the **Port** field, type the port that your SMTP server uses to send email. + - In the **Domain** field, type the domain name that your SMTP server will send with a HELO response, if any. + - Select the **Authentication** dropdown, and choose the type of encryption used by your SMTP server. + - In the **No-reply email address** field, type the email address to use in the From and To fields for all notification emails. +4. If you want to discard all incoming emails that are addressed to the no-reply email address, select **Discard email addressed to the no-reply email address**. + !["Discard" checkbox for email settings configuration](/assets/images/enterprise/configuration/ae-discard-email.png) +5. Click **Test email settings**. + !["Test email settings" button for email settings configuration](/assets/images/enterprise/configuration/ae-test-email.png) +6. Under "Send test email to," type the email address where you want to send a test email, then click **Send test email**. + !["Send test email" button for email settings configuration](/assets/images/enterprise/configuration/ae-send-test-email.png) +7. Click **Save**. + !["Save" button for enterprise support contact configuration](/assets/images/enterprise/configuration/ae-save.png) +{% endif %} -### Configuring DNS and firewall settings to allow incoming emails - -If you want to allow email replies to notifications, you must configure your DNS settings. - -1. Ensure that port 25 on the instance is accessible to your SMTP server. -2. Create an A record that points to `reply.[hostname]`. Depending on your DNS provider and instance host configuration, you may be able to instead create a single A record that points to `*.[hostname]`. -3. Create an MX record that points to `reply.[hostname]` so that emails to that domain are routed to the instance. -4. Create an MX record that points `noreply.[hostname]` to `[hostname]` so that replies to the `cc` address in notification emails are routed to the instance. For more information, see {% if currentVersion ver_gt "enterprise-server@2.20" %}"[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications){% else %}"[About email notifications](/github/receiving-notifications-about-activity-on-github/about-email-notifications){% endif %}." - -With your DNS configuration setup, you can now test whether the setup works. - +{% if enterpriseServerVersions contains currentVersion %} ### Testing email delivery 1. At the top of the **Email** section, click **Test email settings**. @@ -84,6 +86,15 @@ With your DNS configuration setup, you can now test whether the setup works. 6. Wait for the configuration run to complete. ![Configuring your instance](/assets/images/enterprise/management-console/configuration-run.png) +### Configuring DNS and firewall settings to allow incoming emails + +If you want to allow email replies to notifications, you must configure your DNS settings. + +1. Ensure that port 25 on the instance is accessible to your SMTP server. +2. Create an A record that points to `reply.[hostname]`. Depending on your DNS provider and instance host configuration, you may be able to instead create a single A record that points to `*.[hostname]`. +3. Create an MX record that points to `reply.[hostname]` so that emails to that domain are routed to the instance. +4. Create an MX record that points `noreply.[hostname]` to `[hostname]` so that replies to the `cc` address in notification emails are routed to the instance. For more information, see {% if currentVersion ver_gt "enterprise-server@2.20" %}"[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications){% else %}"[About email notifications](/github/receiving-notifications-about-activity-on-github/about-email-notifications){% endif %}." + ### Troubleshooting email delivery #### Create a Support Bundle @@ -155,7 +166,7 @@ Note that the client first connects; then, the queue becomes active. Then, the m [2014-10-30T00:47:23.334 DEBUG (5284) #] Moving /data/user/mail/reply/new/1414630039.Vfc00I12000eM445784.ghe-tjl2-co-ie => /data/user/incoming-mail/success ``` -You'll notice that `metroplex` catches the inbound message, processes it, then moves the file over to `/data/user/incoming-mail/success`. +You'll notice that `metroplex` catches the inbound message, processes it, then moves the file over to `/data/user/incoming-mail/success`.{% endif %} #### Verify your DNS settings @@ -166,6 +177,8 @@ In order to properly process inbound emails, you must configure a valid A Record If {% data variables.product.product_location %} is behind a firewall or is being served through an AWS Security Group, make sure port 25 is open to all mail servers that send emails to `reply@reply.[hostname]`. #### Contact support - +{% if enterpriseServerVersions contains currentVersion %} If you're still unable to resolve the problem, contact {% data variables.contact.contact_ent_support %}. Please attach the output file from `http(s)://[hostname]/setup/diagnostics` to your email to help us troubleshoot your problem. +{% elsif currentVersion == "github-ae@latest" %} +You can contact {% data variables.contact.github_support %} for help configuring email for notifications to be sent through your SMTP server. For more information, see "[Receiving help from {% data variables.contact.github_support %}](/admin/enterprise-support/receiving-help-from-github-support)." {% endif %} diff --git a/content/admin/configuration/configuring-github-pages-for-your-enterprise.md b/content/admin/configuration/configuring-github-pages-for-your-enterprise.md index 29a92ff609..3a27d659cc 100644 --- a/content/admin/configuration/configuring-github-pages-for-your-enterprise.md +++ b/content/admin/configuration/configuring-github-pages-for-your-enterprise.md @@ -11,6 +11,8 @@ redirect_from: versions: enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- ### Enabling public sites for {% data variables.product.prodname_pages %} diff --git a/content/admin/configuration/configuring-network-settings.md b/content/admin/configuration/configuring-network-settings.md index b5d7abf7e0..fe94a7b2b0 100644 --- a/content/admin/configuration/configuring-network-settings.md +++ b/content/admin/configuration/configuring-network-settings.md @@ -11,5 +11,7 @@ intro: 'Configure {% data variables.product.prodname_ghe_server %} with the DNS mapTopic: true versions: enterprise-server: '*' +topics: + - enterprise --- diff --git a/content/admin/configuration/configuring-rate-limits.md b/content/admin/configuration/configuring-rate-limits.md index 5cffccdf16..46f56ef79e 100644 --- a/content/admin/configuration/configuring-rate-limits.md +++ b/content/admin/configuration/configuring-rate-limits.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/configuration/configuring-rate-limits versions: enterprise-server: '*' +topics: + - enterprise --- ### Enabling rate limits for {% data variables.product.prodname_enterprise_api %} diff --git a/content/admin/configuration/configuring-secret-scanning-for-your-appliance.md b/content/admin/configuration/configuring-secret-scanning-for-your-appliance.md index b806b45f29..361702b4b3 100644 --- a/content/admin/configuration/configuring-secret-scanning-for-your-appliance.md +++ b/content/admin/configuration/configuring-secret-scanning-for-your-appliance.md @@ -6,6 +6,8 @@ product: '{% data reusables.gated-features.secret-scanning %}' miniTocMaxHeadingLevel: 4 versions: enterprise-server: '>=3.0' +topics: + - enterprise --- {% data reusables.secret-scanning.beta %} diff --git a/content/admin/configuration/configuring-the-ip-address-using-the-virtual-machine-console.md b/content/admin/configuration/configuring-the-ip-address-using-the-virtual-machine-console.md index c8b25b42dc..f814b48cf9 100644 --- a/content/admin/configuration/configuring-the-ip-address-using-the-virtual-machine-console.md +++ b/content/admin/configuration/configuring-the-ip-address-using-the-virtual-machine-console.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/configuration/configuring-the-ip-address-using-the-virtual-machine-console versions: enterprise-server: '*' +topics: + - enterprise --- {% note %} diff --git a/content/admin/configuration/configuring-time-synchronization.md b/content/admin/configuration/configuring-time-synchronization.md index d9042f873d..a71272ab86 100644 --- a/content/admin/configuration/configuring-time-synchronization.md +++ b/content/admin/configuration/configuring-time-synchronization.md @@ -10,6 +10,8 @@ redirect_from: - /enterprise/admin/configuration/configuring-time-synchronization versions: enterprise-server: '*' +topics: + - enterprise --- ### Changing the default NTP servers diff --git a/content/admin/configuration/configuring-tls.md b/content/admin/configuration/configuring-tls.md index fd106938d1..4b9d1bb375 100644 --- a/content/admin/configuration/configuring-tls.md +++ b/content/admin/configuration/configuring-tls.md @@ -8,6 +8,8 @@ redirect_from: - /enterprise/admin/configuration/configuring-tls versions: enterprise-server: '*' +topics: + - enterprise --- ### About Transport Layer Security diff --git a/content/admin/configuration/configuring-your-enterprise.md b/content/admin/configuration/configuring-your-enterprise.md index 5afbbe1751..641f5e6109 100644 --- a/content/admin/configuration/configuring-your-enterprise.md +++ b/content/admin/configuration/configuring-your-enterprise.md @@ -1,6 +1,6 @@ --- title: Configuring your enterprise -intro: "After {% data variables.product.product_name %} is up and running, you can configure your enterprise to suit your organization's needs." +intro: 'After {% data variables.product.product_name %} is up and running, you can configure your enterprise to suit your organization''s needs.' redirect_from: - /enterprise/admin/guides/installation/basic-configuration/ - /enterprise/admin/guides/installation/administrative-tools/ @@ -12,5 +12,7 @@ mapTopic: true versions: enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- diff --git a/content/admin/configuration/connecting-github-enterprise-server-to-github-enterprise-cloud.md b/content/admin/configuration/connecting-github-enterprise-server-to-github-enterprise-cloud.md index f3e412341c..30be76ad51 100644 --- a/content/admin/configuration/connecting-github-enterprise-server-to-github-enterprise-cloud.md +++ b/content/admin/configuration/connecting-github-enterprise-server-to-github-enterprise-cloud.md @@ -10,6 +10,8 @@ redirect_from: permissions: 'Site administrators for {% data variables.product.prodname_ghe_server %} who are also owners of a {% data variables.product.prodname_ghe_cloud %} organization or enterprise account can enable {% data variables.product.prodname_github_connect %}.' versions: enterprise-server: '*' +topics: + - enterprise --- ### About {% data variables.product.prodname_github_connect %} diff --git a/content/admin/configuration/enabling-alerts-for-vulnerable-dependencies-on-github-enterprise-server.md b/content/admin/configuration/enabling-alerts-for-vulnerable-dependencies-on-github-enterprise-server.md index 8d25c497ef..3311ca6605 100644 --- a/content/admin/configuration/enabling-alerts-for-vulnerable-dependencies-on-github-enterprise-server.md +++ b/content/admin/configuration/enabling-alerts-for-vulnerable-dependencies-on-github-enterprise-server.md @@ -8,6 +8,8 @@ redirect_from: permissions: 'Site administrators for {% data variables.product.prodname_ghe_server %} who are also owners of the connected {% data variables.product.prodname_ghe_cloud %} organization or enterprise account can enable {% if currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot %}{% else %}security{% endif %} alerts for vulnerable dependencies on {% data variables.product.prodname_ghe_server %}.' versions: enterprise-server: '*' +topics: + - enterprise --- ### About alerts for vulnerable dependencies on {% data variables.product.prodname_ghe_server %} diff --git a/content/admin/configuration/enabling-and-scheduling-maintenance-mode.md b/content/admin/configuration/enabling-and-scheduling-maintenance-mode.md index 832241da5f..52dfaa160b 100644 --- a/content/admin/configuration/enabling-and-scheduling-maintenance-mode.md +++ b/content/admin/configuration/enabling-and-scheduling-maintenance-mode.md @@ -12,6 +12,8 @@ redirect_from: - /enterprise/admin/configuration/enabling-and-scheduling-maintenance-mode versions: enterprise-server: '*' +topics: + - enterprise --- ### About maintenance mode diff --git a/content/admin/configuration/enabling-automatic-user-license-sync-between-github-enterprise-server-and-github-enterprise-cloud.md b/content/admin/configuration/enabling-automatic-user-license-sync-between-github-enterprise-server-and-github-enterprise-cloud.md index a320a62917..3c161a3171 100644 --- a/content/admin/configuration/enabling-automatic-user-license-sync-between-github-enterprise-server-and-github-enterprise-cloud.md +++ b/content/admin/configuration/enabling-automatic-user-license-sync-between-github-enterprise-server-and-github-enterprise-cloud.md @@ -7,6 +7,8 @@ redirect_from: permissions: 'Site administrators for {% data variables.product.prodname_ghe_server %} who are also owners of the connected {% data variables.product.prodname_ghe_cloud %} organization or enterprise account can enable automatic user license synchronization.' versions: enterprise-server: '*' +topics: + - enterprise --- ### About license synchronization diff --git a/content/admin/configuration/enabling-private-mode.md b/content/admin/configuration/enabling-private-mode.md index 831e440b7f..1e32ab673f 100644 --- a/content/admin/configuration/enabling-private-mode.md +++ b/content/admin/configuration/enabling-private-mode.md @@ -9,6 +9,8 @@ redirect_from: - /enterprise/admin/configuration/enabling-private-mode versions: enterprise-server: '*' +topics: + - enterprise --- You must enable private mode if {% data variables.product.product_location %} is publicly accessible over the Internet. In private mode, users cannot anonymously clone repositories over `git://`. If built-in authentication is also enabled, an administrator must invite new users to create an account on the instance. For more information, see "[Using built-in authentication](/enterprise/{{ currentVersion }}/admin/guides/user-management/using-built-in-authentication)." diff --git a/content/admin/configuration/enabling-subdomain-isolation.md b/content/admin/configuration/enabling-subdomain-isolation.md index 76012af69f..782d4033e7 100644 --- a/content/admin/configuration/enabling-subdomain-isolation.md +++ b/content/admin/configuration/enabling-subdomain-isolation.md @@ -7,6 +7,8 @@ redirect_from: - /enterprise/admin/configuration/enabling-subdomain-isolation versions: enterprise-server: '*' +topics: + - enterprise --- ### About subdomain isolation diff --git a/content/admin/configuration/enabling-unified-contributions-between-github-enterprise-server-and-githubcom.md b/content/admin/configuration/enabling-unified-contributions-between-github-enterprise-server-and-githubcom.md index 7c85654bea..2d609c74fb 100644 --- a/content/admin/configuration/enabling-unified-contributions-between-github-enterprise-server-and-githubcom.md +++ b/content/admin/configuration/enabling-unified-contributions-between-github-enterprise-server-and-githubcom.md @@ -10,6 +10,8 @@ redirect_from: permissions: 'Site administrators for {% data variables.product.prodname_ghe_server %} who are also owners of the connected {% data variables.product.prodname_ghe_cloud %} organization or enterprise account can enable unified contributions between {% data variables.product.prodname_ghe_server %} and {% data variables.product.prodname_dotcom_the_website %}.' versions: enterprise-server: '*' +topics: + - enterprise --- As a site administrator, you can allow end users to send anonymized contribution counts for their work from {% data variables.product.prodname_ghe_server %} to their {% data variables.product.prodname_dotcom_the_website %} contribution graph. diff --git a/content/admin/configuration/enabling-unified-search-between-github-enterprise-server-and-githubcom.md b/content/admin/configuration/enabling-unified-search-between-github-enterprise-server-and-githubcom.md index 33130ca6fe..d34e2ebdba 100644 --- a/content/admin/configuration/enabling-unified-search-between-github-enterprise-server-and-githubcom.md +++ b/content/admin/configuration/enabling-unified-search-between-github-enterprise-server-and-githubcom.md @@ -10,6 +10,8 @@ redirect_from: permissions: 'Site administrators for {% data variables.product.prodname_ghe_server %} who are also owners of the connected {% data variables.product.prodname_ghe_cloud %} organization or enterprise account can enable unified search between {% data variables.product.prodname_ghe_server %} and {% data variables.product.prodname_dotcom_the_website %}.' versions: enterprise-server: '*' +topics: + - enterprise --- When you enable unified search, users can view search results from public and private content on {% data variables.product.prodname_dotcom_the_website %} when searching from {% data variables.product.product_location_enterprise %}. diff --git a/content/admin/configuration/index.md b/content/admin/configuration/index.md index ee042551f2..1cfa0079a8 100644 --- a/content/admin/configuration/index.md +++ b/content/admin/configuration/index.md @@ -1,12 +1,14 @@ --- title: Configuring GitHub Enterprise shortTitle: Configuring GitHub Enterprise -intro: "You can configure your enterprise to suit your organization's needs." +intro: You can configure your enterprise to suit your organization's needs. redirect_from: - /enterprise/admin/configuration versions: enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- {% if currentVersion ver_gt "enterprise-server@2.21" %} diff --git a/content/admin/configuration/initializing-github-ae.md b/content/admin/configuration/initializing-github-ae.md index 773dd7d1b5..8be6d29791 100644 --- a/content/admin/configuration/initializing-github-ae.md +++ b/content/admin/configuration/initializing-github-ae.md @@ -22,9 +22,9 @@ During initialization, the enterprise owner will name your enterprise, configure {% endnote %} 1. To initialize {% data variables.product.product_location %}, you must have a SAML identity provider (IdP). {% data reusables.saml.ae-uses-saml-sso %} To connect your IdP to your enterprise during initialization, you should have your IdP's Entity ID (SSO) URL, Issuer ID URL, and public signing certificate (Base64-encoded). For more information, see "[About identity and access management for your enterprise](/admin/authentication/about-identity-and-access-management-for-your-enterprise)." - + {% note %} - + **Note**: {% data reusables.saml.create-a-machine-user %} {% endnote %} @@ -92,3 +92,28 @@ You can configure the method your users will use to contact your internal suppor ![Text field for internal support contact URL](/assets/images/enterprise/configuration/ae-support-link-url.png) 3. Click **Save**. !["Save" button for enterprise support contact configuration](/assets/images/enterprise/configuration/ae-save.png) + +### Setting your email settings + +Once this is initialized, you can reconfigure any settings after the initialization process. For more information, see "[Configuring email for notifications](/admin/configuration/configuring-email-for-notifications)." + +1. To the right of "Configure email settings", click **Configure**. + !["Configure" button for email settings configuration](/assets/images/enterprise/configuration/ae-email-configure.png) +2. Select **Enable email**. This will enable both outbound and inbound email, however, for inbound email to work you will also need to configure your DNS settings. For more information, see "[Configuring DNS and firewall + settings to allow incoming emails](/admin/configuration/configuring-email-for-notifications#configuring-dns-and-firewall-settings-to-allow-incoming-emails)." + !["Enable" checkbox for email settings configuration](/assets/images/enterprise/configuration/ae-enable-email-configure.png) +3. Complete your email server settings: + - In the **Server address** field, type the address of your SMTP server. + - In the **Port** field, type the port that your SMTP server uses to send email. + - In the **Domain** field, type the domain name that your SMTP server will send with a HELO response, if any. + - In the **Authentication** dropdown, choose the type of encryption used by your SMTP server. + - In the **No-reply email address** field, type the email address to use in the From and To fields for all notification emails. + +4. If you want to discard all incoming emails that are addressed to the no-reply email address, select **Discard email addressed to the no-reply email address**. + !["Discard" checkbox for email settings configuration](/assets/images/enterprise/configuration/ae-discard-email.png) +5. Click **Test email settings**. + !["Test email settings" button for email settings configuration](/assets/images/enterprise/configuration/ae-test-email.png) +6. Under "Send test email to," type the email address where you want to send a test email, then click **Send test email**. + !["Send test email" button for email settings configuration](/assets/images/enterprise/configuration/ae-send-test-email.png) +7. Click **Save**. + !["Save" button for enterprise support contact configuration](/assets/images/enterprise/configuration/ae-save.png) diff --git a/content/admin/configuration/managing-connections-between-github-enterprise-server-and-github-enterprise-cloud.md b/content/admin/configuration/managing-connections-between-github-enterprise-server-and-github-enterprise-cloud.md index 63e4e25bee..1fd17e838e 100644 --- a/content/admin/configuration/managing-connections-between-github-enterprise-server-and-github-enterprise-cloud.md +++ b/content/admin/configuration/managing-connections-between-github-enterprise-server-and-github-enterprise-cloud.md @@ -11,5 +11,7 @@ redirect_from: - /enterprise/admin/configuration/managing-connections-between-github-enterprise-server-and-github-enterprise-cloud versions: enterprise-server: '*' +topics: + - enterprise --- diff --git a/content/admin/configuration/managing-github-for-mobile-for-your-enterprise.md b/content/admin/configuration/managing-github-for-mobile-for-your-enterprise.md index 66de92b8f4..fb7b3fe2dc 100644 --- a/content/admin/configuration/managing-github-for-mobile-for-your-enterprise.md +++ b/content/admin/configuration/managing-github-for-mobile-for-your-enterprise.md @@ -1,9 +1,11 @@ --- title: Managing GitHub for mobile for your enterprise -intro: You can decide whether authenticated users can connect to {% data variables.product.product_location %} with {% data variables.product.prodname_mobile %}. -permissions: Enterprise owners can manage {% data variables.product.prodname_mobile %} for an enterprise on {% data variables.product.product_name %}. +intro: 'You can decide whether authenticated users can connect to {% data variables.product.product_location %} with {% data variables.product.prodname_mobile %}.' +permissions: 'Enterprise owners can manage {% data variables.product.prodname_mobile %} for an enterprise on {% data variables.product.product_name %}.' versions: enterprise-server: '>=3.0' +topics: + - enterprise --- {% if enterpriseServerVersions contains currentVersion %} diff --git a/content/admin/configuration/network-ports.md b/content/admin/configuration/network-ports.md index 9a4688b5f2..22f578d8d3 100644 --- a/content/admin/configuration/network-ports.md +++ b/content/admin/configuration/network-ports.md @@ -10,6 +10,8 @@ redirect_from: intro: 'Open network ports selectively based on the network services you need to expose for administrators, end users, and email support.' versions: enterprise-server: '*' +topics: + - enterprise --- ### Administrative ports diff --git a/content/admin/configuration/restricting-network-traffic-to-your-enterprise.md b/content/admin/configuration/restricting-network-traffic-to-your-enterprise.md index d20a711bd0..7edc128771 100644 --- a/content/admin/configuration/restricting-network-traffic-to-your-enterprise.md +++ b/content/admin/configuration/restricting-network-traffic-to-your-enterprise.md @@ -1,11 +1,60 @@ --- title: Restricting network traffic to your enterprise shortTitle: Restricting network traffic -intro: 'You can restrict access to your enterprise to connections from specified IP addresses.' +intro: 'You can use an IP allow list to restrict access to your enterprise to connections from specified IP addresses.' versions: github-ae: '*' --- -By default, authorized users can access your enterprise from any IP address. You can restrict access to specific IP addresses such as your physical office locations by contacting support. +### About IP allow lists +By default, authorized users can access your enterprise from any IP address. Enterprise owners can restrict access to assets owned by organizations in an enterprise account by configuring an allow list for specific IP addresses. {% data reusables.identity-and-permissions.ip-allow-lists-example-and-restrictions %} -Contact {% data variables.contact.github_support %} with the IP addresses that should be allowed to access your enterprise. Specify address ranges using the standard CIDR (Classless Inter-Domain Routing) format. {% data variables.contact.github_support %} will configure the appropriate firewall rules for your enterprise to restrict network access over HTTP, SSH, HTTPS, and SMTP. For more information, see "[Receiving help from {% data variables.contact.github_support %}](/enterprise/admin/guides/enterprise-support/receiving-help-from-github-support)." +{% data reusables.identity-and-permissions.ip-allow-lists-cidr-notation %} + +{% data reusables.identity-and-permissions.ip-allow-lists-enable %} + +You can also configure allowed IP addresses for an individual organization. For more information, see "[Managing allowed IP addresses for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-allowed-ip-addresses-for-your-organization)." + +By default, Azure network security group (NSG) rules leave all inbound traffic open on ports 22, 80, 443, and 25. Enterprise owners can contact {% data variables.contact.github_support %} to configure access restrictions for your instance. + +For instance-level restrictions using Azure NSGs, contact {% data variables.contact.github_support %} with the IP addresses that should be allowed to access your enterprise instance. Specify address ranges using the standard CIDR (Classless Inter-Domain Routing) format. {% data variables.contact.github_support %} will configure the appropriate firewall rules for your enterprise to restrict network access over HTTP, SSH, HTTPS, and SMTP. For more information, see "[Receiving help from {% data variables.contact.github_support %}](/admin/enterprise-support/receiving-help-from-github-support)." + +### Adding an allowed IP address + +{% data reusables.enterprise-accounts.access-enterprise %} +{% data reusables.enterprise-accounts.settings-tab %} +{% data reusables.enterprise-accounts.security-tab %} +{% data reusables.identity-and-permissions.ip-allow-lists-add-ip %} +{% data reusables.identity-and-permissions.ip-allow-lists-add-description %} +{% data reusables.identity-and-permissions.ip-allow-lists-add-entry %} + +### Enabling allowed IP addresses + +{% data reusables.enterprise-accounts.access-enterprise %} +{% data reusables.enterprise-accounts.settings-tab %} +{% data reusables.enterprise-accounts.security-tab %} +1. Under "IP allow list", select **Enable IP allow list**. + ![Checkbox to allow IP addresses](/assets/images/help/security/enable-ip-allowlist-enterprise-checkbox.png) +4. Click **Save**. + +### Editing an allowed IP address + +{% data reusables.enterprise-accounts.access-enterprise %} +{% data reusables.enterprise-accounts.settings-tab %} +{% data reusables.enterprise-accounts.security-tab %} +{% data reusables.identity-and-permissions.ip-allow-lists-edit-entry %} +{% data reusables.identity-and-permissions.ip-allow-lists-edit-ip %} +{% data reusables.identity-and-permissions.ip-allow-lists-edit-description %} +8. Click **Update**. + +### Deleting an allowed IP address + +{% data reusables.enterprise-accounts.access-enterprise %} +{% data reusables.enterprise-accounts.settings-tab %} +{% data reusables.enterprise-accounts.security-tab %} +{% data reusables.identity-and-permissions.ip-allow-lists-delete-entry %} +{% data reusables.identity-and-permissions.ip-allow-lists-confirm-deletion %} + +### Using {% data variables.product.prodname_actions %} with an IP allow list + +{% data reusables.github-actions.ip-allow-list-hosted-runners %} diff --git a/content/admin/configuration/site-admin-dashboard.md b/content/admin/configuration/site-admin-dashboard.md index da953a8cd3..df0c325292 100644 --- a/content/admin/configuration/site-admin-dashboard.md +++ b/content/admin/configuration/site-admin-dashboard.md @@ -7,6 +7,8 @@ redirect_from: - /enterprise/admin/configuration/site-admin-dashboard versions: enterprise-server: '*' +topics: + - enterprise --- To access the dashboard, in the upper-right corner of any page, click {% octicon "rocket" aria-label="The rocket ship" %}. diff --git a/content/admin/configuration/troubleshooting-ssl-errors.md b/content/admin/configuration/troubleshooting-ssl-errors.md index 61c4bb3ce9..8271cc47b2 100644 --- a/content/admin/configuration/troubleshooting-ssl-errors.md +++ b/content/admin/configuration/troubleshooting-ssl-errors.md @@ -8,6 +8,8 @@ redirect_from: - /enterprise/admin/configuration/troubleshooting-ssl-errors versions: enterprise-server: '*' +topics: + - enterprise --- ### Removing the passphrase from your key file diff --git a/content/admin/configuration/using-github-enterprise-server-with-a-load-balancer.md b/content/admin/configuration/using-github-enterprise-server-with-a-load-balancer.md index 539b679d73..869cc35ff0 100644 --- a/content/admin/configuration/using-github-enterprise-server-with-a-load-balancer.md +++ b/content/admin/configuration/using-github-enterprise-server-with-a-load-balancer.md @@ -7,6 +7,8 @@ redirect_from: - /enterprise/admin/configuration/using-github-enterprise-server-with-a-load-balancer versions: enterprise-server: '*' +topics: + - enterprise --- {% data reusables.enterprise_clustering.load_balancer_intro %} diff --git a/content/admin/configuration/validating-your-domain-settings.md b/content/admin/configuration/validating-your-domain-settings.md index 1c731a310c..581679b205 100644 --- a/content/admin/configuration/validating-your-domain-settings.md +++ b/content/admin/configuration/validating-your-domain-settings.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/configuration/validating-your-domain-settings versions: enterprise-server: '*' +topics: + - enterprise --- {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} diff --git a/content/admin/enterprise-management/about-cluster-nodes.md b/content/admin/enterprise-management/about-cluster-nodes.md index 74a1a75fe3..463b8781a0 100644 --- a/content/admin/enterprise-management/about-cluster-nodes.md +++ b/content/admin/enterprise-management/about-cluster-nodes.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/enterprise-management/about-cluster-nodes versions: enterprise-server: '*' +topics: + - enterprise --- {% data reusables.enterprise_clustering.clustering-requires-https %} diff --git a/content/admin/enterprise-management/about-clustering.md b/content/admin/enterprise-management/about-clustering.md index 8b3345da85..1a1157bb0d 100644 --- a/content/admin/enterprise-management/about-clustering.md +++ b/content/admin/enterprise-management/about-clustering.md @@ -8,6 +8,8 @@ redirect_from: - /enterprise/admin/enterprise-management/about-clustering versions: enterprise-server: '*' +topics: + - enterprise --- ### Clustering architecture diff --git a/content/admin/enterprise-management/about-geo-replication.md b/content/admin/enterprise-management/about-geo-replication.md index dfa868e556..b72945375b 100644 --- a/content/admin/enterprise-management/about-geo-replication.md +++ b/content/admin/enterprise-management/about-geo-replication.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/enterprise-management/about-geo-replication versions: enterprise-server: '*' +topics: + - enterprise --- Multiple active replicas can provide a shorter distance to the nearest replica. For example, an organization with offices in San Francisco, New York, and London could run the primary appliance in a datacenter near New York and two replicas in datacenters near San Francisco and London. Using geolocation-aware DNS, users can be directed to the closest server available and access repository data faster. Designating the appliance near New York as the primary helps reduce the latency between the hosts, compared to the appliance near San Francisco being the primary which has a higher latency to London. diff --git a/content/admin/enterprise-management/about-high-availability-configuration.md b/content/admin/enterprise-management/about-high-availability-configuration.md index 724be83b78..19b5449371 100644 --- a/content/admin/enterprise-management/about-high-availability-configuration.md +++ b/content/admin/enterprise-management/about-high-availability-configuration.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/enterprise-management/about-high-availability-configuration versions: enterprise-server: '*' +topics: + - enterprise --- When you configure high availability, there is an automated setup of one-way, asynchronous replication of all datastores (Git repositories, MySQL, Redis, and Elasticsearch) from the primary to the replica appliance. diff --git a/content/admin/enterprise-management/accessing-the-monitor-dashboard.md b/content/admin/enterprise-management/accessing-the-monitor-dashboard.md index a83ec1d359..b7182b0edf 100644 --- a/content/admin/enterprise-management/accessing-the-monitor-dashboard.md +++ b/content/admin/enterprise-management/accessing-the-monitor-dashboard.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/enterprise-management/accessing-the-monitor-dashboard versions: enterprise-server: '*' +topics: + - enterprise --- ### Accessing the monitor dashboard diff --git a/content/admin/enterprise-management/cluster-network-configuration.md b/content/admin/enterprise-management/cluster-network-configuration.md index b11cc7bb1f..80f91507d7 100644 --- a/content/admin/enterprise-management/cluster-network-configuration.md +++ b/content/admin/enterprise-management/cluster-network-configuration.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/enterprise-management/cluster-network-configuration versions: enterprise-server: '*' +topics: + - enterprise --- ### Network considerations diff --git a/content/admin/enterprise-management/configuring-clustering.md b/content/admin/enterprise-management/configuring-clustering.md index 6fc9f34af1..6752ddf050 100644 --- a/content/admin/enterprise-management/configuring-clustering.md +++ b/content/admin/enterprise-management/configuring-clustering.md @@ -9,5 +9,7 @@ redirect_from: mapTopic: true versions: enterprise-server: '*' +topics: + - enterprise --- diff --git a/content/admin/enterprise-management/configuring-collectd.md b/content/admin/enterprise-management/configuring-collectd.md index 4196beb841..7ce2e846c8 100644 --- a/content/admin/enterprise-management/configuring-collectd.md +++ b/content/admin/enterprise-management/configuring-collectd.md @@ -7,6 +7,8 @@ redirect_from: - /enterprise/admin/enterprise-management/configuring-collectd versions: enterprise-server: '*' +topics: + - enterprise --- ### Set up an external `collectd` server diff --git a/content/admin/enterprise-management/configuring-high-availability-replication-for-a-cluster.md b/content/admin/enterprise-management/configuring-high-availability-replication-for-a-cluster.md index 9cf229f154..deb7ebbf60 100644 --- a/content/admin/enterprise-management/configuring-high-availability-replication-for-a-cluster.md +++ b/content/admin/enterprise-management/configuring-high-availability-replication-for-a-cluster.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/enterprise-management/configuring-high-availability-replication-for-a-cluster versions: enterprise-server: '>2.21' +topics: + - enterprise --- ### About high availability replication for clusters diff --git a/content/admin/enterprise-management/configuring-high-availability.md b/content/admin/enterprise-management/configuring-high-availability.md index 84b7b0ae9f..bd994c7848 100644 --- a/content/admin/enterprise-management/configuring-high-availability.md +++ b/content/admin/enterprise-management/configuring-high-availability.md @@ -10,5 +10,7 @@ intro: '{% data variables.product.prodname_ghe_server %} supports a high availab mapTopic: true versions: enterprise-server: '*' +topics: + - enterprise --- diff --git a/content/admin/enterprise-management/creating-a-high-availability-replica.md b/content/admin/enterprise-management/creating-a-high-availability-replica.md index 9c124a1eb8..8a032953fb 100644 --- a/content/admin/enterprise-management/creating-a-high-availability-replica.md +++ b/content/admin/enterprise-management/creating-a-high-availability-replica.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/enterprise-management/creating-a-high-availability-replica versions: enterprise-server: '*' +topics: + - enterprise --- ### Creating a high availability replica diff --git a/content/admin/enterprise-management/differences-between-clustering-and-high-availability-ha.md b/content/admin/enterprise-management/differences-between-clustering-and-high-availability-ha.md index 9ac3ba2f73..59d4847dd9 100644 --- a/content/admin/enterprise-management/differences-between-clustering-and-high-availability-ha.md +++ b/content/admin/enterprise-management/differences-between-clustering-and-high-availability-ha.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/enterprise-management/differences-between-clustering-and-high-availability-ha versions: enterprise-server: '*' +topics: + - enterprise --- ### Failure scenarios diff --git a/content/admin/enterprise-management/enabling-automatic-update-checks.md b/content/admin/enterprise-management/enabling-automatic-update-checks.md index 07f741e1bc..3c53bfa0a5 100644 --- a/content/admin/enterprise-management/enabling-automatic-update-checks.md +++ b/content/admin/enterprise-management/enabling-automatic-update-checks.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/enterprise-management/enabling-automatic-update-checks versions: enterprise-server: '*' +topics: + - enterprise --- When an upgrade package is automatically downloaded for {% data variables.product.product_location %}, you'll receive a message letting you know you can upgrade {% data variables.product.prodname_ghe_server %}. Packages download to the `/var/lib/ghe-updates` directory on {% data variables.product.product_location %}. For more information, see "[Upgrading {% data variables.product.prodname_ghe_server %}](/enterprise/{{ currentVersion }}/admin/guides/installation/upgrading-github-enterprise-server)." diff --git a/content/admin/enterprise-management/evacuating-a-cluster-node.md b/content/admin/enterprise-management/evacuating-a-cluster-node.md index c429e92707..a93e152668 100644 --- a/content/admin/enterprise-management/evacuating-a-cluster-node.md +++ b/content/admin/enterprise-management/evacuating-a-cluster-node.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/enterprise-management/evacuating-a-cluster-node versions: enterprise-server: '*' +topics: + - enterprise --- If you only have three nodes in your data services cluster, you can't evacuate the nodes, because `ghe-spokes` doesn’t have another place to make a copy. If you have four or more, `ghe-spokes` will move all the repositories off of the evacuated node. diff --git a/content/admin/enterprise-management/increasing-cpu-or-memory-resources.md b/content/admin/enterprise-management/increasing-cpu-or-memory-resources.md index 70ad38778a..ce3e4a1acd 100644 --- a/content/admin/enterprise-management/increasing-cpu-or-memory-resources.md +++ b/content/admin/enterprise-management/increasing-cpu-or-memory-resources.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/enterprise-management/increasing-cpu-or-memory-resources versions: enterprise-server: '*' +topics: + - enterprise --- {% data reusables.enterprise_installation.warning-on-upgrading-physical-resources %} diff --git a/content/admin/enterprise-management/increasing-storage-capacity.md b/content/admin/enterprise-management/increasing-storage-capacity.md index 2c893b226e..1db8208731 100644 --- a/content/admin/enterprise-management/increasing-storage-capacity.md +++ b/content/admin/enterprise-management/increasing-storage-capacity.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/enterprise-management/increasing-storage-capacity versions: enterprise-server: '*' +topics: + - enterprise --- {% data reusables.enterprise_installation.warning-on-upgrading-physical-resources %} diff --git a/content/admin/enterprise-management/index.md b/content/admin/enterprise-management/index.md index faaf069973..cc6f503d0a 100644 --- a/content/admin/enterprise-management/index.md +++ b/content/admin/enterprise-management/index.md @@ -5,6 +5,8 @@ redirect_from: - /enterprise/admin/enterprise-management versions: enterprise-server: '*' +topics: + - enterprise --- diff --git a/content/admin/enterprise-management/initializing-the-cluster.md b/content/admin/enterprise-management/initializing-the-cluster.md index 1fc88c484a..4ada134284 100644 --- a/content/admin/enterprise-management/initializing-the-cluster.md +++ b/content/admin/enterprise-management/initializing-the-cluster.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/enterprise-management/initializing-the-cluster versions: enterprise-server: '*' +topics: + - enterprise --- {% data reusables.enterprise_clustering.clustering-requires-https %} diff --git a/content/admin/enterprise-management/initiating-a-failover-to-your-replica-appliance.md b/content/admin/enterprise-management/initiating-a-failover-to-your-replica-appliance.md index 208fe0e10d..7a9d0c47f5 100644 --- a/content/admin/enterprise-management/initiating-a-failover-to-your-replica-appliance.md +++ b/content/admin/enterprise-management/initiating-a-failover-to-your-replica-appliance.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/enterprise-management/initiating-a-failover-to-your-replica-appliance versions: enterprise-server: '*' +topics: + - enterprise --- The time required to failover depends on how long it takes to manually promote the replica and redirect traffic. The average time ranges between 2-10 minutes. diff --git a/content/admin/enterprise-management/initiating-a-failover-to-your-replica-cluster.md b/content/admin/enterprise-management/initiating-a-failover-to-your-replica-cluster.md index 2b0406038c..baa4b482d3 100644 --- a/content/admin/enterprise-management/initiating-a-failover-to-your-replica-cluster.md +++ b/content/admin/enterprise-management/initiating-a-failover-to-your-replica-cluster.md @@ -5,6 +5,8 @@ redirect_from: - /enterprise/admin/enterprise-management/initiating-a-failover-to-your-replica-cluster versions: enterprise-server: '>2.21' +topics: + - enterprise --- ### About failover to your replica cluster diff --git a/content/admin/enterprise-management/migrating-from-github-enterprise-1110x-to-2123.md b/content/admin/enterprise-management/migrating-from-github-enterprise-1110x-to-2123.md index 00638ec3d9..f28668eb3a 100644 --- a/content/admin/enterprise-management/migrating-from-github-enterprise-1110x-to-2123.md +++ b/content/admin/enterprise-management/migrating-from-github-enterprise-1110x-to-2123.md @@ -12,6 +12,8 @@ redirect_from: intro: 'To migrate from {% data variables.product.prodname_enterprise %} 11.10.x to 2.1.23, you''ll need to set up a new appliance instance and migrate data from the previous instance.' versions: enterprise-server: '*' +topics: + - enterprise --- Migrations from {% data variables.product.prodname_enterprise %} 11.10.348 and later are supported. Migrating from {% data variables.product.prodname_enterprise %} 11.10.348 and earlier is not supported. You must first upgrade to 11.10.348 in several upgrades. For more information, see the 11.10.348 upgrading procedure, "[Upgrading to the latest release](/enterprise/11.10.340/admin/articles/upgrading-to-the-latest-release/)." @@ -81,7 +83,7 @@ To upgrade to the latest version of {% data variables.product.prodname_enterpris ``` 12. Return to the new instance's restore status screen to see that the restore completed. -![Restore complete screen](/assets/images/enterprise/migration/restore-complete-screen.png) +![Restore complete screen](/assets/images/enterprise/migration/migration-status-complete.png) 13. Click **Continue to settings** to review and adjust the configuration information and settings that were imported from the previous instance. ![Review imported settings](/assets/images/enterprise/migration/migration-status-complete.png) 14. Click **Save settings**. diff --git a/content/admin/enterprise-management/monitoring-cluster-nodes.md b/content/admin/enterprise-management/monitoring-cluster-nodes.md index da5fcdd1c9..4916df38ad 100644 --- a/content/admin/enterprise-management/monitoring-cluster-nodes.md +++ b/content/admin/enterprise-management/monitoring-cluster-nodes.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/enterprise-management/monitoring-cluster-nodes versions: enterprise-server: '*' +topics: + - enterprise --- ### Manually checking cluster status diff --git a/content/admin/enterprise-management/monitoring-using-snmp.md b/content/admin/enterprise-management/monitoring-using-snmp.md index 8038a64e46..bcc5821b39 100644 --- a/content/admin/enterprise-management/monitoring-using-snmp.md +++ b/content/admin/enterprise-management/monitoring-using-snmp.md @@ -7,6 +7,8 @@ redirect_from: - /enterprise/admin/enterprise-management/monitoring-using-snmp versions: enterprise-server: '*' +topics: + - enterprise --- SNMP is a common standard for monitoring devices over a network. We strongly recommend enabling SNMP so you can monitor the health of {% data variables.product.product_location %} and know when to add more memory, storage, or processor power to the host machine. @@ -66,7 +68,7 @@ If you enable SNMP v3, you can take advantage of increased user based security t ##### Querying SNMP data -Both hardware and software-level information about your appliance is available with SNMP v3. Due to the lack of encryption and privacy for the `noAuthNoPriv` and `authNoPriv` security levels, we exclude the `hrSWRun` table (1.1.3.6.1.2.1.25.41) from the resulting SNMP reports. We include this table if you're using the `authPriv` security level. +Both hardware and software-level information about your appliance is available with SNMP v3. Due to the lack of encryption and privacy for the `noAuthNoPriv` and `authNoPriv` security levels, we exclude the `hrSWRun` table (1.3.6.1.2.1.25.4) from the resulting SNMP reports. We include this table if you're using the `authPriv` security level. For more information, see the "[OID reference documentation](http://oidref.com/1.3.6.1.2.1.25.4)." With SNMP v2c, only hardware-level information about your appliance is available. The applications and services within {% data variables.product.prodname_enterprise %} do not have OIDs configured to report metrics. Several MIBs are available, which you can see by running `snmpwalk` on a separate workstation with SNMP support in your network: @@ -76,16 +78,16 @@ With SNMP v2c, only hardware-level information about your appliance is available $ snmpwalk -v 2c -c community-string -O e hostname ``` -Of the available MIBs for SNMP, the most useful is `HOST-RESOURCES-MIB` (.1.3.6.1.2.1.25). See the table below for some important objects in this MIB: +Of the available MIBs for SNMP, the most useful is `HOST-RESOURCES-MIB` (1.3.6.1.2.1.25). See the table below for some important objects in this MIB: | Name | OID | Description | | ---- | --- | ----------- | -| hrSystemDate.2 | .1.3.6.1.2.1.25.1.2 | The hosts notion of the local date and time of day. | -| hrSystemUptime.0 |.1.3.6.1.2.1.25.1.1.0 | How long it's been since the host was last initialized. | -| hrMemorySize.0 | .1.3.6.1.2.1.25.2.2.0 | The amount of RAM on the host. | -| hrSystemProcesses.0 | .1.3.6.1.2.1.25.1.6.0 | The number of process contexts currently loaded or running on the host. | -| hrStorageUsed.1 | .1.3.6.1.2.1.25.2.3.1.6.1 | The amount of storage space consumed on the host, in hrStorageAllocationUnits. | -| hrStorageAllocationUnits.1 | .1.3.6.1.2.1.25.2.3.1.4.1 | The size, in bytes, of an hrStorageAllocationUnit | +| hrSystemDate.2 | 1.3.6.1.2.1.25.1.2 | The hosts notion of the local date and time of day. | +| hrSystemUptime.0 | 1.3.6.1.2.1.25.1.1.0 | How long it's been since the host was last initialized. | +| hrMemorySize.0 | 1.3.6.1.2.1.25.2.2.0 | The amount of RAM on the host. | +| hrSystemProcesses.0 | 1.3.6.1.2.1.25.1.6.0 | The number of process contexts currently loaded or running on the host. | +| hrStorageUsed.1 | 1.3.6.1.2.1.25.2.3.1.6.1 | The amount of storage space consumed on the host, in hrStorageAllocationUnits. | +| hrStorageAllocationUnits.1 | 1.3.6.1.2.1.25.2.3.1.4.1 | The size, in bytes, of an hrStorageAllocationUnit | For example, to query for `hrMemorySize` with SNMP v3, run the following command on a separate workstation with SNMP support in your network: ```shell @@ -108,7 +110,7 @@ snmpget -v 2c -c community-string hostname HOST-RESOURCES-MIB: {% tip %} -**Note:** To prevent leaking information about services running on your appliance, we exclude the `hrSWRun` table (1.1.3.6.1.2.1.25.41) from the resulting SNMP reports unless you're using the `authPriv` security level with SNMP v3. If you're using the `authPriv` security level, we include the `hrSWRun` table. +**Note:** To prevent leaking information about services running on your appliance, we exclude the `hrSWRun` table (1.3.6.1.2.1.25.4) from the resulting SNMP reports unless you're using the `authPriv` security level with SNMP v3. If you're using the `authPriv` security level, we include the `hrSWRun` table. {% endtip %} diff --git a/content/admin/enterprise-management/monitoring-your-appliance.md b/content/admin/enterprise-management/monitoring-your-appliance.md index e8adac6a11..a73f9c02e3 100644 --- a/content/admin/enterprise-management/monitoring-your-appliance.md +++ b/content/admin/enterprise-management/monitoring-your-appliance.md @@ -9,5 +9,7 @@ redirect_from: mapTopic: true versions: enterprise-server: '*' +topics: + - enterprise --- diff --git a/content/admin/enterprise-management/recommended-alert-thresholds.md b/content/admin/enterprise-management/recommended-alert-thresholds.md index ceae6ab760..3898e09a0b 100644 --- a/content/admin/enterprise-management/recommended-alert-thresholds.md +++ b/content/admin/enterprise-management/recommended-alert-thresholds.md @@ -8,6 +8,8 @@ redirect_from: - /enterprise/admin/enterprise-management/recommended-alert-thresholds versions: enterprise-server: '*' +topics: + - enterprise --- ### Monitoring storage diff --git a/content/admin/enterprise-management/recovering-a-high-availability-configuration.md b/content/admin/enterprise-management/recovering-a-high-availability-configuration.md index 879390f390..cc9cd0027e 100644 --- a/content/admin/enterprise-management/recovering-a-high-availability-configuration.md +++ b/content/admin/enterprise-management/recovering-a-high-availability-configuration.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/enterprise-management/recovering-a-high-availability-configuration versions: enterprise-server: '*' +topics: + - enterprise --- You can use the former primary appliance as the new replica appliance if the failover was planned or was not related to the health of the appliance. If the failover was related to an issue with the primary appliance, you may prefer to create a new replica appliance. For more information, see "[Creating a high availability replica](/enterprise/{{ currentVersion }}/admin/guides/installation/creating-a-high-availability-replica/)." diff --git a/content/admin/enterprise-management/removing-a-high-availability-replica.md b/content/admin/enterprise-management/removing-a-high-availability-replica.md index 6002b89d1b..7f3ab841b7 100644 --- a/content/admin/enterprise-management/removing-a-high-availability-replica.md +++ b/content/admin/enterprise-management/removing-a-high-availability-replica.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/enterprise-management/removing-a-high-availability-replica versions: enterprise-server: '*' +topics: + - enterprise --- ### Stopping replication temporarily diff --git a/content/admin/enterprise-management/replacing-a-cluster-node.md b/content/admin/enterprise-management/replacing-a-cluster-node.md index 4dde19d038..2f96afbd7d 100644 --- a/content/admin/enterprise-management/replacing-a-cluster-node.md +++ b/content/admin/enterprise-management/replacing-a-cluster-node.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/enterprise-management/replacing-a-cluster-node versions: enterprise-server: '*' +topics: + - enterprise --- {% warning %} diff --git a/content/admin/enterprise-management/setting-up-external-monitoring.md b/content/admin/enterprise-management/setting-up-external-monitoring.md index f0163ff946..21031f8d8f 100644 --- a/content/admin/enterprise-management/setting-up-external-monitoring.md +++ b/content/admin/enterprise-management/setting-up-external-monitoring.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/enterprise-management/setting-up-external-monitoring versions: enterprise-server: '*' +topics: + - enterprise --- ### About SNMP diff --git a/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources.md b/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources.md index 3c590160d0..b40afca279 100644 --- a/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources.md +++ b/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources.md @@ -9,5 +9,7 @@ redirect_from: mapTopic: true versions: enterprise-server: '*' +topics: + - enterprise --- diff --git a/content/admin/enterprise-management/upgrade-requirements.md b/content/admin/enterprise-management/upgrade-requirements.md index 60da0b3d30..c06792a751 100644 --- a/content/admin/enterprise-management/upgrade-requirements.md +++ b/content/admin/enterprise-management/upgrade-requirements.md @@ -7,6 +7,8 @@ redirect_from: - /enterprise/admin/enterprise-management/upgrade-requirements versions: enterprise-server: '*' +topics: + - enterprise --- {% note %} diff --git a/content/admin/enterprise-management/upgrading-a-cluster.md b/content/admin/enterprise-management/upgrading-a-cluster.md index 1be8e7d8b5..19fd10ebcd 100644 --- a/content/admin/enterprise-management/upgrading-a-cluster.md +++ b/content/admin/enterprise-management/upgrading-a-cluster.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/enterprise-management/upgrading-a-cluster versions: enterprise-server: '*' +topics: + - enterprise --- ### Upgrading with a hotpatch {% data reusables.enterprise_installation.hotpatching-explanation %} The hotpatch installation script installs the hotpatch on every node in the cluster and restarts the services in their proper sequence to avoid downtime. diff --git a/content/admin/enterprise-management/upgrading-github-enterprise-server.md b/content/admin/enterprise-management/upgrading-github-enterprise-server.md index 0b430d3815..a839c03410 100644 --- a/content/admin/enterprise-management/upgrading-github-enterprise-server.md +++ b/content/admin/enterprise-management/upgrading-github-enterprise-server.md @@ -15,6 +15,8 @@ redirect_from: - /enterprise/admin/enterprise-management/upgrading-github-enterprise-server versions: enterprise-server: '*' +topics: + - enterprise --- ### Preparing to upgrade @@ -45,6 +47,12 @@ Increased requirements for {% data variables.product.prodname_ghe_server %} 3.0 | 5,000 to 8000 | **16**
_Up from 12_ | 96 GB | 750 GB | 200 GB | | 8,000 to 10,000+ | **20**
_Up from 16_ | **160 GB**
_Up from 128 GB_ | 1000 GB | 200 GB | +{% if currentVersion ver_gt "enterprise-server@2.21" %} + +For more information about hardware requirements for {% data variables.product.prodname_actions %}, see "[Getting started with {% data variables.product.prodname_actions %} for {% data variables.product.prodname_ghe_server %}](/admin/github-actions/getting-started-with-github-actions-for-github-enterprise-server#review-hardware-considerations)." + +{% endif %} + {% data reusables.enterprise_installation.about-adjusting-resources %} {% endif %} @@ -245,4 +253,4 @@ To roll back from a feature release, restore from a VM snapshot to ensure that r ### Further reading - "[About upgrades to new releases](/admin/overview/about-upgrades-to-new-releases)" -{% endif %} \ No newline at end of file +{% endif %} diff --git a/content/admin/enterprise-support/about-github-enterprise-support.md b/content/admin/enterprise-support/about-github-enterprise-support.md index 696ce3441c..f731cfec52 100644 --- a/content/admin/enterprise-support/about-github-enterprise-support.md +++ b/content/admin/enterprise-support/about-github-enterprise-support.md @@ -6,6 +6,8 @@ redirect_from: versions: enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- {% note %} diff --git a/content/admin/enterprise-support/about-github-premium-support-for-github-enterprise-server.md b/content/admin/enterprise-support/about-github-premium-support-for-github-enterprise-server.md index ecdcf02322..de2131bec7 100644 --- a/content/admin/enterprise-support/about-github-premium-support-for-github-enterprise-server.md +++ b/content/admin/enterprise-support/about-github-premium-support-for-github-enterprise-server.md @@ -7,6 +7,8 @@ redirect_from: - /enterprise/admin/enterprise-support/about-github-premium-support-for-github-enterprise-server versions: enterprise-server: '*' +topics: + - enterprise --- {% note %} diff --git a/content/admin/enterprise-support/about-github-premium-support-for-github-enterprise.md b/content/admin/enterprise-support/about-github-premium-support-for-github-enterprise.md index b55487a008..8553ddf3da 100644 --- a/content/admin/enterprise-support/about-github-premium-support-for-github-enterprise.md +++ b/content/admin/enterprise-support/about-github-premium-support-for-github-enterprise.md @@ -5,6 +5,8 @@ redirect_from: - /enterprise/admin/enterprise-support/about-github-premium-support-for-github-enterprise versions: enterprise-server: '*' +topics: + - enterprise --- {% note %} diff --git a/content/admin/enterprise-support/about-support-for-advanced-security.md b/content/admin/enterprise-support/about-support-for-advanced-security.md index f1eadede3a..d9f8d78ef9 100644 --- a/content/admin/enterprise-support/about-support-for-advanced-security.md +++ b/content/admin/enterprise-support/about-support-for-advanced-security.md @@ -5,6 +5,8 @@ redirect_from: - /enterprise/admin/enterprise-support/about-support-for-advanced-security versions: enterprise-server: '*' +topics: + - enterprise --- {% note %} diff --git a/content/admin/enterprise-support/index.md b/content/admin/enterprise-support/index.md index d6f1ed9191..1393d3bc81 100644 --- a/content/admin/enterprise-support/index.md +++ b/content/admin/enterprise-support/index.md @@ -6,6 +6,8 @@ redirect_from: versions: enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- ### Table of Contents diff --git a/content/admin/enterprise-support/overview.md b/content/admin/enterprise-support/overview.md index 67f3ad9d93..ce8e4498c5 100644 --- a/content/admin/enterprise-support/overview.md +++ b/content/admin/enterprise-support/overview.md @@ -7,4 +7,7 @@ redirect_from: versions: enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- + diff --git a/content/admin/enterprise-support/preparing-to-submit-a-ticket.md b/content/admin/enterprise-support/preparing-to-submit-a-ticket.md index 9c70a25abf..4f0ebdb6d5 100644 --- a/content/admin/enterprise-support/preparing-to-submit-a-ticket.md +++ b/content/admin/enterprise-support/preparing-to-submit-a-ticket.md @@ -6,6 +6,8 @@ redirect_from: versions: enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- Before submitting a ticket, you should: @@ -24,4 +26,4 @@ Especially for tickets with {% data variables.product.support_ticket_priority_ur - Be knowledgeable in your internal systems, tools, policies, and practices. - Be a proficient user of {% data variables.product.product_name %}. - Have full access and permissions to any services that are required to troubleshoot the issue. - - Be authorized to make the recommended changes to your network and any applicable products. \ No newline at end of file + - Be authorized to make the recommended changes to your network and any applicable products. diff --git a/content/admin/enterprise-support/providing-data-to-github-support.md b/content/admin/enterprise-support/providing-data-to-github-support.md index 2bb07afaab..3ea6981372 100644 --- a/content/admin/enterprise-support/providing-data-to-github-support.md +++ b/content/admin/enterprise-support/providing-data-to-github-support.md @@ -8,6 +8,8 @@ redirect_from: - /enterprise/admin/enterprise-support/providing-data-to-github-support versions: enterprise-server: '*' +topics: + - enterprise --- ### Creating and sharing diagnostic files diff --git a/content/admin/enterprise-support/reaching-github-support.md b/content/admin/enterprise-support/reaching-github-support.md index 7cf256ce56..51d55999d7 100644 --- a/content/admin/enterprise-support/reaching-github-support.md +++ b/content/admin/enterprise-support/reaching-github-support.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/enterprise-support/reaching-github-support versions: enterprise-server: '*' +topics: + - enterprise --- ### Using automated ticketing systems diff --git a/content/admin/enterprise-support/receiving-help-from-github-support.md b/content/admin/enterprise-support/receiving-help-from-github-support.md index 98b3cd0eea..c700ae6897 100644 --- a/content/admin/enterprise-support/receiving-help-from-github-support.md +++ b/content/admin/enterprise-support/receiving-help-from-github-support.md @@ -8,4 +8,7 @@ mapTopic: true versions: enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- + diff --git a/content/admin/enterprise-support/submitting-a-ticket.md b/content/admin/enterprise-support/submitting-a-ticket.md index 5f396e34ca..cb16823728 100644 --- a/content/admin/enterprise-support/submitting-a-ticket.md +++ b/content/admin/enterprise-support/submitting-a-ticket.md @@ -6,6 +6,8 @@ redirect_from: versions: enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- ### About submitting a ticket diff --git a/content/admin/github-actions/about-using-actions-on-github-enterprise-server.md b/content/admin/github-actions/about-using-actions-on-github-enterprise-server.md index 3b3b6da7eb..e87d29f61f 100644 --- a/content/admin/github-actions/about-using-actions-on-github-enterprise-server.md +++ b/content/admin/github-actions/about-using-actions-on-github-enterprise-server.md @@ -6,6 +6,8 @@ redirect_from: - /admin/github-actions/about-using-githubcom-actions-on-github-enterprise-server versions: enterprise-server: '>=2.22' +topics: + - enterprise --- {% data reusables.actions.enterprise-beta %} diff --git a/content/admin/github-actions/advanced-configuration-and-troubleshooting.md b/content/admin/github-actions/advanced-configuration-and-troubleshooting.md index fa3f0a4aa7..609640ef99 100644 --- a/content/admin/github-actions/advanced-configuration-and-troubleshooting.md +++ b/content/admin/github-actions/advanced-configuration-and-troubleshooting.md @@ -4,4 +4,7 @@ intro: 'Configure high availability for {% data variables.product.prodname_actio mapTopic: true versions: enterprise-server: '>=3.0' +topics: + - enterprise --- + diff --git a/content/admin/github-actions/backing-up-and-restoring-github-enterprise-server-with-github-actions-enabled.md b/content/admin/github-actions/backing-up-and-restoring-github-enterprise-server-with-github-actions-enabled.md index a2556020e8..1a687f2e87 100644 --- a/content/admin/github-actions/backing-up-and-restoring-github-enterprise-server-with-github-actions-enabled.md +++ b/content/admin/github-actions/backing-up-and-restoring-github-enterprise-server-with-github-actions-enabled.md @@ -4,6 +4,8 @@ shortTitle: Backing up and restoring intro: '{% data variables.product.prodname_actions %} data on your external storage provider is not included in regular {% data variables.product.prodname_ghe_server %} backups, and must be backed up separately.' versions: enterprise-server: '>=3.0' +topics: + - enterprise --- {% data reusables.actions.enterprise-storage-ha-backups %} diff --git a/content/admin/github-actions/enabling-automatic-access-to-githubcom-actions-using-github-connect.md b/content/admin/github-actions/enabling-automatic-access-to-githubcom-actions-using-github-connect.md index 5be9397384..8235057e02 100644 --- a/content/admin/github-actions/enabling-automatic-access-to-githubcom-actions-using-github-connect.md +++ b/content/admin/github-actions/enabling-automatic-access-to-githubcom-actions-using-github-connect.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/github-actions/enabling-automatic-access-to-githubcom-actions-using-github-connect versions: enterprise-server: '>=2.22' +topics: + - enterprise --- {% data reusables.actions.enterprise-beta %} diff --git a/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server.md b/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server.md index 886b40a786..1ab36ce2a1 100644 --- a/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server.md +++ b/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server.md @@ -4,4 +4,7 @@ intro: 'Learn how to configure storage and enable {% data variables.product.prod mapTopic: true versions: enterprise-server: '>=2.22' +topics: + - enterprise --- + diff --git a/content/admin/github-actions/enabling-github-actions-with-amazon-s3-storage.md b/content/admin/github-actions/enabling-github-actions-with-amazon-s3-storage.md index 1e94369d98..f545d49494 100644 --- a/content/admin/github-actions/enabling-github-actions-with-amazon-s3-storage.md +++ b/content/admin/github-actions/enabling-github-actions-with-amazon-s3-storage.md @@ -4,6 +4,8 @@ intro: 'You can enable {% data variables.product.prodname_actions %} on {% data permissions: 'Site administrators can enable {% data variables.product.prodname_actions %} and configure enterprise settings.' versions: enterprise-server: '>=3.0' +topics: + - enterprise --- ### Prerequisites diff --git a/content/admin/github-actions/enabling-github-actions-with-azure-blob-storage.md b/content/admin/github-actions/enabling-github-actions-with-azure-blob-storage.md index a9b21f3001..1245137438 100644 --- a/content/admin/github-actions/enabling-github-actions-with-azure-blob-storage.md +++ b/content/admin/github-actions/enabling-github-actions-with-azure-blob-storage.md @@ -4,6 +4,8 @@ intro: 'You can enable {% data variables.product.prodname_actions %} on {% data permissions: 'Site administrators can enable {% data variables.product.prodname_actions %} and configure enterprise settings.' versions: enterprise-server: '>=3.0' +topics: + - enterprise --- ### Prerequisites diff --git a/content/admin/github-actions/enabling-github-actions-with-minio-gateway-for-nas-storage.md b/content/admin/github-actions/enabling-github-actions-with-minio-gateway-for-nas-storage.md index d86f1a64b5..ba2c6c47ab 100644 --- a/content/admin/github-actions/enabling-github-actions-with-minio-gateway-for-nas-storage.md +++ b/content/admin/github-actions/enabling-github-actions-with-minio-gateway-for-nas-storage.md @@ -4,6 +4,8 @@ intro: 'You can enable {% data variables.product.prodname_actions %} on {% data permissions: 'Site administrators can enable {% data variables.product.prodname_actions %} and configure enterprise settings.' versions: enterprise-server: '>=3.0' +topics: + - enterprise --- ### Prerequisites diff --git a/content/admin/github-actions/enforcing-github-actions-policies-for-your-enterprise.md b/content/admin/github-actions/enforcing-github-actions-policies-for-your-enterprise.md index d47cc8b225..b9f5e4fcf2 100644 --- a/content/admin/github-actions/enforcing-github-actions-policies-for-your-enterprise.md +++ b/content/admin/github-actions/enforcing-github-actions-policies-for-your-enterprise.md @@ -5,13 +5,17 @@ redirect_from: - /enterprise/admin/github-actions/enforcing-github-actions-policies-for-your-enterprise versions: enterprise-server: '>=2.22' + github-ae: '*' +topics: + - enterprise --- +{% data reusables.actions.ae-beta %} {% data reusables.actions.enterprise-beta %} ### About {% data variables.product.prodname_actions %} permissions for your enterprise -When you enable {% data variables.product.prodname_actions %} on {% data variables.product.prodname_ghe_server %}, it is enabled for all organizations in your enterprise. You can choose to disable {% data variables.product.prodname_actions %} for all organizations in your enterprise, or only allow specific organizations. You can also limit the use of public actions, so that people can only use local actions that exist in your enterprise. +{% if currentVersion == "github-ae@latest" %}{% else %}When you enable {% data variables.product.prodname_actions %} on {% data variables.product.prodname_ghe_server %}, it is enabled for all organizations in your enterprise. {% endif %}You can choose to disable {% data variables.product.prodname_actions %} for all organizations in your enterprise, or only allow specific organizations. You can also limit the use of public actions, so that people can only use local actions that exist in your enterprise. ### Managing {% data variables.product.prodname_actions %} permissions for your enterprise @@ -20,7 +24,7 @@ When you enable {% data variables.product.prodname_actions %} on {% data variabl {% data reusables.enterprise-accounts.actions-tab %} {% data reusables.actions.enterprise-actions-permissions %} -{% if currentVersion ver_gt "enterprise-server@2.22" %} +{% if currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest"%} ### Enabling workflows for private repository forks {% data reusables.github-actions.private-repository-forks-overview %} diff --git a/content/admin/github-actions/getting-started-with-github-actions-for-github-ae.md b/content/admin/github-actions/getting-started-with-github-actions-for-github-ae.md new file mode 100644 index 0000000000..4ce90c5b50 --- /dev/null +++ b/content/admin/github-actions/getting-started-with-github-actions-for-github-ae.md @@ -0,0 +1,30 @@ +--- +title: Getting started with GitHub Actions for GitHub AE +intro: 'Learn configuring {% data variables.product.prodname_actions %} on {% data variables.product.prodname_ghe_managed %}.' +permissions: 'Site administrators can enable {% data variables.product.prodname_actions %} and configure enterprise settings.' +versions: + github-ae: '*' +--- + +{% data reusables.actions.ae-beta %} + +This article explains how site administrators can configure {% data variables.product.prodname_ghe_managed %} to use {% data variables.product.prodname_actions %}. + +### Managing access permissions for {% data variables.product.prodname_actions %} in your enterprise + +You can use policies to manage access to {% data variables.product.prodname_actions %}. For more information, see "[Enforcing GitHub Actions policies for your enterprise](/admin/github-actions/enforcing-github-actions-policies-for-your-enterprise)." + +### Adding runners + +{% note %} + +**Note:** To add {% data variables.actions.hosted_runner %}s to {% data variables.product.prodname_ghe_managed %}, you will need to contact {% data variables.product.prodname_dotcom %} support. + +{% endnote %} + +To run {% data variables.product.prodname_actions %} workflows, you need to add runners. You can add runners at the enterprise, organization, or repository levels. For more information, see "[About {% data variables.actions.hosted_runner %}s](/actions/using-github-hosted-runners/about-ae-hosted-runners)." + + +### General security hardening for {% data variables.product.prodname_actions %} + +If you want to learn more about security practices for {% data variables.product.prodname_actions %}, see "[Security hardening for {% data variables.product.prodname_actions %}](/actions/learn-github-actions/security-hardening-for-github-actions)." diff --git a/content/admin/github-actions/getting-started-with-github-actions-for-github-enterprise-server.md b/content/admin/github-actions/getting-started-with-github-actions-for-github-enterprise-server.md index 67f797d751..4cba468196 100644 --- a/content/admin/github-actions/getting-started-with-github-actions-for-github-enterprise-server.md +++ b/content/admin/github-actions/getting-started-with-github-actions-for-github-enterprise-server.md @@ -7,6 +7,8 @@ redirect_from: - /admin/github-actions/enabling-github-actions-and-configuring-storage versions: enterprise-server: '>=2.22' +topics: + - enterprise --- {% data reusables.actions.enterprise-beta %} @@ -31,9 +33,20 @@ This article explains how site administrators can configure {% data variables.pr {% endif %} -{% data reusables.actions.enterprise-hardware-considerations %} +The CPU and memory resources available to {% data variables.product.product_location %} determine the maximum job throughput for {% data variables.product.prodname_actions %}. -For more information about resource requirements for {% data variables.product.prodname_ghe_server %}, see the hardware considerations for your instance's platform. +Internal testing at {% data variables.product.company_short %} demonstrated the following maximum throughput for {% data variables.product.prodname_ghe_server %} instances with a range of CPU and memory configurations. You may see different throughput depending on the overall levels of activity on your instance. + +| vCPUs | Memory | Maximum job throughput | +| :--- | :--- | :--- | +| 4 | 32 GB | Demo or light testing | +| 8 | 64 GB | 25 jobs | +| 16 | 160 GB | 35 jobs | +| 32 | 256 GB | 100 jobs | + +If you {% if currentVersion == "enterprise-server@2.22" %}enabled the beta of{% else %}plan to enable{% endif %} {% data variables.product.prodname_actions %} for the users of an existing instance, review the levels of activity for users and automations on the instance and ensure that you have provisioned adequate CPU and memory for your users. For more information about monitoring the capacity and performance of {% data variables.product.prodname_ghe_server %}, see "[Monitoring your appliance](/admin/enterprise-management/monitoring-your-appliance)." + +For more information about minimum hardware requirements for {% data variables.product.product_location %}, see the hardware considerations for your instance's platform. - [AWS](/admin/installation/installing-github-enterprise-server-on-aws#hardware-considerations) - [Azure](/admin/installation/installing-github-enterprise-server-on-azure#hardware-considerations) diff --git a/content/admin/github-actions/high-availability-for-github-actions.md b/content/admin/github-actions/high-availability-for-github-actions.md index 26ccc90fba..c893e6c059 100644 --- a/content/admin/github-actions/high-availability-for-github-actions.md +++ b/content/admin/github-actions/high-availability-for-github-actions.md @@ -3,6 +3,8 @@ title: High availability for GitHub Actions intro: 'There are some special considerations for administering {% data variables.product.prodname_actions %} in a high availability configuration.' versions: enterprise-server: '>=3.0' +topics: + - enterprise --- ### Replication or redundancy of your {% data variables.product.prodname_actions %} data diff --git a/content/admin/github-actions/index.md b/content/admin/github-actions/index.md index 55495f30bc..6caf9cf8e2 100644 --- a/content/admin/github-actions/index.md +++ b/content/admin/github-actions/index.md @@ -1,17 +1,25 @@ --- title: Managing GitHub Actions for your enterprise -intro: 'Enable {% data variables.product.prodname_actions %} on {% data variables.product.prodname_ghe_server %}, and manage {% data variables.product.prodname_actions %} policies and settings.' +intro: 'Enable {% data variables.product.prodname_actions %} on {% if currentVersion == "github-ae@latest" %}{% data variables.product.prodname_ghe_managed %}{% else %}{% data variables.product.prodname_ghe_server %}{% endif %}, and manage {% data variables.product.prodname_actions %} policies and settings.' redirect_from: - /enterprise/admin/github-actions versions: enterprise-server: '>=2.22' + github-ae: '*' +topics: + - enterprise --- +{% data reusables.actions.ae-beta %} {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} ### Table of Contents +{% topic_link_in_list /using-github-actions-in-github-ae %} + {% link_in_list /getting-started-with-github-actions-for-github-ae %} + {% link_in_list /using-actions-in-github-ae %} + {% topic_link_in_list /enabling-github-actions-for-github-enterprise-server %} {% link_in_list /getting-started-with-github-actions-for-github-enterprise-server %} {% link_in_list /enabling-github-actions-with-azure-blob-storage %} diff --git a/content/admin/github-actions/managing-access-to-actions-from-githubcom.md b/content/admin/github-actions/managing-access-to-actions-from-githubcom.md index 51d601c89f..78e01a4ca3 100644 --- a/content/admin/github-actions/managing-access-to-actions-from-githubcom.md +++ b/content/admin/github-actions/managing-access-to-actions-from-githubcom.md @@ -6,5 +6,7 @@ redirect_from: - /enterprise/admin/github-actions/managing-access-to-actions-from-githubcom versions: enterprise-server: '>=2.22' +topics: + - enterprise --- diff --git a/content/admin/github-actions/manually-syncing-actions-from-githubcom.md b/content/admin/github-actions/manually-syncing-actions-from-githubcom.md index f36947c4bc..3f8f07e6ba 100644 --- a/content/admin/github-actions/manually-syncing-actions-from-githubcom.md +++ b/content/admin/github-actions/manually-syncing-actions-from-githubcom.md @@ -5,6 +5,8 @@ redirect_from: - /enterprise/admin/github-actions/manually-syncing-actions-from-githubcom versions: enterprise-server: '>=2.22' +topics: + - enterprise --- {% data reusables.actions.enterprise-beta %} diff --git a/content/admin/github-actions/setting-up-the-tool-cache-on-self-hosted-runners-without-internet-access.md b/content/admin/github-actions/setting-up-the-tool-cache-on-self-hosted-runners-without-internet-access.md index dfc57ac64b..a380a9961e 100644 --- a/content/admin/github-actions/setting-up-the-tool-cache-on-self-hosted-runners-without-internet-access.md +++ b/content/admin/github-actions/setting-up-the-tool-cache-on-self-hosted-runners-without-internet-access.md @@ -5,6 +5,8 @@ redirect_from: - /enterprise/admin/github-actions/setting-up-the-tool-cache-on-self-hosted-runners-without-internet-access versions: enterprise-server: '>=2.22' +topics: + - enterprise --- {% data reusables.actions.enterprise-beta %} diff --git a/content/admin/github-actions/troubleshooting-github-actions-for-your-enterprise.md b/content/admin/github-actions/troubleshooting-github-actions-for-your-enterprise.md index df08b0d047..5ef91e72d9 100644 --- a/content/admin/github-actions/troubleshooting-github-actions-for-your-enterprise.md +++ b/content/admin/github-actions/troubleshooting-github-actions-for-your-enterprise.md @@ -4,6 +4,8 @@ intro: 'Troubleshooting common issues that occur when using {% data variables.pr permissions: 'Site administrators can troubleshoot {% data variables.product.prodname_actions %} issues and modify {% data variables.product.prodname_ghe_server %} configurations.' versions: enterprise-server: '>=3.0' +topics: + - enterprise --- ### Configuring self-hosted runners when using a self-signed certificate for {% data variables.product.prodname_ghe_server %} diff --git a/content/admin/github-actions/using-a-staging-environment.md b/content/admin/github-actions/using-a-staging-environment.md index f2d387de55..d463c8a01c 100644 --- a/content/admin/github-actions/using-a-staging-environment.md +++ b/content/admin/github-actions/using-a-staging-environment.md @@ -3,6 +3,8 @@ title: Using a staging environment intro: 'Learn about using {% data variables.product.prodname_actions %} with {% data variables.product.prodname_ghe_server %} staging environments.' versions: enterprise-server: '>=3.0' +topics: + - enterprise --- It can be useful to have a staging or testing environment for {% data variables.product.product_location %}, so that you can test updates or new features before implementing them in your production environment. diff --git a/content/admin/github-actions/using-actions-in-github-ae.md b/content/admin/github-actions/using-actions-in-github-ae.md new file mode 100644 index 0000000000..4aa01e4d4e --- /dev/null +++ b/content/admin/github-actions/using-actions-in-github-ae.md @@ -0,0 +1,20 @@ +--- +title: Using actions in GitHub AE +intro: '{% data variables.product.prodname_ghe_managed %} includes most of the {% data variables.product.prodname_dotcom %}-authored actions.' +versions: + github-ae: '*' +--- + +{% data reusables.actions.ae-beta %} + +{% data variables.product.prodname_actions %} workflows can use _actions_, which are individual tasks that you can combine to create jobs and customize your workflow. You can create your own actions, or use and customize actions shared by the {% data variables.product.prodname_dotcom %} community. + +### Official actions bundled with {% data variables.product.prodname_ghe_managed %} + +Most official {% data variables.product.prodname_dotcom %}-authored actions are automatically bundled with {% data variables.product.prodname_ghe_managed %}, and are captured at a point in time from {% data variables.product.prodname_marketplace %}. When your {% data variables.product.prodname_ghe_managed %} instance is updated, the bundled official actions are also updated. + +The bundled official actions include `actions/checkout`, `actions/upload-artifact`, `actions/download-artifact`, `actions/labeler`, and various `actions/setup-` actions, among others. To see which of the official actions are included, browse to the following organizations on your instance: +- https://HOSTNAME/actions +- https://HOSTNAME/github + +Each action's files are kept in a repository in the `actions` and `github` organizations. Each action repository includes the necessary tags, branches, and commit SHAs that your workflows can use to reference the action. diff --git a/content/admin/github-actions/using-github-actions-in-github-ae.md b/content/admin/github-actions/using-github-actions-in-github-ae.md new file mode 100644 index 0000000000..9c05715d11 --- /dev/null +++ b/content/admin/github-actions/using-github-actions-in-github-ae.md @@ -0,0 +1,7 @@ +--- +title: Using GitHub Actions in GitHub AE +intro: 'Learn how to configure {% data variables.product.prodname_actions %} on {% data variables.product.prodname_ghe_managed %}.' +mapTopic: true +versions: + github-ae: '*' +--- diff --git a/content/admin/installation/index.md b/content/admin/installation/index.md index ca489927cc..582246e33e 100644 --- a/content/admin/installation/index.md +++ b/content/admin/installation/index.md @@ -11,6 +11,8 @@ redirect_from: - /enterprise/admin/installation versions: enterprise-server: '*' +topics: + - enterprise --- For more information, or to purchase {% data variables.product.prodname_enterprise %}, see [{% data variables.product.prodname_enterprise %}](https://github.com/enterprise). diff --git a/content/admin/installation/installing-github-enterprise-server-on-aws.md b/content/admin/installation/installing-github-enterprise-server-on-aws.md index 50d3baa627..f6de6fe0ee 100644 --- a/content/admin/installation/installing-github-enterprise-server-on-aws.md +++ b/content/admin/installation/installing-github-enterprise-server-on-aws.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/installation/installing-github-enterprise-server-on-aws versions: enterprise-server: '*' +topics: + - enterprise --- ### Prerequisites diff --git a/content/admin/installation/installing-github-enterprise-server-on-azure.md b/content/admin/installation/installing-github-enterprise-server-on-azure.md index be1006b3f7..008413e67e 100644 --- a/content/admin/installation/installing-github-enterprise-server-on-azure.md +++ b/content/admin/installation/installing-github-enterprise-server-on-azure.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/installation/installing-github-enterprise-server-on-azure versions: enterprise-server: '*' +topics: + - enterprise --- You can deploy {% data variables.product.prodname_ghe_server %} on global Azure or Azure Government. diff --git a/content/admin/installation/installing-github-enterprise-server-on-google-cloud-platform.md b/content/admin/installation/installing-github-enterprise-server-on-google-cloud-platform.md index e21838d06a..6f80158971 100644 --- a/content/admin/installation/installing-github-enterprise-server-on-google-cloud-platform.md +++ b/content/admin/installation/installing-github-enterprise-server-on-google-cloud-platform.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/installation/installing-github-enterprise-server-on-google-cloud-platform versions: enterprise-server: '*' +topics: + - enterprise --- ### Prerequisites diff --git a/content/admin/installation/installing-github-enterprise-server-on-hyper-v.md b/content/admin/installation/installing-github-enterprise-server-on-hyper-v.md index 42a146e2f9..eded2b581a 100644 --- a/content/admin/installation/installing-github-enterprise-server-on-hyper-v.md +++ b/content/admin/installation/installing-github-enterprise-server-on-hyper-v.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/installation/installing-github-enterprise-server-on-hyper-v versions: enterprise-server: '*' +topics: + - enterprise --- ### Prerequisites diff --git a/content/admin/installation/installing-github-enterprise-server-on-openstack-kvm.md b/content/admin/installation/installing-github-enterprise-server-on-openstack-kvm.md index 2695c4d612..79453ba7f6 100644 --- a/content/admin/installation/installing-github-enterprise-server-on-openstack-kvm.md +++ b/content/admin/installation/installing-github-enterprise-server-on-openstack-kvm.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/installation/installing-github-enterprise-server-on-openstack-kvm versions: enterprise-server: '*' +topics: + - enterprise --- ### Prerequisites diff --git a/content/admin/installation/installing-github-enterprise-server-on-vmware.md b/content/admin/installation/installing-github-enterprise-server-on-vmware.md index ce4f58e9bb..0646a0cdea 100644 --- a/content/admin/installation/installing-github-enterprise-server-on-vmware.md +++ b/content/admin/installation/installing-github-enterprise-server-on-vmware.md @@ -9,6 +9,8 @@ redirect_from: - /enterprise/admin/installation/installing-github-enterprise-server-on-vmware versions: enterprise-server: '*' +topics: + - enterprise --- ### Prerequisites diff --git a/content/admin/installation/installing-github-enterprise-server-on-xenserver.md b/content/admin/installation/installing-github-enterprise-server-on-xenserver.md index fb0341074d..7b87108661 100644 --- a/content/admin/installation/installing-github-enterprise-server-on-xenserver.md +++ b/content/admin/installation/installing-github-enterprise-server-on-xenserver.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/installation/installing-github-enterprise-server-on-xenserver versions: enterprise-server: '*' +topics: + - enterprise --- ### Prerequisites diff --git a/content/admin/installation/setting-up-a-github-enterprise-server-instance.md b/content/admin/installation/setting-up-a-github-enterprise-server-instance.md index 92a5f510c9..865536adbe 100644 --- a/content/admin/installation/setting-up-a-github-enterprise-server-instance.md +++ b/content/admin/installation/setting-up-a-github-enterprise-server-instance.md @@ -10,5 +10,7 @@ redirect_from: mapTopic: true versions: enterprise-server: '*' +topics: + - enterprise --- diff --git a/content/admin/installation/setting-up-a-staging-instance.md b/content/admin/installation/setting-up-a-staging-instance.md index 972f5439d3..082e71f7fe 100644 --- a/content/admin/installation/setting-up-a-staging-instance.md +++ b/content/admin/installation/setting-up-a-staging-instance.md @@ -5,6 +5,8 @@ redirect_from: - /enterprise/admin/installation/setting-up-a-staging-instance versions: enterprise-server: '*' +topics: + - enterprise --- {% tip %} @@ -28,4 +30,4 @@ To thoroughly test a {% data variables.product.prodname_ghe_server %} appliance ### Further reading - "[About upgrades to new releases](/admin/overview/about-upgrades-to-new-releases)" -{% endif %} \ No newline at end of file +{% endif %} diff --git a/content/admin/overview/about-data-residency.md b/content/admin/overview/about-data-residency.md new file mode 100644 index 0000000000..a83066177e --- /dev/null +++ b/content/admin/overview/about-data-residency.md @@ -0,0 +1,12 @@ +--- +title: About data residency +intro: You can choose the geography where {% data variables.product.product_name %} stores all customer data for your enterprise. +versions: + github-ae: '*' +--- + +{% data reusables.github-ae.github-ae-enables-you %} You can choose the geography where you store all the customer data for {% data variables.product.product_location %}, and members of your enterprise can access {% data variables.product.product_name %} from anywhere in the world. + +When creating your enterprise, you can tell {% data variables.contact.contact_enterprise_sales %} where to store your customer data. {% data variables.product.company_short %} will not store or move any of your enterprise's data outside of the geography you choose. + +For more information about the available geographies, contact {% data variables.contact.contact_enterprise_sales %}. diff --git a/content/admin/overview/about-enterprise-accounts.md b/content/admin/overview/about-enterprise-accounts.md index 4c37b9eed5..42352b9ac1 100644 --- a/content/admin/overview/about-enterprise-accounts.md +++ b/content/admin/overview/about-enterprise-accounts.md @@ -7,6 +7,8 @@ redirect_from: versions: enterprise-server: '>=2.20' github-ae: '*' +topics: + - enterprise --- ### About enterprise accounts on {% data variables.product.product_name %} diff --git a/content/admin/overview/about-github-ae.md b/content/admin/overview/about-github-ae.md index d143dd1af0..a864f01f38 100644 --- a/content/admin/overview/about-github-ae.md +++ b/content/admin/overview/about-github-ae.md @@ -1,17 +1,15 @@ --- title: About GitHub AE -intro: '{% data variables.product.prodname_ghe_managed %} is the most secure and compliant way to use {% data variables.product.prodname_dotcom %}.' +intro: '{% data variables.product.prodname_ghe_managed %} is a security-enhanced and compliant way to use {% data variables.product.prodname_dotcom %} in the cloud.' versions: github-ae: '*' --- ### About {% data variables.product.prodname_ghe_managed %} -{% data reusables.github-ae.github-ae-enables-you %} +{% data reusables.github-ae.github-ae-enables-you %} {% data variables.product.prodname_ghe_managed %} is fully managed, reliable, and scalable, allowing you to accelerate delivery without sacrificing risk management. -{% data variables.product.prodname_ghe_managed %} offers one developer platform from idea to production. You can increase developer velocity, automate entire workflows, secure your code, and collaborate in developers’ favorite tool. - -{% data variables.product.prodname_ghe_managed %} provides your organization with all the power of [{% data variables.product.prodname_enterprise %}](https://github.com/enterprise). With {% data variables.product.prodname_ghe_managed %}, you can also meet security and compliance goals with a suite of features and certifications that put you in control. +{% data variables.product.prodname_ghe_managed %} offers one developer platform from idea to production. You can increase development velocity with the tools that teams know and love, while you maintain industry and regulatory compliance with unique security and access controls, workflow automation, and policy enforcement. ### A highly available and planet-scale cloud @@ -36,11 +34,3 @@ Secure access to your enterprise on {% data variables.product.prodname_ghe_manag ### Commercial and government environments {% data variables.product.prodname_ghe_managed %} is available in the Azure Government cloud, the trusted cloud for US government agencies and their partners. {% data variables.product.prodname_ghe_managed %} is also available in the commercial cloud, so you can choose the hosting environment that is right for your organization. - -### Premium Plus support - -Premium Plus support is available for all {% data variables.product.prodname_ghe_managed %} customers, to ensure you have the fastest and most personal support experience. A dedicated Account Manager will work with you to help you get the most out of {% data variables.product.prodname_dotcom %}. Our support team will resolve issues any time of day, in the shortest possible time. - -### About billing for {% data variables.product.prodname_ghe_managed %} - -{% data reusables.github-ae.about-billing %} For more information, see "[Managing billing for your enterprise](/admin/overview/managing-billing-for-your-enterprise)." \ No newline at end of file diff --git a/content/admin/overview/about-the-github-enterprise-api.md b/content/admin/overview/about-the-github-enterprise-api.md index 8f75a39a07..d79b6c703a 100644 --- a/content/admin/overview/about-the-github-enterprise-api.md +++ b/content/admin/overview/about-the-github-enterprise-api.md @@ -11,6 +11,8 @@ redirect_from: versions: enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- With the APIs, you can automate many administrative tasks. Some examples include: diff --git a/content/admin/overview/about-upgrades-to-new-releases.md b/content/admin/overview/about-upgrades-to-new-releases.md index 19b7d28e7f..475fea0e5f 100644 --- a/content/admin/overview/about-upgrades-to-new-releases.md +++ b/content/admin/overview/about-upgrades-to-new-releases.md @@ -1,14 +1,19 @@ --- title: About upgrades to new releases shortTitle: About upgrades -intro: 'You can benefit from new features and bug fixes for {% data variables.product.product_name %} by upgrading your enterprise to a newly released version.' +intro: '{% if currentVersion == "github-ae@latest" %}Your {% data variables.product.product_name %} enterprise is updated with the latest features and bug fixes on a regular basis by {% data variables.product.company_short %}.{% else %}You can benefit from new features and bug fixes for {% data variables.product.product_name %} by upgrading your enterprise to a newly released version.{% endif %}' versions: enterprise-server: '>=3.0' + github-ae: '*' +topics: + - enterprise --- -{% data variables.product.product_name %} is constantly improving, with new functionality and bug fixes introduced through major and minor releases. +{% data variables.product.product_name %} is constantly improving, with new functionality and bug fixes introduced through major and minor releases. {% if currentVersion == "github-ae@latest" %}{% data variables.product.prodname_ghe_managed %} is a fully managed service, so {% data variables.product.company_short %} completes the upgrade process for your enterprise.{% endif %} -Major releases include new functionality and feature upgrades and typically occur quarterly. +Major releases include new functionality and feature upgrades and typically occur {% if currentVersion == "github-ae@latest" %}every few weeks or months{% else %} quarterly{% endif %}. {% if currentVersion == "github-ae@latest" %}{% data variables.product.company_short %} will upgrade your enterprise to the latest major release. You will be given advance notice of any planned downtime for your enterprise.{% endif %} + +{% if enterpriseServerVersions contains currentVersion %} Starting with {% data variables.product.prodname_ghe_server %} 3.0, all major releases begin with at least one release candidate. Release candidates are proposed major releases, with a complete feature set. There may be bugs or issues in a release candidate which can only be found through feedback from customers actually using {% data variables.product.product_name %}. @@ -18,16 +23,25 @@ Release candidates should be deployed on test or staging environments. As you te We'll use your feedback to apply bug fixes and any other necessary changes to create a stable production release. Each new release candidate adds bug fixes for issues found in prior versions. When the release is ready for widespread adoption, {% data variables.product.company_short %} publishes a stable production release. +{% endif %} + {% warning %} **Warning**: The upgrade to a new major release will cause a few hours of downtime, during which none of your users will be able to use the enterprise. You can inform your users about downtime by publishing a global announcement banner, using your enterprise settings or the REST API. For more information, see "[Customizing user messages on your instance](/admin/user-management/customizing-user-messages-on-your-instance#creating-a-global-announcement-banner)" and "[{% data variables.product.prodname_enterprise %} administration](/rest/reference/enterprise-admin#announcements)." {% endwarning %} +{% if enterpriseServerVersions contains currentVersion %} + Minor releases, which consist of hot patches and bug fixes only, happen more frequently. Minor releases are generally available when first released, with no release candidates. Upgrading to a minor release typically requires less than five minutes of downtime. To upgrade your enterprise to a new release, see "[Release notes](/enterprise-server/admin/release-notes)" and "[Upgrading {% data variables.product.prodname_ghe_server %}](/admin/enterprise-management/upgrading-github-enterprise-server)." +{% endif %} + ### Further reading - [ {% data variables.product.prodname_roadmap %} ]( {% data variables.product.prodname_roadmap_link %} ) in the `github/roadmap` repository +{% if currentVersion == "github-ae@latest" %} +- [ {% data variables.product.prodname_ghe_managed %} release notes](/admin/overview/github-ae-release-notes) +{% endif %} diff --git a/content/admin/overview/github-ae-release-notes.md b/content/admin/overview/github-ae-release-notes.md new file mode 100644 index 0000000000..38a619fc8e --- /dev/null +++ b/content/admin/overview/github-ae-release-notes.md @@ -0,0 +1,89 @@ +--- +title: GitHub AE release notes +intro: March 1, 2021 +versions: + github-ae: '*' +--- + +### Features + +#### {% data variables.product.prodname_actions %} beta + +[{% data variables.product.prodname_actions %}](https://github.com/features/actions) is a powerful, flexible solution for CI/CD and workflow automation. For more information, see "[Introduction to {% data variables.product.prodname_actions %}](/actions/learn-github-actions/introduction-to-github-actions)." + +{% data variables.product.prodname_actions %} on {% data variables.product.product_name %} uses a new [{% data variables.actions.hosted_runner %}](/actions/using-github-hosted-runners/about-ae-hosted-runners), only available for {% data variables.product.product_name %}, that enables you to customize the size, image, and networking configuration of the runners. These runners are a finished-service CI compute environment with auto-scaling and management, fully managed by {% data variables.product.company_short %}. During the beta, the use {% data variables.actions.hosted_runner %}s is free of charge. For more information, see "[Adding {% data variables.actions.hosted_runner %}s](/actions/using-github-hosted-runners/adding-ae-hosted-runners)." + +Please note that when {% data variables.product.prodname_actions %} is enabled during this upgrade, two organizations named "GitHub Actions" (@**actions** and @**github**) will appear in {% data variables.product.product_location %}. These organizations are required by {% data variables.product.prodname_actions %}. Users named @**ghost** and @**actions** appear as the actors for creation of these organizations in the audit log. + +#### {% data variables.product.prodname_registry %} beta + +[{% data variables.product.prodname_registry %}](https://github.com/features/packages) is a package hosting service, natively integrated with {% data variables.product.prodname_actions %}, APIs, and webhooks. Create an [end-to-end DevOps workflow](/github-ae@latest/packages/quickstart) that includes your code, continuous integration, and deployment solutions. For more information, see "[About {% data variables.product.prodname_registry %}](/packages/learn-github-packages/about-github-packages)." + +During this beta, {% data variables.product.prodname_registry %} is free of charge to {% data variables.product.product_name %} customers. + +#### {% data variables.product.prodname_GH_advanced_security %} beta + +{% data variables.product.prodname_GH_advanced_security %} is available in beta and includes both {% data variables.product.prodname_code_scanning %} and {% data variables.product.prodname_secret_scanning %}. Repository administrators and organization owners can opt into {% data variables.product.prodname_advanced_security %} features in the settings for a repository or organization, within the **Security and analysis** tab. For more information, see "[About {% data variables.product.prodname_GH_advanced_security %}](/github/getting-started-with-github/about-github-advanced-security)." + +During this beta, {% data variables.product.prodname_advanced_security %} features are free of charge to {% data variables.product.product_name %} customers. + +#### Manage teams from your identity provider (IdP) + +Customers using SCIM (System for Cross-domain Identity Management) can now sync security groups in Azure Active Directory with {% data variables.product.company_short %} teams. Once a team has been linked to a security group, membership will be automatically updated in {% data variables.product.product_name %} when a user is added or removed from their assigned security group. For more information, see "[Synchronizing a team with an identity provider group](/github/setting-up-and-managing-organizations-and-teams/synchronizing-a-team-with-an-identity-provider-group)." + +#### IP allow lists beta + +Enterprise and organization owners can now use IP allow lists to restrict traffic to the enterprise or specific organizations. After you configure an IP allow list, only visitors from IP addresses on the list are permitted to access the resources protected by the list. + +This functionality is provided in addition to the ability to request network security group changes that filter traffic to the entirety of the {% data variables.product.product_name %} tenant. + +For more information, see "[Restricting network traffic to your enterprise](/admin/configuration/restricting-network-traffic-to-your-enterprise)" and "[Managing allowed IP addresses for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-allowed-ip-addresses-for-your-organization)." + +#### Pull request auto-merge + +With auto-merge, pull requests can be set to merge automatically when all merge requirements have been satisfied. This saves users from needing to constantly check the state of their pull requests just to merge them. Auto-merge can be enabled by a user with permission to merge and on pull requests that have unsatisfied merge requirements (like missing approvals or pending or failing required status checks). For more information, see "[Automatically merging a pull request](/github/collaborating-with-issues-and-pull-requests/automatically-merging-a-pull-request)." + +### Changes + +#### Developer changes + +- [Organization owners can now disable publication](/github/setting-up-and-managing-organizations-and-teams/managing-the-publication-of-github-pages-sites-for-your-organization) of {% data variables.product.prodname_pages %} sites from repositories in the organization. This will not unpublish existing sites. +- Repositories that use {% data variables.product.prodname_pages %} can now [build and deploy from any branch](/github/working-with-github-pages/about-github-pages#publishing-sources-for-github-pages-sites). +- When writing an issue or pull request, the list syntax for bullets, numbers, and tasks will now be autocompleted after you press `return` or `enter`. +- You can now delete a directory in a repository from the repository page. When navigating to a directory, a new kebab button next to the "Add file" button gives the option to delete the directory. +- It’s now easier and faster to [reference issues or pull requests](/github/writing-on-github/basic-writing-and-formatting-syntax#referencing-issues-and-pull-requests), with search across multiple words after the "#". + +##### Administration changes + +- Enterprise owners can now [publish a mandatory message](/admin/user-management/customizing-user-messages-for-your-enterprise#creating-a-mandatory-message). The message is shown to all users and they must acknowledge it. This can be used to display important information, terms of service or policies. +- The {% data variables.product.prodname_github_app%} single file path permission can now [support up to ten files](/developers/apps/creating-a-github-app-using-url-parameters). +- When configuring a {% data variables.product.prodname_github_app%}, the authorization callback URL is a required field. Now we will permit the integrator to specify multiple callback URLs. {% data variables.product.product_name %} denies authorization if the callback URL from the request is not listed. +- A [new API endpoint](/rest/reference/apps#create-a-scoped-access-token) enables the exchange of a user to server token for a user to server token scoped to specific repositories. +- Events are now logged in the audit log on [promoting a team member to be a team maintainer and on demoting a team maintainer to be a team member](/admin/user-management/audited-actions#teams). +- The [OAuth device authorization flow](/developers/apps/authorizing-oauth-apps#device-flow) is now supported. This allows any CLI client or developer tool to authenticate using a secondary system. +- A user can no longer delete their account if SCIM provisioning is enabled. + +##### Default branch renaming + +Enterprise and organization owners can now set the default branch name for new repositories. Enterprise owners can also enforce their choice of default branch name across all organizations or allow individual organizations to choose their own. For more information, see "[Enforcing repository management policies in your enterprise](/admin/policies/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-on-the-default-branch-name)" and "[Managing the default branch name for repositories in your organization](/github/setting-up-and-managing-organizations-and-teams/managing-the-default-branch-name-for-repositories-in-your-organization)." + +Existing repositories are unaffected by these settings, and their default branch name will not be changed. + +This change is one of many changes {% data variables.product.company_short %} is making to support projects and maintainers that want to rename their default branch. To learn more, see [github/renaming](https://github.com/github/renaming). + + +### Bug fixes +- Users can no longer set a backup email address on their profile. Their email address is set through the IdP only. +- You can no longer enable two-factor authentication after configuring authentication through your IdP. +- {% data variables.product.product_name %} can now connect to Azure Boards. +- Version headers were missing from the APIs, and have now been set to "GitHub AE." +- Links to documentation have been fixed. +- Configuration of audit log forwarding within the enterprise's settings was failing. +- Navigating to gists could result in a 500 error. +- The Support email or URL was failing to save. It now saves after a period of a few minutes. +- Organization level pull request templates were not being applied to all pull requests in the organization. + +### Known issues + +- Geographic location data is not shown in the audit log. Location information can otherwise be discerned from the IP address associated with each event. +- The link to {% data variables.product.prodname_registry %} from a repository page shows an incorrect search page when that repository does not have any packages. diff --git a/content/admin/overview/index.md b/content/admin/overview/index.md index 099c1c1d54..607f86a51d 100644 --- a/content/admin/overview/index.md +++ b/content/admin/overview/index.md @@ -13,9 +13,12 @@ For more information, or to purchase {% data variables.product.prodname_enterpri ### Table of Contents {% link_in_list /about-github-ae %} +{% link_in_list /about-upgrades-to-new-releases %} +{% link_in_list /about-data-residency %} {% link_in_list /about-enterprise-accounts %} {% link_in_list /managing-your-github-enterprise-license %} {% link_in_list /managing-billing-for-your-enterprise %} {% link_in_list /about-upgrades-to-new-releases %} {% link_in_list /system-overview %} {% link_in_list /about-the-github-enterprise-api %} +{% link_in_list /github-ae-release-notes %} diff --git a/content/admin/overview/managing-billing-for-your-enterprise.md b/content/admin/overview/managing-billing-for-your-enterprise.md index 97c0ba8c03..8b8000cdc4 100644 --- a/content/admin/overview/managing-billing-for-your-enterprise.md +++ b/content/admin/overview/managing-billing-for-your-enterprise.md @@ -1,6 +1,6 @@ --- title: Managing billing for your enterprise -intro: 'You can view billing information for your enterprise.' +intro: You can view billing information for your enterprise. product: '{% data reusables.gated-features.enterprise-accounts %}' redirect_from: - /enterprise/admin/installation/managing-billing-for-github-enterprise @@ -9,6 +9,8 @@ redirect_from: versions: enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- {% if currentVersion == "github-ae@latest" %} diff --git a/content/admin/overview/managing-your-github-enterprise-license.md b/content/admin/overview/managing-your-github-enterprise-license.md index 3b1f4646ee..5318d5ca08 100644 --- a/content/admin/overview/managing-your-github-enterprise-license.md +++ b/content/admin/overview/managing-your-github-enterprise-license.md @@ -14,17 +14,23 @@ redirect_from: - /enterprise/admin/overview/managing-your-github-enterprise-license versions: enterprise-server: '*' +topics: + - enterprise --- ### About {% data variables.product.prodname_enterprise %} licenses -When you purchase or renew {% data variables.product.prodname_enterprise %}, you receive a license file to validate your application. A license file has an expiration date and controls the number of user licenses you can add to {% data variables.product.prodname_enterprise %}. After you download and install {% data variables.product.prodname_enterprise %}, uploading the license file unlocks the application for you to use. +When you purchase or renew {% data variables.product.prodname_enterprise %}, you receive a license file to validate your application. A license file has an expiration date and controls the number of user licenses you can add to {% data variables.product.prodname_enterprise %}. After you download and install {% data variables.product.prodname_enterprise %}, uploading the license file unlocks the application for you to use. For more information about downloading {% data variables.product.prodname_enterprise %}, see the [{% data variables.product.prodname_enterprise %} Releases](https://enterprise.github.com/releases/) website. For information about setting up {% data variables.product.product_location %}, see "[Setting up a {% data variables.product.prodname_enterprise %} instance](/admin/installation/setting-up-a-github-enterprise-server-instance)." + You can allocate the user licenses included in your {% data variables.product.prodname_enterprise %} license to users in {% data variables.product.product_location_enterprise %} and a {% data variables.product.prodname_ghe_cloud %} enterprise account. When you add a user to either environment, they will consume a license. If a user has accounts in both environments, to consume only one license, their primary {% data variables.product.prodname_enterprise %} email address must be the same as their verified {% data variables.product.prodname_ghe_cloud %} email address. You can sync license count and usage between the environments. If your {% data variables.product.prodname_ghe_server %} license expires, you won't be able to access {% data variables.product.product_location_enterprise %} via a web browser or Git. If needed, you will be able to use command-line utilities to back up all your data. For more information, see "[Configuring backups on your appliance](/enterprise/admin/guides/installation/configuring-backups-on-your-appliance)." If you have any questions about renewing your license, contact {% data variables.contact.contact_enterprise_sales %}. -### Uploading a new license to {% data variables.product.prodname_ghe_server %} +You can download your {% data variables.product.prodname_ghe_server %} license from your [enterprise account](https://enterprise.github.com/download). For more information, see "[Managing your {% data variables.product.prodname_enterprise %} license](/admin/overview/managing-your-github-enterprise-license#uploading-a-new-license-to-github-enterprise-server)." + +### Uploading a new license to {% data variables.product.prodname_ghe_server %} + After you purchase a new license or upgrade an existing license from {% data variables.contact.contact_enterprise_sales %}, you must download your new license file, then upload the file to {% data variables.product.prodname_ghe_server %} to unlock your new user licenses. diff --git a/content/admin/overview/system-overview.md b/content/admin/overview/system-overview.md index c86afe795a..a84cc7b275 100644 --- a/content/admin/overview/system-overview.md +++ b/content/admin/overview/system-overview.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/overview/system-overview versions: enterprise-server: '*' +topics: + - enterprise --- ### Storage architecture diff --git a/content/admin/packages/configuring-package-ecosystem-support-for-your-enterprise.md b/content/admin/packages/configuring-package-ecosystem-support-for-your-enterprise.md index 1f15dc49c2..b544920183 100644 --- a/content/admin/packages/configuring-package-ecosystem-support-for-your-enterprise.md +++ b/content/admin/packages/configuring-package-ecosystem-support-for-your-enterprise.md @@ -6,6 +6,8 @@ redirect_from: - /admin/packages/configuring-packages-support-for-your-enterprise versions: enterprise-server: '>=2.22' +topics: + - enterprise --- {% data reusables.package_registry.packages-ghes-release-stage %} diff --git a/content/admin/packages/enabling-github-packages-with-aws.md b/content/admin/packages/enabling-github-packages-with-aws.md index 4cfb1b0123..d1ac35a260 100644 --- a/content/admin/packages/enabling-github-packages-with-aws.md +++ b/content/admin/packages/enabling-github-packages-with-aws.md @@ -3,6 +3,8 @@ title: Enabling GitHub Packages with AWS intro: 'Set up {% data variables.product.prodname_registry %} with AWS as your external storage.' versions: enterprise-server: '>=2.22' +topics: + - enterprise --- {% warning %} diff --git a/content/admin/packages/enabling-github-packages-with-azure-blob-storage.md b/content/admin/packages/enabling-github-packages-with-azure-blob-storage.md index 65fd365621..913cfba14c 100644 --- a/content/admin/packages/enabling-github-packages-with-azure-blob-storage.md +++ b/content/admin/packages/enabling-github-packages-with-azure-blob-storage.md @@ -3,6 +3,8 @@ title: Enabling GitHub Packages with Azure Blob Storage intro: 'Set up {% data variables.product.prodname_registry %} with Azure Blob Storage as your external storage.' versions: enterprise-server: '>=3.0' +topics: + - enterprise --- {% warning %} diff --git a/content/admin/packages/enabling-github-packages-with-minio.md b/content/admin/packages/enabling-github-packages-with-minio.md index b0cec33688..9123b05147 100644 --- a/content/admin/packages/enabling-github-packages-with-minio.md +++ b/content/admin/packages/enabling-github-packages-with-minio.md @@ -3,6 +3,8 @@ title: Enabling GitHub Packages with MinIO intro: 'Set up {% data variables.product.prodname_registry %} with MinIO as your external storage.' versions: enterprise-server: '>=2.22' +topics: + - enterprise --- {% warning %} diff --git a/content/admin/packages/getting-started-with-github-packages-for-your-enterprise.md b/content/admin/packages/getting-started-with-github-packages-for-your-enterprise.md index 46a402df72..16aae55c86 100644 --- a/content/admin/packages/getting-started-with-github-packages-for-your-enterprise.md +++ b/content/admin/packages/getting-started-with-github-packages-for-your-enterprise.md @@ -6,6 +6,8 @@ redirect_from: - /admin/packages/enabling-github-packages-for-your-enterprise versions: enterprise-server: '>=2.22' +topics: + - enterprise --- {% if currentVersion == "enterprise-server@2.22" %} @@ -40,7 +42,7 @@ To enable {% data variables.product.prodname_registry %} and configure third-par ### Step 2: Specify the package ecosystems to support on your instance -Choose which package ecosystems you'd like to enable, disable, or set to read-only on your {% data variables.product.product_location %}. Available options are Docker, RubyGems, npm, Apache Maven, Gradle, or NuGet. For more information, see "[Configuring package ecosystem support for your enterprise](/enterprise/admin/packages/configuring-package-ecosystem-support-for-your-enterprise)." +Choose which package ecosystems you'd like to enable, disable, or set to read-only on {% data variables.product.product_location %}. Available options are Docker, RubyGems, npm, Apache Maven, Gradle, or NuGet. For more information, see "[Configuring package ecosystem support for your enterprise](/enterprise/admin/packages/configuring-package-ecosystem-support-for-your-enterprise)." ### Step 3: Ensure you have a TLS certificate for your package host URL, if needed diff --git a/content/admin/packages/index.md b/content/admin/packages/index.md index 9808ef3fde..b4f90820e7 100644 --- a/content/admin/packages/index.md +++ b/content/admin/packages/index.md @@ -5,6 +5,8 @@ redirect_from: - /enterprise/admin/packages versions: enterprise-server: '>=2.22' +topics: + - enterprise --- {% data reusables.package_registry.packages-ghes-release-stage %} diff --git a/content/admin/packages/quickstart-for-configuring-your-minio-storage-bucket-for-github-packages.md b/content/admin/packages/quickstart-for-configuring-your-minio-storage-bucket-for-github-packages.md index 646d1454a2..fc418b26e2 100644 --- a/content/admin/packages/quickstart-for-configuring-your-minio-storage-bucket-for-github-packages.md +++ b/content/admin/packages/quickstart-for-configuring-your-minio-storage-bucket-for-github-packages.md @@ -3,6 +3,8 @@ title: Quickstart for configuring your MinIO storage bucket for GitHub Packages intro: 'Configure your custom MinIO storage bucket for use with {% data variables.product.prodname_registry %}.' versions: enterprise-server: '>=2.22' +topics: + - enterprise --- {% data reusables.package_registry.packages-ghes-release-stage %} diff --git a/content/admin/policies/about-pre-receive-hooks.md b/content/admin/policies/about-pre-receive-hooks.md index ec699e2ccf..effb31b1b4 100644 --- a/content/admin/policies/about-pre-receive-hooks.md +++ b/content/admin/policies/about-pre-receive-hooks.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/policies/about-pre-receive-hooks versions: enterprise-server: '*' +topics: + - enterprise --- When a push occurs, each script runs in an isolated environment and can perform checks on the content of the push. The scripts will cause the push to be accepted if the exit status is 0, or rejected if the exit status is non-zero. diff --git a/content/admin/policies/creating-a-pre-receive-hook-environment.md b/content/admin/policies/creating-a-pre-receive-hook-environment.md index 64ab4099fc..f798129733 100644 --- a/content/admin/policies/creating-a-pre-receive-hook-environment.md +++ b/content/admin/policies/creating-a-pre-receive-hook-environment.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/policies/creating-a-pre-receive-hook-environment versions: enterprise-server: '*' +topics: + - enterprise --- A pre-receive environment for {% data variables.product.prodname_ghe_server %} is a Linux [`chroot`](https://en.wikipedia.org/wiki/Chroot) environment. Because pre-receive hooks execute on every push event, they should be fast and lightweight. The environment needed for such checks will typically be minimal. diff --git a/content/admin/policies/creating-a-pre-receive-hook-script.md b/content/admin/policies/creating-a-pre-receive-hook-script.md index c501d76e58..71f3a8e971 100644 --- a/content/admin/policies/creating-a-pre-receive-hook-script.md +++ b/content/admin/policies/creating-a-pre-receive-hook-script.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/policies/creating-a-pre-receive-hook-script versions: enterprise-server: '*' +topics: + - enterprise --- You can see examples of pre-receive hooks for {% data variables.product.prodname_ghe_server %} in the [`github/platform-samples` repository](https://github.com/github/platform-samples/tree/master/pre-receive-hooks). diff --git a/content/admin/policies/enforcing-policies-for-your-enterprise.md b/content/admin/policies/enforcing-policies-for-your-enterprise.md index b3673275fc..c5583b723d 100644 --- a/content/admin/policies/enforcing-policies-for-your-enterprise.md +++ b/content/admin/policies/enforcing-policies-for-your-enterprise.md @@ -6,5 +6,7 @@ redirect_from: versions: enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- diff --git a/content/admin/policies/enforcing-policy-with-pre-receive-hooks.md b/content/admin/policies/enforcing-policy-with-pre-receive-hooks.md index 49c8daec91..62f4721a65 100644 --- a/content/admin/policies/enforcing-policy-with-pre-receive-hooks.md +++ b/content/admin/policies/enforcing-policy-with-pre-receive-hooks.md @@ -7,5 +7,7 @@ redirect_from: - /enterprise/admin/policies/enforcing-policy-with-pre-receive-hooks versions: enterprise-server: '*' +topics: + - enterprise --- diff --git a/content/admin/policies/enforcing-repository-management-policies-in-your-enterprise.md b/content/admin/policies/enforcing-repository-management-policies-in-your-enterprise.md index de657754d3..adb7c0bf50 100644 --- a/content/admin/policies/enforcing-repository-management-policies-in-your-enterprise.md +++ b/content/admin/policies/enforcing-repository-management-policies-in-your-enterprise.md @@ -28,6 +28,8 @@ redirect_from: versions: enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- ### Configuring the default visibility of new repositories in your enterprise @@ -242,4 +244,4 @@ If necessary, you can prevent repository administrators from changing anonymous ![Enforcement checkbox](/assets/images/help/business-accounts/default-branch-name-enforce.png) 5. Click **Update**. ![Update button](/assets/images/help/business-accounts/default-branch-name-update.png) -{% endif %} \ No newline at end of file +{% endif %} diff --git a/content/admin/policies/index.md b/content/admin/policies/index.md index 9c665ea894..2588b9ba09 100644 --- a/content/admin/policies/index.md +++ b/content/admin/policies/index.md @@ -7,6 +7,8 @@ redirect_from: versions: enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- diff --git a/content/admin/policies/managing-pre-receive-hooks-on-the-github-enterprise-server-appliance.md b/content/admin/policies/managing-pre-receive-hooks-on-the-github-enterprise-server-appliance.md index 806dd27df9..78a8dbb31f 100644 --- a/content/admin/policies/managing-pre-receive-hooks-on-the-github-enterprise-server-appliance.md +++ b/content/admin/policies/managing-pre-receive-hooks-on-the-github-enterprise-server-appliance.md @@ -7,6 +7,8 @@ redirect_from: - /enterprise/admin/policies/managing-pre-receive-hooks-on-the-github-enterprise-server-appliance versions: enterprise-server: '*' +topics: + - enterprise --- ### Creating pre-receive hooks diff --git a/content/admin/release-notes.md b/content/admin/release-notes.md index 4010feb879..3608580c91 100644 --- a/content/admin/release-notes.md +++ b/content/admin/release-notes.md @@ -1,7 +1,10 @@ --- title: Release notes -intro: The release notes for {{ allVersions[currentVersion].versionTitle }}. +intro: 'The release notes for {{ allVersions[currentVersion].versionTitle }}.' layout: release-notes versions: enterprise-server: '*' +topics: + - enterprise --- + diff --git a/content/admin/user-management/about-migrations.md b/content/admin/user-management/about-migrations.md index e04bdf4f4a..4761a77561 100644 --- a/content/admin/user-management/about-migrations.md +++ b/content/admin/user-management/about-migrations.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/user-management/about-migrations versions: enterprise-server: '*' +topics: + - enterprise --- ### Types of migrations diff --git a/content/admin/user-management/activity-dashboard.md b/content/admin/user-management/activity-dashboard.md index 5fb4fce0d9..36572f7c90 100644 --- a/content/admin/user-management/activity-dashboard.md +++ b/content/admin/user-management/activity-dashboard.md @@ -1,6 +1,6 @@ --- title: Activity dashboard -intro: 'The Activity dashboard gives you an overview of all the activity in your enterprise.' +intro: The Activity dashboard gives you an overview of all the activity in your enterprise. redirect_from: - /enterprise/admin/articles/activity-dashboard/ - /enterprise/admin/installation/activity-dashboard @@ -8,6 +8,8 @@ redirect_from: versions: enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- The Activity dashboard provides weekly, monthly, and yearly graphs of the number of: diff --git a/content/admin/user-management/adding-people-to-teams.md b/content/admin/user-management/adding-people-to-teams.md index 0a94dea0aa..cae2ec54c9 100644 --- a/content/admin/user-management/adding-people-to-teams.md +++ b/content/admin/user-management/adding-people-to-teams.md @@ -8,6 +8,8 @@ redirect_from: intro: 'Once a team has been created, organization admins can add users from {% data variables.product.product_location %} to the team and determine which repositories they have access to.' versions: enterprise-server: '*' +topics: + - enterprise --- Each team has its own individually defined [access permissions for repositories owned by your organization](/articles/permission-levels-for-an-organization). diff --git a/content/admin/user-management/audit-logging.md b/content/admin/user-management/audit-logging.md index 8a8da98e14..d4eb94ca04 100644 --- a/content/admin/user-management/audit-logging.md +++ b/content/admin/user-management/audit-logging.md @@ -8,6 +8,8 @@ redirect_from: versions: enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- For a full list, see "[Audited actions](/admin/user-management/audited-actions)." For more information on finding a particular action, see "[Searching the audit log](/admin/user-management/searching-the-audit-log)." @@ -38,4 +40,4 @@ This example shows that commits were pushed to a repository. ``` Oct 26 02:19:31 github-ent github_audit: { "pid":22860, "ppid":22859, "program":"receive-pack", "git_dir":"/data/repositories/some-user/some-repository.git", "hostname":"github-ent", "pusher":"some-user", "real_ip":"10.0.0.51", "user_agent":"git/1.7.10.4", "repo_id":1, "repo_name":"some-user/some-repository", "transaction_id":"b031b7dc7043c87323a75f7a92092ef1456e5fbaef995c68", "frontend_ppid":1, "repo_public":true, "user_name":"some-user", "user_login":"some-user", "frontend_pid":18238, "frontend":"github-ent", "user_email":"some-user@github.example.com", "user_id":2, "pgroup":"github-ent_22860", "status":"post_receive_hook", "features":" report-status side-band-64k", "received_objects":3, "receive_pack_size":243, "non_fast_forward":false, "current_ref":"refs/heads/main" } ``` -{% endif %} \ No newline at end of file +{% endif %} diff --git a/content/admin/user-management/audited-actions.md b/content/admin/user-management/audited-actions.md index 299314ab07..eaf820e04b 100644 --- a/content/admin/user-management/audited-actions.md +++ b/content/admin/user-management/audited-actions.md @@ -1,6 +1,7 @@ --- title: Audited actions intro: You can search the audit log for a wide variety of actions. +miniTocMaxHeadingLevel: 4 redirect_from: - /enterprise/admin/articles/audited-actions/ - /enterprise/admin/installation/audited-actions @@ -8,6 +9,8 @@ redirect_from: versions: enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- #### Authentication @@ -56,6 +59,22 @@ Action | Description `enterprise.config.lock_anonymous_git_access` | A site admin locks anonymous Git read access to prevent repository admins from changing existing anonymous Git read access settings for repositories in the enterprise. For more information, see "[Enforcing repository management policies in your enterprise](/admin/policies/enforcing-repository-management-policies-in-your-enterprise#configuring-anonymous-git-read-access)." `enterprise.config.unlock_anonymous_git_access` | A site admin unlocks anonymous Git read access to allow repository admins to change existing anonymous Git read access settings for repositories in the enterprise. For more information, see "[Enforcing repository management policies in your enterprise](/admin/policies/enforcing-repository-management-policies-in-your-enterprise#configuring-anonymous-git-read-access)."{% endif %} +{% if currentVersion == "github-ae@latest" %} + +#### IP allow lists + +Name | Description +------------------------------------:| ----------------------------------------------------------- +`ip_allow_list_entry.create` | An IP address was added to an IP allow list. +`ip_allow_list_entry.update` | An IP address or its description was changed. +`ip_allow_list_entry.destroy` | An IP address was deleted from an IP allow list. +`ip_allow_list.enable` | An IP allow list was enabled. +`ip_allow_list.enable_for_installed_apps` | An IP allow list was enabled for installed {% data variables.product.prodname_github_apps %}. +`ip_allow_list.disable` | An IP allow list was disabled. +`ip_allow_list.disable_for_installed_apps` | An IP allow list was disabled for installed {% data variables.product.prodname_github_apps %}. + +{% endif %} + #### Issues and pull requests Action | Description diff --git a/content/admin/user-management/auditing-ssh-keys.md b/content/admin/user-management/auditing-ssh-keys.md index fca0dbe5be..fa8aee9730 100644 --- a/content/admin/user-management/auditing-ssh-keys.md +++ b/content/admin/user-management/auditing-ssh-keys.md @@ -7,6 +7,8 @@ redirect_from: versions: enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- Once initiated, the audit disables all existing SSH keys and forces users to approve or reject them before they're able to clone, pull, or push to any repositories. An audit is useful in situations where an employee or contractor leaves the company and you need to ensure that all keys are verified. diff --git a/content/admin/user-management/auditing-users-across-your-enterprise.md b/content/admin/user-management/auditing-users-across-your-enterprise.md index 015fe8c7a2..d644c7cbeb 100644 --- a/content/admin/user-management/auditing-users-across-your-enterprise.md +++ b/content/admin/user-management/auditing-users-across-your-enterprise.md @@ -8,6 +8,8 @@ redirect_from: versions: enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- ### Accessing the audit log diff --git a/content/admin/user-management/best-practices-for-user-security.md b/content/admin/user-management/best-practices-for-user-security.md index beae6174be..a0de18848f 100644 --- a/content/admin/user-management/best-practices-for-user-security.md +++ b/content/admin/user-management/best-practices-for-user-security.md @@ -6,6 +6,8 @@ redirect_from: versions: enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- {% if enterpriseServerVersions contains currentVersion %} diff --git a/content/admin/user-management/configuring-git-large-file-storage-for-your-enterprise.md b/content/admin/user-management/configuring-git-large-file-storage-for-your-enterprise.md index e51686cb1f..bd22261272 100644 --- a/content/admin/user-management/configuring-git-large-file-storage-for-your-enterprise.md +++ b/content/admin/user-management/configuring-git-large-file-storage-for-your-enterprise.md @@ -15,6 +15,8 @@ redirect_from: versions: enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- ### About {% data variables.large_files.product_name_long %} diff --git a/content/admin/user-management/configuring-visibility-for-organization-membership.md b/content/admin/user-management/configuring-visibility-for-organization-membership.md index 6551ad31f8..4b051cbd69 100644 --- a/content/admin/user-management/configuring-visibility-for-organization-membership.md +++ b/content/admin/user-management/configuring-visibility-for-organization-membership.md @@ -6,6 +6,8 @@ redirect_from: versions: enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- {% if enterpriseServerVersions contains currentVersion %} diff --git a/content/admin/user-management/continuous-integration-using-jenkins.md b/content/admin/user-management/continuous-integration-using-jenkins.md index 8f1ebe6bda..74cc0fc964 100644 --- a/content/admin/user-management/continuous-integration-using-jenkins.md +++ b/content/admin/user-management/continuous-integration-using-jenkins.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/user-management/continuous-integration-using-jenkins versions: enterprise-server: '*' +topics: + - enterprise --- ### Requirements diff --git a/content/admin/user-management/creating-teams.md b/content/admin/user-management/creating-teams.md index 96c25bbb5a..73de830082 100644 --- a/content/admin/user-management/creating-teams.md +++ b/content/admin/user-management/creating-teams.md @@ -5,6 +5,8 @@ redirect_from: - /enterprise/admin/user-management/creating-teams versions: enterprise-server: '*' +topics: + - enterprise --- Teams are central to many of {% data variables.product.prodname_dotcom %}'s collaborative features, such as team @mentions to notify appropriate parties that you'd like to request their input or attention. For more information, see "[Permission levels for an organization repository](/enterprise/{{ currentVersion }}/user/articles/repository-permission-levels-for-an-organization/)". diff --git a/content/admin/user-management/customizing-user-messages-for-your-enterprise.md b/content/admin/user-management/customizing-user-messages-for-your-enterprise.md index 8d20c8a7ad..fb040c543b 100644 --- a/content/admin/user-management/customizing-user-messages-for-your-enterprise.md +++ b/content/admin/user-management/customizing-user-messages-for-your-enterprise.md @@ -8,6 +8,8 @@ intro: 'You can create custom messages that users will see on {% data variables. versions: enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- ### About user messages diff --git a/content/admin/user-management/disabling-git-ssh-access-on-your-enterprise.md b/content/admin/user-management/disabling-git-ssh-access-on-your-enterprise.md index 1578faba94..ed0284421e 100644 --- a/content/admin/user-management/disabling-git-ssh-access-on-your-enterprise.md +++ b/content/admin/user-management/disabling-git-ssh-access-on-your-enterprise.md @@ -13,10 +13,12 @@ redirect_from: - /enterprise/admin/installation/disabling-git-ssh-access-on-github-enterprise-server - /enterprise/admin/user-management/disabling-git-ssh-access-on-github-enterprise-server - /admin/user-management/disabling-git-ssh-access-on-github-enterprise-server -intro: 'You can prevent people from using Git over SSH for certain or all repositories on your enterprise.' +intro: You can prevent people from using Git over SSH for certain or all repositories on your enterprise. versions: enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- ### Disabling Git SSH access to a specific repository diff --git a/content/admin/user-management/exporting-migration-data-from-githubcom.md b/content/admin/user-management/exporting-migration-data-from-githubcom.md index 7856792cb0..6112f4c241 100644 --- a/content/admin/user-management/exporting-migration-data-from-githubcom.md +++ b/content/admin/user-management/exporting-migration-data-from-githubcom.md @@ -11,6 +11,8 @@ redirect_from: - /enterprise/admin/user-management/exporting-migration-data-from-githubcom versions: enterprise-server: '*' +topics: + - enterprise --- ### Preparing the source organization on {% data variables.product.prodname_dotcom %} diff --git a/content/admin/user-management/exporting-migration-data-from-your-enterprise.md b/content/admin/user-management/exporting-migration-data-from-your-enterprise.md index da606dbe91..a777e740e3 100644 --- a/content/admin/user-management/exporting-migration-data-from-your-enterprise.md +++ b/content/admin/user-management/exporting-migration-data-from-your-enterprise.md @@ -11,6 +11,8 @@ redirect_from: - /enterprise/admin/user-management/exporting-migration-data-from-your-enterprise versions: enterprise-server: '*' +topics: + - enterprise --- ### Preparing the {% data variables.product.prodname_ghe_server %} source instance diff --git a/content/admin/user-management/importing-data-from-third-party-version-control-systems.md b/content/admin/user-management/importing-data-from-third-party-version-control-systems.md index 8a81872d82..4fce02539d 100644 --- a/content/admin/user-management/importing-data-from-third-party-version-control-systems.md +++ b/content/admin/user-management/importing-data-from-third-party-version-control-systems.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/user-management/importing-data-from-third-party-version-control-systems versions: enterprise-server: '*' +topics: + - enterprise --- ### Importing projects from Mercurial diff --git a/content/admin/user-management/index.md b/content/admin/user-management/index.md index 73f0672568..6bbed26d46 100644 --- a/content/admin/user-management/index.md +++ b/content/admin/user-management/index.md @@ -11,6 +11,8 @@ redirect_from: versions: enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- diff --git a/content/admin/user-management/log-forwarding.md b/content/admin/user-management/log-forwarding.md index 00ad4741f3..c30299376f 100644 --- a/content/admin/user-management/log-forwarding.md +++ b/content/admin/user-management/log-forwarding.md @@ -9,6 +9,8 @@ redirect_from: versions: enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- Any log collection system that supports syslog-style log streams is supported (e.g., [Logstash](http://logstash.net/) and [Splunk](http://docs.splunk.com/Documentation/Splunk/latest/Data/Monitornetworkports)). diff --git a/content/admin/user-management/managing-dormant-users.md b/content/admin/user-management/managing-dormant-users.md index 9aaaccfb90..99c8980a2c 100644 --- a/content/admin/user-management/managing-dormant-users.md +++ b/content/admin/user-management/managing-dormant-users.md @@ -5,10 +5,12 @@ redirect_from: - /enterprise/admin/articles/viewing-dormant-users/ - /enterprise/admin/articles/determining-whether-a-user-account-is-dormant/ - /enterprise/admin/user-management/managing-dormant-users -intro: A user account is considered to be dormant if it has not been active for at least a month.{% if enterpriseServerVersions contains currentVersion %} You may choose to suspend dormant users to free up user licenses.{% endif %} +intro: 'A user account is considered to be dormant if it has not been active for at least a month.{% if enterpriseServerVersions contains currentVersion %} You may choose to suspend dormant users to free up user licenses.{% endif %}' versions: enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- "Activity" includes, but is not limited to: diff --git a/content/admin/user-management/managing-global-webhooks.md b/content/admin/user-management/managing-global-webhooks.md index e34217f4ca..8dfcaa45e9 100644 --- a/content/admin/user-management/managing-global-webhooks.md +++ b/content/admin/user-management/managing-global-webhooks.md @@ -7,6 +7,8 @@ redirect_from: versions: enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- ### About global webhooks diff --git a/content/admin/user-management/managing-organizations-in-your-enterprise.md b/content/admin/user-management/managing-organizations-in-your-enterprise.md index 08415450a9..0fddb06a87 100644 --- a/content/admin/user-management/managing-organizations-in-your-enterprise.md +++ b/content/admin/user-management/managing-organizations-in-your-enterprise.md @@ -10,4 +10,7 @@ mapTopic: true versions: enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- + diff --git a/content/admin/user-management/managing-projects-using-jira.md b/content/admin/user-management/managing-projects-using-jira.md index fb919a1769..c6ea376e22 100644 --- a/content/admin/user-management/managing-projects-using-jira.md +++ b/content/admin/user-management/managing-projects-using-jira.md @@ -9,6 +9,8 @@ redirect_from: - /enterprise/admin/user-management/managing-projects-using-jira versions: enterprise-server: '*' +topics: + - enterprise --- ### Connecting JIRA to a {% data variables.product.prodname_enterprise %} organization diff --git a/content/admin/user-management/managing-repositories-in-your-enterprise.md b/content/admin/user-management/managing-repositories-in-your-enterprise.md index 4da07ed3b7..bf4eb99cac 100644 --- a/content/admin/user-management/managing-repositories-in-your-enterprise.md +++ b/content/admin/user-management/managing-repositories-in-your-enterprise.md @@ -1,6 +1,6 @@ --- title: Managing repositories in your enterprise -intro: 'You can manage the settings available to repository administrators in your enterprise.' +intro: You can manage the settings available to repository administrators in your enterprise. redirect_from: - /enterprise/admin/user-management/repositories - /enterprise/admin/user-management/managing-repositories-in-your-enterprise @@ -8,5 +8,7 @@ mapTopic: true versions: enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- diff --git a/content/admin/user-management/managing-users-in-your-enterprise.md b/content/admin/user-management/managing-users-in-your-enterprise.md index 63a373005f..f5ee73f94a 100644 --- a/content/admin/user-management/managing-users-in-your-enterprise.md +++ b/content/admin/user-management/managing-users-in-your-enterprise.md @@ -1,6 +1,6 @@ --- title: Managing users in your enterprise -intro: 'You can audit user activity and manage user settings.' +intro: You can audit user activity and manage user settings. redirect_from: - /enterprise/admin/guides/user-management/enabling-avatars-and-identicons/ - /enterprise/admin/user-management/basic-account-settings @@ -10,5 +10,7 @@ mapTopic: true versions: enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- diff --git a/content/admin/user-management/migrating-data-to-and-from-your-enterprise.md b/content/admin/user-management/migrating-data-to-and-from-your-enterprise.md index a3df463ac3..216d8e3aa4 100644 --- a/content/admin/user-management/migrating-data-to-and-from-your-enterprise.md +++ b/content/admin/user-management/migrating-data-to-and-from-your-enterprise.md @@ -9,5 +9,7 @@ redirect_from: - /enterprise/admin/user-management/migrating-data-to-and-from-your-enterprise versions: enterprise-server: '*' +topics: + - enterprise --- diff --git a/content/admin/user-management/migrating-data-to-your-enterprise.md b/content/admin/user-management/migrating-data-to-your-enterprise.md index 0cfce09e13..47abddf047 100644 --- a/content/admin/user-management/migrating-data-to-your-enterprise.md +++ b/content/admin/user-management/migrating-data-to-your-enterprise.md @@ -13,14 +13,18 @@ redirect_from: - /enterprise/admin/user-management/migrating-data-to-your-enterprise versions: enterprise-server: '*' +topics: + - enterprise --- ### Applying the imported data on {% data variables.product.prodname_ghe_server %} +Once you have [prepared your migration](/admin/user-management/preparing-to-migrate-data-to-your-enterprise) you can use the following steps to complete the migration. + {% data reusables.enterprise_installation.ssh-into-target-instance %} 2. Using the `ghe-migrator import` command, start the import process. You'll need: - * Your Migration GUID. + * Your Migration GUID. For more information, see "[Preparing to migrate data to your enterprise](/admin/user-management/preparing-to-migrate-data-to-your-enterprise)." * Your personal access token for authentication. The personal access token that you use is only for authentication as a site administrator, and does not require any specific scope. For more information, see "[Creating a personal access token](/github/authenticating-to-github/creating-a-personal-access-token)." ```shell diff --git a/content/admin/user-management/migrating-to-internal-repositories.md b/content/admin/user-management/migrating-to-internal-repositories.md index 509a9e1a11..c3abc3d40b 100644 --- a/content/admin/user-management/migrating-to-internal-repositories.md +++ b/content/admin/user-management/migrating-to-internal-repositories.md @@ -7,6 +7,8 @@ redirect_from: permissions: Site administrators can migrate to internal repositories. versions: enterprise-server: '>=2.20' +topics: + - enterprise --- ### About internal repositories diff --git a/content/admin/user-management/monitoring-activity-in-your-enterprise.md b/content/admin/user-management/monitoring-activity-in-your-enterprise.md index a72fde4deb..4c8ae9bd38 100644 --- a/content/admin/user-management/monitoring-activity-in-your-enterprise.md +++ b/content/admin/user-management/monitoring-activity-in-your-enterprise.md @@ -7,5 +7,7 @@ redirect_from: versions: enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- diff --git a/content/admin/user-management/placing-a-legal-hold-on-a-user-or-organization.md b/content/admin/user-management/placing-a-legal-hold-on-a-user-or-organization.md index 20a81d080e..881f91d4b9 100644 --- a/content/admin/user-management/placing-a-legal-hold-on-a-user-or-organization.md +++ b/content/admin/user-management/placing-a-legal-hold-on-a-user-or-organization.md @@ -1,11 +1,13 @@ --- title: Placing a legal hold on a user or organization -intro: 'You can place a legal hold on a user or organization to ensure that repositories they own cannot be permanently removed from your enterprise.' +intro: You can place a legal hold on a user or organization to ensure that repositories they own cannot be permanently removed from your enterprise. redirect_from: - /enterprise/admin/user-management/placing-a-legal-hold-on-a-user-or-organization versions: enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- Usually, if someone deletes a repository, it will be available on disk for 90 days and can be restored via the site admin dashboard. After 90 days the repository is purged and deleted forever. If you place a legal hold on a user or organization, repositories they own are available for restore indefinitely. diff --git a/content/admin/user-management/preparing-to-migrate-data-to-your-enterprise.md b/content/admin/user-management/preparing-to-migrate-data-to-your-enterprise.md index c6e85b46cc..b0b294e4ce 100644 --- a/content/admin/user-management/preparing-to-migrate-data-to-your-enterprise.md +++ b/content/admin/user-management/preparing-to-migrate-data-to-your-enterprise.md @@ -10,6 +10,8 @@ redirect_from: - /enterprise/admin/user-management/preparing-to-migrate-data-to-your-enterprise versions: enterprise-server: '*' +topics: + - enterprise --- ### Preparing the migrated data for import to {% data variables.product.prodname_ghe_server %} diff --git a/content/admin/user-management/preventing-users-from-creating-organizations.md b/content/admin/user-management/preventing-users-from-creating-organizations.md index 1a1f09c776..41355830c4 100644 --- a/content/admin/user-management/preventing-users-from-creating-organizations.md +++ b/content/admin/user-management/preventing-users-from-creating-organizations.md @@ -4,10 +4,12 @@ redirect_from: - /enterprise/admin/articles/preventing-users-from-creating-organizations/ - /enterprise/admin/hidden/preventing-users-from-creating-organizations/ - /enterprise/admin/user-management/preventing-users-from-creating-organizations -intro: 'You can prevent users from creating organizations in your enterprise.' +intro: You can prevent users from creating organizations in your enterprise. versions: enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- {% data reusables.enterprise-accounts.access-enterprise %} diff --git a/content/admin/user-management/promoting-or-demoting-a-site-administrator.md b/content/admin/user-management/promoting-or-demoting-a-site-administrator.md index 8370cad870..225c8efd4b 100644 --- a/content/admin/user-management/promoting-or-demoting-a-site-administrator.md +++ b/content/admin/user-management/promoting-or-demoting-a-site-administrator.md @@ -7,6 +7,8 @@ redirect_from: intro: 'Site administrators can promote any normal user account to a site administrator, as well as demote other site administrators to regular users.' versions: enterprise-server: '*' +topics: + - enterprise --- {% tip %} @@ -52,4 +54,4 @@ For information about promoting a user to an organization owner, see the `ghe-or 2. Run [ghe-user-demote](/enterprise/{{ currentVersion }}/admin/guides/installation/command-line-utilities#ghe-user-demote) with the username to demote. ```shell $ ghe-user-demote username - ``` \ No newline at end of file + ``` diff --git a/content/admin/user-management/rebuilding-contributions-data.md b/content/admin/user-management/rebuilding-contributions-data.md index 12b6e32f28..8ad18007f0 100644 --- a/content/admin/user-management/rebuilding-contributions-data.md +++ b/content/admin/user-management/rebuilding-contributions-data.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/user-management/rebuilding-contributions-data versions: enterprise-server: '*' +topics: + - enterprise --- Whenever a commit is pushed to {% data variables.product.prodname_enterprise %}, it is linked to a user account if they are both associated with the same email address. However, existing commits are *not* retroactively linked when a user registers a new email address or creates a new account. diff --git a/content/admin/user-management/removing-users-from-teams-and-organizations.md b/content/admin/user-management/removing-users-from-teams-and-organizations.md index 3887587f90..2d4d6eace6 100644 --- a/content/admin/user-management/removing-users-from-teams-and-organizations.md +++ b/content/admin/user-management/removing-users-from-teams-and-organizations.md @@ -5,6 +5,8 @@ redirect_from: - /enterprise/admin/user-management/removing-users-from-teams-and-organizations versions: enterprise-server: '*' +topics: + - enterprise --- Only owners or team admins can remove organization members. When a user is removed from a team or organization, their issues, pull requests, and comments in the organization's repositories remain intact and are still attributed to the user. diff --git a/content/admin/user-management/requiring-two-factor-authentication-for-an-organization.md b/content/admin/user-management/requiring-two-factor-authentication-for-an-organization.md index 32cff3f262..a60123ce08 100644 --- a/content/admin/user-management/requiring-two-factor-authentication-for-an-organization.md +++ b/content/admin/user-management/requiring-two-factor-authentication-for-an-organization.md @@ -5,6 +5,8 @@ redirect_from: - /enterprise/admin/user-management/requiring-two-factor-authentication-for-an-organization versions: enterprise-server: '*' +topics: + - enterprise --- When using LDAP or built-in authentication, two-factor authentication is supported on {% data variables.product.product_location %}. Organization administrators can require members to have two-factor authentication enabled. diff --git a/content/admin/user-management/searching-the-audit-log.md b/content/admin/user-management/searching-the-audit-log.md index 9495d0dc5c..aa9caf2db5 100644 --- a/content/admin/user-management/searching-the-audit-log.md +++ b/content/admin/user-management/searching-the-audit-log.md @@ -1,6 +1,6 @@ --- title: Searching the audit log -intro: 'Site administrators can search an extensive list of audited actions on the enterprise.' +intro: Site administrators can search an extensive list of audited actions on the enterprise. redirect_from: - /enterprise/admin/articles/searching-the-audit-log/ - /enterprise/admin/installation/searching-the-audit-log @@ -8,6 +8,8 @@ redirect_from: versions: enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- ### Search query syntax diff --git a/content/admin/user-management/suspending-and-unsuspending-users.md b/content/admin/user-management/suspending-and-unsuspending-users.md index ce82b3bb93..ba313b6765 100644 --- a/content/admin/user-management/suspending-and-unsuspending-users.md +++ b/content/admin/user-management/suspending-and-unsuspending-users.md @@ -10,6 +10,8 @@ redirect_from: intro: 'If a user leaves or moves to a different part of the company, you should remove or modify their ability to access {% data variables.product.product_location %}.' versions: enterprise-server: '*' +topics: + - enterprise --- If employees leave the company, you can suspend their {% data variables.product.prodname_ghe_server %} accounts to open up user licenses in your {% data variables.product.prodname_enterprise %} license while preserving the issues, comments, repositories, gists, and other data they created. Suspended users cannot sign into your instance, nor can they push or pull code. @@ -92,4 +94,4 @@ You can create a custom message that suspended users will see when attempting to ``` ### Further reading -- "[Suspend a user](/rest/reference/enterprise-admin#suspend-a-user)" \ No newline at end of file +- "[Suspend a user](/rest/reference/enterprise-admin#suspend-a-user)" diff --git a/content/admin/user-management/troubleshooting-service-hooks.md b/content/admin/user-management/troubleshooting-service-hooks.md index 3ae71bf810..f7e8ea77c0 100644 --- a/content/admin/user-management/troubleshooting-service-hooks.md +++ b/content/admin/user-management/troubleshooting-service-hooks.md @@ -8,6 +8,8 @@ redirect_from: versions: enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- ### Getting information on deliveries diff --git a/content/admin/user-management/viewing-push-logs.md b/content/admin/user-management/viewing-push-logs.md index 19fb572493..3481540a90 100644 --- a/content/admin/user-management/viewing-push-logs.md +++ b/content/admin/user-management/viewing-push-logs.md @@ -1,6 +1,6 @@ --- title: Viewing push logs -intro: 'Site administrators can view a list of Git push operations for any repository on the enterprise.' +intro: Site administrators can view a list of Git push operations for any repository on the enterprise. redirect_from: - /enterprise/admin/articles/viewing-push-logs/ - /enterprise/admin/installation/viewing-push-logs @@ -8,6 +8,8 @@ redirect_from: versions: enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- Push log entries show: @@ -38,4 +40,4 @@ Push log entries show: ```shell ghe-repo owner/repository -c "less audit_log" ``` -{% endif %} \ No newline at end of file +{% endif %} diff --git a/content/desktop/contributing-and-collaborating-using-github-desktop/committing-and-reviewing-changes-to-your-project.md b/content/desktop/contributing-and-collaborating-using-github-desktop/committing-and-reviewing-changes-to-your-project.md index bee5116a9a..fc9f1d608c 100644 --- a/content/desktop/contributing-and-collaborating-using-github-desktop/committing-and-reviewing-changes-to-your-project.md +++ b/content/desktop/contributing-and-collaborating-using-github-desktop/committing-and-reviewing-changes-to-your-project.md @@ -16,7 +16,7 @@ versions: ### 1. Choosing a branch and making changes 1. [Create a new branch](/desktop/guides/contributing-to-projects/managing-branches), or select an existing branch by clicking {% octicon "git-branch" aria-label="The branch icon" %} **Current Branch** on the toolbar and selecting the branch from the list. - ![Drop down menu to switch your current branch](/assets/images/help/desktop/click-branch-in-drop-down.png) + ![Drop down menu to switch your current branch](/assets/images/help/desktop/select-branch-from-dropdown.png) {% data reusables.desktop.make-changes %} ### 2. Selecting changes to include in a commit diff --git a/content/desktop/contributing-and-collaborating-using-github-desktop/index.md b/content/desktop/contributing-and-collaborating-using-github-desktop/index.md index 3b94ba2311..2e0f6b62fd 100644 --- a/content/desktop/contributing-and-collaborating-using-github-desktop/index.md +++ b/content/desktop/contributing-and-collaborating-using-github-desktop/index.md @@ -19,6 +19,7 @@ versions: {% topic_link_in_list /making-changes-in-a-branch %} {% link_in_list /managing-branches %} {% link_in_list /committing-and-reviewing-changes-to-your-project %} + {% link_in_list /stashing-changes %} {% link_in_list /pushing-changes-to-github %} {% link_in_list /reverting-a-commit %} {% link_in_list /managing-tags %} diff --git a/content/desktop/contributing-and-collaborating-using-github-desktop/managing-branches.md b/content/desktop/contributing-and-collaborating-using-github-desktop/managing-branches.md index 879ecd2097..a63906b36e 100644 --- a/content/desktop/contributing-and-collaborating-using-github-desktop/managing-branches.md +++ b/content/desktop/contributing-and-collaborating-using-github-desktop/managing-branches.md @@ -30,7 +30,7 @@ You can always create a branch in {% data variables.product.prodname_desktop %} {% mac %} {% data reusables.desktop.click-base-branch-in-drop-down %} - ![Drop-down menu to switch your current branch](/assets/images/help/desktop/click-branch-in-drop-down-mac.png) + ![Drop-down menu to switch your current branch](/assets/images/help/desktop/select-branch-from-dropdown.png) {% data reusables.desktop.create-new-branch %} ![New Branch option in the Branch menu](/assets/images/help/desktop/new-branch-button-mac.png) {% data reusables.desktop.name-branch %} @@ -62,13 +62,12 @@ You can always create a branch in {% data variables.product.prodname_desktop %} If you create a branch on {% data variables.product.product_name %}, you'll need to publish the branch to make it available for collaboration on {% data variables.product.prodname_dotcom %}. 1. At the top of the app, click {% octicon "git-branch" aria-label="The branch icon" %} **Current Branch**, then click the branch that you want to publish. - ![Drop-down menu to select which branch to publish](/assets/images/help/desktop/click-branch-in-drop-down-mac.png) + ![Drop-down menu to select which branch to publish](/assets/images/help/desktop/select-branch-from-dropdown.png) 2. Click **Publish branch**. ![The Publish branch button](/assets/images/help/desktop/publish-branch-button.png) ### Switching between branches -You can view and make commits to any of your repository's branches. If you have uncommitted, saved changes, you'll need to decide what to do with your changes before you can switch branches. You can commit your changes on the current branch, stash your changes on the current branch, or bring the changes to your new branch. If you want to commit your changes on the current branch, follow the steps in "[Committing and reviewing changes to your project](/desktop/contributing-to-projects/committing-and-reviewing-changes-to-your-project)" before switching branches. - +You can view and make commits to any of your repository's branches. If you have uncommitted, saved changes, you'll need to decide what to do with your changes before you can switch branches. You can commit your changes on the current branch, stash your changes to temporarily save them on the current branch, or bring the changes to your new branch. If you want to commit your changes before switching branches, see "[Committing and reviewing changes to your project](/desktop/contributing-to-projects/committing-and-reviewing-changes-to-your-project)." {% tip %} **Tip**: You can set a default behavior for switching branches in the **Advanced** settings. For more information, see "[Configuring basic settings](/desktop/getting-started-with-github-desktop/configuring-basic-settings)." @@ -77,21 +76,10 @@ You can view and make commits to any of your repository's branches. If you have {% data reusables.desktop.current-branch-menu %} {% data reusables.desktop.switching-between-branches %} - ![List of branches in the repository](/assets/images/help/desktop/click-branch-in-drop-down-mac.png) + ![List of branches in the repository](/assets/images/help/desktop/select-branch-from-dropdown.png) 3. If you have saved, uncommitted changes, choose **Leave my changes** or **Bring my changes**, then click **Switch Branch**. ![Switch branch with changes options](/assets/images/help/desktop/stash-changes-options.png) -### Retrieving stashed changes -To access changes you've stashed in another branch, switch back to the branch you stashed the changes in. - -{% data reusables.desktop.current-branch-menu %} -{% data reusables.desktop.switching-between-branches %} - ![List of branches in the repository](/assets/images/help/desktop/click-branch-in-drop-down-mac.png) -3. In the left sidebar, click **Stashed Changes**. -![Stashed changes option](/assets/images/help/desktop/stashed-changes.png) -4. To delete your stashed changes, click **Discard**, or to use your stashed changes, click **Restore**. -![Discard or Restore stashed changes](/assets/images/help/desktop/discard-restore-stash-buttons.png) - ### Deleting a branch You can't delete a branch if it's currently associated with an open pull request. You cannot undo deleting a branch. @@ -99,7 +87,7 @@ You can't delete a branch if it's currently associated with an open pull request {% mac %} {% data reusables.desktop.select-branch-to-delete %} - ![Drop-down menu to select which branch to delete](/assets/images/help/desktop/select-branch-to-delete.png) + ![Drop-down menu to select which branch to delete](/assets/images/help/desktop/select-branch-from-dropdown.png) {% data reusables.desktop.delete-branch-mac %} ![Delete... option in the Branch menu](/assets/images/help/desktop/delete-branch-mac.png) @@ -108,7 +96,7 @@ You can't delete a branch if it's currently associated with an open pull request {% windows %} {% data reusables.desktop.select-branch-to-delete %} - ![Drop-down menu to select which branch to delete](/assets/images/help/desktop/select-branch-to-delete.png) + ![Drop-down menu to select which branch to delete](/assets/images/help/desktop/select-branch-from-dropdown.png) {% data reusables.desktop.delete-branch-win %} ![Delete... option in the Branch menu](/assets/images/help/desktop/delete-branch-win.png) @@ -120,3 +108,4 @@ You can't delete a branch if it's currently associated with an open pull request - "[Branch](/articles/github-glossary/#branch)" in the {% data variables.product.prodname_dotcom %} glossary - "[About branches](/articles/about-branches)" - "[Branches in a Nutshell](https://git-scm.com/book/en/v2/Git-Branching-Branches-in-a-Nutshell)" in the Git documentation +- "[Stashing changes](/desktop/contributing-and-collaborating-using-github-desktop/stashing-changes)" diff --git a/content/desktop/contributing-and-collaborating-using-github-desktop/stashing-changes.md b/content/desktop/contributing-and-collaborating-using-github-desktop/stashing-changes.md new file mode 100644 index 0000000000..54122ffc39 --- /dev/null +++ b/content/desktop/contributing-and-collaborating-using-github-desktop/stashing-changes.md @@ -0,0 +1,29 @@ +--- +title: Stashing changes +intro: You can temporarily save your changes without committing them to a branch by stashing the changes. +versions: + free-pro-team: '*' +--- + +### About stashed changes + +To apply your changes to your repository, you must save the files and then commit the changes to a branch. If you have saved changes that you are not ready to commit yet, you can stash the changes for later. When you stash changes, the changes are temporarily removed from the files and you can choose to restore or discard the changes later. You can only stash one set of changes at a time with {% data variables.product.prodname_desktop %}. If you use {% data variables.product.prodname_desktop %} to stash changes, all unsaved changes will be stashed. After you stash changes on a branch, you can safely change branches or make other changes to your current branch. + +If you use {% data variables.product.prodname_desktop %} to switch branches while you have saved, but not committed, changes, {% data variables.product.prodname_desktop %} will prompt you to stash the changes or bring them to the other branch. For more information, see "[Managing branches](/desktop/contributing-to-projects/managing-branches#switching-between-branches)." + +### Stashing changes + +{% data reusables.desktop.click-changed-files-header %} +{% data reusables.desktop.click-stash-all-changes %} + +### Restoring stashed changes + +{% data reusables.desktop.navigate-to-stashed-changes %} +{% data reusables.desktop.click-stashed-changes %} +{% data reusables.desktop.click-restore %} + +### Discarding stashed changes + +{% data reusables.desktop.navigate-to-stashed-changes %} +{% data reusables.desktop.click-stashed-changes %} +{% data reusables.desktop.click-discard %} diff --git a/content/desktop/installing-and-configuring-github-desktop/authenticating-to-github.md b/content/desktop/installing-and-configuring-github-desktop/authenticating-to-github.md index 8bb5f14c5a..dda5c4f092 100644 --- a/content/desktop/installing-and-configuring-github-desktop/authenticating-to-github.md +++ b/content/desktop/installing-and-configuring-github-desktop/authenticating-to-github.md @@ -24,7 +24,7 @@ Before you authenticate, {% data reusables.desktop.get-an-account %} 3. To the right of "{% data variables.product.prodname_dotcom_the_website %}," click **Sign In**. ![The Sign In button for GitHub](/assets/images/help/desktop/mac-sign-in-github.png) 4. In the "Sign in" pane, click **Sign in using your browser**. {% data variables.product.prodname_desktop %} will open your default browser. - ![The Sign in using your browser link](/assets/images/help/desktop/mac-sign-in-browser.png) + ![The Sign in using your browser link](/assets/images/help/desktop/sign-in-browser.png) {% data reusables.user_settings.password-authentication-deprecation-desktop %} @@ -54,7 +54,7 @@ Before you authenticate, {% data reusables.desktop.get-an-account %} 3. To the right of "GitHub.com," click **Sign in**. ![The Sign In button for GitHub](/assets/images/help/desktop/windows-sign-in-github.png) 4. In the Sign in pane, click **Sign in using your browser**. - ![The Sign in using your browser link](/assets/images/help/desktop/windows-sign-in-browser.png) + ![The Sign in using your browser link](/assets/images/help/desktop/sign-in-browser.png) {% data reusables.user_settings.password-authentication-deprecation-desktop %} diff --git a/content/developers/apps/about-apps.md b/content/developers/apps/about-apps.md index fff85efbab..e1c19c1da5 100644 --- a/content/developers/apps/about-apps.md +++ b/content/developers/apps/about-apps.md @@ -10,6 +10,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - github apps --- Apps on {% data variables.product.prodname_dotcom %} allow you to automate and improve your workflow. You can build apps to improve your workflow.{% if currentVersion == "free-pro-team@latest" %} You can also share or sell apps in [{% data variables.product.prodname_marketplace %}](https://github.com/marketplace). To learn how to list an app on {% data variables.product.prodname_marketplace %}, see "[Getting started with GitHub Marketplace](/marketplace/getting-started/)."{% endif %} diff --git a/content/developers/apps/activating-optional-features-for-apps.md b/content/developers/apps/activating-optional-features-for-apps.md index ef5f534d5b..79ef3adf87 100644 --- a/content/developers/apps/activating-optional-features-for-apps.md +++ b/content/developers/apps/activating-optional-features-for-apps.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' github-ae: '*' enterprise-server: '>=2.22' +topics: + - github apps --- {% warning %} diff --git a/content/developers/apps/authenticating-with-github-apps.md b/content/developers/apps/authenticating-with-github-apps.md index 45b446f810..46ab929b32 100644 --- a/content/developers/apps/authenticating-with-github-apps.md +++ b/content/developers/apps/authenticating-with-github-apps.md @@ -9,6 +9,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - github apps --- {% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.22" %} @@ -77,8 +79,8 @@ private_key = OpenSSL::PKey::RSA.new(private_pem) # Generate the JWT payload = { - # issued at time - iat: Time.now.to_i, + # issued at time, 60 seconds in the past to allow for clock drift + iat: Time.now.to_i - 60, # JWT expiration time (10 minute maximum) exp: Time.now.to_i + (10 * 60), # {% data variables.product.prodname_github_app %}'s identifier diff --git a/content/developers/apps/authorizing-oauth-apps.md b/content/developers/apps/authorizing-oauth-apps.md index 4a9ab098cc..cbf94e9bae 100644 --- a/content/developers/apps/authorizing-oauth-apps.md +++ b/content/developers/apps/authorizing-oauth-apps.md @@ -12,6 +12,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - oauth apps --- {% data variables.product.product_name %}'s OAuth implementation supports the standard [authorization code grant type](https://tools.ietf.org/html/rfc6749#section-4.1){% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %} and the OAuth 2.0 [Device Authorization Grant](https://tools.ietf.org/html/rfc8628) for apps that don't have access to a web browser{% endif %}. diff --git a/content/developers/apps/building-github-apps.md b/content/developers/apps/building-github-apps.md index 0012cdf9ce..8c79f00995 100644 --- a/content/developers/apps/building-github-apps.md +++ b/content/developers/apps/building-github-apps.md @@ -1,6 +1,6 @@ --- title: Building GitHub Apps -intro: You can build GitHub Apps for personal or public use. Learn how to register and set up permissions and authentication options for GitHub Apps. +intro: You can build GitHub Apps for yourself or others to use. Learn how to register and set up permissions and authentication options for GitHub Apps. mapTopic: true redirect_from: - /apps/building-integrations/setting-up-and-registering-github-apps/ @@ -9,5 +9,7 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - github apps --- diff --git a/content/developers/apps/building-oauth-apps.md b/content/developers/apps/building-oauth-apps.md index 92ea416d43..16fbbbf523 100644 --- a/content/developers/apps/building-oauth-apps.md +++ b/content/developers/apps/building-oauth-apps.md @@ -1,6 +1,6 @@ --- title: Building OAuth Apps -intro: You can build OAuth Apps for personal or public use. Learn how to register and set up permissions and authorization options for OAuth Apps. +intro: You can build OAuth Apps for yourself or others to use. Learn how to register and set up permissions and authorization options for OAuth Apps. mapTopic: true redirect_from: - /apps/building-integrations/setting-up-and-registering-oauth-apps/ @@ -9,5 +9,6 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - oauth apps --- - diff --git a/content/developers/apps/creating-a-custom-badge-for-your-github-app.md b/content/developers/apps/creating-a-custom-badge-for-your-github-app.md index c39b720c26..2f26017f1c 100644 --- a/content/developers/apps/creating-a-custom-badge-for-your-github-app.md +++ b/content/developers/apps/creating-a-custom-badge-for-your-github-app.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - github apps --- By default, a new GitHub App will have an automatically generated [identicon](https://github.com/blog/1586-identicons). diff --git a/content/developers/apps/creating-a-custom-badge-for-your-oauth-app.md b/content/developers/apps/creating-a-custom-badge-for-your-oauth-app.md index 9945833d00..f39207563e 100644 --- a/content/developers/apps/creating-a-custom-badge-for-your-oauth-app.md +++ b/content/developers/apps/creating-a-custom-badge-for-your-oauth-app.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - oauth apps --- By default, a new OAuth App will have an automatically generated [identicon](https://github.com/blog/1586-identicons). diff --git a/content/developers/apps/creating-a-github-app-from-a-manifest.md b/content/developers/apps/creating-a-github-app-from-a-manifest.md index 7c18a8b460..22c65eacfa 100644 --- a/content/developers/apps/creating-a-github-app-from-a-manifest.md +++ b/content/developers/apps/creating-a-github-app-from-a-manifest.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - github apps --- diff --git a/content/developers/apps/creating-a-github-app-using-url-parameters.md b/content/developers/apps/creating-a-github-app-using-url-parameters.md index 99d0f03a93..a4794039ea 100644 --- a/content/developers/apps/creating-a-github-app-using-url-parameters.md +++ b/content/developers/apps/creating-a-github-app-using-url-parameters.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - github apps --- diff --git a/content/developers/apps/creating-a-github-app.md b/content/developers/apps/creating-a-github-app.md index 054cc4493a..63b95c7eae 100644 --- a/content/developers/apps/creating-a-github-app.md +++ b/content/developers/apps/creating-a-github-app.md @@ -9,6 +9,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - github apps --- {% if currentVersion == "free-pro-team@latest" %}To learn how to use GitHub App Manifests, which allow people to create preconfigured GitHub Apps, see "[Creating GitHub Apps from a manifest](/apps/building-github-apps/creating-github-apps-from-a-manifest/)."{% endif %} @@ -75,7 +77,7 @@ versions: 13. In "Permissions", choose the permissions your app will request. For each type of permission, use the drop-down menu and click **Read-only**, **Read & write**, or **No access**. ![Various permissions for your GitHub App](/assets/images/github-apps/github_apps_new_permissions_post2dot13.png) -14. In "Subscribe to events", choose whether to subscribe your app to **Label**, **Public**, **Repository**, or **Watch** events. ![Subscribe to events options for your GitHub App](/assets/images/github-apps/github_apps_subscribe_to_events.png) +14. In "Subscribe to events", choose the events you want your app to receive. 15. To choose where the app can be installed, select either **Only on this account** or **Any account**. For more information on installation options, see "[Making a GitHub App public or private](/apps/managing-github-apps/making-a-github-app-public-or-private/)." ![Installation options for your GitHub App](/assets/images/github-apps/github_apps_installation_options.png) 16. Click **Create GitHub App**. diff --git a/content/developers/apps/creating-an-oauth-app.md b/content/developers/apps/creating-an-oauth-app.md index c885dc2134..0340b236ef 100644 --- a/content/developers/apps/creating-an-oauth-app.md +++ b/content/developers/apps/creating-an-oauth-app.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - oauth apps --- {% if currentVersion == "free-pro-team@latest" %} diff --git a/content/developers/apps/creating-ci-tests-with-the-checks-api.md b/content/developers/apps/creating-ci-tests-with-the-checks-api.md index e964e7b055..8d8bd1e520 100644 --- a/content/developers/apps/creating-ci-tests-with-the-checks-api.md +++ b/content/developers/apps/creating-ci-tests-with-the-checks-api.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - github apps --- diff --git a/content/developers/apps/deleting-a-github-app.md b/content/developers/apps/deleting-a-github-app.md index 6c32b8f7f9..7c40c0b61d 100644 --- a/content/developers/apps/deleting-a-github-app.md +++ b/content/developers/apps/deleting-a-github-app.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - github apps --- {% data reusables.user-settings.access_settings %} diff --git a/content/developers/apps/deleting-an-oauth-app.md b/content/developers/apps/deleting-an-oauth-app.md index cdf87e56e0..75eb74ad1a 100644 --- a/content/developers/apps/deleting-an-oauth-app.md +++ b/content/developers/apps/deleting-an-oauth-app.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - oauth apps --- {% data reusables.user-settings.access_settings %} diff --git a/content/developers/apps/differences-between-github-apps-and-oauth-apps.md b/content/developers/apps/differences-between-github-apps-and-oauth-apps.md index 091642a8f7..c1c8b1c125 100644 --- a/content/developers/apps/differences-between-github-apps-and-oauth-apps.md +++ b/content/developers/apps/differences-between-github-apps-and-oauth-apps.md @@ -9,6 +9,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - github apps + - oauth apps --- ### Who can install GitHub Apps and authorize OAuth Apps? diff --git a/content/developers/apps/editing-a-github-apps-permissions.md b/content/developers/apps/editing-a-github-apps-permissions.md index d57db219a1..62ec4ae5c0 100644 --- a/content/developers/apps/editing-a-github-apps-permissions.md +++ b/content/developers/apps/editing-a-github-apps-permissions.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - github apps --- {% note %} diff --git a/content/developers/apps/getting-started-with-apps.md b/content/developers/apps/getting-started-with-apps.md index d6bc3d7a0f..46aa599b97 100644 --- a/content/developers/apps/getting-started-with-apps.md +++ b/content/developers/apps/getting-started-with-apps.md @@ -6,5 +6,7 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - github apps --- diff --git a/content/developers/apps/guides.md b/content/developers/apps/guides.md index 1e90f02406..125c0f5c42 100644 --- a/content/developers/apps/guides.md +++ b/content/developers/apps/guides.md @@ -8,5 +8,7 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - github apps --- diff --git a/content/developers/apps/identifying-and-authorizing-users-for-github-apps.md b/content/developers/apps/identifying-and-authorizing-users-for-github-apps.md index 0c27bda883..6f235d3ca0 100644 --- a/content/developers/apps/identifying-and-authorizing-users-for-github-apps.md +++ b/content/developers/apps/identifying-and-authorizing-users-for-github-apps.md @@ -9,6 +9,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - github apps --- diff --git a/content/developers/apps/index.md b/content/developers/apps/index.md index e384433f90..5dab758c53 100644 --- a/content/developers/apps/index.md +++ b/content/developers/apps/index.md @@ -13,6 +13,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - github apps --- {% topic_link_in_list /getting-started-with-apps %} diff --git a/content/developers/apps/installing-github-apps.md b/content/developers/apps/installing-github-apps.md index 3e54b9d622..59215beea0 100644 --- a/content/developers/apps/installing-github-apps.md +++ b/content/developers/apps/installing-github-apps.md @@ -1,12 +1,14 @@ --- title: Installing GitHub Apps -intro: 'When your app is public, anyone can install your app on their repository through {% if currentVersion == "free-pro-team@latest" %} the {% data variables.product.prodname_marketplace %} or {% endif %}an installation URL. When your app is private, you can only install the app on repositories that you own.' +intro: 'When your app is public, anyone can use {% if currentVersion == "free-pro-team@latest" %} the {% data variables.product.prodname_marketplace %} or {% endif %}an installation URL to install the app on their repository. When your app is private, only you can install the app on repositories that you own.' redirect_from: - /apps/installing-github-apps versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - github apps --- {% note %} diff --git a/content/developers/apps/making-a-github-app-public-or-private.md b/content/developers/apps/making-a-github-app-public-or-private.md index 779af339cb..37f0bee15c 100644 --- a/content/developers/apps/making-a-github-app-public-or-private.md +++ b/content/developers/apps/making-a-github-app-public-or-private.md @@ -11,13 +11,15 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - github apps --- For authentication information, see "[Authenticating with GitHub Apps](/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation)." ### Public installation flow -Public installation flows have a landing page where users begin the installation flow. This link is provided in the "Public link" field when setting up your GitHub App. For more information, see "[Installing GitHub Apps](/apps/installing-github-apps/)." +Public installation flows have a landing page to enable other people besides the app owner to install the app in their repositories. This link is provided in the "Public link" field when setting up your GitHub App. For more information, see "[Installing GitHub Apps](/apps/installing-github-apps/)." ### Private installation flow diff --git a/content/developers/apps/managing-github-apps.md b/content/developers/apps/managing-github-apps.md index fb3b9c3934..0bab3a14a5 100644 --- a/content/developers/apps/managing-github-apps.md +++ b/content/developers/apps/managing-github-apps.md @@ -9,5 +9,7 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - github apps --- diff --git a/content/developers/apps/managing-oauth-apps.md b/content/developers/apps/managing-oauth-apps.md index e1bf769ded..18cb006f91 100644 --- a/content/developers/apps/managing-oauth-apps.md +++ b/content/developers/apps/managing-oauth-apps.md @@ -9,5 +9,6 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - oauth apps --- - diff --git a/content/developers/apps/migrating-oauth-apps-to-github-apps.md b/content/developers/apps/migrating-oauth-apps-to-github-apps.md index 21fbe532f2..eedbac7a4c 100644 --- a/content/developers/apps/migrating-oauth-apps-to-github-apps.md +++ b/content/developers/apps/migrating-oauth-apps-to-github-apps.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - github apps --- diff --git a/content/developers/apps/modifying-a-github-app.md b/content/developers/apps/modifying-a-github-app.md index 47392e13f0..39278961f9 100644 --- a/content/developers/apps/modifying-a-github-app.md +++ b/content/developers/apps/modifying-a-github-app.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - github apps --- {% data reusables.user-settings.access_settings %} diff --git a/content/developers/apps/modifying-an-oauth-app.md b/content/developers/apps/modifying-an-oauth-app.md index 73beec3337..7b15a86e19 100644 --- a/content/developers/apps/modifying-an-oauth-app.md +++ b/content/developers/apps/modifying-an-oauth-app.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - oauth apps --- {% data reusables.user-settings.access_settings %} diff --git a/content/developers/apps/rate-limits-for-github-apps.md b/content/developers/apps/rate-limits-for-github-apps.md index 31607e2e14..2451916675 100644 --- a/content/developers/apps/rate-limits-for-github-apps.md +++ b/content/developers/apps/rate-limits-for-github-apps.md @@ -10,6 +10,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - github apps --- ### Server-to-server requests diff --git a/content/developers/apps/refreshing-user-to-server-access-tokens.md b/content/developers/apps/refreshing-user-to-server-access-tokens.md index 3a21601f34..ca66b82b31 100644 --- a/content/developers/apps/refreshing-user-to-server-access-tokens.md +++ b/content/developers/apps/refreshing-user-to-server-access-tokens.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '>=2.22' github-ae: '*' +topics: + - github apps --- diff --git a/content/developers/apps/scopes-for-oauth-apps.md b/content/developers/apps/scopes-for-oauth-apps.md index 29a3c06f2f..db6e245649 100644 --- a/content/developers/apps/scopes-for-oauth-apps.md +++ b/content/developers/apps/scopes-for-oauth-apps.md @@ -9,6 +9,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - oauth apps --- When setting up an OAuth App on GitHub, requested scopes are displayed to the user on the authorization form. @@ -38,19 +40,19 @@ X-Accepted-OAuth-Scopes: user ### Available scopes Name | Description ------|-----------| -**`(no scope)`** | Grants read-only access to public information (includes public user profile info, public repository info, and gists){% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %} +-----|-----------|{% if currentVersion != "github-ae@latest" %} +**`(no scope)`** | Grants read-only access to public information (including user profile info, repository info, and gists){% endif %}{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %} **`site_admin`** | Grants site administrators access to [{% data variables.product.prodname_ghe_server %} Administration API endpoints](/rest/reference/enterprise-admin).{% endif %} -**`repo`** | Grants full access to private and public repositories. That includes read/write access to code, commit statuses, repository and organization projects, invitations, collaborators, adding team memberships, deployment statuses, and repository webhooks for public and private repositories and organizations. Also grants ability to manage user projects. - `repo:status`| Grants read/write access to public and private repository commit statuses. This scope is only necessary to grant other users or services access to private repository commit statuses *without* granting access to the code. - `repo_deployment`| Grants access to [deployment statuses](/rest/reference/repos#deployments) for public and private repositories. This scope is only necessary to grant other users or services access to deployment statuses, *without* granting access to the code. - `public_repo`| Limits access to public repositories. That includes read/write access to code, commit statuses, repository projects, collaborators, and deployment statuses for public repositories and organizations. Also required for starring public repositories. +**`repo`** | Grants full access to repositories, including private repositories. That includes read/write access to code, commit statuses, repository and organization projects, invitations, collaborators, adding team memberships, deployment statuses, and repository webhooks for repositories and organizations. Also grants ability to manage user projects. + `repo:status`| Grants read/write access to {% if currentVersion != "github-ae@latest" %}public{% else %}internal{% endif %} and private repository commit statuses. This scope is only necessary to grant other users or services access to private repository commit statuses *without* granting access to the code. + `repo_deployment`| Grants access to [deployment statuses](/rest/reference/repos#deployments) for {% if currentVersion != "github-ae@latest" %}public{% else %}internal{% endif %} and private repositories. This scope is only necessary to grant other users or services access to deployment statuses, *without* granting access to the code.{% if currentVersion != "github-ae@latest" %} + `public_repo`| Limits access to public repositories. That includes read/write access to code, commit statuses, repository projects, collaborators, and deployment statuses for public repositories and organizations. Also required for starring public repositories.{% endif %}  `repo:invite` | Grants accept/decline abilities for invitations to collaborate on a repository. This scope is only necessary to grant other users or services access to invites *without* granting access to the code.{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}  `security_events` | Grants:
read and write access to security events in the [{% data variables.product.prodname_code_scanning %} API](/rest/reference/code-scanning)
read and write access to security events in the [{% data variables.product.prodname_secret_scanning %} API](/rest/reference/secret-scanning)
This scope is only necessary to grant other users or services access to security events *without* granting access to the code.{% endif %}{% if currentVersion ver_gt "enterprise-server@2.21" and currentVersion ver_lt "enterprise-server@3.1" %}  `security_events` | Grants read and write access to security events in the [{% data variables.product.prodname_code_scanning %} API](/rest/reference/code-scanning). This scope is only necessary to grant other users or services access to security events *without* granting access to the code.{% endif %} -**`admin:repo_hook`** | Grants read, write, ping, and delete access to repository hooks in public and private repositories. The `repo` and `public_repo` scopes grants full access to repositories, including repository hooks. Use the `admin:repo_hook` scope to limit access to only repository hooks. - `write:repo_hook` | Grants read, write, and ping access to hooks in public or private repositories. - `read:repo_hook`| Grants read and ping access to hooks in public or private repositories. +**`admin:repo_hook`** | Grants read, write, ping, and delete access to repository hooks in {% if currentVersion != "github-ae@latest" %}public{% else %}internal{% endif %} and private repositories. The `repo` {% if currentVersion != "github-ae@latest" %}and `public_repo` scopes grant{% else %}scope grants{% endif %} full access to repositories, including repository hooks. Use the `admin:repo_hook` scope to limit access to only repository hooks. + `write:repo_hook` | Grants read, write, and ping access to hooks in {% if currentVersion != "github-ae@latest" %}public{% else %}internal{% endif %} or private repositories. + `read:repo_hook`| Grants read and ping access to hooks in {% if currentVersion != "github-ae@latest" %}public{% else %}internal{% endif %} or private repositories. **`admin:org`** | Fully manage the organization and its teams, projects, and memberships.  `write:org`| Read and write access to organization membership, organization projects, and team membership.  `read:org`| Read-only access to organization membership, organization projects, and team membership. @@ -66,10 +68,10 @@ Name | Description  `user:follow`| Grants access to follow or unfollow other users. **`delete_repo`** | Grants access to delete adminable repositories. **`write:discussion`** | Allows read and write access for team discussions. - `read:discussion` | Allows read access for team discussions.{% if currentVersion == "free-pro-team@latest" %} + `read:discussion` | Allows read access for team discussions.{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" %} **`write:packages`** | Grants access to upload or publish a package in {% data variables.product.prodname_registry %}. For more information, see "[Publishing a package](/github/managing-packages-with-github-packages/publishing-a-package)". **`read:packages`** | Grants access to download or install packages from {% data variables.product.prodname_registry %}. For more information, see "[Installing a package](/github/managing-packages-with-github-packages/installing-a-package)". -**`delete:packages`** | Grants access to delete packages from {% data variables.product.prodname_registry %}. For more information, see "[Deleting packages](/packages/learn-github-packages/deleting-and-restoring-a-package)".{% endif %} +**`delete:packages`** | Grants access to delete packages from {% data variables.product.prodname_registry %}. For more information, see "{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif currentVersion ver_lt "enterprise-server@3.1" or currentVersion == "github-ae@latest" %}[Deleting a package](/packages/learn-github-packages/deleting-a-package){% endif %}."{% endif %} **`admin:gpg_key`** | Fully manage GPG keys.  `write:gpg_key`| Create, list, and view details for GPG keys.  `read:gpg_key`| List and view details for GPG keys.{% if currentVersion == "free-pro-team@latest" %} @@ -78,11 +80,11 @@ Name | Description {% note %} **Note:** Your OAuth App can request the scopes in the initial redirection. You -can specify multiple scopes by separating them with a space: +can specify multiple scopes by separating them with a space using `%20`: https://github.com/login/oauth/authorize? client_id=...& - scope=user%20public_repo + scope=user%20repo_deployment {% endnote %} diff --git a/content/developers/apps/setting-permissions-for-github-apps.md b/content/developers/apps/setting-permissions-for-github-apps.md index c7b9470177..4d9c1fb557 100644 --- a/content/developers/apps/setting-permissions-for-github-apps.md +++ b/content/developers/apps/setting-permissions-for-github-apps.md @@ -9,12 +9,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - github apps --- -When you create a GitHub App, you can select the permissions it needs to access end user data. Permissions can also be added and removed. For more information, see "[Editing a GitHub App's permissions](/apps/managing-github-apps/editing-a-github-app-s-permissions/)." - -### Metadata permissions - -By default, GitHub Apps have `Read-only` access to metadata endpoints. Metadata is a collection of read-only endpoints that provide general information about resources that the authorized installation can access. - -{% data reusables.apps.metadata-permissions %} For a list of metadata endpoints, see "[Metadata permissions](/rest/reference/permissions-required-for-github-apps#metadata-permissions)." +GitHub Apps don't have any permissions by default. When you create a GitHub App, you can select the permissions it needs to access end user data. Permissions can also be added and removed. For more information, see "[Editing a GitHub App's permissions](/apps/managing-github-apps/editing-a-github-app-s-permissions/)." diff --git a/content/developers/apps/setting-up-your-development-environment-to-create-a-github-app.md b/content/developers/apps/setting-up-your-development-environment-to-create-a-github-app.md index 0c32f55b6c..6e4d57a597 100644 --- a/content/developers/apps/setting-up-your-development-environment-to-create-a-github-app.md +++ b/content/developers/apps/setting-up-your-development-environment-to-create-a-github-app.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - github apps --- @@ -115,7 +117,8 @@ You'll see a form where you can enter details about your app. See "[Creating a G ![Form with webhook secret filled in](/assets/images/webhook-secret.png) -* On the Permissions & Webhooks page, you can specify a set of permissions for your app, which determines how much data your app has access to. Leave this page with its default values. If you decide to extend this template app, you can update these permissions later. +* On the Permissions & Webhooks page, you can specify a set of permissions for your app, which determines how much data your app has access to. Under the "Repository permissions" + section, scroll down to "Metadata" and select `Access: Read-only`. If you decide to extend this template app, you can update these permissions later. * At the bottom of the Permissions & Webhooks page, specify whether this is a private app or a public app. This refers to who can install it: just you, or anyone in the world? For now, leave the app as private by selecting **Only on this account**. @@ -150,7 +153,7 @@ You need to add these variables to the `.env` file: Here is an example `.env` file: ``` -PRIVATE_KEY="-----BEGIN RSA PRIVATE KEY----- +GITHUB_PRIVATE_KEY="-----BEGIN RSA PRIVATE KEY----- ... HkVN9... ... @@ -401,7 +404,7 @@ Here are a few common problems and some suggested solutions. If you run into any **A:** You probably haven't set up your private key environment variable quite right. Your `GITHUB_PRIVATE_KEY` variable should look like this: ``` - PRIVATE_KEY="-----BEGIN RSA PRIVATE KEY----- + GITHUB_PRIVATE_KEY="-----BEGIN RSA PRIVATE KEY----- ... HkVN9... ... @@ -420,7 +423,7 @@ Here are a few common problems and some suggested solutions. If you run into any * **Q:** My server isn't listening to events! The Smee client is running in a Terminal window, and I'm installing the app on a repository on GitHub, but I don't see any output in the Terminal window where I'm running the server. - **A:** You may not be running the Smee client, or you may not have the correct Smee domain in your GitHub App settings. First check to make sure the Smee client is running in a Terminal tab. If that's not the problem, visit your [app settings page](https://github.com/settings/apps) and check the fields shown in "[Step 2. Register a new GitHub App](#step-2-register-a-new-github-app)." Make sure the domain in those fields matches the domain you used in your `smee -u ` command in "[Step 1. Start a new Smee channel](#step-1-start-a-new-smee-channel)." + **A:** You may not be running the Smee client, running the Smee command with the wrong parameters or you may not have the correct Smee domain in your GitHub App settings. First check to make sure the Smee client is running in a Terminal tab. If that's not the problem, visit your [app settings page](https://github.com/settings/apps) and check the fields shown in "[Step 2. Register a new GitHub App](#step-2-register-a-new-github-app)." Make sure the domain in those fields matches the domain you used in your `smee -u ` command in "[Step 1. Start a new Smee channel](#step-1-start-a-new-smee-channel)." If none of the above work, check that you are running the full Smee command including the `--path` and `--port` options, for example: `smee --url https://smee.io/qrfeVRbFbffd6vD --path /event_handler --port 3000` (replacing `https://smee.io/qrfeVRbFbffd6vD` with your own Smee domain). * **Q:** I'm getting an `Octokit::NotFound` 404 error in my debug output: ``` diff --git a/content/developers/apps/suspending-a-github-app-installation.md b/content/developers/apps/suspending-a-github-app-installation.md index 8ec4ca2e06..a619a27810 100644 --- a/content/developers/apps/suspending-a-github-app-installation.md +++ b/content/developers/apps/suspending-a-github-app-installation.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '>=2.22' github-ae: '*' +topics: + - github apps --- ### Suspending a GitHub App diff --git a/content/developers/apps/transferring-ownership-of-a-github-app.md b/content/developers/apps/transferring-ownership-of-a-github-app.md index 118908599d..0d9f093edf 100644 --- a/content/developers/apps/transferring-ownership-of-a-github-app.md +++ b/content/developers/apps/transferring-ownership-of-a-github-app.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - github apps --- {% data reusables.user-settings.access_settings %} diff --git a/content/developers/apps/transferring-ownership-of-an-oauth-app.md b/content/developers/apps/transferring-ownership-of-an-oauth-app.md index 59d1b1adc3..023d8477dd 100644 --- a/content/developers/apps/transferring-ownership-of-an-oauth-app.md +++ b/content/developers/apps/transferring-ownership-of-an-oauth-app.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - oauth apps --- {% data reusables.user-settings.access_settings %} diff --git a/content/developers/apps/troubleshooting-authorization-request-errors.md b/content/developers/apps/troubleshooting-authorization-request-errors.md index 4620a4aa35..aed485cc2b 100644 --- a/content/developers/apps/troubleshooting-authorization-request-errors.md +++ b/content/developers/apps/troubleshooting-authorization-request-errors.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - github apps --- ### Application suspended diff --git a/content/developers/apps/troubleshooting-oauth-app-access-token-request-errors.md b/content/developers/apps/troubleshooting-oauth-app-access-token-request-errors.md index c6b54ed2b2..af14d42307 100644 --- a/content/developers/apps/troubleshooting-oauth-app-access-token-request-errors.md +++ b/content/developers/apps/troubleshooting-oauth-app-access-token-request-errors.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - oauth apps --- {% note %} diff --git a/content/developers/apps/using-content-attachments.md b/content/developers/apps/using-content-attachments.md index 3bbe27bf11..8fc9225435 100644 --- a/content/developers/apps/using-content-attachments.md +++ b/content/developers/apps/using-content-attachments.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - github apps --- {% data reusables.pre-release-program.content-attachments-public-beta %} @@ -77,7 +79,7 @@ For more information about creating an installation token, see "[Authenticating **Step 5.** You'll see the new content attachment appear under the link in a pull request or issue comment: -![Content attached to a reference in an issue](/assets/images/github-apps/github_apps_content_reference_attachment.png) +![Content attached to a reference in an issue](/assets/images/github-apps/content_reference_attachment.png) ### Using content attachments in GraphQL We provide the `node_id` in the [`content_reference` webhook](/webhooks/event-payloads/#content_reference) event so you can refer to the `createContentAttachment` mutation in the GraphQL API. @@ -175,4 +177,4 @@ To create a Probot App, follow these steps: 7. Add a comment to the issue you opened that includes the URL you configured in the `app.yml` file. 8. Take a look at the issue comment and you'll see an update that looks like this: - ![Content attached to a reference in an issue](/assets/images/github-apps/github_apps_content_reference_attachment.png) + ![Content attached to a reference in an issue](/assets/images/github-apps/content_reference_attachment.png) diff --git a/content/developers/apps/using-the-github-api-in-your-app.md b/content/developers/apps/using-the-github-api-in-your-app.md index ebd8e6ed71..d128429499 100644 --- a/content/developers/apps/using-the-github-api-in-your-app.md +++ b/content/developers/apps/using-the-github-api-in-your-app.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - github apps --- diff --git a/content/developers/github-marketplace/about-github-marketplace.md b/content/developers/github-marketplace/about-github-marketplace.md index a5566fb012..cc3ca5561e 100644 --- a/content/developers/github-marketplace/about-github-marketplace.md +++ b/content/developers/github-marketplace/about-github-marketplace.md @@ -6,6 +6,8 @@ redirect_from: - /marketplace/getting-started versions: free-pro-team: '*' +topics: + - marketplace --- [{% data variables.product.prodname_marketplace %}](https://github.com/marketplace) connects you to developers who want to extend and improve their {% data variables.product.prodname_dotcom %} workflows. You can list free and paid tools for developers to use in {% data variables.product.prodname_marketplace %}. {% data variables.product.prodname_marketplace %} offers developers two types of tools: {% data variables.product.prodname_actions %} and Apps, and each tool requires different steps for adding it to {% data variables.product.prodname_marketplace %}. diff --git a/content/developers/github-marketplace/applying-for-publisher-verification-for-your-organization.md b/content/developers/github-marketplace/applying-for-publisher-verification-for-your-organization.md index 8919eee16e..f6c6257f9d 100644 --- a/content/developers/github-marketplace/applying-for-publisher-verification-for-your-organization.md +++ b/content/developers/github-marketplace/applying-for-publisher-verification-for-your-organization.md @@ -3,6 +3,8 @@ title: Applying for publisher verification for your organization intro: 'To offer paid plans for your app or to include a marketplace badge in your app listing, you must complete the publisher verification process for your organization.' versions: free-pro-team: '*' +topics: + - marketplace --- Publisher verification ensures that {% data variables.product.prodname_dotcom %} has a way to contact you, that you've enabled two-factor authentication for your organization, and that your organization's domain has been verified. diff --git a/content/developers/github-marketplace/billing-customers.md b/content/developers/github-marketplace/billing-customers.md index ed6701d671..2e578e1458 100644 --- a/content/developers/github-marketplace/billing-customers.md +++ b/content/developers/github-marketplace/billing-customers.md @@ -7,6 +7,8 @@ redirect_from: - /marketplace/selling-your-app/billing-customers-in-github-marketplace versions: free-pro-team: '*' +topics: + - marketplace --- diff --git a/content/developers/github-marketplace/configuring-a-webhook-to-notify-you-of-plan-changes.md b/content/developers/github-marketplace/configuring-a-webhook-to-notify-you-of-plan-changes.md index 6ed97feecd..00e34854f1 100644 --- a/content/developers/github-marketplace/configuring-a-webhook-to-notify-you-of-plan-changes.md +++ b/content/developers/github-marketplace/configuring-a-webhook-to-notify-you-of-plan-changes.md @@ -9,6 +9,8 @@ redirect_from: - /marketplace/listing-on-github-marketplace/configuring-the-github-marketplace-webhook versions: free-pro-team: '*' +topics: + - marketplace --- diff --git a/content/developers/github-marketplace/creating-apps-for-github-marketplace.md b/content/developers/github-marketplace/creating-apps-for-github-marketplace.md index 342754e94d..1db26ad8f2 100644 --- a/content/developers/github-marketplace/creating-apps-for-github-marketplace.md +++ b/content/developers/github-marketplace/creating-apps-for-github-marketplace.md @@ -4,5 +4,7 @@ intro: 'You can list free and paid tools for developers to use in {% data variab mapTopic: true versions: free-pro-team: '*' +topics: + - marketplace --- diff --git a/content/developers/github-marketplace/customer-experience-best-practices-for-apps.md b/content/developers/github-marketplace/customer-experience-best-practices-for-apps.md index 4107fa4427..b739663a7d 100644 --- a/content/developers/github-marketplace/customer-experience-best-practices-for-apps.md +++ b/content/developers/github-marketplace/customer-experience-best-practices-for-apps.md @@ -1,9 +1,11 @@ --- title: Customer experience best practices for apps -intro: 'Guidelines for creating an app that will be easy to use and understand.' +intro: Guidelines for creating an app that will be easy to use and understand. shortTitle: Customer experience best practice versions: free-pro-team: '*' +topics: + - marketplace --- If you follow these best practices it will help you to provide a good customer experience. diff --git a/content/developers/github-marketplace/drafting-a-listing-for-your-app.md b/content/developers/github-marketplace/drafting-a-listing-for-your-app.md index c495928b43..85fcb55cc2 100644 --- a/content/developers/github-marketplace/drafting-a-listing-for-your-app.md +++ b/content/developers/github-marketplace/drafting-a-listing-for-your-app.md @@ -14,6 +14,8 @@ redirect_from: - /marketplace/listing-on-github-marketplace/creating-a-draft-github-marketplace-listing versions: free-pro-team: '*' +topics: + - marketplace --- diff --git a/content/developers/github-marketplace/handling-new-purchases-and-free-trials.md b/content/developers/github-marketplace/handling-new-purchases-and-free-trials.md index 94b29c63ff..0809b8196c 100644 --- a/content/developers/github-marketplace/handling-new-purchases-and-free-trials.md +++ b/content/developers/github-marketplace/handling-new-purchases-and-free-trials.md @@ -8,6 +8,8 @@ redirect_from: - /marketplace/integrating-with-the-github-marketplace-api/handling-new-purchases-and-free-trials versions: free-pro-team: '*' +topics: + - marketplace --- diff --git a/content/developers/github-marketplace/handling-plan-cancellations.md b/content/developers/github-marketplace/handling-plan-cancellations.md index ed287efb5e..2334e0fe9a 100644 --- a/content/developers/github-marketplace/handling-plan-cancellations.md +++ b/content/developers/github-marketplace/handling-plan-cancellations.md @@ -7,6 +7,8 @@ redirect_from: - /marketplace/integrating-with-the-github-marketplace-api/cancelling-plans versions: free-pro-team: '*' +topics: + - marketplace --- diff --git a/content/developers/github-marketplace/handling-plan-changes.md b/content/developers/github-marketplace/handling-plan-changes.md index 7fb64dd96c..a567ed24d9 100644 --- a/content/developers/github-marketplace/handling-plan-changes.md +++ b/content/developers/github-marketplace/handling-plan-changes.md @@ -7,6 +7,8 @@ redirect_from: - /marketplace/integrating-with-the-github-marketplace-api/upgrading-and-downgrading-plans versions: free-pro-team: '*' +topics: + - marketplace --- diff --git a/content/developers/github-marketplace/index.md b/content/developers/github-marketplace/index.md index 9d018cfe81..96571894ae 100644 --- a/content/developers/github-marketplace/index.md +++ b/content/developers/github-marketplace/index.md @@ -7,6 +7,8 @@ redirect_from: - /marketplace versions: free-pro-team: '*' +topics: + - marketplace --- {% topic_link_in_list /github-marketplace-overview %} diff --git a/content/developers/github-marketplace/listing-an-app-on-github-marketplace.md b/content/developers/github-marketplace/listing-an-app-on-github-marketplace.md index 58924a15d0..cfe604c53e 100644 --- a/content/developers/github-marketplace/listing-an-app-on-github-marketplace.md +++ b/content/developers/github-marketplace/listing-an-app-on-github-marketplace.md @@ -13,5 +13,7 @@ redirect_from: - /marketplace/listing-on-github-marketplace versions: free-pro-team: '*' +topics: + - marketplace --- diff --git a/content/developers/github-marketplace/pricing-plans-for-github-marketplace-apps.md b/content/developers/github-marketplace/pricing-plans-for-github-marketplace-apps.md index 8e76577810..33e7aeeccc 100644 --- a/content/developers/github-marketplace/pricing-plans-for-github-marketplace-apps.md +++ b/content/developers/github-marketplace/pricing-plans-for-github-marketplace-apps.md @@ -6,6 +6,8 @@ redirect_from: - /marketplace/selling-your-app/github-marketplace-pricing-plans versions: free-pro-team: '*' +topics: + - marketplace --- diff --git a/content/developers/github-marketplace/receiving-payment-for-app-purchases.md b/content/developers/github-marketplace/receiving-payment-for-app-purchases.md index 0264e77e2e..85bb104042 100644 --- a/content/developers/github-marketplace/receiving-payment-for-app-purchases.md +++ b/content/developers/github-marketplace/receiving-payment-for-app-purchases.md @@ -9,6 +9,8 @@ redirect_from: - /marketplace/selling-your-app/receiving-payment-for-github-marketplace-listings versions: free-pro-team: '*' +topics: + - marketplace --- diff --git a/content/developers/github-marketplace/requirements-for-listing-an-app.md b/content/developers/github-marketplace/requirements-for-listing-an-app.md index 3a2a3d1be3..05213fa2b8 100644 --- a/content/developers/github-marketplace/requirements-for-listing-an-app.md +++ b/content/developers/github-marketplace/requirements-for-listing-an-app.md @@ -10,6 +10,8 @@ redirect_from: - /marketplace/getting-started/requirements-for-listing-an-app-on-github-marketplace versions: free-pro-team: '*' +topics: + - marketplace --- diff --git a/content/developers/github-marketplace/rest-endpoints-for-the-github-marketplace-api.md b/content/developers/github-marketplace/rest-endpoints-for-the-github-marketplace-api.md index db3482b992..09ae762f88 100644 --- a/content/developers/github-marketplace/rest-endpoints-for-the-github-marketplace-api.md +++ b/content/developers/github-marketplace/rest-endpoints-for-the-github-marketplace-api.md @@ -7,6 +7,8 @@ redirect_from: - /marketplace/integrating-with-the-github-marketplace-api/github-marketplace-rest-api-endpoints versions: free-pro-team: '*' +topics: + - marketplace --- diff --git a/content/developers/github-marketplace/security-best-practices-for-apps.md b/content/developers/github-marketplace/security-best-practices-for-apps.md index fac3d2fcf6..b8be78bbfa 100644 --- a/content/developers/github-marketplace/security-best-practices-for-apps.md +++ b/content/developers/github-marketplace/security-best-practices-for-apps.md @@ -8,6 +8,8 @@ redirect_from: shortTitle: Security best practice versions: free-pro-team: '*' +topics: + - marketplace --- If you follow these best practices it will help you to provide a secure user experience. diff --git a/content/developers/github-marketplace/selling-your-app-on-github-marketplace.md b/content/developers/github-marketplace/selling-your-app-on-github-marketplace.md index e468593f58..5b643723ff 100644 --- a/content/developers/github-marketplace/selling-your-app-on-github-marketplace.md +++ b/content/developers/github-marketplace/selling-your-app-on-github-marketplace.md @@ -11,5 +11,7 @@ redirect_from: - /marketplace/selling-your-app versions: free-pro-team: '*' +topics: + - marketplace --- diff --git a/content/developers/github-marketplace/setting-pricing-plans-for-your-listing.md b/content/developers/github-marketplace/setting-pricing-plans-for-your-listing.md index 14fb5e0e67..7b7f3014d4 100644 --- a/content/developers/github-marketplace/setting-pricing-plans-for-your-listing.md +++ b/content/developers/github-marketplace/setting-pricing-plans-for-your-listing.md @@ -15,6 +15,8 @@ redirect_from: - /marketplace/listing-on-github-marketplace/setting-a-github-marketplace-listing-s-pricing-plan versions: free-pro-team: '*' +topics: + - marketplace --- ### About setting pricing plans diff --git a/content/developers/github-marketplace/submitting-your-listing-for-publication.md b/content/developers/github-marketplace/submitting-your-listing-for-publication.md index f56182b6ba..eba474e22e 100644 --- a/content/developers/github-marketplace/submitting-your-listing-for-publication.md +++ b/content/developers/github-marketplace/submitting-your-listing-for-publication.md @@ -6,6 +6,8 @@ redirect_from: - /developers/github-marketplace/submitting-your-listing-for-review versions: free-pro-team: '*' +topics: + - marketplace --- Once your app listing meets the {% data variables.product.prodname_marketplace %} requirements, you can submit your app. For an overview of the app listing requirements, see "[Requirements for listing an app](/developers/github-marketplace/requirements-for-listing-an-app)." diff --git a/content/developers/github-marketplace/testing-your-app.md b/content/developers/github-marketplace/testing-your-app.md index 577b6d624a..e587a94908 100644 --- a/content/developers/github-marketplace/testing-your-app.md +++ b/content/developers/github-marketplace/testing-your-app.md @@ -7,6 +7,8 @@ redirect_from: - /marketplace/integrating-with-the-github-marketplace-api/testing-github-marketplace-apps versions: free-pro-team: '*' +topics: + - marketplace --- diff --git a/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app.md b/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app.md index 79b8ccfe43..6846363051 100644 --- a/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app.md +++ b/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app.md @@ -8,5 +8,7 @@ redirect_from: - /marketplace/integrating-with-the-github-marketplace-api versions: free-pro-team: '*' +topics: + - marketplace --- diff --git a/content/developers/github-marketplace/viewing-metrics-for-your-listing.md b/content/developers/github-marketplace/viewing-metrics-for-your-listing.md index de49180466..3621b2e7b8 100644 --- a/content/developers/github-marketplace/viewing-metrics-for-your-listing.md +++ b/content/developers/github-marketplace/viewing-metrics-for-your-listing.md @@ -8,6 +8,8 @@ redirect_from: - /marketplace/github-marketplace-insights versions: free-pro-team: '*' +topics: + - marketplace --- diff --git a/content/developers/github-marketplace/viewing-transactions-for-your-listing.md b/content/developers/github-marketplace/viewing-transactions-for-your-listing.md index b0c801eaa0..60f69eafb4 100644 --- a/content/developers/github-marketplace/viewing-transactions-for-your-listing.md +++ b/content/developers/github-marketplace/viewing-transactions-for-your-listing.md @@ -5,6 +5,8 @@ redirect_from: - /marketplace/github-marketplace-transactions versions: free-pro-team: '*' +topics: + - marketplace --- diff --git a/content/developers/github-marketplace/webhook-events-for-the-github-marketplace-api.md b/content/developers/github-marketplace/webhook-events-for-the-github-marketplace-api.md index 96594bbc61..71772c127c 100644 --- a/content/developers/github-marketplace/webhook-events-for-the-github-marketplace-api.md +++ b/content/developers/github-marketplace/webhook-events-for-the-github-marketplace-api.md @@ -7,6 +7,8 @@ redirect_from: - /marketplace/integrating-with-the-github-marketplace-api/github-marketplace-webhook-events versions: free-pro-team: '*' +topics: + - marketplace --- diff --git a/content/developers/github-marketplace/writing-a-listing-description-for-your-app.md b/content/developers/github-marketplace/writing-a-listing-description-for-your-app.md index 7dabc220bb..50544a871f 100644 --- a/content/developers/github-marketplace/writing-a-listing-description-for-your-app.md +++ b/content/developers/github-marketplace/writing-a-listing-description-for-your-app.md @@ -12,6 +12,8 @@ redirect_from: - /marketplace/listing-on-github-marketplace/writing-github-marketplace-listing-descriptions versions: free-pro-team: '*' +topics: + - marketplace --- diff --git a/content/developers/overview/about-githubs-apis.md b/content/developers/overview/about-githubs-apis.md index e60baa72e3..7141a1ac74 100644 --- a/content/developers/overview/about-githubs-apis.md +++ b/content/developers/overview/about-githubs-apis.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - api --- There are two stable versions of the GitHub API: the [REST API](/rest) and the [GraphQL API](/graphql). When using the REST API, we encourage you to [request v3 via the `Accept` header](/v3/media/#request-specific-version). For information on using the GraphQL API, see the [v4 docs](/graphql). diff --git a/content/developers/overview/github-developer-program.md b/content/developers/overview/github-developer-program.md index 343241fd6f..947b290ce3 100644 --- a/content/developers/overview/github-developer-program.md +++ b/content/developers/overview/github-developer-program.md @@ -5,6 +5,8 @@ redirect_from: - /program versions: free-pro-team: '*' +topics: + - api --- Building an application that integrates with GitHub? Register for our Developer Program! The possibilities are endless, and you enjoy the kudos. [Register now](https://github.com/developer/register) diff --git a/content/developers/overview/managing-deploy-keys.md b/content/developers/overview/managing-deploy-keys.md index d97cec6391..ad419e8717 100644 --- a/content/developers/overview/managing-deploy-keys.md +++ b/content/developers/overview/managing-deploy-keys.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - api --- diff --git a/content/developers/overview/replacing-github-services.md b/content/developers/overview/replacing-github-services.md index 878a316bd5..05f75c5079 100644 --- a/content/developers/overview/replacing-github-services.md +++ b/content/developers/overview/replacing-github-services.md @@ -8,6 +8,8 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '*' +topics: + - api --- diff --git a/content/developers/overview/secret-scanning.md b/content/developers/overview/secret-scanning.md index f45b2d97e7..9c2d39bf94 100644 --- a/content/developers/overview/secret-scanning.md +++ b/content/developers/overview/secret-scanning.md @@ -7,6 +7,8 @@ redirect_from: - /partnerships/secret-scanning versions: free-pro-team: '*' +topics: + - api --- {% data variables.product.prodname_dotcom %} scans repositories for known secret formats to prevent fraudulent use of credentials that were committed accidentally. {% data variables.product.prodname_secret_scanning_caps %} happens by default on public repositories, and can be enabled on private repositories by repository administrators or organization owners. As a service provider, you can partner with {% data variables.product.prodname_dotcom %} so that your secret formats are included in our {% data variables.product.prodname_secret_scanning %}. @@ -278,6 +280,48 @@ openssl_key = OpenSSL::PKey::EC.new(current_key) puts openssl_key.verify(OpenSSL::Digest::SHA256.new, Base64.decode64(signature), payload.chomp) ``` +**Validation sample in JavaScript** +```js +const crypto = require("crypto"); +const axios = require("axios"); + +const GITHUB_KEYS_URI = "https://api.github.com/meta/public_keys/secret_scanning"; + +/** + * Verify a payload and signature against a public key + * @param {String} payload the value to verify + * @param {String} signature the expected value + * @param {String} keyID the id of the key used to generated the signature + * @return {void} throws if the signature is invalid + */ +const verify_signature = async (payload, signature, keyID) => { + if (typeof payload !== "string" || payload.length === 0) { + throw new Error("Invalid payload"); + } + if (typeof signature !== "string" || signature.length === 0) { + throw new Error("Invalid signature"); + } + if (typeof keyID !== "string" || keyID.length === 0) { + throw new Error("Invalid keyID"); + } + + const keys = (await axios.get(GITHUB_KEYS_URI)).data; + if (!(keys?.public_keys instanceof Array) || keys.length === 0) { + throw new Error("No public keys found"); + } + + const publicKey = keys.public_keys.find((k) => k.key_identifier === keyID) ?? null; + if (publicKey === null) { + throw new Error("No public key found matching key identifier"); + } + + const verify = crypto.createVerify("SHA256").update(payload); + if (!verify.verify(publicKey.key, Buffer.from(signature, "base64"), "base64")) { + throw new Error("Signature does not match payload"); + } +}; +``` + #### Implement secret revocation and user notification in your secret alert service For {% data variables.product.prodname_secret_scanning %} in public repositories, you can enhance your secret alert service to revoke the exposed secrets and notify the affected users. How you implement this in your secret alert service is up to you, but we recommend considering any secrets that {% data variables.product.prodname_dotcom %} sends you messages about as public and compromised. diff --git a/content/developers/overview/using-ssh-agent-forwarding.md b/content/developers/overview/using-ssh-agent-forwarding.md index 81b5ffbd5f..dfa6e0efc4 100644 --- a/content/developers/overview/using-ssh-agent-forwarding.md +++ b/content/developers/overview/using-ssh-agent-forwarding.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - api --- diff --git a/content/developers/overview/viewing-deployment-history.md b/content/developers/overview/viewing-deployment-history.md index 05d8099b78..5d9f721581 100644 --- a/content/developers/overview/viewing-deployment-history.md +++ b/content/developers/overview/viewing-deployment-history.md @@ -5,6 +5,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - api --- {% data reusables.actions.environments-beta %} diff --git a/content/developers/webhooks-and-events/about-webhooks.md b/content/developers/webhooks-and-events/about-webhooks.md index 3123eb3183..1c4708f577 100644 --- a/content/developers/webhooks-and-events/about-webhooks.md +++ b/content/developers/webhooks-and-events/about-webhooks.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - webhooks --- diff --git a/content/developers/webhooks-and-events/configuring-your-server-to-receive-payloads.md b/content/developers/webhooks-and-events/configuring-your-server-to-receive-payloads.md index c4787dcc97..42464d48ef 100644 --- a/content/developers/webhooks-and-events/configuring-your-server-to-receive-payloads.md +++ b/content/developers/webhooks-and-events/configuring-your-server-to-receive-payloads.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - webhooks --- diff --git a/content/developers/webhooks-and-events/creating-webhooks.md b/content/developers/webhooks-and-events/creating-webhooks.md index 17d3ac7a24..ab6e95e7bb 100644 --- a/content/developers/webhooks-and-events/creating-webhooks.md +++ b/content/developers/webhooks-and-events/creating-webhooks.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - webhooks --- diff --git a/content/developers/webhooks-and-events/events.md b/content/developers/webhooks-and-events/events.md index 6fead511c2..761e6b2472 100644 --- a/content/developers/webhooks-and-events/events.md +++ b/content/developers/webhooks-and-events/events.md @@ -6,5 +6,7 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - events --- diff --git a/content/developers/webhooks-and-events/github-event-types.md b/content/developers/webhooks-and-events/github-event-types.md index 788e444783..74579398db 100644 --- a/content/developers/webhooks-and-events/github-event-types.md +++ b/content/developers/webhooks-and-events/github-event-types.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - events --- @@ -51,7 +53,7 @@ Link: ; rel="next", [ { "type": "WatchEvent", - "public": true, + "public": false, "payload": { }, "repo": { @@ -162,14 +164,14 @@ Link: ; rel="next", {% data reusables.webhooks.member_event_api_properties %} {% data reusables.webhooks.member_properties %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %} ### PublicEvent {% data reusables.webhooks.public_short_desc %} - #### Event `payload` object This event returns an empty `payload` object. - +{% endif %} ### PullRequestEvent {% data reusables.webhooks.pull_request_short_desc %} diff --git a/content/developers/webhooks-and-events/index.md b/content/developers/webhooks-and-events/index.md index 8fe5ba3cd8..e433da0403 100644 --- a/content/developers/webhooks-and-events/index.md +++ b/content/developers/webhooks-and-events/index.md @@ -5,6 +5,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - webhooks + - events --- ### Table of Contents diff --git a/content/developers/webhooks-and-events/issue-event-types.md b/content/developers/webhooks-and-events/issue-event-types.md index 3341f6ce6a..41380543d1 100644 --- a/content/developers/webhooks-and-events/issue-event-types.md +++ b/content/developers/webhooks-and-events/issue-event-types.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - events --- @@ -163,7 +165,7 @@ Name | Type | Description `tree` | `object` | The Git tree of the commit. `message` | `string` | The commit message. `parents` | `array of objects` | A list of parent commits. -`verfication` | `object` | The result of verifying the commit's signature. For more information, see "[Signature verification object](/rest/reference/git#signature-verification-object)." +`verfication` | `object` | The result of verifying the commit's signature. For more information, see "[Signature verification object](/rest/reference/git#get-a-commit)." `event` | `string` | The event value is `"committed"`. ### connected diff --git a/content/developers/webhooks-and-events/securing-your-webhooks.md b/content/developers/webhooks-and-events/securing-your-webhooks.md index c32343b777..cfdf4c9a1e 100644 --- a/content/developers/webhooks-and-events/securing-your-webhooks.md +++ b/content/developers/webhooks-and-events/securing-your-webhooks.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - webhooks --- diff --git a/content/developers/webhooks-and-events/testing-webhooks.md b/content/developers/webhooks-and-events/testing-webhooks.md index 3735773363..ba40fe2cb4 100644 --- a/content/developers/webhooks-and-events/testing-webhooks.md +++ b/content/developers/webhooks-and-events/testing-webhooks.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - webhooks --- diff --git a/content/developers/webhooks-and-events/webhook-events-and-payloads.md b/content/developers/webhooks-and-events/webhook-events-and-payloads.md index 75cbee7e0b..f2299c912d 100644 --- a/content/developers/webhooks-and-events/webhook-events-and-payloads.md +++ b/content/developers/webhooks-and-events/webhook-events-and-payloads.md @@ -10,6 +10,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - webhooks --- @@ -145,7 +147,7 @@ Also, the `User-Agent` for the requests will have the prefix `GitHub-Hookshot/`. {{ webhookPayloadsForCurrentVersion.check_suite.completed }} -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %} ### code_scanning_alert {% data reusables.webhooks.code_scanning_alert_event_short_desc %} @@ -222,6 +224,7 @@ Only {% data variables.product.prodname_github_app %}s can receive this event. { #### Webhook payload object {% data reusables.webhooks.create_properties %} +{% data reusables.webhooks.pusher_type_desc %} {% data reusables.webhooks.repo_desc %} {% data reusables.webhooks.org_desc %} {% data reusables.webhooks.app_desc %} @@ -250,6 +253,7 @@ Only {% data variables.product.prodname_github_app %}s can receive this event. { #### Webhook payload object {% data reusables.webhooks.delete_properties %} +{% data reusables.webhooks.pusher_type_desc %} {% data reusables.webhooks.repo_desc %} {% data reusables.webhooks.org_desc %} {% data reusables.webhooks.app_desc %} @@ -705,6 +709,10 @@ Key | Type | Description {{ webhookPayloadsForCurrentVersion.org_block.blocked }} +{% endif %} + +{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" %} + ### package Activity related to {% data variables.product.prodname_registry %}. {% data reusables.webhooks.action_type_desc %} For more information, see "[Managing packages with {% data variables.product.prodname_registry %}](/github/managing-packages-with-github-packages)" to learn more about {% data variables.product.prodname_registry %}. @@ -843,10 +851,10 @@ Key | Type | Description {{ webhookPayloadsForCurrentVersion.project.created }} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %} ### public {% data reusables.webhooks.public_short_desc %} - #### Availability - Repository webhooks @@ -865,7 +873,7 @@ Key | Type | Description #### Webhook payload example {{ webhookPayloadsForCurrentVersion.public }} - +{% endif %} ### pull_request {% data reusables.webhooks.pull_request_short_desc %} @@ -1331,9 +1339,8 @@ When a {% data variables.product.prodname_actions %} workflow run is requested o #### Webhook payload object -Key | Type | Description -----|------|------------- -`action` | `string` | Most webhook payloads contain an `action` property that contains the specific activity that triggered the event. +{% data reusables.webhooks.workflow_run_properties %} +{% data reusables.webhooks.workflow_desc %} {% data reusables.webhooks.org_desc %} {% data reusables.webhooks.repo_desc %} {% data reusables.webhooks.sender_desc %} diff --git a/content/developers/webhooks-and-events/webhooks.md b/content/developers/webhooks-and-events/webhooks.md index ce66413490..9a1347c894 100644 --- a/content/developers/webhooks-and-events/webhooks.md +++ b/content/developers/webhooks-and-events/webhooks.md @@ -6,5 +6,7 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - webhooks --- diff --git a/content/discussions/guides/best-practices-for-community-conversations-on-github.md b/content/discussions/guides/best-practices-for-community-conversations-on-github.md index e4cc2321b6..6631fd4d3c 100644 --- a/content/discussions/guides/best-practices-for-community-conversations-on-github.md +++ b/content/discussions/guides/best-practices-for-community-conversations-on-github.md @@ -29,7 +29,7 @@ You can use {% data variables.product.prodname_discussions %} to discuss big pic Issues are useful for discussing specific details of a project such as bug reports and planned improvements. For more information, see "[About issues](/articles/about-issues)." Pull requests allow you to comment directly on proposed changes. For more information, see "[About pull requests](/articles/about-pull-requests)" and "[Commenting on a pull request](/articles/commenting-on-a-pull-request)." -{% data reusables.organizations.team-discussions-purpose %} For more information, see "[About team discussions](/articles/about-team-discussions)." +{% data reusables.organizations.team-discussions-purpose %} For more information, see "[About team discussions](/github/setting-up-and-managing-organizations-and-teams/about-team-discussions)." ### Following contributing guidelines diff --git a/content/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository.md b/content/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository.md index 10a420e0db..56cc724cd5 100644 --- a/content/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository.md +++ b/content/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository.md @@ -12,9 +12,7 @@ versions: {% data reusables.discussions.about-discussions %} {% data reusables.discussions.about-categories-and-formats %} -Each category must have a unique name and emoji pairing, and can be accompanied by a detailed description stating its purpose. Categories help maintainers organize how conversations are filed and are customizable to help distinguish categories that are Q&A or more open-ended conversations.{% data reusables.discussions.repository-category-limit %} - -For more information, see "[About discussions](/discussions/collaborating-with-your-community-using-discussions/about-discussions#about-categories-and-formats-for-discussions)." +Each category must have a unique name and emoji pairing, and can be accompanied by a detailed description stating its purpose. Categories help maintainers organize how conversations are filed and are customizable to help distinguish categories that are Q&A or more open-ended conversations. {% data reusables.discussions.repository-category-limit %} For more information, see "[About discussions](/discussions/collaborating-with-your-community-using-discussions/about-discussions#about-categories-and-formats-for-discussions)." ### Default categories diff --git a/content/discussions/managing-discussions-for-your-community/managing-discussions-in-your-repository.md b/content/discussions/managing-discussions-for-your-community/managing-discussions-in-your-repository.md index 28251d0478..230201e4d9 100644 --- a/content/discussions/managing-discussions-for-your-community/managing-discussions-in-your-repository.md +++ b/content/discussions/managing-discussions-for-your-community/managing-discussions-in-your-repository.md @@ -24,7 +24,7 @@ To manage discussions in a repository, discussions must be enabled for the repos ### Changing the category for a discussion -You can categorize discussions to help community members find related discussions. For more information, see "[Managing categories for discussions in your repository](/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository)" article. +You can categorize discussions to help community members find related discussions. For more information, see "[Managing categories for discussions in your repository](/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository)." You can also move a discussion to a different category. diff --git a/content/discussions/quickstart.md b/content/discussions/quickstart.md index 252da3b6cc..4609b2fddb 100644 --- a/content/discussions/quickstart.md +++ b/content/discussions/quickstart.md @@ -16,7 +16,7 @@ Discussions give a space for more collaborative conversations by connecting and ### Enabling {% data variables.product.prodname_discussions %} on your repository -Repository owners and people with write access can enable {% data variables.product.prodname_discussions %} for a community on their public repositories. +Repository owners and people with write access can enable {% data variables.product.prodname_discussions %} for a community on their public and private repositories. When you first enable a {% data variables.product.prodname_discussions %}, you will be invited to configure a welcome post. @@ -49,13 +49,13 @@ Anyone with access to a repository can create a discussion. ### Organizing discussions into relevant categories -Repository owners and people with write access can create new categories to keep discussions organized. Collaborators participating and creating new discussions can group discussions into the most relevant existing categories. Discussions can also be recategorized after they are created. For more information, see "[Managing categories for discussions in your repository](/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository)" +Repository owners and people with write access can create new categories to keep discussions organized. Collaborators participating and creating new discussions can group discussions into the most relevant existing categories. Discussions can also be recategorized after they are created. For more information, see "[Managing categories for discussions in your repository](/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository)." ### Promoting healthy conversations People with write permissions for a repository can help surface important conversations by pinning discussions, deleting discussions that are no longer useful or are damaging to the community, and transferring discussions to more relevant repositories owned by the organization. For more information, see "[Managing discussions in your repository](/discussions/managing-discussions-for-your-community/managing-discussions-in-your-repository)." -People with triage permissions for a repository can help moderate a project's discussions by marking comments as answers, locking discussions that are not longer useful or are damaging to the community, and converting issues to discussions when an idea is still in the early stages of development. For more information, see "[Moderating discussions](/discussions/managing-discussions-for-your-community/moderating-discussions)." +People with triage permissions for a repository can help moderate a project's discussions by marking comments as answers, locking discussions that are no longer useful or are damaging to the community, and converting issues to discussions when an idea is still in the early stages of development. For more information, see "[Moderating discussions](/discussions/managing-discussions-for-your-community/moderating-discussions)." ### Next steps diff --git a/content/github/administering-a-repository/about-dependabot-version-updates.md b/content/github/administering-a-repository/about-dependabot-version-updates.md index 1ade8a1acb..d96a8719f3 100644 --- a/content/github/administering-a-repository/about-dependabot-version-updates.md +++ b/content/github/administering-a-repository/about-dependabot-version-updates.md @@ -5,9 +5,10 @@ redirect_from: - /github/administering-a-repository/about-dependabot - /github/administering-a-repository/about-github-dependabot - /github/administering-a-repository/about-github-dependabot-version-updates - versions: free-pro-team: '*' +topics: + - repositories --- {% data reusables.dependabot.beta-note %} @@ -22,6 +23,8 @@ When {% data variables.product.prodname_dependabot %} identifies an outdated dep If you enable security updates, {% data variables.product.prodname_dependabot %} also raises pull requests to update vulnerable dependencies. For more information, see "[About {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/about-dependabot-security-updates)." +{% data reusables.dependabot.pull-request-security-vs-version-updates %} + {% data reusables.dependabot.dependabot-tos %} ### Frequency of {% data variables.product.prodname_dependabot %} pull requests @@ -38,7 +41,9 @@ You can configure version updates for repositories that contain a dependency man {% note %} -{% data reusables.dependabot.private-dependencies-note %} Additionally, {% data variables.product.prodname_dependabot %} doesn't support private {% data variables.product.prodname_dotcom %} dependencies for all package managers. See the details in the table below. +{% data reusables.dependabot.private-dependencies-note %} + +{% data variables.product.prodname_dependabot %} doesn't support private {% data variables.product.prodname_dotcom %} dependencies for all package managers. See the details in the table below. {% endnote %} diff --git a/content/github/administering-a-repository/about-email-notifications-for-pushes-to-your-repository.md b/content/github/administering-a-repository/about-email-notifications-for-pushes-to-your-repository.md index 792bfec4bc..88b8fbb6d7 100644 --- a/content/github/administering-a-repository/about-email-notifications-for-pushes-to-your-repository.md +++ b/content/github/administering-a-repository/about-email-notifications-for-pushes-to-your-repository.md @@ -11,6 +11,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- {% data reusables.notifications.outbound_email_tip %} diff --git a/content/github/administering-a-repository/about-merge-methods-on-github.md b/content/github/administering-a-repository/about-merge-methods-on-github.md index d8928317a6..6533a3ec45 100644 --- a/content/github/administering-a-repository/about-merge-methods-on-github.md +++ b/content/github/administering-a-repository/about-merge-methods-on-github.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- {% data reusables.pull_requests.configure_pull_request_merges_intro %} You can enforce one type of merge method, such as commit squashing or rebasing, by only enabling the desired method for your repository. diff --git a/content/github/administering-a-repository/about-protected-branches.md b/content/github/administering-a-repository/about-protected-branches.md index c842929a11..1dc9ce75c3 100644 --- a/content/github/administering-a-repository/about-protected-branches.md +++ b/content/github/administering-a-repository/about-protected-branches.md @@ -19,6 +19,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- ### About branch protection rules diff --git a/content/github/administering-a-repository/about-releases.md b/content/github/administering-a-repository/about-releases.md index 81ade4c4b0..fc0699c303 100644 --- a/content/github/administering-a-repository/about-releases.md +++ b/content/github/administering-a-repository/about-releases.md @@ -11,6 +11,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- ### About releases diff --git a/content/github/administering-a-repository/about-secret-scanning.md b/content/github/administering-a-repository/about-secret-scanning.md index a1572c7771..38696dfe50 100644 --- a/content/github/administering-a-repository/about-secret-scanning.md +++ b/content/github/administering-a-repository/about-secret-scanning.md @@ -9,6 +9,9 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=3.0' + github-ae: '*' +topics: + - repositories --- {% data reusables.secret-scanning.beta %} @@ -35,7 +38,7 @@ When {% data variables.product.prodname_secret_scanning %} detects a set of cred ### About {% data variables.product.prodname_secret_scanning %} for private repositories {% endif %} -{% if enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.22" %} +{% if currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} ### About {% data variables.product.prodname_secret_scanning %} on {% data variables.product.product_name %} {% data variables.product.prodname_secret_scanning_caps %} is available on all organization-owned repositories as part of {% data variables.product.prodname_GH_advanced_security %}. It is not available on user-owned repositories. @@ -45,11 +48,16 @@ If you're a repository administrator or an organization owner, you can enable {% When you push commits to a{% if currentVersion == "free-pro-team@latest" %} private{% endif %} repository with {% data variables.product.prodname_secret_scanning %} enabled, {% data variables.product.prodname_dotcom %} scans the contents of the commits for secrets. -When {% data variables.product.prodname_secret_scanning %} detects a secret in a{% if currentVersion == "free-pro-team@latest" %} private{% endif %} repository, {% data variables.product.prodname_dotcom %} sends alerts. +When {% data variables.product.prodname_secret_scanning %} detects a secret in a{% if currentVersion == "free-pro-team@latest" %} private{% endif %} repository, {% data variables.product.prodname_dotcom %} generates an alert. - {% data variables.product.prodname_dotcom %} sends an email alert to the repository administrators and organization owners. +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == 'github-ae@next' %} +- {% data variables.product.prodname_dotcom %} sends an email alert to the contributor who committed the secret to the repository, with a link to the related {% data variables.product.prodname_secret_scanning %} alert. The commit author can then view the alert in the repository, and resolve the alert. +{% endif %} +- {% data variables.product.prodname_dotcom %} displays an alert in the repository.{% if currentVersion == "enterprise-server@3.0" %} For more information, see "[Managing alerts from {% data variables.product.prodname_secret_scanning %}](/github/administering-a-repository/managing-alerts-from-secret-scanning)."{% endif %} -- {% data variables.product.prodname_dotcom %} displays an alert in the repository. For more information, see "[Managing alerts from {% data variables.product.prodname_secret_scanning %}](/github/administering-a-repository/managing-alerts-from-secret-scanning)." +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == 'github-ae@next' %} +For more information about viewing and resolving {% data variables.product.prodname_secret_scanning %} alerts, see "[Managing alerts from {% data variables.product.prodname_secret_scanning %}](/github/administering-a-repository/managing-alerts-from-secret-scanning)."{% endif %} Repository administrators and organization owners can grant users and teams access to {% data variables.product.prodname_secret_scanning %} alerts. For more information, see "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)." diff --git a/content/github/administering-a-repository/about-securing-your-repository.md b/content/github/administering-a-repository/about-securing-your-repository.md index 50fbe4f3dd..a98f29f304 100644 --- a/content/github/administering-a-repository/about-securing-your-repository.md +++ b/content/github/administering-a-repository/about-securing-your-repository.md @@ -3,7 +3,10 @@ title: About securing your repository intro: '{% data variables.product.product_name %} provides a number of ways that you can help keep your repository secure.' versions: free-pro-team: '*' - enterprise-server: '>=3.0' + enterprise-server: '>=3.0' + github-ae: '*' +topics: + - repositories --- ### Setting up your repository securely @@ -14,6 +17,7 @@ The first step to securing a repository is to set up who can see and modify your {% data variables.product.prodname_dotcom %} has a growing set of security features that help you keep your code secure. You can find these on the **Security** tab for your repository. +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} #### Available for all repositories {% if currentVersion == "free-pro-team@latest" %} @@ -31,7 +35,7 @@ The first step to securing a repository is to set up who can see and modify your and "[About {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/about-dependabot-security-updates)." {% endif %} -{% if enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.22" %} +{% if currentVersion ver_gt "enterprise-server@2.22" %} - **{% data variables.product.prodname_dependabot_alerts %}** View alerts about dependencies that are known to contain security vulnerabilities, and manage these alerts. For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)." @@ -42,12 +46,15 @@ The first step to securing a repository is to set up who can see and modify your Use {% data variables.product.prodname_dependabot %} to automatically raise pull requests to keep your dependencies up-to-date. This helps reduce your exposure to older versions of dependencies. Using newer versions makes it easier to apply patches if security vulnerabilities are discovered, and also makes it easier for {% data variables.product.prodname_dependabot_security_updates %} to successfully raise pull requests to upgrade vulnerable dependencies. For more information, see "[About {% data variables.product.prodname_dependabot_version_updates %}](/github/administering-a-repository/about-dependabot-version-updates)." {% endif %} + {% endif %} -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} #### Available {% if currentVersion == "free-pro-team@latest" %}for public repositories and for repositories {% endif %}with {% data variables.product.prodname_advanced_security %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} These features are available {% if currentVersion == "free-pro-team@latest" %}for all public repositories, and for private repositories owned by organizations with {% else %}if you have {% endif %}an {% data variables.product.prodname_advanced_security %} license. {% data reusables.advanced-security.more-info-ghas %} + {% endif %} - **{% data variables.product.prodname_code_scanning_capc %} alerts** @@ -55,7 +62,7 @@ These features are available {% if currentVersion == "free-pro-team@latest" %}fo - **Detected secrets** - {% if currentVersion == "free-pro-team@latest" %}For private repositories, view {% else if %}View {% endif %}any secrets that {% data variables.product.prodname_dotcom %} has found in your code. You should treat tokens or credentials that have been checked into the repository as compromised. For more information, see "[About secret scanning](/github/administering-a-repository/about-secret-scanning)." + {% if currentVersion == "free-pro-team@latest" %}For private repositories, view {% else %}View {% endif %}any secrets that {% data variables.product.prodname_dotcom %} has found in your code. You should treat tokens or credentials that have been checked into the repository as compromised. For more information, see "[About secret scanning](/github/administering-a-repository/about-secret-scanning)." {% endif %} @@ -63,6 +70,7 @@ These features are available {% if currentVersion == "free-pro-team@latest" %}fo - **Dependency review** - Show the full impact of changes to dependencies and see details of any vulnerable versions before you merge a pull request. For more information, see "[Reviewing dependency changes in a pull request](/github/collaborating-with-issues-and-pull-requests/reviewing-dependency-changes-in-a-pull-request)." {% endif %} +{% if currentVersion != "github-ae@latest" %} ### Exploring dependencies {% data variables.product.prodname_dotcom %}'s dependency graph allows you to explore: @@ -72,3 +80,4 @@ These features are available {% if currentVersion == "free-pro-team@latest" %}fo You must enable the dependency graph before {% data variables.product.prodname_dotcom %} can generate {% data variables.product.prodname_dependabot_alerts %} for dependencies with security vulnerabilities. {% if currentVersion == "free-pro-team@latest" %}Enabling the dependency graph also enables {% data variables.product.prodname_dotcom %} to run dependency reviews of pull requests.{% endif %} You can find the dependency graph on the **Insights** tab for your repository. For more information, see "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph)." +{% endif %} diff --git a/content/github/administering-a-repository/automation-for-release-forms-with-query-parameters.md b/content/github/administering-a-repository/automation-for-release-forms-with-query-parameters.md index a24e1145b9..10e4011e88 100644 --- a/content/github/administering-a-repository/automation-for-release-forms-with-query-parameters.md +++ b/content/github/administering-a-repository/automation-for-release-forms-with-query-parameters.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- Query parameters are optional parts of a URL you can customize to share a specific web page view, such as search filter results, an issue template, or the release form page on {% data variables.product.prodname_dotcom %}. To create your own query parameters, you must match the key and value pair. diff --git a/content/github/administering-a-repository/changing-the-default-branch.md b/content/github/administering-a-repository/changing-the-default-branch.md index cefd27c271..f1f0f892bd 100644 --- a/content/github/administering-a-repository/changing-the-default-branch.md +++ b/content/github/administering-a-repository/changing-the-default-branch.md @@ -9,6 +9,8 @@ versions: redirect_from: - /github/administering-a-repository/setting-the-default-branch - /articles/setting-the-default-branch +topics: + - repositories --- ### About changing the default branch diff --git a/content/github/administering-a-repository/classifying-your-repository-with-topics.md b/content/github/administering-a-repository/classifying-your-repository-with-topics.md index a187c9313d..8918184c6b 100644 --- a/content/github/administering-a-repository/classifying-your-repository-with-topics.md +++ b/content/github/administering-a-repository/classifying-your-repository-with-topics.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- ### About topics diff --git a/content/github/administering-a-repository/comparing-releases.md b/content/github/administering-a-repository/comparing-releases.md index 7e57598c48..ae83a329db 100644 --- a/content/github/administering-a-repository/comparing-releases.md +++ b/content/github/administering-a-repository/comparing-releases.md @@ -6,6 +6,8 @@ versions: free-pro-team: '*' enterprise-server: '>=2.21' github-ae: '*' +topics: + - repositories --- {% data reusables.repositories.navigate-to-repo %} diff --git a/content/github/administering-a-repository/configuration-options-for-dependency-updates.md b/content/github/administering-a-repository/configuration-options-for-dependency-updates.md index 2999f77230..bae978220c 100644 --- a/content/github/administering-a-repository/configuration-options-for-dependency-updates.md +++ b/content/github/administering-a-repository/configuration-options-for-dependency-updates.md @@ -2,8 +2,11 @@ title: Configuration options for dependency updates intro: 'Detailed information for all the options you can use to customize how {% data variables.product.prodname_dependabot %} maintains your repositories.' permissions: 'People with write permissions to a repository can configure {% data variables.product.prodname_dependabot %} for the repository.' +miniTocMaxHeadingLevel: 4 versions: free-pro-team: '*' +topics: + - repositories --- {% data reusables.dependabot.beta-note %} @@ -14,9 +17,11 @@ The {% data variables.product.prodname_dependabot %} configuration file, *depend You must store this file in the `.github` directory of your repository. When you add or update the *dependabot.yml* file, this triggers an immediate check for version updates. Any options that also affect security updates are used the next time a security alert triggers a pull request for a security update. For more information, see "[Enabling and disabling version updates](/github/administering-a-repository/enabling-and-disabling-version-updates)" and "[Configuring {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/configuring-dependabot-security-updates)." -### Configuration options for *dependabot.yml* +The *dependabot.yml* file has two mandatory top-level keys: `version`, and `updates`. You can, optionally, include a top-level `registries` key. The file must start with `version: 2`. -The *dependabot.yml* file must start with `version: 2` followed by an array of `updates`. +### Configuration options for updates + +The top-level `updates` key is mandatory. You use it to configure how {% data variables.product.prodname_dependabot %} updates the versions or your project's dependencies. Each entry configures the update settings for a particular package manager. You can use the following options. | Option | Required | Description | |:---|:---:|:---| @@ -27,11 +32,13 @@ The *dependabot.yml* file must start with `version: 2` followed by an array of ` | [`assignees`](#assignees) | | Assignees to set on pull requests | | [`commit-message`](#commit-message) | | Commit message preferences | | [`ignore`](#ignore) | | Ignore certain dependencies or versions | +| [`insecure-external-code-execution`](#insecure-external-code-execution) | | Allow or deny code execution in manifest files | | [`labels`](#labels) | | Labels to set on pull requests | | [`milestone`](#milestone) | | Milestone to set on pull requests | | [`open-pull-requests-limit`](#open-pull-requests-limit) | | Limit number of open pull requests for version updates| | [`pull-request-branch-name.separator`](#pull-request-branch-nameseparator) | | Change separator for pull request branch names | | [`rebase-strategy`](#rebase-strategy) | | Disable automatic rebasing | +| [`registries`](#registries) | | Private registries that {% data variables.product.prodname_dependabot %} can access| | [`reviewers`](#reviewers) | | Reviewers to set on pull requests | | [`schedule.day`](#scheduleday) | | Day of week to check for updates | | [`schedule.time`](#scheduletime) | | Time of day to check for updates (hh:mm) | @@ -60,9 +67,9 @@ In general, security updates use any configuration options that affect pull requ {% endnote %} -### `package-ecosystem` +#### `package-ecosystem` -**Required** You add one `package-ecosystem` element for each package manager that you want {% data variables.product.prodname_dependabot %} to monitor for new versions. The repository must also contain a dependency manifest or lock file for each of these package managers. If you want to enable vendoring for a package manager that supports it, the vendored dependencies must be located in the required directory. For more information, see [`vendor`](#vendor) below. +**Required**. You add one `package-ecosystem` element for each package manager that you want {% data variables.product.prodname_dependabot %} to monitor for new versions. The repository must also contain a dependency manifest or lock file for each of these package managers. If you want to enable vendoring for a package manager that supports it, the vendored dependencies must be located in the required directory. For more information, see [`vendor`](#vendor) below. {% data reusables.dependabot.supported-package-managers %} @@ -91,9 +98,9 @@ updates: interval: "daily" ``` -### `directory` +#### `directory` -**Required** You must define the location of the package manifests for each package manager (for example, the *package.json* or *Gemfile*). You define the directory relative to the root of the repository for all ecosystems except GitHub Actions. For GitHub Actions, set the directory to `/` to check for workflow files in `.github/workflows`. +**Required**. You must define the location of the package manifests for each package manager (for example, the *package.json* or *Gemfile*). You define the directory relative to the root of the repository for all ecosystems except GitHub Actions. For GitHub Actions, set the directory to `/` to check for workflow files in `.github/workflows`. ```yaml # Specify location of manifest files for each package manager @@ -120,9 +127,9 @@ updates: interval: "daily" ``` -### `schedule.interval` +#### `schedule.interval` -**Required** You must define how often to check for new versions for each package manager. By default, this is at 5am UTC. To modify this, use [`schedule.time`](#scheduletime) and [`schedule.timezone`](#scheduletimezone). +**Required**. You must define how often to check for new versions for each package manager. By default, this is at 5am UTC. To modify this, use [`schedule.time`](#scheduletime) and [`schedule.timezone`](#scheduletimezone). - `daily`—runs on every weekday, Monday to Friday. - `weekly`—runs once each week. By default, this is on Monday. To modify this, use [`schedule.day`](#scheduleday). @@ -147,7 +154,13 @@ updates: interval: "weekly" ``` -### `allow` +{% note %} + +**Note**: `schedule` defines when {% data variables.product.prodname_dependabot %} attempts a new update. However, it's not the only time you may receive pull requests. Updates can be triggered based on changes to your `dependabot.yml` file, changes to your manifest file(s) after a failed update, or {% data variables.product.prodname_dependabot_security_updates %}. For more information, see "[Frequency of {% data variables.product.prodname_dependabot %} pull requests](/github/administering-a-repository/about-dependabot-version-updates#frequency-of-dependabot-pull-requests)" and "[About {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/about-dependabot-security-updates)." + +{% endnote %} + +#### `allow` {% data reusables.dependabot.default-dependencies-allow-ignore %} @@ -165,7 +178,7 @@ Use the `allow` option to customize which dependencies are updated. This has no | `development`| `bundler`, `composer`, `mix`, `maven`, `npm`, `pip` | Only dependencies in the "Development dependency group". | ```yaml -# Customizing the dependencies to maintain with `allow` +# Use `allow` to specify which dependencies to maintain version: 2 updates: @@ -201,7 +214,7 @@ updates: dependency-type: "production" ``` -### `assignees` +#### `assignees` Use `assignees` to specify individual assignees for all pull requests raised for a package manager. @@ -221,7 +234,7 @@ updates: - "octocat" ``` -### `commit-message` +#### `commit-message` By default, {% data variables.product.prodname_dependabot %} attempts to detect your commit message preferences and use similar patterns. Use the `commit-message` option to specify your preferences explicitly. @@ -234,7 +247,7 @@ Supported options {% data reusables.dependabot.option-affects-security-updates %} ```yaml -# Customizing commit messages +# Customize commit messages version: 2 updates: @@ -268,17 +281,17 @@ updates: include: "scope" ``` -### `ignore` +#### `ignore` {% data reusables.dependabot.warning-ignore-option %} -#### Checking for existing ignore preferences +##### Checking for existing ignore preferences Before you add an `ignore` option to the configuration file, check whether you've previously used any of the `@dependabot ignore` commands on a security update or version update pull request. {% data variables.product.prodname_dependabot %} stores these preferences for each package manager centrally and this information is overwritten by the `ignore` option. For more information about the `@dependabot ignore` commands, see "[Managing pull requests for dependency updates](/github/administering-a-repository/managing-pull-requests-for-dependency-updates)." You can check whether a repository has stored preferences by searching the repository for `"@dependabot ignore" in:comments`. If you review any pull requests in the results, you can decide whether or not to specify those ignored dependencies or versions in the configuration file. -#### Specifying dependencies and versions to ignore +##### Specifying dependencies and versions to ignore {% data reusables.dependabot.default-dependencies-allow-ignore %} @@ -290,7 +303,7 @@ You can use the `ignore` option to customize which dependencies are updated. The {% data reusables.dependabot.option-affects-security-updates %} ```yaml -# Customizing the dependencies to maintain with `ignore` +# Use `ignore` to specify dependencies that should not be updated version: 2 updates: @@ -308,12 +321,38 @@ updates: {% note %} -**Note**: {% data variables.product.prodname_dependabot %} can only run version updates on manifest or lock files if it can access all of the dependencies in the file, even if you add inaccessible dependencies to the `ignore` option of your configuration file. For more information, see "[Managing security and analysis settings for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization#allowing-dependabot-to-access-private-repositories)" and "[Troubleshooting {% data variables.product.prodname_dependabot %} errors](/github/managing-security-vulnerabilities/troubleshooting-dependabot-errors#dependabot-cant-resolve-your-dependency-files)." +**Note**: {% data variables.product.prodname_dependabot %} can only run version updates on manifest or lock files if it can access all of the dependencies in the file, even if you add inaccessible dependencies to the `ignore` option of your configuration file. For more information, see "[Managing security and analysis settings for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization#allowing-dependabot-to-access-private-dependencies)" and "[Troubleshooting {% data variables.product.prodname_dependabot %} errors](/github/managing-security-vulnerabilities/troubleshooting-dependabot-errors#dependabot-cant-resolve-your-dependency-files)." {% endnote %} -### `labels` +#### `insecure-external-code-execution` + +Package managers with the `package-ecosystem` values `bundler`, `mix`, and `pip` may execute external code in the manifest as part of the version update process. This might allow a compromised package to steal credentials or gain access to configured registries. When you add a [`registries`](#registries) setting within an `updates` configuration, {% data variables.product.prodname_dependabot %} automatically prevents external code execution, in which case the version update may fail. You can choose to override this behavior and allow external code execution for `bundler`, `mix`, and `pip` package managers by setting `insecure-external-code-execution` to `allow`. + +You can explicitly deny external code execution, irrespective of whether there is a `registries` setting for this update configuration, by setting `insecure-external-code-execution` to `deny`. + +{% raw %} +```yaml +# Allow external code execution when updating dependencies from private registries + +version: 2 +registries: + ruby-github: + type: rubygems-server + url: https://rubygems.pkg.github.com/octocat/github_api + token: ${{secrets.MY_GITHUB_PERSONAL_TOKEN}} +updates: + - package-ecosystem: "bundler" + directory: "/rubygems-server" + insecure-external-code-execution: allow + registries: "*" + schedule: + interval: "monthly" +``` +{% endraw %} + +#### `labels` {% data reusables.dependabot.default-labels %} @@ -337,7 +376,7 @@ updates: - "dependencies" ``` -### `milestone` +#### `milestone` Use `milestone` to associate all pull requests raised for a package manager with a milestone. You need to specify the numeric identifier of the milestone and not its label. If you view a milestone, the final part of the page URL, after `milestone`, is the identifier. For example: `https://github.com///milestone/3`. @@ -356,14 +395,14 @@ updates: milestone: 4 ``` -### `open-pull-requests-limit` +#### `open-pull-requests-limit` -By default, {% data variables.product.prodname_dependabot %} opens a maximum of five pull requests for version updates. Once there are five open pull requests, new requests are blocked until you merge or close some of the open requests. Use `open-pull-requests-limit` to change this limit. This also provides a simple way to temporarily disable version updates for a package manager. +By default, {% data variables.product.prodname_dependabot %} opens a maximum of five pull requests for version updates. Once there are five open pull requests, new requests are blocked until you merge or close some of the open requests, after which new pull requests can be opened on subsequent updates. Use `open-pull-requests-limit` to change this limit. This also provides a simple way to temporarily disable version updates for a package manager. This option has no impact on security updates, which have a separate, internal limit of ten open pull requests. ```yaml -# Changing the number of open pull requests allowed +# Specify the number of open pull requests allowed version: 2 updates: @@ -382,7 +421,7 @@ updates: open-pull-requests-limit: 10 ``` -### `pull-request-branch-name.separator` +#### `pull-request-branch-name.separator` {% data variables.product.prodname_dependabot %} generates a branch for each pull request. Each branch name includes `dependabot`, and the package manager and dependency that are updated. By default, these parts are separated by a `/` symbol, for example: `dependabot/npm_and_yarn/next_js/acorn-6.4.1`. @@ -391,7 +430,7 @@ Use `pull-request-branch-name.separator` to specify a different separator. This {% data reusables.dependabot.option-affects-security-updates %} ```yaml -# Specifying a different separator for branch names +# Specify a different separator for branch names version: 2 updates: @@ -405,7 +444,7 @@ updates: separator: "-" ``` -### `rebase-strategy` +#### `rebase-strategy` By default, {% data variables.product.prodname_dependabot %} automatically rebases open pull requests when it detects conflicts. Use `rebase-strategy` to disable this behavior. @@ -417,7 +456,7 @@ Available rebase strategies {% data reusables.dependabot.option-affects-security-updates %} ```yaml -# Disabling automatic rebasing +# Disable automatic rebasing version: 2 updates: @@ -429,7 +468,39 @@ updates: rebase-strategy: "disabled" ``` -### `reviewers` +#### `registries` + +To allow {% data variables.product.prodname_dependabot %} to access a private package registry when performing a version update, you must include a `registries` setting within the relevant `updates` configuration. You can allow all of the defined registries to be used by setting `registries` to `"*"`. Alternatively, you can list the registries that the update can use. To do this, use the name of the registry as defined in the top-level `registries` section of the _dependabot.yml_ file. + +To allow {% data variables.product.prodname_dependabot %} to use `bundler`, `mix`, and `pip` package managers to update dependencies in private registries, you can choose to allow external code execution. For more information, see [`insecure-external-code-execution`](#insecure-external-code-execution). + +{% raw %} +```yaml +# Allow {% data variables.product.prodname_dependabot %} to use one of the two defined private registries +# when updating dependency versions for this ecosystem + +version: 2 +registries: + maven-github: + type: maven-repository + url: https://maven.pkg.github.com/octocat + token: ${{secrets.MY_GITHUB_PERSONAL_TOKEN}} + npm-npmjs: + type: npm-registry + url: https://registry.npmjs.org + username: octocat + password: ${{secrets.MY_NPM_PASSWORD}} +updates: + - package-ecosystem: "gitsubmodule" + directory: "/" + registries: + - maven-github + schedule: + interval: "monthly" +``` +{% endraw %} + +#### `reviewers` Use `reviewers` to specify individual reviewers or teams of reviewers for all pull requests raised for a package manager. You must use the full team name, including the organization, as if you were @mentioning the team. @@ -451,7 +522,7 @@ updates: - "my-org/python-team" ``` -### `schedule.day` +#### `schedule.day` When you set a `weekly` update schedule, by default, {% data variables.product.prodname_dependabot %} checks for new versions on Monday at 05:00 UTC. Use `schedule.day` to specify an alternative day to check for updates. @@ -478,7 +549,7 @@ updates: day: "sunday" ``` -### `schedule.time` +#### `schedule.time` By default, {% data variables.product.prodname_dependabot %} checks for new versions at 05:00 UTC. Use `schedule.time` to specify an alternative time of day to check for updates (format: `hh:mm`). @@ -494,7 +565,7 @@ updates: time: "09:00" ``` -### `schedule.timezone` +#### `schedule.timezone` By default, {% data variables.product.prodname_dependabot %} checks for new versions at 05:00 UTC. Use `schedule.timezone` to specify an alternative time zone. The time zone identifier must be from the Time Zone database maintained by [iana](https://www.iana.org/time-zones). For more information, see [List of tz database time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). @@ -512,7 +583,7 @@ updates: timezone: "Asia/Tokyo" ``` -### `target-branch` +#### `target-branch` By default, {% data variables.product.prodname_dependabot %} checks for manifest files on the default branch and raises pull requests for version updates against this branch. Use `target-branch` to specify a different branch for manifest files and for pull requests. When you use this option, the settings for this package manager will no longer affect any pull requests raised for security updates. @@ -543,9 +614,9 @@ updates: - "npm dependencies" ``` -### `vendor` +#### `vendor` -Use the `vendor` option to tell {% data variables.product.prodname_dependabot %} to vendor dependencies when updating them. +Use the `vendor` option to tell {% data variables.product.prodname_dependabot %} to vendor dependencies when updating them. Don't use this option if you're using `gomod` as {% data variables.product.prodname_dependabot %} automatically detects vendoring for this tool. ```yaml # Configure version updates for both dependencies defined in manifests and vendored dependencies @@ -568,7 +639,7 @@ updates: | `gomod` | No path requirement (dependencies are usually located in the _vendor_ directory) | [`go mod vendor` documentation](https://golang.org/ref/mod#go-mod-vendor) | -### `versioning-strategy` +#### `versioning-strategy` When {% data variables.product.prodname_dependabot %} edits a manifest file to update a version, it uses the following overall strategies: @@ -590,7 +661,7 @@ Available update strategies | `increase-if-necessary` | `bundler`, `composer`, `npm` | Increase the version requirement only when required by the new version. | ```yaml -# Customizing the manifest version strategy +# Customize the manifest version strategy version: 2 updates: @@ -618,3 +689,222 @@ updates: # ignore any version updates that affect the manifest versioning-strategy: lockfile-only ``` + +### Configuration options for private registries + +The top-level `registries` key is optional. It allows you to specify authentication details that {% data variables.product.prodname_dependabot %} can use to access private package registries. + +{% note %} + +**Note:** Private registries behind firewalls on private networks are not supported. + +{% endnote %} + +The value of the `registries` key is an associative array, each element of which consists of a key that identifies a particular registry and a value which is an associative array that specifies the settings required to access that registry. The following *dependabot.yml* file, configures a registry identified as `dockerhub` in the `registries` section of the file and then references this in the `updates` section of the file. + +{% raw %} +```yaml +# Minimal settings to update dependencies in one private registry + +version: 2 +registries: + dockerhub: # Define access for a private registry + type: docker-registry + url: registry.hub.docker.com + username: octocat + password: ${{secrets.DOCKERHUB_PASSWORD}} +updates: + - package-ecosystem: "docker" + directory: "/docker-registry/dockerhub" + registries: + - dockerhub # Allow version updates for dependencies in this registry + schedule: + interval: "monthly" +``` +{% endraw %} + +You use the following options to specify access settings. Registry settings must contain a `type` and a `url`, and typically either a `username` and `password` combination or a `token`. + +| Option                 | Description | +|:---|:---| +| `type` | Identifies the type of registry. See the full list of types below. | +| `url` | The URL to use to access the dependencies in this registry. The protocol is optional. If not specified, `https://` is assumed. {% data variables.product.prodname_dependabot %} adds or ignores trailing slashes as required. | +| `username` | The username that {% data variables.product.prodname_dependabot %} uses to access the registry. | +| `password` | A reference to a {% data variables.product.prodname_dependabot %} secret containing the password for the specified user. For more information, see "[Managing encrypted secrets for Dependabot](/github/administering-a-repository/managing-encrypted-secrets-for-dependabot)." | +| `token` | A reference to a {% data variables.product.prodname_dependabot %} secret containing an access token for this registry. For more information, see "[Managing encrypted secrets for Dependabot](/github/administering-a-repository/managing-encrypted-secrets-for-dependabot)." | +| `replaces-base` | For registries with `type: python-index`, if the boolean value is `true`, pip resolves dependencies by using the specified URL rather than the base URL of the Python Package Index (by default `https://pypi.org/simple`). | + + +Each configuration `type` requires you to provide particular settings. Some types allow more than one way to connect. The following sections provide details of the settings you should use for each `type`. + +#### `composer-repository` + +The `composer-repository` type supports username and password. + +{% raw %} +```yaml +registries: + composer: + type: composer-repository + url: https://repo.packagist.com/example-company/ + username: octocat + password: ${{secrets.MY_PACKAGIST_PASSWORD}} +``` +{% endraw %} + +#### `docker-registry` + +The `docker-registry` type supports username and password. + +{% raw %} +```yaml +registries: + dockerhub: + type: docker-registry + url: https://registry.hub.docker.com + username: octocat + password: ${{secrets.MY_DOCKERHUB_PASSWORD}} +``` +{% endraw %} + +#### `git` + +The `git` type supports username and password. + +{% raw %} +```yaml +registries: + github-octocat: + type: git + url: https://github.com + username: x-access-token + password: ${{secrets.MY_GITHUB_PERSONAL_TOKEN}} +``` +{% endraw %} + +#### `maven-repository` + +The `maven-repository` type supports username and password, or token. + +{% raw %} +```yaml +registries: + maven-artifactory: + type: maven-repository + url: https://artifactory.example.com + username: octocat + password: ${{secrets.MY_ARTIFACTORY_PASSWORD}} +``` +{% endraw %} + +{% raw %} +```yaml +registries: + maven-github: + type: maven-repository + url: https://maven.pkg.github.com/octocat + token: ${{secrets.MY_GITHUB_PERSONAL_TOKEN}} +``` +{% endraw %} + +#### `npm-registry` + +The `npm-registry` type supports username and password, or token. + +{% raw %} +```yaml +registries: + npm-npmjs: + type: npm-registry + url: https://registry.npmjs.org + username: octocat + password: ${{secrets.MY_NPM_PASSWORD}} +``` +{% endraw %} + +{% raw %} +```yaml +registries: + npm-github: + type: npm-registry + url: https://npm.pkg.github.com + token: ${{secrets.MY_GITHUB_PERSONAL_TOKEN}} +``` +{% endraw %} + +#### `nuget-feed` + +The `nuget-feed` type supports username and password, or token. + +{% raw %} +```yaml +registries: + nuget-example: + type: nuget-feed + url: https://nuget.example.com/v3/index.json + username: octocat@example.com + password: ${{secrets.MY_NUGET_PASSWORD}} +``` +{% endraw %} + +{% raw %} +```yaml +registries: + nuget-azure-devops: + type: nuget-feed + url: https://pkgs.dev.azure.com/.../_packaging/My_Feed/nuget/v3/index.json + token: ${{secrets.MY_AZURE_DEVOPS_TOKEN}} +``` +{% endraw %} + +#### `python-index` + +The `python-index` type supports username and password, or token. + +{% raw %} +```yaml +registries: + python-example: + type: python-index + url: https://example.com/_packaging/my-feed/pypi/example + username: octocat + password: ${{secrets.MY_BASIC_AUTH_PASSWORD}} + replaces-base: true +``` +{% endraw %} + +{% raw %} +```yaml +registries: + python-azure: + type: python-index + url: https://pkgs.dev.azure.com/octocat/_packaging/my-feed/pypi/example + token: ${{secrets.MY_AZURE_DEVOPS_TOKEN}} + replaces-base: true +``` +{% endraw %} + +#### `rubygems-server` + +The `rubygems-server` type supports username and password, or token. + +{% raw %} +```yaml +registries: + ruby-example: + type: rubygems-server + url: https://rubygems.example.com + username: octocat@example.com + password: ${{secrets.MY_RUBYGEMS_PASSWORD}} +``` +{% endraw %} + +{% raw %} +```yaml +registries: + ruby-github: + type: rubygems-server + url: https://rubygems.pkg.github.com/octocat/github_api + token: ${{secrets.MY_GITHUB_PERSONAL_TOKEN}} +``` +{% endraw %} \ No newline at end of file diff --git a/content/github/administering-a-repository/configuring-autolinks-to-reference-external-resources.md b/content/github/administering-a-repository/configuring-autolinks-to-reference-external-resources.md index dafdd7d9e5..023771cbe1 100644 --- a/content/github/administering-a-repository/configuring-autolinks-to-reference-external-resources.md +++ b/content/github/administering-a-repository/configuring-autolinks-to-reference-external-resources.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- Anyone with admin permissions to a repository can configure autolink references to link issues, pull requests,{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.21" %} commit messages, and release descriptions{% else %} and commit messages{% endif %} to external third-party services. diff --git a/content/github/administering-a-repository/configuring-commit-rebasing-for-pull-requests.md b/content/github/administering-a-repository/configuring-commit-rebasing-for-pull-requests.md index eb2944629f..2a8e4a235b 100644 --- a/content/github/administering-a-repository/configuring-commit-rebasing-for-pull-requests.md +++ b/content/github/administering-a-repository/configuring-commit-rebasing-for-pull-requests.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- {% data reusables.pull_requests.configure_pull_request_merges_intro %} diff --git a/content/github/administering-a-repository/configuring-commit-squashing-for-pull-requests.md b/content/github/administering-a-repository/configuring-commit-squashing-for-pull-requests.md index 8a3a1cde8c..010fbbcb58 100644 --- a/content/github/administering-a-repository/configuring-commit-squashing-for-pull-requests.md +++ b/content/github/administering-a-repository/configuring-commit-squashing-for-pull-requests.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- {% data reusables.pull_requests.configure_pull_request_merges_intro %} diff --git a/content/github/administering-a-repository/configuring-pull-request-merges.md b/content/github/administering-a-repository/configuring-pull-request-merges.md index f42c9d2a9a..4f05c5af5a 100644 --- a/content/github/administering-a-repository/configuring-pull-request-merges.md +++ b/content/github/administering-a-repository/configuring-pull-request-merges.md @@ -8,5 +8,7 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- diff --git a/content/github/administering-a-repository/configuring-secret-scanning-for-your-repositories.md b/content/github/administering-a-repository/configuring-secret-scanning-for-your-repositories.md index b4c714924d..1060d92009 100644 --- a/content/github/administering-a-repository/configuring-secret-scanning-for-your-repositories.md +++ b/content/github/administering-a-repository/configuring-secret-scanning-for-your-repositories.md @@ -7,7 +7,10 @@ redirect_from: product: '{% data reusables.gated-features.secret-scanning %}' versions: free-pro-team: '*' - enterprise-server: '>=3.0' + enterprise-server: '>=3.0' + github-ae: '*' +topics: + - repositories --- {% data reusables.secret-scanning.beta %} @@ -26,7 +29,6 @@ versions: {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} {% data reusables.repositories.navigate-to-security-and-analysis %} - {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} 4. You may need to enable {% data variables.product.prodname_GH_advanced_security %} to activate the button for "{% data variables.product.prodname_secret_scanning_caps %}". To the right of "{% data variables.product.prodname_GH_advanced_security %}", click **Enable**. ![Enable {% data variables.product.prodname_GH_advanced_security %} for your repository](/assets/images/help/repository/enable-ghas-dotcom.png) @@ -34,10 +36,18 @@ versions: ![Confirm enabling {% data variables.product.prodname_GH_advanced_security %} for your repository](/assets/images/help/repository/enable-ghas-confirmation-dotcom.png) 6. When you enable {% data variables.product.prodname_GH_advanced_security %} this may automatically enable {% data variables.product.prodname_secret_scanning %} for the repository (this is controlled by the organization configuration). If "{% data variables.product.prodname_secret_scanning_caps %}" is shown with an **Enable** button, you still need to enable {% data variables.product.prodname_secret_scanning %} by clicking **Enable**. If you see a **Disable** button, {% data variables.product.prodname_secret_scanning %} is already enabled. ![Enable {% data variables.product.prodname_secret_scanning %} for your repository](/assets/images/help/repository/enable-secret-scanning-dotcom.png) - {% else if enterpriseServerVersions contains currentVersion and currentVersion == "enterprise-server@3.0" %} -4. To the right of "{% data variables.product.prodname_secret_scanning_caps %}", click **Enable**. + {% elsif currentVersion == "enterprise-server@3.0" %} +7. To the right of "{% data variables.product.prodname_secret_scanning_caps %}", click **Enable**. ![Enable {% data variables.product.prodname_secret_scanning %} for your repository](/assets/images/help/repository/enable-secret-scanning-ghe.png) {% endif %} +{% if currentVersion == "github-ae@latest" %} +1. Before you can enable {% data variables.product.prodname_secret_scanning %}, you need to enable {% data variables.product.prodname_GH_advanced_security %} first. To the right of "{% data variables.product.prodname_GH_advanced_security %}", click **Enable**. + ![Enable {% data variables.product.prodname_GH_advanced_security %} for your repository](/assets/images/enterprise/github-ae/repository/enable-ghas-ghae.png) +2. Click **Enable {% data variables.product.prodname_GH_advanced_security %} for this repository** to confirm the action. + ![Confirm enabling {% data variables.product.prodname_GH_advanced_security %} for your repository](/assets/images/enterprise/github-ae/repository/enable-ghas-confirmation-ghae.png) +3. To the right of "{% data variables.product.prodname_secret_scanning_caps %}", click **Enable**. + ![Enable {% data variables.product.prodname_secret_scanning %} for your repository](/assets/images/enterprise/github-ae/repository/enable-secret-scanning-ghae.png) +{% endif %} ### Excluding alerts from {% data variables.product.prodname_secret_scanning %} in {% if currentVersion == "free-pro-team@latest" %}private {% endif %}repositories diff --git a/content/github/administering-a-repository/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-repository.md b/content/github/administering-a-repository/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-repository.md index c759845dad..309dca088f 100644 --- a/content/github/administering-a-repository/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-repository.md +++ b/content/github/administering-a-repository/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-repository.md @@ -4,6 +4,9 @@ intro: 'You can configure the retention period for {% data variables.product.pro versions: free-pro-team: '*' enterprise-server: '>=2.23' + github-ae: '*' +topics: + - repositories --- {% data reusables.actions.about-artifact-log-retention %} diff --git a/content/github/administering-a-repository/customizing-dependency-updates.md b/content/github/administering-a-repository/customizing-dependency-updates.md index 95340f31d2..8d078b68fc 100644 --- a/content/github/administering-a-repository/customizing-dependency-updates.md +++ b/content/github/administering-a-repository/customizing-dependency-updates.md @@ -4,6 +4,8 @@ intro: 'You can customize how {% data variables.product.prodname_dependabot %} m permissions: 'People with write permissions to a repository can configure {% data variables.product.prodname_dependabot %} for the repository.' versions: free-pro-team: '*' +topics: + - repositories --- {% data reusables.dependabot.beta-note %} diff --git a/content/github/administering-a-repository/customizing-how-changed-files-appear-on-github.md b/content/github/administering-a-repository/customizing-how-changed-files-appear-on-github.md index 77d1e3d332..1e5e81df5b 100644 --- a/content/github/administering-a-repository/customizing-how-changed-files-appear-on-github.md +++ b/content/github/administering-a-repository/customizing-how-changed-files-appear-on-github.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- Use a *.gitattributes* file to mark files that match a given "pattern" with the specified attributes. A *.gitattributes* file uses the same rules for matching as _.gitignore_ files. For more information, see [PATTERN FORMAT](https://www.git-scm.com/docs/gitignore#_pattern_format) in the Git documentation. diff --git a/content/github/administering-a-repository/customizing-your-repositorys-social-media-preview.md b/content/github/administering-a-repository/customizing-your-repositorys-social-media-preview.md index 10a7cc5654..beb609f0db 100644 --- a/content/github/administering-a-repository/customizing-your-repositorys-social-media-preview.md +++ b/content/github/administering-a-repository/customizing-your-repositorys-social-media-preview.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- Until you add an image, repository links expand to show basic information about the repository and the owner's avatar. Adding an image to your repository can help identify your project across various social platforms. diff --git a/content/github/administering-a-repository/defining-the-mergeability-of-pull-requests.md b/content/github/administering-a-repository/defining-the-mergeability-of-pull-requests.md index ddf52fc18c..584181f842 100644 --- a/content/github/administering-a-repository/defining-the-mergeability-of-pull-requests.md +++ b/content/github/administering-a-repository/defining-the-mergeability-of-pull-requests.md @@ -11,5 +11,7 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- diff --git a/content/github/administering-a-repository/deleting-a-repository.md b/content/github/administering-a-repository/deleting-a-repository.md index 87e00bcbfc..51abc910fb 100644 --- a/content/github/administering-a-repository/deleting-a-repository.md +++ b/content/github/administering-a-repository/deleting-a-repository.md @@ -9,6 +9,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- {% data reusables.organizations.owners-and-admins-can %} delete an organization repository. If **Allow members to delete or transfer repositories for this organization** has been disabled, only organization owners can delete organization repositories. {% data reusables.organizations.new-repo-permissions-more-info %} diff --git a/content/github/administering-a-repository/deleting-and-restoring-branches-in-a-pull-request.md b/content/github/administering-a-repository/deleting-and-restoring-branches-in-a-pull-request.md index 69b1689383..ea22b7c9f4 100644 --- a/content/github/administering-a-repository/deleting-and-restoring-branches-in-a-pull-request.md +++ b/content/github/administering-a-repository/deleting-and-restoring-branches-in-a-pull-request.md @@ -10,6 +10,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- ### Deleting a branch used for a pull request diff --git a/content/github/administering-a-repository/disabling-or-limiting-github-actions-for-a-repository.md b/content/github/administering-a-repository/disabling-or-limiting-github-actions-for-a-repository.md index 3ae328181f..d7afb49e30 100644 --- a/content/github/administering-a-repository/disabling-or-limiting-github-actions-for-a-repository.md +++ b/content/github/administering-a-repository/disabling-or-limiting-github-actions-for-a-repository.md @@ -4,6 +4,9 @@ intro: 'Repository owners can disable, enable, and limit {% data variables.produ versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' +topics: + - repositories --- {% data reusables.actions.enterprise-beta %} diff --git a/content/github/administering-a-repository/displaying-a-sponsor-button-in-your-repository.md b/content/github/administering-a-repository/displaying-a-sponsor-button-in-your-repository.md index f49eb6231f..e665938671 100644 --- a/content/github/administering-a-repository/displaying-a-sponsor-button-in-your-repository.md +++ b/content/github/administering-a-repository/displaying-a-sponsor-button-in-your-repository.md @@ -6,6 +6,8 @@ redirect_from: - /articles/displaying-a-sponsor-button-in-your-repository versions: free-pro-team: '*' +topics: + - repositories --- ### About FUNDING files @@ -16,7 +18,7 @@ You can add one username, package name, or project name per external funding pla Platform | Syntax -------- | ----- -[CommunityBridge](https://communitybridge.org) | `community_bridge: PROJECT-NAME` +[LFX Mentorship (formerly CommunityBridge)](https://lfx.linuxfoundation.org/tools/mentorship) | `community_bridge: PROJECT-NAME` [{% data variables.product.prodname_sponsors %}](https://github.com/sponsors) | `github: USERNAME` or `github: [USERNAME, USERNAME, USERNAME, USERNAME]` [IssueHunt](https://issuehunt.io/) | `issuehunt: USERNAME` [Ko-fi](https://ko-fi.com/) | `ko_fi: USERNAME` diff --git a/content/github/administering-a-repository/enabling-and-disabling-version-updates.md b/content/github/administering-a-repository/enabling-and-disabling-version-updates.md index 04f8ec9a61..e84fe4da5c 100644 --- a/content/github/administering-a-repository/enabling-and-disabling-version-updates.md +++ b/content/github/administering-a-repository/enabling-and-disabling-version-updates.md @@ -4,6 +4,8 @@ intro: 'You can configure your repository so that {% data variables.product.prod permissions: 'People with write permissions to a repository can enable or disable {% data variables.product.prodname_dependabot_version_updates %} for the repository.' versions: free-pro-team: '*' +topics: + - repositories --- {% data reusables.dependabot.beta-note-no-link %} @@ -18,9 +20,12 @@ You enable {% data variables.product.prodname_dependabot_version_updates %} by c ### Enabling {% data variables.product.prodname_dependabot_version_updates %} -{% data reusables.dependabot.create-dependabot-yml %} -1. Use `package-ecosystem` to specify the package managers to monitor. +{% data reusables.dependabot.create-dependabot-yml %} For information, see "[Configuration options for dependency updates](/github/administering-a-repository/configuration-options-for-dependency-updates)." +1. Add a `version`. +1. Optionally, if you have dependencies in a private registry, add a `registries` section containing authentication details. +1. Add an `updates` section, with an entry for each package manager you want {% data variables.product.prodname_dependabot %} to monitor. 1. For each package manager, use: + - `package-ecosystem` to specify the package manager. - `directory` to specify the location of the manifest or other definition files. - `schedule.interval` to specify how often to check for new versions. {% data reusables.dependabot.check-in-dependabot-yml %} diff --git a/content/github/administering-a-repository/enabling-or-disabling-github-discussions-for-a-repository.md b/content/github/administering-a-repository/enabling-or-disabling-github-discussions-for-a-repository.md index 9937e19241..0ec0ad3282 100644 --- a/content/github/administering-a-repository/enabling-or-disabling-github-discussions-for-a-repository.md +++ b/content/github/administering-a-repository/enabling-or-disabling-github-discussions-for-a-repository.md @@ -5,6 +5,8 @@ product: '{% data reusables.gated-features.discussions %}' permissions: People with admin permissions to a repository can enable discussions for the repository. versions: free-pro-team: '*' +topics: + - repositories --- {% data reusables.discussions.beta %} diff --git a/content/github/administering-a-repository/index.md b/content/github/administering-a-repository/index.md index 5ed179703c..6c1ae35807 100644 --- a/content/github/administering-a-repository/index.md +++ b/content/github/administering-a-repository/index.md @@ -6,6 +6,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- @@ -64,6 +66,7 @@ versions: {% link_in_list /enabling-and-disabling-version-updates %} {% link_in_list /listing-dependencies-configured-for-version-updates %} {% link_in_list /managing-pull-requests-for-dependency-updates %} + {% link_in_list /managing-encrypted-secrets-for-dependabot %} {% link_in_list /customizing-dependency-updates %} {% link_in_list /configuration-options-for-dependency-updates %} {% link_in_list /keeping-your-actions-up-to-date-with-dependabot %} diff --git a/content/github/administering-a-repository/keeping-your-actions-up-to-date-with-dependabot.md b/content/github/administering-a-repository/keeping-your-actions-up-to-date-with-dependabot.md index e489fec42f..212bf528dd 100644 --- a/content/github/administering-a-repository/keeping-your-actions-up-to-date-with-dependabot.md +++ b/content/github/administering-a-repository/keeping-your-actions-up-to-date-with-dependabot.md @@ -5,6 +5,8 @@ redirect_from: - /github/administering-a-repository/keeping-your-actions-up-to-date-with-github-dependabot versions: free-pro-team: '*' +topics: + - repositories --- {% data reusables.dependabot.beta-note %} @@ -13,6 +15,8 @@ versions: Actions are often updated with bug fixes and new features to make automated processes more reliable, faster, and safer. When you enable {% data variables.product.prodname_dependabot_version_updates %} for {% data variables.product.prodname_actions %}, {% data variables.product.prodname_dependabot %} will help ensure that references to actions in a repository's *workflow.yml* file are kept up to date. For each action in the file, {% data variables.product.prodname_dependabot %} checks the action's reference (typically a version number or commit identifier associated with the action) against the latest version. If a more recent version of the action is available, {% data variables.product.prodname_dependabot %} will send you a pull request that updates the reference in the workflow file to the latest version. For more information about {% data variables.product.prodname_dependabot_version_updates %}, see "[About {% data variables.product.prodname_dependabot_version_updates %}](/github/administering-a-repository/about-dependabot-version-updates)." For more information about configuring workflows for {% data variables.product.prodname_actions %}, see "[Learn {% data variables.product.prodname_actions %}](/actions/learn-github-actions)." +{% data reusables.actions.workflow-runs-dependabot-note %} + ### Enabling {% data variables.product.prodname_dependabot_version_updates %} for actions {% data reusables.dependabot.create-dependabot-yml %} If you have already enabled {% data variables.product.prodname_dependabot_version_updates %} for other ecosystems or package managers, simply open the existing *dependabot.yml* file. diff --git a/content/github/administering-a-repository/keeping-your-dependencies-updated-automatically.md b/content/github/administering-a-repository/keeping-your-dependencies-updated-automatically.md index 3c6c79af15..5b7076daa1 100644 --- a/content/github/administering-a-repository/keeping-your-dependencies-updated-automatically.md +++ b/content/github/administering-a-repository/keeping-your-dependencies-updated-automatically.md @@ -4,5 +4,7 @@ intro: '{% data variables.product.prodname_dependabot %} can maintain your repos mapTopic: true versions: free-pro-team: '*' +topics: + - repositories --- diff --git a/content/github/administering-a-repository/linking-to-releases.md b/content/github/administering-a-repository/linking-to-releases.md index 8d87615b86..b6cb7bbcba 100644 --- a/content/github/administering-a-repository/linking-to-releases.md +++ b/content/github/administering-a-repository/linking-to-releases.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- {% data reusables.repositories.navigate-to-repo %} diff --git a/content/github/administering-a-repository/listing-dependencies-configured-for-version-updates.md b/content/github/administering-a-repository/listing-dependencies-configured-for-version-updates.md index 19a0c93aee..5fb3ca1c67 100644 --- a/content/github/administering-a-repository/listing-dependencies-configured-for-version-updates.md +++ b/content/github/administering-a-repository/listing-dependencies-configured-for-version-updates.md @@ -3,6 +3,8 @@ title: Listing dependencies configured for version updates intro: 'You can view the dependencies that {% data variables.product.prodname_dependabot %} monitors for updates.' versions: free-pro-team: '*' +topics: + - repositories --- {% data reusables.dependabot.beta-note %} diff --git a/content/github/administering-a-repository/managing-a-branch-protection-rule.md b/content/github/administering-a-repository/managing-a-branch-protection-rule.md index 06a6d484d7..38384638d7 100644 --- a/content/github/administering-a-repository/managing-a-branch-protection-rule.md +++ b/content/github/administering-a-repository/managing-a-branch-protection-rule.md @@ -21,6 +21,8 @@ versions: enterprise-server: '*' github-ae: '*' permissions: People with admin permissions to a repository can manage branch protection rules. +topics: + - repositories --- ### About branch protection rules diff --git a/content/github/administering-a-repository/managing-alerts-from-secret-scanning.md b/content/github/administering-a-repository/managing-alerts-from-secret-scanning.md index a25d4ef064..e4495dda34 100644 --- a/content/github/administering-a-repository/managing-alerts-from-secret-scanning.md +++ b/content/github/administering-a-repository/managing-alerts-from-secret-scanning.md @@ -5,6 +5,9 @@ product: '{% data reusables.gated-features.secret-scanning %}' versions: free-pro-team: '*' enterprise-server: '>=3.0' + github-ae: '*' +topics: + - repositories --- {% data reusables.secret-scanning.beta %} @@ -13,20 +16,28 @@ versions: {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-security %} -3. In the left sidebar, click **Detected secrets**. -!["Detected secrets" tab](/assets/images/help/repository/sidebar-secrets.png) +3. In the left sidebar, click **Secret scanning alerts**. + {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} + !["Secret scanning alerts" tab](/assets/images/help/repository/sidebar-secrets.png) + {% endif %} + {% if currentVersion == "github-ae@latest" %} + !["Secret scanning alerts" tab](/assets/images/enterprise/github-ae/repository/sidebar-secrets-ghae.png) + {% endif %} 4. Under "Secret scanning" click the alert you want to view. {% if currentVersion == "free-pro-team@latest" %} ![List of alerts from secret scanning](/assets/images/help/repository/secret-scanning-click-alert.png) {% endif %} - {% if enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.22" %} + {% if currentVersion ver_gt "enterprise-server@2.22" %} ![List of alerts from secret scanning](/assets/images/help/repository/secret-scanning-click-alert-ghe.png) {% endif %} -1. Optionally, use the "Mark as" drop-down menu and click a reason for resolving an alert. + {% if currentVersion == "github-ae@latest" %} + ![List of alerts from secret scanning](/assets/images/enterprise/github-ae/repository/secret-scanning-click-alert-ghae.png) + {% endif %} +5. Optionally, use the "Mark as" drop-down menu and click a reason for resolving an alert. {% if currentVersion == "free-pro-team@latest" %} ![Drop-down menu for resolving an alert from secret scanning](/assets/images/help/repository/secret-scanning-resolve-alert.png) {% endif %} - {% if enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.22" %} + {% if currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} ![Drop-down menu for resolving an alert from secret scanning](/assets/images/help/repository/secret-scanning-resolve-alert-ghe.png) {% endif %} diff --git a/content/github/administering-a-repository/managing-auto-merge-for-pull-requests-in-your-repository.md b/content/github/administering-a-repository/managing-auto-merge-for-pull-requests-in-your-repository.md index 77fe94a3c3..0e7cb11f0f 100644 --- a/content/github/administering-a-repository/managing-auto-merge-for-pull-requests-in-your-repository.md +++ b/content/github/administering-a-repository/managing-auto-merge-for-pull-requests-in-your-repository.md @@ -1,11 +1,14 @@ --- title: Managing auto-merge for pull requests in your repository -intro: "You can allow or disallow auto-merge for pull requests in your repository." +intro: You can allow or disallow auto-merge for pull requests in your repository. product: '{% data reusables.gated-features.auto-merge %}' versions: free-pro-team: '*' enterprise-server: '>=3.1' + github-ae: '*' permissions: People with maintainer permissions can manage auto-merge for pull requests in a repository. +topics: + - repositories --- If you allow auto-merge for pull requests in your repository, people can configure individual pull requests in the repository to merge automatically when all merge requirements are met. For more information, see "[Automatically merging a pull request](/github/collaborating-with-issues-and-pull-requests/automatically-merging-a-pull-request)." diff --git a/content/github/administering-a-repository/managing-branches-in-your-repository.md b/content/github/administering-a-repository/managing-branches-in-your-repository.md index 2688f35f9e..c59c70f2b2 100644 --- a/content/github/administering-a-repository/managing-branches-in-your-repository.md +++ b/content/github/administering-a-repository/managing-branches-in-your-repository.md @@ -8,5 +8,7 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- diff --git a/content/github/administering-a-repository/managing-encrypted-secrets-for-dependabot.md b/content/github/administering-a-repository/managing-encrypted-secrets-for-dependabot.md new file mode 100644 index 0000000000..1362ff7866 --- /dev/null +++ b/content/github/administering-a-repository/managing-encrypted-secrets-for-dependabot.md @@ -0,0 +1,72 @@ +--- +title: Managing encrypted secrets for Dependabot +intro: You can store sensitive information, like passwords and access tokens, as encrypted secrets and then reference these in the {% data variables.product.prodname_dependabot %} configuration file. +versions: + free-pro-team: '*' +--- + +### About encrypted secrets for {% data variables.product.prodname_dependabot %} + +{% data variables.product.prodname_dependabot %} secrets are encrypted credentials that you create at either the organization level or the repository level. +When you add a secret at the organization level, you can specify which repositories can access the secret. You can use secrets to allow {% data variables.product.prodname_dependabot %} to update dependencies located in private package registries. When you add a secret it's encrypted before it reaches {% data variables.product.prodname_dotcom %} and it remains encrypted until it's used by {% data variables.product.prodname_dependabot %} to access a private package registry. + +After you add a {% data variables.product.prodname_dependabot %} secret, you can reference it in the _dependabot.yml_ configuration file like this: {% raw %}`${{secrets.NAME}}`{% endraw %}, where "NAME" is the name you chose for the secret. For example: + +{% raw %} +```yaml +password: ${{secrets.MY_ARTIFACTORY_PASSWORD}} +``` +{% endraw %} + +For more information, see "[Configuration options for dependency updates](/github/administering-a-repository/configuration-options-for-dependency-updates#configuration-options-for-private-registries)." + +#### Naming your secrets + +The name of a {% data variables.product.prodname_dependabot %} secret: +* Can only contain alphanumeric characters (`[A-Z]`, `[0-9]`) or underscores (`_`). Spaces are not allowed. If you enter lowercase letters these are changed to uppercase. +* Must not start with the `GITHUB_` prefix. +* Must not start with a number. + +### Adding a repository secret for {% data variables.product.prodname_dependabot %} + +{% data reusables.github-actions.permissions-statement-secrets-repository %} + +{% data reusables.repositories.navigate-to-repo %} +{% data reusables.repositories.sidebar-settings %} +{% data reusables.github-actions.sidebar-secret %} +{% data reusables.dependabot.dependabot-secrets-button %} +1. Click **New repository secret**. +1. Type a name for your secret in the **Name** input box. +1. Enter the value for your secret. +1. Click **Add secret**. + + The name of the secret is listed on the Dependabot secrets page. You can click **Update** to change the secret value. You can click **Remove** to delete the secret. + + ![Update or remove a repository secret](/assets/images/help/dependabot/update-remove-repo-secret.png) + +### Adding an organization secret for {% data variables.product.prodname_dependabot %} + +When creating a secret in an organization, you can use a policy to limit which repositories can access that secret. For example, you can grant access to all repositories, or limit access to only private repositories or a specified list of repositories. + +{% data reusables.github-actions.permissions-statement-secrets-organization %} + +{% data reusables.organizations.navigate-to-org %} +{% data reusables.organizations.org_settings %} +{% data reusables.github-actions.sidebar-secret %} +{% data reusables.dependabot.dependabot-secrets-button %} +1. Click **New organization secret**. +1. Type a name for your secret in the **Name** input box. +1. Enter the **Value** for your secret. +1. From the **Repository access** dropdown list, choose an access policy. +1. If you chose **Selected repositories**: + + * Click {% octicon "gear" aria-label="The Gear icon" %}. + * Choose the repositories that can access this secret. + ![Select repositories for this secret](/assets/images/help/dependabot/secret-repository-access.png) + * Click **Update selection**. + +1. Click **Add secret**. + + The name of the secret is listed on the Dependabot secrets page. You can click **Update** to change the secret value or its access policy. You can click **Remove** to delete the secret. + + ![Update or remove an organization secret](/assets/images/help/dependabot/update-remove-repo-secret.png) diff --git a/content/github/administering-a-repository/managing-git-lfs-objects-in-archives-of-your-repository.md b/content/github/administering-a-repository/managing-git-lfs-objects-in-archives-of-your-repository.md index a4bb51ee20..f8f65c1c80 100644 --- a/content/github/administering-a-repository/managing-git-lfs-objects-in-archives-of-your-repository.md +++ b/content/github/administering-a-repository/managing-git-lfs-objects-in-archives-of-your-repository.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '>3.0' github-ae: '*' +topics: + - repositories --- ### About {% data variables.large_files.product_name_short %} objects in archives diff --git a/content/github/administering-a-repository/managing-pull-requests-for-dependency-updates.md b/content/github/administering-a-repository/managing-pull-requests-for-dependency-updates.md index ebe089535a..ed3277df69 100644 --- a/content/github/administering-a-repository/managing-pull-requests-for-dependency-updates.md +++ b/content/github/administering-a-repository/managing-pull-requests-for-dependency-updates.md @@ -3,6 +3,8 @@ title: Managing pull requests for dependency updates intro: 'You manage pull requests raised by {% data variables.product.prodname_dependabot %} in much the same way as other pull requests, but there are some extra options.' versions: free-pro-team: '*' +topics: + - repositories --- {% data reusables.dependabot.beta-note %} diff --git a/content/github/administering-a-repository/managing-releases-in-a-repository.md b/content/github/administering-a-repository/managing-releases-in-a-repository.md index fb779d9e7c..0998c7252e 100644 --- a/content/github/administering-a-repository/managing-releases-in-a-repository.md +++ b/content/github/administering-a-repository/managing-releases-in-a-repository.md @@ -13,6 +13,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion ver_gt "github-ae@latest" %} diff --git a/content/github/administering-a-repository/managing-repository-settings.md b/content/github/administering-a-repository/managing-repository-settings.md index fe7f46cdc3..d62b9d82b2 100644 --- a/content/github/administering-a-repository/managing-repository-settings.md +++ b/content/github/administering-a-repository/managing-repository-settings.md @@ -8,5 +8,7 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- diff --git a/content/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository.md b/content/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository.md index f8c0730a6b..4eed68ffc8 100644 --- a/content/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository.md +++ b/content/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository.md @@ -10,6 +10,9 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=3.0' + github-ae: '*' +topics: + - repositories --- {% if currentVersion == "free-pro-team@latest" %} @@ -26,31 +29,36 @@ You can manage a subset of security and analysis features for public repositorie ### Enabling or disabling security and analysis features{% if currentVersion == "free-pro-team@latest" %} for private repositories{% endif %} -You can manage the security and analysis features for your {% if currentVersion == "free-pro-team@latest" %}private or internal {% endif %}repository. If your organization or enterprise has a license for {% data variables.product.prodname_GH_advanced_security %} then extra options are available. {% data reusables.advanced-security.more-info-ghas %} +You can manage the security and analysis features for your {% if currentVersion == "free-pro-team@latest" %}private or internal {% endif %}repository.{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} If your organization belongs to an enterprise with a license for {% data variables.product.prodname_GH_advanced_security %} then extra options are available. {% data reusables.advanced-security.more-info-ghas %}{% endif %} {% data reusables.security.security-and-analysis-features-enable-read-only %} {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} {% data reusables.repositories.navigate-to-security-and-analysis %} -4. Under "Configure security and analysis features", to the right of the feature, click **Disable** or **Enable**. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}If the control for "{% data variables.product.prodname_secret_scanning_caps %}" is not active, you need to enable {% data variables.product.prodname_GH_advanced_security %} first. +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} +4. Under "Configure security and analysis features", to the right of the feature, click **Disable** or **Enable**.{% endif %} {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}The control for "{% data variables.product.prodname_GH_advanced_security %}" is disabled if you have no available seats in your {% data variables.product.prodname_GH_advanced_security %} license. !["Enable" or "Disable" button for "Configure security and analysis" features](/assets/images/help/repository/security-and-analysis-disable-or-enable-dotcom-private.png) {% note %} - **Note:** If you disable {% data variables.product.prodname_GH_advanced_security %}, both {% data variables.product.prodname_secret_scanning %} and {% data variables.product.prodname_code_scanning %} are disabled. Any workflows, SARIF uploads, or API calls for {% data variables.product.prodname_code_scanning %} will fail. + **Note:** If you disable {% data variables.product.prodname_GH_advanced_security %}, {% if currentVersion == "free-pro-team@latest" %}dependency review, {% endif %}{% data variables.product.prodname_secret_scanning %} and {% data variables.product.prodname_code_scanning %} are disabled. Any workflows, SARIF uploads, or API calls for {% data variables.product.prodname_code_scanning %} will fail. {% endnote %} - - {% else if enterpriseServerVersions contains currentVersion and currentVersion == "enterprise-server@3.0" %} + {% endif %} + {% if currentVersion == "enterprise-server@3.0" %} !["Enable" or "Disable" button for "Configure security and analysis" features](/assets/images/help/repository/security-and-analysis-disable-or-enable-ghe.png) {% endif %} + {% if currentVersion == "github-ae@latest" %} +4. Under "Configure security and analysis features", to the right of the feature, click **Disable** or **Enable**. Before you can enable "{% data variables.product.prodname_secret_scanning %}" for your repository, you need to enable {% data variables.product.prodname_GH_advanced_security %}. + ![Enable or disable {% data variables.product.prodname_GH_advanced_security %} or {% data variables.product.prodname_secret_scanning %} for your repository](/assets/images/enterprise/github-ae/repository/enable-ghas-secret-scanning-ghae.png) + {% endif %} ### Granting access to security alerts -After you enable {% data variables.product.prodname_dependabot %} or {% data variables.product.prodname_secret_scanning %} alerts for a repository in an organization, organization owners and repository administrators can view the alerts by default. You can give additional teams and people access to the alerts for a repository. +After you enable {% if currentVersion != "github-ae@latest" %}{% data variables.product.prodname_dependabot %} or {% endif %}{% data variables.product.prodname_secret_scanning %} alerts for a repository in an organization, organization owners and repository administrators can view the alerts by default. You can give additional teams and people access to the alerts for a repository. {% note %} -Organization owners and repository administrators can only grant access to view security alerts, such as {% data variables.product.prodname_dependabot %} and {% data variables.product.prodname_secret_scanning %} alerts, to people or teams who have write access to the repo. +Organization owners and repository administrators can only grant access to view security alerts, such as {% data variables.product.prodname_secret_scanning %} alerts, to people or teams who have write access to the repo. {% endnote %} @@ -64,8 +72,17 @@ Organization owners and repository administrators can only grant access to view {% if enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.22" %} ![Search field for granting people or teams access to security alerts](/assets/images/help/repository/security-and-analysis-security-alerts-person-or-team-search-ghe.png) {% endif %} + {% if currentVersion == "github-ae@latest" %} + ![Search field for granting people or teams access to security alerts](/assets/images/enterprise/github-ae/repository/security-and-analysis-security-alerts-person-or-team-search-ghae.png) + {% endif %} + 5. Click **Save changes**. - !["Save changes" button for changes to security alert settings](/assets/images/help/repository/security-and-analysis-security-alerts-save-changes.png) + {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} + !["Save changes" button for changes to security alert settings](/assets/images/help/repository/security-and-analysis-security-alerts-save-changes.png) + {% endif %} + {% if currentVersion == "github-ae@latest" %} + !["Save changes" button for changes to security alert settings](/assets/images/enterprise/github-ae/repository/security-and-analysis-security-alerts-save-changes-ghae.png) + {% endif %} ### Removing access to security alerts @@ -79,6 +96,9 @@ Organization owners and repository administrators can only grant access to view {% if enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.22" %} !["x" button to remove someone's access to security alerts for your repository](/assets/images/help/repository/security-and-analysis-security-alerts-username-x-ghe.png) {% endif %} + {% if currentVersion == "github-ae@latest" %} + !["x" button to remove someone's access to security alerts for your repository](/assets/images/enterprise/github-ae/repository/security-and-analysis-security-alerts-username-x-ghae.png) + {% endif %} ### Further reading diff --git a/content/github/administering-a-repository/managing-teams-and-people-with-access-to-your-repository.md b/content/github/administering-a-repository/managing-teams-and-people-with-access-to-your-repository.md index 9e38d3ccec..fc4dac0766 100644 --- a/content/github/administering-a-repository/managing-teams-and-people-with-access-to-your-repository.md +++ b/content/github/administering-a-repository/managing-teams-and-people-with-access-to-your-repository.md @@ -6,6 +6,8 @@ redirect_from: - /github/administering-a-repository/managing-people-and-teams-with-access-to-your-repository versions: free-pro-team: '*' +topics: + - repositories --- ### About managing access to your repository diff --git a/content/github/administering-a-repository/managing-the-automatic-deletion-of-branches.md b/content/github/administering-a-repository/managing-the-automatic-deletion-of-branches.md index f165dc4986..ffa5b30e4a 100644 --- a/content/github/administering-a-repository/managing-the-automatic-deletion-of-branches.md +++ b/content/github/administering-a-repository/managing-the-automatic-deletion-of-branches.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- Anyone with admin permissions to a repository can enable or disable the automatic deletion of branches. diff --git a/content/github/administering-a-repository/managing-the-forking-policy-for-your-repository.md b/content/github/administering-a-repository/managing-the-forking-policy-for-your-repository.md index 94e4afbdf9..6d6be04cd2 100644 --- a/content/github/administering-a-repository/managing-the-forking-policy-for-your-repository.md +++ b/content/github/administering-a-repository/managing-the-forking-policy-for-your-repository.md @@ -9,6 +9,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- An organization owner must allow forks of private{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.19" %} and internal{% endif %} repositories on the organization level before you can allow or disallow forks for a specific repository. For more information, see "[Managing the forking policy for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-the-forking-policy-for-your-organization)." diff --git a/content/github/administering-a-repository/releasing-projects-on-github.md b/content/github/administering-a-repository/releasing-projects-on-github.md index 372ed4cafc..0ee087417a 100644 --- a/content/github/administering-a-repository/releasing-projects-on-github.md +++ b/content/github/administering-a-repository/releasing-projects-on-github.md @@ -9,5 +9,7 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- diff --git a/content/github/administering-a-repository/renaming-a-branch.md b/content/github/administering-a-repository/renaming-a-branch.md index 7b23d9d5d5..2386a11954 100644 --- a/content/github/administering-a-repository/renaming-a-branch.md +++ b/content/github/administering-a-repository/renaming-a-branch.md @@ -5,6 +5,8 @@ permissions: People with write permissions to a repository can rename a branch i versions: free-pro-team: '*' enterprise-server: '>=3.1' +topics: + - repositories --- ### About renaming branches diff --git a/content/github/administering-a-repository/renaming-a-repository.md b/content/github/administering-a-repository/renaming-a-repository.md index 49b2a1bb30..57638a77a7 100644 --- a/content/github/administering-a-repository/renaming-a-repository.md +++ b/content/github/administering-a-repository/renaming-a-repository.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- When you rename a repository, all existing information, with the exception of project site URLs, is automatically redirected to the new name, including: diff --git a/content/github/administering-a-repository/restoring-a-deleted-repository.md b/content/github/administering-a-repository/restoring-a-deleted-repository.md index 7f8ac645e7..52e4b9e21e 100644 --- a/content/github/administering-a-repository/restoring-a-deleted-repository.md +++ b/content/github/administering-a-repository/restoring-a-deleted-repository.md @@ -5,6 +5,8 @@ redirect_from: - /articles/restoring-a-deleted-repository versions: free-pro-team: '*' +topics: + - repositories --- Anyone can restore deleted repositories that were owned by their own user account. Organization owners can restore deleted repositories that were owned by the organization. diff --git a/content/github/administering-a-repository/securing-your-repository.md b/content/github/administering-a-repository/securing-your-repository.md index df0cafb217..357d9148e6 100644 --- a/content/github/administering-a-repository/securing-your-repository.md +++ b/content/github/administering-a-repository/securing-your-repository.md @@ -7,5 +7,8 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=3.0' + github-ae: '*' +topics: + - repositories --- diff --git a/content/github/administering-a-repository/setting-repository-visibility.md b/content/github/administering-a-repository/setting-repository-visibility.md index 1a36f2f066..587bf86a29 100644 --- a/content/github/administering-a-repository/setting-repository-visibility.md +++ b/content/github/administering-a-repository/setting-repository-visibility.md @@ -10,6 +10,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- ### About repository visibility changes @@ -25,7 +27,7 @@ We recommend reviewing the following caveats before you change the visibility of * If you're using {% data variables.product.prodname_free_user %} for user accounts or organizations, some features won't be available in the repository after you change the visibility to private. {% data reusables.gated-features.more-info %}{% endif %} * Any published {% data variables.product.prodname_pages %} site will be automatically unpublished.{% if currentVersion == "free-pro-team@latest" %} If you added a custom domain to the {% data variables.product.prodname_pages %} site, you should remove or update your DNS records before making the repository private, to avoid the risk of a domain takeover. For more information, see "[Managing a custom domain for your {% data variables.product.prodname_pages %} site](/articles/managing-a-custom-domain-for-your-github-pages-site)."{% endif %}{% if currentVersion == "free-pro-team@latest" %} * {% data variables.product.prodname_dotcom %} will no longer include the repository in the {% data variables.product.prodname_archive %}. For more information, see "[About archiving content and data on {% data variables.product.prodname_dotcom %}](/github/creating-cloning-and-archiving-repositories/about-archiving-content-and-data-on-github#about-the-github-archive-program)."{% endif %}{% if currentVersion == "free-pro-team@latest" %} -* {% data variables.product.prodname_GH_advanced_security %} features, such as {% data variables.product.prodname_code_scanning %}, will stop working unless the repository is owned by an organization that has a license for {% data variables.product.prodname_advanced_security %}. {% data reusables.advanced-security.more-info-ghas %}{% endif %}{% if enterpriseServerVersions contains currentVersion %} +* {% data variables.product.prodname_GH_advanced_security %} features, such as {% data variables.product.prodname_code_scanning %}, will stop working unless the repository is owned by an organization that is part of an enterprise with a license for {% data variables.product.prodname_advanced_security %} and sufficient spare seats. {% data reusables.advanced-security.more-info-ghas %}{% endif %}{% if enterpriseServerVersions contains currentVersion %} * Anonymous Git read access is no longer available. For more information, see "[Enabling anonymous Git read access for a repository](/enterprise/{{ currentVersion }}/user/articles/enabling-anonymous-git-read-access-for-a-repository)."{% endif %} {% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.19" %} diff --git a/content/github/administering-a-repository/transferring-a-repository.md b/content/github/administering-a-repository/transferring-a-repository.md index 95343d8a7a..94388ad8a4 100644 --- a/content/github/administering-a-repository/transferring-a-repository.md +++ b/content/github/administering-a-repository/transferring-a-repository.md @@ -16,6 +16,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- ### About repository transfers diff --git a/content/github/administering-a-repository/troubleshooting-required-status-checks.md b/content/github/administering-a-repository/troubleshooting-required-status-checks.md index d07532b5f4..3424fb27b7 100644 --- a/content/github/administering-a-repository/troubleshooting-required-status-checks.md +++ b/content/github/administering-a-repository/troubleshooting-required-status-checks.md @@ -1,11 +1,13 @@ --- title: Troubleshooting required status checks -intro: 'You can check for common errors and resolve issues with required status checks.' +intro: You can check for common errors and resolve issues with required status checks. product: '{% data reusables.gated-features.protected-branches %}' versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- If you have a check and a status with the same name, and you select that name as a required status check, both the check and the status are required. For more information, see "[Checks](/rest/reference/checks)." diff --git a/content/github/administering-a-repository/viewing-branches-in-your-repository.md b/content/github/administering-a-repository/viewing-branches-in-your-repository.md index b6df1553e5..f2c4839806 100644 --- a/content/github/administering-a-repository/viewing-branches-in-your-repository.md +++ b/content/github/administering-a-repository/viewing-branches-in-your-repository.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.navigate-to-branches %} @@ -16,6 +18,8 @@ versions: - **Stale branches**: The **Stale** view shows all branches that no one has committed to in the last three months, ordered by the branches with the oldest commits first. Use this list to determine [which branches to delete](/articles/creating-and-deleting-branches-within-your-repository). - **All branches**: The **All** view shows the default branch, followed by all other branches ordered by the branches with the most recent commits first. +4. Optionally, use the search field on the top right. It provides a simple, case-insensitive, sub-string search on the branch name. It does not support any additional query syntax. + ![The branches page for the Atom repository](/assets/images/help/branches/branches-overview-atom.png) ### Further reading diff --git a/content/github/administering-a-repository/viewing-deployment-activity-for-your-repository.md b/content/github/administering-a-repository/viewing-deployment-activity-for-your-repository.md index 9c6758f8c1..d551f5f755 100644 --- a/content/github/administering-a-repository/viewing-deployment-activity-for-your-repository.md +++ b/content/github/administering-a-repository/viewing-deployment-activity-for-your-repository.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- {% note %} diff --git a/content/github/administering-a-repository/viewing-your-repositorys-releases-and-tags.md b/content/github/administering-a-repository/viewing-your-repositorys-releases-and-tags.md index e11d111666..bc64774ab1 100644 --- a/content/github/administering-a-repository/viewing-your-repositorys-releases-and-tags.md +++ b/content/github/administering-a-repository/viewing-your-repositorys-releases-and-tags.md @@ -9,6 +9,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- {% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.19" %} diff --git a/content/github/authenticating-to-github/about-anonymized-image-urls.md b/content/github/authenticating-to-github/about-anonymized-image-urls.md index d36acb1003..f1f469fcb0 100644 --- a/content/github/authenticating-to-github/about-anonymized-image-urls.md +++ b/content/github/authenticating-to-github/about-anonymized-image-urls.md @@ -6,6 +6,9 @@ redirect_from: - /articles/about-anonymized-image-urls versions: free-pro-team: '*' +topics: + - identity + - access management --- To host your images, {% data variables.product.product_name %} uses the [open-source project Camo](https://github.com/atmos/camo). Camo generates an anonymous URL proxy for each image which hides your browser details and related information from other users. The URL starts `https://.githubusercontent.com/`, with different subdomains depending on how you uploaded the image. diff --git a/content/github/authenticating-to-github/about-authentication-to-github.md b/content/github/authenticating-to-github/about-authentication-to-github.md index c7d1f21a1a..1f3dad6026 100644 --- a/content/github/authenticating-to-github/about-authentication-to-github.md +++ b/content/github/authenticating-to-github/about-authentication-to-github.md @@ -5,6 +5,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - identity + - access management --- ### About authentication to {% data variables.product.prodname_dotcom %} diff --git a/content/github/authenticating-to-github/about-authentication-with-saml-single-sign-on.md b/content/github/authenticating-to-github/about-authentication-with-saml-single-sign-on.md index bb6b3e7304..c7f6ff6491 100644 --- a/content/github/authenticating-to-github/about-authentication-with-saml-single-sign-on.md +++ b/content/github/authenticating-to-github/about-authentication-with-saml-single-sign-on.md @@ -7,6 +7,8 @@ redirect_from: versions: free-pro-team: '*' github-ae: '*' +topics: + - sso --- ### About authentication with SAML SSO diff --git a/content/github/authenticating-to-github/about-commit-signature-verification.md b/content/github/authenticating-to-github/about-commit-signature-verification.md index 4c51889491..77a2b528ca 100644 --- a/content/github/authenticating-to-github/about-commit-signature-verification.md +++ b/content/github/authenticating-to-github/about-commit-signature-verification.md @@ -9,6 +9,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - identity + - access management --- ### About commit signature verification diff --git a/content/github/authenticating-to-github/about-githubs-ip-addresses.md b/content/github/authenticating-to-github/about-githubs-ip-addresses.md index 0ffa4bb10a..1718f9d21c 100644 --- a/content/github/authenticating-to-github/about-githubs-ip-addresses.md +++ b/content/github/authenticating-to-github/about-githubs-ip-addresses.md @@ -10,6 +10,9 @@ redirect_from: - /articles/about-githubs-ip-addresses versions: free-pro-team: '*' +topics: + - identity + - access management --- You can retrieve a list of {% data variables.product.prodname_dotcom %}'s IP addresses from the [meta](https://api.github.com/meta) API endpoint. For more information, see "[Meta](/rest/reference/meta)." diff --git a/content/github/authenticating-to-github/about-ssh.md b/content/github/authenticating-to-github/about-ssh.md index e6d03cbea3..2eaef9677c 100644 --- a/content/github/authenticating-to-github/about-ssh.md +++ b/content/github/authenticating-to-github/about-ssh.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - ssh --- When you set up SSH, you'll [generate an SSH key and add it to the ssh-agent](/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent) and then [add the key to your {% data variables.product.product_name %} account](/articles/adding-a-new-ssh-key-to-your-github-account). Adding the SSH key to the ssh-agent ensures that your SSH key has an extra layer of security through the use of a passphrase. For more information, see "[Working with SSH key passphrases](/articles/working-with-ssh-key-passphrases)." diff --git a/content/github/authenticating-to-github/about-two-factor-authentication.md b/content/github/authenticating-to-github/about-two-factor-authentication.md index 478630fc95..fec3b375c2 100644 --- a/content/github/authenticating-to-github/about-two-factor-authentication.md +++ b/content/github/authenticating-to-github/about-two-factor-authentication.md @@ -6,6 +6,8 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '*' +topics: + - 2fa --- For {% data variables.product.product_name %}, the second form of authentication is a code that's generated by an application on your mobile device{% if currentVersion == "free-pro-team@latest" %} or sent as a text message (SMS){% endif %}. After you enable 2FA, {% data variables.product.product_name %} generates an authentication code any time someone attempts to sign into your {% data variables.product.product_name %} account. The only way someone can sign into your account is if they know both your password and have access to the authentication code on your phone. diff --git a/content/github/authenticating-to-github/accessing-github-using-two-factor-authentication.md b/content/github/authenticating-to-github/accessing-github-using-two-factor-authentication.md index 4310af7d71..0b15769178 100644 --- a/content/github/authenticating-to-github/accessing-github-using-two-factor-authentication.md +++ b/content/github/authenticating-to-github/accessing-github-using-two-factor-authentication.md @@ -9,6 +9,8 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '*' +topics: + - 2fa --- With two-factor authentication enabled, you'll need to provide an authentication code when accessing {% data variables.product.product_name %} through your browser. If you access {% data variables.product.product_name %} using other methods, such as the API or the command line, you'll need to use an alternative form of authentication. For more information, see "[About authentication to {% data variables.product.prodname_dotcom %}](/github/authenticating-to-github/about-authentication-to-github)." diff --git a/content/github/authenticating-to-github/adding-a-new-gpg-key-to-your-github-account.md b/content/github/authenticating-to-github/adding-a-new-gpg-key-to-your-github-account.md index e8c4ba5e23..6df4b4b162 100644 --- a/content/github/authenticating-to-github/adding-a-new-gpg-key-to-your-github-account.md +++ b/content/github/authenticating-to-github/adding-a-new-gpg-key-to-your-github-account.md @@ -7,6 +7,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - identity + - access management --- Before adding a new GPG key to your {% data variables.product.product_name %} account, you should have: diff --git a/content/github/authenticating-to-github/adding-a-new-ssh-key-to-your-github-account.md b/content/github/authenticating-to-github/adding-a-new-ssh-key-to-your-github-account.md index 668b00c955..0638c2432f 100644 --- a/content/github/authenticating-to-github/adding-a-new-ssh-key-to-your-github-account.md +++ b/content/github/authenticating-to-github/adding-a-new-ssh-key-to-your-github-account.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - ssh --- Before adding a new SSH key to your {% data variables.product.product_name %} account, you should have: diff --git a/content/github/authenticating-to-github/associating-an-email-with-your-gpg-key.md b/content/github/authenticating-to-github/associating-an-email-with-your-gpg-key.md index 79bf3d46bf..895402d671 100644 --- a/content/github/authenticating-to-github/associating-an-email-with-your-gpg-key.md +++ b/content/github/authenticating-to-github/associating-an-email-with-your-gpg-key.md @@ -7,6 +7,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - identity + - access management --- {% note %} diff --git a/content/github/authenticating-to-github/authenticating-with-saml-single-sign-on.md b/content/github/authenticating-to-github/authenticating-with-saml-single-sign-on.md index e1cc609301..bd089ba9e7 100644 --- a/content/github/authenticating-to-github/authenticating-with-saml-single-sign-on.md +++ b/content/github/authenticating-to-github/authenticating-with-saml-single-sign-on.md @@ -9,5 +9,7 @@ redirect_from: versions: free-pro-team: '*' github-ae: '*' +topics: + - sso --- diff --git a/content/github/authenticating-to-github/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on.md b/content/github/authenticating-to-github/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on.md index 6b52b66658..f7d73042d1 100644 --- a/content/github/authenticating-to-github/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on.md +++ b/content/github/authenticating-to-github/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on.md @@ -6,6 +6,8 @@ redirect_from: - /articles/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on versions: free-pro-team: '*' +topics: + - sso --- You can authorize an existing personal access token, or [create a new personal access token](/github/authenticating-to-github/creating-a-personal-access-token) and then authorize it. diff --git a/content/github/authenticating-to-github/authorizing-an-ssh-key-for-use-with-saml-single-sign-on.md b/content/github/authenticating-to-github/authorizing-an-ssh-key-for-use-with-saml-single-sign-on.md index ee2b69a4b7..dd401111ea 100644 --- a/content/github/authenticating-to-github/authorizing-an-ssh-key-for-use-with-saml-single-sign-on.md +++ b/content/github/authenticating-to-github/authorizing-an-ssh-key-for-use-with-saml-single-sign-on.md @@ -6,6 +6,8 @@ redirect_from: - /articles/authorizing-an-ssh-key-for-use-with-saml-single-sign-on versions: free-pro-team: '*' +topics: + - sso --- You can authorize an existing SSH key, or create a new SSH key and then authorize it. For more information about creating a new SSH key, see "[Generating a new SSH key and adding it to the ssh-agent](/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent)." diff --git a/content/github/authenticating-to-github/authorizing-oauth-apps.md b/content/github/authenticating-to-github/authorizing-oauth-apps.md index dca4ac4c69..6c32b4a444 100644 --- a/content/github/authenticating-to-github/authorizing-oauth-apps.md +++ b/content/github/authenticating-to-github/authorizing-oauth-apps.md @@ -7,6 +7,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - identity + - access management --- When an {% data variables.product.prodname_oauth_app %} wants to identify you by your {% data variables.product.product_name %} account, you'll see a page with the app's developer contact information and a list of the specific data that's being requested. diff --git a/content/github/authenticating-to-github/changing-two-factor-authentication-delivery-methods-for-your-mobile-device.md b/content/github/authenticating-to-github/changing-two-factor-authentication-delivery-methods-for-your-mobile-device.md index c2889d5547..b57c38d604 100644 --- a/content/github/authenticating-to-github/changing-two-factor-authentication-delivery-methods-for-your-mobile-device.md +++ b/content/github/authenticating-to-github/changing-two-factor-authentication-delivery-methods-for-your-mobile-device.md @@ -6,6 +6,8 @@ redirect_from: - /articles/changing-two-factor-authentication-delivery-methods-for-your-mobile-device versions: free-pro-team: '*' +topics: + - 2fa --- {% note %} diff --git a/content/github/authenticating-to-github/checking-for-existing-gpg-keys.md b/content/github/authenticating-to-github/checking-for-existing-gpg-keys.md index 1ffc22df36..0abd12c197 100644 --- a/content/github/authenticating-to-github/checking-for-existing-gpg-keys.md +++ b/content/github/authenticating-to-github/checking-for-existing-gpg-keys.md @@ -7,6 +7,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - identity + - access management --- {% data reusables.gpg.supported-gpg-key-algorithms %} diff --git a/content/github/authenticating-to-github/checking-for-existing-ssh-keys.md b/content/github/authenticating-to-github/checking-for-existing-ssh-keys.md index 9a95a12d6b..1131f1f04e 100644 --- a/content/github/authenticating-to-github/checking-for-existing-ssh-keys.md +++ b/content/github/authenticating-to-github/checking-for-existing-ssh-keys.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - ssh --- {% data reusables.ssh.dsa-support %} diff --git a/content/github/authenticating-to-github/checking-your-commit-and-tag-signature-verification-status.md b/content/github/authenticating-to-github/checking-your-commit-and-tag-signature-verification-status.md index 2e7403a50f..36d736bca8 100644 --- a/content/github/authenticating-to-github/checking-your-commit-and-tag-signature-verification-status.md +++ b/content/github/authenticating-to-github/checking-your-commit-and-tag-signature-verification-status.md @@ -8,6 +8,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - identity + - access management --- ### Checking your commit signature verification status diff --git a/content/github/authenticating-to-github/configuring-two-factor-authentication-recovery-methods.md b/content/github/authenticating-to-github/configuring-two-factor-authentication-recovery-methods.md index 937293a143..ac37753066 100644 --- a/content/github/authenticating-to-github/configuring-two-factor-authentication-recovery-methods.md +++ b/content/github/authenticating-to-github/configuring-two-factor-authentication-recovery-methods.md @@ -11,6 +11,8 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '*' +topics: + - 2fa --- In addition to securely storing your two-factor authentication recovery codes, we strongly recommend configuring one or more additional recovery methods. diff --git a/content/github/authenticating-to-github/configuring-two-factor-authentication.md b/content/github/authenticating-to-github/configuring-two-factor-authentication.md index bc352f983e..3066f68814 100644 --- a/content/github/authenticating-to-github/configuring-two-factor-authentication.md +++ b/content/github/authenticating-to-github/configuring-two-factor-authentication.md @@ -9,6 +9,8 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '*' +topics: + - 2fa --- You can configure two-factor authentication using a mobile app{% if currentVersion == "free-pro-team@latest" %} or via text message{% endif %}. You can also add a security key. diff --git a/content/github/authenticating-to-github/connecting-to-github-with-ssh.md b/content/github/authenticating-to-github/connecting-to-github-with-ssh.md index 2f82f7db52..09ce32816e 100644 --- a/content/github/authenticating-to-github/connecting-to-github-with-ssh.md +++ b/content/github/authenticating-to-github/connecting-to-github-with-ssh.md @@ -15,5 +15,7 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - ssh --- diff --git a/content/github/authenticating-to-github/connecting-with-third-party-applications.md b/content/github/authenticating-to-github/connecting-with-third-party-applications.md index 5af7c4e731..5ffb4b5bf2 100644 --- a/content/github/authenticating-to-github/connecting-with-third-party-applications.md +++ b/content/github/authenticating-to-github/connecting-with-third-party-applications.md @@ -7,6 +7,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - identity + - access management --- When a third-party application wants to identify you by your {% data variables.product.product_name %} login, you'll see a page with the developer contact information and a list of the specific data that's being requested. @@ -55,13 +58,13 @@ There are several types of data that applications can request. | Type of data | Description | | --- | --- | | Commit status | You can grant access for a third-party application to report your commit status. Commit status access allows applications to determine if a build is a successful against a specific commit. Applications won't have access to your code, but they can read and write status information against a specific commit. | -| Deployments | Deployment status access allows applications to determine if a deployment is successful against a specific commit for public and private repositories. Applications won't have access to your code. | -| Gists | [Gist](https://gist.github.com) access allows applications to read or write to both your public and secret Gists. | +| Deployments | Deployment status access allows applications to determine if a deployment is successful against a specific commit for a repository. Applications won't have access to your code. | +| Gists | [Gist](https://gist.github.com) access allows applications to read or write to {% if currentVersion != "github-ae@latest" %}both your public and{% else %}both your internal and{% endif %} secret Gists. | | Hooks | [Webhooks](/webhooks) access allows applications to read or write hook configurations on repositories you manage. | | Notifications | Notification access allows applications to read your {% data variables.product.product_name %} notifications, such as comments on issues and pull requests. However, applications remain unable to access anything in your repositories. | | Organizations and teams | Organization and teams access allows apps to access and manage organization and team membership. | | Personal user data | User data includes information found in your user profile, like your name, e-mail address, and location. | -| Repositories | Repository information includes the names of contributors, the branches you've created, and the actual files within your repository. Applications can request access for either public or private repositories on a user-wide level. | +| Repositories | Repository information includes the names of contributors, the branches you've created, and the actual files within your repository. Applications can request access for either {% if currentVersion != "github-ae@latest" %}public{% else %}internal{% endif %} or private repositories on a user-wide level. | | Repository delete | Applications can request to delete repositories that you administer, but they won't have access to your code. | ### Requesting updated permissions diff --git a/content/github/authenticating-to-github/countries-where-sms-authentication-is-supported.md b/content/github/authenticating-to-github/countries-where-sms-authentication-is-supported.md index aa7dc1332f..95d39a899a 100644 --- a/content/github/authenticating-to-github/countries-where-sms-authentication-is-supported.md +++ b/content/github/authenticating-to-github/countries-where-sms-authentication-is-supported.md @@ -5,6 +5,8 @@ redirect_from: - /articles/countries-where-sms-authentication-is-supported versions: free-pro-team: '*' +topics: + - 2fa --- If we don't support two-factor authentication via text message for your country of residence, you can set up authentication via a TOTP mobile application. For more information, see "[Configuring two-factor authentication](/articles/configuring-two-factor-authentication)." diff --git a/content/github/authenticating-to-github/creating-a-personal-access-token.md b/content/github/authenticating-to-github/creating-a-personal-access-token.md index a61660cea6..2340dc5433 100644 --- a/content/github/authenticating-to-github/creating-a-personal-access-token.md +++ b/content/github/authenticating-to-github/creating-a-personal-access-token.md @@ -10,6 +10,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - identity + - access management --- Personal access tokens (PATs) are an alternative to using passwords for authentication to {% data variables.product.product_name %} when using the [GitHub API](/rest/overview/other-authentication-methods#via-oauth-and-personal-access-tokens) or the [command line](#using-a-token-on-the-command-line). @@ -29,7 +32,11 @@ Personal access tokens (PATs) are an alternative to using passwords for authenti 5. Give your token a descriptive name. ![Token description field](/assets/images/help/settings/token_description.png) 6. Select the scopes, or permissions, you'd like to grant this token. To use your token to access repositories from the command line, select **repo**. + {% if currentVersion == "free-pro-team@latest" or enterpriseServerVersions contains currentVersion %} ![Selecting token scopes](/assets/images/help/settings/token_scopes.gif) + {% elsif currentVersion == "github-ae@latest" %} + ![Selecting token scopes](/assets/images/enterprise/github-ae/settings/access-token-scopes-for-ghae.png) + {% endif %} 7. Click **Generate token**. ![Generate token button](/assets/images/help/settings/generate_token.png) 8. Click {% octicon "clippy" aria-label="The copy to clipboard icon" %} to copy the token to your clipboard. For security reasons, after you navigate off the page, you will not be able to see the token again.{% if currentVersion == "free-pro-team@latest" %} diff --git a/content/github/authenticating-to-github/creating-a-strong-password.md b/content/github/authenticating-to-github/creating-a-strong-password.md index db0cefe674..db2e968ad7 100644 --- a/content/github/authenticating-to-github/creating-a-strong-password.md +++ b/content/github/authenticating-to-github/creating-a-strong-password.md @@ -7,14 +7,17 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '*' +topics: + - identity + - access management --- You must choose or generate a password for your {% data variables.product.product_name %} account that is at least: - Eight characters long, if it includes a number and a lowercase letter, or -- 16 characters long with any combination of characters +- 15 characters long with any combination of characters To keep your account secure, we recommend you follow these best practices: -- Use a password manager, such as [LastPass](https://lastpass.com/) or [1Password](https://1password.com/), to generate a password more than 16 characters. +- Use a password manager, such as [LastPass](https://lastpass.com/) or [1Password](https://1password.com/), to generate a password of at least 15 characters. - Generate a unique password for {% data variables.product.product_name %}. If you use your {% data variables.product.product_name %} password elsewhere and that service is compromised, then attackers or other malicious actors could use that information to access your {% data variables.product.product_name %} account. - Configure two-factor authentication for your personal account. For more information, see "[About two-factor authentication](/articles/about-two-factor-authentication)." - Never share your password, even with a potential collaborator. Each person should use their own personal account on {% data variables.product.product_name %}. For more information on ways to collaborate, see: "[Inviting collaborators to a personal repository](/articles/inviting-collaborators-to-a-personal-repository)," "[About collaborative development models](/articles/about-collaborative-development-models/)," or "[Collaborating with groups in organizations](/articles/collaborating-with-groups-in-organizations/)." diff --git a/content/github/authenticating-to-github/deleted-or-missing-ssh-keys.md b/content/github/authenticating-to-github/deleted-or-missing-ssh-keys.md index a815793bf9..2d62415729 100644 --- a/content/github/authenticating-to-github/deleted-or-missing-ssh-keys.md +++ b/content/github/authenticating-to-github/deleted-or-missing-ssh-keys.md @@ -5,6 +5,8 @@ redirect_from: - /articles/deleted-or-missing-ssh-keys versions: free-pro-team: '*' +topics: + - ssh --- {% data variables.product.prodname_dotcom %} automatically deletes inactive SSH keys to help keep accounts safe, such as after someone leaves a job or loses a computer. diff --git a/content/github/authenticating-to-github/disabling-two-factor-authentication-for-your-personal-account.md b/content/github/authenticating-to-github/disabling-two-factor-authentication-for-your-personal-account.md index 6364fe6238..334725eabb 100644 --- a/content/github/authenticating-to-github/disabling-two-factor-authentication-for-your-personal-account.md +++ b/content/github/authenticating-to-github/disabling-two-factor-authentication-for-your-personal-account.md @@ -6,6 +6,8 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '*' +topics: + - 2fa --- We strongly recommend using two-factor authentication to secure your account. If you need to disable 2FA, we recommend re-enabling it as soon as possible. diff --git a/content/github/authenticating-to-github/error-agent-admitted-failure-to-sign.md b/content/github/authenticating-to-github/error-agent-admitted-failure-to-sign.md index ad63b888c3..0a0cf75aaf 100644 --- a/content/github/authenticating-to-github/error-agent-admitted-failure-to-sign.md +++ b/content/github/authenticating-to-github/error-agent-admitted-failure-to-sign.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - ssh --- When trying to SSH into {% data variables.product.product_location %} on a Linux computer, you may see the following message in your terminal: diff --git a/content/github/authenticating-to-github/error-bad-file-number.md b/content/github/authenticating-to-github/error-bad-file-number.md index af70808b43..c652063f74 100644 --- a/content/github/authenticating-to-github/error-bad-file-number.md +++ b/content/github/authenticating-to-github/error-bad-file-number.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - ssh --- When running remote Git commands or SSH, your connection might time out: diff --git a/content/github/authenticating-to-github/error-key-already-in-use.md b/content/github/authenticating-to-github/error-key-already-in-use.md index 2e4c52a8bf..91003389a0 100644 --- a/content/github/authenticating-to-github/error-key-already-in-use.md +++ b/content/github/authenticating-to-github/error-key-already-in-use.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - ssh --- ### Finding where the key has been used diff --git a/content/github/authenticating-to-github/error-permission-denied-publickey.md b/content/github/authenticating-to-github/error-permission-denied-publickey.md index 6057153d6b..6c57fec292 100644 --- a/content/github/authenticating-to-github/error-permission-denied-publickey.md +++ b/content/github/authenticating-to-github/error-permission-denied-publickey.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - ssh --- ### Should the `sudo` command be used with Git? diff --git a/content/github/authenticating-to-github/error-permission-to-userrepo-denied-to-other-user.md b/content/github/authenticating-to-github/error-permission-to-userrepo-denied-to-other-user.md index f45e846a3e..51660edaec 100644 --- a/content/github/authenticating-to-github/error-permission-to-userrepo-denied-to-other-user.md +++ b/content/github/authenticating-to-github/error-permission-to-userrepo-denied-to-other-user.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - ssh --- To fix this, the owner of the repository (`user`) needs to add your account (`other-user`) as a collaborator on the repository or to a team that has write access to the repository. diff --git a/content/github/authenticating-to-github/error-permission-to-userrepo-denied-to-userother-repo.md b/content/github/authenticating-to-github/error-permission-to-userrepo-denied-to-userother-repo.md index dda09ea92a..818e7dc717 100644 --- a/content/github/authenticating-to-github/error-permission-to-userrepo-denied-to-userother-repo.md +++ b/content/github/authenticating-to-github/error-permission-to-userrepo-denied-to-userother-repo.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - ssh --- To fix this, remove the deploy key from the repository, and [add the key to your user account](/articles/adding-a-new-ssh-key-to-your-github-account) instead. diff --git a/content/github/authenticating-to-github/error-ssh-add-illegal-option----k.md b/content/github/authenticating-to-github/error-ssh-add-illegal-option----k.md index 3d9d3e3fad..9699bf3bc7 100644 --- a/content/github/authenticating-to-github/error-ssh-add-illegal-option----k.md +++ b/content/github/authenticating-to-github/error-ssh-add-illegal-option----k.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - ssh --- The `-K` option is in Apple's standard version of `ssh-add`, which stores the passphrase in your keychain for you when you add an ssh key to the ssh-agent. If you have installed a different version of `ssh-add`, it may lack support for `-K`. diff --git a/content/github/authenticating-to-github/error-ssl-certificate-problem-verify-that-the-ca-cert-is-ok.md b/content/github/authenticating-to-github/error-ssl-certificate-problem-verify-that-the-ca-cert-is-ok.md index 1c844c3838..1d0e213750 100644 --- a/content/github/authenticating-to-github/error-ssl-certificate-problem-verify-that-the-ca-cert-is-ok.md +++ b/content/github/authenticating-to-github/error-ssl-certificate-problem-verify-that-the-ca-cert-is-ok.md @@ -5,6 +5,8 @@ redirect_from: - /articles/error-ssl-certificate-problem-verify-that-the-ca-cert-is-ok versions: free-pro-team: '*' +topics: + - ssh --- The error you receive may look like the following: diff --git a/content/github/authenticating-to-github/error-were-doing-an-ssh-key-audit.md b/content/github/authenticating-to-github/error-were-doing-an-ssh-key-audit.md index 3ca153f2df..fadb01e5fd 100644 --- a/content/github/authenticating-to-github/error-were-doing-an-ssh-key-audit.md +++ b/content/github/authenticating-to-github/error-were-doing-an-ssh-key-audit.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - ssh --- When using an unverified key to perform Git operations, you will be prompted to perform an audit of your SSH keys. diff --git a/content/github/authenticating-to-github/generating-a-new-gpg-key.md b/content/github/authenticating-to-github/generating-a-new-gpg-key.md index b02d4f0cef..65069037b2 100644 --- a/content/github/authenticating-to-github/generating-a-new-gpg-key.md +++ b/content/github/authenticating-to-github/generating-a-new-gpg-key.md @@ -7,6 +7,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - identity + - access management --- {% data reusables.gpg.supported-gpg-key-algorithms %} diff --git a/content/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent.md b/content/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent.md index 020d609a12..93182ab506 100644 --- a/content/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent.md +++ b/content/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent.md @@ -9,6 +9,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - ssh --- If you don't already have an SSH key, you must [generate a new SSH key](#generating-a-new-ssh-key). If you're unsure whether you already have an SSH key, check for [existing keys](/articles/checking-for-existing-ssh-keys). diff --git a/content/github/authenticating-to-github/githubs-ssh-key-fingerprints.md b/content/github/authenticating-to-github/githubs-ssh-key-fingerprints.md index 309b4e69c1..6b47b5874f 100644 --- a/content/github/authenticating-to-github/githubs-ssh-key-fingerprints.md +++ b/content/github/authenticating-to-github/githubs-ssh-key-fingerprints.md @@ -7,6 +7,9 @@ redirect_from: - /articles/githubs-ssh-key-fingerprints versions: free-pro-team: '*' +topics: + - identity + - access management --- These are {% data variables.product.prodname_dotcom %}'s public key fingerprints: diff --git a/content/github/authenticating-to-github/index.md b/content/github/authenticating-to-github/index.md index 30e51c7087..d59e1b78c4 100644 --- a/content/github/authenticating-to-github/index.md +++ b/content/github/authenticating-to-github/index.md @@ -17,6 +17,12 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - 2fa + - identity + - access management + - usernames + - device verification --- diff --git a/content/github/authenticating-to-github/keeping-your-account-and-data-secure.md b/content/github/authenticating-to-github/keeping-your-account-and-data-secure.md index 183fecb7f3..f2cceaccef 100644 --- a/content/github/authenticating-to-github/keeping-your-account-and-data-secure.md +++ b/content/github/authenticating-to-github/keeping-your-account-and-data-secure.md @@ -8,5 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - identity + - access management --- diff --git a/content/github/authenticating-to-github/managing-commit-signature-verification.md b/content/github/authenticating-to-github/managing-commit-signature-verification.md index da61d71196..1402793ca0 100644 --- a/content/github/authenticating-to-github/managing-commit-signature-verification.md +++ b/content/github/authenticating-to-github/managing-commit-signature-verification.md @@ -10,5 +10,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - identity + - access management --- diff --git a/content/github/authenticating-to-github/preventing-unauthorized-access.md b/content/github/authenticating-to-github/preventing-unauthorized-access.md index 79c9518fac..80cf7fc056 100644 --- a/content/github/authenticating-to-github/preventing-unauthorized-access.md +++ b/content/github/authenticating-to-github/preventing-unauthorized-access.md @@ -6,6 +6,9 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '*' +topics: + - identity + - access management --- {% data variables.product.product_name %} requires a password to perform sensitive actions, such as adding new SSH keys, authorizing applications, or modifying team members. diff --git a/content/github/authenticating-to-github/recovering-your-account-if-you-lose-your-2fa-credentials.md b/content/github/authenticating-to-github/recovering-your-account-if-you-lose-your-2fa-credentials.md index e3259b0eff..f6fad1ddb2 100644 --- a/content/github/authenticating-to-github/recovering-your-account-if-you-lose-your-2fa-credentials.md +++ b/content/github/authenticating-to-github/recovering-your-account-if-you-lose-your-2fa-credentials.md @@ -8,6 +8,8 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '*' +topics: + - 2fa --- {% if currentVersion == "free-pro-team@latest" %} diff --git a/content/github/authenticating-to-github/recovering-your-ssh-key-passphrase.md b/content/github/authenticating-to-github/recovering-your-ssh-key-passphrase.md index fc251cc1e1..e5bc1c00c6 100644 --- a/content/github/authenticating-to-github/recovering-your-ssh-key-passphrase.md +++ b/content/github/authenticating-to-github/recovering-your-ssh-key-passphrase.md @@ -9,6 +9,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - ssh --- {% mac %} diff --git a/content/github/authenticating-to-github/removing-sensitive-data-from-a-repository.md b/content/github/authenticating-to-github/removing-sensitive-data-from-a-repository.md index 55bd3a3601..95e6b04666 100644 --- a/content/github/authenticating-to-github/removing-sensitive-data-from-a-repository.md +++ b/content/github/authenticating-to-github/removing-sensitive-data-from-a-repository.md @@ -10,6 +10,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - identity + - access management --- The `git filter-branch` command and the BFG Repo-Cleaner rewrite your repository's history, which changes the SHAs for existing commits that you alter and any dependent commits. Changed commit SHAs may affect open pull requests in your repository. We recommend merging or closing all open pull requests before removing files from your repository. diff --git a/content/github/authenticating-to-github/reviewing-your-authorized-applications-oauth.md b/content/github/authenticating-to-github/reviewing-your-authorized-applications-oauth.md index ce1fd85a57..81cd79e7ff 100644 --- a/content/github/authenticating-to-github/reviewing-your-authorized-applications-oauth.md +++ b/content/github/authenticating-to-github/reviewing-your-authorized-applications-oauth.md @@ -7,6 +7,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - identity + - access management --- {% data reusables.user_settings.access_settings %} diff --git a/content/github/authenticating-to-github/reviewing-your-authorized-integrations.md b/content/github/authenticating-to-github/reviewing-your-authorized-integrations.md index 6bbe5801e1..6423bac6f8 100644 --- a/content/github/authenticating-to-github/reviewing-your-authorized-integrations.md +++ b/content/github/authenticating-to-github/reviewing-your-authorized-integrations.md @@ -7,6 +7,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - identity + - access management --- ### Reviewing your authorized {% data variables.product.prodname_oauth_app %}s diff --git a/content/github/authenticating-to-github/reviewing-your-deploy-keys.md b/content/github/authenticating-to-github/reviewing-your-deploy-keys.md index 85eba969b9..f6b160dfd0 100644 --- a/content/github/authenticating-to-github/reviewing-your-deploy-keys.md +++ b/content/github/authenticating-to-github/reviewing-your-deploy-keys.md @@ -7,6 +7,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - identity + - access management --- {% data reusables.repositories.navigate-to-repo %} diff --git a/content/github/authenticating-to-github/reviewing-your-security-log.md b/content/github/authenticating-to-github/reviewing-your-security-log.md index 01aa0036e4..466c990e1c 100644 --- a/content/github/authenticating-to-github/reviewing-your-security-log.md +++ b/content/github/authenticating-to-github/reviewing-your-security-log.md @@ -8,6 +8,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - identity + - access management --- ### Accessing your security log diff --git a/content/github/authenticating-to-github/reviewing-your-ssh-keys.md b/content/github/authenticating-to-github/reviewing-your-ssh-keys.md index ba3e70593d..2aec1117d3 100644 --- a/content/github/authenticating-to-github/reviewing-your-ssh-keys.md +++ b/content/github/authenticating-to-github/reviewing-your-ssh-keys.md @@ -9,6 +9,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - identity + - access management --- You can delete unauthorized (or possibly compromised) SSH keys to ensure that an attacker no longer has access to your repositories. You can also approve existing SSH keys that are valid. diff --git a/content/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa.md b/content/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa.md index 597dc2ed96..5dc2e4fc18 100644 --- a/content/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa.md +++ b/content/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa.md @@ -9,5 +9,7 @@ mapTopic: true versions: free-pro-team: '*' enterprise-server: '*' +topics: + - 2fa --- diff --git a/content/github/authenticating-to-github/signing-commits.md b/content/github/authenticating-to-github/signing-commits.md index fe4fefa5cb..247301e527 100644 --- a/content/github/authenticating-to-github/signing-commits.md +++ b/content/github/authenticating-to-github/signing-commits.md @@ -9,6 +9,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - identity + - access management --- {% data reusables.gpg.desktop-support-for-commit-signing %} diff --git a/content/github/authenticating-to-github/signing-tags.md b/content/github/authenticating-to-github/signing-tags.md index 7924021445..08026ad479 100644 --- a/content/github/authenticating-to-github/signing-tags.md +++ b/content/github/authenticating-to-github/signing-tags.md @@ -8,6 +8,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - identity + - access management --- {% data reusables.gpg.desktop-support-for-commit-signing %} diff --git a/content/github/authenticating-to-github/sudo-mode.md b/content/github/authenticating-to-github/sudo-mode.md index 065f2c0582..a20303dd82 100644 --- a/content/github/authenticating-to-github/sudo-mode.md +++ b/content/github/authenticating-to-github/sudo-mode.md @@ -6,6 +6,9 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '*' +topics: + - identity + - access management --- After you've performed a sudo-protected action, you'll only be asked to re-authenticate again after a few hours of inactivity. Every sudo-protected action resets this timer. diff --git a/content/github/authenticating-to-github/telling-git-about-your-signing-key.md b/content/github/authenticating-to-github/telling-git-about-your-signing-key.md index 70780cac45..5fab6b7ab9 100644 --- a/content/github/authenticating-to-github/telling-git-about-your-signing-key.md +++ b/content/github/authenticating-to-github/telling-git-about-your-signing-key.md @@ -1,6 +1,6 @@ --- title: Telling Git about your signing key -intro: "To sign commits locally, you need to inform Git that there's a GPG or X.509 key you'd like to use." +intro: 'To sign commits locally, you need to inform Git that there''s a GPG or X.509 key you''d like to use.' redirect_from: - /articles/telling-git-about-your-gpg-key/ - /articles/telling-git-about-your-signing-key @@ -8,6 +8,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - identity + - access management --- {% mac %} diff --git a/content/github/authenticating-to-github/testing-your-ssh-connection.md b/content/github/authenticating-to-github/testing-your-ssh-connection.md index 1413718434..167a477bb5 100644 --- a/content/github/authenticating-to-github/testing-your-ssh-connection.md +++ b/content/github/authenticating-to-github/testing-your-ssh-connection.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - ssh --- Before testing your SSH connection, you should have: diff --git a/content/github/authenticating-to-github/troubleshooting-commit-signature-verification.md b/content/github/authenticating-to-github/troubleshooting-commit-signature-verification.md index eaf728188e..ae4ef0099e 100644 --- a/content/github/authenticating-to-github/troubleshooting-commit-signature-verification.md +++ b/content/github/authenticating-to-github/troubleshooting-commit-signature-verification.md @@ -9,5 +9,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - identity + - access management --- diff --git a/content/github/authenticating-to-github/troubleshooting-ssh.md b/content/github/authenticating-to-github/troubleshooting-ssh.md index 6e0edc6822..a7d35a006e 100644 --- a/content/github/authenticating-to-github/troubleshooting-ssh.md +++ b/content/github/authenticating-to-github/troubleshooting-ssh.md @@ -8,5 +8,7 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - ssh --- diff --git a/content/github/authenticating-to-github/updating-an-expired-gpg-key.md b/content/github/authenticating-to-github/updating-an-expired-gpg-key.md index 15a8a860a3..0d76efd0fc 100644 --- a/content/github/authenticating-to-github/updating-an-expired-gpg-key.md +++ b/content/github/authenticating-to-github/updating-an-expired-gpg-key.md @@ -7,6 +7,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - identity + - access management --- If your key is expired, you must [update the expiration](https://www.gnupg.org/gph/en/manual/c235.html#AEN328), export the new key, delete the expired key in your GitHub account, and [upload the new key to GitHub](/articles/adding-a-new-gpg-key-to-your-github-account/). Your previous commits and tags will show as verified, as long as the key meets all other verification requirements. diff --git a/content/github/authenticating-to-github/updating-your-github-access-credentials.md b/content/github/authenticating-to-github/updating-your-github-access-credentials.md index 75214d3ae8..121deadaeb 100644 --- a/content/github/authenticating-to-github/updating-your-github-access-credentials.md +++ b/content/github/authenticating-to-github/updating-your-github-access-credentials.md @@ -9,6 +9,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - identity + - access management --- {% if currentVersion != "github-ae@latest" %} diff --git a/content/github/authenticating-to-github/using-a-verified-email-address-in-your-gpg-key.md b/content/github/authenticating-to-github/using-a-verified-email-address-in-your-gpg-key.md index e215b0d4b5..f072a89dab 100644 --- a/content/github/authenticating-to-github/using-a-verified-email-address-in-your-gpg-key.md +++ b/content/github/authenticating-to-github/using-a-verified-email-address-in-your-gpg-key.md @@ -7,6 +7,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - identity + - access management --- {% if currentVersion == "free-pro-team@latest" %} diff --git a/content/github/authenticating-to-github/using-ssh-over-the-https-port.md b/content/github/authenticating-to-github/using-ssh-over-the-https-port.md index 07b84a0897..05f7043e78 100644 --- a/content/github/authenticating-to-github/using-ssh-over-the-https-port.md +++ b/content/github/authenticating-to-github/using-ssh-over-the-https-port.md @@ -5,6 +5,8 @@ redirect_from: - /articles/using-ssh-over-the-https-port versions: free-pro-team: '*' +topics: + - ssh --- {% tip %} @@ -33,6 +35,7 @@ To set this in your ssh config, edit the file at `~/.ssh/config`, and add this s Host {% data variables.command_line.codeblock %} Hostname ssh.{% data variables.command_line.codeblock %} Port 443 + User git ``` You can test that this works by connecting once more to {% data variables.product.product_location %}: diff --git a/content/github/authenticating-to-github/viewing-and-managing-your-active-saml-sessions.md b/content/github/authenticating-to-github/viewing-and-managing-your-active-saml-sessions.md index 4b3d9b9288..ce7b47ed3b 100644 --- a/content/github/authenticating-to-github/viewing-and-managing-your-active-saml-sessions.md +++ b/content/github/authenticating-to-github/viewing-and-managing-your-active-saml-sessions.md @@ -5,6 +5,8 @@ redirect_from: - /articles/viewing-and-managing-your-active-saml-sessions versions: free-pro-team: '*' +topics: + - sso --- {% data reusables.user_settings.access_settings %} @@ -24,4 +26,4 @@ versions: ### Further reading -- "[About authentication with SAML SSO](/github/authenticating-to-github/about-authentication-with-saml-single-sign-on)" \ No newline at end of file +- "[About authentication with SAML SSO](/github/authenticating-to-github/about-authentication-with-saml-single-sign-on)" diff --git a/content/github/authenticating-to-github/working-with-ssh-key-passphrases.md b/content/github/authenticating-to-github/working-with-ssh-key-passphrases.md index 81917a1cc1..859778b9eb 100644 --- a/content/github/authenticating-to-github/working-with-ssh-key-passphrases.md +++ b/content/github/authenticating-to-github/working-with-ssh-key-passphrases.md @@ -9,6 +9,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - ssh --- With SSH keys, if someone gains access to your computer, they also gain access to every system that uses that key. To add an extra layer of security, you can add a passphrase to your SSH key. You can use `ssh-agent` to securely save your passphrase so you don't have to reenter it. diff --git a/content/github/building-a-strong-community/about-community-management-and-moderation.md b/content/github/building-a-strong-community/about-community-management-and-moderation.md index 1e693282d9..f4a26afaa9 100644 --- a/content/github/building-a-strong-community/about-community-management-and-moderation.md +++ b/content/github/building-a-strong-community/about-community-management-and-moderation.md @@ -3,6 +3,8 @@ title: About community management and moderation intro: '{% data variables.product.prodname_dotcom %} offers tools that help repository maintainers establish and enforce standards of behavior in their communities on {% data variables.product.prodname_dotcom_the_website %}.' versions: free-pro-team: '*' +topics: + - community --- ### About community management and moderation diff --git a/content/github/building-a-strong-community/about-community-profiles-for-public-repositories.md b/content/github/building-a-strong-community/about-community-profiles-for-public-repositories.md index 5e1f3a28ef..5876ae99d6 100644 --- a/content/github/building-a-strong-community/about-community-profiles-for-public-repositories.md +++ b/content/github/building-a-strong-community/about-community-profiles-for-public-repositories.md @@ -6,6 +6,8 @@ redirect_from: - /articles/about-community-profiles-for-public-repositories versions: free-pro-team: '*' +topics: + - community --- The community profile checklist checks to see if a project includes recommended community health files, such as README, CODE_OF_CONDUCT, LICENSE, or CONTRIBUTING, in a supported location. For more information, see "[Accessing a project's community profile](/articles/accessing-a-project-s-community-profile)." diff --git a/content/github/building-a-strong-community/about-issue-and-pull-request-templates.md b/content/github/building-a-strong-community/about-issue-and-pull-request-templates.md index 8d8c0a7b0e..7f3ecabf3e 100644 --- a/content/github/building-a-strong-community/about-issue-and-pull-request-templates.md +++ b/content/github/building-a-strong-community/about-issue-and-pull-request-templates.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - community --- After you create issue and pull request templates in your repository, contributors can use the templates to open issues or describe the proposed changes in their pull requests according to the repository's contributing guidelines. For more information about adding contributing guidelines to a repository, see "[Setting guidelines for repository contributors](/articles/setting-guidelines-for-repository-contributors)." diff --git a/content/github/building-a-strong-community/about-wikis.md b/content/github/building-a-strong-community/about-wikis.md index 6e0beec462..39ebce9237 100644 --- a/content/github/building-a-strong-community/about-wikis.md +++ b/content/github/building-a-strong-community/about-wikis.md @@ -9,6 +9,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - community --- Every {% data variables.product.product_name %} repository comes equipped with a section for hosting documentation, called a wiki. You can use your repository's wiki to share long-form content about your project, such as how to use it, how you designed it, or its core principles. A README file quickly tells what your project can do, while you can use a wiki to provide additional documentation. For more information, see "[About READMEs](/articles/about-readmes)." diff --git a/content/github/building-a-strong-community/accessing-a-projects-community-profile.md b/content/github/building-a-strong-community/accessing-a-projects-community-profile.md index d145d7dd83..2b20b15381 100644 --- a/content/github/building-a-strong-community/accessing-a-projects-community-profile.md +++ b/content/github/building-a-strong-community/accessing-a-projects-community-profile.md @@ -6,6 +6,8 @@ redirect_from: - /articles/accessing-a-projects-community-profile versions: free-pro-team: '*' +topics: + - community --- {% data reusables.repositories.navigate-to-repo %} diff --git a/content/github/building-a-strong-community/adding-a-code-of-conduct-to-your-project.md b/content/github/building-a-strong-community/adding-a-code-of-conduct-to-your-project.md index aa7d99e071..c83fcd6804 100644 --- a/content/github/building-a-strong-community/adding-a-code-of-conduct-to-your-project.md +++ b/content/github/building-a-strong-community/adding-a-code-of-conduct-to-your-project.md @@ -5,6 +5,8 @@ redirect_from: - /articles/adding-a-code-of-conduct-to-your-project versions: free-pro-team: '*' +topics: + - community --- A *code of conduct* defines standards for how to engage in a community. It signals an inclusive environment that respects all contributions. It also outlines procedures for addressing problems between members of your project's community. For more information on why a code of conduct defines standards and expectations for how to engage in a community, see the [Open Source Guide](https://opensource.guide/code-of-conduct/). diff --git a/content/github/building-a-strong-community/adding-a-license-to-a-repository.md b/content/github/building-a-strong-community/adding-a-license-to-a-repository.md index 05d1c89413..b69cd607cd 100644 --- a/content/github/building-a-strong-community/adding-a-license-to-a-repository.md +++ b/content/github/building-a-strong-community/adding-a-license-to-a-repository.md @@ -6,6 +6,8 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '*' +topics: + - community --- If you include a detectable license in your repository, people who visit your repository will see it at the top of the repository page. To read the entire license file, click the license name. diff --git a/content/github/building-a-strong-community/adding-or-editing-wiki-pages.md b/content/github/building-a-strong-community/adding-or-editing-wiki-pages.md index 62ae605146..738e36f1ac 100644 --- a/content/github/building-a-strong-community/adding-or-editing-wiki-pages.md +++ b/content/github/building-a-strong-community/adding-or-editing-wiki-pages.md @@ -12,6 +12,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - community --- ### Adding wiki pages diff --git a/content/github/building-a-strong-community/adding-support-resources-to-your-project.md b/content/github/building-a-strong-community/adding-support-resources-to-your-project.md index 7fb6d57013..c16e886001 100644 --- a/content/github/building-a-strong-community/adding-support-resources-to-your-project.md +++ b/content/github/building-a-strong-community/adding-support-resources-to-your-project.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - community --- To direct people to specific support resources, you can add a SUPPORT file to your repository's root, `docs`, or `.github` folder. When someone creates an issue in your repository, they will see a link to your project's SUPPORT file. diff --git a/content/github/building-a-strong-community/blocking-a-user-from-your-organization.md b/content/github/building-a-strong-community/blocking-a-user-from-your-organization.md index 855f81f777..7a4a51f999 100644 --- a/content/github/building-a-strong-community/blocking-a-user-from-your-organization.md +++ b/content/github/building-a-strong-community/blocking-a-user-from-your-organization.md @@ -5,6 +5,8 @@ redirect_from: - /articles/blocking-a-user-from-your-organization versions: free-pro-team: '*' +topics: + - community --- You can block a user from within your organization's settings or from a specific comment made by the user. When you block a user in a comment, you can choose to send the user a notification explaining that they were blocked and why. Otherwise, the user is not directly notified that you've blocked them. Blocked users can still delete their existing content. diff --git a/content/github/building-a-strong-community/blocking-a-user-from-your-personal-account.md b/content/github/building-a-strong-community/blocking-a-user-from-your-personal-account.md index 77ef77338a..c2dc55ccef 100644 --- a/content/github/building-a-strong-community/blocking-a-user-from-your-personal-account.md +++ b/content/github/building-a-strong-community/blocking-a-user-from-your-personal-account.md @@ -5,6 +5,8 @@ redirect_from: - /articles/blocking-a-user-from-your-personal-account versions: free-pro-team: '*' +topics: + - community --- ### About blocking users diff --git a/content/github/building-a-strong-community/changing-access-permissions-for-wikis.md b/content/github/building-a-strong-community/changing-access-permissions-for-wikis.md index 3cd1846dba..f8cc461171 100644 --- a/content/github/building-a-strong-community/changing-access-permissions-for-wikis.md +++ b/content/github/building-a-strong-community/changing-access-permissions-for-wikis.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - community --- {% data reusables.repositories.navigate-to-repo %} diff --git a/content/github/building-a-strong-community/configuring-issue-templates-for-your-repository.md b/content/github/building-a-strong-community/configuring-issue-templates-for-your-repository.md index 13df72ab27..d8686332e6 100644 --- a/content/github/building-a-strong-community/configuring-issue-templates-for-your-repository.md +++ b/content/github/building-a-strong-community/configuring-issue-templates-for-your-repository.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - community --- {% if currentVersion == "free-pro-team@latest" or enterpriseServerVersions contains currentVersion %} diff --git a/content/github/building-a-strong-community/creating-a-default-community-health-file.md b/content/github/building-a-strong-community/creating-a-default-community-health-file.md index c4157ac34c..373b288d0e 100644 --- a/content/github/building-a-strong-community/creating-a-default-community-health-file.md +++ b/content/github/building-a-strong-community/creating-a-default-community-health-file.md @@ -7,6 +7,8 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '*' +topics: + - community --- ### About default community health files diff --git a/content/github/building-a-strong-community/creating-a-footer-or-sidebar-for-your-wiki.md b/content/github/building-a-strong-community/creating-a-footer-or-sidebar-for-your-wiki.md index 5e725a84aa..81a9895472 100644 --- a/content/github/building-a-strong-community/creating-a-footer-or-sidebar-for-your-wiki.md +++ b/content/github/building-a-strong-community/creating-a-footer-or-sidebar-for-your-wiki.md @@ -10,6 +10,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - community --- ### Creating a footer diff --git a/content/github/building-a-strong-community/creating-a-pull-request-template-for-your-repository.md b/content/github/building-a-strong-community/creating-a-pull-request-template-for-your-repository.md index 29ff888262..a0098f3058 100644 --- a/content/github/building-a-strong-community/creating-a-pull-request-template-for-your-repository.md +++ b/content/github/building-a-strong-community/creating-a-pull-request-template-for-your-repository.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - community --- For more information, see "[About issue and pull request templates](/articles/about-issue-and-pull-request-templates)." diff --git a/content/github/building-a-strong-community/disabling-wikis.md b/content/github/building-a-strong-community/disabling-wikis.md index 1dc9587157..400b502f0e 100644 --- a/content/github/building-a-strong-community/disabling-wikis.md +++ b/content/github/building-a-strong-community/disabling-wikis.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - community --- When you turn off a wiki, the content is hidden, but not erased. If you choose to re-enable wikis later, your previous pages will be restored. diff --git a/content/github/building-a-strong-community/documenting-your-project-with-wikis.md b/content/github/building-a-strong-community/documenting-your-project-with-wikis.md index db5793db24..b653151038 100644 --- a/content/github/building-a-strong-community/documenting-your-project-with-wikis.md +++ b/content/github/building-a-strong-community/documenting-your-project-with-wikis.md @@ -11,5 +11,7 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - community --- diff --git a/content/github/building-a-strong-community/editing-wiki-content.md b/content/github/building-a-strong-community/editing-wiki-content.md index d592597dd6..57e1e83f5e 100644 --- a/content/github/building-a-strong-community/editing-wiki-content.md +++ b/content/github/building-a-strong-community/editing-wiki-content.md @@ -15,6 +15,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - community --- ### Adding links diff --git a/content/github/building-a-strong-community/encouraging-helpful-contributions-to-your-project-with-labels.md b/content/github/building-a-strong-community/encouraging-helpful-contributions-to-your-project-with-labels.md index 95c92f2ede..54e3f5c09a 100644 --- a/content/github/building-a-strong-community/encouraging-helpful-contributions-to-your-project-with-labels.md +++ b/content/github/building-a-strong-community/encouraging-helpful-contributions-to-your-project-with-labels.md @@ -6,6 +6,8 @@ redirect_from: - /articles/helping-new-contributors-find-your-project-with-labels versions: free-pro-team: '*' +topics: + - community --- You can apply the `good first issue` label to issues in your public repository so that people can find them when searching by labels. For more information about searching by labels, see "[Searching issues and pull requests](/articles/searching-issues-and-pull-requests/#search-by-label)." diff --git a/content/github/building-a-strong-community/index.md b/content/github/building-a-strong-community/index.md index 70d3a13506..96db2f1924 100644 --- a/content/github/building-a-strong-community/index.md +++ b/content/github/building-a-strong-community/index.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - community --- @@ -52,8 +54,3 @@ versions: {% link_in_list /viewing-a-wikis-history-of-changes %} {% link_in_list /changing-access-permissions-for-wikis %} {% link_in_list /disabling-wikis %} -{% topic_link_in_list /collaborating-with-your-team %} - {% link_in_list /about-team-discussions %} - {% link_in_list /creating-a-team-discussion %} - {% link_in_list /editing-or-deleting-a-team-discussion %} - {% link_in_list /pinning-a-team-discussion %} diff --git a/content/github/building-a-strong-community/limiting-interactions-for-your-user-account.md b/content/github/building-a-strong-community/limiting-interactions-for-your-user-account.md index 6c01ed2e08..b04377b01c 100644 --- a/content/github/building-a-strong-community/limiting-interactions-for-your-user-account.md +++ b/content/github/building-a-strong-community/limiting-interactions-for-your-user-account.md @@ -1,9 +1,11 @@ --- title: Limiting interactions for your user account -intro: 'You can temporarily enforce a period of limited activity for certain users in all public repositories owned by your user account.' +intro: You can temporarily enforce a period of limited activity for certain users in all public repositories owned by your user account. versions: free-pro-team: '*' permissions: Anyone can limit interactions for their own user account. +topics: + - community --- ### About temporary interaction limits @@ -24,4 +26,4 @@ You can also block users. For more information, see "[Blocking a user from your 1. In your user settings sidebar, under "Moderation settings", click **Interaction limits**. !["Interaction limits" tab in the user settings sidebar](/assets/images/help/settings/settings-sidebar-interaction-limits.png) {% data reusables.community.set-interaction-limit %} - ![Temporary interaction limit options](/assets/images/help/settings/user-account-temporary-interaction-limits-options.png) \ No newline at end of file + ![Temporary interaction limit options](/assets/images/help/settings/user-account-temporary-interaction-limits-options.png) diff --git a/content/github/building-a-strong-community/limiting-interactions-in-your-organization.md b/content/github/building-a-strong-community/limiting-interactions-in-your-organization.md index 8c96c26302..d43d4be730 100644 --- a/content/github/building-a-strong-community/limiting-interactions-in-your-organization.md +++ b/content/github/building-a-strong-community/limiting-interactions-in-your-organization.md @@ -1,12 +1,14 @@ --- title: Limiting interactions in your organization -intro: 'You can temporarily enforce a period of limited activity for certain users in all public repositories owned by your organization.' +intro: You can temporarily enforce a period of limited activity for certain users in all public repositories owned by your organization. redirect_from: - /github/setting-up-and-managing-organizations-and-teams/limiting-interactions-in-your-organization - /articles/limiting-interactions-in-your-organization versions: free-pro-team: '*' permissions: Organization owners can limit interactions in an organization. +topics: + - community --- ### About temporary interaction limits diff --git a/content/github/building-a-strong-community/limiting-interactions-in-your-repository.md b/content/github/building-a-strong-community/limiting-interactions-in-your-repository.md index da85594b43..3b7219a4c1 100644 --- a/content/github/building-a-strong-community/limiting-interactions-in-your-repository.md +++ b/content/github/building-a-strong-community/limiting-interactions-in-your-repository.md @@ -1,12 +1,14 @@ --- title: Limiting interactions in your repository -intro: 'You can temporarily enforce a period of limited activity for certain users on a public repository.' +intro: You can temporarily enforce a period of limited activity for certain users on a public repository. redirect_from: - /articles/limiting-interactions-with-your-repository/ - /articles/limiting-interactions-in-your-repository versions: free-pro-team: '*' permissions: People with admin permissions to a repository can temporarily limit interactions in that repository. +topics: + - community --- ### About temporary interaction limits diff --git a/content/github/building-a-strong-community/locking-conversations.md b/content/github/building-a-strong-community/locking-conversations.md index 7f384471b5..2035ce49d2 100644 --- a/content/github/building-a-strong-community/locking-conversations.md +++ b/content/github/building-a-strong-community/locking-conversations.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - community --- It's appropriate to lock a conversation when the entire conversation is not constructive or violates your community's code of conduct{% if currentVersion == "free-pro-team@latest" %} or GitHub's [Community Guidelines](/articles/github-community-guidelines){% endif %}. When you lock a conversation, you can also specify a reason, which is publicly visible. diff --git a/content/github/building-a-strong-community/maintaining-your-safety-on-github.md b/content/github/building-a-strong-community/maintaining-your-safety-on-github.md index 5ace725492..72e9dbb00a 100644 --- a/content/github/building-a-strong-community/maintaining-your-safety-on-github.md +++ b/content/github/building-a-strong-community/maintaining-your-safety-on-github.md @@ -9,5 +9,7 @@ redirect_from: - /articles/encouraging-positive-contributions-to-your-project versions: free-pro-team: '*' +topics: + - community --- diff --git a/content/github/building-a-strong-community/managing-disruptive-comments.md b/content/github/building-a-strong-community/managing-disruptive-comments.md index 16acb1360c..9b41dd1009 100644 --- a/content/github/building-a-strong-community/managing-disruptive-comments.md +++ b/content/github/building-a-strong-community/managing-disruptive-comments.md @@ -9,6 +9,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - community --- ### Hiding a comment diff --git a/content/github/building-a-strong-community/managing-how-contributors-report-abuse-in-your-organizations-repository.md b/content/github/building-a-strong-community/managing-how-contributors-report-abuse-in-your-organizations-repository.md index de50df47da..2bbba1c9fe 100644 --- a/content/github/building-a-strong-community/managing-how-contributors-report-abuse-in-your-organizations-repository.md +++ b/content/github/building-a-strong-community/managing-how-contributors-report-abuse-in-your-organizations-repository.md @@ -3,6 +3,8 @@ title: Managing how contributors report abuse in your organization's repository intro: You can allow contributors to report disruptive behavior directly to repository maintainers. versions: free-pro-team: '*' +topics: + - community --- Anyone with admin permissions to a repository can manage how contributors report abuse in the repository. diff --git a/content/github/building-a-strong-community/managing-reported-content-in-your-organizations-repository.md b/content/github/building-a-strong-community/managing-reported-content-in-your-organizations-repository.md index 4dc4216243..790af089e2 100644 --- a/content/github/building-a-strong-community/managing-reported-content-in-your-organizations-repository.md +++ b/content/github/building-a-strong-community/managing-reported-content-in-your-organizations-repository.md @@ -3,6 +3,8 @@ title: Managing reported content in your organization's repository intro: 'After a contributor reports disruptive content in a repository, repository maintainers can view and manage the report.' versions: free-pro-team: '*' +topics: + - community --- Anyone with admin permissions to a repository can view and manage reported content for the repository. diff --git a/content/github/building-a-strong-community/manually-creating-a-single-issue-template-for-your-repository.md b/content/github/building-a-strong-community/manually-creating-a-single-issue-template-for-your-repository.md index 8cb5adf5ce..3a22ec0bd1 100644 --- a/content/github/building-a-strong-community/manually-creating-a-single-issue-template-for-your-repository.md +++ b/content/github/building-a-strong-community/manually-creating-a-single-issue-template-for-your-repository.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - community --- {% data reusables.repositories.legacy-issue-template-tip %} diff --git a/content/github/building-a-strong-community/moderating-comments-and-conversations.md b/content/github/building-a-strong-community/moderating-comments-and-conversations.md index 6b02dc83f3..68955777c3 100644 --- a/content/github/building-a-strong-community/moderating-comments-and-conversations.md +++ b/content/github/building-a-strong-community/moderating-comments-and-conversations.md @@ -8,5 +8,7 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - community --- diff --git a/content/github/building-a-strong-community/reporting-abuse-or-spam.md b/content/github/building-a-strong-community/reporting-abuse-or-spam.md index e33cd7be4c..5570339879 100644 --- a/content/github/building-a-strong-community/reporting-abuse-or-spam.md +++ b/content/github/building-a-strong-community/reporting-abuse-or-spam.md @@ -5,6 +5,8 @@ redirect_from: - /articles/reporting-abuse-or-spam versions: free-pro-team: '*' +topics: + - community --- Owners, collaborators, prior contributors, and people with write access can report issues, pull requests, and comments on issues, pull requests, and commits. Anyone can report apps in {% data variables.product.prodname_marketplace %}. diff --git a/content/github/building-a-strong-community/setting-guidelines-for-repository-contributors.md b/content/github/building-a-strong-community/setting-guidelines-for-repository-contributors.md index aca5e9c2ff..c529f52f84 100644 --- a/content/github/building-a-strong-community/setting-guidelines-for-repository-contributors.md +++ b/content/github/building-a-strong-community/setting-guidelines-for-repository-contributors.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - community --- To help your project contributors do good work, you can add a file with contribution guidelines to your project repository's root, `docs`, or `.github` folder. When someone opens a pull request or creates an issue, they will see a link to that file. diff --git a/content/github/building-a-strong-community/setting-up-your-project-for-healthy-contributions.md b/content/github/building-a-strong-community/setting-up-your-project-for-healthy-contributions.md index 4779c2e8c9..bab3c8d57f 100644 --- a/content/github/building-a-strong-community/setting-up-your-project-for-healthy-contributions.md +++ b/content/github/building-a-strong-community/setting-up-your-project-for-healthy-contributions.md @@ -9,5 +9,7 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - community --- diff --git a/content/github/building-a-strong-community/tracking-changes-in-a-comment.md b/content/github/building-a-strong-community/tracking-changes-in-a-comment.md index 0af05d4355..9ddaa0094d 100644 --- a/content/github/building-a-strong-community/tracking-changes-in-a-comment.md +++ b/content/github/building-a-strong-community/tracking-changes-in-a-comment.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - community --- ### Viewing a comment's edit history details diff --git a/content/github/building-a-strong-community/unblocking-a-user-from-your-organization.md b/content/github/building-a-strong-community/unblocking-a-user-from-your-organization.md index 616b702424..f0b25a83de 100644 --- a/content/github/building-a-strong-community/unblocking-a-user-from-your-organization.md +++ b/content/github/building-a-strong-community/unblocking-a-user-from-your-organization.md @@ -5,6 +5,8 @@ redirect_from: - /articles/unblocking-a-user-from-your-organization versions: free-pro-team: '*' +topics: + - community --- After unblocking a user from your organization, they'll be able to contribute to your organization's repositories. diff --git a/content/github/building-a-strong-community/unblocking-a-user-from-your-personal-account.md b/content/github/building-a-strong-community/unblocking-a-user-from-your-personal-account.md index f62dd1c2ac..49e3481749 100644 --- a/content/github/building-a-strong-community/unblocking-a-user-from-your-personal-account.md +++ b/content/github/building-a-strong-community/unblocking-a-user-from-your-personal-account.md @@ -5,6 +5,8 @@ redirect_from: - /articles/unblocking-a-user-from-your-personal-account versions: free-pro-team: '*' +topics: + - community --- When you unblock a user, they'll be able to invite you to be a collaborator to their repositories. If they [@mention you](/articles/basic-writing-and-formatting-syntax/#mentioning-people-and-teams) anywhere on GitHub, you'll receive notifications. diff --git a/content/github/building-a-strong-community/using-templates-to-encourage-useful-issues-and-pull-requests.md b/content/github/building-a-strong-community/using-templates-to-encourage-useful-issues-and-pull-requests.md index 3435c8fa32..65848c631a 100644 --- a/content/github/building-a-strong-community/using-templates-to-encourage-useful-issues-and-pull-requests.md +++ b/content/github/building-a-strong-community/using-templates-to-encourage-useful-issues-and-pull-requests.md @@ -10,5 +10,7 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - community --- diff --git a/content/github/building-a-strong-community/viewing-a-wikis-history-of-changes.md b/content/github/building-a-strong-community/viewing-a-wikis-history-of-changes.md index caaad4013d..8af76dfd85 100644 --- a/content/github/building-a-strong-community/viewing-a-wikis-history-of-changes.md +++ b/content/github/building-a-strong-community/viewing-a-wikis-history-of-changes.md @@ -9,6 +9,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - community --- ### Viewing wiki history diff --git a/content/github/building-a-strong-community/viewing-users-who-are-blocked-from-your-organization.md b/content/github/building-a-strong-community/viewing-users-who-are-blocked-from-your-organization.md index 047ea789cc..27efafed8f 100644 --- a/content/github/building-a-strong-community/viewing-users-who-are-blocked-from-your-organization.md +++ b/content/github/building-a-strong-community/viewing-users-who-are-blocked-from-your-organization.md @@ -5,6 +5,8 @@ redirect_from: - /articles/viewing-users-who-are-blocked-from-your-organization versions: free-pro-team: '*' +topics: + - community --- {% data reusables.profile.access_profile %} diff --git a/content/github/building-a-strong-community/viewing-users-youve-blocked-from-your-personal-account.md b/content/github/building-a-strong-community/viewing-users-youve-blocked-from-your-personal-account.md index 0f3bae172f..a5866bc295 100644 --- a/content/github/building-a-strong-community/viewing-users-youve-blocked-from-your-personal-account.md +++ b/content/github/building-a-strong-community/viewing-users-youve-blocked-from-your-personal-account.md @@ -6,6 +6,8 @@ redirect_from: - /articles/viewing-users-youve-blocked-from-your-personal-account versions: free-pro-team: '*' +topics: + - community --- {% data reusables.user_settings.access_settings %} diff --git a/content/github/collaborating-with-issues-and-pull-requests/about-branches.md b/content/github/collaborating-with-issues-and-pull-requests/about-branches.md index 14595a111a..016cc6cc7a 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/about-branches.md +++ b/content/github/collaborating-with-issues-and-pull-requests/about-branches.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- diff --git a/content/github/collaborating-with-issues-and-pull-requests/about-collaborative-development-models.md b/content/github/collaborating-with-issues-and-pull-requests/about-collaborative-development-models.md index 7325304482..f9cec4d87c 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/about-collaborative-development-models.md +++ b/content/github/collaborating-with-issues-and-pull-requests/about-collaborative-development-models.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- There are two main types of development models with which you'd use pull requests. In the *fork and pull model*, anyone can fork an existing repository and push changes to their personal fork. You do not need permission to the source repository to push to a user-owned fork. The changes can be pulled into the source repository by the project maintainer. When you open a pull request proposing changes from your user-owned fork to a branch in the source (upstream) repository, you can allow anyone with push access to the upstream repository to make changes to your pull request. This model is popular with open source projects as it reduces the amount of friction for new contributors and allows people to work independently without upfront coordination. diff --git a/content/github/collaborating-with-issues-and-pull-requests/about-comparing-branches-in-pull-requests.md b/content/github/collaborating-with-issues-and-pull-requests/about-comparing-branches-in-pull-requests.md index 7e07ded2be..10c3ea7475 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/about-comparing-branches-in-pull-requests.md +++ b/content/github/collaborating-with-issues-and-pull-requests/about-comparing-branches-in-pull-requests.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- {% note %} diff --git a/content/github/collaborating-with-issues-and-pull-requests/about-conversations-on-github.md b/content/github/collaborating-with-issues-and-pull-requests/about-conversations-on-github.md index 8e21b6d214..c88963f9b0 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/about-conversations-on-github.md +++ b/content/github/collaborating-with-issues-and-pull-requests/about-conversations-on-github.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- ### Discussions on {% data variables.product.product_name %} @@ -16,7 +18,7 @@ You can create and participate in issues, pull requests, and team discussions, d Issues are useful for discussing specific details of a project such as bug reports and planned improvements. For more information, see "[About issues](/articles/about-issues)." Pull requests allow you to comment directly on proposed changes. For more information, see "[About pull requests](/articles/about-pull-requests)" and "[Commenting on a pull request](/articles/commenting-on-a-pull-request)." -{% data reusables.organizations.team-discussions-purpose %} For more information, see "[About team discussions](/articles/about-team-discussions)." +{% data reusables.organizations.team-discussions-purpose %} For more information, see "[About team discussions](/github/setting-up-and-managing-organizations-and-teams/about-team-discussions)." ### Reacting to ideas in comments diff --git a/content/github/collaborating-with-issues-and-pull-requests/about-forks.md b/content/github/collaborating-with-issues-and-pull-requests/about-forks.md index c7acbb201e..a98a7988d3 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/about-forks.md +++ b/content/github/collaborating-with-issues-and-pull-requests/about-forks.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- Forking a repository is similar to copying a repository, with two major differences: diff --git a/content/github/collaborating-with-issues-and-pull-requests/about-merge-conflicts.md b/content/github/collaborating-with-issues-and-pull-requests/about-merge-conflicts.md index 8e10ed8b96..620828529a 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/about-merge-conflicts.md +++ b/content/github/collaborating-with-issues-and-pull-requests/about-merge-conflicts.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- Git can often resolve differences between branches and merge them automatically. Usually, the changes are on different lines, or even in different files, which makes the merge simple for computers to understand. However, sometimes there are competing changes that Git can't resolve without your help. Often, merge conflicts happen when people make different changes to the same line of the same file, or when one person edits a file and another person deletes the same file. diff --git a/content/github/collaborating-with-issues-and-pull-requests/about-pull-request-merges.md b/content/github/collaborating-with-issues-and-pull-requests/about-pull-request-merges.md index 140097bc99..7c0a215180 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/about-pull-request-merges.md +++ b/content/github/collaborating-with-issues-and-pull-requests/about-pull-request-merges.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- {% data reusables.pull_requests.default_merge_option %} diff --git a/content/github/collaborating-with-issues-and-pull-requests/about-pull-request-reviews.md b/content/github/collaborating-with-issues-and-pull-requests/about-pull-request-reviews.md index cd9d144824..93a6a0374d 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/about-pull-request-reviews.md +++ b/content/github/collaborating-with-issues-and-pull-requests/about-pull-request-reviews.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- ### About pull request reviews diff --git a/content/github/collaborating-with-issues-and-pull-requests/about-pull-requests.md b/content/github/collaborating-with-issues-and-pull-requests/about-pull-requests.md index ffba2f58cf..e157d032a5 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/about-pull-requests.md +++ b/content/github/collaborating-with-issues-and-pull-requests/about-pull-requests.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- ### About pull requests diff --git a/content/github/collaborating-with-issues-and-pull-requests/about-status-checks.md b/content/github/collaborating-with-issues-and-pull-requests/about-status-checks.md index 4723d04971..cf4fb304a9 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/about-status-checks.md +++ b/content/github/collaborating-with-issues-and-pull-requests/about-status-checks.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- Status checks are based on external processes, such as continuous integration builds, which run for each push you make to a repository. You can see the *pending*, *passing*, or *failing* state of status checks next to individual commits in your pull request. diff --git a/content/github/collaborating-with-issues-and-pull-requests/addressing-merge-conflicts.md b/content/github/collaborating-with-issues-and-pull-requests/addressing-merge-conflicts.md index 496b92edd0..bc9829b98f 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/addressing-merge-conflicts.md +++ b/content/github/collaborating-with-issues-and-pull-requests/addressing-merge-conflicts.md @@ -8,5 +8,7 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- diff --git a/content/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork.md b/content/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork.md index e84de9cf65..45d42c07a0 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork.md +++ b/content/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- Only pull request authors can give upstream repository maintainers, or those with push access to the upstream repository, permission to make commits to their pull request's compare branch in a user-owned fork. To learn more about upstream repositories, see "[About forks](/articles/about-forks)." diff --git a/content/github/collaborating-with-issues-and-pull-requests/approving-a-pull-request-with-required-reviews.md b/content/github/collaborating-with-issues-and-pull-requests/approving-a-pull-request-with-required-reviews.md index a6854818c4..04caa5fe36 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/approving-a-pull-request-with-required-reviews.md +++ b/content/github/collaborating-with-issues-and-pull-requests/approving-a-pull-request-with-required-reviews.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- For more information about required reviews, see "[About protected branches](/github/administering-a-repository/about-protected-branches#require-pull-request-reviews-before-merging)." diff --git a/content/github/collaborating-with-issues-and-pull-requests/automatically-merging-a-pull-request.md b/content/github/collaborating-with-issues-and-pull-requests/automatically-merging-a-pull-request.md index 5b04b5082b..12d2eb2b92 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/automatically-merging-a-pull-request.md +++ b/content/github/collaborating-with-issues-and-pull-requests/automatically-merging-a-pull-request.md @@ -1,10 +1,13 @@ --- title: Automatically merging a pull request -intro: 'You can increase development velocity by enabling auto-merge for a pull request so that the pull request will merge automatically when all merge requirements are met.' +intro: You can increase development velocity by enabling auto-merge for a pull request so that the pull request will merge automatically when all merge requirements are met. product: '{% data reusables.gated-features.auto-merge %}' versions: free-pro-team: '*' enterprise-server: '>=3.1' + github-ae: '*' +topics: + - pull requests --- ### About auto-merge diff --git a/content/github/collaborating-with-issues-and-pull-requests/changing-the-base-branch-of-a-pull-request.md b/content/github/collaborating-with-issues-and-pull-requests/changing-the-base-branch-of-a-pull-request.md index 2e5cf86f52..dc5773a4dd 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/changing-the-base-branch-of-a-pull-request.md +++ b/content/github/collaborating-with-issues-and-pull-requests/changing-the-base-branch-of-a-pull-request.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- {% warning %} diff --git a/content/github/collaborating-with-issues-and-pull-requests/changing-the-stage-of-a-pull-request.md b/content/github/collaborating-with-issues-and-pull-requests/changing-the-stage-of-a-pull-request.md index c8c46903c4..5684ef55c0 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/changing-the-stage-of-a-pull-request.md +++ b/content/github/collaborating-with-issues-and-pull-requests/changing-the-stage-of-a-pull-request.md @@ -9,6 +9,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- ### Marking a pull request as ready for review diff --git a/content/github/collaborating-with-issues-and-pull-requests/checking-out-pull-requests-locally.md b/content/github/collaborating-with-issues-and-pull-requests/checking-out-pull-requests-locally.md index 4ed1a97a60..edb7dbdb90 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/checking-out-pull-requests-locally.md +++ b/content/github/collaborating-with-issues-and-pull-requests/checking-out-pull-requests-locally.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- {% note %} diff --git a/content/github/collaborating-with-issues-and-pull-requests/closing-a-pull-request.md b/content/github/collaborating-with-issues-and-pull-requests/closing-a-pull-request.md index a6acb76c97..cfb5b3c972 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/closing-a-pull-request.md +++ b/content/github/collaborating-with-issues-and-pull-requests/closing-a-pull-request.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- {% tip %} diff --git a/content/github/collaborating-with-issues-and-pull-requests/collaborating-on-repositories-with-code-quality-features.md b/content/github/collaborating-with-issues-and-pull-requests/collaborating-on-repositories-with-code-quality-features.md index e185d0a0cf..1d4bdbd223 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/collaborating-on-repositories-with-code-quality-features.md +++ b/content/github/collaborating-with-issues-and-pull-requests/collaborating-on-repositories-with-code-quality-features.md @@ -9,5 +9,7 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- diff --git a/content/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request.md b/content/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request.md index 2f109a79d6..d40da420da 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request.md +++ b/content/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request.md @@ -10,6 +10,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- ### About pull request comments diff --git a/content/github/collaborating-with-issues-and-pull-requests/committing-changes-to-a-pull-request-branch-created-from-a-fork.md b/content/github/collaborating-with-issues-and-pull-requests/committing-changes-to-a-pull-request-branch-created-from-a-fork.md index 0f38fb1a00..fe0ffb4d7a 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/committing-changes-to-a-pull-request-branch-created-from-a-fork.md +++ b/content/github/collaborating-with-issues-and-pull-requests/committing-changes-to-a-pull-request-branch-created-from-a-fork.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- You can only make commits on pull request branches that: diff --git a/content/github/collaborating-with-issues-and-pull-requests/configuring-a-remote-for-a-fork.md b/content/github/collaborating-with-issues-and-pull-requests/configuring-a-remote-for-a-fork.md index 357da89aed..8808971cdc 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/configuring-a-remote-for-a-fork.md +++ b/content/github/collaborating-with-issues-and-pull-requests/configuring-a-remote-for-a-fork.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- {% data reusables.command_line.open_the_multi_os_terminal %} 2. List the current configured remote repository for your fork. diff --git a/content/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork.md b/content/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork.md index 0aebcf7f57..a6de47b348 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork.md +++ b/content/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- You can also give the upstream repository's maintainers permission to push commits to a user-owned fork. If your pull request compares your topic branch with a branch in the upstream repository as the base branch, then your topic branch is also called the compare branch of the pull request. For more information about pull request branches, including examples, see "[Creating a pull request](/articles/creating-a-pull-request/#changing-the-branch-range-and-destination-repository)." diff --git a/content/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request.md b/content/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request.md index 501339a84f..15326fe298 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request.md +++ b/content/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- Anyone with read permissions to a repository can create a pull request, but you must have write permissions to create a branch. If you want to create a new branch for your pull request and don't have write permissions to the repository, you can fork the repository first. For more information, see "[Creating a pull request from a fork](/articles/creating-a-pull-request-from-a-fork)" and "[About forks](/articles/about-forks)." diff --git a/content/github/collaborating-with-issues-and-pull-requests/creating-and-deleting-branches-within-your-repository.md b/content/github/collaborating-with-issues-and-pull-requests/creating-and-deleting-branches-within-your-repository.md index 4f0c487c12..c7618f3507 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/creating-and-deleting-branches-within-your-repository.md +++ b/content/github/collaborating-with-issues-and-pull-requests/creating-and-deleting-branches-within-your-repository.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- ### Creating a branch diff --git a/content/github/collaborating-with-issues-and-pull-requests/dismissing-a-pull-request-review.md b/content/github/collaborating-with-issues-and-pull-requests/dismissing-a-pull-request-review.md index 0f52e396f7..9a7a0aacc5 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/dismissing-a-pull-request-review.md +++ b/content/github/collaborating-with-issues-and-pull-requests/dismissing-a-pull-request-review.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- {% data reusables.pull_requests.dismiss_review %} @@ -26,4 +28,4 @@ This changes the status of the review to a review comment. When you dismiss a re - "[About pull request reviews](/articles/about-pull-request-reviews)" - "[Reviewing proposed changes in a pull request](/articles/reviewing-proposed-changes-in-a-pull-request)" -- "[About protected branches](/github/administering-a-repository/about-protected-branches#require-pull-request-reviews-before-merging)" \ No newline at end of file +- "[About protected branches](/github/administering-a-repository/about-protected-branches#require-pull-request-reviews-before-merging)" diff --git a/content/github/collaborating-with-issues-and-pull-requests/filtering-files-in-a-pull-request.md b/content/github/collaborating-with-issues-and-pull-requests/filtering-files-in-a-pull-request.md index 8abfc72cb1..0f50ae18a7 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/filtering-files-in-a-pull-request.md +++ b/content/github/collaborating-with-issues-and-pull-requests/filtering-files-in-a-pull-request.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- You can filter files in a pull request by file extension type, such as `.html` or `.js`, lack of an extension, code ownership, or dotfiles. diff --git a/content/github/collaborating-with-issues-and-pull-requests/finding-changed-methods-and-functions-in-a-pull-request.md b/content/github/collaborating-with-issues-and-pull-requests/finding-changed-methods-and-functions-in-a-pull-request.md index 5b1ea925dc..4fe786ab06 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/finding-changed-methods-and-functions-in-a-pull-request.md +++ b/content/github/collaborating-with-issues-and-pull-requests/finding-changed-methods-and-functions-in-a-pull-request.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- Anyone with read access to a repository can see a summary list of the functions and methods changes in certain files of a pull request. diff --git a/content/github/collaborating-with-issues-and-pull-requests/github-flow.md b/content/github/collaborating-with-issues-and-pull-requests/github-flow.md index b94297ab44..9aceb77d6c 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/github-flow.md +++ b/content/github/collaborating-with-issues-and-pull-requests/github-flow.md @@ -9,6 +9,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- ### Following the GitHub flow diff --git a/content/github/collaborating-with-issues-and-pull-requests/incorporating-changes-from-a-pull-request.md b/content/github/collaborating-with-issues-and-pull-requests/incorporating-changes-from-a-pull-request.md index 0caba244c6..d6d564c409 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/incorporating-changes-from-a-pull-request.md +++ b/content/github/collaborating-with-issues-and-pull-requests/incorporating-changes-from-a-pull-request.md @@ -8,5 +8,7 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- diff --git a/content/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request.md b/content/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request.md index 68bcb96e4a..b8db6db125 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request.md +++ b/content/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- ### Applying suggested changes diff --git a/content/github/collaborating-with-issues-and-pull-requests/index.md b/content/github/collaborating-with-issues-and-pull-requests/index.md index 1e666ca019..51e6d15485 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/index.md +++ b/content/github/collaborating-with-issues-and-pull-requests/index.md @@ -11,6 +11,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- diff --git a/content/github/collaborating-with-issues-and-pull-requests/merging-a-pull-request.md b/content/github/collaborating-with-issues-and-pull-requests/merging-a-pull-request.md index 876784f7cf..ffac83495b 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/merging-a-pull-request.md +++ b/content/github/collaborating-with-issues-and-pull-requests/merging-a-pull-request.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- ### About pull request merges diff --git a/content/github/collaborating-with-issues-and-pull-requests/merging-an-upstream-repository-into-your-fork.md b/content/github/collaborating-with-issues-and-pull-requests/merging-an-upstream-repository-into-your-fork.md index 4463aa1477..d74e66d01c 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/merging-an-upstream-repository-into-your-fork.md +++ b/content/github/collaborating-with-issues-and-pull-requests/merging-an-upstream-repository-into-your-fork.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- {% data reusables.command_line.open_the_multi_os_terminal %} 2. Change the current working directory to your local project. diff --git a/content/github/collaborating-with-issues-and-pull-requests/overview.md b/content/github/collaborating-with-issues-and-pull-requests/overview.md index 816072556f..be470cec0b 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/overview.md +++ b/content/github/collaborating-with-issues-and-pull-requests/overview.md @@ -6,5 +6,7 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- diff --git a/content/github/collaborating-with-issues-and-pull-requests/proposing-changes-to-your-work-with-pull-requests.md b/content/github/collaborating-with-issues-and-pull-requests/proposing-changes-to-your-work-with-pull-requests.md index 913990858c..efe90d1598 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/proposing-changes-to-your-work-with-pull-requests.md +++ b/content/github/collaborating-with-issues-and-pull-requests/proposing-changes-to-your-work-with-pull-requests.md @@ -8,5 +8,7 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- diff --git a/content/github/collaborating-with-issues-and-pull-requests/requesting-a-pull-request-review.md b/content/github/collaborating-with-issues-and-pull-requests/requesting-a-pull-request-review.md index 65ebb3844c..72ba7b1693 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/requesting-a-pull-request-review.md +++ b/content/github/collaborating-with-issues-and-pull-requests/requesting-a-pull-request-review.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- Owners and collaborators on a repository owned by a user account can assign pull request reviews. Organization members with triage permissions to a repository can assign a pull request review. diff --git a/content/github/collaborating-with-issues-and-pull-requests/resolving-a-merge-conflict-on-github.md b/content/github/collaborating-with-issues-and-pull-requests/resolving-a-merge-conflict-on-github.md index ec47c6933b..a423d69817 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/resolving-a-merge-conflict-on-github.md +++ b/content/github/collaborating-with-issues-and-pull-requests/resolving-a-merge-conflict-on-github.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- You can only resolve merge conflicts on {% data variables.product.product_name %} that are caused by competing line changes, such as when people make different changes to the same line of the same file on different branches in your Git repository. For all other types of merge conflicts, you must resolve the conflict locally on the command line. For more information, see "[Resolving a merge conflict using the command line](/articles/resolving-a-merge-conflict-using-the-command-line/)." diff --git a/content/github/collaborating-with-issues-and-pull-requests/resolving-a-merge-conflict-using-the-command-line.md b/content/github/collaborating-with-issues-and-pull-requests/resolving-a-merge-conflict-using-the-command-line.md index 5dae3a1540..f97a0aa9fb 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/resolving-a-merge-conflict-using-the-command-line.md +++ b/content/github/collaborating-with-issues-and-pull-requests/resolving-a-merge-conflict-using-the-command-line.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- Merge conflicts occur when competing changes are made to the same line of a file, or when one person edits a file and another person deletes the same file. For more information, see "[About merge conflicts](/articles/about-merge-conflicts/)." diff --git a/content/github/collaborating-with-issues-and-pull-requests/reverting-a-pull-request.md b/content/github/collaborating-with-issues-and-pull-requests/reverting-a-pull-request.md index dd7b4b5df1..2eeeb21d67 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/reverting-a-pull-request.md +++ b/content/github/collaborating-with-issues-and-pull-requests/reverting-a-pull-request.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- ### About reverting a pull request diff --git a/content/github/collaborating-with-issues-and-pull-requests/reviewing-changes-in-pull-requests.md b/content/github/collaborating-with-issues-and-pull-requests/reviewing-changes-in-pull-requests.md index 83cbe91549..f0b03a1aae 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/reviewing-changes-in-pull-requests.md +++ b/content/github/collaborating-with-issues-and-pull-requests/reviewing-changes-in-pull-requests.md @@ -9,5 +9,7 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- diff --git a/content/github/collaborating-with-issues-and-pull-requests/reviewing-dependency-changes-in-a-pull-request.md b/content/github/collaborating-with-issues-and-pull-requests/reviewing-dependency-changes-in-a-pull-request.md index 2f68164e62..f925a1ee23 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/reviewing-dependency-changes-in-a-pull-request.md +++ b/content/github/collaborating-with-issues-and-pull-requests/reviewing-dependency-changes-in-a-pull-request.md @@ -3,6 +3,8 @@ title: Reviewing dependency changes in a pull request intro: 'If a pull request contains changes to dependencies, you can view a summary of what has changed and whether there are known vulnerabilities in any of the dependencies.' versions: free-pro-team: '*' +topics: + - pull requests --- {% note %} diff --git a/content/github/collaborating-with-issues-and-pull-requests/reviewing-proposed-changes-in-a-pull-request.md b/content/github/collaborating-with-issues-and-pull-requests/reviewing-proposed-changes-in-a-pull-request.md index efecceace8..0abbfff562 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/reviewing-proposed-changes-in-a-pull-request.md +++ b/content/github/collaborating-with-issues-and-pull-requests/reviewing-proposed-changes-in-a-pull-request.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- ### About reviewing pull requests diff --git a/content/github/collaborating-with-issues-and-pull-requests/syncing-a-fork.md b/content/github/collaborating-with-issues-and-pull-requests/syncing-a-fork.md index affc3dd844..941f9b9da1 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/syncing-a-fork.md +++ b/content/github/collaborating-with-issues-and-pull-requests/syncing-a-fork.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- Before you can sync your fork with an upstream repository, you must [configure a remote that points to the upstream repository](/articles/configuring-a-remote-for-a-fork) in Git. diff --git a/content/github/collaborating-with-issues-and-pull-requests/viewing-a-pull-request-review.md b/content/github/collaborating-with-issues-and-pull-requests/viewing-a-pull-request-review.md index 6beac48895..7eab837b12 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/viewing-a-pull-request-review.md +++ b/content/github/collaborating-with-issues-and-pull-requests/viewing-a-pull-request-review.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- {% data reusables.search.requested_reviews_search %} diff --git a/content/github/collaborating-with-issues-and-pull-requests/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility.md b/content/github/collaborating-with-issues-and-pull-requests/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility.md index 28d3dee2e5..563ad76cfb 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility.md +++ b/content/github/collaborating-with-issues-and-pull-requests/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- {% data reusables.repositories.deleted_forks_from_private_repositories_warning %} diff --git a/content/github/collaborating-with-issues-and-pull-requests/working-with-forks.md b/content/github/collaborating-with-issues-and-pull-requests/working-with-forks.md index fef659dd91..0fca472b8f 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/working-with-forks.md +++ b/content/github/collaborating-with-issues-and-pull-requests/working-with-forks.md @@ -8,5 +8,7 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- diff --git a/content/github/creating-cloning-and-archiving-repositories/about-archiving-content-and-data-on-github.md b/content/github/creating-cloning-and-archiving-repositories/about-archiving-content-and-data-on-github.md index 3b9fb08f27..2df075cbef 100644 --- a/content/github/creating-cloning-and-archiving-repositories/about-archiving-content-and-data-on-github.md +++ b/content/github/creating-cloning-and-archiving-repositories/about-archiving-content-and-data-on-github.md @@ -5,6 +5,8 @@ redirect_from: - /articles/about-archiving-content-and-data-on-github versions: free-pro-team: '*' +topics: + - repositories --- ### Persistence of public repositories diff --git a/content/github/creating-cloning-and-archiving-repositories/about-archiving-repositories.md b/content/github/creating-cloning-and-archiving-repositories/about-archiving-repositories.md index 51d0fc1e32..829e7fffa7 100644 --- a/content/github/creating-cloning-and-archiving-repositories/about-archiving-repositories.md +++ b/content/github/creating-cloning-and-archiving-repositories/about-archiving-repositories.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- {% if currentVersion == "free-pro-team@latest" %} diff --git a/content/github/creating-cloning-and-archiving-repositories/about-code-owners.md b/content/github/creating-cloning-and-archiving-repositories/about-code-owners.md index c9da88109f..c65f2577a1 100644 --- a/content/github/creating-cloning-and-archiving-repositories/about-code-owners.md +++ b/content/github/creating-cloning-and-archiving-repositories/about-code-owners.md @@ -9,6 +9,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- People with admin or owner permissions can set up a CODEOWNERS file in a repository. diff --git a/content/github/creating-cloning-and-archiving-repositories/about-readmes.md b/content/github/creating-cloning-and-archiving-repositories/about-readmes.md index 2e65dc8587..c11e0278a7 100644 --- a/content/github/creating-cloning-and-archiving-repositories/about-readmes.md +++ b/content/github/creating-cloning-and-archiving-repositories/about-readmes.md @@ -9,6 +9,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- ### About READMEs diff --git a/content/github/creating-cloning-and-archiving-repositories/about-repositories.md b/content/github/creating-cloning-and-archiving-repositories/about-repositories.md index 214d30606e..87e8cbf1fd 100644 --- a/content/github/creating-cloning-and-archiving-repositories/about-repositories.md +++ b/content/github/creating-cloning-and-archiving-repositories/about-repositories.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- You can own repositories individually, or you can share ownership of repositories with other people in an organization. diff --git a/content/github/creating-cloning-and-archiving-repositories/about-repository-languages.md b/content/github/creating-cloning-and-archiving-repositories/about-repository-languages.md index 94d1f82eb3..2fde93a169 100644 --- a/content/github/creating-cloning-and-archiving-repositories/about-repository-languages.md +++ b/content/github/creating-cloning-and-archiving-repositories/about-repository-languages.md @@ -12,6 +12,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- {% data variables.product.product_name %} uses the open source [Linguist library](https://github.com/github/linguist) to determine file languages for syntax highlighting and repository statistics. Language statistics will update after you push changes to your default branch. diff --git a/content/github/creating-cloning-and-archiving-repositories/about-repository-visibility.md b/content/github/creating-cloning-and-archiving-repositories/about-repository-visibility.md index 9e2fc6a4ec..722ababce5 100644 --- a/content/github/creating-cloning-and-archiving-repositories/about-repository-visibility.md +++ b/content/github/creating-cloning-and-archiving-repositories/about-repository-visibility.md @@ -5,6 +5,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- ### About repository visibility diff --git a/content/github/creating-cloning-and-archiving-repositories/archiving-a-github-repository.md b/content/github/creating-cloning-and-archiving-repositories/archiving-a-github-repository.md index bb9d9e01a7..39ef8ed46e 100644 --- a/content/github/creating-cloning-and-archiving-repositories/archiving-a-github-repository.md +++ b/content/github/creating-cloning-and-archiving-repositories/archiving-a-github-repository.md @@ -10,5 +10,7 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- diff --git a/content/github/creating-cloning-and-archiving-repositories/archiving-repositories.md b/content/github/creating-cloning-and-archiving-repositories/archiving-repositories.md index 8a8f7b9bdf..e7d866a63b 100644 --- a/content/github/creating-cloning-and-archiving-repositories/archiving-repositories.md +++ b/content/github/creating-cloning-and-archiving-repositories/archiving-repositories.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- {% data reusables.repositories.archiving-repositories-recommendation %} diff --git a/content/github/creating-cloning-and-archiving-repositories/backing-up-a-repository.md b/content/github/creating-cloning-and-archiving-repositories/backing-up-a-repository.md index 11675d7087..8fd1c33c3f 100644 --- a/content/github/creating-cloning-and-archiving-repositories/backing-up-a-repository.md +++ b/content/github/creating-cloning-and-archiving-repositories/backing-up-a-repository.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- {% if currentVersion == "free-pro-team@latest" %} @@ -36,7 +38,5 @@ Once you have {% if enterpriseServerVersions contains currentVersion or currentV {% if currentVersion == "free-pro-team@latest" %} ### Third-party backup tools -A number of self-service tools exist that automate backups of repositories. Unlike archival projects, which archive _all_ public repositories on {% data variables.product.product_name %} that have not opted out and make the data accessible to anyone, backup tools will download data from _specific_ repositories and organize it within a new branch or directory. For more information about archival projects, see "[About archiving content and data on {% data variables.product.prodname_dotcom %}](/github/creating-cloning-and-archiving-repositories/about-archiving-content-and-data-on-github#about-the-github-archive-program)." - -You can back up all of a repository's Git data (such as project files and commit history), as well as much data from {% data variables.product.product_name %} (such as issues and pull requests), with [BackHub](https://github.com/marketplace/backhub), which creates daily recurring backups of your repositories with snapshots up to 30 days back in time. BackHub is available in {% data variables.product.prodname_marketplace %}. +A number of self-service tools exist that automate backups of repositories. Unlike archival projects, which archive _all_ public repositories on {% data variables.product.product_name %} that have not opted out and make the data accessible to anyone, backup tools will download data from _specific_ repositories and organize it within a new branch or directory. For more information about archival projects, see "[About archiving content and data on {% data variables.product.prodname_dotcom %}](/github/creating-cloning-and-archiving-repositories/about-archiving-content-and-data-on-github#about-the-github-archive-program)." For more information about self-service backup tools, see the [Backup Utilities category on {% data variables.product.prodname_marketplace %}](https://github.com/marketplace?category=backup-utilities). {% endif %} diff --git a/content/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github.md b/content/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github.md index 8272d98dcb..e8b70b558f 100644 --- a/content/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github.md +++ b/content/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github.md @@ -8,5 +8,7 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- diff --git a/content/github/creating-cloning-and-archiving-repositories/cloning-a-repository.md b/content/github/creating-cloning-and-archiving-repositories/cloning-a-repository.md index 0dc66db59f..8014777ecb 100644 --- a/content/github/creating-cloning-and-archiving-repositories/cloning-a-repository.md +++ b/content/github/creating-cloning-and-archiving-repositories/cloning-a-repository.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- ### About cloning a repository diff --git a/content/github/creating-cloning-and-archiving-repositories/creating-a-new-repository.md b/content/github/creating-cloning-and-archiving-repositories/creating-a-new-repository.md index fbd4af8d7b..bdf453d842 100644 --- a/content/github/creating-cloning-and-archiving-repositories/creating-a-new-repository.md +++ b/content/github/creating-cloning-and-archiving-repositories/creating-a-new-repository.md @@ -13,6 +13,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- {% tip %} diff --git a/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template.md b/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template.md index c8174a611e..a5cb896023 100644 --- a/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template.md +++ b/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- ### About repository templates diff --git a/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github.md b/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github.md index ca3e328a93..ab4eaeb9cd 100644 --- a/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github.md +++ b/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github.md @@ -8,5 +8,7 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- diff --git a/content/github/creating-cloning-and-archiving-repositories/creating-a-template-repository.md b/content/github/creating-cloning-and-archiving-repositories/creating-a-template-repository.md index 39778d159c..786ce1022c 100644 --- a/content/github/creating-cloning-and-archiving-repositories/creating-a-template-repository.md +++ b/content/github/creating-cloning-and-archiving-repositories/creating-a-template-repository.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- {% note %} diff --git a/content/github/creating-cloning-and-archiving-repositories/creating-an-issues-only-repository.md b/content/github/creating-cloning-and-archiving-repositories/creating-an-issues-only-repository.md index 29b1a39280..c02192cb38 100644 --- a/content/github/creating-cloning-and-archiving-repositories/creating-an-issues-only-repository.md +++ b/content/github/creating-cloning-and-archiving-repositories/creating-an-issues-only-repository.md @@ -9,6 +9,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- 1. Create a **private** repository to host the source code from your project. diff --git a/content/github/creating-cloning-and-archiving-repositories/duplicating-a-repository.md b/content/github/creating-cloning-and-archiving-repositories/duplicating-a-repository.md index bff96eedc7..69243b563c 100644 --- a/content/github/creating-cloning-and-archiving-repositories/duplicating-a-repository.md +++ b/content/github/creating-cloning-and-archiving-repositories/duplicating-a-repository.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- Before you can duplicate a repository and push to your new copy, or _mirror_, of the repository, you must [create the new repository](/articles/creating-a-new-repository) on {% data variables.product.product_location %}. In these examples, `exampleuser/new-repository` or `exampleuser/mirrored` are the mirrors. diff --git a/content/github/creating-cloning-and-archiving-repositories/error-remote-head-refers-to-nonexistent-ref-unable-to-checkout.md b/content/github/creating-cloning-and-archiving-repositories/error-remote-head-refers-to-nonexistent-ref-unable-to-checkout.md index f1854f8be8..1f7017a371 100644 --- a/content/github/creating-cloning-and-archiving-repositories/error-remote-head-refers-to-nonexistent-ref-unable-to-checkout.md +++ b/content/github/creating-cloning-and-archiving-repositories/error-remote-head-refers-to-nonexistent-ref-unable-to-checkout.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- Detecting this error is simple; Git will warn you when you try to clone the repository: diff --git a/content/github/creating-cloning-and-archiving-repositories/error-repository-not-found.md b/content/github/creating-cloning-and-archiving-repositories/error-repository-not-found.md index 55b0e571ce..b5a1a1591d 100644 --- a/content/github/creating-cloning-and-archiving-repositories/error-repository-not-found.md +++ b/content/github/creating-cloning-and-archiving-repositories/error-repository-not-found.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- ### Check your spelling diff --git a/content/github/creating-cloning-and-archiving-repositories/https-cloning-errors.md b/content/github/creating-cloning-and-archiving-repositories/https-cloning-errors.md index 5910f71320..8c1b1a9b6a 100644 --- a/content/github/creating-cloning-and-archiving-repositories/https-cloning-errors.md +++ b/content/github/creating-cloning-and-archiving-repositories/https-cloning-errors.md @@ -11,6 +11,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- Here's an example of an HTTPS error you might receive: diff --git a/content/github/creating-cloning-and-archiving-repositories/index.md b/content/github/creating-cloning-and-archiving-repositories/index.md index d590e22a92..c5b3fb896f 100644 --- a/content/github/creating-cloning-and-archiving-repositories/index.md +++ b/content/github/creating-cloning-and-archiving-repositories/index.md @@ -9,6 +9,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- diff --git a/content/github/creating-cloning-and-archiving-repositories/licensing-a-repository.md b/content/github/creating-cloning-and-archiving-repositories/licensing-a-repository.md index e4619e0a4c..aaf80f4d9a 100644 --- a/content/github/creating-cloning-and-archiving-repositories/licensing-a-repository.md +++ b/content/github/creating-cloning-and-archiving-repositories/licensing-a-repository.md @@ -7,6 +7,8 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '*' +topics: + - repositories --- ### Choosing the right license @@ -23,7 +25,7 @@ You're under no obligation to choose a license. However, without a license, the ### Determining the location of your license -Most people place their license text in a file named `LICENSE.txt` (or `LICENSE.md`) in the root of the repository; [here's an example from Hubot](https://github.com/github/hubot/blob/master/LICENSE.md). +Most people place their license text in a file named `LICENSE.txt` (or `LICENSE.md` or `LICENSE.rst`) in the root of the repository; [here's an example from Hubot](https://github.com/github/hubot/blob/master/LICENSE.md). Some projects include information about their license in their README. For example, a project's README may include a note saying "This project is licensed under the terms of the MIT license." diff --git a/content/github/creating-cloning-and-archiving-repositories/limits-for-viewing-content-and-diffs-in-a-repository.md b/content/github/creating-cloning-and-archiving-repositories/limits-for-viewing-content-and-diffs-in-a-repository.md index 0a5310093a..1ebf7e51a8 100644 --- a/content/github/creating-cloning-and-archiving-repositories/limits-for-viewing-content-and-diffs-in-a-repository.md +++ b/content/github/creating-cloning-and-archiving-repositories/limits-for-viewing-content-and-diffs-in-a-repository.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- Most of the limits below affect both {% data variables.product.product_name %} and the API. diff --git a/content/github/creating-cloning-and-archiving-repositories/referencing-and-citing-content.md b/content/github/creating-cloning-and-archiving-repositories/referencing-and-citing-content.md index 6bf832fcb6..be9786624d 100644 --- a/content/github/creating-cloning-and-archiving-repositories/referencing-and-citing-content.md +++ b/content/github/creating-cloning-and-archiving-repositories/referencing-and-citing-content.md @@ -5,6 +5,8 @@ redirect_from: - /articles/referencing-and-citing-content versions: free-pro-team: '*' +topics: + - repositories --- ### Issuing a persistent identifier for your repository with Zenodo diff --git a/content/github/customizing-your-github-workflow/github-extensions-and-integrations.md b/content/github/customizing-your-github-workflow/github-extensions-and-integrations.md index 9d49e1b75b..0241703194 100644 --- a/content/github/customizing-your-github-workflow/github-extensions-and-integrations.md +++ b/content/github/customizing-your-github-workflow/github-extensions-and-integrations.md @@ -30,12 +30,20 @@ With the {% data variables.product.prodname_dotcom %} for Visual Studio Code ext ### Project management tools -You can integrate your {% data variables.product.product_name %} personal account or organization with third-party project management tools, such as Jira or Slack. +You can integrate your {% data variables.product.product_name %} personal account or organization with third-party project management tools, such as Jira. #### Jira Cloud and {% data variables.product.product_name %}.com integration You can integrate Jira Cloud with your personal or organization account to scan commits and pull requests, creating relevant metadata and hyperlinks in any mentioned Jira issues. For more information, visit the [Jira integration app](https://github.com/marketplace/jira-software-github) in the marketplace. +### Team communication tools + +You can integrate your {% data variables.product.product_name %} personal account or organization with third-party team communication tools, such as Slack or Microsoft Teams. + #### Slack and {% data variables.product.product_name %} integration You can integrate Slack with your personal or organization account to subscribe for notifications, close or open issues, and provide rich references to issues and pull requests without leaving Slack. For more information, visit the [Slack integration app](https://github.com/marketplace/slack-github) in the marketplace. + +#### Microsoft Teams and {% data variables.product.product_name %} integration + +You can integrate Microsoft Teams with your personal or organization account to access information about {% data variables.product.product_name %} alongside wider team communication. When you integrate Microsoft Teams with {% data variables.product.product_name %}, you can subscribe for notifications, close or open issues, and provide rich references to issues and pull requests without leaving Microsoft Teams. For more information, visit the [Microsoft Teams integration app](https://appsource.microsoft.com/en-us/product/office/WA200002077) in Microsoft AppSource. diff --git a/content/github/developing-online-with-codespaces/about-billing-for-codespaces.md b/content/github/developing-online-with-codespaces/about-billing-for-codespaces.md index 22648b2242..c7553618ce 100644 --- a/content/github/developing-online-with-codespaces/about-billing-for-codespaces.md +++ b/content/github/developing-online-with-codespaces/about-billing-for-codespaces.md @@ -4,6 +4,8 @@ intro: 'When {% data variables.product.prodname_codespaces %} becomes generally product: '{% data reusables.gated-features.codespaces %}' versions: free-pro-team: '*' +topics: + - codespaces --- {% data reusables.codespaces.release-stage %} diff --git a/content/github/developing-online-with-codespaces/about-codespaces.md b/content/github/developing-online-with-codespaces/about-codespaces.md index c711a28763..133a2f95f3 100644 --- a/content/github/developing-online-with-codespaces/about-codespaces.md +++ b/content/github/developing-online-with-codespaces/about-codespaces.md @@ -6,6 +6,8 @@ redirect_from: - /github/developing-online-with-github-codespaces/about-github-codespaces versions: free-pro-team: '*' +topics: + - codespaces --- {% note %} diff --git a/content/github/developing-online-with-codespaces/configuring-codespaces-for-your-project.md b/content/github/developing-online-with-codespaces/configuring-codespaces-for-your-project.md index 07781dde1b..0c63b670ab 100644 --- a/content/github/developing-online-with-codespaces/configuring-codespaces-for-your-project.md +++ b/content/github/developing-online-with-codespaces/configuring-codespaces-for-your-project.md @@ -7,6 +7,8 @@ redirect_from: - /github/developing-online-with-github-codespaces/configuring-github-codespaces-for-your-project versions: free-pro-team: '*' +topics: + - codespaces --- {% data reusables.codespaces.release-stage %} diff --git a/content/github/developing-online-with-codespaces/creating-a-codespace.md b/content/github/developing-online-with-codespaces/creating-a-codespace.md index ff22cc9ec4..11f694ab41 100644 --- a/content/github/developing-online-with-codespaces/creating-a-codespace.md +++ b/content/github/developing-online-with-codespaces/creating-a-codespace.md @@ -7,6 +7,8 @@ redirect_from: - /github/developing-online-with-github-codespaces/creating-a-codespace versions: free-pro-team: '*' +topics: + - codespaces --- {% data reusables.codespaces.release-stage %} diff --git a/content/github/developing-online-with-codespaces/deleting-a-codespace.md b/content/github/developing-online-with-codespaces/deleting-a-codespace.md index db9fe05a45..3479d7ede0 100644 --- a/content/github/developing-online-with-codespaces/deleting-a-codespace.md +++ b/content/github/developing-online-with-codespaces/deleting-a-codespace.md @@ -7,6 +7,8 @@ redirect_from: - /github/developing-online-with-github-codespaces/deleting-a-codespace versions: free-pro-team: '*' +topics: + - codespaces --- {% data reusables.codespaces.release-stage %} diff --git a/content/github/developing-online-with-codespaces/developing-in-a-codespace.md b/content/github/developing-online-with-codespaces/developing-in-a-codespace.md index a9df2f093f..f40aa202bc 100644 --- a/content/github/developing-online-with-codespaces/developing-in-a-codespace.md +++ b/content/github/developing-online-with-codespaces/developing-in-a-codespace.md @@ -7,6 +7,8 @@ redirect_from: - /github/developing-online-with-github-codespaces/developing-in-a-codespace versions: free-pro-team: '*' +topics: + - codespaces --- {% data reusables.codespaces.release-stage %} diff --git a/content/github/developing-online-with-codespaces/index.md b/content/github/developing-online-with-codespaces/index.md index 1ec4ada121..c0a39439e1 100644 --- a/content/github/developing-online-with-codespaces/index.md +++ b/content/github/developing-online-with-codespaces/index.md @@ -7,6 +7,8 @@ redirect_from: - /github/developing-online-with-github-codespaces versions: free-pro-team: '*' +topics: + - codespaces --- {% data reusables.codespaces.release-stage %} diff --git a/content/github/developing-online-with-codespaces/managing-access-and-security-for-codespaces.md b/content/github/developing-online-with-codespaces/managing-access-and-security-for-codespaces.md index a364ad3050..1db7b63da3 100644 --- a/content/github/developing-online-with-codespaces/managing-access-and-security-for-codespaces.md +++ b/content/github/developing-online-with-codespaces/managing-access-and-security-for-codespaces.md @@ -4,6 +4,8 @@ intro: You can manage the repositories that codespaces can access. product: '{% data reusables.gated-features.codespaces %}' versions: free-pro-team: '*' +topics: + - codespaces --- {% note %} diff --git a/content/github/developing-online-with-codespaces/managing-encrypted-secrets-for-codespaces.md b/content/github/developing-online-with-codespaces/managing-encrypted-secrets-for-codespaces.md index 4fc3f4126f..f99fc17ff1 100644 --- a/content/github/developing-online-with-codespaces/managing-encrypted-secrets-for-codespaces.md +++ b/content/github/developing-online-with-codespaces/managing-encrypted-secrets-for-codespaces.md @@ -1,9 +1,11 @@ --- title: Managing encrypted secrets for Codespaces -intro: You can store sensitive information, like tokens, that you want to access in your codespaces via environment variables. +intro: 'You can store sensitive information, like tokens, that you want to access in your codespaces via environment variables.' product: '{% data reusables.gated-features.codespaces %}' versions: free-pro-team: '*' +topics: + - codespaces --- {% note %} @@ -12,6 +14,7 @@ versions: {% endnote %} + ### About encrypted secrets for {% data variables.product.prodname_codespaces %} You can add encrypted secrets to your user account that you want to use in your codespaces. For example, you may want to store and access the following sensitive information as encrypted secrets. @@ -24,6 +27,12 @@ You can choose which repositories should have access to each secret. Then, you c ### Adding a secret +{% note %} + +**Note:** Tokens starting with GITHUB_ are reserved + +{% endnote %} + {% data reusables.user_settings.access_settings %} {% data reusables.user_settings.codespaces-tab %} 1. To the right of "Codespaces secrets", click **New secret**. diff --git a/content/github/developing-online-with-codespaces/managing-gpg-verification-for-codespaces.md b/content/github/developing-online-with-codespaces/managing-gpg-verification-for-codespaces.md index 41c3420829..2aeb8deb09 100644 --- a/content/github/developing-online-with-codespaces/managing-gpg-verification-for-codespaces.md +++ b/content/github/developing-online-with-codespaces/managing-gpg-verification-for-codespaces.md @@ -1,9 +1,11 @@ --- title: Managing GPG verification for Codespaces -intro: You can allow {% data variables.product.company_short %} to automatically use GPG to sign commits you make in your codespaces, so other people can be confident that the changes come from a trusted source. +intro: 'You can allow {% data variables.product.company_short %} to automatically use GPG to sign commits you make in your codespaces, so other people can be confident that the changes come from a trusted source.' product: '{% data reusables.gated-features.codespaces %}' versions: free-pro-team: '*' +topics: + - codespaces --- {% note %} diff --git a/content/github/developing-online-with-codespaces/personalizing-codespaces-for-your-account.md b/content/github/developing-online-with-codespaces/personalizing-codespaces-for-your-account.md index 2539fd6762..57ec686acc 100644 --- a/content/github/developing-online-with-codespaces/personalizing-codespaces-for-your-account.md +++ b/content/github/developing-online-with-codespaces/personalizing-codespaces-for-your-account.md @@ -7,6 +7,8 @@ redirect_from: - /github/developing-online-with-github-codespaces/personalizing-github-codespaces-for-your-account versions: free-pro-team: '*' +topics: + - codespaces --- {% data reusables.codespaces.release-stage %} diff --git a/content/github/developing-online-with-codespaces/troubleshooting-your-codespace.md b/content/github/developing-online-with-codespaces/troubleshooting-your-codespace.md index 2daf7c2607..400c039188 100644 --- a/content/github/developing-online-with-codespaces/troubleshooting-your-codespace.md +++ b/content/github/developing-online-with-codespaces/troubleshooting-your-codespace.md @@ -6,6 +6,8 @@ redirect_from: - /github/developing-online-with-github-codespaces/troubleshooting-your-codespace versions: free-pro-team: '*' +topics: + - codespaces --- {% data reusables.codespaces.release-stage %} diff --git a/content/github/developing-online-with-codespaces/using-codespaces-in-visual-studio-code.md b/content/github/developing-online-with-codespaces/using-codespaces-in-visual-studio-code.md index cc973aea5e..a190ef1962 100644 --- a/content/github/developing-online-with-codespaces/using-codespaces-in-visual-studio-code.md +++ b/content/github/developing-online-with-codespaces/using-codespaces-in-visual-studio-code.md @@ -6,6 +6,8 @@ redirect_from: - /github/developing-online-with-codespaces/connecting-to-your-codespace-from-visual-studio-code versions: free-pro-team: '*' +topics: + - codespaces --- {% data reusables.codespaces.release-stage %} diff --git a/content/github/developing-online-with-codespaces/using-codespaces-in-visual-studio.md b/content/github/developing-online-with-codespaces/using-codespaces-in-visual-studio.md index 64cedbedb9..084fc31a53 100644 --- a/content/github/developing-online-with-codespaces/using-codespaces-in-visual-studio.md +++ b/content/github/developing-online-with-codespaces/using-codespaces-in-visual-studio.md @@ -4,6 +4,8 @@ intro: 'You can develop in your codespace directly in {% data variables.product. product: '{% data reusables.gated-features.codespaces %}' versions: free-pro-team: '*' +topics: + - codespaces --- {% note %} diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/about-code-scanning.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/about-code-scanning.md index 9684696ef4..8599ca24b2 100644 --- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/about-code-scanning.md +++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/about-code-scanning.md @@ -7,6 +7,9 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' +topics: + - security --- {% data reusables.code-scanning.beta %} @@ -35,7 +38,7 @@ You can use {% data variables.product.prodname_code_scanning %} with {% data var {% data reusables.code-scanning.supported-languages %} -You can view and contribute to the queries for {% data variables.product.prodname_code_scanning %} in the [`github/codeql`](https://github.com/github/codeql) repository. For more information, see [{% data variables.product.prodname_codeql %} queries](https://help.semmle.com/QL/learn-ql/writing-queries/writing-queries.html) in the {% data variables.product.prodname_codeql %} documentation. +You can view and contribute to the queries for {% data variables.product.prodname_code_scanning %} in the [`github/codeql`](https://github.com/github/codeql) repository. For more information, see [{% data variables.product.prodname_codeql %} queries](https://codeql.github.com/docs/writing-codeql-queries/codeql-queries/) in the {% data variables.product.prodname_codeql %} documentation. {% if currentVersion == "free-pro-team@latest" %} diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/about-integration-with-code-scanning.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/about-integration-with-code-scanning.md index 87abca9e6d..5869a83fc0 100644 --- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/about-integration-with-code-scanning.md +++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/about-integration-with-code-scanning.md @@ -6,6 +6,9 @@ product: '{% data reusables.gated-features.code-scanning %}' versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' +topics: + - security --- {% data reusables.code-scanning.beta %} @@ -17,7 +20,7 @@ If you use a third-party static analysis tool that can produce results as Static ### Integrations with webhooks -You can use {% data variables.product.prodname_code_scanning %} webhooks to build or set up integrations, such as [{% data variables.product.prodname_github_app %}s](/apps/building-github-apps/) or [{% data variables.product.prodname_oauth_app %}s](/apps/building-oauth-apps/), that subscribe to {% data variables.product.prodname_code_scanning %} events in your repository. For example, you could build an integration that creates an issue on {% data variables.product.product_location %} or sends you a Slack notification when a new {% data variables.product.prodname_code_scanning %} alert is added in your repository. For more information, see "[Creating webhooks](/developers/webhooks-and-events/creating-webhooks)" and "[Webhook events and payloads](/developers/webhooks-and-events/webhook-events-and-payloads#code_scanning_alert)." +You can use {% data variables.product.prodname_code_scanning %} webhooks to build or set up integrations, such as [{% data variables.product.prodname_github_app %}s](/apps/building-github-apps/) or [{% data variables.product.prodname_oauth_app %}s](/apps/building-oauth-apps/), that subscribe to {% data variables.product.prodname_code_scanning %} events in your repository. For example, you could build an integration that creates an issue on {% data variables.product.product_name %} or sends you a Slack notification when a new {% data variables.product.prodname_code_scanning %} alert is added in your repository. For more information, see "[Creating webhooks](/developers/webhooks-and-events/creating-webhooks)" and "[Webhook events and payloads](/developers/webhooks-and-events/webhook-events-and-payloads#code_scanning_alert)." ### Further reading diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/automatically-scanning-your-code-for-vulnerabilities-and-errors.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/automatically-scanning-your-code-for-vulnerabilities-and-errors.md index 2f126e4f1c..cac898efaf 100644 --- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/automatically-scanning-your-code-for-vulnerabilities-and-errors.md +++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/automatically-scanning-your-code-for-vulnerabilities-and-errors.md @@ -7,5 +7,8 @@ product: '{% data reusables.gated-features.code-scanning %}' versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' +topics: + - security --- diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning.md index c0231c0766..26d4311360 100644 --- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning.md +++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning.md @@ -7,6 +7,9 @@ miniTocMaxHeadingLevel: 4 versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' +topics: + - security --- {% data reusables.code-scanning.beta %} @@ -14,9 +17,9 @@ versions: ### About {% data variables.product.prodname_code_scanning %} configuration -You can run {% data variables.product.prodname_code_scanning %} within {% data variables.product.product_location %}, using {% data variables.product.prodname_actions %}, or from your continuous integration (CI) system, using the {% data variables.product.prodname_codeql_runner %}. For more information about {% data variables.product.prodname_actions %}, see "[About {% data variables.product.prodname_actions %}](/actions/getting-started-with-github-actions/about-github-actions)." For more information about the {% data variables.product.prodname_codeql_runner %}, see "[Running {% data variables.product.prodname_code_scanning %} in your CI system](/github/finding-security-vulnerabilities-and-errors-in-your-code/running-codeql-code-scanning-in-your-ci-system)." +You can run {% data variables.product.prodname_code_scanning %} on {% data variables.product.product_name %}, using {% data variables.product.prodname_actions %}, or from your continuous integration (CI) system, using the {% data variables.product.prodname_codeql_runner %}. For more information about {% data variables.product.prodname_actions %}, see "[About {% data variables.product.prodname_actions %}](/actions/getting-started-with-github-actions/about-github-actions)." For more information about the {% data variables.product.prodname_codeql_runner %}, see "[Running {% data variables.product.prodname_code_scanning %} in your CI system](/github/finding-security-vulnerabilities-and-errors-in-your-code/running-codeql-code-scanning-in-your-ci-system)." -This article is about running {% data variables.product.prodname_code_scanning %} within {% if currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_ghe_server %}{% else %}{% data variables.product.prodname_dotcom %}{% endif %}. +This article is about running {% data variables.product.prodname_code_scanning %} on {% data variables.product.product_name %}. Before you can configure {% data variables.product.prodname_code_scanning %} for a repository, you must set up {% data variables.product.prodname_code_scanning %} by adding a {% data variables.product.prodname_actions %} workflow to the repository. For more information, see "[Setting up {% data variables.product.prodname_code_scanning %} for a repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/setting-up-code-scanning-for-a-repository)." @@ -203,13 +206,17 @@ jobs: {% data reusables.code-scanning.run-additional-queries %} -To add one or more queries, add a `with: queries:` entry within the `uses: github/codeql-action/init@v1` section of the workflow. +To add one or more queries, add a `with: queries:` entry within the `uses: github/codeql-action/init@v1` section of the workflow. If the queries are in a private repository, use the `external-repository-token` parameter to specify a token that has access to the private repository. +{% raw %} ``` yaml - uses: github/codeql-action/init@v1 with: queries: COMMA-SEPARATED LIST OF PATHS + # Optional. Provide a token to access private repositories. + external-repository-token: ${{ secrets.ACCESS_TOKEN }} ``` +{% endraw %} You can also specify query suites in the value of `queries`. Query suites are collections of queries, usually grouped by purpose or language. @@ -219,12 +226,15 @@ If you are also using a configuration file for custom settings, any additional q In the following example, the `+` symbol ensures that the specified additional queries are used together with any queries specified in the referenced configuration file. +{% raw %} ``` yaml - uses: github/codeql-action/init@v1 with: config-file: ./.github/codeql/codeql-config.yml queries: +security-and-quality,octo-org/python-qlpack/show_ifs.ql@main + external-repository-token: ${{ secrets.ACCESS_TOKEN }} ``` +{% endraw %} ### Using a custom configuration file @@ -238,9 +248,19 @@ In the workflow file, use the `config-file` parameter of the `init` action to sp config-file: ./.github/codeql/codeql-config.yml ``` -The configuration file can be located within the local repository, or in a remote, public repository. Using a remote, public repository allows you to specify configuration options for multiple repositories in a single place. When you reference a configuration file located in a remote repository, you can use the _OWNER/REPOSITORY/FILENAME@BRANCH_ syntax. For example, _monacorp/shared/codeql-config.yml@main_. +{% data reusables.code-scanning.custom-configuration-file %} -The settings in the file are written in YAML format. +If the configuration file is located in an external private repository, use the `external-repository-token` parameter of the `init` action to specify a token that has access to the private repository. + +{% raw %} +```yaml +uses: github/codeql-action/init@v1 +with: + external-repository-token: ${{ secrets.ACCESS_TOKEN }} +``` +{% endraw %} + +The settings in the configuration file are written in YAML format. #### Specifying additional queries @@ -296,25 +316,6 @@ You can quickly analyze small portions of a monorepo when you modify code in spe {% data reusables.code-scanning.autobuild-add-build-steps %} For more information about how to configure {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} for compiled languages, see "[Configuring the {% data variables.product.prodname_codeql %} workflow for compiled languages](/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-the-codeql-workflow-for-compiled-languages)." -### Accessing private repositories - -If your workflow for {% data variables.product.prodname_code_scanning %} accesses a private repository, other than the repository that contains the workflow, you'll need to configure Git to authenticate with a personal access token. Define the secret in the runner environment by using `jobs..steps[*].env` in your workflow before any {% data variables.product.prodname_codeql %} actions. For more information, see "[Creating a personal access token for the command line](/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line)" and "[Creating and storing encrypted secrets](/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets)." - -For example, the following configuration has Git replace the full URLs to the `ghost/foo`, `ghost/bar`, and `ghost/baz` repositories on {% data variables.product.prodname_dotcom_the_website %} with URLs that include the personal access token that you store in the `ACCESS_TOKEN` environment variable. - -{% raw %} -```yaml -steps: -- name: Configure access to private repositories - env: - TOKEN: ${{ secrets.ACCESS_TOKEN }} - run: | - git config --global url."https://${TOKEN}@github.com/ghost/foo".insteadOf "https://github.com/ghost/foo" - git config --global url."https://${TOKEN}@github.com/ghost/bar".insteadOf "https://github.com/ghost/bar" - git config --global url."https://${TOKEN}@github.com/ghost/baz".insteadOf "https://github.com/ghost/baz" -``` -{% endraw %} - ### Uploading {% data variables.product.prodname_code_scanning %} data to {% data variables.product.prodname_dotcom %} {% data variables.product.prodname_dotcom %} can display code analysis data generated externally by a third-party tool. You can upload code analysis data with the `upload-sarif` action. For more information, see "[Uploading a SARIF file to GitHub](/github/finding-security-vulnerabilities-and-errors-in-your-code/uploading-a-sarif-file-to-github)." diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-codeql-code-scanning-in-your-ci-system.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-codeql-code-scanning-in-your-ci-system.md index 7a8c9e9014..dae62003f2 100644 --- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-codeql-code-scanning-in-your-ci-system.md +++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-codeql-code-scanning-in-your-ci-system.md @@ -9,6 +9,9 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' +topics: + - security --- {% data reusables.code-scanning.beta-codeql-runner %} @@ -34,12 +37,18 @@ To customize the way the {% data variables.product.prodname_codeql_runner %} sca Scanning code whenever a pull request is created prevents developers from introducing new vulnerabilities and errors into the code. -To scan a pull request, run the `analyze` command and use the `--ref` flag to specify the pull request. The reference is `refs/pull//head` or `refs/pull//merge`, depending on whether you have checked out the HEAD commit of the pull request branch or a merge commit with the base branch. +To scan a pull request, run the `analyze` command and use the `--ref` flag to specify the pull request. The reference is `refs/pull//head` or `refs/pull//merge`, depending on whether you have checked out the HEAD commit of the pull request branch or a merge commit with the base branch. ```shell -$ /path/to-runner/codeql-runner-linux analyze --ref refs/pull/42/head +$ /path/to-runner/codeql-runner-linux analyze --ref refs/pull/42/merge ``` +{% note %} + +**Note**: If you analyze code with a third-party tool and want the results to appear as pull request checks, you must run the `upload` command and use the `--ref` flag to specify the pull request instead of the branch. The reference is `refs/pull//head` or `refs/pull//merge`. + +{% endnote %} + ### Overriding automatic language detection The {% data variables.product.prodname_codeql_runner %} automatically detects and scans code written in the supported languages. @@ -85,6 +94,8 @@ Use the `--config-file` flag of the `init` command to specify the configuration $ /path/to-runner/codeql-runner-linux init --config-file .github/codeql/codeql-config.yml ``` +{% data reusables.code-scanning.custom-configuration-file %} + #### Example configuration files {% data reusables.code-scanning.example-configuration-files %} @@ -107,7 +118,9 @@ If the `autobuild` command can't build your code, you can run the build steps yo By default, the {% data variables.product.prodname_codeql_runner %} uploads results from {% data variables.product.prodname_code_scanning %} when you run the `analyze` command. You can also upload SARIF files separately, by using the `upload` command. -Once you've uploaded the data, {% data variables.product.prodname_dotcom %} displays the alerts in your repository. For more information, see "[Managing {% data variables.product.prodname_code_scanning %} alerts for your repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository)." +Once you've uploaded the data, {% data variables.product.prodname_dotcom %} displays the alerts in your repository. +- If you uploaded to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see "[Triaging code scanning alerts in pull requests](/github/finding-security-vulnerabilities-and-errors-in-your-code/triaging-code-scanning-alerts-in-pull-requests)." +- If you uploaded to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see "[Managing code scanning alerts for your repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository)." ### {% data variables.product.prodname_codeql_runner %} command reference @@ -145,7 +158,7 @@ Attempts to build the code for the compiled languages C/C++, C#, and Java. For t #### `analyze` -Analyzes the code in the {% data variables.product.prodname_codeql %} databases and uploads results to {% data variables.product.product_location %}. +Analyzes the code in the {% data variables.product.prodname_codeql %} databases and uploads results to {% data variables.product.product_name %}. | Flag | Required | Input value | | ---- |:--------:| ----------- | @@ -155,7 +168,7 @@ Analyzes the code in the {% data variables.product.prodname_codeql %} databases | `--github-url` | ✓ | URL of the {% data variables.product.prodname_dotcom %} instance where your repository is hosted. | | `--github-auth` | ✓ | A {% data variables.product.prodname_github_apps %} token or personal access token. | | `--checkout-path` | | The path to the checkout of your repository. The default is the current working directory. | -| `--no-upload` | | None. Stops the {% data variables.product.prodname_codeql_runner %} from uploading the results to {% data variables.product.product_location %}. | +| `--no-upload` | | None. Stops the {% data variables.product.prodname_codeql_runner %} from uploading the results to {% data variables.product.product_name %}. | | `--output-dir` | | Directory where the output SARIF files are stored. The default is in the directory of temporary files. | | `--ram` | | Amount of memory to use when running queries. The default is to use all available memory. | | `--no-add-snippets` | | None. Excludes code snippets from the SARIF output. | @@ -166,7 +179,7 @@ Analyzes the code in the {% data variables.product.prodname_codeql %} databases #### `upload` -Uploads SARIF files to {% data variables.product.product_location %}. +Uploads SARIF files to {% data variables.product.product_name %}. {% note %} diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-the-codeql-workflow-for-compiled-languages.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-the-codeql-workflow-for-compiled-languages.md index 8dbf60a780..99dabb5999 100644 --- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-the-codeql-workflow-for-compiled-languages.md +++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-the-codeql-workflow-for-compiled-languages.md @@ -10,6 +10,9 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' +topics: + - security --- {% data reusables.code-scanning.beta %} @@ -32,7 +35,10 @@ If your workflow uses a `language` matrix, `autobuild` attempts to build each of {% note %} +{% if currentVersion == "github-ae@latest" %}**Note**: For instructions on how to make sure your {% data variables.actions.hosted_runner %} has the required software installed, see "[Creating custom images](/actions/using-github-hosted-runners/creating-custom-images)." +{% else %} **Note**: If you use self-hosted runners for {% data variables.product.prodname_actions %}, you may need to install additional software to use the `autobuild` process. Additionally, if your repository requires a specific version of a build tool, you may need to install it manually. For more information, see "[Specifications for {% data variables.product.prodname_dotcom %}-hosted runners](/actions/reference/specifications-for-github-hosted-runners/#supported-software)". +{% endif %} {% endnote %} diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/index.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/index.md index 3c5f11b678..3b6825a2db 100644 --- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/index.md +++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/index.md @@ -7,6 +7,9 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' +topics: + - security --- ### Table of Contents diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/integrating-with-code-scanning.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/integrating-with-code-scanning.md index 01a082e501..a463ffdbf6 100644 --- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/integrating-with-code-scanning.md +++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/integrating-with-code-scanning.md @@ -9,5 +9,8 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' +topics: + - security --- diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository.md index 70a5d289e3..a72de426b2 100644 --- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository.md +++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository.md @@ -7,6 +7,7 @@ permissions: 'If you have write permission to a repository you can manage {% dat versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' redirect_from: - /github/managing-security-vulnerabilities/managing-alerts-from-automated-code-scanning - /github/finding-security-vulnerabilities-and-errors-in-your-code/managing-alerts-from-code-scanning diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/running-codeql-code-scanning-in-a-container.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/running-codeql-code-scanning-in-a-container.md index 8b0021e943..004c326f79 100644 --- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/running-codeql-code-scanning-in-a-container.md +++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/running-codeql-code-scanning-in-a-container.md @@ -6,6 +6,9 @@ product: '{% data reusables.gated-features.code-scanning %}' versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' +topics: + - security --- {% data reusables.code-scanning.beta %} diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/running-codeql-code-scanning-in-your-ci-system.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/running-codeql-code-scanning-in-your-ci-system.md index 9ae8a2ddf5..511d7205cd 100644 --- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/running-codeql-code-scanning-in-your-ci-system.md +++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/running-codeql-code-scanning-in-your-ci-system.md @@ -8,6 +8,9 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' +topics: + - security --- @@ -23,9 +26,9 @@ If you use a continuous integration or continuous delivery/deployment (CI/CD) sy {% data reusables.code-scanning.about-code-scanning %} For information, see "[About {% data variables.product.prodname_code_scanning %}](/github/finding-security-vulnerabilities-and-errors-in-your-code/about-code-scanning)." -You can use the {% data variables.product.prodname_codeql_runner %} to run {% data variables.product.prodname_code_scanning %} on code that you're processing in a third-party continuous integration (CI) system. Alternatively, you can use {% data variables.product.prodname_actions %} to run {% data variables.product.prodname_code_scanning %} on {% data variables.product.product_location %}. For information, see "[Setting up {% data variables.product.prodname_code_scanning %} for a repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/setting-up-code-scanning-for-a-repository)." +You can use the {% data variables.product.prodname_codeql_runner %} to run {% data variables.product.prodname_code_scanning %} on code that you're processing in a third-party continuous integration (CI) system. Alternatively, you can use {% data variables.product.prodname_actions %} to run {% data variables.product.prodname_code_scanning %} on {% data variables.product.product_name %}. For information, see "[Setting up {% data variables.product.prodname_code_scanning %} for a repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/setting-up-code-scanning-for-a-repository)." -The {% data variables.product.prodname_codeql_runner %} is a command-line tool that runs {% data variables.product.prodname_codeql %} analysis on a checkout of a {% data variables.product.prodname_dotcom %} repository. You add the runner to your third-party system, then call the runner to analyze code and upload the results to {% data variables.product.product_location %}. These results are displayed as {% data variables.product.prodname_code_scanning %} alerts in the repository. +The {% data variables.product.prodname_codeql_runner %} is a command-line tool that runs {% data variables.product.prodname_codeql %} analysis on a checkout of a {% data variables.product.prodname_dotcom %} repository. You add the runner to your third-party system, then call the runner to analyze code and upload the results to {% data variables.product.product_name %}. These results are displayed as {% data variables.product.prodname_code_scanning %} alerts in the repository. {% note %} @@ -40,7 +43,7 @@ The {% data variables.product.prodname_codeql_runner %} is a command-line tool t ### Downloading the {% data variables.product.prodname_codeql_runner %} -You can download the {% data variables.product.prodname_codeql_runner %} from https://github.com/github/codeql-action/releases. On some operating systems, you may need to change permissions for the downloaded file before you can run it. +You can download the {% data variables.product.prodname_codeql_runner %} from https://{% if currentVersion == "enterprise-server@2.22" or currentVersion == "free-pro-team@latest" %}github.com{% else %}HOSTNAME{% endif %}/github/codeql-action/releases. On some operating systems, you may need to change permissions for the downloaded file before you can run it. On Linux: @@ -59,33 +62,33 @@ On Windows, the `codeql-runner-win.exe` file usually requires no change to permi ### Adding the {% data variables.product.prodname_codeql_runner %} to your CI system -Once you download the {% data variables.product.prodname_codeql_runner %} and verify that it can be executed, you should make the runner available to each CI server that you intend to use for {% data variables.product.prodname_code_scanning %}. For example, you might configure each server to copy the runner from a central, internal location. Alternatively, you could use the REST API to get the runner directly from GitHub, for example: +Once you download the {% data variables.product.prodname_codeql_runner %} and verify that it can be executed, you should make the runner available to each CI server that you intend to use for {% data variables.product.prodname_code_scanning %}. For example, you might configure each server to copy the runner from a central, internal location. Alternatively, you could use the REST API to get the runner directly from {% data variables.product.prodname_dotcom %}, for example: ```shell -wget https://github.com/github/codeql-action/releases/latest/download/codeql-runner-linux +wget https://{% if currentVersion == "enterprise-server@2.22" or currentVersion == "free-pro-team@latest" %}github.com{% else %}HOSTNAME{% endif %}/github/codeql-action/releases/latest/download/codeql-runner-linux chmod +x codeql-runner-linux ``` In addition to this, each CI server also needs: -- A {% data variables.product.prodname_github_app %} or personal access token for the {% data variables.product.prodname_codeql_runner %} to use. You must use an access token with the `security_events` scope, or a {% data variables.product.prodname_github_app %} with the `security_events` write permission. For information, see "[Building {% data variables.product.prodname_github_apps %}](/developers/apps/building-github-apps)" and "[Creating a personal access token](/github/authenticating-to-github/creating-a-personal-access-token)." +- A {% data variables.product.prodname_github_app %} or personal access token for the {% data variables.product.prodname_codeql_runner %} to use. You must use an access token with the `repo` scope, or a {% data variables.product.prodname_github_app %} with the `security_events` write permission, and `metadata` and `contents` read permissions. For information, see "[Building {% data variables.product.prodname_github_apps %}](/developers/apps/building-github-apps)" and "[Creating a personal access token](/github/authenticating-to-github/creating-a-personal-access-token)." - Access to the {% data variables.product.prodname_codeql %} bundle associated with this release of the {% data variables.product.prodname_codeql_runner %}. This package contains queries and libraries needed for {% data variables.product.prodname_codeql %} analysis, plus the {% data variables.product.prodname_codeql %} CLI, which is used internally by the runner. For information, see "[{% data variables.product.prodname_codeql %} CLI](https://codeql.github.com/docs/codeql-cli/)." The options for providing access to the {% data variables.product.prodname_codeql %} bundle are: -1. Allow the CI servers access to {% data variables.product.prodname_dotcom_the_website %} so that the {% data variables.product.prodname_codeql_runner %} can download the bundle automatically. -1. Manually download/extract the bundle, store it with other central resources, and use the `--codeql-path` flag to specify the location of the bundle in calls to initialize the {% data variables.product.prodname_codeql_runner %}. -{% if enterpriseServerVersions contains currentVersion %} -1. You can mirror the `github/codeql-action` repository on {% data variables.product.product_location %}. Unless you specify the `--codeql-path` flag, the runner automatically checks for the bundle in this location and on {% data variables.product.prodname_dotcom_the_website %}.{% endif %} +1. Allow the CI servers access to https://{% if currentVersion == "enterprise-server@2.22" or currentVersion == "free-pro-team@latest" %}github.com{% else %}HOSTNAME{% endif %}/github/codeql-action so that the {% data variables.product.prodname_codeql_runner %} can download the bundle automatically. +{% if currentVersion == "enterprise-server@2.22" %} +1. Mirror the `github/codeql-action` repository on {% data variables.product.product_name %}. Unless you specify the `--codeql-path` flag, the runner automatically checks for the bundle in this location and on {% data variables.product.prodname_dotcom_the_website %}.{% endif %} +1. Manually download/extract the bundle, store it with other central resources, and use the `--codeql-path` flag to specify the location of the bundle in calls to initialize the {% data variables.product.prodname_codeql_runner %}. ### Calling the {% data variables.product.prodname_codeql_runner %} You should call the {% data variables.product.prodname_codeql_runner %} from the checkout location of the repository you want to analyze. The two main commands are: 1. `init` required to initialize the runner and create a {% data variables.product.prodname_codeql %} database for each language to be analyzed. These databases are populated and analyzed by subsequent commands. -1. `analyze` required to populate the {% data variables.product.prodname_codeql %} databases, analyze them, and upload results to {% data variables.product.product_location %}. +1. `analyze` required to populate the {% data variables.product.prodname_codeql %} databases, analyze them, and upload results to {% data variables.product.product_name %}. -For both commands, you must specify the URL of {% data variables.product.product_location %}, the repository *OWNER/NAME*, and the GitHub Apps or personal access token to use for authentication. You also need to specify the location of the CodeQL bundle unless the CI server has access to download it directly from the `github/codeql-action` repository on {% data variables.product.prodname_dotcom_the_website %}{% if enterpriseServerVersions contains currentVersion %} or mirrored on {% data variables.product.product_location %}{% endif %}. +For both commands, you must specify the URL of {% data variables.product.product_name %}, the repository *OWNER/NAME*, and the {% data variables.product.prodname_github_apps %} or personal access token to use for authentication. You also need to specify the location of the CodeQL bundle, unless the CI server has access to download it directly from the `github/codeql-action` repository. You can configure where the {% data variables.product.prodname_codeql_runner %} stores the CodeQL bundle for future analysis on a server using the `--tools-dir` flag and where it stores temporary files during analysis using `--temp-dir`. @@ -97,6 +100,8 @@ To view the command-line reference for the runner, use the `-h` flag. For exampl This example runs {% data variables.product.prodname_codeql %} analysis on a Linux CI server for the `octo-org/example-repo` repository hosted on `{% data variables.command_line.git_url_example %}`. The process is very simple because the repository contains only languages that can be analyzed by {% data variables.product.prodname_codeql %} directly, without being built (that is, Go, JavaScript, Python, and TypeScript). +In this example, the server has access to download the {% data variables.product.prodname_codeql %} bundle directly from the `github/codeql-action` repository, so there is no need to use the `--codeql-path` flag. + 1. Check out the repository to analyze. 1. Move into the directory where the repository is checked out. 1. Initialize the {% data variables.product.prodname_codeql_runner %} and create {% data variables.product.prodname_codeql %} databases for the languages detected. @@ -109,19 +114,7 @@ This example runs {% data variables.product.prodname_codeql %} analysis on a Lin > Created CodeQL database at /srv/checkout/example-repo/codeql-runner/codeql_databases/javascript. ``` -1. Populate the {% data variables.product.prodname_codeql_runner %} databases, analyze them, and upload the results to {% data variables.product.product_name %}. - - ```shell - $ /path/to-runner/codeql-runner-linux analyze --repository octo-org/example-repo - --github-url {% data variables.command_line.git_url_example %} --github-auth TOKEN - --commit 5b6a3078b31dc346e5ce7b86837d6abbe7a18bbd --ref refs/heads/main - > Finalizing database creation - > ... - > POST /repos/octo-org/example-repo/code-scanning/sarifs - 202 in 786ms - > Successfully uploaded results - ``` - -The server has access to download the {% data variables.product.prodname_codeql %} bundle directly from the `github/codeql-action` repository on {% data variables.product.prodname_dotcom_the_website %}{% if enterpriseServerVersions contains currentVersion %} or mirrored on {% data variables.product.product_location %}{% endif %}, so there is no need to use the `--codeql-path` flag. When the analysis is complete, the {% data variables.product.prodname_codeql_runner %} uploads the results to the {% data variables.product.prodname_code_scanning %} view. For more information, see "[Managing {% data variables.product.prodname_code_scanning %} alerts for your repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository)." +{% data reusables.code-scanning.codeql-runner-analyze-example %} #### Compiled language example @@ -138,28 +131,19 @@ This example is similar to the previous example, however this time the repositor > ... > CodeQL environment output to "/srv/checkout/example-repo-2/codeql-runner/codeql-env.json" and "/srv/checkout/example-repo-2/codeql-runner/codeql-env.sh". - Please export these variables to future processes so that CodeQL can monitor the build, for example by running " - . /srv/checkout/example-repo-2/codeql-runner/codeql-env.sh". + Please export these variables to future processes so that CodeQL can monitor the build, for example by running + ". /srv/checkout/example-repo-2/codeql-runner/codeql-env.sh". ``` -1. Run the script generated by the `init` action to set up the environment to monitor the build. +1. Source the script generated by the `init` action to set up the environment to monitor the build. Note the leading dot and space in the following code snippet. ```shell $ . /srv/checkout/example-repo-2/codeql-runner/codeql-env.sh ``` -1. Build the code. -1. Populate the {% data variables.product.prodname_codeql %} databases, analyze them, and upload the results to GitHub. +1. Build the code. On macOS, you need to prefix the build command with the environment variable `$CODEQL_RUNNER`. For more information, see "[Troubleshooting CodeQL code scanning in your CI system](/github/finding-security-vulnerabilities-and-errors-in-your-code/troubleshooting-codeql-code-scanning-in-your-ci-system#no-code-found-during-the-build)." - ```shell - $ /path/to-runner/codeql-runner-linux analyze --repository octo-org/example-repo-2 - --github-url {% data variables.command_line.git_url_example %} --github-auth TOKEN - --commit ae7b655ef30b50fb726ae7b3daa79571a39d194d --ref refs/heads/main - > Finalizing database creation - > ... - > POST /repos/octo-org/example-repo-2/code-scanning/sarifs - 202 in 573ms - > Successfully uploaded results - ``` +{% data reusables.code-scanning.codeql-runner-analyze-example %} {% note %} diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/sarif-support-for-code-scanning.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/sarif-support-for-code-scanning.md index 2d6783b803..8bdd7005a8 100644 --- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/sarif-support-for-code-scanning.md +++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/sarif-support-for-code-scanning.md @@ -8,6 +8,9 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' +topics: + - security --- {% data reusables.code-scanning.beta %} diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/setting-up-code-scanning-for-a-repository.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/setting-up-code-scanning-for-a-repository.md index c23538ba91..fb199b31c0 100644 --- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/setting-up-code-scanning-for-a-repository.md +++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/setting-up-code-scanning-for-a-repository.md @@ -11,6 +11,9 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' +topics: + - security --- {% data reusables.code-scanning.beta %} @@ -28,10 +31,10 @@ You decide how to generate {% data variables.product.prodname_code_scanning %} a {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-security %} -3. To the right of "{% data variables.product.prodname_code_scanning_capc %}", click **Set up {% data variables.product.prodname_code_scanning %}**. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}If {% data variables.product.prodname_code_scanning %} is missing, you need to ask an organization owner or repository administrator to enable {% data variables.product.prodname_GH_advanced_security %}. For more information, see "[Managing security and analysis settings for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization)" or "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)."{% endif %} +3. To the right of "{% data variables.product.prodname_code_scanning_capc %} alerts", click **Set up {% data variables.product.prodname_code_scanning %}**. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}If {% data variables.product.prodname_code_scanning %} is missing, you need to ask an organization owner or repository administrator to enable {% data variables.product.prodname_GH_advanced_security %}. For more information, see "[Managing security and analysis settings for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization)" or "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)."{% endif %} !["Set up {% data variables.product.prodname_code_scanning %}" button to the right of "{% data variables.product.prodname_code_scanning_capc %}" in the Security Overview](/assets/images/help/security/overview-set-up-code-scanning.png) -4. Under "Get started with {% data variables.product.prodname_code_scanning %}", click **Set up this workflow** on the {% data variables.product.prodname_codeql_workflow %} or on a third-party workflow. - !["Set up this workflow" button under "Get started with {% data variables.product.prodname_code_scanning %}" heading](/assets/images/help/repository/code-scanning-set-up-this-workflow.png) +4. Under "Get started with {% data variables.product.prodname_code_scanning %}", click **Set up this workflow** on the {% data variables.product.prodname_codeql_workflow %} or on a third-party workflow. + !["Set up this workflow" button under "Get started with {% data variables.product.prodname_code_scanning %}" heading](/assets/images/help/repository/code-scanning-set-up-this-workflow.png){% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}Workflows are only displayed if they are relevant for the programming languages detected in the repository. The {% data variables.product.prodname_codeql_workflow %} is always displayed, but the "Set up this workflow" button is only enabled if {% data variables.product.prodname_codeql %} analysis supports the languages present in the repository.{% endif %} 5. To customize how {% data variables.product.prodname_code_scanning %} scans your code, edit the workflow. Generally you can commit the {% data variables.product.prodname_codeql_workflow %} without making any changes to it. However, many of the third-party workflows require additional configuration, so read the comments in the workflow before committing. diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/triaging-code-scanning-alerts-in-pull-requests.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/triaging-code-scanning-alerts-in-pull-requests.md index a0c75841b6..1d93129def 100644 --- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/triaging-code-scanning-alerts-in-pull-requests.md +++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/triaging-code-scanning-alerts-in-pull-requests.md @@ -7,6 +7,9 @@ permissions: 'If you have read permission for a repository, you can see annotati versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' +topics: + - security --- {% data reusables.code-scanning.beta %} @@ -31,7 +34,7 @@ When you look at the **Files changed** tab for a pull request, you see annotatio ![Alert annotation within a pull request diff](/assets/images/help/repository/code-scanning-pr-annotation.png) -If you have write permission for the repository, some annotations contain links with extra context for the alert. In the example above, from {% data variables.product.prodname_codeql %} analysis, you can click **user-provided value** to see where the untrusted data enters the data flow (this is referred to as the source). In this case you can also view the full path from the source to the code that uses the data (the sink) by clicking **Show paths**. This makes it easy to check whether the data is untrusted or if the analysis failed to recognize a data sanitization step between the source and the sink. For information about analyzing data flow using {% data variables.product.prodname_codeql %}, see "[About data flow analysis](https://help.semmle.com/QL/learn-ql/intro-to-data-flow.html)." +If you have write permission for the repository, some annotations contain links with extra context for the alert. In the example above, from {% data variables.product.prodname_codeql %} analysis, you can click **user-provided value** to see where the untrusted data enters the data flow (this is referred to as the source). In this case you can also view the full path from the source to the code that uses the data (the sink) by clicking **Show paths**. This makes it easy to check whether the data is untrusted or if the analysis failed to recognize a data sanitization step between the source and the sink. For information about analyzing data flow using {% data variables.product.prodname_codeql %}, see "[About data flow analysis](https://codeql.github.com/docs/writing-codeql-queries/about-data-flow-analysis/)." To see more information about an alert, users with write permission can click the **Show more details** link shown in the annotation. This allows you to see all of the context and metadata provided by the tool in an alert view. In the example below, you can see tags showing the severity, type, and relevant common weakness enumerations (CWEs) for the problem. The view also shows which commit introduced the problem. diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/troubleshooting-codeql-code-scanning-in-your-ci-system.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/troubleshooting-codeql-code-scanning-in-your-ci-system.md index e53bd81edc..7fb5107e44 100644 --- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/troubleshooting-codeql-code-scanning-in-your-ci-system.md +++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/troubleshooting-codeql-code-scanning-in-your-ci-system.md @@ -8,6 +8,9 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' +topics: + - security --- {% data reusables.code-scanning.beta-codeql-runner %} @@ -51,4 +54,7 @@ If the `analyze` command for the {% data variables.product.prodname_codeql_runne {% endnote %} +1. You're analyzing a compiled language on macOS without using the `autobuild` command and you run the build steps yourself after the `init` step. If SIP (System Integrity Protection) is enabled, which is the default on recent versions of OSX, analysis might fail. To fix this, prefix the build command with the `$CODEQL_RUNNER` environment variable. + For example, if your build command is `cmd arg1 arg2`, you should run `$CODEQL_RUNNER cmd arg1 arg2`. + 1. The code is built in a container or on a separate machine. If you use a containerized build or if you outsource the build to another machine, make sure to run the {% data variables.product.prodname_codeql_runner %} in the container or on the machine where your build task takes place. For more information, see "[Running CodeQL code scanning in a container](/github/finding-security-vulnerabilities-and-errors-in-your-code/running-codeql-code-scanning-in-a-container)." diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/troubleshooting-the-codeql-workflow.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/troubleshooting-the-codeql-workflow.md index f1c4d3e53a..c97c815c63 100644 --- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/troubleshooting-the-codeql-workflow.md +++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/troubleshooting-the-codeql-workflow.md @@ -8,11 +8,18 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' +topics: + - security --- {% data reusables.code-scanning.beta %} {% data reusables.code-scanning.not-available %} +### Producing detailed logs for debugging + +To produce more detailed logging output, you can enable step debug logging. For more information, see "[Enabling debug logging](/actions/managing-workflow-runs/enabling-debug-logging#enabling-step-debug-logging)." + ### Automatic build for a compiled language fails If an automatic build of code for a compiled language within your project fails, try the following troubleshooting steps. @@ -167,4 +174,4 @@ The revised `steps` section of the workflow will look like this: ... ``` -For more information about editing the {% data variables.product.prodname_codeql %} workflow file, see "[Configuring {% data variables.product.prodname_code_scanning %}](/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#editing-a-code-scanning-workflow)." \ No newline at end of file +For more information about editing the {% data variables.product.prodname_codeql %} workflow file, see "[Configuring {% data variables.product.prodname_code_scanning %}](/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#editing-a-code-scanning-workflow)." diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/uploading-a-sarif-file-to-github.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/uploading-a-sarif-file-to-github.md index b597086da2..d8b31a6968 100644 --- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/uploading-a-sarif-file-to-github.md +++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/uploading-a-sarif-file-to-github.md @@ -9,6 +9,9 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' +topics: + - security --- {% data reusables.code-scanning.beta %} diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/using-codeql-code-scanning-with-your-existing-ci-system.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/using-codeql-code-scanning-with-your-existing-ci-system.md index af71f4047d..685e815aea 100644 --- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/using-codeql-code-scanning-with-your-existing-ci-system.md +++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/using-codeql-code-scanning-with-your-existing-ci-system.md @@ -7,5 +7,8 @@ product: '{% data reusables.gated-features.code-scanning %}' versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' +topics: + - security --- diff --git a/content/github/finding-talent-with-github-jobs/about-github-jobs.md b/content/github/finding-talent-with-github-jobs/about-github-jobs.md index b828445961..f524f975c7 100644 --- a/content/github/finding-talent-with-github-jobs/about-github-jobs.md +++ b/content/github/finding-talent-with-github-jobs/about-github-jobs.md @@ -6,6 +6,8 @@ redirect_from: intro: 'You can post a job on {% data variables.product.prodname_jobs %} to find talent for your business.' versions: free-pro-team: '*' +topics: + - jobs --- Before you can post a job, you must create a {% data variables.product.prodname_dotcom %} account and verify your email address. For more information, see "[Signing up for a new {% data variables.product.prodname_dotcom %} account](/articles/signing-up-for-a-new-github-account)" and "[Verifying your email address](/articles/verifying-your-email-address)." diff --git a/content/github/finding-talent-with-github-jobs/index.md b/content/github/finding-talent-with-github-jobs/index.md index 2ac9ca9b92..16bb315d08 100644 --- a/content/github/finding-talent-with-github-jobs/index.md +++ b/content/github/finding-talent-with-github-jobs/index.md @@ -6,6 +6,8 @@ redirect_from: - /categories/finding-talent-with-github-jobs versions: free-pro-team: '*' +topics: + - jobs --- diff --git a/content/github/getting-started-with-github/about-github-advanced-security.md b/content/github/getting-started-with-github/about-github-advanced-security.md index 7f56cb9742..89ae0113f8 100644 --- a/content/github/getting-started-with-github/about-github-advanced-security.md +++ b/content/github/getting-started-with-github/about-github-advanced-security.md @@ -1,16 +1,20 @@ --- title: About GitHub Advanced Security -intro: '{% data variables.product.prodname_dotcom %} makes extra security features available to customers under an {% data variables.product.prodname_advanced_security %} license. These features are also enabled for public repositories on {% data variables.product.prodname_dotcom_the_website %}.' +intro: '{% data variables.product.prodname_dotcom %} makes extra security features available to customers under an {% data variables.product.prodname_advanced_security %} license.{% if currentVersion == "free-pro-team@latest" %} These features are also enabled for public repositories on {% data variables.product.prodname_dotcom_the_website %}.{% endif %}' +product: '{% data reusables.gated-features.ghas %}' versions: free-pro-team: '*' enterprise-server: '>=3.0' + github-ae: '*' +topics: + - security --- ### About {% data variables.product.prodname_GH_advanced_security %} -{% data variables.product.prodname_dotcom %} has many features that help you improve and maintain the quality of your code. Some of these are included in all plans, for example: dependency graph and {% data variables.product.prodname_dependabot_alerts %}. Other security features require a license for {% data variables.product.prodname_GH_advanced_security %} to run on repositories apart from public repositories on {% data variables.product.prodname_dotcom_the_website %}. (That is, private and internal repositories on {% data variables.product.prodname_dotcom_the_website %}, and all repositories on {% data variables.product.prodname_ghe_server %}.) +{% data variables.product.prodname_dotcom %} has many features that help you improve and maintain the quality of your code. Some of these are included in all plans{% if currentVersion != "github-ae@latest" %}, such as dependency graph and {% data variables.product.prodname_dependabot_alerts %}{% endif %}. Other security features require a license for {% data variables.product.prodname_GH_advanced_security %} to run on repositories apart from public repositories on {% data variables.product.prodname_dotcom_the_website %}. -For an overview of all security features, see "[About securing your repository](/github/administering-a-repository/about-securing-your-repository#setting-up-your-repository-securely)." For information about permission requirements for actions related to security features, see "[Repository permission levels for an organization](/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-requirements-for-security-features)." +{% if currentVersion == "free-pro-team@latest" %}For more information, see "[About licensing for {% data variables.product.prodname_GH_advanced_security %}](/github/setting-up-and-managing-billing-and-payments-on-github/about-licensing-for-github-advanced-security)."{% elsif currentVersion ver_gt "enterprise-server@2.22" %}For information about purchasing a license for {% data variables.product.prodname_GH_advanced_security %}, contact {% data variables.contact.contact_enterprise_sales %}.{% elsif currentVersion == "github-ae@latest" %}There is no charge for {% data variables.product.prodname_GH_advanced_security %} on {% data variables.product.prodname_ghe_managed %} during the beta release.{% endif %} ### About {% data variables.product.prodname_advanced_security %} features @@ -24,39 +28,29 @@ A {% data variables.product.prodname_GH_advanced_security %} license provides th - **Dependency review** - Show the full impact of changes to dependencies and see details of any vulnerable versions before you merge a pull request. For more information, see "[Reviewing dependency changes in a pull request](/github/collaborating-with-issues-and-pull-requests/reviewing-dependency-changes-in-a-pull-request)." {% endif %} -For information about {% data variables.product.prodname_advanced_security %} features that are in development, see "[{% data variables.product.prodname_dotcom %} public roadmap](https://github.com/github/roadmap)." +For information about {% data variables.product.prodname_advanced_security %} features that are in development, see "[{% data variables.product.prodname_dotcom %} public roadmap](https://github.com/github/roadmap)." For an overview of all security features, see "[About securing your repository](/github/administering-a-repository/about-securing-your-repository#setting-up-your-repository-securely)." -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} - -### About {% data variables.product.prodname_advanced_security %} licensing - -{% data reusables.advanced-security.license-overview %} - -{% data reusables.advanced-security.enable-disable-committer-info %} - -{% endif %} +{% if currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} +### Enabling {% data variables.product.prodname_advanced_security %} features on {% data variables.product.product_name %} {% if currentVersion ver_gt "enterprise-server@2.22" %} -### Enabling {% data variables.product.prodname_advanced_security %} features on {% data variables.product.prodname_ghe_server %} - The site administrator must enable {% data variables.product.prodname_advanced_security %} for {% data variables.product.product_location %} before you can use these features. For more information, see "[Configuring Advanced Security features](/admin/configuration/configuring-advanced-security-features)." +{% endif %} Once your system is set up, you can enable and disable these features at the organization or repository level. For more information, see "[Managing security and analysis settings for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization)" and "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)." -For information about purchasing a license for {% data variables.product.prodname_GH_advanced_security %}, contact {% data variables.contact.contact_enterprise_sales %}. {% endif %} +{% if currentVersion != "github-ae@latest" %} ### Enabling {% data variables.product.prodname_advanced_security %} features on {% data variables.product.prodname_dotcom_the_website %} -For public repositories on {% data variables.product.prodname_dotcom_the_website %}, these features are permanently on and are only disabled if you change the visibility of the project so that the code is no longer public. +For public repositories on {% data variables.product.prodname_dotcom_the_website %}, these features are permanently on and can only be disabled if you change the visibility of the project so that the code is no longer public. -For other repositories, once you have a license for your organization or enterprise, you can enable and disable these features at the organization or repository level. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}For more information, see "[Managing security and analysis settings for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization)" and "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)." +For other repositories, once you have a license for your enterprise account, you can enable and disable these features at the organization or repository level. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}For more information, see "[Managing security and analysis settings for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization)" and "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)."{% endif %} + +{% endif %} {% if currentVersion == "free-pro-team@latest" %} - -If you have an enterprise account, license use for the enterprise is shown on your billing page. For more information, see "[Managing use of Advanced Security for organizations in your enterprise account](/github/setting-up-and-managing-your-enterprise/managing-use-of-advanced-security-for-organizations-in-your-enterprise-account)." +If you have an enterprise account, license use for the entire enterprise is shown on your enterprise license page. For more information, see "[Viewing your {% data variables.product.prodname_GH_advanced_security %} usage](/github/setting-up-and-managing-billing-and-payments-on-github/viewing-your-github-advanced-security-usage)." {% endif %} - -For information about purchasing a license for {% data variables.product.prodname_GH_advanced_security %}, contact {% data variables.contact.contact_enterprise_sales %}. -{% endif %} diff --git a/content/github/getting-started-with-github/access-permissions-on-github.md b/content/github/getting-started-with-github/access-permissions-on-github.md index b2483b1986..bd8b6a4f51 100644 --- a/content/github/getting-started-with-github/access-permissions-on-github.md +++ b/content/github/getting-started-with-github/access-permissions-on-github.md @@ -10,6 +10,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - permissions + - accounts --- ### Personal user accounts diff --git a/content/github/getting-started-with-github/be-social.md b/content/github/getting-started-with-github/be-social.md index d326445068..2817ef122e 100644 --- a/content/github/getting-started-with-github/be-social.md +++ b/content/github/getting-started-with-github/be-social.md @@ -8,6 +8,12 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - profile + - pull requests + - issues + - notifications + - accounts --- To learn about accessing your personal dashboard, see "[About your personal dashboard](/articles/about-your-personal-dashboard)." diff --git a/content/github/getting-started-with-github/create-a-repo.md b/content/github/getting-started-with-github/create-a-repo.md index e04f4e2030..94477e922c 100644 --- a/content/github/getting-started-with-github/create-a-repo.md +++ b/content/github/getting-started-with-github/create-a-repo.md @@ -8,6 +8,11 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests + - issues + - notifications + - accounts --- {% if currentVersion == "free-pro-team@latest" %} diff --git a/content/github/getting-started-with-github/exploring-early-access-releases-with-feature-preview.md b/content/github/getting-started-with-github/exploring-early-access-releases-with-feature-preview.md index caee1aa1eb..595962f3c5 100644 --- a/content/github/getting-started-with-github/exploring-early-access-releases-with-feature-preview.md +++ b/content/github/getting-started-with-github/exploring-early-access-releases-with-feature-preview.md @@ -5,6 +5,8 @@ redirect_from: - /articles/exploring-early-access-releases-with-feature-preview versions: free-pro-team: '*' +topics: + - early access --- ### {% data variables.product.prodname_dotcom %}'s release cycle diff --git a/content/github/getting-started-with-github/exploring-projects-on-github.md b/content/github/getting-started-with-github/exploring-projects-on-github.md index 796214bfb5..86b64226f4 100644 --- a/content/github/getting-started-with-github/exploring-projects-on-github.md +++ b/content/github/getting-started-with-github/exploring-projects-on-github.md @@ -11,5 +11,7 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - projects --- diff --git a/content/github/getting-started-with-github/faq-about-changes-to-githubs-plans.md b/content/github/getting-started-with-github/faq-about-changes-to-githubs-plans.md index 6d85fbd4f0..c9bba505fd 100644 --- a/content/github/getting-started-with-github/faq-about-changes-to-githubs-plans.md +++ b/content/github/getting-started-with-github/faq-about-changes-to-githubs-plans.md @@ -3,6 +3,8 @@ title: FAQ about changes to GitHub’s plans intro: 'As of April 14, 2020, GitHub announced that all of the core GitHub features are now free for everyone.' versions: free-pro-team: '*' +topics: + - github --- ### What plans and pricing changes did GitHub announce on April 14? diff --git a/content/github/getting-started-with-github/finding-ways-to-contribute-to-open-source-on-github.md b/content/github/getting-started-with-github/finding-ways-to-contribute-to-open-source-on-github.md index d1b5e3c6c9..46760bbc07 100644 --- a/content/github/getting-started-with-github/finding-ways-to-contribute-to-open-source-on-github.md +++ b/content/github/getting-started-with-github/finding-ways-to-contribute-to-open-source-on-github.md @@ -10,6 +10,8 @@ redirect_from: - /github/getting-started-with-github/finding-open-source-projects-on-github versions: free-pro-team: '*' +topics: + - open source --- ### Discovering relevant projects diff --git a/content/github/getting-started-with-github/following-people.md b/content/github/getting-started-with-github/following-people.md index cbf380c4a0..c629d18751 100644 --- a/content/github/getting-started-with-github/following-people.md +++ b/content/github/getting-started-with-github/following-people.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - profile --- When you follow people, you'll see their public activity in the activity view of your news feed.{% if currentVersion == "free-pro-team@latest" %} If someone you follow stars a public repository, {% data variables.product.product_name %} may recommend the repository to you in the discovery view of your news feed.{% endif %} To follow someone, visit their profile page and click **Follow** under their profile image. diff --git a/content/github/getting-started-with-github/fork-a-repo.md b/content/github/getting-started-with-github/fork-a-repo.md index 74914f4ea5..777773290a 100644 --- a/content/github/getting-started-with-github/fork-a-repo.md +++ b/content/github/getting-started-with-github/fork-a-repo.md @@ -9,6 +9,11 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests + - issues + - notifications + - accounts --- Most commonly, forks are used to either propose changes to someone else's project or to use someone else's project as a starting point for your own idea. diff --git a/content/github/getting-started-with-github/github-cli.md b/content/github/getting-started-with-github/github-cli.md index 9abdb36159..ff68b7c922 100644 --- a/content/github/getting-started-with-github/github-cli.md +++ b/content/github/getting-started-with-github/github-cli.md @@ -5,6 +5,8 @@ versions: free-pro-team: '*' enterprise-server: '>2.19' github-ae: '*' +topics: + - cli --- ### About {% data variables.product.prodname_cli %} diff --git a/content/github/getting-started-with-github/github-desktop.md b/content/github/getting-started-with-github/github-desktop.md index bce85ea84e..cfb8affbb7 100644 --- a/content/github/getting-started-with-github/github-desktop.md +++ b/content/github/getting-started-with-github/github-desktop.md @@ -5,6 +5,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - desktop --- ### About {% data variables.product.prodname_desktop %} diff --git a/content/github/getting-started-with-github/github-for-mobile.md b/content/github/getting-started-with-github/github-for-mobile.md index 1a0fc38c53..13e7496742 100644 --- a/content/github/getting-started-with-github/github-for-mobile.md +++ b/content/github/getting-started-with-github/github-for-mobile.md @@ -4,6 +4,8 @@ intro: 'Triage, collaborate, and manage your work on {% data variables.product.p versions: free-pro-team: '*' enterprise-server: '>=3.0' +topics: + - mobile --- {% data reusables.mobile.ghes-release-phase %} diff --git a/content/github/getting-started-with-github/githubs-products.md b/content/github/getting-started-with-github/githubs-products.md index 4f14fddd35..8a162bbf28 100644 --- a/content/github/getting-started-with-github/githubs-products.md +++ b/content/github/getting-started-with-github/githubs-products.md @@ -8,6 +8,12 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - accounts + - cli + - mobile + - desktop + - security --- {% data variables.product.prodname_dotcom %} offers free and paid products. You can see pricing and a full list of features for each product at <{% data variables.product.pricing_url %}>. {% data reusables.products.product-roadmap %} @@ -79,7 +85,8 @@ In addition to the features available with {% data variables.product.prodname_te - Additional security, compliance, and deployment controls - Authentication with SAML single sign-on - Access provisioning with SAML or SCIM -- {% data variables.product.prodname_github_connect %} +- {% data variables.product.prodname_github_connect %}{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.22" %} +- The option to purchase {% data variables.product.prodname_GH_advanced_security %}. For more information, see "[About {% data variables.product.prodname_GH_advanced_security %}](/github/getting-started-with-github/about-github-advanced-security)."{% endif %} {% data variables.product.prodname_ghe_cloud %} also includes: - {% data variables.contact.enterprise_support %}. For more information, see "{% data variables.product.prodname_ghe_cloud %} support" and "{% data variables.product.prodname_ghe_cloud %} Addendum." diff --git a/content/github/getting-started-with-github/index.md b/content/github/getting-started-with-github/index.md index d5970dd910..184a5a0296 100644 --- a/content/github/getting-started-with-github/index.md +++ b/content/github/getting-started-with-github/index.md @@ -1,7 +1,7 @@ --- title: Getting started with GitHub shortTitle: Getting started -intro: 'Learn about {% data variables.product.prodname_dotcom %}''s products, sign up for an account, and explore the {% data variables.product.prodname_dotcom %} community.' +intro: 'Learn how to start building, shipping, and maintaining software with {% data variables.product.prodname_dotcom %}. Explore our products, sign up for an account, and connect with the world''s largest development community.' redirect_from: - /categories/54/articles/ - /categories/bootcamp/ @@ -16,8 +16,39 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +layout: product-landing +introLinks: + quickstart: /github/getting-started-with-github/quickstart +featuredLinks: + guides: + - /github/getting-started-with-github/githubs-products + - /github/getting-started-with-github/create-a-repo + - /github/getting-started-with-github/signing-up-for-a-new-github-account + popular: + - /github/getting-started-with-github/set-up-git + - /github/getting-started-with-github/github-glossary + - /github/getting-started-with-github/fork-a-repo + - /github/getting-started-with-github/keyboard-shortcuts + - /github/getting-started-with-github/saving-repositories-with-stars + guideCards: + - /github/getting-started-with-github/types-of-github-accounts + - /github/getting-started-with-github/finding-ways-to-contribute-to-open-source-on-github + - /github/getting-started-with-github/troubleshooting-connectivity-problems +topics: + - pull requests + - issues + - notifications + - accounts --- + diff --git a/content/github/getting-started-with-github/keyboard-shortcuts.md b/content/github/getting-started-with-github/keyboard-shortcuts.md index 26090a8dae..66c0cdd97c 100644 --- a/content/github/getting-started-with-github/keyboard-shortcuts.md +++ b/content/github/getting-started-with-github/keyboard-shortcuts.md @@ -64,6 +64,7 @@ For more keyboard shortcuts, see the [CodeMirror documentation](https://codemirr |w | Switch to a new branch or tag |y | Expand a URL to its canonical form. For more information, see "[Getting permanent links to files](/articles/getting-permanent-links-to-files)." |i | Show or hide comments on diffs. For more information, see "[Commenting on the diff of a pull request](/articles/commenting-on-the-diff-of-a-pull-request)." +|a | Show or hide annotations on diffs |b | Open blame view. For more information, see "[Tracing changes in a file](/articles/tracing-changes-in-a-file)." ### Comments diff --git a/content/github/getting-started-with-github/learning-about-github.md b/content/github/getting-started-with-github/learning-about-github.md index 8c94a8491f..d43ab528ff 100644 --- a/content/github/getting-started-with-github/learning-about-github.md +++ b/content/github/getting-started-with-github/learning-about-github.md @@ -8,5 +8,11 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - accounts + - cli + - mobile + - desktop + - security --- diff --git a/content/github/getting-started-with-github/quickstart.md b/content/github/getting-started-with-github/quickstart.md index 77de003bdf..d123093cb0 100644 --- a/content/github/getting-started-with-github/quickstart.md +++ b/content/github/getting-started-with-github/quickstart.md @@ -6,5 +6,10 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests + - issues + - notifications + - accounts --- diff --git a/content/github/getting-started-with-github/saving-repositories-with-stars.md b/content/github/getting-started-with-github/saving-repositories-with-stars.md index 993595cb4e..2cbf15688c 100644 --- a/content/github/getting-started-with-github/saving-repositories-with-stars.md +++ b/content/github/getting-started-with-github/saving-repositories-with-stars.md @@ -11,6 +11,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- You can search, sort, and filter your starred repositories and topics on your {% data variables.explore.your_stars_page %}.' diff --git a/content/github/getting-started-with-github/set-up-git.md b/content/github/getting-started-with-github/set-up-git.md index 3e1169f8e4..e96c3b8490 100644 --- a/content/github/getting-started-with-github/set-up-git.md +++ b/content/github/getting-started-with-github/set-up-git.md @@ -15,6 +15,11 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests + - issues + - notifications + - accounts --- To use Git on the command line, you'll need to download, install, and configure Git on your computer. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" or currentVersion == "github-ae@latest" %} You can also install {% data variables.product.prodname_cli %} to use {% data variables.product.product_name %} from the command line. For more information on {% data variables.product.prodname_cli %}, see the [{% data variables.product.prodname_cli %}](https://cli.github.com/manual/) documentation.{% endif %} diff --git a/content/github/getting-started-with-github/setting-up-a-trial-of-github-enterprise-cloud.md b/content/github/getting-started-with-github/setting-up-a-trial-of-github-enterprise-cloud.md index 46ae74fe24..3105c872d2 100644 --- a/content/github/getting-started-with-github/setting-up-a-trial-of-github-enterprise-cloud.md +++ b/content/github/getting-started-with-github/setting-up-a-trial-of-github-enterprise-cloud.md @@ -6,6 +6,8 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '*' +topics: + - accounts --- ### About trials of {% data variables.product.prodname_ghe_cloud %} diff --git a/content/github/getting-started-with-github/setting-up-a-trial-of-github-enterprise-server.md b/content/github/getting-started-with-github/setting-up-a-trial-of-github-enterprise-server.md index d0d75deba7..8800cbbc3f 100644 --- a/content/github/getting-started-with-github/setting-up-a-trial-of-github-enterprise-server.md +++ b/content/github/getting-started-with-github/setting-up-a-trial-of-github-enterprise-server.md @@ -7,6 +7,8 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '*' +topics: + - accounts --- ### About trials of {% data variables.product.prodname_ghe_server %} diff --git a/content/github/getting-started-with-github/signing-up-for-a-new-github-account.md b/content/github/getting-started-with-github/signing-up-for-a-new-github-account.md index f30f496882..fa3b49af14 100644 --- a/content/github/getting-started-with-github/signing-up-for-a-new-github-account.md +++ b/content/github/getting-started-with-github/signing-up-for-a-new-github-account.md @@ -6,6 +6,8 @@ redirect_from: - /articles/signing-up-for-a-new-github-account versions: free-pro-team: '*' +topics: + - accounts --- For more information about account types and products, see "[Types of {% data variables.product.prodname_dotcom %} accounts](/articles/types-of-github-accounts)" and "[{% data variables.product.product_name %}'s products](/articles/github-s-products)." diff --git a/content/github/getting-started-with-github/signing-up-for-github.md b/content/github/getting-started-with-github/signing-up-for-github.md index 540b8e845c..b231d472ab 100644 --- a/content/github/getting-started-with-github/signing-up-for-github.md +++ b/content/github/getting-started-with-github/signing-up-for-github.md @@ -8,5 +8,7 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - accounts --- diff --git a/content/github/getting-started-with-github/types-of-github-accounts.md b/content/github/getting-started-with-github/types-of-github-accounts.md index 17235a2455..f1615b90b7 100644 --- a/content/github/getting-started-with-github/types-of-github-accounts.md +++ b/content/github/getting-started-with-github/types-of-github-accounts.md @@ -11,6 +11,12 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - accounts + - cli + - mobile + - desktop + - security --- {% if currentVersion == "free-pro-team@latest" %} diff --git a/content/github/getting-started-with-github/verifying-your-email-address.md b/content/github/getting-started-with-github/verifying-your-email-address.md index f4a31c5d35..71f4415c43 100644 --- a/content/github/getting-started-with-github/verifying-your-email-address.md +++ b/content/github/getting-started-with-github/verifying-your-email-address.md @@ -7,6 +7,8 @@ redirect_from: - /articles/verifying-your-email-address versions: free-pro-team: '*' +topics: + - accounts --- ### About email verification diff --git a/content/github/managing-files-in-a-repository/3d-file-viewer.md b/content/github/managing-files-in-a-repository/3d-file-viewer.md index c203f9b71d..f1b6595e4a 100644 --- a/content/github/managing-files-in-a-repository/3d-file-viewer.md +++ b/content/github/managing-files-in-a-repository/3d-file-viewer.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- {% data variables.product.product_name %} can host and render 3D files with the *.stl* extension. diff --git a/content/github/managing-files-in-a-repository/adding-a-file-to-a-repository-using-the-command-line.md b/content/github/managing-files-in-a-repository/adding-a-file-to-a-repository-using-the-command-line.md index 2f0fc63c9a..b4ec09487f 100644 --- a/content/github/managing-files-in-a-repository/adding-a-file-to-a-repository-using-the-command-line.md +++ b/content/github/managing-files-in-a-repository/adding-a-file-to-a-repository-using-the-command-line.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- {% tip %} diff --git a/content/github/managing-files-in-a-repository/adding-a-file-to-a-repository.md b/content/github/managing-files-in-a-repository/adding-a-file-to-a-repository.md index 2b87bdf54e..62e57a8f86 100644 --- a/content/github/managing-files-in-a-repository/adding-a-file-to-a-repository.md +++ b/content/github/managing-files-in-a-repository/adding-a-file-to-a-repository.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- Files that you add to a repository via a browser are limited to {% data variables.large_files.max_github_browser_size %} per file. You can add larger files, up to {% data variables.large_files.max_github_size %} each, via the command line. For more information, see "[Adding a file to a repository using the command line](/articles/adding-a-file-to-a-repository-using-the-command-line)." diff --git a/content/github/managing-files-in-a-repository/creating-new-files.md b/content/github/managing-files-in-a-repository/creating-new-files.md index 4f625eff34..9f3b073d39 100644 --- a/content/github/managing-files-in-a-repository/creating-new-files.md +++ b/content/github/managing-files-in-a-repository/creating-new-files.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- When creating a file on {% data variables.product.product_name %}, consider the following: diff --git a/content/github/managing-files-in-a-repository/deleting-files-in-a-repository.md b/content/github/managing-files-in-a-repository/deleting-files-in-a-repository.md index 40bcfcc02e..163a2a447b 100644 --- a/content/github/managing-files-in-a-repository/deleting-files-in-a-repository.md +++ b/content/github/managing-files-in-a-repository/deleting-files-in-a-repository.md @@ -9,7 +9,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' -permissions: People with write permissions can delete files{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} or directories{% endif %} in a repository. +permissions: 'People with write permissions can delete files{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} or directories{% endif %} in a repository.' +topics: + - repositories --- ### About file{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} and directory{% endif %} deletion @@ -40,4 +42,4 @@ If the file{% if currentVersion == "free-pro-team@latest" or currentVersion ver_ {% data reusables.files.choose-commit-email %} {% data reusables.files.choose_commit_branch %} {% data reusables.files.propose_file_change %} -{% endif %} \ No newline at end of file +{% endif %} diff --git a/content/github/managing-files-in-a-repository/editing-files-in-another-users-repository.md b/content/github/managing-files-in-a-repository/editing-files-in-another-users-repository.md index dc10c8e09f..21cf61f245 100644 --- a/content/github/managing-files-in-a-repository/editing-files-in-another-users-repository.md +++ b/content/github/managing-files-in-a-repository/editing-files-in-another-users-repository.md @@ -9,6 +9,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- 1. In another user's repository, browse to the folder that contains the file you want to edit. Click the name of the file you want to edit. diff --git a/content/github/managing-files-in-a-repository/editing-files-in-your-repository.md b/content/github/managing-files-in-a-repository/editing-files-in-your-repository.md index 5de63217e7..94bebe636a 100644 --- a/content/github/managing-files-in-a-repository/editing-files-in-your-repository.md +++ b/content/github/managing-files-in-a-repository/editing-files-in-your-repository.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- {% tip %} diff --git a/content/github/managing-files-in-a-repository/getting-permanent-links-to-files.md b/content/github/managing-files-in-a-repository/getting-permanent-links-to-files.md index 756ff937e0..e1e9942b61 100644 --- a/content/github/managing-files-in-a-repository/getting-permanent-links-to-files.md +++ b/content/github/managing-files-in-a-repository/getting-permanent-links-to-files.md @@ -9,6 +9,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- {% tip %} diff --git a/content/github/managing-files-in-a-repository/index.md b/content/github/managing-files-in-a-repository/index.md index faf07b3fb4..c17ebfd9e9 100644 --- a/content/github/managing-files-in-a-repository/index.md +++ b/content/github/managing-files-in-a-repository/index.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- diff --git a/content/github/managing-files-in-a-repository/managing-files-on-github.md b/content/github/managing-files-in-a-repository/managing-files-on-github.md index da52349c22..847cc2c4f7 100644 --- a/content/github/managing-files-in-a-repository/managing-files-on-github.md +++ b/content/github/managing-files-in-a-repository/managing-files-on-github.md @@ -8,5 +8,7 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- diff --git a/content/github/managing-files-in-a-repository/managing-files-using-the-command-line.md b/content/github/managing-files-in-a-repository/managing-files-using-the-command-line.md index 1badad1949..4e9a2a76e5 100644 --- a/content/github/managing-files-in-a-repository/managing-files-using-the-command-line.md +++ b/content/github/managing-files-in-a-repository/managing-files-using-the-command-line.md @@ -8,5 +8,7 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- diff --git a/content/github/managing-files-in-a-repository/mapping-geojson-files-on-github.md b/content/github/managing-files-in-a-repository/mapping-geojson-files-on-github.md index 863ba4e52d..909b0152ec 100644 --- a/content/github/managing-files-in-a-repository/mapping-geojson-files-on-github.md +++ b/content/github/managing-files-in-a-repository/mapping-geojson-files-on-github.md @@ -6,6 +6,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- {% data variables.product.product_name %} supports rendering geoJSON and topoJSON map files within {% data variables.product.product_name %} repositories. Simply commit the file as you would normally using a `.geojson` or `.topojson` extension. Files with a `.json` extension are also supported, but only if `type` is set to `FeatureCollection`, `GeometryCollection`, or `topology`. Then, navigate to the path of the geoJSON file on GitHub.com. diff --git a/content/github/managing-files-in-a-repository/moving-a-file-to-a-new-location-using-the-command-line.md b/content/github/managing-files-in-a-repository/moving-a-file-to-a-new-location-using-the-command-line.md index 7479f99231..cdabc716cb 100644 --- a/content/github/managing-files-in-a-repository/moving-a-file-to-a-new-location-using-the-command-line.md +++ b/content/github/managing-files-in-a-repository/moving-a-file-to-a-new-location-using-the-command-line.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- Many files can be [moved directly on {% data variables.product.product_name %}](/articles/moving-a-file-to-a-new-location), but some files, such as images, require that you move them from the command line. diff --git a/content/github/managing-files-in-a-repository/moving-a-file-to-a-new-location.md b/content/github/managing-files-in-a-repository/moving-a-file-to-a-new-location.md index c628d64080..4a1f31ec2e 100644 --- a/content/github/managing-files-in-a-repository/moving-a-file-to-a-new-location.md +++ b/content/github/managing-files-in-a-repository/moving-a-file-to-a-new-location.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- In addition to changing the file location, you can also [update the contents of your file](/articles/editing-files-in-your-repository), or [give it a new name](/articles/renaming-a-file) in the same commit. diff --git a/content/github/managing-files-in-a-repository/navigating-code-on-github.md b/content/github/managing-files-in-a-repository/navigating-code-on-github.md index 82b3f3ecc8..693ce8c7cf 100644 --- a/content/github/managing-files-in-a-repository/navigating-code-on-github.md +++ b/content/github/managing-files-in-a-repository/navigating-code-on-github.md @@ -5,6 +5,8 @@ redirect_from: - /articles/navigating-code-on-github versions: free-pro-team: '*' +topics: + - repositories --- ### About navigating code on {% data variables.product.prodname_dotcom %} diff --git a/content/github/managing-files-in-a-repository/renaming-a-file-using-the-command-line.md b/content/github/managing-files-in-a-repository/renaming-a-file-using-the-command-line.md index 213d83c124..3477c51b80 100644 --- a/content/github/managing-files-in-a-repository/renaming-a-file-using-the-command-line.md +++ b/content/github/managing-files-in-a-repository/renaming-a-file-using-the-command-line.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- Many files can be [renamed directly on {% data variables.product.product_name %}](/articles/renaming-a-file), but some files, such as images, require that you rename them from the command line. diff --git a/content/github/managing-files-in-a-repository/renaming-a-file.md b/content/github/managing-files-in-a-repository/renaming-a-file.md index c516722bcb..6b95200340 100644 --- a/content/github/managing-files-in-a-repository/renaming-a-file.md +++ b/content/github/managing-files-in-a-repository/renaming-a-file.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- {% tip %} diff --git a/content/github/managing-files-in-a-repository/rendering-and-diffing-images.md b/content/github/managing-files-in-a-repository/rendering-and-diffing-images.md index 5f4a5868b0..cbb171c5b3 100644 --- a/content/github/managing-files-in-a-repository/rendering-and-diffing-images.md +++ b/content/github/managing-files-in-a-repository/rendering-and-diffing-images.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- {% note %} diff --git a/content/github/managing-files-in-a-repository/rendering-csv-and-tsv-data.md b/content/github/managing-files-in-a-repository/rendering-csv-and-tsv-data.md index 216d9abe4f..426afc055d 100644 --- a/content/github/managing-files-in-a-repository/rendering-csv-and-tsv-data.md +++ b/content/github/managing-files-in-a-repository/rendering-csv-and-tsv-data.md @@ -6,6 +6,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- GitHub supports rendering tabular data in the form of *.csv* (comma-separated) and .*tsv* (tab-separated) files. diff --git a/content/github/managing-files-in-a-repository/rendering-differences-in-prose-documents.md b/content/github/managing-files-in-a-repository/rendering-differences-in-prose-documents.md index 1f3c59ad20..2a547a058b 100644 --- a/content/github/managing-files-in-a-repository/rendering-differences-in-prose-documents.md +++ b/content/github/managing-files-in-a-repository/rendering-differences-in-prose-documents.md @@ -6,6 +6,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- Commits and pull requests that include prose documents have the ability to represent those documents with *source* and *rendered* views. diff --git a/content/github/managing-files-in-a-repository/rendering-pdf-documents.md b/content/github/managing-files-in-a-repository/rendering-pdf-documents.md index 5e13b3f24a..11567a5abd 100644 --- a/content/github/managing-files-in-a-repository/rendering-pdf-documents.md +++ b/content/github/managing-files-in-a-repository/rendering-pdf-documents.md @@ -6,6 +6,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- GitHub supports rendering of PDF documents. diff --git a/content/github/managing-files-in-a-repository/tracking-changes-in-a-file.md b/content/github/managing-files-in-a-repository/tracking-changes-in-a-file.md index 99fb0d7b54..9ace4fd76b 100644 --- a/content/github/managing-files-in-a-repository/tracking-changes-in-a-file.md +++ b/content/github/managing-files-in-a-repository/tracking-changes-in-a-file.md @@ -9,6 +9,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- With the blame view, you can view the line-by-line revision history for an entire file, or view the revision history of a single line within a file by clicking {% octicon "versions" aria-label="The prior blame icon" %}. Each time you click {% octicon "versions" aria-label="The prior blame icon" %}, you'll see the previous revision information for that line, including who committed the change and when. diff --git a/content/github/managing-files-in-a-repository/working-with-jupyter-notebook-files-on-github.md b/content/github/managing-files-in-a-repository/working-with-jupyter-notebook-files-on-github.md index be3704331a..60e0292cb6 100644 --- a/content/github/managing-files-in-a-repository/working-with-jupyter-notebook-files-on-github.md +++ b/content/github/managing-files-in-a-repository/working-with-jupyter-notebook-files-on-github.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- diff --git a/content/github/managing-files-in-a-repository/working-with-non-code-files.md b/content/github/managing-files-in-a-repository/working-with-non-code-files.md index 2fb771ab50..2632f39bf4 100644 --- a/content/github/managing-files-in-a-repository/working-with-non-code-files.md +++ b/content/github/managing-files-in-a-repository/working-with-non-code-files.md @@ -9,5 +9,7 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- diff --git a/content/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies.md b/content/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies.md index feb34c4070..34402e25b6 100644 --- a/content/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies.md +++ b/content/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies.md @@ -7,6 +7,8 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '*' +topics: + - security --- ### About vulnerable dependencies @@ -20,8 +22,7 @@ When your code depends on a package that has a security vulnerability, this vuln {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot %} detects vulnerable dependencies and sends {% data variables.product.prodname_dependabot_alerts %}{% else %}{% data variables.product.product_name %} detects vulnerable dependencies and sends security alerts{% endif %} when: {% if currentVersion == "free-pro-team@latest" %} -- A new vulnerability is added to the {% data variables.product.prodname_advisory_database %}. For more information, see "[Browsing security vulnerabilities in the {% data variables.product.prodname_advisory_database %}](/github/managing-security-vulnerabilities/browsing-security-vulnerabilities-in-the-github-advisory-database)." -- New vulnerability data from [WhiteSource](https://www.whitesourcesoftware.com/vulnerability-database) is processed.{% else %} +- A new vulnerability is added to the {% data variables.product.prodname_advisory_database %}. For more information, see "[Browsing security vulnerabilities in the {% data variables.product.prodname_advisory_database %}](/github/managing-security-vulnerabilities/browsing-security-vulnerabilities-in-the-github-advisory-database)."{% else %} - New advisory data is synchronized to {% data variables.product.prodname_ghe_server %} each hour from {% data variables.product.prodname_dotcom_the_website %}. For more information about advisory data, see "Browsing security vulnerabilities in the {% data variables.product.prodname_advisory_database %}."{% endif %} - The dependency graph for a repository changes. For example, when a contributor pushes a commit to change the packages or versions it depends on{% if currentVersion == "free-pro-team@latest" %}, or when the code of one of the dependencies changes{% endif %}. For more information, see "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph)." diff --git a/content/github/managing-security-vulnerabilities/about-dependabot-security-updates.md b/content/github/managing-security-vulnerabilities/about-dependabot-security-updates.md index 7192b75861..b2229db5ed 100644 --- a/content/github/managing-security-vulnerabilities/about-dependabot-security-updates.md +++ b/content/github/managing-security-vulnerabilities/about-dependabot-security-updates.md @@ -6,6 +6,8 @@ redirect_from: - /github/managing-security-vulnerabilities/about-github-dependabot-security-updates versions: free-pro-team: '*' +topics: + - security --- ### About {% data variables.product.prodname_dependabot_security_updates %} @@ -25,6 +27,10 @@ The {% data variables.product.prodname_dependabot_security_updates %} feature is {% endnote %} +You can enable a related feature, {% data variables.product.prodname_dependabot_version_updates %}, so that {% data variables.product.prodname_dependabot %} raises pull requests to update the manifest to the latest version of the dependency, whenever it detects an outdated dependency. For more information, see "[About {% data variables.product.prodname_dependabot %} version updates](/github/administering-a-repository/about-dependabot-version-updates)." + +{% data reusables.dependabot.pull-request-security-vs-version-updates %} + ### About pull requests for security updates Each pull request contains everything you need to quickly and safely review and merge a proposed fix into your project. This includes information about the vulnerability like release notes, changelog entries, and commit details. Details of which vulnerability a pull request resolves are hidden from anyone who does not have access to {% data variables.product.prodname_dependabot_alerts %} for the repository. @@ -39,4 +45,4 @@ When you merge a pull request that contains a security update, the corresponding ### About notifications for {% data variables.product.prodname_dependabot %} security updates -You can filter your notifications on {% data variables.product.company_short %} to show {% data variables.product.prodname_dependabot %} security updates. For more information, see "[Managing notifications from your inbox](/github/managing-subscriptions-and-notifications-on-github/managing-notifications-from-your-inbox#dependabot-custom-filters)." \ No newline at end of file +You can filter your notifications on {% data variables.product.company_short %} to show {% data variables.product.prodname_dependabot %} security updates. For more information, see "[Managing notifications from your inbox](/github/managing-subscriptions-and-notifications-on-github/managing-notifications-from-your-inbox#dependabot-custom-filters)." diff --git a/content/github/managing-security-vulnerabilities/about-github-security-advisories.md b/content/github/managing-security-vulnerabilities/about-github-security-advisories.md index 59952fd9ba..dadfcffdad 100644 --- a/content/github/managing-security-vulnerabilities/about-github-security-advisories.md +++ b/content/github/managing-security-vulnerabilities/about-github-security-advisories.md @@ -6,6 +6,8 @@ redirect_from: - /github/managing-security-vulnerabilities/about-maintainer-security-advisories versions: free-pro-team: '*' +topics: + - security --- {% data reusables.repositories.security-advisory-admin-permissions %} diff --git a/content/github/managing-security-vulnerabilities/about-managing-vulnerable-dependencies.md b/content/github/managing-security-vulnerabilities/about-managing-vulnerable-dependencies.md index 9041daa8de..2d5b72356a 100644 --- a/content/github/managing-security-vulnerabilities/about-managing-vulnerable-dependencies.md +++ b/content/github/managing-security-vulnerabilities/about-managing-vulnerable-dependencies.md @@ -3,6 +3,8 @@ title: About managing vulnerable dependencies intro: '{% data variables.product.prodname_dotcom %} helps you to avoid using third-party software that contains known vulnerabilities.' versions: free-pro-team: '*' +topics: + - security --- {% data variables.product.prodname_dotcom %} provides the following tools for removing and avoiding vulnerable dependencies. diff --git a/content/github/managing-security-vulnerabilities/adding-a-collaborator-to-a-security-advisory.md b/content/github/managing-security-vulnerabilities/adding-a-collaborator-to-a-security-advisory.md index c182035648..eae7a3aedc 100644 --- a/content/github/managing-security-vulnerabilities/adding-a-collaborator-to-a-security-advisory.md +++ b/content/github/managing-security-vulnerabilities/adding-a-collaborator-to-a-security-advisory.md @@ -6,6 +6,8 @@ redirect_from: - /github/managing-security-vulnerabilities/adding-a-collaborator-to-a-maintainer-security-advisory versions: free-pro-team: '*' +topics: + - security --- People with admin permissions to a security advisory can add collaborators to the security advisory. diff --git a/content/github/managing-security-vulnerabilities/adding-a-security-policy-to-your-repository.md b/content/github/managing-security-vulnerabilities/adding-a-security-policy-to-your-repository.md index 756d594ba2..0d7b7ca563 100644 --- a/content/github/managing-security-vulnerabilities/adding-a-security-policy-to-your-repository.md +++ b/content/github/managing-security-vulnerabilities/adding-a-security-policy-to-your-repository.md @@ -5,6 +5,8 @@ redirect_from: - /articles/adding-a-security-policy-to-your-repository versions: free-pro-team: '*' +topics: + - security --- ### About security policies diff --git a/content/github/managing-security-vulnerabilities/browsing-security-vulnerabilities-in-the-github-advisory-database.md b/content/github/managing-security-vulnerabilities/browsing-security-vulnerabilities-in-the-github-advisory-database.md index a45c3564bf..12d047bb37 100644 --- a/content/github/managing-security-vulnerabilities/browsing-security-vulnerabilities-in-the-github-advisory-database.md +++ b/content/github/managing-security-vulnerabilities/browsing-security-vulnerabilities-in-the-github-advisory-database.md @@ -4,6 +4,8 @@ intro: 'The {% data variables.product.prodname_advisory_database %} allows you t shortTitle: Browsing the Advisory Database versions: free-pro-team: '*' +topics: + - security --- ### About security vulnerabilities diff --git a/content/github/managing-security-vulnerabilities/collaborating-in-a-temporary-private-fork-to-resolve-a-security-vulnerability.md b/content/github/managing-security-vulnerabilities/collaborating-in-a-temporary-private-fork-to-resolve-a-security-vulnerability.md index fb5e8e5a95..b4961194c4 100644 --- a/content/github/managing-security-vulnerabilities/collaborating-in-a-temporary-private-fork-to-resolve-a-security-vulnerability.md +++ b/content/github/managing-security-vulnerabilities/collaborating-in-a-temporary-private-fork-to-resolve-a-security-vulnerability.md @@ -5,6 +5,8 @@ redirect_from: - /articles/collaborating-in-a-temporary-private-fork-to-resolve-a-security-vulnerability versions: free-pro-team: '*' +topics: + - security --- ### Prerequisites diff --git a/content/github/managing-security-vulnerabilities/configuring-dependabot-security-updates.md b/content/github/managing-security-vulnerabilities/configuring-dependabot-security-updates.md index c1ae6ff87f..55c9e8a0b5 100644 --- a/content/github/managing-security-vulnerabilities/configuring-dependabot-security-updates.md +++ b/content/github/managing-security-vulnerabilities/configuring-dependabot-security-updates.md @@ -9,6 +9,8 @@ redirect_from: - /github/managing-security-vulnerabilities/configuring-github-dependabot-security-updates versions: free-pro-team: '*' +topics: + - security --- ### About configuring {% data variables.product.prodname_dependabot_security_updates %} diff --git a/content/github/managing-security-vulnerabilities/configuring-notifications-for-vulnerable-dependencies.md b/content/github/managing-security-vulnerabilities/configuring-notifications-for-vulnerable-dependencies.md index b1097a9342..c894222439 100644 --- a/content/github/managing-security-vulnerabilities/configuring-notifications-for-vulnerable-dependencies.md +++ b/content/github/managing-security-vulnerabilities/configuring-notifications-for-vulnerable-dependencies.md @@ -5,6 +5,8 @@ intro: 'Optimize how you receive notifications about {% if currentVersion == "f versions: free-pro-team: '*' enterprise-server: '>=2.21' +topics: + - security --- ### About notifications for vulnerable dependencies diff --git a/content/github/managing-security-vulnerabilities/creating-a-security-advisory.md b/content/github/managing-security-vulnerabilities/creating-a-security-advisory.md index fd713c6afb..983020feec 100644 --- a/content/github/managing-security-vulnerabilities/creating-a-security-advisory.md +++ b/content/github/managing-security-vulnerabilities/creating-a-security-advisory.md @@ -6,6 +6,8 @@ redirect_from: - /github/managing-security-vulnerabilities/creating-a-maintainer-security-advisory versions: free-pro-team: '*' +topics: + - security --- Anyone with admin permissions to a repository can create a security advisory. diff --git a/content/github/managing-security-vulnerabilities/editing-a-security-advisory.md b/content/github/managing-security-vulnerabilities/editing-a-security-advisory.md index d2914ae576..c60b339d43 100644 --- a/content/github/managing-security-vulnerabilities/editing-a-security-advisory.md +++ b/content/github/managing-security-vulnerabilities/editing-a-security-advisory.md @@ -3,6 +3,8 @@ title: Editing a security advisory intro: You can edit the metadata and description for a security advisory if you need to update details or correct errors. versions: free-pro-team: '*' +topics: + - security --- People with admin permissions to a security advisory can edit the security advisory. diff --git a/content/github/managing-security-vulnerabilities/index.md b/content/github/managing-security-vulnerabilities/index.md index 9501e51783..15eee0fe02 100644 --- a/content/github/managing-security-vulnerabilities/index.md +++ b/content/github/managing-security-vulnerabilities/index.md @@ -5,6 +5,8 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '*' +topics: + - security --- diff --git a/content/github/managing-security-vulnerabilities/managing-vulnerabilities-in-your-projects-dependencies.md b/content/github/managing-security-vulnerabilities/managing-vulnerabilities-in-your-projects-dependencies.md index 85d0c898be..145fe1516d 100644 --- a/content/github/managing-security-vulnerabilities/managing-vulnerabilities-in-your-projects-dependencies.md +++ b/content/github/managing-security-vulnerabilities/managing-vulnerabilities-in-your-projects-dependencies.md @@ -10,5 +10,7 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '*' +topics: + - security --- diff --git a/content/github/managing-security-vulnerabilities/permission-levels-for-security-advisories.md b/content/github/managing-security-vulnerabilities/permission-levels-for-security-advisories.md index a69030e7e2..80d91731a9 100644 --- a/content/github/managing-security-vulnerabilities/permission-levels-for-security-advisories.md +++ b/content/github/managing-security-vulnerabilities/permission-levels-for-security-advisories.md @@ -6,6 +6,8 @@ redirect_from: - /github/managing-security-vulnerabilities/permission-levels-for-maintainer-security-advisories versions: free-pro-team: '*' +topics: + - security --- ### Permissions overview diff --git a/content/github/managing-security-vulnerabilities/publishing-a-security-advisory.md b/content/github/managing-security-vulnerabilities/publishing-a-security-advisory.md index cde49eaca0..511a9bff69 100644 --- a/content/github/managing-security-vulnerabilities/publishing-a-security-advisory.md +++ b/content/github/managing-security-vulnerabilities/publishing-a-security-advisory.md @@ -6,6 +6,8 @@ redirect_from: - /github/managing-security-vulnerabilities/publishing-a-maintainer-security-advisory versions: free-pro-team: '*' +topics: + - security --- Anyone with admin permissions to a security advisory can publish the security advisory. diff --git a/content/github/managing-security-vulnerabilities/removing-a-collaborator-from-a-security-advisory.md b/content/github/managing-security-vulnerabilities/removing-a-collaborator-from-a-security-advisory.md index ff06ba0cb0..d3e2fbfb3d 100644 --- a/content/github/managing-security-vulnerabilities/removing-a-collaborator-from-a-security-advisory.md +++ b/content/github/managing-security-vulnerabilities/removing-a-collaborator-from-a-security-advisory.md @@ -3,6 +3,8 @@ title: Removing a collaborator from a security advisory intro: 'When you remove a collaborator from a security advisory, they lose read and write access to the security advisory''s discussion and metadata.' versions: free-pro-team: '*' +topics: + - security --- People with admin permissions to a security advisory can remove collaborators from the security advisory. diff --git a/content/github/managing-security-vulnerabilities/troubleshooting-dependabot-errors.md b/content/github/managing-security-vulnerabilities/troubleshooting-dependabot-errors.md index 5d9f2b85c4..fa7dcb49d7 100644 --- a/content/github/managing-security-vulnerabilities/troubleshooting-dependabot-errors.md +++ b/content/github/managing-security-vulnerabilities/troubleshooting-dependabot-errors.md @@ -6,6 +6,8 @@ redirect_from: - /github/managing-security-vulnerabilities/troubleshooting-github-dependabot-errors versions: free-pro-team: '*' +topics: + - security --- {% data reusables.dependabot.beta-note %} @@ -76,9 +78,20 @@ There are separate limits for security and version update pull requests, so that The best way to resolve this error is to merge or close some of the existing pull requests and trigger a new pull request manually. For more information, see "[Triggering a {% data variables.product.prodname_dependabot %} pull request manually](#triggering-a-dependabot-pull-request-manually)." -#### {% data variables.product.prodname_dependabot %} can't resolve your dependency files +#### {% data variables.product.prodname_dependabot %} can't resolve or access your dependencies -If {% data variables.product.prodname_dependabot %} attempts to check whether dependency references need to be updated in a repository, but can't access one or more of the referenced files, the operation will fail with the error message "{% data variables.product.prodname_dependabot %} can't resolve your LANGUAGE dependency files." The API error type is `git_dependencies_not_reachable`. +If {% data variables.product.prodname_dependabot %} attempts to check whether dependency references need to be updated in a repository, but can't access one or more of the referenced files, the operation will fail with the error message "{% data variables.product.prodname_dependabot %} can't resolve your LANGUAGE dependency files." The API error type is `git_dependencies_not_reachable`. + +Similarly, if {% data variables.product.prodname_dependabot %} can't access a private package registry in which a dependency is located, one of the following errors is generated: + +* "Dependabot can't reach a dependency in a private package registry"
+ (API error type: `private_source_not_reachable`) +* "Dependabot can't authenticate to a private package registry"
+ (API error type:`private_source_authentication_failure`) +* "Dependabot timed out while waiting for a private package registry"
+ (API error type:`private_source_timed_out`) +* "Dependabot couldn't validate the certificate for a private package registry"
+ (API error type:`private_source_certificate_failure`) To allow {% data variables.product.prodname_dependabot %} to update the dependency references successfully, make sure that all of the referenced dependencies are hosted at accessible locations. diff --git a/content/github/managing-security-vulnerabilities/troubleshooting-the-detection-of-vulnerable-dependencies.md b/content/github/managing-security-vulnerabilities/troubleshooting-the-detection-of-vulnerable-dependencies.md index ce6fe1bc8e..91aac50f13 100644 --- a/content/github/managing-security-vulnerabilities/troubleshooting-the-detection-of-vulnerable-dependencies.md +++ b/content/github/managing-security-vulnerabilities/troubleshooting-the-detection-of-vulnerable-dependencies.md @@ -4,6 +4,8 @@ intro: 'If the dependency information reported by {% data variables.product.prod shortTitle: Troubleshooting detection versions: free-pro-team: '*' +topics: + - security --- The results of dependency detection reported by {% data variables.product.product_name %} may be different from the results returned by other tools. There are good reasons for this and it's helpful to understand how {% data variables.product.prodname_dotcom %} determines dependencies for your project. diff --git a/content/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository.md b/content/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository.md index 532fddecb5..c1c2a5ea52 100644 --- a/content/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository.md +++ b/content/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository.md @@ -7,6 +7,8 @@ permissions: Repository administrators and organization owners can view and upda shortTitle: Viewing and updating vulnerable dependencies versions: free-pro-team: '*' +topics: + - security --- Your repository's {% data variables.product.prodname_dependabot %} alerts tab lists all open and closed {% data variables.product.prodname_dependabot_alerts %} and corresponding {% data variables.product.prodname_dependabot_security_updates %}. You can sort the list of alerts using the drop-down menu, and you can click into specific alerts for more details. For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)." diff --git a/content/github/managing-security-vulnerabilities/withdrawing-a-security-advisory.md b/content/github/managing-security-vulnerabilities/withdrawing-a-security-advisory.md index 90e0dd0d99..3c83e17230 100644 --- a/content/github/managing-security-vulnerabilities/withdrawing-a-security-advisory.md +++ b/content/github/managing-security-vulnerabilities/withdrawing-a-security-advisory.md @@ -3,6 +3,8 @@ title: Withdrawing a security advisory intro: You can withdraw a security advisory that you've published. versions: free-pro-team: '*' +topics: + - security --- If you publish a security advisory in error, you can withdraw the security advisory by contacting {% data variables.contact.contact_support %}. diff --git a/content/github/managing-subscriptions-and-notifications-on-github/about-notifications.md b/content/github/managing-subscriptions-and-notifications-on-github/about-notifications.md index b10f85762d..e7b5a97ca3 100644 --- a/content/github/managing-subscriptions-and-notifications-on-github/about-notifications.md +++ b/content/github/managing-subscriptions-and-notifications-on-github/about-notifications.md @@ -9,6 +9,8 @@ versions: free-pro-team: '*' enterprise-server: '>=2.21' github-ae: '*' +topics: + - notifications --- {% if enterpriseServerVersions contains currentVersion %} @@ -63,7 +65,7 @@ To keep your subscriptions manageable, review your subscriptions and watched rep To customize how you'd like to receive updates for specific pull requests or issues, you can configure your preferences within the issue or pull request. For more information, see “[Triaging a single notification](/github/managing-subscriptions-and-notifications-on-github/triaging-a-single-notification#customizing-when-to-receive-future-updates-for-an-issue-or-pull-request).” {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "2.22"%} -You can enable push notifications in the {% data variables.product.prodname_mobile %} app. For more information, see "[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#enabling-push-notifications-with-github-for-mobile)." +You can customize and schedule push notifications in the {% data variables.product.prodname_mobile %} app. For more information, see "[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#managing-your-notification-settings-with-github-for-mobile)." {% endif %} ### Reasons for receiving notifications diff --git a/content/github/managing-subscriptions-and-notifications-on-github/configuring-notifications.md b/content/github/managing-subscriptions-and-notifications-on-github/configuring-notifications.md index 64f25bd77b..d6ab248414 100644 --- a/content/github/managing-subscriptions-and-notifications-on-github/configuring-notifications.md +++ b/content/github/managing-subscriptions-and-notifications-on-github/configuring-notifications.md @@ -17,6 +17,8 @@ versions: free-pro-team: '*' enterprise-server: '>=2.21' github-ae: '*' +topics: + - notifications --- {% if enterpriseServerVersions contains currentVersion %} @@ -50,7 +52,7 @@ The notifications inbox on {% data variables.product.product_name %}{% if curren - Group notifications in your inbox by repository or date to get a quick overview with less context switching {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "2.22" %} -In addition, the notifications inbox on {% data variables.product.prodname_mobile %} allows you to triage notifications in dark mode and receive push notifications for direct mentions. For more information, see "[Enabling push notifications with GitHub for mobile](#enabling-push-notifications-with-github-for-mobile)" or "[GitHub for mobile](/github/getting-started-with-github/github-for-mobile)." +In addition, you can receive and triage notifications on your mobile device with {% data variables.product.prodname_mobile %}. For more information, see "[Managing your notification settings with GitHub for mobile](#managing-your-notification-settings-with-github-for-mobile)" or "[GitHub for mobile](/github/getting-started-with-github/github-for-mobile)." {% endif %} #### Benefits of using an email client for notifications @@ -63,7 +65,7 @@ Email notifications also allow flexibility with the types of notifications you r ### About participating and watching notifications -When you watch a repository, you're subscribing to updates for activity in that repository. Similarly, when you watch a specific team's discussions, you're subscribing to all conversation updates on that team's page. For more information, see "[About team discussions](/github/building-a-strong-community/about-team-discussions)." +When you watch a repository, you're subscribing to updates for activity in that repository. Similarly, when you watch a specific team's discussions, you're subscribing to all conversation updates on that team's page. For more information, see "[About team discussions](/github/setting-up-and-managing-organizations-and-teams/about-team-discussions)." To see repositories that you're watching, go to your [watching page](https://github.com/watching). For more information, see "[Managing subscriptions and notifications on GitHub](/github/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github)." {% if currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.20" %} @@ -152,6 +154,26 @@ By default, anytime you gain access to a new repository, you will automatically If "Automatically watch repositories" is disabled, then you will not automatically watch your own repositories. You must navigate to your repository page and choose the watch option. +### Configuring your watch settings for an individual repository + +You can choose whether to watch or unwatch an individual repository. You can also choose to only be notified of {% if currentVersion == "free-pro-team@latest" %}certain event types such as issues, pull requests, discussions (if enabled for the repository) and {% endif %}new releases, or completely ignore an individual repository. + +{% data reusables.repositories.navigate-to-repo %} +2. In the upper-right corner, click the "Watch" drop-down menu to select a watch option. +{% if currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.20" %} + ![Watch options in a drop-down menu for a repository](/assets/images/help/notifications-v2/watch-repository-options.png) +{% endif %} +{% if currentVersion == "free-pro-team@latest" %} + ![Watch options in a drop-down menu for a repository](/assets/images/help/notifications-v2/watch-repository-options-custom.png) +{% data reusables.notifications-v2.custom-notifications-beta %} +The **Custom** option allows you to further customize notifications so that you're only notified when specific events happen in the repository, in addition to participating and @mentions. + + ![Custom watch options in a drop-down menu for a repository](/assets/images/help/notifications-v2/watch-repository-options-custom2.png) + +If you select "Issues", you will be notified about, and subscribed to, updates on every issue (including those that existed prior to you selecting this option) in the repository. If you're @mentioned in a pull request in this repository, you'll receive notifications for that too, and you'll be subscribed to updates on that specific pull request, in addition to being notified about issues. + +{% endif %} + ### Choosing where your organization’s email notifications are sent If you belong to an organization, you can choose the email account you want notifications for organization activity sent to. For example, if you belong to an organization for work, you may want your notifications sent to your work email address, rather than your personal address. @@ -200,28 +222,41 @@ Choose how you want to receive workflow run updates for repositories that you ar {% endif %} {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "2.22" %} -### Enabling push notifications with {% data variables.product.prodname_mobile %} +### Managing your notification settings with {% data variables.product.prodname_mobile %} -When you install {% data variables.product.prodname_mobile %}, you will automatically be opted into web notifications. You can then enable push notifications for direct mentions within the app. +When you install {% data variables.product.prodname_mobile %}, you will automatically be opted into web notifications. Within the app, you can enable push notifications for the following events. +- Direct mentions +- Assignments to issues or pull requests +- Requests to review a pull request +- Requests to approve a deployment -You can only receive notifications for pushes to repositories on {% data variables.product.prodname_mobile %} at this time. +You can also schedule when {% data variables.product.prodname_mobile %} will send push notifications to your mobile device. {% data reusables.mobile.push-notifications-on-ghes %} -#### Enabling push notifications with {% data variables.product.prodname_ios %} +#### Managing your notification settings with {% data variables.product.prodname_ios %} -1. Above "Home", tap your profile photo. +1. In the bottom menu, tap **Profile**. 2. To view your settings, tap {% octicon "gear" aria-label="The Gear icon" %}. - ![Settings icon for GitHub for iOS](/assets/images/help/mobile/ios-settings-icon.png) -3. To update your notification settings, tap **Push notifications**. -4. To turn on push notifications for direct mentions, use the **Direct Mentions** toggle. +3. To update your notification settings, tap **Notifications** and then use the toggles to enable or disable your preferred types of push notifications. +4. Optionally, to schedule when {% data variables.product.prodname_mobile %} will send push notifications to your mobile device, tap **Working Hours**, use the **Custom working hours** toggle, and then choose when you would like to receive push notifications. -{% if currentVersion == "free-pro-team@latest" %} -#### Enabling push notifications with {% data variables.product.prodname_android %} +#### Managing your notification settings with {% data variables.product.prodname_android %} -1. Above "Home", tap your profile photo. +1. In the bottom menu, tap **Profile**. 2. To view your settings, tap {% octicon "gear" aria-label="The Gear icon" %}. - ![Settings icon for GitHub for Android](/assets/images/help/mobile/android-settings-icon.png) -3. To turn on push notifications for direct mentions, use the **Direct mentions** toggle. +3. To update your notification settings, tap **Notifications** and then use the toggles to enable or disable your preferred types of push notifications. +4. Optionally, to schedule when {% data variables.product.prodname_mobile %} will send push notifications to your mobile device, tap **Receive Notifications**, use the **Custom working hours** toggle, and then choose when you would like to receive push notifications. + +### Configuring your watch settings for an individual repository with {% data variables.product.prodname_mobile %} + +You can choose whether to watch or unwatch an individual repository. You can also choose to only be notified of {% if currentVersion == "free-pro-team@latest" %}certain event types such as issues, pull requests, discussions (if enabled for the repository) and {% endif %}new releases, or completely ignore an individual repository. + +1. On {% data variables.product.prodname_mobile %}, navigate to main page of the repository. +2. Tap **Watch**. + ![The watch button on {% data variables.product.prodname_mobile %}](/assets/images/help/notifications-v2/mobile-watch-button.png) +3. To choose what activities you receive notifications for, tap your preferred watch settings. + ![Watch settings dropdown menu in {% data variables.product.prodname_mobile %}](/assets/images/help/notifications-v2/mobile-watch-settings.png) +{% data reusables.notifications-v2.custom-notifications-beta %} + {% endif %} -{% endif %} \ No newline at end of file diff --git a/content/github/managing-subscriptions-and-notifications-on-github/customizing-a-workflow-for-triaging-your-notifications.md b/content/github/managing-subscriptions-and-notifications-on-github/customizing-a-workflow-for-triaging-your-notifications.md index 8a458d1456..bfc6a6038a 100644 --- a/content/github/managing-subscriptions-and-notifications-on-github/customizing-a-workflow-for-triaging-your-notifications.md +++ b/content/github/managing-subscriptions-and-notifications-on-github/customizing-a-workflow-for-triaging-your-notifications.md @@ -5,6 +5,8 @@ versions: free-pro-team: '*' enterprise-server: '>=2.21' github-ae: '*' +topics: + - notifications --- ### Starting your inbox triage diff --git a/content/github/managing-subscriptions-and-notifications-on-github/index.md b/content/github/managing-subscriptions-and-notifications-on-github/index.md index ed54e4ee58..2ac3e96335 100644 --- a/content/github/managing-subscriptions-and-notifications-on-github/index.md +++ b/content/github/managing-subscriptions-and-notifications-on-github/index.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '>=2.21' github-ae: '*' +topics: + - notifications --- ### Table of Contents diff --git a/content/github/managing-subscriptions-and-notifications-on-github/managing-notifications-from-your-inbox.md b/content/github/managing-subscriptions-and-notifications-on-github/managing-notifications-from-your-inbox.md index 5e5c8949b4..506a577ecf 100644 --- a/content/github/managing-subscriptions-and-notifications-on-github/managing-notifications-from-your-inbox.md +++ b/content/github/managing-subscriptions-and-notifications-on-github/managing-notifications-from-your-inbox.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '>=2.21' github-ae: '*' +topics: + - notifications --- {% if enterpriseServerVersions contains currentVersion %} diff --git a/content/github/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github.md b/content/github/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github.md index 57f54410c0..4783be44f1 100644 --- a/content/github/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github.md +++ b/content/github/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github.md @@ -6,5 +6,7 @@ versions: free-pro-team: '*' enterprise-server: '>=2.21' github-ae: '*' +topics: + - notifications --- diff --git a/content/github/managing-subscriptions-and-notifications-on-github/managing-your-subscriptions.md b/content/github/managing-subscriptions-and-notifications-on-github/managing-your-subscriptions.md index d947f274cb..41501f058e 100644 --- a/content/github/managing-subscriptions-and-notifications-on-github/managing-your-subscriptions.md +++ b/content/github/managing-subscriptions-and-notifications-on-github/managing-your-subscriptions.md @@ -5,6 +5,8 @@ versions: free-pro-team: '*' enterprise-server: '>=2.21' github-ae: '*' +topics: + - notifications --- To help you understand your subscriptions and decide whether to unsubscribe, see "[Viewing your subscriptions](/github/managing-subscriptions-and-notifications-on-github/viewing-your-subscriptions)." diff --git a/content/github/managing-subscriptions-and-notifications-on-github/setting-up-notifications.md b/content/github/managing-subscriptions-and-notifications-on-github/setting-up-notifications.md index ba87f0c7c0..7995dcba50 100644 --- a/content/github/managing-subscriptions-and-notifications-on-github/setting-up-notifications.md +++ b/content/github/managing-subscriptions-and-notifications-on-github/setting-up-notifications.md @@ -8,5 +8,7 @@ versions: free-pro-team: '*' enterprise-server: '>=2.21' github-ae: '*' +topics: + - notifications --- diff --git a/content/github/managing-subscriptions-and-notifications-on-github/triaging-a-single-notification.md b/content/github/managing-subscriptions-and-notifications-on-github/triaging-a-single-notification.md index a6210db1b2..6214d8b1ea 100644 --- a/content/github/managing-subscriptions-and-notifications-on-github/triaging-a-single-notification.md +++ b/content/github/managing-subscriptions-and-notifications-on-github/triaging-a-single-notification.md @@ -5,6 +5,8 @@ versions: free-pro-team: '*' enterprise-server: '>=2.21' github-ae: '*' +topics: + - notifications --- ### Saving a single notification diff --git a/content/github/managing-subscriptions-and-notifications-on-github/viewing-and-triaging-notifications.md b/content/github/managing-subscriptions-and-notifications-on-github/viewing-and-triaging-notifications.md index 761e8487ea..1d23e517b8 100644 --- a/content/github/managing-subscriptions-and-notifications-on-github/viewing-and-triaging-notifications.md +++ b/content/github/managing-subscriptions-and-notifications-on-github/viewing-and-triaging-notifications.md @@ -9,5 +9,7 @@ versions: free-pro-team: '*' enterprise-server: '>=2.21' github-ae: '*' +topics: + - notifications --- diff --git a/content/github/managing-subscriptions-and-notifications-on-github/viewing-your-subscriptions.md b/content/github/managing-subscriptions-and-notifications-on-github/viewing-your-subscriptions.md index fa4321a743..bdc6a0d93b 100644 --- a/content/github/managing-subscriptions-and-notifications-on-github/viewing-your-subscriptions.md +++ b/content/github/managing-subscriptions-and-notifications-on-github/viewing-your-subscriptions.md @@ -18,6 +18,8 @@ versions: free-pro-team: '*' enterprise-server: '>=2.21' github-ae: '*' +topics: + - notifications --- You receive notifications for your subscriptions of ongoing activity on {% data variables.product.product_name %}. There are many reasons you can be subscribed to a conversation. For more information, see "[About notifications](/github/managing-subscriptions-and-notifications-on-github/about-notifications#notifications-and-subscriptions)." @@ -81,23 +83,3 @@ Many people forget about repositories that they've chosen to watch in the past. When you unwatch a repository, you can still be notified when you're @mentioned or participating in a thread. When you configure to receive notifications for certain event types, you're only notified when there are updates to these event types in the repository, you're participating in a thread, or you or a team you're on is @mentioned. {% endtip %} - -### Configuring your watch settings for an individual repository - -You can choose whether to watch or unwatch an individual repository. You can also choose to only be notified of {% if currentVersion == "free-pro-team@latest" %}certain event types such as issues, pull requests, discussions (if enabled for the repository) and {% endif %}new releases, or completely ignore an individual repository. - -{% data reusables.repositories.navigate-to-repo %} -2. In the upper-right corner, click the "Watch" drop-down menu to select a watch option. -{% if currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.20" %} - ![Watch options in a drop-down menu for a repository](/assets/images/help/notifications-v2/watch-repository-options.png) -{% endif %} -{% if currentVersion == "free-pro-team@latest" %} - ![Watch options in a drop-down menu for a repository](/assets/images/help/notifications-v2/watch-repository-options-custom.png) -{% data reusables.notifications-v2.custom-notifications-beta %} -The **Custom** option allows you to further customize notifications so that you're only notified when specific events happen in the repository, in addition to participating and @mentions. - - ![Custom watch options in a drop-down menu for a repository](/assets/images/help/notifications-v2/watch-repository-options-custom2.png) - -If you select "Issues", you will be notified about, and subscribed to, updates on every issue (including those that existed prior to you selecting this option) in the repository. If you're @mentioned in a pull request in this repository, you'll receive notifications for that too, and you'll be subscribed to updates on that specific pull request, in addition to being notified about issues. - -{% endif %} diff --git a/content/github/managing-your-work-on-github/about-automation-for-issues-and-pull-requests-with-query-parameters.md b/content/github/managing-your-work-on-github/about-automation-for-issues-and-pull-requests-with-query-parameters.md index 39b913c7c2..010c9aea63 100644 --- a/content/github/managing-your-work-on-github/about-automation-for-issues-and-pull-requests-with-query-parameters.md +++ b/content/github/managing-your-work-on-github/about-automation-for-issues-and-pull-requests-with-query-parameters.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- Query parameters are optional parts of a URL you can customize to share a specific web page view, such as search filter results or an issue template on {% data variables.product.prodname_dotcom %}. To create your own query parameters, you must match the key and value pair. diff --git a/content/github/managing-your-work-on-github/about-automation-for-project-boards.md b/content/github/managing-your-work-on-github/about-automation-for-project-boards.md index 1a6b04071a..1fcade4aa0 100644 --- a/content/github/managing-your-work-on-github/about-automation-for-project-boards.md +++ b/content/github/managing-your-work-on-github/about-automation-for-project-boards.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- {% data reusables.project-management.automate-project-board-permissions %} For more information, see "[Project board permissions for an organization](/articles/project-board-permissions-for-an-organization)." diff --git a/content/github/managing-your-work-on-github/about-duplicate-issues-and-pull-requests.md b/content/github/managing-your-work-on-github/about-duplicate-issues-and-pull-requests.md index f1b544a094..9f7ec04b68 100644 --- a/content/github/managing-your-work-on-github/about-duplicate-issues-and-pull-requests.md +++ b/content/github/managing-your-work-on-github/about-duplicate-issues-and-pull-requests.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- For a "marked as duplicate" timeline event to appear, the user who creates the duplicate reference comment must have write access to the repository where they create the comment. diff --git a/content/github/managing-your-work-on-github/about-issues.md b/content/github/managing-your-work-on-github/about-issues.md index 9500408071..fee3c09c34 100644 --- a/content/github/managing-your-work-on-github/about-issues.md +++ b/content/github/managing-your-work-on-github/about-issues.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- ### About issues diff --git a/content/github/managing-your-work-on-github/about-milestones.md b/content/github/managing-your-work-on-github/about-milestones.md index 27238a9b73..2b3ae8c27f 100644 --- a/content/github/managing-your-work-on-github/about-milestones.md +++ b/content/github/managing-your-work-on-github/about-milestones.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- When you [create a milestone](/articles/creating-and-editing-milestones-for-issues-and-pull-requests), you can [associate it with issues and pull requests](/articles/associating-milestones-with-issues-and-pull-requests). diff --git a/content/github/managing-your-work-on-github/about-project-boards.md b/content/github/managing-your-work-on-github/about-project-boards.md index da22dbe579..69c4caa8fc 100644 --- a/content/github/managing-your-work-on-github/about-project-boards.md +++ b/content/github/managing-your-work-on-github/about-project-boards.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- Project boards are made up of issues, pull requests, and notes that are categorized as cards in columns of your choosing. You can drag and drop or use keyboard shortcuts to reorder cards within a column, move cards from column to column, and change the order of columns. diff --git a/content/github/managing-your-work-on-github/about-task-lists.md b/content/github/managing-your-work-on-github/about-task-lists.md index 250c4684a9..d0407d4813 100644 --- a/content/github/managing-your-work-on-github/about-task-lists.md +++ b/content/github/managing-your-work-on-github/about-task-lists.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- Task lists render with clickable checkboxes in comments. You can select or unselect the checkboxes to mark them as complete or incomplete. diff --git a/content/github/managing-your-work-on-github/adding-issues-and-pull-requests-to-a-project-board.md b/content/github/managing-your-work-on-github/adding-issues-and-pull-requests-to-a-project-board.md index 028e0c5031..89d954f6b8 100644 --- a/content/github/managing-your-work-on-github/adding-issues-and-pull-requests-to-a-project-board.md +++ b/content/github/managing-your-work-on-github/adding-issues-and-pull-requests-to-a-project-board.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- You can add issue or pull request cards to your project board by: diff --git a/content/github/managing-your-work-on-github/adding-notes-to-a-project-board.md b/content/github/managing-your-work-on-github/adding-notes-to-a-project-board.md index 87761cc8b8..1361bcea63 100644 --- a/content/github/managing-your-work-on-github/adding-notes-to-a-project-board.md +++ b/content/github/managing-your-work-on-github/adding-notes-to-a-project-board.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- {% tip %} diff --git a/content/github/managing-your-work-on-github/archiving-cards-on-a-project-board.md b/content/github/managing-your-work-on-github/archiving-cards-on-a-project-board.md index cc7eb1dd66..b6b513b8cf 100644 --- a/content/github/managing-your-work-on-github/archiving-cards-on-a-project-board.md +++ b/content/github/managing-your-work-on-github/archiving-cards-on-a-project-board.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- Automation in your project board does not apply to archived project board cards. For example, if you close an issue in a project board's archive, the archived card does not automatically move to the "Done" column. When you restore a card from the project board archive, the card will return to the column where it was archived. diff --git a/content/github/managing-your-work-on-github/assigning-issues-and-pull-requests-to-other-github-users.md b/content/github/managing-your-work-on-github/assigning-issues-and-pull-requests-to-other-github-users.md index c9feda552b..d3704545bb 100644 --- a/content/github/managing-your-work-on-github/assigning-issues-and-pull-requests-to-other-github-users.md +++ b/content/github/managing-your-work-on-github/assigning-issues-and-pull-requests-to-other-github-users.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- Anyone with write permissions to a repository can assign issues and pull requests. diff --git a/content/github/managing-your-work-on-github/associating-milestones-with-issues-and-pull-requests.md b/content/github/managing-your-work-on-github/associating-milestones-with-issues-and-pull-requests.md index 73f110edab..2b6bc1cbda 100644 --- a/content/github/managing-your-work-on-github/associating-milestones-with-issues-and-pull-requests.md +++ b/content/github/managing-your-work-on-github/associating-milestones-with-issues-and-pull-requests.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- {% data reusables.repositories.navigate-to-repo %} diff --git a/content/github/managing-your-work-on-github/changing-project-board-visibility.md b/content/github/managing-your-work-on-github/changing-project-board-visibility.md index 0ecd5477f4..34b68877bd 100644 --- a/content/github/managing-your-work-on-github/changing-project-board-visibility.md +++ b/content/github/managing-your-work-on-github/changing-project-board-visibility.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- {% data reusables.project-management.project-board-visibility %} diff --git a/content/github/managing-your-work-on-github/closing-a-project-board.md b/content/github/managing-your-work-on-github/closing-a-project-board.md index 57b8586d71..5d0f001f70 100644 --- a/content/github/managing-your-work-on-github/closing-a-project-board.md +++ b/content/github/managing-your-work-on-github/closing-a-project-board.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- When you close a project board, any configured workflow automation will pause by default. diff --git a/content/github/managing-your-work-on-github/configuring-automation-for-project-boards.md b/content/github/managing-your-work-on-github/configuring-automation-for-project-boards.md index 037b6efa7c..7289b952f4 100644 --- a/content/github/managing-your-work-on-github/configuring-automation-for-project-boards.md +++ b/content/github/managing-your-work-on-github/configuring-automation-for-project-boards.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- {% data reusables.project-management.automate-project-board-permissions %} For more information, see "[About automation for project boards](/articles/about-automation-for-project-boards)." diff --git a/content/github/managing-your-work-on-github/copying-a-project-board.md b/content/github/managing-your-work-on-github/copying-a-project-board.md index 1d7225e79e..6b6f7afefc 100644 --- a/content/github/managing-your-work-on-github/copying-a-project-board.md +++ b/content/github/managing-your-work-on-github/copying-a-project-board.md @@ -5,6 +5,8 @@ redirect_from: - /articles/copying-a-project-board versions: free-pro-team: '*' +topics: + - pull requests --- Copying a project board allows you to reuse a project board's title, description, and automation configuration. You can copy project boards to eliminate the manual process of creating new project boards for similar workflows. diff --git a/content/github/managing-your-work-on-github/creating-a-permanent-link-to-a-code-snippet.md b/content/github/managing-your-work-on-github/creating-a-permanent-link-to-a-code-snippet.md index 283530bf8d..f8f251b394 100644 --- a/content/github/managing-your-work-on-github/creating-a-permanent-link-to-a-code-snippet.md +++ b/content/github/managing-your-work-on-github/creating-a-permanent-link-to-a-code-snippet.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- This type of permanent link will render as a code snippet only in the repository it originated in. In other repositories, the permalink code snippet will render as a URL. diff --git a/content/github/managing-your-work-on-github/creating-a-project-board.md b/content/github/managing-your-work-on-github/creating-a-project-board.md index 77f0193882..4d4021f5a2 100644 --- a/content/github/managing-your-work-on-github/creating-a-project-board.md +++ b/content/github/managing-your-work-on-github/creating-a-project-board.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- {% data reusables.project-management.use-automated-template %} diff --git a/content/github/managing-your-work-on-github/creating-an-issue.md b/content/github/managing-your-work-on-github/creating-an-issue.md index bd2ff8d5a3..b0d3ea02a8 100644 --- a/content/github/managing-your-work-on-github/creating-an-issue.md +++ b/content/github/managing-your-work-on-github/creating-an-issue.md @@ -1,13 +1,15 @@ --- title: Creating an issue intro: 'Issues can be used to keep track of bugs, enhancements, or other requests.' -permissions: 'People with read permissions can create an issue in a repository where issues are enabled.' +permissions: People with read permissions can create an issue in a repository where issues are enabled. redirect_from: - /articles/creating-an-issue versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- You can open a new issue based on code from an existing pull request. For more information, see "[Opening an issue from code](/github/managing-your-work-on-github/opening-an-issue-from-code)." diff --git a/content/github/managing-your-work-on-github/creating-and-editing-milestones-for-issues-and-pull-requests.md b/content/github/managing-your-work-on-github/creating-and-editing-milestones-for-issues-and-pull-requests.md index 0524cf9237..d8e3ae3338 100644 --- a/content/github/managing-your-work-on-github/creating-and-editing-milestones-for-issues-and-pull-requests.md +++ b/content/github/managing-your-work-on-github/creating-and-editing-milestones-for-issues-and-pull-requests.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- {% data reusables.repositories.navigate-to-repo %} diff --git a/content/github/managing-your-work-on-github/deleting-a-project-board.md b/content/github/managing-your-work-on-github/deleting-a-project-board.md index 365d7a03bc..edff31371e 100644 --- a/content/github/managing-your-work-on-github/deleting-a-project-board.md +++ b/content/github/managing-your-work-on-github/deleting-a-project-board.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- {% tip %} diff --git a/content/github/managing-your-work-on-github/deleting-an-issue.md b/content/github/managing-your-work-on-github/deleting-an-issue.md index 705f41ff5a..0a087f1297 100644 --- a/content/github/managing-your-work-on-github/deleting-an-issue.md +++ b/content/github/managing-your-work-on-github/deleting-an-issue.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- You can only delete issues in a repository owned by your user account. You cannot delete issues in a repository owned by another user account, even if you are a collaborator there. diff --git a/content/github/managing-your-work-on-github/disabling-issues.md b/content/github/managing-your-work-on-github/disabling-issues.md index 469bd2bac8..eb8ea5c679 100644 --- a/content/github/managing-your-work-on-github/disabling-issues.md +++ b/content/github/managing-your-work-on-github/disabling-issues.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} diff --git a/content/github/managing-your-work-on-github/disabling-project-boards-in-a-repository.md b/content/github/managing-your-work-on-github/disabling-project-boards-in-a-repository.md index 5a3d679fd6..c6d6970768 100644 --- a/content/github/managing-your-work-on-github/disabling-project-boards-in-a-repository.md +++ b/content/github/managing-your-work-on-github/disabling-project-boards-in-a-repository.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- When you disable project boards, you will no longer see project board information in timelines or [audit logs](/articles/reviewing-your-security-log/). diff --git a/content/github/managing-your-work-on-github/disabling-project-boards-in-your-organization.md b/content/github/managing-your-work-on-github/disabling-project-boards-in-your-organization.md index 6b5579d3b6..e944f2866f 100644 --- a/content/github/managing-your-work-on-github/disabling-project-boards-in-your-organization.md +++ b/content/github/managing-your-work-on-github/disabling-project-boards-in-your-organization.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- After you disable organization-wide project boards, it won’t be possible to create new project boards at the organization level, and any existing organization-level project boards will become inaccessible at their previous URLs. Project boards in repositories in the organization are not affected. diff --git a/content/github/managing-your-work-on-github/editing-a-project-board.md b/content/github/managing-your-work-on-github/editing-a-project-board.md index 0f9e5c977c..e9cc53d326 100644 --- a/content/github/managing-your-work-on-github/editing-a-project-board.md +++ b/content/github/managing-your-work-on-github/editing-a-project-board.md @@ -9,6 +9,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- {% tip %} diff --git a/content/github/managing-your-work-on-github/file-attachments-on-issues-and-pull-requests.md b/content/github/managing-your-work-on-github/file-attachments-on-issues-and-pull-requests.md index 4abe40a38f..abb1ae4b48 100644 --- a/content/github/managing-your-work-on-github/file-attachments-on-issues-and-pull-requests.md +++ b/content/github/managing-your-work-on-github/file-attachments-on-issues-and-pull-requests.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- {% warning %} diff --git a/content/github/managing-your-work-on-github/filtering-cards-on-a-project-board.md b/content/github/managing-your-work-on-github/filtering-cards-on-a-project-board.md index a4a1ee3f6f..4b1a22b3be 100644 --- a/content/github/managing-your-work-on-github/filtering-cards-on-a-project-board.md +++ b/content/github/managing-your-work-on-github/filtering-cards-on-a-project-board.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- On a card, you can click any assignee, milestone, or label to filter the project board by that qualifier. To clear the search, you can click the same assignee, milestone, or label again. diff --git a/content/github/managing-your-work-on-github/filtering-issues-and-pull-requests-by-assignees.md b/content/github/managing-your-work-on-github/filtering-issues-and-pull-requests-by-assignees.md index e04db9f312..e39fd884ff 100644 --- a/content/github/managing-your-work-on-github/filtering-issues-and-pull-requests-by-assignees.md +++ b/content/github/managing-your-work-on-github/filtering-issues-and-pull-requests-by-assignees.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- {% data reusables.cli.filter-issues-and-pull-requests-tip %} diff --git a/content/github/managing-your-work-on-github/filtering-issues-and-pull-requests-by-labels.md b/content/github/managing-your-work-on-github/filtering-issues-and-pull-requests-by-labels.md index d0ad982702..33f6798afe 100644 --- a/content/github/managing-your-work-on-github/filtering-issues-and-pull-requests-by-labels.md +++ b/content/github/managing-your-work-on-github/filtering-issues-and-pull-requests-by-labels.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- {% data reusables.cli.filter-issues-and-pull-requests-tip %} diff --git a/content/github/managing-your-work-on-github/filtering-issues-and-pull-requests-by-milestone.md b/content/github/managing-your-work-on-github/filtering-issues-and-pull-requests-by-milestone.md index d6c96b95d7..4f6d7d3eca 100644 --- a/content/github/managing-your-work-on-github/filtering-issues-and-pull-requests-by-milestone.md +++ b/content/github/managing-your-work-on-github/filtering-issues-and-pull-requests-by-milestone.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- {% tip %} diff --git a/content/github/managing-your-work-on-github/filtering-issues-and-pull-requests.md b/content/github/managing-your-work-on-github/filtering-issues-and-pull-requests.md index 8459b5dd4d..a59627be7d 100644 --- a/content/github/managing-your-work-on-github/filtering-issues-and-pull-requests.md +++ b/content/github/managing-your-work-on-github/filtering-issues-and-pull-requests.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- {% data reusables.search.requested_reviews_search %} diff --git a/content/github/managing-your-work-on-github/filtering-pull-requests-by-review-status.md b/content/github/managing-your-work-on-github/filtering-pull-requests-by-review-status.md index 58bd074a17..1d633e08f3 100644 --- a/content/github/managing-your-work-on-github/filtering-pull-requests-by-review-status.md +++ b/content/github/managing-your-work-on-github/filtering-pull-requests-by-review-status.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- You can filter a repository's list of pull requests to find: diff --git a/content/github/managing-your-work-on-github/finding-information-in-a-repository.md b/content/github/managing-your-work-on-github/finding-information-in-a-repository.md index ccc776aa0e..d90d3de261 100644 --- a/content/github/managing-your-work-on-github/finding-information-in-a-repository.md +++ b/content/github/managing-your-work-on-github/finding-information-in-a-repository.md @@ -8,5 +8,7 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- diff --git a/content/github/managing-your-work-on-github/index.md b/content/github/managing-your-work-on-github/index.md index eb501619b0..a425a1a411 100644 --- a/content/github/managing-your-work-on-github/index.md +++ b/content/github/managing-your-work-on-github/index.md @@ -9,6 +9,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- diff --git a/content/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue.md b/content/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue.md index e99658d64f..b41b7ab75f 100644 --- a/content/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue.md +++ b/content/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue.md @@ -1,6 +1,6 @@ --- title: Linking a pull request to an issue -intro: 'You can link a pull request to an issue to show that a fix is in progress and to automatically close the issue when the pull request is merged.' +intro: You can link a pull request to an issue to show that a fix is in progress and to automatically close the issue when the pull request is merged. redirect_from: - /articles/closing-issues-via-commit-message/ - /articles/closing-issues-via-commit-messages/ @@ -10,6 +10,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- {% note %} diff --git a/content/github/managing-your-work-on-github/linking-a-repository-to-a-project-board.md b/content/github/managing-your-work-on-github/linking-a-repository-to-a-project-board.md index e394df5c31..ee6c964732 100644 --- a/content/github/managing-your-work-on-github/linking-a-repository-to-a-project-board.md +++ b/content/github/managing-your-work-on-github/linking-a-repository-to-a-project-board.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- diff --git a/content/github/managing-your-work-on-github/managing-labels.md b/content/github/managing-your-work-on-github/managing-labels.md index 09e093c6b8..99a825c458 100644 --- a/content/github/managing-your-work-on-github/managing-labels.md +++ b/content/github/managing-your-work-on-github/managing-labels.md @@ -21,6 +21,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- ### About labels diff --git a/content/github/managing-your-work-on-github/managing-project-boards.md b/content/github/managing-your-work-on-github/managing-project-boards.md index 4ecbcf476f..ccc1c55316 100644 --- a/content/github/managing-your-work-on-github/managing-project-boards.md +++ b/content/github/managing-your-work-on-github/managing-project-boards.md @@ -8,5 +8,7 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- diff --git a/content/github/managing-your-work-on-github/managing-your-work-with-issues-and-pull-requests.md b/content/github/managing-your-work-on-github/managing-your-work-with-issues-and-pull-requests.md index 7627c87e95..b8e7517513 100644 --- a/content/github/managing-your-work-on-github/managing-your-work-with-issues-and-pull-requests.md +++ b/content/github/managing-your-work-on-github/managing-your-work-with-issues-and-pull-requests.md @@ -9,5 +9,7 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- diff --git a/content/github/managing-your-work-on-github/opening-an-issue-from-a-comment.md b/content/github/managing-your-work-on-github/opening-an-issue-from-a-comment.md index 64b72de5fd..644415774a 100644 --- a/content/github/managing-your-work-on-github/opening-an-issue-from-a-comment.md +++ b/content/github/managing-your-work-on-github/opening-an-issue-from-a-comment.md @@ -1,11 +1,13 @@ --- title: Opening an issue from a comment intro: You can open a new issue from a specific comment in an issue or pull request. -permissions: 'People with read permissions can create an issue in a repository where issues are enabled.' +permissions: People with read permissions can create an issue in a repository where issues are enabled. versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- When you open an issue from a comment, the issue contains a snippet showing where the comment was originally posted. diff --git a/content/github/managing-your-work-on-github/opening-an-issue-from-code.md b/content/github/managing-your-work-on-github/opening-an-issue-from-code.md index 583221530d..9b07c631a2 100644 --- a/content/github/managing-your-work-on-github/opening-an-issue-from-code.md +++ b/content/github/managing-your-work-on-github/opening-an-issue-from-code.md @@ -1,13 +1,15 @@ --- title: Opening an issue from code intro: You can open a new issue from a specific line or lines of code in a file or pull request. -permissions: 'People with read permissions can create an issue in a repository where issues are enabled.' +permissions: People with read permissions can create an issue in a repository where issues are enabled. redirect_from: - /articles/opening-an-issue-from-code versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- When you open an issue from code, the issue contains a snippet showing the line or range of code you chose. You can only open an issue in the same repository where the code is stored. diff --git a/content/github/managing-your-work-on-github/pinning-an-issue-to-your-repository.md b/content/github/managing-your-work-on-github/pinning-an-issue-to-your-repository.md index 6786f5add2..4b8baf8b85 100644 --- a/content/github/managing-your-work-on-github/pinning-an-issue-to-your-repository.md +++ b/content/github/managing-your-work-on-github/pinning-an-issue-to-your-repository.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- ![Pinned issues](/assets/images/help/issues/pinned-issues.png) diff --git a/content/github/managing-your-work-on-github/reopening-a-closed-project-board.md b/content/github/managing-your-work-on-github/reopening-a-closed-project-board.md index 4ddda31852..17939004ef 100644 --- a/content/github/managing-your-work-on-github/reopening-a-closed-project-board.md +++ b/content/github/managing-your-work-on-github/reopening-a-closed-project-board.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- When you close a project board, any workflow automation that was configured for the project board will pause by default. For more information, see "[Closing a project board](/articles/closing-a-project-board)." diff --git a/content/github/managing-your-work-on-github/sharing-filters.md b/content/github/managing-your-work-on-github/sharing-filters.md index deaa2e4d84..8575fb7e80 100644 --- a/content/github/managing-your-work-on-github/sharing-filters.md +++ b/content/github/managing-your-work-on-github/sharing-filters.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- You can send the URL that issues generates to any user, and they'll be able to see the same filter view that you see. diff --git a/content/github/managing-your-work-on-github/sorting-issues-and-pull-requests.md b/content/github/managing-your-work-on-github/sorting-issues-and-pull-requests.md index 0137ba5be2..9decbf89e3 100644 --- a/content/github/managing-your-work-on-github/sorting-issues-and-pull-requests.md +++ b/content/github/managing-your-work-on-github/sorting-issues-and-pull-requests.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- You can sort any filtered view by: diff --git a/content/github/managing-your-work-on-github/tracking-progress-on-your-project-board.md b/content/github/managing-your-work-on-github/tracking-progress-on-your-project-board.md index dd4915bbee..6eb703d108 100644 --- a/content/github/managing-your-work-on-github/tracking-progress-on-your-project-board.md +++ b/content/github/managing-your-work-on-github/tracking-progress-on-your-project-board.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- {% data reusables.project-management.project-progress-locations %} diff --git a/content/github/managing-your-work-on-github/tracking-the-progress-of-your-work-with-milestones.md b/content/github/managing-your-work-on-github/tracking-the-progress-of-your-work-with-milestones.md index 289f06851c..081bd66cfd 100644 --- a/content/github/managing-your-work-on-github/tracking-the-progress-of-your-work-with-milestones.md +++ b/content/github/managing-your-work-on-github/tracking-the-progress-of-your-work-with-milestones.md @@ -8,5 +8,7 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- diff --git a/content/github/managing-your-work-on-github/tracking-the-progress-of-your-work-with-project-boards.md b/content/github/managing-your-work-on-github/tracking-the-progress-of-your-work-with-project-boards.md index 6bdc399895..9ad7f25801 100644 --- a/content/github/managing-your-work-on-github/tracking-the-progress-of-your-work-with-project-boards.md +++ b/content/github/managing-your-work-on-github/tracking-the-progress-of-your-work-with-project-boards.md @@ -9,5 +9,7 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- diff --git a/content/github/managing-your-work-on-github/transferring-an-issue-to-another-repository.md b/content/github/managing-your-work-on-github/transferring-an-issue-to-another-repository.md index 64920e0815..d7c5ba7a59 100644 --- a/content/github/managing-your-work-on-github/transferring-an-issue-to-another-repository.md +++ b/content/github/managing-your-work-on-github/transferring-an-issue-to-another-repository.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- To transfer an open issue to another repository, you must have write permissions on the repository the issue is in and the repository you're transferring the issue to. For more information, see "[Repository permission levels for an organization](/articles/repository-permission-levels-for-an-organization)." diff --git a/content/github/managing-your-work-on-github/using-search-to-filter-issues-and-pull-requests.md b/content/github/managing-your-work-on-github/using-search-to-filter-issues-and-pull-requests.md index 102296457c..68aac842f1 100644 --- a/content/github/managing-your-work-on-github/using-search-to-filter-issues-and-pull-requests.md +++ b/content/github/managing-your-work-on-github/using-search-to-filter-issues-and-pull-requests.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- The issues and pull requests search bar allows you to define your own custom filters and sort by a wide variety of criteria. You can find the search bar on each repository's **Issues** and **Pull requests** tabs and on your [Issues and Pull requests dashboards](/articles/viewing-all-of-your-issues-and-pull-requests). diff --git a/content/github/managing-your-work-on-github/viewing-all-of-your-issues-and-pull-requests.md b/content/github/managing-your-work-on-github/viewing-all-of-your-issues-and-pull-requests.md index 289597f46b..0a5c9f90dd 100644 --- a/content/github/managing-your-work-on-github/viewing-all-of-your-issues-and-pull-requests.md +++ b/content/github/managing-your-work-on-github/viewing-all-of-your-issues-and-pull-requests.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- Your issues and pull request dashboards are available at the top of any page. On each dashboard, you can filter the list to find issues or pull requests you created, that are assigned to you, or in which you're mentioned. You can also find pull requests that you've been asked to review. diff --git a/content/github/managing-your-work-on-github/viewing-your-milestones-progress.md b/content/github/managing-your-work-on-github/viewing-your-milestones-progress.md index 0fc56efbff..a67a141429 100644 --- a/content/github/managing-your-work-on-github/viewing-your-milestones-progress.md +++ b/content/github/managing-your-work-on-github/viewing-your-milestones-progress.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- {% data reusables.repositories.navigate-to-repo %} diff --git a/content/github/receiving-notifications-about-activity-on-github/watching-and-unwatching-team-discussions.md b/content/github/receiving-notifications-about-activity-on-github/watching-and-unwatching-team-discussions.md index 6205d243d6..39e0433971 100644 --- a/content/github/receiving-notifications-about-activity-on-github/watching-and-unwatching-team-discussions.md +++ b/content/github/receiving-notifications-about-activity-on-github/watching-and-unwatching-team-discussions.md @@ -5,7 +5,7 @@ versions: enterprise-server: <2.21 --- -By default, you'll automatically receive notifications for team discussions you're a member of. If you don't want to receive certain notifications for an existing team discussion, you must unwatch that team. You can also unsubscribe or subscribe to specific team discussion posts. For more information, see "[About team discussions](/articles/about-team-discussions)" and "[Subscribing to and unsubscribing from notifications](/enterprise/{{ currentVersion }}/user/github/receiving-notifications-about-activity-on-github/subscribing-to-and-unsubscribing-from-notifications)." +By default, you'll automatically receive notifications for team discussions you're a member of. If you don't want to receive certain notifications for an existing team discussion, you must unwatch that team. You can also unsubscribe or subscribe to specific team discussion posts. For more information, see "[About team discussions](/github/setting-up-and-managing-organizations-and-teams/about-team-discussions)" and "[Subscribing to and unsubscribing from notifications](/enterprise/{{ currentVersion }}/user/github/receiving-notifications-about-activity-on-github/subscribing-to-and-unsubscribing-from-notifications)." If you don't want to automatically watch team discussions when you become a member of new teams, you can update your automatic watching settings. @@ -58,5 +58,5 @@ If you don't want to automatically receive team discussion notifications when yo ### Further reading - "[About notifications](/enterprise/{{ currentVersion }}/user/github/receiving-notifications-about-activity-on-github/about-notifications)" -- "[About team discussions](/articles/about-team-discussions)" +- "[About team discussions](/github/setting-up-and-managing-organizations-and-teams/about-team-discussions)" - "[About teams](/articles/about-teams)" diff --git a/content/github/searching-for-information-on-github/about-searching-on-github.md b/content/github/searching-for-information-on-github/about-searching-on-github.md index aa30f601d7..44c994ea1b 100644 --- a/content/github/searching-for-information-on-github/about-searching-on-github.md +++ b/content/github/searching-for-information-on-github/about-searching-on-github.md @@ -12,6 +12,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - github search --- {% data reusables.search.you-can-search-globally %} @@ -45,7 +47,7 @@ You can search for the following information across all repositories you can acc - [Discussions](/github/searching-for-information-on-github/searching-discussions){% endif %} - [Code](/articles/searching-code) - [Commits](/articles/searching-commits) -- [Users](/articles/searching-users){% if currentVersion == "free-pro-team@latest" %} +- [Users](/articles/searching-users){% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.21" %} - [Packages](/github/searching-for-information-on-github/searching-for-packages){% endif %} - [Wikis](/articles/searching-wikis) diff --git a/content/github/searching-for-information-on-github/enabling-githubcom-repository-search-in-github-enterprise-server.md b/content/github/searching-for-information-on-github/enabling-githubcom-repository-search-in-github-enterprise-server.md index 20e4232077..df48291d6e 100644 --- a/content/github/searching-for-information-on-github/enabling-githubcom-repository-search-in-github-enterprise-server.md +++ b/content/github/searching-for-information-on-github/enabling-githubcom-repository-search-in-github-enterprise-server.md @@ -9,6 +9,8 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '*' +topics: + - github search --- If you use {% data variables.product.prodname_ghe_server %} and {% data variables.product.prodname_dotcom_the_website %} and your {% data variables.product.prodname_ghe_server %} site administrator has enabled {% data variables.product.prodname_github_connect %} and {% data variables.product.prodname_unified_search %} for private repositories, then you can search for designated private repositories in the connected organization. diff --git a/content/github/searching-for-information-on-github/finding-files-on-github.md b/content/github/searching-for-information-on-github/finding-files-on-github.md index b5f1b9d22b..6206ebfb82 100644 --- a/content/github/searching-for-information-on-github/finding-files-on-github.md +++ b/content/github/searching-for-information-on-github/finding-files-on-github.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - github search --- {% tip %} diff --git a/content/github/searching-for-information-on-github/getting-started-with-searching-on-github.md b/content/github/searching-for-information-on-github/getting-started-with-searching-on-github.md index 75b823525a..b29b41a6b2 100644 --- a/content/github/searching-for-information-on-github/getting-started-with-searching-on-github.md +++ b/content/github/searching-for-information-on-github/getting-started-with-searching-on-github.md @@ -7,5 +7,7 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - github search --- diff --git a/content/github/searching-for-information-on-github/index.md b/content/github/searching-for-information-on-github/index.md index e95408d576..d5c9601add 100644 --- a/content/github/searching-for-information-on-github/index.md +++ b/content/github/searching-for-information-on-github/index.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - github search --- diff --git a/content/github/searching-for-information-on-github/searching-code.md b/content/github/searching-for-information-on-github/searching-code.md index f03e26fb17..41c64e585a 100644 --- a/content/github/searching-for-information-on-github/searching-code.md +++ b/content/github/searching-for-information-on-github/searching-code.md @@ -9,6 +9,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - github search --- {% data reusables.search.you-can-search-globally %} For more information, see "[About searching on GitHub](/articles/about-searching-on-github)." diff --git a/content/github/searching-for-information-on-github/searching-commits.md b/content/github/searching-for-information-on-github/searching-commits.md index a2fe749c4b..fc7c3da237 100644 --- a/content/github/searching-for-information-on-github/searching-commits.md +++ b/content/github/searching-for-information-on-github/searching-commits.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - github search --- You can search for commits globally across all of {% data variables.product.product_name %}, or search for commits within a particular repository or organization. For more information, see "[About searching on {% data variables.product.company_short %}](/articles/about-searching-on-github)." diff --git a/content/github/searching-for-information-on-github/searching-discussions.md b/content/github/searching-for-information-on-github/searching-discussions.md index 5e4097328f..7485132659 100644 --- a/content/github/searching-for-information-on-github/searching-discussions.md +++ b/content/github/searching-for-information-on-github/searching-discussions.md @@ -1,8 +1,10 @@ --- title: Searching discussions -intro: You can search for discussions on {% data variables.product.product_name %} and narrow the results using search qualifiers. +intro: 'You can search for discussions on {% data variables.product.product_name %} and narrow the results using search qualifiers.' versions: free-pro-team: '*' +topics: + - github search --- {% data reusables.discussions.beta %} diff --git a/content/github/searching-for-information-on-github/searching-for-packages.md b/content/github/searching-for-information-on-github/searching-for-packages.md index 908a5b758f..5ec6be82f4 100644 --- a/content/github/searching-for-information-on-github/searching-for-packages.md +++ b/content/github/searching-for-information-on-github/searching-for-packages.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '>=2.22' github-ae: '*' +topics: + - github search --- {% data reusables.package_registry.packages-ghes-release-stage %} diff --git a/content/github/searching-for-information-on-github/searching-for-repositories.md b/content/github/searching-for-information-on-github/searching-for-repositories.md index f66b04b94e..081ea49f58 100644 --- a/content/github/searching-for-information-on-github/searching-for-repositories.md +++ b/content/github/searching-for-information-on-github/searching-for-repositories.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - github search --- You can search for repositories globally across all of {% data variables.product.product_location %}, or search for repositories within a particular organization. For more information, see "[About searching on {% data variables.product.prodname_dotcom %}](/articles/about-searching-on-github)." diff --git a/content/github/searching-for-information-on-github/searching-github-marketplace.md b/content/github/searching-for-information-on-github/searching-github-marketplace.md index 8521b5faaa..95b23ef0c2 100644 --- a/content/github/searching-for-information-on-github/searching-github-marketplace.md +++ b/content/github/searching-for-information-on-github/searching-github-marketplace.md @@ -3,6 +3,8 @@ title: Searching GitHub Marketplace intro: 'You can search for apps and actions that are available on {% data variables.product.prodname_marketplace %}.' versions: free-pro-team: '*' +topics: + - github search --- ### About searching {% data variables.product.prodname_marketplace %} diff --git a/content/github/searching-for-information-on-github/searching-in-forks.md b/content/github/searching-for-information-on-github/searching-in-forks.md index 00f94f10b1..4adaa01863 100644 --- a/content/github/searching-for-information-on-github/searching-in-forks.md +++ b/content/github/searching-for-information-on-github/searching-in-forks.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - github search --- To show forks in [repository search](/articles/searching-for-repositories) results, add `fork:true` or `fork:only` to your query. diff --git a/content/github/searching-for-information-on-github/searching-issues-and-pull-requests.md b/content/github/searching-for-information-on-github/searching-issues-and-pull-requests.md index 1ee2d6f95e..8175068037 100644 --- a/content/github/searching-for-information-on-github/searching-issues-and-pull-requests.md +++ b/content/github/searching-for-information-on-github/searching-issues-and-pull-requests.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - github search --- You can search for issues and pull requests globally across all of {% data variables.product.product_name %}, or search for issues and pull requests within a particular organization. For more information, see "[About searching on {% data variables.product.company_short %}](/articles/about-searching-on-github)." diff --git a/content/github/searching-for-information-on-github/searching-on-github.md b/content/github/searching-for-information-on-github/searching-on-github.md index 26639b46a1..add2f14613 100644 --- a/content/github/searching-for-information-on-github/searching-on-github.md +++ b/content/github/searching-for-information-on-github/searching-on-github.md @@ -7,5 +7,7 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - github search --- diff --git a/content/github/searching-for-information-on-github/searching-topics.md b/content/github/searching-for-information-on-github/searching-topics.md index 99cab36c66..d56c5390ff 100644 --- a/content/github/searching-for-information-on-github/searching-topics.md +++ b/content/github/searching-for-information-on-github/searching-topics.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - github search --- ### Search {% data variables.product.product_name %} for topics diff --git a/content/github/searching-for-information-on-github/searching-users.md b/content/github/searching-for-information-on-github/searching-users.md index 325fe570e9..6cd812eb6f 100644 --- a/content/github/searching-for-information-on-github/searching-users.md +++ b/content/github/searching-for-information-on-github/searching-users.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - github search --- You can search for users globally across all of {% data variables.product.product_name %}. For more information, see "[About searching on {% data variables.product.company_short %}](/articles/about-searching-on-github)." diff --git a/content/github/searching-for-information-on-github/searching-wikis.md b/content/github/searching-for-information-on-github/searching-wikis.md index 20e4ea13be..121f4d8949 100644 --- a/content/github/searching-for-information-on-github/searching-wikis.md +++ b/content/github/searching-for-information-on-github/searching-wikis.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - github search --- You can search wikis globally across all of {% data variables.product.product_name %}, or search wikis within a particular repository or organization. For more information, see "[About searching on {% data variables.product.company_short %}](/articles/about-searching-on-github)." diff --git a/content/github/searching-for-information-on-github/sorting-search-results.md b/content/github/searching-for-information-on-github/sorting-search-results.md index 63a87f4ea8..cca11dff24 100644 --- a/content/github/searching-for-information-on-github/sorting-search-results.md +++ b/content/github/searching-for-information-on-github/sorting-search-results.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - github search --- Use the Sort menu to sort results by relevance, number of stars, number of forks, and how recently the items were updated. diff --git a/content/github/searching-for-information-on-github/troubleshooting-search-queries.md b/content/github/searching-for-information-on-github/troubleshooting-search-queries.md index 1ef5321599..c43385c2be 100644 --- a/content/github/searching-for-information-on-github/troubleshooting-search-queries.md +++ b/content/github/searching-for-information-on-github/troubleshooting-search-queries.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - github search --- ### Potential timeouts diff --git a/content/github/searching-for-information-on-github/understanding-the-search-syntax.md b/content/github/searching-for-information-on-github/understanding-the-search-syntax.md index 917ed579ab..dc1b05d6fe 100644 --- a/content/github/searching-for-information-on-github/understanding-the-search-syntax.md +++ b/content/github/searching-for-information-on-github/understanding-the-search-syntax.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - github search --- ### Query for values greater or less than another value @@ -48,7 +50,7 @@ Query | Example <=YYYY-MM-DD | **[cats created:<=2012-07-04](https://github.com/search?utf8=%E2%9C%93&q=cats+created%3A%3C%3D2012-07-04&type=Issues)** matches issues with the word "cats" that were created on or before July 4, 2012. YYYY-MM-DD..YYYY-MM-DD | **[cats pushed:2016-04-30..2016-07-04](https://github.com/search?utf8=%E2%9C%93&q=cats+pushed%3A2016-04-30..2016-07-04&type=Repositories)** matches repositories with the word "cats" that were pushed to between the end of April and July of 2016. YYYY-MM-DD..* | **[cats created:2012-04-30..*](https://github.com/search?utf8=%E2%9C%93&q=cats+created%3A2012-04-30..*&type=Issues)** matches issues created after April 30th, 2012 containing the word "cats." -*..YYYY-MM-DD | **[cats created:*..2012-04-30](https://github.com/search?utf8=%E2%9C%93&q=cats+created%3A*..2012-07-04&type=Issues)** matches issues created before July 4th, 2012 containing the word "cats." +*..YYYY-MM-DD | **[cats created:*..2012-07-04](https://github.com/search?utf8=%E2%9C%93&q=cats+created%3A*..2012-07-04&type=Issues)** matches issues created before July 4th, 2012 containing the word "cats." {% data reusables.time_date.time_format %} diff --git a/content/github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-git-large-file-storage.md b/content/github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-git-large-file-storage.md index 7abf04ebd9..84f966fe47 100644 --- a/content/github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-git-large-file-storage.md +++ b/content/github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-git-large-file-storage.md @@ -5,6 +5,8 @@ redirect_from: - /articles/about-billing-for-git-large-file-storage versions: free-pro-team: '*' +topics: + - billing --- ### About billing for {% data variables.large_files.product_name_long %} diff --git a/content/github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-accounts.md b/content/github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-accounts.md index ee973ad804..eb9ad6bc36 100644 --- a/content/github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-accounts.md +++ b/content/github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-accounts.md @@ -12,6 +12,8 @@ redirect_from: - /articles/about-billing-for-github-accounts versions: free-pro-team: '*' +topics: + - billing --- For more information on the products available for your account, see "[{% data variables.product.product_name %}'s products](/articles/github-s-products)." You can see pricing and a full list of features for each product at <{% data variables.product.pricing_url %}>. {% data variables.product.product_name %} does not offer custom products or subscriptions. diff --git a/content/github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-actions.md b/content/github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-actions.md index 99af79b584..2a0027703f 100644 --- a/content/github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-actions.md +++ b/content/github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-actions.md @@ -4,6 +4,8 @@ intro: 'If you want to use {% data variables.product.prodname_actions %} beyond product: '{% data reusables.gated-features.actions %}' versions: free-pro-team: '*' +topics: + - billing --- ### About billing for {% data variables.product.prodname_actions %} diff --git a/content/github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-marketplace.md b/content/github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-marketplace.md index ae029cc60b..9c5932d9e1 100644 --- a/content/github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-marketplace.md +++ b/content/github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-marketplace.md @@ -5,6 +5,8 @@ redirect_from: - /articles/about-billing-for-github-marketplace versions: free-pro-team: '*' +topics: + - billing --- {% data variables.product.prodname_marketplace %} includes apps with free and paid pricing plans. After you purchase and install an app, you can upgrade, downgrade, or cancel at any time. diff --git a/content/github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-packages.md b/content/github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-packages.md index 1d3fa8d063..590bd13680 100644 --- a/content/github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-packages.md +++ b/content/github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-packages.md @@ -4,6 +4,8 @@ intro: 'If you want to use {% data variables.product.prodname_registry %} beyond product: '{% data reusables.gated-features.packages %}' versions: free-pro-team: '*' +topics: + - billing --- ### About billing for {% data variables.product.prodname_registry %} diff --git a/content/github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-sponsors.md b/content/github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-sponsors.md index f5cb393123..19604added 100644 --- a/content/github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-sponsors.md +++ b/content/github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-sponsors.md @@ -5,6 +5,8 @@ redirect_from: - /articles/about-billing-for-github-sponsors versions: free-pro-team: '*' +topics: + - billing --- {% data reusables.sponsors.sponsorship-details %} diff --git a/content/github/setting-up-and-managing-billing-and-payments-on-github/about-billing-on-github.md b/content/github/setting-up-and-managing-billing-and-payments-on-github/about-billing-on-github.md index 8b377b21e1..42a40a8e55 100644 --- a/content/github/setting-up-and-managing-billing-and-payments-on-github/about-billing-on-github.md +++ b/content/github/setting-up-and-managing-billing-and-payments-on-github/about-billing-on-github.md @@ -5,6 +5,8 @@ redirect_from: - /articles/about-billing-on-github versions: free-pro-team: '*' +topics: + - billing --- ### Paid features and products diff --git a/content/github/setting-up-and-managing-billing-and-payments-on-github/about-licensing-for-github-advanced-security.md b/content/github/setting-up-and-managing-billing-and-payments-on-github/about-licensing-for-github-advanced-security.md new file mode 100644 index 0000000000..732af53a92 --- /dev/null +++ b/content/github/setting-up-and-managing-billing-and-payments-on-github/about-licensing-for-github-advanced-security.md @@ -0,0 +1,49 @@ +--- +title: About licensing for GitHub Advanced Security +intro: 'If you want to use {% data variables.product.prodname_GH_advanced_security %} features in a private or internal repository, you need a license. These features are available free of charge for public repositories.' +product: '{% data reusables.gated-features.ghas %}' +versions: + free-pro-team: '*' +--- + +### About licensing for {% data variables.product.prodname_GH_advanced_security %} + +If you want to use {% data variables.product.prodname_GH_advanced_security %} features on any repository apart from a public repository on {% data variables.product.prodname_dotcom_the_website %}, you will need a license. For more information about {% data variables.product.prodname_GH_advanced_security %}, see "[About {% data variables.product.prodname_GH_advanced_security %}](/github/getting-started-with-github/about-github-advanced-security)." + +{% data reusables.advanced-security.license-overview %} + +To discuss licensing {% data variables.product.prodname_GH_advanced_security %} for your enterprise account, contact {% data variables.contact.contact_enterprise_sales %}. + +### About committer numbers for {% data variables.product.prodname_GH_advanced_security %} + +We record and display two numbers of committers for {% data variables.product.prodname_GH_advanced_security %} on {% data variables.product.prodname_dotcom_the_website %}: + +- **Committers** is the number of committers who contributed to at least one private repository in an organization and who use a seat in your license. That is, they are also an organization member, an external collaborator, or have a pending invitation to join an organization in your enterprise. +- **Unique to this repository/organization** is the number of committers who contributed only to this repository, or to repositories in this organization. This number shows how many license seats you can free up by disabling {% data variables.product.prodname_GH_advanced_security %} for that repository or organization. + +If there are no unique committers, this means that all active committers also contribute to other repositories or organizations that use {% data variables.product.prodname_GH_advanced_security %}. Disabling the feature for that repository or organization would not free any seats on your license. + +{% note %} + +**Note:** The total number of seats used in your license is not the sum of either the committers or the unique committers to each repository or organization. This is because there are people who contribute to multiple repositories or organizations. The number of seats used is measured across the whole enterprise account to ensure that each person is counted only once regardless of how many repositories or organizations they contribute to. + +{% endnote %} + +### Managing your license usage for {% data variables.product.prodname_GH_advanced_security %} + +When you enable {% data variables.product.prodname_GH_advanced_security %} for a single repository, or for all repositories in an organization, {% data variables.product.company_short %} shows how many extra seats this will use and prompts you for confirmation. If you disable access to {% data variables.product.prodname_GH_advanced_security %}, any seats used by "unique" committers are freed up. This makes it easy to understand the impact of your changes on the use of your license. + +If you are over your license limit, {% data variables.product.prodname_GH_advanced_security %} continues to work on all repositories where it is already enabled. However, in organizations where {% data variables.product.prodname_GH_advanced_security %} is enabled for new repositories, repositories will be created with the feature disabled. In addition, the option to enable {% data variables.product.prodname_GH_advanced_security %} for existing repositories will not be available. If you change the visibility of a public repository to private then {% data variables.product.prodname_GH_advanced_security %} will be disabled for that repository. + +As soon as you free up some seats, by disabling {% data variables.product.prodname_GH_advanced_security %} for some repositories or by increasing your license size, the options for enabling {% data variables.product.prodname_GH_advanced_security %} will work again as normal. + +For information on viewing usage, see "[Viewing your GitHub Advanced Security usage](/github/setting-up-and-managing-billing-and-payments-on-github/viewing-your-github-advanced-security-usage)." + +### Getting the most out of your {% data variables.product.prodname_GH_advanced_security %} license + +When you decide which repositories and organizations to prioritize for {% data variables.product.prodname_GH_advanced_security %}, you should review them and identify: + +- Codebases that are the most critical to your company's success. These are the projects for which the introduction of vulnerable code, hard-coded secrets, or vulnerable dependencies would have the greatest impact on your company. +- Codebases with the highest commit frequency. These are the most actively developed projects, consequently there is a higher risk that security problems could be introduced. + +When you have enabled {% data variables.product.prodname_GH_advanced_security %} for these organizations or repositories, you should assess which other codebases you could add without adding any extra unique committers and using up more seats on your license. After this, review the next most important and busy codebases. If you want to increase the number of seats in your license, contact {% data variables.contact.contact_enterprise_sales %}. diff --git a/content/github/setting-up-and-managing-billing-and-payments-on-github/about-organizations-for-procurement-companies.md b/content/github/setting-up-and-managing-billing-and-payments-on-github/about-organizations-for-procurement-companies.md index 620bb92d7c..7528a07c86 100644 --- a/content/github/setting-up-and-managing-billing-and-payments-on-github/about-organizations-for-procurement-companies.md +++ b/content/github/setting-up-and-managing-billing-and-payments-on-github/about-organizations-for-procurement-companies.md @@ -6,6 +6,8 @@ redirect_from: - /articles/about-organizations-for-procurement-companies versions: free-pro-team: '*' +topics: + - billing --- To access an organization, each member must sign into their own personal user account. diff --git a/content/github/setting-up-and-managing-billing-and-payments-on-github/about-per-user-pricing.md b/content/github/setting-up-and-managing-billing-and-payments-on-github/about-per-user-pricing.md index 4ad2ca3d40..88e02ca788 100644 --- a/content/github/setting-up-and-managing-billing-and-payments-on-github/about-per-user-pricing.md +++ b/content/github/setting-up-and-managing-billing-and-payments-on-github/about-per-user-pricing.md @@ -5,6 +5,8 @@ redirect_from: - /articles/about-per-user-pricing versions: free-pro-team: '*' +topics: + - billing --- New organizations can build public and open-source projects with {% data variables.product.prodname_free_team %}, or [upgrade]({% data variables.product.pricing_url %}) to a paid product with per-user pricing. diff --git a/content/github/setting-up-and-managing-billing-and-payments-on-github/adding-information-to-your-receipts.md b/content/github/setting-up-and-managing-billing-and-payments-on-github/adding-information-to-your-receipts.md index 978c384796..3f9b261206 100644 --- a/content/github/setting-up-and-managing-billing-and-payments-on-github/adding-information-to-your-receipts.md +++ b/content/github/setting-up-and-managing-billing-and-payments-on-github/adding-information-to-your-receipts.md @@ -13,6 +13,8 @@ redirect_from: - /articles/adding-information-to-your-receipts versions: free-pro-team: '*' +topics: + - billing --- Your receipts include your {% data variables.product.prodname_dotcom %} subscription as well as any subscriptions for [other paid features and products](/articles/about-billing-on-github). diff --git a/content/github/setting-up-and-managing-billing-and-payments-on-github/adding-or-editing-a-payment-method.md b/content/github/setting-up-and-managing-billing-and-payments-on-github/adding-or-editing-a-payment-method.md index 2252335a71..dbdcb5afdd 100644 --- a/content/github/setting-up-and-managing-billing-and-payments-on-github/adding-or-editing-a-payment-method.md +++ b/content/github/setting-up-and-managing-billing-and-payments-on-github/adding-or-editing-a-payment-method.md @@ -17,6 +17,8 @@ redirect_from: - /articles/adding-or-editing-a-payment-method versions: free-pro-team: '*' +topics: + - billing --- {% data reusables.dotcom_billing.payment-methods %} {% data reusables.dotcom_billing.same-payment-method %} diff --git a/content/github/setting-up-and-managing-billing-and-payments-on-github/canceling-a-github-marketplace-app.md b/content/github/setting-up-and-managing-billing-and-payments-on-github/canceling-a-github-marketplace-app.md index 8ea7be345d..56f1b47629 100644 --- a/content/github/setting-up-and-managing-billing-and-payments-on-github/canceling-a-github-marketplace-app.md +++ b/content/github/setting-up-and-managing-billing-and-payments-on-github/canceling-a-github-marketplace-app.md @@ -7,6 +7,8 @@ redirect_from: - /articles/canceling-a-github-marketplace-app versions: free-pro-team: '*' +topics: + - billing --- When you cancel an app, your subscription remains active until the end of your current billing cycle. The cancellation takes effect on your next billing date. For more information, see "[About billing for {% data variables.product.prodname_marketplace %}](/articles/about-billing-for-github-marketplace)." diff --git a/content/github/setting-up-and-managing-billing-and-payments-on-github/changing-the-duration-of-your-billing-cycle.md b/content/github/setting-up-and-managing-billing-and-payments-on-github/changing-the-duration-of-your-billing-cycle.md index be7799346d..69126ef59b 100644 --- a/content/github/setting-up-and-managing-billing-and-payments-on-github/changing-the-duration-of-your-billing-cycle.md +++ b/content/github/setting-up-and-managing-billing-and-payments-on-github/changing-the-duration-of-your-billing-cycle.md @@ -8,6 +8,8 @@ redirect_from: - /articles/changing-the-duration-of-your-billing-cycle versions: free-pro-team: '*' +topics: + - billing --- When you change your billing cycle's duration, your {% data variables.product.prodname_dotcom %} subscription, along with any other paid features and products, will be moved to your new billing cycle on your next billing date. diff --git a/content/github/setting-up-and-managing-billing-and-payments-on-github/creating-and-paying-for-an-organization-on-behalf-of-a-client.md b/content/github/setting-up-and-managing-billing-and-payments-on-github/creating-and-paying-for-an-organization-on-behalf-of-a-client.md index c1743cd9df..c68cc1fd99 100644 --- a/content/github/setting-up-and-managing-billing-and-payments-on-github/creating-and-paying-for-an-organization-on-behalf-of-a-client.md +++ b/content/github/setting-up-and-managing-billing-and-payments-on-github/creating-and-paying-for-an-organization-on-behalf-of-a-client.md @@ -5,6 +5,8 @@ redirect_from: - /articles/creating-and-paying-for-an-organization-on-behalf-of-a-client versions: free-pro-team: '*' +topics: + - billing --- ### Requirements diff --git a/content/github/setting-up-and-managing-billing-and-payments-on-github/discounted-subscriptions-for-github-accounts.md b/content/github/setting-up-and-managing-billing-and-payments-on-github/discounted-subscriptions-for-github-accounts.md index 4f1306773f..171d6f1003 100644 --- a/content/github/setting-up-and-managing-billing-and-payments-on-github/discounted-subscriptions-for-github-accounts.md +++ b/content/github/setting-up-and-managing-billing-and-payments-on-github/discounted-subscriptions-for-github-accounts.md @@ -8,6 +8,8 @@ redirect_from: - /articles/discounted-subscriptions-for-github-accounts versions: free-pro-team: '*' +topics: + - billing --- {% tip %} diff --git a/content/github/setting-up-and-managing-billing-and-payments-on-github/downgrading-a-sponsorship.md b/content/github/setting-up-and-managing-billing-and-payments-on-github/downgrading-a-sponsorship.md index 4d9595814c..55d99d1503 100644 --- a/content/github/setting-up-and-managing-billing-and-payments-on-github/downgrading-a-sponsorship.md +++ b/content/github/setting-up-and-managing-billing-and-payments-on-github/downgrading-a-sponsorship.md @@ -5,6 +5,8 @@ redirect_from: - /articles/downgrading-a-sponsorship versions: free-pro-team: '*' +topics: + - billing --- {% data reusables.sponsors.org-sponsors-release-phase %} diff --git a/content/github/setting-up-and-managing-billing-and-payments-on-github/downgrading-git-large-file-storage.md b/content/github/setting-up-and-managing-billing-and-payments-on-github/downgrading-git-large-file-storage.md index 8ae0090550..d297c4ee39 100644 --- a/content/github/setting-up-and-managing-billing-and-payments-on-github/downgrading-git-large-file-storage.md +++ b/content/github/setting-up-and-managing-billing-and-payments-on-github/downgrading-git-large-file-storage.md @@ -7,6 +7,8 @@ redirect_from: - /articles/downgrading-git-large-file-storage versions: free-pro-team: '*' +topics: + - billing --- When you downgrade your number of data packs, your change takes effect on your next billing date. For more information, see "[About billing for {% data variables.large_files.product_name_long %}](/articles/about-billing-for-git-large-file-storage)." diff --git a/content/github/setting-up-and-managing-billing-and-payments-on-github/downgrading-the-billing-plan-for-a-github-marketplace-app.md b/content/github/setting-up-and-managing-billing-and-payments-on-github/downgrading-the-billing-plan-for-a-github-marketplace-app.md index 0ee8629d63..b9c50ec438 100644 --- a/content/github/setting-up-and-managing-billing-and-payments-on-github/downgrading-the-billing-plan-for-a-github-marketplace-app.md +++ b/content/github/setting-up-and-managing-billing-and-payments-on-github/downgrading-the-billing-plan-for-a-github-marketplace-app.md @@ -7,6 +7,8 @@ redirect_from: - /articles/downgrading-the-billing-plan-for-a-github-marketplace-app versions: free-pro-team: '*' +topics: + - billing --- When you downgrade an app, your subscription remains active until the end of your current billing cycle. The downgrade takes effect on your next billing date. For more information, see "[About billing for {% data variables.product.prodname_marketplace %}](/articles/about-billing-for-github-marketplace)." diff --git a/content/github/setting-up-and-managing-billing-and-payments-on-github/downgrading-your-github-subscription.md b/content/github/setting-up-and-managing-billing-and-payments-on-github/downgrading-your-github-subscription.md index 52e4c319e3..cbc71c572f 100644 --- a/content/github/setting-up-and-managing-billing-and-payments-on-github/downgrading-your-github-subscription.md +++ b/content/github/setting-up-and-managing-billing-and-payments-on-github/downgrading-your-github-subscription.md @@ -17,6 +17,8 @@ redirect_from: - /articles/downgrading-your-github-subscription versions: free-pro-team: '*' +topics: + - billing --- ### Downgrading your {% data variables.product.product_name %} subscription diff --git a/content/github/setting-up-and-managing-billing-and-payments-on-github/how-does-upgrading-or-downgrading-affect-the-billing-process.md b/content/github/setting-up-and-managing-billing-and-payments-on-github/how-does-upgrading-or-downgrading-affect-the-billing-process.md index 28dcc69c66..5ee620bf4b 100644 --- a/content/github/setting-up-and-managing-billing-and-payments-on-github/how-does-upgrading-or-downgrading-affect-the-billing-process.md +++ b/content/github/setting-up-and-managing-billing-and-payments-on-github/how-does-upgrading-or-downgrading-affect-the-billing-process.md @@ -5,6 +5,8 @@ redirect_from: - /articles/how-does-upgrading-or-downgrading-affect-the-billing-process versions: free-pro-team: '*' +topics: + - billing --- Changes to your paid user account or organization subscription does not affect subscriptions or payments for other paid {% data variables.product.prodname_dotcom %} features, such as {% data variables.large_files.product_name_long %} or paid apps purchased in {% data variables.product.prodname_marketplace %}. diff --git a/content/github/setting-up-and-managing-billing-and-payments-on-github/index.md b/content/github/setting-up-and-managing-billing-and-payments-on-github/index.md index 1ec07412e3..486292fcdd 100644 --- a/content/github/setting-up-and-managing-billing-and-payments-on-github/index.md +++ b/content/github/setting-up-and-managing-billing-and-payments-on-github/index.md @@ -5,6 +5,8 @@ redirect_from: - /categories/setting-up-and-managing-billing-and-payments-on-github versions: free-pro-team: '*' +topics: + - billing --- @@ -44,6 +46,9 @@ versions: {% link_in_list /viewing-your-git-large-file-storage-usage %} {% link_in_list /upgrading-git-large-file-storage %} {% link_in_list /downgrading-git-large-file-storage %} +{% topic_link_in_list /managing-licensing-for-github-advanced-security %} + {% link_in_list /about-licensing-for-github-advanced-security %} + {% link_in_list /viewing-your-github-advanced-security-usage %} {% topic_link_in_list /managing-billing-for-github-sponsors %} {% link_in_list /about-billing-for-github-sponsors %} {% link_in_list /upgrading-a-sponsorship %} diff --git a/content/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-git-large-file-storage.md b/content/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-git-large-file-storage.md index 8e2bf2e7cc..bca4ee4352 100644 --- a/content/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-git-large-file-storage.md +++ b/content/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-git-large-file-storage.md @@ -9,5 +9,7 @@ redirect_from: mapTopic: true versions: free-pro-team: '*' +topics: + - billing --- diff --git a/content/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions.md b/content/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions.md index 39f3088888..b8c8c8f629 100644 --- a/content/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions.md +++ b/content/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions.md @@ -4,5 +4,7 @@ intro: 'You can view your usage and set a spending limit for {% data variables.p mapTopic: true versions: free-pro-team: '*' +topics: + - billing --- diff --git a/content/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-marketplace-apps.md b/content/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-marketplace-apps.md index 3f00310c38..8eec46d9b3 100644 --- a/content/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-marketplace-apps.md +++ b/content/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-marketplace-apps.md @@ -8,5 +8,7 @@ redirect_from: mapTopic: true versions: free-pro-team: '*' +topics: + - billing --- diff --git a/content/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages.md b/content/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages.md index 18f10a288a..4842c9eb73 100644 --- a/content/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages.md +++ b/content/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages.md @@ -4,5 +4,7 @@ intro: 'You can view your {% data variables.product.prodname_registry %} usage a mapTopic: true versions: free-pro-team: '*' +topics: + - billing --- diff --git a/content/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-sponsors.md b/content/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-sponsors.md index f03d1f05d6..9b58bc5296 100644 --- a/content/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-sponsors.md +++ b/content/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-sponsors.md @@ -6,5 +6,7 @@ redirect_from: - /articles/managing-billing-for-github-sponsors versions: free-pro-team: '*' +topics: + - billing --- diff --git a/content/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-your-github-account.md b/content/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-your-github-account.md index 929708d3ea..c9ca0b8cc9 100644 --- a/content/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-your-github-account.md +++ b/content/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-your-github-account.md @@ -14,5 +14,7 @@ redirect_from: mapTopic: true versions: free-pro-team: '*' +topics: + - billing --- diff --git a/content/github/setting-up-and-managing-billing-and-payments-on-github/managing-licensing-for-github-advanced-security.md b/content/github/setting-up-and-managing-billing-and-payments-on-github/managing-licensing-for-github-advanced-security.md new file mode 100644 index 0000000000..c10dea733a --- /dev/null +++ b/content/github/setting-up-and-managing-billing-and-payments-on-github/managing-licensing-for-github-advanced-security.md @@ -0,0 +1,8 @@ +--- +title: Managing licensing for GitHub Advanced Security +intro: 'You can view and manage your use of seats on a license for {% data variables.product.prodname_advanced_security %}.' +mapTopic: true +product: '{% data reusables.gated-features.ghas %}' +versions: + free-pro-team: '*' +--- diff --git a/content/github/setting-up-and-managing-billing-and-payments-on-github/managing-your-github-billing-settings.md b/content/github/setting-up-and-managing-billing-and-payments-on-github/managing-your-github-billing-settings.md index e684dad17c..1f95070192 100644 --- a/content/github/setting-up-and-managing-billing-and-payments-on-github/managing-your-github-billing-settings.md +++ b/content/github/setting-up-and-managing-billing-and-payments-on-github/managing-your-github-billing-settings.md @@ -12,5 +12,7 @@ redirect_from: mapTopic: true versions: free-pro-team: '*' +topics: + - billing --- diff --git a/content/github/setting-up-and-managing-billing-and-payments-on-github/managing-your-spending-limit-for-github-actions.md b/content/github/setting-up-and-managing-billing-and-payments-on-github/managing-your-spending-limit-for-github-actions.md index 0640df74bb..5c60d891b5 100644 --- a/content/github/setting-up-and-managing-billing-and-payments-on-github/managing-your-spending-limit-for-github-actions.md +++ b/content/github/setting-up-and-managing-billing-and-payments-on-github/managing-your-spending-limit-for-github-actions.md @@ -4,6 +4,8 @@ intro: 'You can set a spending limit for {% data variables.product.prodname_acti product: '{% data reusables.gated-features.actions %}' versions: free-pro-team: '*' +topics: + - billing --- ### About spending limits for {% data variables.product.prodname_actions %} diff --git a/content/github/setting-up-and-managing-billing-and-payments-on-github/managing-your-spending-limit-for-github-packages.md b/content/github/setting-up-and-managing-billing-and-payments-on-github/managing-your-spending-limit-for-github-packages.md index 250aaab93a..e5fa4995f3 100644 --- a/content/github/setting-up-and-managing-billing-and-payments-on-github/managing-your-spending-limit-for-github-packages.md +++ b/content/github/setting-up-and-managing-billing-and-payments-on-github/managing-your-spending-limit-for-github-packages.md @@ -4,6 +4,8 @@ intro: 'You can set a spending limit for {% data variables.product.prodname_regi product: '{% data reusables.gated-features.packages %}' versions: free-pro-team: '*' +topics: + - billing --- ### About spending limits for {% data variables.product.prodname_registry %} diff --git a/content/github/setting-up-and-managing-billing-and-payments-on-github/redeeming-a-coupon.md b/content/github/setting-up-and-managing-billing-and-payments-on-github/redeeming-a-coupon.md index 7ba2f81725..038f5af655 100644 --- a/content/github/setting-up-and-managing-billing-and-payments-on-github/redeeming-a-coupon.md +++ b/content/github/setting-up-and-managing-billing-and-payments-on-github/redeeming-a-coupon.md @@ -8,6 +8,8 @@ redirect_from: - /articles/redeeming-a-coupon versions: free-pro-team: '*' +topics: + - billing --- {% data variables.product.product_name %} can't issue a refund if you pay for an account before applying a coupon. We also can't transfer a redeemed coupon or give you a new coupon if you apply it to the wrong account. Confirm that you're applying the coupon to the correct account before you redeem a coupon. diff --git a/content/github/setting-up-and-managing-billing-and-payments-on-github/removing-a-payment-method.md b/content/github/setting-up-and-managing-billing-and-payments-on-github/removing-a-payment-method.md index d28d8cb4be..4487393f5a 100644 --- a/content/github/setting-up-and-managing-billing-and-payments-on-github/removing-a-payment-method.md +++ b/content/github/setting-up-and-managing-billing-and-payments-on-github/removing-a-payment-method.md @@ -9,6 +9,8 @@ redirect_from: - /articles/removing-a-payment-method versions: free-pro-team: '*' +topics: + - billing --- If you're paying for your {% data variables.product.product_name %} subscription with a coupon, and you aren't using your payment method for any [other paid features or products](/articles/about-billing-on-github) on {% data variables.product.product_name %}, you can remove your credit card or PayPal information. diff --git a/content/github/setting-up-and-managing-billing-and-payments-on-github/renewing-your-clients-paid-organization.md b/content/github/setting-up-and-managing-billing-and-payments-on-github/renewing-your-clients-paid-organization.md index 95f32e829c..77eb7a3166 100644 --- a/content/github/setting-up-and-managing-billing-and-payments-on-github/renewing-your-clients-paid-organization.md +++ b/content/github/setting-up-and-managing-billing-and-payments-on-github/renewing-your-clients-paid-organization.md @@ -6,6 +6,8 @@ redirect_from: - /articles/renewing-your-clients-paid-organization versions: free-pro-team: '*' +topics: + - billing --- {% data reusables.organizations.reseller-ask-to-become-billing-manager %} diff --git a/content/github/setting-up-and-managing-billing-and-payments-on-github/setting-up-paid-organizations-for-procurement-companies.md b/content/github/setting-up-and-managing-billing-and-payments-on-github/setting-up-paid-organizations-for-procurement-companies.md index f2ed48d2f9..66a29895ee 100644 --- a/content/github/setting-up-and-managing-billing-and-payments-on-github/setting-up-paid-organizations-for-procurement-companies.md +++ b/content/github/setting-up-and-managing-billing-and-payments-on-github/setting-up-paid-organizations-for-procurement-companies.md @@ -8,5 +8,7 @@ redirect_from: mapTopic: true versions: free-pro-team: '*' +topics: + - billing --- diff --git a/content/github/setting-up-and-managing-billing-and-payments-on-github/setting-your-billing-email.md b/content/github/setting-up-and-managing-billing-and-payments-on-github/setting-your-billing-email.md index a2d2fb3b7d..ffe4d5ed49 100644 --- a/content/github/setting-up-and-managing-billing-and-payments-on-github/setting-your-billing-email.md +++ b/content/github/setting-up-and-managing-billing-and-payments-on-github/setting-your-billing-email.md @@ -9,6 +9,8 @@ redirect_from: - /articles/setting-your-billing-email versions: free-pro-team: '*' +topics: + - billing --- ### Setting your personal account's billing email diff --git a/content/github/setting-up-and-managing-billing-and-payments-on-github/troubleshooting-a-declined-credit-card-charge.md b/content/github/setting-up-and-managing-billing-and-payments-on-github/troubleshooting-a-declined-credit-card-charge.md index f76f433b3a..e0951dd49f 100644 --- a/content/github/setting-up-and-managing-billing-and-payments-on-github/troubleshooting-a-declined-credit-card-charge.md +++ b/content/github/setting-up-and-managing-billing-and-payments-on-github/troubleshooting-a-declined-credit-card-charge.md @@ -6,6 +6,8 @@ redirect_from: - /articles/troubleshooting-a-declined-credit-card-charge versions: free-pro-team: '*' +topics: + - billing --- If your card is declined, we'll send you an email about why the payment was declined. You'll have a few days to resolve the problem before we try charging you again. diff --git a/content/github/setting-up-and-managing-billing-and-payments-on-github/unlocking-a-locked-account.md b/content/github/setting-up-and-managing-billing-and-payments-on-github/unlocking-a-locked-account.md index bc7968d21e..06d264a1ba 100644 --- a/content/github/setting-up-and-managing-billing-and-payments-on-github/unlocking-a-locked-account.md +++ b/content/github/setting-up-and-managing-billing-and-payments-on-github/unlocking-a-locked-account.md @@ -11,6 +11,8 @@ redirect_from: - /articles/unlocking-a-locked-account versions: free-pro-team: '*' +topics: + - billing --- You can unlock and access your account by updating your organization's payment method and resuming paid status. We do not ask you to pay for the time elapsed in locked mode. diff --git a/content/github/setting-up-and-managing-billing-and-payments-on-github/upgrading-a-sponsorship.md b/content/github/setting-up-and-managing-billing-and-payments-on-github/upgrading-a-sponsorship.md index cd65d50f26..71d7d250f8 100644 --- a/content/github/setting-up-and-managing-billing-and-payments-on-github/upgrading-a-sponsorship.md +++ b/content/github/setting-up-and-managing-billing-and-payments-on-github/upgrading-a-sponsorship.md @@ -5,6 +5,8 @@ redirect_from: - /articles/upgrading-a-sponsorship versions: free-pro-team: '*' +topics: + - billing --- {% data reusables.sponsors.org-sponsors-release-phase %} @@ -18,4 +20,4 @@ When you upgrade your sponsorship tier, the change will become effective immedia {% data reusables.sponsors.navigate-to-sponsored-account %} {% data reusables.sponsors.sponsorship-dashboard %} {% data reusables.sponsors.select-a-tier %} -{% data reusables.sponsors.update-sponsorship %} \ No newline at end of file +{% data reusables.sponsors.update-sponsorship %} diff --git a/content/github/setting-up-and-managing-billing-and-payments-on-github/upgrading-git-large-file-storage.md b/content/github/setting-up-and-managing-billing-and-payments-on-github/upgrading-git-large-file-storage.md index 19dd20d6d3..cfaee9f15b 100644 --- a/content/github/setting-up-and-managing-billing-and-payments-on-github/upgrading-git-large-file-storage.md +++ b/content/github/setting-up-and-managing-billing-and-payments-on-github/upgrading-git-large-file-storage.md @@ -7,6 +7,8 @@ redirect_from: - /articles/upgrading-git-large-file-storage versions: free-pro-team: '*' +topics: + - billing --- ### Purchasing additional storage and bandwidth for a personal account diff --git a/content/github/setting-up-and-managing-billing-and-payments-on-github/upgrading-or-downgrading-your-clients-paid-organization.md b/content/github/setting-up-and-managing-billing-and-payments-on-github/upgrading-or-downgrading-your-clients-paid-organization.md index a92f60b039..6ff83d7659 100644 --- a/content/github/setting-up-and-managing-billing-and-payments-on-github/upgrading-or-downgrading-your-clients-paid-organization.md +++ b/content/github/setting-up-and-managing-billing-and-payments-on-github/upgrading-or-downgrading-your-clients-paid-organization.md @@ -6,6 +6,8 @@ redirect_from: - /articles/upgrading-or-downgrading-your-clients-paid-organization versions: free-pro-team: '*' +topics: + - billing --- {% data reusables.organizations.reseller-ask-to-become-billing-manager %} diff --git a/content/github/setting-up-and-managing-billing-and-payments-on-github/upgrading-the-billing-plan-for-a-github-marketplace-app.md b/content/github/setting-up-and-managing-billing-and-payments-on-github/upgrading-the-billing-plan-for-a-github-marketplace-app.md index 47f0471d8d..b6647fe927 100644 --- a/content/github/setting-up-and-managing-billing-and-payments-on-github/upgrading-the-billing-plan-for-a-github-marketplace-app.md +++ b/content/github/setting-up-and-managing-billing-and-payments-on-github/upgrading-the-billing-plan-for-a-github-marketplace-app.md @@ -7,6 +7,8 @@ redirect_from: - /articles/upgrading-the-billing-plan-for-a-github-marketplace-app versions: free-pro-team: '*' +topics: + - billing --- When you upgrade an app, your payment method is charged a prorated amount based on the time remaining until your next billing date. For more information, see "[About billing for {% data variables.product.prodname_marketplace %}](/articles/about-billing-for-github-marketplace)." diff --git a/content/github/setting-up-and-managing-billing-and-payments-on-github/upgrading-your-github-subscription.md b/content/github/setting-up-and-managing-billing-and-payments-on-github/upgrading-your-github-subscription.md index 782a9b2f4a..848bdc0cf1 100644 --- a/content/github/setting-up-and-managing-billing-and-payments-on-github/upgrading-your-github-subscription.md +++ b/content/github/setting-up-and-managing-billing-and-payments-on-github/upgrading-your-github-subscription.md @@ -19,6 +19,8 @@ redirect_from: - /articles/upgrading-your-github-subscription versions: free-pro-team: '*' +topics: + - billing --- ### Upgrading your personal account's subscription diff --git a/content/github/setting-up-and-managing-billing-and-payments-on-github/viewing-and-managing-pending-changes-to-your-subscription.md b/content/github/setting-up-and-managing-billing-and-payments-on-github/viewing-and-managing-pending-changes-to-your-subscription.md index 260b634f81..deef9231ef 100644 --- a/content/github/setting-up-and-managing-billing-and-payments-on-github/viewing-and-managing-pending-changes-to-your-subscription.md +++ b/content/github/setting-up-and-managing-billing-and-payments-on-github/viewing-and-managing-pending-changes-to-your-subscription.md @@ -8,6 +8,8 @@ redirect_from: - /articles/viewing-and-managing-pending-changes-to-your-subscription versions: free-pro-team: '*' +topics: + - billing --- You can cancel pending changes to your account's subscription as well as pending changes to your subscriptions to other paid features and products. diff --git a/content/github/setting-up-and-managing-billing-and-payments-on-github/viewing-your-git-large-file-storage-usage.md b/content/github/setting-up-and-managing-billing-and-payments-on-github/viewing-your-git-large-file-storage-usage.md index 10f786b60d..71811a02e0 100644 --- a/content/github/setting-up-and-managing-billing-and-payments-on-github/viewing-your-git-large-file-storage-usage.md +++ b/content/github/setting-up-and-managing-billing-and-payments-on-github/viewing-your-git-large-file-storage-usage.md @@ -7,6 +7,8 @@ redirect_from: - /articles/viewing-your-git-large-file-storage-usage versions: free-pro-team: '*' +topics: + - billing --- {% data reusables.large_files.owner_quota_only %} {% data reusables.large_files.does_not_carry %} diff --git a/content/github/setting-up-and-managing-billing-and-payments-on-github/viewing-your-github-actions-usage.md b/content/github/setting-up-and-managing-billing-and-payments-on-github/viewing-your-github-actions-usage.md index 1c16ae50ef..a9614ba2a4 100644 --- a/content/github/setting-up-and-managing-billing-and-payments-on-github/viewing-your-github-actions-usage.md +++ b/content/github/setting-up-and-managing-billing-and-payments-on-github/viewing-your-github-actions-usage.md @@ -4,6 +4,8 @@ intro: 'You can view details of your usage of minutes and storage for {% data va product: '{% data reusables.gated-features.actions %}' versions: free-pro-team: '*' +topics: + - billing --- You can also view the billable job execution minutes for an individual workflow run. For more information, see "[Viewing job execution time](/actions/managing-workflow-runs/viewing-job-execution-time)." diff --git a/content/github/setting-up-and-managing-billing-and-payments-on-github/viewing-your-github-advanced-security-usage.md b/content/github/setting-up-and-managing-billing-and-payments-on-github/viewing-your-github-advanced-security-usage.md new file mode 100644 index 0000000000..3e9d1d052a --- /dev/null +++ b/content/github/setting-up-and-managing-billing-and-payments-on-github/viewing-your-github-advanced-security-usage.md @@ -0,0 +1,33 @@ +--- +title: Viewing your GitHub Advanced Security usage +intro: 'You can view and manage usage of your {% data variables.product.prodname_GH_advanced_security %} license.' +permissions: Organization and enterprise owners can manage access to {% data variables.product.prodname_GH_advanced_security %} for their organization or enterprise organizations. +product: '{% data reusables.gated-features.ghas %}' +redirect_from: /github/setting-up-and-managing-your-enterprise/managing-use-of-advanced-security-for-organizations-in-your-enterprise-account +versions: + free-pro-team: '*' +--- + +Each license for {% data variables.product.prodname_GH_advanced_security %} specifies a maximum number of accounts, or seats, that can use these features. Periodically you should check that your use is within your license capacity. For more information, see "[About licensing for {% data variables.product.prodname_GH_advanced_security %} enterprise license](/github/setting-up-and-managing-billing-and-payments-on-github/about-licensing-for-github-advanced-security)." + +### Viewing and managing {% data variables.product.prodname_GH_advanced_security %} license usage for your enterprise account + +You can check how many seats your license includes and how many of them are currently used on the "Enterprise licensing" page. + +{% data reusables.enterprise-accounts.access-enterprise %} +{% data reusables.enterprise-accounts.settings-tab %} +{% data reusables.enterprise-accounts.license-tab %} + The "{% data variables.product.prodname_GH_advanced_security %}" section shows details of the current usage. + ![{% data variables.product.prodname_GH_advanced_security %} in enterprise licensing settings](/assets/images/help/enterprises/enterprise-licensing-tab-ghas.png) + If you run out of seats, the section will be red. You should either reduce your use of {% data variables.product.prodname_GH_advanced_security %} or purchase more seats. For more information, see "[About licensing for {% data variables.product.prodname_GH_advanced_security %} enterprise license](/github/setting-up-and-managing-billing-and-payments-on-github/about-licensing-for-github-advanced-security#getting-the-most-out-of-your-github-advanced-security-enterprise-license)." + ![{% data variables.product.prodname_GH_advanced_security %} in enterprise licensing settings](/assets/images/help/enterprises/enterprise-licensing-tab-ghas-no-seats.png) +4. Optionally, to see a detailed breakdown of usage per organization, in the left sidebar, click **Billing**. + ![Billing tab in the enterprise account settings sidebar](/assets/images/help/business-accounts/settings-billing-tab.png) + In the "{% data variables.product.prodname_GH_advanced_security %}" section you can see the number of committers and unique committers for each organization. + ![{% data variables.product.prodname_GH_advanced_security %} in enterprise billing settings](/assets/images/help/billing/ghas-orgs-list-enterprise.png) +5. Optionally, click the name of an organization where you are an owner to display the security and analysis settings for the organization. + ![Owned organization in {% data variables.product.prodname_GH_advanced_security %} section of enterprise billing settings](/assets/images/help/billing/ghas-orgs-list-enterprise-click-org.png) +6. On the "Security & analysis" settings page, scroll to the "{% data variables.product.prodname_GH_advanced_security %} repositories" section to see a detailed breakdown of usage by repository for this organization. + ![{% data variables.product.prodname_GH_advanced_security %} repositories section](/assets/images/help/enterprises/settings-security-analysis-ghas-repos-list.png) + For more information, see "[Managing security and analysis settings for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization)." + diff --git a/content/github/setting-up-and-managing-billing-and-payments-on-github/viewing-your-github-packages-usage.md b/content/github/setting-up-and-managing-billing-and-payments-on-github/viewing-your-github-packages-usage.md index fcf65f1ada..11fbf086b3 100644 --- a/content/github/setting-up-and-managing-billing-and-payments-on-github/viewing-your-github-packages-usage.md +++ b/content/github/setting-up-and-managing-billing-and-payments-on-github/viewing-your-github-packages-usage.md @@ -4,6 +4,8 @@ intro: 'You can view details of your usage of storage and data transfer for {% d product: '{% data reusables.gated-features.packages %}' versions: free-pro-team: '*' +topics: + - billing --- ### Viewing {% data variables.product.prodname_registry %} usage for your user account diff --git a/content/github/setting-up-and-managing-billing-and-payments-on-github/viewing-your-payment-history-and-receipts.md b/content/github/setting-up-and-managing-billing-and-payments-on-github/viewing-your-payment-history-and-receipts.md index 7f939cf84c..5b7e84b959 100644 --- a/content/github/setting-up-and-managing-billing-and-payments-on-github/viewing-your-payment-history-and-receipts.md +++ b/content/github/setting-up-and-managing-billing-and-payments-on-github/viewing-your-payment-history-and-receipts.md @@ -8,6 +8,8 @@ redirect_from: - /articles/viewing-your-payment-history-and-receipts versions: free-pro-team: '*' +topics: + - billing --- ### Viewing receipts for your personal account diff --git a/content/github/setting-up-and-managing-billing-and-payments-on-github/viewing-your-subscriptions-and-billing-date.md b/content/github/setting-up-and-managing-billing-and-payments-on-github/viewing-your-subscriptions-and-billing-date.md index 71591f0aef..a04c021853 100644 --- a/content/github/setting-up-and-managing-billing-and-payments-on-github/viewing-your-subscriptions-and-billing-date.md +++ b/content/github/setting-up-and-managing-billing-and-payments-on-github/viewing-your-subscriptions-and-billing-date.md @@ -9,6 +9,8 @@ redirect_from: - /articles/viewing-your-subscriptions-and-billing-date versions: free-pro-team: '*' +topics: + - billing --- ### Finding your personal account's next billing date diff --git a/content/github/setting-up-and-managing-organizations-and-teams/about-identity-and-access-management-with-saml-single-sign-on.md b/content/github/setting-up-and-managing-organizations-and-teams/about-identity-and-access-management-with-saml-single-sign-on.md index 624a03a885..154855ba68 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/about-identity-and-access-management-with-saml-single-sign-on.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/about-identity-and-access-management-with-saml-single-sign-on.md @@ -6,6 +6,9 @@ redirect_from: - /articles/about-identity-and-access-management-with-saml-single-sign-on versions: free-pro-team: '*' +topics: + - organizations + - teams --- ### About SAML SSO diff --git a/content/github/setting-up-and-managing-organizations-and-teams/about-oauth-app-access-restrictions.md b/content/github/setting-up-and-managing-organizations-and-teams/about-oauth-app-access-restrictions.md index 5da63c8dc8..4122072bda 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/about-oauth-app-access-restrictions.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/about-oauth-app-access-restrictions.md @@ -6,6 +6,9 @@ redirect_from: - /articles/about-oauth-app-access-restrictions versions: free-pro-team: '*' +topics: + - organizations + - teams --- When {% data variables.product.prodname_oauth_app %} access restrictions are enabled, organization members cannot authorize {% data variables.product.prodname_oauth_app %} access to organization resources. Organization members can request owner approval for {% data variables.product.prodname_oauth_app %}s they'd like to use, and organization owners receive a notification of pending requests. diff --git a/content/github/setting-up-and-managing-organizations-and-teams/about-organizations.md b/content/github/setting-up-and-managing-organizations-and-teams/about-organizations.md index 308abb2d5f..9b777b5eee 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/about-organizations.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/about-organizations.md @@ -7,6 +7,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - organizations + - teams --- {% data reusables.organizations.organizations_include %} diff --git a/content/github/setting-up-and-managing-organizations-and-teams/about-scim.md b/content/github/setting-up-and-managing-organizations-and-teams/about-scim.md index 0fbcbda6ba..36f06c2387 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/about-scim.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/about-scim.md @@ -6,6 +6,9 @@ redirect_from: - /articles/about-scim versions: free-pro-team: '*' +topics: + - organizations + - teams --- If you use [SAML SSO](/articles/about-identity-and-access-management-with-saml-single-sign-on) in your organization, you can implement SCIM to add, manage, and remove organization members' access to {% data variables.product.product_name %}. For example, an administrator can deprovision an organization member using SCIM and automatically remove the member from the organization. diff --git a/content/github/setting-up-and-managing-organizations-and-teams/about-ssh-certificate-authorities.md b/content/github/setting-up-and-managing-organizations-and-teams/about-ssh-certificate-authorities.md index 1b57c0922c..a61f9370d5 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/about-ssh-certificate-authorities.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/about-ssh-certificate-authorities.md @@ -8,6 +8,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - organizations + - teams --- An SSH certificate is a mechanism for one SSH key to sign another SSH key. If you use an SSH certificate authority (CA) to provide your organization members with signed SSH certificates, you can add the CA to your enterprise account or organization to allow organization members to use their certificates to access organization resources. For more information, see "[Managing your organization's SSH certificate authorities](/articles/managing-your-organizations-ssh-certificate-authorities)." diff --git a/content/github/building-a-strong-community/about-team-discussions.md b/content/github/setting-up-and-managing-organizations-and-teams/about-team-discussions.md similarity index 89% rename from content/github/building-a-strong-community/about-team-discussions.md rename to content/github/setting-up-and-managing-organizations-and-teams/about-team-discussions.md index 6bf572b9e9..d95bfccf08 100644 --- a/content/github/building-a-strong-community/about-team-discussions.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/about-team-discussions.md @@ -3,10 +3,13 @@ title: About team discussions intro: 'Your team can plan together, update one another, or talk about any topic you''d like in discussion posts on your team''s page in an organization.' redirect_from: - /articles/about-team-discussions + - /github/building-a-strong-community/about-team-discussions versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - community --- {% data reusables.organizations.team-discussions-purpose %} @@ -15,7 +18,7 @@ Any organization member can post on your team's page or participate in a public ![Discussions tab of team page with public and private discussions](/assets/images/help/organizations/team-page-discussions-tab.png) -You can link to any team discussion to reference it elsewhere. You can pin important posts to your team's page for quick reference later. For more information, see "[Pinning a team discussion](/articles/pinning-a-team-discussion)." +You can link to any team discussion to reference it elsewhere. You can pin important posts to your team's page for quick reference later. For more information, see "[Pinning a team discussion](/github/setting-up-and-managing-organizations-and-teams/pinning-a-team-discussion)." ![Pinned discussions tab of team page with pinned discussion](/assets/images/help/organizations/team-discussions-pinned.png) @@ -41,5 +44,5 @@ For more information, see {% if currentVersion == "free-pro-team@latest" or curr - "[About conversations on {% data variables.product.prodname_dotcom %}](/articles/about-conversations-on-github)" - "[About teams](/articles/about-teams)" -- "[Creating a team discussion](/articles/creating-a-team-discussion)" -- "[Editing or deleting a team discussion](/articles/editing-or-deleting-a-team-discussion)" +- "[Creating a team discussion](/github/setting-up-and-managing-organizations-and-teams/creating-a-team-discussion)" +- "[Editing or deleting a team discussion](/github/setting-up-and-managing-organizations-and-teams/editing-or-deleting-a-team-discussion)" diff --git a/content/github/setting-up-and-managing-organizations-and-teams/about-teams.md b/content/github/setting-up-and-managing-organizations-and-teams/about-teams.md index 6d56d44867..aa9b95d1fd 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/about-teams.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/about-teams.md @@ -7,6 +7,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - organizations + - teams --- ![List of teams in an organization](/assets/images/help/teams/org-list-of-teams.png) @@ -36,7 +39,7 @@ You can also use LDAP Sync to synchronize {% data variables.product.product_loca Each team has its own page within an organization. On a team's page, you can view team members, child teams, and the team's repositories. Organization owners and team maintainers can access team settings and update the team's description and profile picture from the team's page. -Organization members can create and participate in discussions with the team. For more information, see "[About team discussions](/articles/about-team-discussions)." +Organization members can create and participate in discussions with the team. For more information, see "[About team discussions](/github/setting-up-and-managing-organizations-and-teams/about-team-discussions)." ![Team page listing team members and discussions](/assets/images/help/organizations/team-page-discussions-tab.png) diff --git a/content/github/setting-up-and-managing-organizations-and-teams/about-two-factor-authentication-and-saml-single-sign-on.md b/content/github/setting-up-and-managing-organizations-and-teams/about-two-factor-authentication-and-saml-single-sign-on.md index d75c5114c7..d061e78d3a 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/about-two-factor-authentication-and-saml-single-sign-on.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/about-two-factor-authentication-and-saml-single-sign-on.md @@ -6,6 +6,9 @@ redirect_from: - /articles/about-two-factor-authentication-and-saml-single-sign-on versions: free-pro-team: '*' +topics: + - organizations + - teams --- Two-factor authentication (2FA) provides basic authentication for organization members. By enabling 2FA, organization administrators limit the likelihood that a member's {% data variables.product.product_name %} account could be compromised. For more information on 2FA, see "[About two-factor authentication](/articles/about-two-factor-authentication)." diff --git a/content/github/setting-up-and-managing-organizations-and-teams/about-your-organization-dashboard.md b/content/github/setting-up-and-managing-organizations-and-teams/about-your-organization-dashboard.md index fe9be4889c..c2c416383a 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/about-your-organization-dashboard.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/about-your-organization-dashboard.md @@ -7,6 +7,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - organizations + - teams --- ### Accessing your organization dashboard diff --git a/content/github/setting-up-and-managing-organizations-and-teams/about-your-organizations-news-feed.md b/content/github/setting-up-and-managing-organizations-and-teams/about-your-organizations-news-feed.md index 22f71d1f17..daa42f63eb 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/about-your-organizations-news-feed.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/about-your-organizations-news-feed.md @@ -9,6 +9,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - organizations + - teams --- An organization's news feed shows other people's activity on repositories owned by that organization. You can use your organization's news feed to see when someone opens, closes, or merges an issue or pull request, creates or deletes a branch, creates a tag or release, comments on an issue, pull request, or commit, or pushes new commits to {% data variables.product.product_name %}. diff --git a/content/github/setting-up-and-managing-organizations-and-teams/accessing-your-organization-if-your-identity-provider-is-unavailable.md b/content/github/setting-up-and-managing-organizations-and-teams/accessing-your-organization-if-your-identity-provider-is-unavailable.md index 684e4a4f31..6cea7ad0bd 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/accessing-your-organization-if-your-identity-provider-is-unavailable.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/accessing-your-organization-if-your-identity-provider-is-unavailable.md @@ -6,6 +6,9 @@ redirect_from: - /articles/accessing-your-organization-if-your-identity-provider-is-unavailable versions: free-pro-team: '*' +topics: + - organizations + - teams --- Organization administrators can use [one of their downloaded or saved recovery codes](/articles/downloading-your-organization-s-saml-single-sign-on-recovery-codes) to bypass single sign-on. You may have saved these to a password manager, such as [LastPass](https://lastpass.com/), [1Password](https://1password.com/), or [Keeper](https://keepersecurity.com/). diff --git a/content/github/setting-up-and-managing-organizations-and-teams/accessing-your-organizations-settings.md b/content/github/setting-up-and-managing-organizations-and-teams/accessing-your-organizations-settings.md index a3107304bd..cbddd686f4 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/accessing-your-organizations-settings.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/accessing-your-organizations-settings.md @@ -13,6 +13,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - organizations + - teams --- {% if currentVersion == "free-pro-team@latest" %} diff --git a/content/github/setting-up-and-managing-organizations-and-teams/adding-a-billing-manager-to-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/adding-a-billing-manager-to-your-organization.md index 7a1580b75f..f9ae9677a0 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/adding-a-billing-manager-to-your-organization.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/adding-a-billing-manager-to-your-organization.md @@ -5,6 +5,10 @@ redirect_from: - /articles/adding-a-billing-manager-to-your-organization versions: free-pro-team: '*' +topics: + - organizations + - teams + - billing --- Members of your organization's Owners team can give *billing manager* permissions to people. Once a person accepts their invitation to become a billing manager for your organization, they can invite additional people to be billing managers. diff --git a/content/github/setting-up-and-managing-organizations-and-teams/adding-an-outside-collaborator-to-a-project-board-in-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/adding-an-outside-collaborator-to-a-project-board-in-your-organization.md index f7b11a7a0f..0332b57bcf 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/adding-an-outside-collaborator-to-a-project-board-in-your-organization.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/adding-an-outside-collaborator-to-a-project-board-in-your-organization.md @@ -7,6 +7,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - organizations + - teams --- An outside collaborator is a person who isn't explicitly a member of your organization, but who has permissions to a project board in your organization. diff --git a/content/github/setting-up-and-managing-organizations-and-teams/adding-github-app-managers-in-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/adding-github-app-managers-in-your-organization.md index b548094db8..3af305e777 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/adding-github-app-managers-in-your-organization.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/adding-github-app-managers-in-your-organization.md @@ -7,6 +7,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - organizations + - teams --- For more information about {% data variables.product.prodname_github_app %} manager permissions, see "[Permission levels for an organization](/articles/permission-levels-for-an-organization#github-app-managers)." diff --git a/content/github/setting-up-and-managing-organizations-and-teams/adding-organization-members-to-a-team.md b/content/github/setting-up-and-managing-organizations-and-teams/adding-organization-members-to-a-team.md index 95eaedc296..e1152db89d 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/adding-organization-members-to-a-team.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/adding-organization-members-to-a-team.md @@ -8,6 +8,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - organizations + - teams --- {% data reusables.organizations.team-synchronization %} diff --git a/content/github/setting-up-and-managing-organizations-and-teams/adding-outside-collaborators-to-repositories-in-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/adding-outside-collaborators-to-repositories-in-your-organization.md index e38a631a7f..66a47afe1f 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/adding-outside-collaborators-to-repositories-in-your-organization.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/adding-outside-collaborators-to-repositories-in-your-organization.md @@ -7,6 +7,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - organizations + - teams --- {% data reusables.organizations.owners-and-admins-can %} add outside collaborators to a repository, unless an organization owner has restricted the ability to invite collaborators. For more information, see "[Setting permissions for adding outside collaborators](/articles/setting-permissions-for-adding-outside-collaborators)." diff --git a/content/github/setting-up-and-managing-organizations-and-teams/allowing-people-to-delete-issues-in-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/allowing-people-to-delete-issues-in-your-organization.md index 3a68f66481..9c994b1884 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/allowing-people-to-delete-issues-in-your-organization.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/allowing-people-to-delete-issues-in-your-organization.md @@ -7,6 +7,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - organizations + - teams --- By default, issues cannot be deleted in an organization's repositories. An organization owner must enable this feature for all of the organization's repositories first. diff --git a/content/github/setting-up-and-managing-organizations-and-teams/approving-oauth-apps-for-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/approving-oauth-apps-for-your-organization.md index 8396a30e64..f228264ab7 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/approving-oauth-apps-for-your-organization.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/approving-oauth-apps-for-your-organization.md @@ -6,6 +6,9 @@ redirect_from: - /articles/approving-oauth-apps-for-your-organization versions: free-pro-team: '*' +topics: + - organizations + - teams --- When {% data variables.product.prodname_oauth_app %} access restrictions are enabled, organization members must [request approval](/articles/requesting-organization-approval-for-oauth-apps) from an organization owner before they can authorize an {% data variables.product.prodname_oauth_app %} that has access to the organization's resources. diff --git a/content/github/setting-up-and-managing-organizations-and-teams/can-i-create-accounts-for-people-in-my-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/can-i-create-accounts-for-people-in-my-organization.md index 6e719b47ed..27a51a313a 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/can-i-create-accounts-for-people-in-my-organization.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/can-i-create-accounts-for-people-in-my-organization.md @@ -6,6 +6,9 @@ redirect_from: intro: 'While you can add users to an organization you''ve created, you can''t create personal user accounts on behalf of another person.' versions: free-pro-team: '*' +topics: + - organizations + - teams --- Because you access an organization by logging in to a personal account, each of your team members needs a personal account. Once you have user names for each person you'd like to add to your organization, you can add them to teams. diff --git a/content/github/setting-up-and-managing-organizations-and-teams/canceling-an-invitation-to-become-an-outside-collaborator-in-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/canceling-an-invitation-to-become-an-outside-collaborator-in-your-organization.md index 0725241ec2..221fd32ac7 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/canceling-an-invitation-to-become-an-outside-collaborator-in-your-organization.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/canceling-an-invitation-to-become-an-outside-collaborator-in-your-organization.md @@ -4,6 +4,9 @@ intro: You can cancel all invitations for a person to become an outside collabor permissions: Organization owners can cancel an invitation to become an outside collaborator in the organization. versions: free-pro-team: '*' +topics: + - organizations + - teams --- You can view a list of all people with pending invitations to become an outside collaborator on any repository owned by your organization. diff --git a/content/github/setting-up-and-managing-organizations-and-teams/canceling-or-editing-an-invitation-to-join-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/canceling-or-editing-an-invitation-to-join-your-organization.md index 81cb2611c5..2e14f7e102 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/canceling-or-editing-an-invitation-to-join-your-organization.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/canceling-or-editing-an-invitation-to-join-your-organization.md @@ -5,6 +5,9 @@ redirect_from: - /articles/canceling-or-editing-an-invitation-to-join-your-organization versions: free-pro-team: '*' +topics: + - organizations + - teams --- {% data reusables.profile.access_profile %} diff --git a/content/github/setting-up-and-managing-organizations-and-teams/changing-team-visibility.md b/content/github/setting-up-and-managing-organizations-and-teams/changing-team-visibility.md index d72bc2ee19..262113a3a3 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/changing-team-visibility.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/changing-team-visibility.md @@ -7,6 +7,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - organizations + - teams --- {% data reusables.organizations.types-of-team-visibility %} diff --git a/content/github/setting-up-and-managing-organizations-and-teams/changing-the-visibility-of-your-organizations-dependency-insights.md b/content/github/setting-up-and-managing-organizations-and-teams/changing-the-visibility-of-your-organizations-dependency-insights.md index 1db374fdc1..790a56e104 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/changing-the-visibility-of-your-organizations-dependency-insights.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/changing-the-visibility-of-your-organizations-dependency-insights.md @@ -6,6 +6,9 @@ redirect_from: - /articles/changing-the-visibility-of-your-organizations-dependency-insights versions: free-pro-team: '*' +topics: + - organizations + - teams --- Organization owners can set limitations for viewing organization dependency insights. All members of an organization can view organization dependency insights by default. diff --git a/content/github/setting-up-and-managing-organizations-and-teams/collaborating-with-groups-in-organizations.md b/content/github/setting-up-and-managing-organizations-and-teams/collaborating-with-groups-in-organizations.md index d73f270e57..6e4d1b4eed 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/collaborating-with-groups-in-organizations.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/collaborating-with-groups-in-organizations.md @@ -9,5 +9,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - organizations + - teams --- diff --git a/content/github/building-a-strong-community/collaborating-with-your-team.md b/content/github/setting-up-and-managing-organizations-and-teams/collaborating-with-your-team.md similarity index 76% rename from content/github/building-a-strong-community/collaborating-with-your-team.md rename to content/github/setting-up-and-managing-organizations-and-teams/collaborating-with-your-team.md index 6e17a6cece..cb4c12309f 100644 --- a/content/github/building-a-strong-community/collaborating-with-your-team.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/collaborating-with-your-team.md @@ -4,9 +4,12 @@ intro: 'Within an organization, your team can work together across projects usin mapTopic: true redirect_from: - /articles/collaborating-with-your-team + - /github/building-a-strong-community/collaborating-with-your-team versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - community --- diff --git a/content/github/setting-up-and-managing-organizations-and-teams/configuring-saml-single-sign-on-and-scim-using-okta.md b/content/github/setting-up-and-managing-organizations-and-teams/configuring-saml-single-sign-on-and-scim-using-okta.md index 2f34342827..effe8a36c8 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/configuring-saml-single-sign-on-and-scim-using-okta.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/configuring-saml-single-sign-on-and-scim-using-okta.md @@ -5,6 +5,9 @@ product: '{% data reusables.gated-features.saml-sso %}' permissions: Organization owners can configure SAML SSO and SCIM using Okta for an organization. versions: free-pro-team: '*' +topics: + - organizations + - teams --- ### About SAML and SCIM with Okta diff --git a/content/github/setting-up-and-managing-organizations-and-teams/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-organization.md index 5934c07381..967d47bdf4 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-organization.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-organization.md @@ -4,6 +4,10 @@ intro: 'You can configure the retention period for {% data variables.product.pro versions: free-pro-team: '*' enterprise-server: '>=2.23' + github-ae: '*' +topics: + - organizations + - teams --- {% data reusables.actions.about-artifact-log-retention %} diff --git a/content/github/setting-up-and-managing-organizations-and-teams/connecting-your-identity-provider-to-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/connecting-your-identity-provider-to-your-organization.md index ab1ebbef74..1196bdc9b3 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/connecting-your-identity-provider-to-your-organization.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/connecting-your-identity-provider-to-your-organization.md @@ -6,6 +6,9 @@ redirect_from: - /articles/connecting-your-identity-provider-to-your-organization versions: free-pro-team: '*' +topics: + - organizations + - teams --- Before [enabling SAML SSO](/articles/enabling-and-testing-saml-single-sign-on-for-your-organization) in your {% data variables.product.product_name %} organization, you'll need to connect your identity provider (IdP) to your organization. diff --git a/content/github/setting-up-and-managing-organizations-and-teams/converting-an-admin-team-to-improved-organization-permissions.md b/content/github/setting-up-and-managing-organizations-and-teams/converting-an-admin-team-to-improved-organization-permissions.md index ebda3d0ae0..c706237e94 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/converting-an-admin-team-to-improved-organization-permissions.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/converting-an-admin-team-to-improved-organization-permissions.md @@ -7,6 +7,9 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '*' +topics: + - organizations + - teams --- You can remove the ability for members of legacy admin teams to create repositories by creating a new team for these members, ensuring that the team has necessary access to the organization's repositories, then deleting the legacy admin team. diff --git a/content/github/setting-up-and-managing-organizations-and-teams/converting-an-organization-into-a-user.md b/content/github/setting-up-and-managing-organizations-and-teams/converting-an-organization-into-a-user.md index f06589eb33..f12e2987df 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/converting-an-organization-into-a-user.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/converting-an-organization-into-a-user.md @@ -6,6 +6,9 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '*' +topics: + - organizations + - teams --- {% if currentVersion == "free-pro-team@latest" %} diff --git a/content/github/setting-up-and-managing-organizations-and-teams/converting-an-organization-member-to-an-outside-collaborator.md b/content/github/setting-up-and-managing-organizations-and-teams/converting-an-organization-member-to-an-outside-collaborator.md index 5e15884e40..0d2f02074d 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/converting-an-organization-member-to-an-outside-collaborator.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/converting-an-organization-member-to-an-outside-collaborator.md @@ -7,6 +7,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - organizations + - teams --- {% data reusables.organizations.owners-and-admins-can %} convert organization members into outside collaborators. diff --git a/content/github/setting-up-and-managing-organizations-and-teams/converting-an-outside-collaborator-to-an-organization-member.md b/content/github/setting-up-and-managing-organizations-and-teams/converting-an-outside-collaborator-to-an-organization-member.md index 55a11392c5..81ece0d1b2 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/converting-an-outside-collaborator-to-an-organization-member.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/converting-an-outside-collaborator-to-an-organization-member.md @@ -7,7 +7,10 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' -permissions: Organization owners can {% if currentVersion == "free-pro-team@latest" %}invite users to join{% else %}add users to{% endif %} an organization. +permissions: 'Organization owners can {% if currentVersion == "free-pro-team@latest" %}invite users to join{% else %}add users to{% endif %} an organization.' +topics: + - organizations + - teams --- {% if currentVersion == "free-pro-team@latest" %} If your organization is on a paid per-user subscription, an unused license must be available before you can invite a new member to join the organization or reinstate a former organization member. For more information, see "[About per-user pricing](/articles/about-per-user-pricing)." {% data reusables.organizations.org-invite-expiration %}{% endif %} diff --git a/content/github/setting-up-and-managing-organizations-and-teams/converting-an-owners-team-to-improved-organization-permissions.md b/content/github/setting-up-and-managing-organizations-and-teams/converting-an-owners-team-to-improved-organization-permissions.md index 544e7396b5..1caafa06b9 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/converting-an-owners-team-to-improved-organization-permissions.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/converting-an-owners-team-to-improved-organization-permissions.md @@ -8,6 +8,9 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '*' +topics: + - organizations + - teams --- You have a few options to convert your legacy Owners team: diff --git a/content/github/setting-up-and-managing-organizations-and-teams/creating-a-new-organization-from-scratch.md b/content/github/setting-up-and-managing-organizations-and-teams/creating-a-new-organization-from-scratch.md index d1d3d1b650..db638bafff 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/creating-a-new-organization-from-scratch.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/creating-a-new-organization-from-scratch.md @@ -8,6 +8,9 @@ versions: redirect_from: - /articles/creating-a-new-organization-from-scratch - /admin/user-management/creating-organizations +topics: + - organizations + - teams --- When you create a new organization from scratch, it doesn't have any repositories associated with it. For more information on adding repositories to your organization, see "[Creating a new repository](/articles/creating-a-new-repository)" and "[Transferring a repository](/articles/transferring-a-repository)." diff --git a/content/github/building-a-strong-community/creating-a-team-discussion.md b/content/github/setting-up-and-managing-organizations-and-teams/creating-a-team-discussion.md similarity index 65% rename from content/github/building-a-strong-community/creating-a-team-discussion.md rename to content/github/setting-up-and-managing-organizations-and-teams/creating-a-team-discussion.md index 0481b6502b..968a93eef7 100644 --- a/content/github/building-a-strong-community/creating-a-team-discussion.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/creating-a-team-discussion.md @@ -3,13 +3,16 @@ title: Creating a team discussion intro: 'Any organization member can create a _public_ team discussion post. To create a _private_ team discussion post, you must be a member of the team or an organization owner.' redirect_from: - /articles/creating-a-team-discussion + - /github/building-a-strong-community/creating-a-team-discussion versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - community --- -{% data reusables.organizations.team-discussions-permissions %} For more information, see "[About team discussions](/articles/about-team-discussions)." +{% data reusables.organizations.team-discussions-permissions %} For more information, see "[About team discussions](/github/setting-up-and-managing-organizations-and-teams/about-team-discussions)." {% data reusables.profile.access_profile %} {% data reusables.profile.access_org %} @@ -24,6 +27,6 @@ versions: ### Further reading - - "[About team discussions](/articles/about-team-discussions)" - - "[Editing or deleting a team discussion](/articles/editing-or-deleting-a-team-discussion)" - - "[Pinning a team discussion](/articles/pinning-a-team-discussion)" + - "[About team discussions](/github/setting-up-and-managing-organizations-and-teams/about-team-discussions)" + - "[Editing or deleting a team discussion](/github/setting-up-and-managing-organizations-and-teams/editing-or-deleting-a-team-discussion)" + - "[Pinning a team discussion](/github/setting-up-and-managing-organizations-and-teams/pinning-a-team-discussion)" diff --git a/content/github/setting-up-and-managing-organizations-and-teams/creating-a-team.md b/content/github/setting-up-and-managing-organizations-and-teams/creating-a-team.md index d29be64dc9..4bba443eb8 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/creating-a-team.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/creating-a-team.md @@ -8,6 +8,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - organizations + - teams --- Only organization owners and maintainers of a parent team can create a new child team under a parent. Owners can also restrict creation permissions for all teams in an organization. For more information, see "[Setting team creation permissions in your organization](/articles/setting-team-creation-permissions-in-your-organization)." diff --git a/content/github/setting-up-and-managing-organizations-and-teams/deleting-a-team.md b/content/github/setting-up-and-managing-organizations-and-teams/deleting-a-team.md index bee8b07a10..5509cc6d98 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/deleting-a-team.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/deleting-a-team.md @@ -7,6 +7,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - organizations + - teams --- {% tip %} diff --git a/content/github/setting-up-and-managing-organizations-and-teams/deleting-an-organization-account.md b/content/github/setting-up-and-managing-organizations-and-teams/deleting-an-organization-account.md index d483f8554c..ab490ccd8f 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/deleting-an-organization-account.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/deleting-an-organization-account.md @@ -7,6 +7,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - organizations + - teams --- {% if currentVersion == "free-pro-team@latest" %} diff --git a/content/github/setting-up-and-managing-organizations-and-teams/denying-access-to-a-previously-approved-oauth-app-for-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/denying-access-to-a-previously-approved-oauth-app-for-your-organization.md index 0463ce5199..f83e8694c7 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/denying-access-to-a-previously-approved-oauth-app-for-your-organization.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/denying-access-to-a-previously-approved-oauth-app-for-your-organization.md @@ -6,6 +6,9 @@ redirect_from: - /articles/denying-access-to-a-previously-approved-oauth-app-for-your-organization versions: free-pro-team: '*' +topics: + - organizations + - teams --- {% data reusables.profile.access_profile %} diff --git a/content/github/setting-up-and-managing-organizations-and-teams/disabling-oauth-app-access-restrictions-for-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/disabling-oauth-app-access-restrictions-for-your-organization.md index ed149595e0..0cd8846027 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/disabling-oauth-app-access-restrictions-for-your-organization.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/disabling-oauth-app-access-restrictions-for-your-organization.md @@ -6,6 +6,9 @@ redirect_from: - /articles/disabling-oauth-app-access-restrictions-for-your-organization versions: free-pro-team: '*' +topics: + - organizations + - teams --- {% danger %} diff --git a/content/github/setting-up-and-managing-organizations-and-teams/disabling-or-limiting-github-actions-for-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/disabling-or-limiting-github-actions-for-your-organization.md index 5dc65ade41..d21c9c8b6f 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/disabling-or-limiting-github-actions-for-your-organization.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/disabling-or-limiting-github-actions-for-your-organization.md @@ -4,6 +4,10 @@ intro: 'Organization owners can disable, enable, and limit GitHub Actions for an versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' +topics: + - organizations + - teams --- {% data reusables.actions.enterprise-beta %} diff --git a/content/github/setting-up-and-managing-organizations-and-teams/disabling-team-discussions-for-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/disabling-team-discussions-for-your-organization.md index e4d9e8d55a..99b423896d 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/disabling-team-discussions-for-your-organization.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/disabling-team-discussions-for-your-organization.md @@ -7,9 +7,12 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - organizations + - teams --- -{% data reusables.organizations.team-discussions-default %} For more information on team discussions, see "[About team discussions](/articles/about-team-discussions)." +{% data reusables.organizations.team-discussions-default %} For more information on team discussions, see "[About team discussions](/github/setting-up-and-managing-organizations-and-teams/about-team-discussions)." {% data reusables.profile.access_profile %} {% data reusables.profile.access_org %} diff --git a/content/github/setting-up-and-managing-organizations-and-teams/downloading-your-organizations-saml-single-sign-on-recovery-codes.md b/content/github/setting-up-and-managing-organizations-and-teams/downloading-your-organizations-saml-single-sign-on-recovery-codes.md index bebfbbc2d9..fe2af11379 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/downloading-your-organizations-saml-single-sign-on-recovery-codes.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/downloading-your-organizations-saml-single-sign-on-recovery-codes.md @@ -7,6 +7,9 @@ redirect_from: product: '{% data reusables.gated-features.saml-sso %}' versions: free-pro-team: '*' +topics: + - organizations + - teams --- Recovery codes should not be shared or distributed. We recommend saving them with a password manager such as [LastPass](https://lastpass.com/), [1Password](https://1password.com/), or [Keeper](https://keepersecurity.com/). diff --git a/content/github/building-a-strong-community/editing-or-deleting-a-team-discussion.md b/content/github/setting-up-and-managing-organizations-and-teams/editing-or-deleting-a-team-discussion.md similarity index 69% rename from content/github/building-a-strong-community/editing-or-deleting-a-team-discussion.md rename to content/github/setting-up-and-managing-organizations-and-teams/editing-or-deleting-a-team-discussion.md index ba567880e8..7397639d74 100644 --- a/content/github/building-a-strong-community/editing-or-deleting-a-team-discussion.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/editing-or-deleting-a-team-discussion.md @@ -3,10 +3,13 @@ title: Editing or deleting a team discussion intro: 'Organization members can edit or delete discussions on a team''s page. If you''re an organization member, you can edit or delete the discussion.' redirect_from: - /articles/editing-or-deleting-a-team-discussion + - /github/building-a-strong-community/editing-or-deleting-a-team-discussion versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - community --- {% data reusables.profile.access_profile %} @@ -21,6 +24,6 @@ versions: ### Further reading - - "[About team discussions](/articles/about-team-discussions)" - - "[Creating a team discussion](/articles/creating-a-team-discussion)" - - "[Pinning a team discussion](/articles/pinning-a-team-discussion)" + - "[About team discussions](/github/setting-up-and-managing-organizations-and-teams/about-team-discussions)" + - "[Creating a team discussion](/github/setting-up-and-managing-organizations-and-teams/creating-a-team-discussion)" + - "[Pinning a team discussion](/github/setting-up-and-managing-organizations-and-teams/pinning-a-team-discussion)" diff --git a/content/github/setting-up-and-managing-organizations-and-teams/enabling-and-testing-saml-single-sign-on-for-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/enabling-and-testing-saml-single-sign-on-for-your-organization.md index 7de1e9bcd7..8f3fc489a1 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/enabling-and-testing-saml-single-sign-on-for-your-organization.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/enabling-and-testing-saml-single-sign-on-for-your-organization.md @@ -6,6 +6,9 @@ redirect_from: - /articles/enabling-and-testing-saml-single-sign-on-for-your-organization versions: free-pro-team: '*' +topics: + - organizations + - teams --- You can enable SAML SSO in your organization without requiring all members to use it. Enabling but not enforcing SAML SSO in your organization can help smooth your organization's SAML SSO adoption. Once a majority of your organization's members use SAML SSO, you can enforce it within your organization. diff --git a/content/github/setting-up-and-managing-organizations-and-teams/enabling-oauth-app-access-restrictions-for-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/enabling-oauth-app-access-restrictions-for-your-organization.md index afb7f66b0c..adc8f17827 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/enabling-oauth-app-access-restrictions-for-your-organization.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/enabling-oauth-app-access-restrictions-for-your-organization.md @@ -6,6 +6,9 @@ redirect_from: - /articles/enabling-oauth-app-access-restrictions-for-your-organization versions: free-pro-team: '*' +topics: + - organizations + - teams --- {% data reusables.organizations.oauth_app_restrictions_default %} diff --git a/content/github/setting-up-and-managing-organizations-and-teams/enforcing-saml-single-sign-on-for-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/enforcing-saml-single-sign-on-for-your-organization.md index d331a4ca12..08241fc58b 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/enforcing-saml-single-sign-on-for-your-organization.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/enforcing-saml-single-sign-on-for-your-organization.md @@ -6,6 +6,9 @@ redirect_from: - /articles/enforcing-saml-single-sign-on-for-your-organization versions: free-pro-team: '*' +topics: + - organizations + - teams --- If you enforce SAML SSO in your organization, any members, including admins who have not authenticated via your SAML identity provider (IdP), will be removed from the organization and will receive an email notifying them about the removal. Bots and service accounts that do not have external identities set up in your organization's IdP will also be removed. For more information on bots and service accounts, see "[Managing bots and service accounts with SAML single sign-on](/articles/managing-bots-and-service-accounts-with-saml-single-sign-on)." You can restore organization members once they successfully complete single sign-on. diff --git a/content/github/setting-up-and-managing-organizations-and-teams/giving-team-maintainer-permissions-to-an-organization-member.md b/content/github/setting-up-and-managing-organizations-and-teams/giving-team-maintainer-permissions-to-an-organization-member.md index 24808059f5..5153f6a357 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/giving-team-maintainer-permissions-to-an-organization-member.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/giving-team-maintainer-permissions-to-an-organization-member.md @@ -8,6 +8,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - organizations + - teams --- {% data reusables.organizations.team_maintainers_can %} diff --git a/content/github/setting-up-and-managing-organizations-and-teams/granting-access-to-your-organization-with-saml-single-sign-on.md b/content/github/setting-up-and-managing-organizations-and-teams/granting-access-to-your-organization-with-saml-single-sign-on.md index c0353de939..80c5ff6848 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/granting-access-to-your-organization-with-saml-single-sign-on.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/granting-access-to-your-organization-with-saml-single-sign-on.md @@ -6,5 +6,8 @@ redirect_from: - /articles/granting-access-to-your-organization-with-saml-single-sign-on versions: free-pro-team: '*' +topics: + - organizations + - teams --- diff --git a/content/github/setting-up-and-managing-organizations-and-teams/index.md b/content/github/setting-up-and-managing-organizations-and-teams/index.md index a51df67c98..70a9607bb9 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/index.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/index.md @@ -9,6 +9,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - organizations + - teams --- @@ -51,6 +54,11 @@ versions: {% link_in_list /disabling-team-discussions-for-your-organization %} {% link_in_list /managing-scheduled-reminders-for-your-team %} {% link_in_list /deleting-a-team %} +{% topic_link_in_list /collaborating-with-your-team %} + {% link_in_list /about-team-discussions %} + {% link_in_list /creating-a-team-discussion %} + {% link_in_list /editing-or-deleting-a-team-discussion %} + {% link_in_list /pinning-a-team-discussion %} {% topic_link_in_list /managing-access-to-your-organizations-repositories %} {% link_in_list /repository-permission-levels-for-an-organization %} {% link_in_list /setting-base-permissions-for-an-organization %} diff --git a/content/github/setting-up-and-managing-organizations-and-teams/inviting-users-to-join-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/inviting-users-to-join-your-organization.md index 0c7304d050..7f2c029ce4 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/inviting-users-to-join-your-organization.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/inviting-users-to-join-your-organization.md @@ -7,6 +7,9 @@ redirect_from: - /articles/inviting-users-to-join-your-organization versions: free-pro-team: '*' +topics: + - organizations + - teams --- {% tip %} diff --git a/content/github/setting-up-and-managing-organizations-and-teams/keeping-your-organization-secure.md b/content/github/setting-up-and-managing-organizations-and-teams/keeping-your-organization-secure.md index ae816c4de7..62b65b07ce 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/keeping-your-organization-secure.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/keeping-your-organization-secure.md @@ -9,5 +9,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - organizations + - teams --- diff --git a/content/github/setting-up-and-managing-organizations-and-teams/maintaining-ownership-continuity-for-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/maintaining-ownership-continuity-for-your-organization.md index 3264533765..76c0456caa 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/maintaining-ownership-continuity-for-your-organization.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/maintaining-ownership-continuity-for-your-organization.md @@ -10,6 +10,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - organizations + - teams --- ### About maintaining ownership continuity for your organization diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-access-to-a-project-board-for-organization-members.md b/content/github/setting-up-and-managing-organizations-and-teams/managing-access-to-a-project-board-for-organization-members.md index 5d7ab225fd..b15db3e0cc 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/managing-access-to-a-project-board-for-organization-members.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/managing-access-to-a-project-board-for-organization-members.md @@ -7,6 +7,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - organizations + - teams --- By default, organization members have write access to their organization's project boards unless organization owners or project board admins set different permissions for specific project boards. diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-access-to-your-organizations-apps.md b/content/github/setting-up-and-managing-organizations-and-teams/managing-access-to-your-organizations-apps.md index 09b911c5fe..722baa5e9d 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/managing-access-to-your-organizations-apps.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/managing-access-to-your-organizations-apps.md @@ -9,5 +9,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - organizations + - teams --- diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-access-to-your-organizations-project-boards.md b/content/github/setting-up-and-managing-organizations-and-teams/managing-access-to-your-organizations-project-boards.md index cd5110e35f..2bdeee3631 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/managing-access-to-your-organizations-project-boards.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/managing-access-to-your-organizations-project-boards.md @@ -9,5 +9,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - organizations + - teams --- diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-access-to-your-organizations-repositories.md b/content/github/setting-up-and-managing-organizations-and-teams/managing-access-to-your-organizations-repositories.md index b6a9fa4057..ed1fe22a09 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/managing-access-to-your-organizations-repositories.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/managing-access-to-your-organizations-repositories.md @@ -10,5 +10,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - organizations + - teams --- diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-allowed-ip-addresses-for-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/managing-allowed-ip-addresses-for-your-organization.md index d92c67df7d..7b77503d4f 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/managing-allowed-ip-addresses-for-your-organization.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/managing-allowed-ip-addresses-for-your-organization.md @@ -4,10 +4,14 @@ intro: You can restrict access to your organization's assets by configuring a li product: '{% data reusables.gated-features.allowed-ip-addresses %}' versions: free-pro-team: '*' + github-ae: '*' +topics: + - organizations + - teams --- Organization owners can manage allowed IP addresses for an organization. - + ### About allowed IP addresses You can restrict access to organization assets by configuring an allow list for specific IP addresses. {% data reusables.identity-and-permissions.ip-allow-lists-example-and-restrictions %} @@ -16,7 +20,7 @@ You can restrict access to organization assets by configuring an allow list for {% data reusables.identity-and-permissions.ip-allow-lists-enable %} -You can also configure allowed IP addresses for the organizations in an enterprise account. For more information, see "[Enforcing security settings in your enterprise account](/github/setting-up-and-managing-your-enterprise/enforcing-security-settings-in-your-enterprise-account#managing-allowed-ip-addresses-for-organizations-in-your-enterprise-account)." +You can also configure allowed IP addresses for the organizations in an enterprise account. For more information, see {% if currentVersion == "github-ae@latest" %}"[Restricting network traffic to your enterprise](/admin/configuration/restricting-network-traffic-to-your-enterprise)." {% else %}"[Enforcing security settings in your enterprise account](/github/setting-up-and-managing-your-enterprise/enforcing-security-settings-in-your-enterprise-account#managing-allowed-ip-addresses-for-organizations-in-your-enterprise-account)."{% endif %} ### Adding an allowed IP address @@ -60,4 +64,12 @@ You can also configure allowed IP addresses for the organizations in an enterpri ### Using {% data variables.product.prodname_actions %} with an IP allow list +{% if currentVersion == "github-ae@latest" %} + +{% data reusables.github-actions.ip-allow-list-hosted-runners %} + +{% else %} + {% data reusables.github-actions.ip-allow-list-self-hosted-runners %} + +{% endif %} diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-an-individuals-access-to-an-organization-project-board.md b/content/github/setting-up-and-managing-organizations-and-teams/managing-an-individuals-access-to-an-organization-project-board.md index cd5207d102..3141574194 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/managing-an-individuals-access-to-an-organization-project-board.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/managing-an-individuals-access-to-an-organization-project-board.md @@ -8,6 +8,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - organizations + - teams --- {% note %} diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-an-individuals-access-to-an-organization-repository.md b/content/github/setting-up-and-managing-organizations-and-teams/managing-an-individuals-access-to-an-organization-repository.md index 194b8f4c9a..f7dcde666d 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/managing-an-individuals-access-to-an-organization-repository.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/managing-an-individuals-access-to-an-organization-repository.md @@ -9,6 +9,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - organizations + - teams --- People with admin permissions can manage the access of organization members and outside collaborators to an organization repository. diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-bots-and-service-accounts-with-saml-single-sign-on.md b/content/github/setting-up-and-managing-organizations-and-teams/managing-bots-and-service-accounts-with-saml-single-sign-on.md index 4cd31df71a..f16c843a4e 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/managing-bots-and-service-accounts-with-saml-single-sign-on.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/managing-bots-and-service-accounts-with-saml-single-sign-on.md @@ -6,6 +6,9 @@ redirect_from: - /articles/managing-bots-and-service-accounts-with-saml-single-sign-on versions: free-pro-team: '*' +topics: + - organizations + - teams --- To retain access for bots and service accounts, organization administrators can [enable](/articles/enabling-and-testing-saml-single-sign-on-for-your-organization), but **not** [enforce](/articles/enforcing-saml-single-sign-on-for-your-organization) SAML single sign-on for their organization. If you need to enforce SAML single sign-on for your organization, you can create an external identity for the bot or service account with your identity provider (IdP). diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-code-review-assignment-for-your-team.md b/content/github/setting-up-and-managing-organizations-and-teams/managing-code-review-assignment-for-your-team.md index 750351b231..3ba913f229 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/managing-code-review-assignment-for-your-team.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/managing-code-review-assignment-for-your-team.md @@ -6,6 +6,9 @@ versions: free-pro-team: '*' enterprise-server: '>=2.20' github-ae: '*' +topics: + - organizations + - teams --- Team maintainers and organization owners can configure code review assignments. diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-default-labels-for-repositories-in-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/managing-default-labels-for-repositories-in-your-organization.md index cd54ddd0c9..7ec3f9f8c4 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/managing-default-labels-for-repositories-in-your-organization.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/managing-default-labels-for-repositories-in-your-organization.md @@ -7,6 +7,9 @@ versions: free-pro-team: '*' enterprise-server: '>=2.20' github-ae: '*' +topics: + - organizations + - teams --- Organization owners can manage default labels for repositories in the organization. diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-discussion-creation-for-repositories-in-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/managing-discussion-creation-for-repositories-in-your-organization.md index 7f6719b4f8..59557ff8e9 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/managing-discussion-creation-for-repositories-in-your-organization.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/managing-discussion-creation-for-repositories-in-your-organization.md @@ -4,6 +4,9 @@ intro: You can choose the permission levels that members require to create discu permissions: Organization owners can manage discussion creation for repositories owned by the organization. versions: free-pro-team: '*' +topics: + - organizations + - teams --- {% data reusables.discussions.beta %} diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-git-access-to-your-organizations-repositories.md b/content/github/setting-up-and-managing-organizations-and-teams/managing-git-access-to-your-organizations-repositories.md index 168400ecde..0070b8eba7 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/managing-git-access-to-your-organizations-repositories.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/managing-git-access-to-your-organizations-repositories.md @@ -10,5 +10,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - organizations + - teams --- diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-membership-in-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/managing-membership-in-your-organization.md index 507ee1d405..497c8251f9 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/managing-membership-in-your-organization.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/managing-membership-in-your-organization.md @@ -9,5 +9,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - organizations + - teams --- diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-organization-settings.md b/content/github/setting-up-and-managing-organizations-and-teams/managing-organization-settings.md index 18cf027e38..64b002f6bf 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/managing-organization-settings.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/managing-organization-settings.md @@ -8,5 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - organizations + - teams --- diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-peoples-access-to-your-organization-with-roles.md b/content/github/setting-up-and-managing-organizations-and-teams/managing-peoples-access-to-your-organization-with-roles.md index f21057f972..9d14684e91 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/managing-peoples-access-to-your-organization-with-roles.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/managing-peoples-access-to-your-organization-with-roles.md @@ -9,5 +9,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - organizations + - teams --- diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-saml-single-sign-on-for-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/managing-saml-single-sign-on-for-your-organization.md index 99753ae9e2..f39fa938c3 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/managing-saml-single-sign-on-for-your-organization.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/managing-saml-single-sign-on-for-your-organization.md @@ -7,5 +7,8 @@ redirect_from: - /articles/managing-saml-single-sign-on-for-your-organization versions: free-pro-team: '*' +topics: + - organizations + - teams --- diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-scheduled-reminders-for-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/managing-scheduled-reminders-for-your-organization.md index 93269f99c4..1d046ad5ee 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/managing-scheduled-reminders-for-your-organization.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/managing-scheduled-reminders-for-your-organization.md @@ -3,6 +3,9 @@ title: Managing scheduled reminders for your organization intro: You can get reminders in Slack for all pull requests that teams in your organization have been requested to review. versions: free-pro-team: '*' +topics: + - organizations + - teams --- ### About scheduled reminders for pull requests diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-scheduled-reminders-for-your-team.md b/content/github/setting-up-and-managing-organizations-and-teams/managing-scheduled-reminders-for-your-team.md index 1be6eb0787..be3b2ef9c0 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/managing-scheduled-reminders-for-your-team.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/managing-scheduled-reminders-for-your-team.md @@ -5,6 +5,9 @@ redirect_from: - /github/setting-up-and-managing-organizations-and-teams/managing-scheduled-reminders-for-pull-requests versions: free-pro-team: '*' +topics: + - organizations + - teams --- ### About scheduled reminders for teams diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization.md index 2bc198a304..61d86f76ab 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization.md @@ -7,6 +7,10 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=3.0' + github-ae: '*' +topics: + - organizations + - teams --- ### About management of security and analysis settings @@ -25,10 +29,12 @@ versions: The page that's displayed allows you to enable or disable all security and analysis features for the repositories in your organization. -{% if currentVersion == "free-pro-team@latest" %}If your organization, or the enterprise that owns it, has a license for {% data variables.product.prodname_GH_advanced_security %}, the page will also contain options to enable and disable {% data variables.product.prodname_advanced_security %} features. Any repositories that use {% data variables.product.prodname_GH_advanced_security %} are listed at the bottom of the page.{% endif %} +{% if currentVersion == "free-pro-team@latest" %}If your organization belongs to an enterprise with a license for {% data variables.product.prodname_GH_advanced_security %}, the page will also contain options to enable and disable {% data variables.product.prodname_advanced_security %} features. Any repositories that use {% data variables.product.prodname_GH_advanced_security %} are listed at the bottom of the page.{% endif %} {% if currentVersion ver_gt "enterprise-server@3.0" %}If you have a license for {% data variables.product.prodname_GH_advanced_security %}, the page will also contain options to enable and disable {% data variables.product.prodname_advanced_security %} features. Any repositories that use {% data variables.product.prodname_GH_advanced_security %} are listed at the bottom of the page.{% endif %} +{% if currentVersion == "github-ae@latest" %}The page will also contain options to enable and disable {% data variables.product.prodname_advanced_security %} features.{% endif %} + ### Enabling or disabling a feature for all existing repositories You can enable or disable features for all repositories. {% if currentVersion == "free-pro-team@latest" %}The impact of your changes on repositories in your organization is determined by their visibility: @@ -39,75 +45,97 @@ You can enable or disable features for all repositories. {% if currentVersion == - **{% data variables.product.prodname_GH_advanced_security %}** - Your changes affect only private repositories because {% data variables.product.prodname_GH_advanced_security %} and the related features are always enabled for public repositories. - **{% data variables.product.prodname_secret_scanning_caps %}** - Your changes affect only private repositories where {% data variables.product.prodname_GH_advanced_security %} is also enabled. {% data variables.product.prodname_secret_scanning_caps %} is always enabled for public repositories.{% endif %} -{% data reusables.advanced-security.note-org-enable-uses-seats %} +{% data reusables.advanced-security.note-org-enable-uses-seats %} 1. Go to the security and analysis settings for your organization. For more information, see "[Displaying the security and analysis settings](#displaying-the-security-and-analysis-settings)." -1. Under "Configure security and analysis features", to the right of the feature, click **Disable all** or **Enable all**. +2. Under "Configure security and analysis features", to the right of the feature, click **Disable all** or **Enable all**. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}The control for "{% data variables.product.prodname_GH_advanced_security %}" is disabled if you have no available seats in your {% data variables.product.prodname_GH_advanced_security %} license.{% endif %} {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} !["Enable all" or "Disable all" button for "Configure security and analysis" features](/assets/images/help/organizations/security-and-analysis-disable-or-enable-all-ghas-dotcom.png) - {% else if enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.22" %} + {% endif %} + {% if enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.22" %} !["Enable all" or "Disable all" button for "Configure security and analysis" features](/assets/images/help/organizations/security-and-analysis-disable-or-enable-all-ghe.png) {% endif %} -2. Optionally, enable the feature by default for new repositories in your organization. + {% if currentVersion == "github-ae@latest" %} + !["Enable all" or "Disable all" button for "Configure security and analysis" features](/assets/images/enterprise/github-ae/organizations/security-and-analysis-disable-or-enable-all-ghae.png) + {% endif %} + {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} +3. Optionally, enable the feature by default for new repositories in your organization. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} !["Enable by default" option for new repositories](/assets/images/help/organizations/security-and-analysis-enable-by-default-in-modal.png) - {% else if enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.22" %} + {% endif %} + {% if enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.22" %} !["Enable by default" option for new repositories](/assets/images/help/organizations/security-and-analysis-secret-scanning-enable-by-default-ghe.png) {% endif %} -3. Click **Disable FEATURE** or **Enable FEATURE** to disable or enable the feature for all the repositories in your organization. +4. Click **Disable FEATURE** or **Enable FEATURE** to disable or enable the feature for all the repositories in your organization. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} ![Button to disable or enable feature](/assets/images/help/organizations/security-and-analysis-enable-dependency-graph.png) - {% else if enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.22" %} + {% endif %} + {% if enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.22" %} ![Button to disable or enable feature](/assets/images/help/organizations/security-and-analysis-enable-secret-scanning-ghe.png) {% endif %} + {% endif %} + {% if currentVersion == "github-ae@latest" %} +3. Click **Enable for all eligible repositories** to enable the feature for all the new repositories in your organization that will have {% data variables.product.prodname_advanced_security %} enabled. + ![Button to enable feature for all the eligible repositories in the organization](/assets/images/enterprise/github-ae/organizations/security-and-analysis-enable-secret-scanning-existing-repos-ghae.png) + {% endif %} + + {% data reusables.security.displayed-information %} ### Enabling or disabling a feature automatically when new repositories are added 1. Go to the security and analysis settings for your organization. For more information, see "[Displaying the security and analysis settings](#displaying-the-security-and-analysis-settings)." -1. Under "Configure security and analysis features", to the right of the feature, enable or disable the feature by default for new repositories{% if currentVersion == "free-pro-team@latest" %}, or all new private repositories,{% endif %} in your organization. +2. Under "Configure security and analysis features", to the right of the feature, enable or disable the feature by default for new repositories{% if currentVersion == "free-pro-team@latest" %}, or all new private repositories,{% endif %} in your organization. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} ![Checkbox for enabling or disabling a feature for new repositories](/assets/images/help/organizations/security-and-analysis-enable-or-disable-feature-checkbox-dotcom.png) - {% else if enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.22" %} + {% endif %} + {% if enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.22" %} ![Checkbox for enabling or disabling a feature for new repositories](/assets/images/help/organizations/security-and-analysis-enable-or-disable-secret-scanning-checkbox-ghe.png) {% endif %} - - {% data reusables.advanced-security.note-org-enable-uses-seats %} + {% if currentVersion == "github-ae@latest" %} + ![Checkbox for enabling or disabling a feature for new repositories](/assets/images/enterprise/github-ae/organizations/security-and-analysis-enable-or-disable-secret-scanning-checkbox-ghae.png) + {% endif %} {% if currentVersion == "free-pro-team@latest" %} -### Allowing Dependabot to access private repositories +### Allowing {% data variables.product.prodname_dependabot %} to access private dependencies {% data reusables.dependabot.beta-note %} -{% data variables.product.prodname_dependabot %} can check for outdated dependency references in a project and automatically generate a pull request to update them. To do this, {% data variables.product.prodname_dependabot %} must have access to all of the targeted dependency files. Typically, version updates will fail if one or more dependencies are inaccessible. +{% data variables.product.prodname_dependabot %} can check for outdated dependency references in a project and automatically generate a pull request to update them. To do this, {% data variables.product.prodname_dependabot %} must have access to all of the targeted dependency files. Typically, version updates will fail if one or more dependencies are inaccessible. For more information, see "[About {% data variables.product.prodname_dependabot %} version updates](/github/administering-a-repository/about-dependabot-version-updates)." -By default, {% data variables.product.prodname_dependabot %} can't update dependencies that are located in private repositories. However, if a dependency is in a private {% data variables.product.prodname_dotcom %} repository within the same organization as the project that uses that dependency, you can allow {% data variables.product.prodname_dependabot %} to update the version successfully by giving it access to the host repository. For more information, including details of limitations to private dependency support, see "[About Dependabot version updates](/github/administering-a-repository/about-dependabot-version-updates)." +By default, {% data variables.product.prodname_dependabot %} can't update dependencies that are located in private repositories or private package registries. However, if a dependency is in a private {% data variables.product.prodname_dotcom %} repository within the same organization as the project that uses that dependency, you can allow {% data variables.product.prodname_dependabot %} to update the version successfully by giving it access to the host repository. + +If your code depends on packages in a private registry, you can allow {% data variables.product.prodname_dependabot %} to update the versions of these dependencies by configuring this at the repository level. You do this by adding authentication details to the _dependabot.yml_ file for the repository. For more information, see "[Configuration options for dependency updates](/github/administering-a-repository/configuration-options-for-dependency-updates#configuration-options-for-private-registries)." + +To allow {% data variables.product.prodname_dependabot %} to access a private {% data variables.product.prodname_dotcom %} repository: 1. Go to the security and analysis settings for your organization. For more information, see "[Displaying the security and analysis settings](#displaying-the-security-and-analysis-settings)." -1. In the "{% data variables.product.prodname_dependabot %} repository access" section, click the settings button **{% octicon "gear" aria-label="The Gear icon" %}**. - ![Repository access setting button](/assets/images/help/organizations/repository-access-cog-button.png) - A list is displayed showing all of the private repositories in your organization. - ![The Repositories list](/assets/images/help/organizations/repositories-dialog.png) -1. Select the repositories that {% data variables.product.prodname_dependabot %} can access. -1. Click **Select repositories**. +1. Under "{% data variables.product.prodname_dependabot %} private repository access", click **Add private repositories** or **Add internal and private repositories**. + ![Add repositories button](/assets/images/help/organizations/dependabot-private-repository-access.png) +1. Start typing the name of the repository you want to allow. + ![Add repositories button](/assets/images/help/organizations/dependabot-private-repo-choose.png) +1. Click the repository you want to allow. + +1. Optionally, to remove a repository from the list, to the right of the repository, click {% octicon "x" aria-label="The X icon" %}. + !["X" button to remove a repository](/assets/images/help/organizations/dependabot-private-repository-list.png) {% endif %} {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} ### Removing access to {% data variables.product.prodname_GH_advanced_security %} from individual repositories in an organization -You can manage the use of {% data variables.product.prodname_GH_advanced_security %} for a repository using the "Security & analysis" page, on the "Settings" tab. You can also disable the use of {% data variables.product.prodname_GH_advanced_security %} for any repository in an organization from the "Security & analysis" page of the organization. +You can manage access to {% data variables.product.prodname_GH_advanced_security %} features for a repository from its "Settings" tab. For more information, see "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)." However, you can also disable {% data variables.product.prodname_GH_advanced_security %} features for a repository from the "Settings" tab for the organization. 1. Go to the security and analysis settings for your organization. For more information, see "[Displaying the security and analysis settings](#displaying-the-security-and-analysis-settings)." 1. To see a list of all the repositories in your organization with {% data variables.product.prodname_GH_advanced_security %} enabled, scroll to the "{% data variables.product.prodname_GH_advanced_security %} repositories" section. - ![{% data variables.product.prodname_GH_advanced_security %} repositories section](/assets/images/help/organizations/ghas-repos-list.png) - The table lists the number of unique committers for each repository. This is the number of seats you could free up on your license by removing access to {% data variables.product.prodname_GH_advanced_security %}. -1. To remove access to {% data variables.product.prodname_GH_advanced_security %} from a repository, click the adjacent {% octicon "x" aria-label="X symbol" %}. + ![{% data variables.product.prodname_GH_advanced_security %} repositories section](/assets/images/help/organizations/settings-security-analysis-ghas-repos-list.png) + The table lists the number of unique committers for each repository. This is the number of seats you could free up on your license by removing access to {% data variables.product.prodname_GH_advanced_security %}. The size of your license is shown for organization-level licenses. For more information, see "[About licensing for {% data variables.product.prodname_GH_advanced_security %}](/github/setting-up-and-managing-billing-and-payments-on-github/about-licensing-for-github-advanced-security)." +1. To remove access to {% data variables.product.prodname_GH_advanced_security %} from a repository and free up seats used by any committers that are unique to the repository, click the adjacent {% octicon "x" aria-label="X symbol" %}. 1. In the confirmation dialog, click **Remove repository** to remove access to the features of {% data variables.product.prodname_GH_advanced_security %}. {% note %} -**Note:** If you remove access to {% data variables.product.prodname_GH_advanced_security %} for a repository, you should communicate with the affected development team so that they know that the change was intended. Otherwise they may assume that the change was a mistake and re-enable access. +**Note:** If you remove access to {% data variables.product.prodname_GH_advanced_security %} for a repository, you should communicate with the affected development team so that they know that the change was intended. This ensures that they don't waste time debugging failed runs of code scanning. {% endnote %} @@ -117,6 +145,6 @@ You can manage the use of {% data variables.product.prodname_GH_advanced_securit - "[About securing your repository](/github/administering-a-repository/about-securing-your-repository)" - "[About secret scanning](/github/administering-a-repository/about-secret-scanning)"{% if currentVersion == "free-pro-team@latest" %} -- "[Keeping your dependencies updated automatically](/github/administering-a-repository/keeping-your-dependencies-updated-automatically)"{% endif %} +- "[Keeping your dependencies updated automatically](/github/administering-a-repository/keeping-your-dependencies-updated-automatically)"{% endif %}{% if currentVersion != "github-ae@latest" %} - "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph)" -- "[Managing vulnerabilities in your project's dependencies](/github/managing-security-vulnerabilities/managing-vulnerabilities-in-your-projects-dependencies)" +- "[Managing vulnerabilities in your project's dependencies](/github/managing-security-vulnerabilities/managing-vulnerabilities-in-your-projects-dependencies)"{% endif %} diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-team-access-to-an-organization-project-board.md b/content/github/setting-up-and-managing-organizations-and-teams/managing-team-access-to-an-organization-project-board.md index d6800f9749..c1659ebf20 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/managing-team-access-to-an-organization-project-board.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/managing-team-access-to-an-organization-project-board.md @@ -7,6 +7,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - organizations + - teams --- {% warning %} diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-team-access-to-an-organization-repository.md b/content/github/setting-up-and-managing-organizations-and-teams/managing-team-access-to-an-organization-repository.md index 54c73b2ab5..dca7e05e67 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/managing-team-access-to-an-organization-repository.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/managing-team-access-to-an-organization-repository.md @@ -8,6 +8,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - organizations + - teams --- People with admin access to a repository can manage team access to the repository. Team maintainers can remove a team's access to a repository. diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-team-synchronization-for-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/managing-team-synchronization-for-your-organization.md index 9688d5223d..afbdb5dfe0 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/managing-team-synchronization-for-your-organization.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/managing-team-synchronization-for-your-organization.md @@ -10,6 +10,9 @@ permissions: Organization owners can manage team synchronization for an organiza miniTocMaxHeadingLevel: 4 versions: free-pro-team: '*' +topics: + - organizations + - teams --- {% data reusables.gated-features.okta-team-sync %} diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-the-default-branch-name-for-repositories-in-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/managing-the-default-branch-name-for-repositories-in-your-organization.md index 97b52e84e9..d0c412bd38 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/managing-the-default-branch-name-for-repositories-in-your-organization.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/managing-the-default-branch-name-for-repositories-in-your-organization.md @@ -6,6 +6,9 @@ versions: free-pro-team: '*' enterprise-server: '>=2.23' github-ae: '*' +topics: + - organizations + - teams --- ### About management of the default branch name diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-the-display-of-member-names-in-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/managing-the-display-of-member-names-in-your-organization.md index aadb68e9f9..2ea1724010 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/managing-the-display-of-member-names-in-your-organization.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/managing-the-display-of-member-names-in-your-organization.md @@ -8,6 +8,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - organizations + - teams --- Organization owners can manage the display of member names in an organization. diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-the-forking-policy-for-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/managing-the-forking-policy-for-your-organization.md index 1a56221145..d0c4ef8fe6 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/managing-the-forking-policy-for-your-organization.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/managing-the-forking-policy-for-your-organization.md @@ -9,6 +9,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - organizations + - teams --- By default, new organizations are configured to disallow the forking of private{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" or currentVersion == "github-ae@latest" %} and internal{% endif %} repositories. diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-the-publication-of-github-pages-sites-for-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/managing-the-publication-of-github-pages-sites-for-your-organization.md index e1a0fc2666..77d90558d2 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/managing-the-publication-of-github-pages-sites-for-your-organization.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/managing-the-publication-of-github-pages-sites-for-your-organization.md @@ -6,9 +6,12 @@ product: '{% data reusables.gated-features.pages %}' versions: free-pro-team: '*' enterprise-server: '>=3.0' + github-ae: '*' redirect_from: - /github/setting-up-and-managing-organizations-and-teams/disabling-publication-of-github-pages-sites-for-your-organization - +topics: + - organizations + - teams --- {% if currentVersion == "free-pro-team@latest" %} diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-updates-from-accounts-your-organization-sponsors.md b/content/github/setting-up-and-managing-organizations-and-teams/managing-updates-from-accounts-your-organization-sponsors.md index f60a664644..d849f0d8b8 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/managing-updates-from-accounts-your-organization-sponsors.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/managing-updates-from-accounts-your-organization-sponsors.md @@ -4,6 +4,9 @@ intro: You can manage the email address that receives updates from accounts your versions: free-pro-team: '*' permissions: Organization owners can manage updates from accounts the organization sponsors. +topics: + - organizations + - teams --- {% data reusables.sponsors.org-sponsors-release-phase %} @@ -22,4 +25,4 @@ You can also disable updates from accounts your organization sponsors. For more ### Further reading -- "[Supporting the open source community with {% data variables.product.prodname_sponsors %}](/github/supporting-the-open-source-community-with-github-sponsors)" \ No newline at end of file +- "[Supporting the open source community with {% data variables.product.prodname_sponsors %}](/github/supporting-the-open-source-community-with-github-sponsors)" diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-your-organizations-ssh-certificate-authorities.md b/content/github/setting-up-and-managing-organizations-and-teams/managing-your-organizations-ssh-certificate-authorities.md index 9a2b443b69..1d363a5cc7 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/managing-your-organizations-ssh-certificate-authorities.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/managing-your-organizations-ssh-certificate-authorities.md @@ -8,6 +8,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - organizations + - teams --- Organization owners can manage an organization's SSH certificate authorities (CA). diff --git a/content/github/setting-up-and-managing-organizations-and-teams/migrating-admin-teams-to-improved-organization-permissions.md b/content/github/setting-up-and-managing-organizations-and-teams/migrating-admin-teams-to-improved-organization-permissions.md index 3a9dfef8fd..47a3e880a4 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/migrating-admin-teams-to-improved-organization-permissions.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/migrating-admin-teams-to-improved-organization-permissions.md @@ -7,6 +7,9 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '*' +topics: + - organizations + - teams --- By default, all organization members can create repositories. If you restrict [repository creation permissions](/articles/restricting-repository-creation-in-your-organization) to organization owners, and your organization was created under the legacy organization permissions structure, members of legacy admin teams will still be able to create repositories. diff --git a/content/github/setting-up-and-managing-organizations-and-teams/migrating-to-improved-organization-permissions.md b/content/github/setting-up-and-managing-organizations-and-teams/migrating-to-improved-organization-permissions.md index 7941a9989c..ccaaf3494e 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/migrating-to-improved-organization-permissions.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/migrating-to-improved-organization-permissions.md @@ -10,5 +10,8 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '*' +topics: + - organizations + - teams --- diff --git a/content/github/setting-up-and-managing-organizations-and-teams/moving-a-team-in-your-organizations-hierarchy.md b/content/github/setting-up-and-managing-organizations-and-teams/moving-a-team-in-your-organizations-hierarchy.md index 5229466db2..7ffab5946c 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/moving-a-team-in-your-organizations-hierarchy.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/moving-a-team-in-your-organizations-hierarchy.md @@ -9,6 +9,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - organizations + - teams --- Organization owners can change the parent of any team. Team maintainers can change a team's parent if they are maintainers in both the child team and the parent team. Team maintainers without maintainer permissions in the child team can request to add a parent or child team. For more information, see "[Requesting to add or change a parent team](/articles/requesting-to-add-or-change-a-parent-team)" and "[Requesting to add a child team](/articles/requesting-to-add-a-child-team)." diff --git a/content/github/setting-up-and-managing-organizations-and-teams/organizing-members-into-teams.md b/content/github/setting-up-and-managing-organizations-and-teams/organizing-members-into-teams.md index fc2ca3c1f7..b820de8bd8 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/organizing-members-into-teams.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/organizing-members-into-teams.md @@ -16,5 +16,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - organizations + - teams --- diff --git a/content/github/setting-up-and-managing-organizations-and-teams/permission-levels-for-an-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/permission-levels-for-an-organization.md index 0b69ba8926..8aa3341d1b 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/permission-levels-for-an-organization.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/permission-levels-for-an-organization.md @@ -8,6 +8,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - organizations + - teams --- ### Permission levels for an organization @@ -49,8 +52,8 @@ Organization members can have *owner*{% if currentVersion == "free-pro-team@late | @mention any visible team | **X** | **X** | | | Can be made a *team maintainer* | **X** | **X** | | | View organization insights (see "[Viewing insights for your organization](/articles/viewing-insights-for-your-organization)" for details) | **X** | **X** | | -| View and post public team discussions to **all teams** (see "[About team discussions](/articles/about-team-discussions)" for details) | **X** | **X** | | -| View and post private team discussions to **all teams** (see "[About team discussions](/articles/about-team-discussions)" for details) | **X** | | | +| View and post public team discussions to **all teams** (see "[About team discussions](/github/setting-up-and-managing-organizations-and-teams/about-team-discussions)" for details) | **X** | **X** | | +| View and post private team discussions to **all teams** (see "[About team discussions](/github/setting-up-and-managing-organizations-and-teams/about-team-discussions)" for details) | **X** | | | | Edit and delete team discussions in **all teams** (see "[Managing disruptive comments](/articles/managing-disruptive-comments)" for details) | **X** | | | | Hide comments on commits, pull requests, and issues (see "[Managing disruptive comments](/articles/managing-disruptive-comments/#hiding-a-comment)" for details) | **X** | **X** | | | Disable team discussions for an organization (see "[Disabling team discussions for your organization](/articles/disabling-team-discussions-for-your-organization)" for details) | **X** | | | @@ -103,8 +106,8 @@ Organization members can have *owner*{% if currentVersion == "free-pro-team@late | Transfer repositories | **X** | | | Manage an organization's SSH certificate authorities (see "[Managing your organization's SSH certificate authorities](/articles/managing-your-organizations-ssh-certificate-authorities)" for details) | **X** | | | Create project boards (see "[Project board permissions for an organization](/articles/project-board-permissions-for-an-organization)" for details) | **X** | **X** | | -| View and post public team discussions to **all teams** (see "[About team discussions](/articles/about-team-discussions)" for details) | **X** | **X** | | -| View and post private team discussions to **all teams** (see "[About team discussions](/articles/about-team-discussions)" for details) | **X** | | | +| View and post public team discussions to **all teams** (see "[About team discussions](/github/setting-up-and-managing-organizations-and-teams/about-team-discussions)" for details) | **X** | **X** | | +| View and post private team discussions to **all teams** (see "[About team discussions](/github/setting-up-and-managing-organizations-and-teams/about-team-discussions)" for details) | **X** | | | | Edit and delete team discussions in **all teams** (for more information, see "[Managing disruptive comments](/articles/managing-disruptive-comments)) | **X** | | | | Hide comments on commits, pull requests, and issues (see "[Managing disruptive comments](/articles/managing-disruptive-comments/#hiding-a-comment)" for details) | **X** | **X** | **X** | | Disable team discussions for an organization (see "[Disabling team discussions for your organization](/articles/disabling-team-discussions-for-your-organization)" for details) | **X** | | | @@ -116,6 +119,7 @@ Organization members can have *owner*{% if currentVersion == "free-pro-team@late | [View people with access to an organization repository](/articles/viewing-people-with-access-to-your-repository) | **X** | | | [Export a list of people with access to an organization repository](/articles/viewing-people-with-access-to-your-repository/#exporting-a-list-of-people-with-access-to-your-repository) | **X** | |{% if currentVersion ver_gt "enterprise-server@2.19" or currentVersion == "github-ae@latest" %} | Manage default labels (see "[Managing default labels for repositories in your organization](/articles/managing-default-labels-for-repositories-in-your-organization)") | **X** | |{% endif %} +{% if currentVersion == "github-ae@latest" %}| Manage IP allow lists (see "[Restricting network traffic to your enterprise](/admin/configuration/restricting-network-traffic-to-your-enterprise)") | **X** | |{% endif %} {% endif %} @@ -130,7 +134,7 @@ When you designate a user as a {% data variables.product.prodname_github_app %} ### Outside collaborators -To keep your organization data secure while allowing access to repositories, you can add *outside collaborators*. {% data reusables.organizations.outside_collaborators_description %} +To keep your organization's data secure while allowing access to repositories, you can add *outside collaborators*. {% data reusables.organizations.outside_collaborators_description %} ### Further reading diff --git a/content/github/building-a-strong-community/pinning-a-team-discussion.md b/content/github/setting-up-and-managing-organizations-and-teams/pinning-a-team-discussion.md similarity index 62% rename from content/github/building-a-strong-community/pinning-a-team-discussion.md rename to content/github/setting-up-and-managing-organizations-and-teams/pinning-a-team-discussion.md index 77726b1399..42459e82a6 100644 --- a/content/github/building-a-strong-community/pinning-a-team-discussion.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/pinning-a-team-discussion.md @@ -3,10 +3,13 @@ title: Pinning a team discussion intro: 'You can pin important discussions to your organization''s team pages for easy reference, and unpin discussions that are no longer relevant.' redirect_from: - /articles/pinning-a-team-discussion + - /github/building-a-strong-community/pinning-a-team-discussion versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - community --- {% data reusables.profile.access_profile %} @@ -18,6 +21,6 @@ versions: ### Further reading - - "[About team discussions](/articles/about-team-discussions)" - - "[Creating a team discussion](/articles/creating-a-team-discussion)" - - "[Editing or deleting a team discussion](/articles/editing-or-deleting-a-team-discussion)" + - "[About team discussions](/github/setting-up-and-managing-organizations-and-teams/about-team-discussions)" + - "[Creating a team discussion](/github/setting-up-and-managing-organizations-and-teams/creating-a-team-discussion)" + - "[Editing or deleting a team discussion](/github/setting-up-and-managing-organizations-and-teams/editing-or-deleting-a-team-discussion)" diff --git a/content/github/setting-up-and-managing-organizations-and-teams/preparing-to-enforce-saml-single-sign-on-in-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/preparing-to-enforce-saml-single-sign-on-in-your-organization.md index 8302c07367..c94b189833 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/preparing-to-enforce-saml-single-sign-on-in-your-organization.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/preparing-to-enforce-saml-single-sign-on-in-your-organization.md @@ -6,6 +6,9 @@ redirect_from: - /articles/preparing-to-enforce-saml-single-sign-on-in-your-organization versions: free-pro-team: '*' +topics: + - organizations + - teams --- When you [enforce SAML single sign-on](/articles/enabling-and-testing-saml-single-sign-on-for-your-organization) in your organization, members that haven't authenticated via your identity provider (IdP) will be removed from the organization and will receive an email notifying them about the removal. diff --git a/content/github/setting-up-and-managing-organizations-and-teams/preparing-to-require-two-factor-authentication-in-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/preparing-to-require-two-factor-authentication-in-your-organization.md index 4faf9c6798..8c14803057 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/preparing-to-require-two-factor-authentication-in-your-organization.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/preparing-to-require-two-factor-authentication-in-your-organization.md @@ -6,6 +6,9 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '*' +topics: + - organizations + - teams --- We recommend that you notify {% if currentVersion == "free-pro-team@latest" %}organization members, outside collaborators, and billing managers{% else %}organization members and outside collaborators{% endif %} at least one week before you require 2FA in your organization. diff --git a/content/github/setting-up-and-managing-organizations-and-teams/project-board-permissions-for-an-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/project-board-permissions-for-an-organization.md index 21d3103029..c774786ca2 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/project-board-permissions-for-an-organization.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/project-board-permissions-for-an-organization.md @@ -7,6 +7,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - organizations + - teams --- ### Permissions overview diff --git a/content/github/setting-up-and-managing-organizations-and-teams/reinstating-a-former-member-of-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/reinstating-a-former-member-of-your-organization.md index 7a8d714fa5..5df6e4477f 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/reinstating-a-former-member-of-your-organization.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/reinstating-a-former-member-of-your-organization.md @@ -7,7 +7,10 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' -permissions: 'Organization owners can reinstate a former member of an organization.' +permissions: Organization owners can reinstate a former member of an organization. +topics: + - organizations + - teams --- ### About member reinstatement diff --git a/content/github/setting-up-and-managing-organizations-and-teams/reinstating-a-former-outside-collaborators-access-to-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/reinstating-a-former-outside-collaborators-access-to-your-organization.md index 3608669ae5..042cca36ba 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/reinstating-a-former-outside-collaborators-access-to-your-organization.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/reinstating-a-former-outside-collaborators-access-to-your-organization.md @@ -1,6 +1,6 @@ --- title: Reinstating a former outside collaborator's access to your organization -intro: "You can reinstate a former outside collaborator's access permissions for organization repositories, forks, and settings." +intro: 'You can reinstate a former outside collaborator''s access permissions for organization repositories, forks, and settings.' redirect_from: - /articles/reinstating-a-former-outside-collaborator-s-access-to-your-organization - /articles/reinstating-a-former-outside-collaborators-access-to-your-organization @@ -8,6 +8,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - organizations + - teams --- When an outside collaborator's access to your organization's private repositories is removed, the user's access privileges and settings are saved for three months. You can restore the user's privileges if you {% if currentVersion == "free-pro-team@latest" %}invite{% else %}add{% endif %} them back to the organization within that time frame. diff --git a/content/github/setting-up-and-managing-organizations-and-teams/removing-a-billing-manager-from-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/removing-a-billing-manager-from-your-organization.md index 16b4fb64bb..cc855248da 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/removing-a-billing-manager-from-your-organization.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/removing-a-billing-manager-from-your-organization.md @@ -5,6 +5,10 @@ redirect_from: - /articles/removing-a-billing-manager-from-your-organization versions: free-pro-team: '*' +topics: + - organizations + - teams + - billing --- {% warning %} diff --git a/content/github/setting-up-and-managing-organizations-and-teams/removing-a-member-from-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/removing-a-member-from-your-organization.md index 69be72a9b5..27a9d304b2 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/removing-a-member-from-your-organization.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/removing-a-member-from-your-organization.md @@ -7,6 +7,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - organizations + - teams --- Only organization owners can remove members from an organization. diff --git a/content/github/setting-up-and-managing-organizations-and-teams/removing-an-outside-collaborator-from-an-organization-project-board.md b/content/github/setting-up-and-managing-organizations-and-teams/removing-an-outside-collaborator-from-an-organization-project-board.md index 545cc8145f..8dfd92496e 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/removing-an-outside-collaborator-from-an-organization-project-board.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/removing-an-outside-collaborator-from-an-organization-project-board.md @@ -7,6 +7,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - organizations + - teams --- {% data reusables.profile.access_profile %} diff --git a/content/github/setting-up-and-managing-organizations-and-teams/removing-an-outside-collaborator-from-an-organization-repository.md b/content/github/setting-up-and-managing-organizations-and-teams/removing-an-outside-collaborator-from-an-organization-repository.md index d46382fc55..434d773e95 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/removing-an-outside-collaborator-from-an-organization-repository.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/removing-an-outside-collaborator-from-an-organization-repository.md @@ -7,6 +7,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - organizations + - teams --- {% if currentVersion == "free-pro-team@latest" %} diff --git a/content/github/setting-up-and-managing-organizations-and-teams/removing-github-app-managers-from-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/removing-github-app-managers-from-your-organization.md index 832ccf3cf5..a5f65d7e72 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/removing-github-app-managers-from-your-organization.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/removing-github-app-managers-from-your-organization.md @@ -7,6 +7,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - organizations + - teams --- For more information about {% data variables.product.prodname_github_app %} manager permissions, see "[Permission levels for an organization](/articles/permission-levels-for-an-organization#github-app-managers)." diff --git a/content/github/setting-up-and-managing-organizations-and-teams/removing-organization-members-from-a-team.md b/content/github/setting-up-and-managing-organizations-and-teams/removing-organization-members-from-a-team.md index 87ec11f1c2..5407d12da3 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/removing-organization-members-from-a-team.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/removing-organization-members-from-a-team.md @@ -8,6 +8,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - organizations + - teams --- {% data reusables.repositories.deleted_forks_from_private_repositories_warning %} diff --git a/content/github/setting-up-and-managing-organizations-and-teams/renaming-a-team.md b/content/github/setting-up-and-managing-organizations-and-teams/renaming-a-team.md index 8df6601909..333b94a9dc 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/renaming-a-team.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/renaming-a-team.md @@ -7,6 +7,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - organizations + - teams --- {% data reusables.profile.access_profile %} diff --git a/content/github/setting-up-and-managing-organizations-and-teams/renaming-an-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/renaming-an-organization.md index a0f04df3b9..05a0ab0685 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/renaming-an-organization.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/renaming-an-organization.md @@ -8,6 +8,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - organizations + - teams --- {% tip %} diff --git a/content/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization.md index a4c6c09b13..8c7fc9d07f 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization.md @@ -9,6 +9,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - organizations + - teams --- People with admin permissions can manage individual and team access to an organization-owned repository. @@ -68,7 +71,7 @@ In addition to managing organization-level settings, organization owners have ad | [Report abusive or spammy content](/articles/reporting-abuse-or-spam) | **X** | **X** | **X** | **X** | **X** |{% endif %} | Apply/dismiss labels | | **X** | **X** | **X** | **X** | | Create, edit, delete labels | | | **X** | **X** | **X** | -| Close, reopen, and assign all issues and pull requests | | **X** | **X** | **X** | **X** |{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} +| Close, reopen, and assign all issues and pull requests | | **X** | **X** | **X** | **X** |{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@3.0" %} | [Enable and disable auto-merge on a pull request](/github/administering-a-repository/managing-auto-merge-for-pull-requests-in-your-repository) | | | **X** | **X** | **X** |{% endif %} | Apply milestones | | **X** | **X** | **X** | **X** | | Mark [duplicate issues and pull requests](/articles/about-duplicate-issues-and-pull-requests)| | **X** | **X** | **X** | **X** | @@ -87,10 +90,10 @@ In addition to managing organization-level settings, organization owners have ad | Create, edit, run, re-run, and cancel [GitHub Actions workflows](/actions/automating-your-workflow-with-github-actions/) | | | **X** | **X** | **X** |{% endif %} | Create and edit releases | | | **X** | **X** | **X** | | View draft releases | | | **X** | **X** | **X** | -| Edit a repository's description | | | | **X** | **X** |{% if currentVersion == "free-pro-team@latest" %} +| Edit a repository's description | | | | **X** | **X** |{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" %} | [View and install packages](/packages/publishing-and-managing-packages) | **X** | **X** | **X** | **X** | **X** | | [Publish packages](/packages/publishing-and-managing-packages/publishing-a-package) | | | **X** | **X** | **X** | -| [Delete packages](/packages/learn-github-packages/deleting-and-restoring-a-package) | | | | | **X** | {% endif %} +| {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}[Delete and restore packages](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif currentVersion ver_lt "enterprise-server@3.1" or currentVersion == "github-ae@latest" %}[Delete packages](/packages/learn-github-packages/deleting-a-package){% endif %} | | | | | **X** | {% endif %} | Manage [topics](/articles/classifying-your-repository-with-topics) | | | | **X** | **X** | | Enable wikis and restrict wiki editors | | | | **X** | **X** | | Enable project boards | | | | **X** | **X** | @@ -130,25 +133,31 @@ In addition to managing organization-level settings, organization owners have ad | [Create new discussions and comment on existing discussions](/discussions/collaborating-with-your-community-using-discussions/participating-in-a-discussion) | **X** | **X** | **X** | **X** | **X** | | [Delete a discussion](/discussions/managing-discussions-for-your-community/managing-discussions-in-your-repository#deleting-a-discussion) | | | | **X** | **X** |{% endif %} -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %} #### Permission requirements for security features -In this section, you can find the repository permission levels required for security features, such as {% data variables.product.prodname_dependabot %} and {% data variables.product.prodname_advanced_security %} features. +In this section, you can find the repository permission levels required for security features, such as {% data variables.product.prodname_advanced_security %} features. | Repository action | Read | Triage | Write | Maintain | Admin | |:---|:---:|:---:|:---:|:---:|:---:|{% if currentVersion == "free-pro-team@latest" %} | Receive [{% data variables.product.prodname_dependabot_alerts %} for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies) in a repository | | | | | **X** | | [Dismiss {% data variables.product.prodname_dependabot_alerts %}](/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository) | | | | | **X** | | [Designate additional people or teams to receive {% data variables.product.prodname_dependabot_alerts %}](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts) for vulnerable dependencies | | | | | **X** | -| Create [security advisories](/github/managing-security-vulnerabilities/about-github-security-advisories) | | | | | **X** |{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} +| Create [security advisories](/github/managing-security-vulnerabilities/about-github-security-advisories) | | | | | **X** |{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} | Manage access to {% data variables.product.prodname_GH_advanced_security %} features (see "[Managing security and analysis settings for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization)") | | | | | **X** |{% endif %}{% if currentVersion == "free-pro-team@latest" %} | [Enable the dependency graph](/github/visualizing-repository-data-with-graphs/exploring-the-dependencies-and-dependents-of-a-repository) for a private repository | | | | | **X** | -| [View dependency reviews](/github/collaborating-with-issues-and-pull-requests/reviewing-dependency-changes-in-a-pull-request) | **X** | **X** | **X** | **X** | **X** |{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %} +| [View dependency reviews](/github/collaborating-with-issues-and-pull-requests/reviewing-dependency-changes-in-a-pull-request) | **X** | **X** | **X** | **X** | **X** |{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %} | [View {% data variables.product.prodname_code_scanning %} alerts on pull requests](/github/finding-security-vulnerabilities-and-errors-in-your-code/triaging-code-scanning-alerts-in-pull-requests) | **X** | **X** | **X** | **X** | **X** | -| [List, dismiss, and delete {% data variables.product.prodname_code_scanning %} alerts](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository) | | | **X** | **X** | **X** |{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} +| [List, dismiss, and delete {% data variables.product.prodname_code_scanning %} alerts](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository) | | | **X** | **X** | **X** |{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == 'github-ae@next' %} +| [View {% data variables.product.prodname_secret_scanning %} alerts in a repository](/github/administering-a-repository/managing-alerts-from-secret-scanning) | | | **X**[1] | **X**[1] | **X** | +| [Resolve, revoke, or re-open {% data variables.product.prodname_secret_scanning %} alerts](/github/administering-a-repository/managing-alerts-from-secret-scanning) | | | **X**[1] | **X**[1] | **X** |{% endif %}{% if currentVersion == "enterprise-server@3.0" %} | [View {% data variables.product.prodname_secret_scanning %} alerts in a repository](/github/administering-a-repository/managing-alerts-from-secret-scanning) | | | | | **X** | -| [Resolve, revoke or re-open {% data variables.product.prodname_secret_scanning %} alerts](/github/administering-a-repository/managing-alerts-from-secret-scanning) | | | | | **X** | +| [Resolve, revoke, or re-open {% data variables.product.prodname_secret_scanning %} alerts](/github/administering-a-repository/managing-alerts-from-secret-scanning) | | | | | **X** |{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} | [Designate additional people or teams to receive {% data variables.product.prodname_secret_scanning %} alerts](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts) in repositories | | | | | **X** |{% endif %} + +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == 'github-ae@next' %} +[1] Repository writers and maintainers can only see alert information for their own commits. +{% endif %} {% endif %} ### Further reading diff --git a/content/github/setting-up-and-managing-organizations-and-teams/requesting-to-add-a-child-team.md b/content/github/setting-up-and-managing-organizations-and-teams/requesting-to-add-a-child-team.md index 82391df281..26a741bfc4 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/requesting-to-add-a-child-team.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/requesting-to-add-a-child-team.md @@ -7,6 +7,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - organizations + - teams --- When you request to add a team as a child, a request is sent to the maintainers of the child team. Once a maintainer of the child team approves your request, the child team is nested under the parent team in your organization's hierarchy. diff --git a/content/github/setting-up-and-managing-organizations-and-teams/requesting-to-add-or-change-a-parent-team.md b/content/github/setting-up-and-managing-organizations-and-teams/requesting-to-add-or-change-a-parent-team.md index 2f295775c4..df965d01f5 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/requesting-to-add-or-change-a-parent-team.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/requesting-to-add-or-change-a-parent-team.md @@ -7,6 +7,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - organizations + - teams --- When you request to add or change your team's parent, a request is sent to the maintainers of the parent team. When a maintainer of the new parent team approves your request, your team is nested as a child team under the parent team in your organization's hierarchy. diff --git a/content/github/setting-up-and-managing-organizations-and-teams/requiring-two-factor-authentication-in-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/requiring-two-factor-authentication-in-your-organization.md index 81fb510f8f..cb8e427fcf 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/requiring-two-factor-authentication-in-your-organization.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/requiring-two-factor-authentication-in-your-organization.md @@ -6,6 +6,9 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '*' +topics: + - organizations + - teams --- ### About two-factor authentication for organizations diff --git a/content/github/setting-up-and-managing-organizations-and-teams/restricting-access-to-your-organizations-data.md b/content/github/setting-up-and-managing-organizations-and-teams/restricting-access-to-your-organizations-data.md index a5156b07c5..e85083f736 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/restricting-access-to-your-organizations-data.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/restricting-access-to-your-organizations-data.md @@ -7,5 +7,8 @@ redirect_from: mapTopic: true versions: free-pro-team: '*' +topics: + - organizations + - teams --- diff --git a/content/github/setting-up-and-managing-organizations-and-teams/restricting-email-notifications-to-an-approved-domain.md b/content/github/setting-up-and-managing-organizations-and-teams/restricting-email-notifications-to-an-approved-domain.md index 6e0924546a..75f20036b2 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/restricting-email-notifications-to-an-approved-domain.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/restricting-email-notifications-to-an-approved-domain.md @@ -7,6 +7,9 @@ redirect_from: - /articles/restricting-email-notifications-to-an-approved-domain versions: free-pro-team: '*' +topics: + - organizations + - teams --- ### About email restrictions diff --git a/content/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization.md index 1a23b5fc5c..8c3dd0b4e0 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization.md @@ -7,6 +7,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - organizations + - teams --- You can choose whether members can create repositories in your organization. If you allow members to create repositories, you can choose which types of repositories members can create.{% if currentVersion == "free-pro-team@latest" %} To allow members to create private repositories only, your organization must use {% data variables.product.prodname_ghe_cloud %}.{% endif %} For more information, see "[About repository visibility](/github/creating-cloning-and-archiving-repositories/about-repository-visibility)." diff --git a/content/github/setting-up-and-managing-organizations-and-teams/restricting-repository-visibility-changes-in-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/restricting-repository-visibility-changes-in-your-organization.md index b2e853ee73..0e9ff0ecde 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/restricting-repository-visibility-changes-in-your-organization.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/restricting-repository-visibility-changes-in-your-organization.md @@ -7,6 +7,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - organizations + - teams --- You can restrict the ability to change repository visibility to organization owners only, or allow members with admin privileges for a repository to also change visibility. diff --git a/content/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization.md index 4cc6da0fc5..dfcc61501b 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization.md @@ -8,6 +8,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - organizations + - teams --- ### Accessing the audit log @@ -58,10 +61,10 @@ To search for specific events, use the `action` qualifier in your query. Actions | [`repo`](#repo-category-actions) | Contains activities related to the repositories owned by your organization.{% if currentVersion == "free-pro-team@latest" %} | [`repository_advisory`](#repository_advisory-category-actions) | Contains repository-level activities related to security advisories in the {% data variables.product.prodname_advisory_database %}. For more information, see "[About {% data variables.product.prodname_dotcom %} Security Advisories](/github/managing-security-vulnerabilities/about-github-security-advisories)." | [`repository_content_analysis`](#repository_content_analysis-category-actions) | Contains all activities related to [enabling or disabling data use for a private repository](/articles/about-github-s-use-of-your-data).{% endif %}{% if currentVersion != "github-ae@latest" %} -| [`repository_dependency_graph`](#repository_dependency_graph-category-actions) | Contains repository-level activities related to enabling or disabling the dependency graph for a {% if currentVersion == "free-pro-team@latest" %}private {% endif %}repository. For more information, see "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph)."{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} +| [`repository_dependency_graph`](#repository_dependency_graph-category-actions) | Contains repository-level activities related to enabling or disabling the dependency graph for a {% if currentVersion == "free-pro-team@latest" %}private {% endif %}repository. For more information, see "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph)."{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} | [`repository_secret_scanning`](#repository_secret_scanning-category-actions) | Contains repository-level activities related to secret scanning. For more information, see "[About secret scanning](/github/administering-a-repository/about-secret-scanning)." {% endif %}{% if currentVersion != "github-ae@latest" %} | [`repository_vulnerability_alert`](#repository_vulnerability_alert-category-actions) | Contains all activities related to [{% data variables.product.prodname_dependabot_alerts %} for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies).{% endif %}{% if currentVersion == "free-pro-team@latest" %} -| [`repository_vulnerability_alerts`](#repository_vulnerability_alerts-category-actions) | Contains repository-level configuration activities for {% data variables.product.prodname_dependabot %} alerts. {% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} +| [`repository_vulnerability_alerts`](#repository_vulnerability_alerts-category-actions) | Contains repository-level configuration activities for {% data variables.product.prodname_dependabot %} alerts. {% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} | [`secret_scanning`](#secret_scanning-category-actions) | Contains organization-level configuration activities for secret scanning in existing repositories. For more information, see "[About secret scanning](/github/administering-a-repository/about-secret-scanning)." | [`secret_scanning_new_repos`](#secret_scanning_new_repos-category-actions) | Contains organization-level configuration activities for secret scanning for new repositories created in the organization. {% endif %}{% if currentVersion == "free-pro-team@latest" %} | [`sponsors`](#sponsors-category-actions) | Contains all events related to sponsor buttons (see "[Displaying a sponsor button in your repository](/articles/displaying-a-sponsor-button-in-your-repository)"){% endif %} @@ -252,7 +255,17 @@ An overview of some of the most common actions that are recorded as events in th {% endif %} {% if currentVersion == "free-pro-team@latest" %} +#### `environment` category actions +| Action | Description +|------------------|------------------- +| `create_actions_secret` | Triggered when a secret is created in an environment. For more information, see ["Environment secrets](/actions/reference/environments#environment-secrets)." +| `delete` | Triggered when an environment is deleted. For more information, see ["Deleting an environment](/actions/reference/environments#deleting-an-environment)." +| `remove_actions_secret` | Triggered when a secret is removed from an environment. For more information, see ["Environment secrets](/actions/reference/environments#environment-secrets)." +| `update_actions_secret` | Triggered when a secret in an environment is updated. For more information, see ["Environment secrets](/actions/reference/environments#environment-secrets)." +{% endif %} + +{% if currentVersion == "free-pro-team@latest" %} #### `git` category actions {% note %} @@ -360,8 +373,10 @@ For more information, see "[Managing the publication of {% data variables.produc | `revoke_sso_session` | Triggered when an organization owner revokes a member's SAML session. For more information, see "[Viewing and managing a member's SAML access to your organization](/github/setting-up-and-managing-organizations-and-teams/viewing-and-managing-a-members-saml-access-to-your-organization#viewing-and-revoking-a-linked-identity)." {% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %} | `runner_group_created` | Triggered when a self-hosted runner group is created. For more information, see "[Creating a self-hosted runner group for an organization](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#creating-a-self-hosted-runner-group-for-an-organization)." | `runner_group_removed` | Triggered when a self-hosted runner group is removed. For more information, see "[Removing a self-hosted runner group](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#removing-a-self-hosted-runner-group)." +| `runner_group_updated` | Triggered when the configuration of a self-hosted runner group is changed. For more information, see "[Changing the access policy of a self-hosted runner group](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#changing-the-access-policy-of-a-self-hosted-runner-group)." | `runner_group_runners_added` | Triggered when a self-hosted runner is added to a group. For more information, see [Moving a self-hosted runner to a group](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#moving-a-self-hosted-runner-to-a-group). -| `runner_group_runner_removed` | Triggered when a self-hosted runner is removed from a group. {% endif %}{% if currentVersion == "free-pro-team@latest"%}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %} +| `runner_group_runner_removed` | Triggered when the REST API is used to remove a self-hosted runner from a group. For more information, see "[Remove a self-hosted runner from a group for an organization](/rest/reference/actions#remove-a-self-hosted-runner-from-a-group-for-an-organization)." +| `runner_group_runners_updated`| Triggered when a runner group's list of members is updated. For more information, see "[Set self-hosted runners in a group for an organization](/rest/reference/actions#set-self-hosted-runners-in-a-group-for-an-organization)."{% endif %}{% if currentVersion == "free-pro-team@latest"%}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %} | `self_hosted_runner_updated` | Triggered when the runner application is updated. Can be viewed using the REST API and the UI; not visible in the JSON/CSV export. For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners#about-self-hosted-runners)."{% endif %} | `unblock_user` | Triggered when an organization owner [unblocks a user from an organization](/articles/unblocking-a-user-from-your-organization).{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %} | `update_actions_secret` |Triggered when a {% data variables.product.prodname_actions %} secret is updated.{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} @@ -473,6 +488,7 @@ For more information, see "[Managing the publication of {% data variables.produc | Action | Description |------------------|------------------- | `access` | Triggered when a user [changes the visibility](/github/administering-a-repository/setting-repository-visibility) of a repository in the organization. +| `actions_enabled` | Triggered when {% data variables.product.prodname_actions %} is enabled for a repository. Can be viewed using the UI. This event is not included when you access the audit log using the REST API. For more information, see "[Using the REST API](#using-the-rest-api)." | `add_member` | Triggered when a user accepts an [invitation to have collaboration access to a repository](/articles/inviting-collaborators-to-a-personal-repository). | `add_topic` | Triggered when a repository admin [adds a topic](/articles/classifying-your-repository-with-topics) to a repository.{% if currentVersion == "free-pro-team@latest" %} | `advanced_security_disabled` | Triggered when a repository owner disables {% data variables.product.prodname_GH_advanced_security %}. For more information, see "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)." @@ -530,7 +546,7 @@ For more information, see "[Managing the publication of {% data variables.produc | `disable` | Triggered when a repository owner or person with admin access to the repository disables the dependency graph for a {% if currentVersion == "free-pro-team@latest" %}private {% endif %}repository. For more information, see "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph)." | `enable` | Triggered when a repository owner or person with admin access to the repository enables the dependency graph for a {% if currentVersion == "free-pro-team@latest" %}private {% endif %}repository. -{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} +{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} #### `repository_secret_scanning` category actions | Action | Description @@ -556,7 +572,7 @@ For more information, see "[Managing the publication of {% data variables.produc | `disable` | Triggered when a repository owner or person with admin access to the repository disables {% data variables.product.prodname_dependabot_alerts %}. | `enable` | Triggered when a repository owner or person with admin access to the repository enables {% data variables.product.prodname_dependabot_alerts %}. -{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} +{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} #### `secret_scanning` category actions | Action | Description @@ -616,7 +632,7 @@ For more information, see "[Managing the publication of {% data variables.produc | `disable` | Triggered when an organization owner disables team discussions for an organization. For more information, see "[Disabling team discussions for your organization](/articles/disabling-team-discussions-for-your-organization)." | `enable` | Triggered when an organization owner enables team discussions for an organization. -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest"%} #### `workflows` category actions {% data reusables.actions.actions-audit-events-workflow %} diff --git a/content/github/setting-up-and-managing-organizations-and-teams/reviewing-your-organizations-installed-integrations.md b/content/github/setting-up-and-managing-organizations-and-teams/reviewing-your-organizations-installed-integrations.md index ac62de20d3..9250fa7013 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/reviewing-your-organizations-installed-integrations.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/reviewing-your-organizations-installed-integrations.md @@ -8,6 +8,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - organizations + - teams --- {% data reusables.profile.access_profile %} diff --git a/content/github/setting-up-and-managing-organizations-and-teams/setting-base-permissions-for-an-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/setting-base-permissions-for-an-organization.md index 10d1f5c9aa..64daf7b01f 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/setting-base-permissions-for-an-organization.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/setting-base-permissions-for-an-organization.md @@ -6,6 +6,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - organizations + - teams --- ### About base permissions for an organization diff --git a/content/github/setting-up-and-managing-organizations-and-teams/setting-permissions-for-adding-outside-collaborators.md b/content/github/setting-up-and-managing-organizations-and-teams/setting-permissions-for-adding-outside-collaborators.md index e70f55bc64..118d2a24a5 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/setting-permissions-for-adding-outside-collaborators.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/setting-permissions-for-adding-outside-collaborators.md @@ -9,6 +9,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - organizations + - teams --- Organization owners, and members with admin privileges for a repository, can invite outside collaborators to work on the repository. You can also restrict outside collaborator invite permissions to only organization owners. diff --git a/content/github/setting-up-and-managing-organizations-and-teams/setting-permissions-for-deleting-or-transferring-repositories.md b/content/github/setting-up-and-managing-organizations-and-teams/setting-permissions-for-deleting-or-transferring-repositories.md index 8634dc39ec..aaa629acd2 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/setting-permissions-for-deleting-or-transferring-repositories.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/setting-permissions-for-deleting-or-transferring-repositories.md @@ -8,6 +8,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - organizations + - teams --- Owners can set permissions for deleting or transferring repositories in an organization. diff --git a/content/github/setting-up-and-managing-organizations-and-teams/setting-team-creation-permissions-in-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/setting-team-creation-permissions-in-your-organization.md index 6e9c8a7668..522a15d7f5 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/setting-team-creation-permissions-in-your-organization.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/setting-team-creation-permissions-in-your-organization.md @@ -7,6 +7,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - organizations + - teams --- Organization owners can set team creation permissions. diff --git a/content/github/setting-up-and-managing-organizations-and-teams/setting-your-teams-profile-picture.md b/content/github/setting-up-and-managing-organizations-and-teams/setting-your-teams-profile-picture.md index 2729775095..e22599de91 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/setting-your-teams-profile-picture.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/setting-your-teams-profile-picture.md @@ -8,6 +8,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - organizations + - teams --- Unless you set a profile picture for a team, the team profile picture will match the organization's profile picture. diff --git a/content/github/setting-up-and-managing-organizations-and-teams/synchronizing-a-team-with-an-identity-provider-group.md b/content/github/setting-up-and-managing-organizations-and-teams/synchronizing-a-team-with-an-identity-provider-group.md index 7e9dd3bf05..b37dc6cb95 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/synchronizing-a-team-with-an-identity-provider-group.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/synchronizing-a-team-with-an-identity-provider-group.md @@ -1,10 +1,14 @@ --- title: Synchronizing a team with an identity provider group -intro: 'You can synchronize a {% data variables.product.prodname_dotcom %} team with an identity provider (IdP) group to automatically add and remove team members.' +intro: 'You can synchronize a {% data variables.product.product_name %} team with an identity provider (IdP) group to automatically add and remove team members.' product: '{% data reusables.gated-features.team-synchronization %}' permissions: 'Organization owners and team maintainers can synchronize a {% data variables.product.prodname_dotcom %} team with an IdP group.' versions: free-pro-team: '*' + github-ae: '*' +topics: + - organizations + - teams --- {% data reusables.gated-features.okta-team-sync %} @@ -13,29 +17,36 @@ versions: {% data reusables.identity-and-permissions.about-team-sync %} -You can connect up to five IdP groups to a {% data variables.product.prodname_dotcom %} team. An IdP group can be assigned to multiple {% data variables.product.prodname_dotcom %} teams without restriction. +{% if currentVersion == "free-pro-team@latest" %}You can connect up to five IdP groups to a {% data variables.product.product_name %} team.{% elsif currentVersion == "github-ae@latest" %}You can connect a team on {% data variables.product.product_name %} to one IdP group. All users in the group are automatically added to the team and also added to the parent organization as members. When you disconnect a group from a team, users who became members of the organization via team membership are removed from the organization.{% endif %} You can assign an IdP group to multiple {% data variables.product.product_name %} teams. -Team synchronization does not support IdP groups with more than 5000 members. +{% if currentVersion == "free-pro-team@latest" %}Team synchronization does not support IdP groups with more than 5000 members.{% endif %} -Once a {% data variables.product.prodname_dotcom %} team is connected to an IdP group, your IdP administrator must make team membership changes through the identity provider. You cannot manage team membership on {% data variables.product.product_name %} or using the API. +Once a {% data variables.product.prodname_dotcom %} team is connected to an IdP group, your IdP administrator must make team membership changes through the identity provider. You cannot manage team membership on {% data variables.product.product_name %}{% if currentVersion == "free-pro-team@latest" %} or using the API{% endif %}. +{% if currentVersion == "free-pro-team@latest" %} All team membership changes made through your IdP will appear in the audit log on {% data variables.product.product_name %} as changes made by the team synchronization bot. Your IdP will send team membership data to {% data variables.product.prodname_dotcom %} once every hour. Connecting a team to an IdP group may remove some team members. For more information, see "[Requirements for members of synchronized teams](#requirements-for-members-of-synchronized-teams)." +{% endif %} + +{% if currentVersion == "github-ae@latest" %} +When group membership changes on your IdP, your IdP sends a SCIM request with the changes to {% data variables.product.product_name %} according to the schedule determined by your IdP. Any requests that change {% data variables.product.prodname_dotcom %} team or organization membership will register in the audit log as changes made by the account used to configure user provisioning. For more information about this account, see "[Configuring user provisioning for your enterprise](/admin/authentication/configuring-user-provisioning-for-your-enterprise)." For more information about SCIM request schedules, see "[Check the status of user provisioning](https://docs.microsoft.com/en-us/azure/active-directory/app-provisioning/application-provisioning-when-will-provisioning-finish-specific-user)" in the Microsoft Docs. +{% endif %} Parent teams cannot synchronize with IdP groups. If the team you want to connect to an IdP group is a parent team, we recommend creating a new team or removing the nested relationships that make your team a parent team. For more information, see "[About teams](/articles/about-teams#nested-teams)," "[Creating a team](/github/setting-up-and-managing-organizations-and-teams/creating-a-team)," and "[Moving a team in your organization's hierarchy](/articles/moving-a-team-in-your-organizations-hierarchy)." To manage repository access for any {% data variables.product.prodname_dotcom %} team, including teams connected to an IdP group, you must make changes with {% data variables.product.product_name %}. For more information, see "[About teams](/articles/about-teams)" and "[Managing team access to an organization repository](/articles/managing-team-access-to-an-organization-repository)." -You can also manage team synchronization with the API. For more information, see "[Team synchronization](/rest/reference/teams#team-sync)." +{% if currentVersion == "free-pro-team@latest" %}You can also manage team synchronization with the API. For more information, see "[Team synchronization](/rest/reference/teams#team-sync)."{% endif %} +{% if currentVersion == "free-pro-team@latest" %} ### Requirements for members of synchronized teams -After you connect a team to an IdP group, team synchronization will add each member of the IdP group to the corresponding team on {% data variables.product.prodname_dotcom %} only if: -- The person is a member of the organization on {% data variables.product.prodname_dotcom %}. -- The person has already logged in with their user account on {% data variables.product.prodname_dotcom %} and authenticated to the organization or enterprise account via SAML single sign-on at least once. +After you connect a team to an IdP group, team synchronization will add each member of the IdP group to the corresponding team on {% data variables.product.product_name %} only if: +- The person is a member of the organization on {% data variables.product.product_name %}. +- The person has already logged in with their user account on {% data variables.product.product_name %} and authenticated to the organization or enterprise account via SAML single sign-on at least once. - The person's SSO identity is a member of the IdP group. -Existing teams or group members who do not meet these criteria will be automatically removed from the team on {% data variables.product.prodname_dotcom %} and lose access to repositories. Revoking a user's linked identity will also remove the user from from any teams mapped to IdP groups. For more information, see "[Viewing and managing a member's SAML access to your organization](/github/setting-up-and-managing-organizations-and-teams/viewing-and-managing-a-members-saml-access-to-your-organization#viewing-and-revoking-a-linked-identity)" and "[Viewing and managing a user's SAML access to your enterprise](/github/setting-up-and-managing-your-enterprise/viewing-and-managing-a-users-saml-access-to-your-enterprise#viewing-and-revoking-a-linked-identity)." +Existing teams or group members who do not meet these criteria will be automatically removed from the team on {% data variables.product.product_name %} and lose access to repositories. Revoking a user's linked identity will also remove the user from from any teams mapped to IdP groups. For more information, see "[Viewing and managing a member's SAML access to your organization](/github/setting-up-and-managing-organizations-and-teams/viewing-and-managing-a-members-saml-access-to-your-organization#viewing-and-revoking-a-linked-identity)" and "[Viewing and managing a user's SAML access to your enterprise](/github/setting-up-and-managing-your-enterprise/viewing-and-managing-a-users-saml-access-to-your-enterprise#viewing-and-revoking-a-linked-identity)." A removed team member can be added back to a team automatically once they have authenticated to the organization or enterprise account using SSO and are moved to the connected IdP group. @@ -43,32 +54,49 @@ To avoid unintentionally removing team members, we recommend enforcing SAML SSO If your organization is owned by an enterprise account, enabling team synchronization for the enterprise account will override your organization-level team synchronization settings. For more information, see "[Managing team synchronization for organizations in your enterprise account](/github/setting-up-and-managing-your-enterprise/managing-team-synchronization-for-organizations-in-your-enterprise-account)." +{% endif %} + ### Prerequisites -Before you can connect a team with an identity provider group, an organization or enterprise owner must enable team synchronization for your organization or enterprise account. For more information, see "[Managing team synchronization for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-team-synchronization-for-your-organization)" and "[Managing team synchronization for organizations in your enterprise account](/github/setting-up-and-managing-your-enterprise/managing-team-synchronization-for-organizations-in-your-enterprise-account)." +{% if currentVersion == "free-pro-team@latest" %} +Before you can connect a {% data variables.product.product_name %} team with an identity provider group, an organization or enterprise owner must enable team synchronization for your organization or enterprise account. For more information, see "[Managing team synchronization for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-team-synchronization-for-your-organization)" and "[Managing team synchronization for organizations in your enterprise account](/github/setting-up-and-managing-your-enterprise/managing-team-synchronization-for-organizations-in-your-enterprise-account)." To avoid unintentionally removing team members, visit the administrative portal for your IdP and confirm that each current team member is also in the IdP groups that you want to connect to this team. If you don't have this access to your identity provider, you can reach out to your IdP administrator. You must authenticate using SAML SSO. For more information, see "[Authenticating with SAML single sign-on](/articles/authenticating-with-saml-single-sign-on)." +{% elsif currentVersion == "github-ae@latest" %} +Before you can connect a {% data variables.product.product_name %} team with an IdP group, you must first configure user provisioning for {% data variables.product.product_location %} using a supported System for Cross-domain Identity Management (SCIM). For more information, see "[Configuring user provisioning for your enterprise](/admin/authentication/configuring-user-provisioning-for-your-enterprise)." + +Once user provisioning for {% data variables.product.product_name %} is configured using SCIM, you can assign the {% data variables.product.product_name %} application to every IdP group that you want to use on {% data variables.product.product_name %}. For more information, see [Configure automatic user provisioning to GitHub AE](https://docs.microsoft.com/en-us/azure/active-directory/saas-apps/github-ae-provisioning-tutorial#step-5-configure-automatic-user-provisioning-to-github-ae) in the Microsoft Docs. +{% endif %} + ### Connecting an IdP group to a team +When you connect an IdP group to a {% data variables.product.product_name %} team, all users in the group are automatically added to the team. {% if currentVersion == "github-ae@latest" %}Any users who were not already members of the parent organization members are also added to the organization.{% endif %} + {% data reusables.profile.access_profile %} {% data reusables.profile.access_org %} {% data reusables.organizations.specific_team %} {% data reusables.organizations.team_settings %} -5. Under "Identity Provider Groups", use the drop-down menu, and select up to 5 identity provider groups. - ![Drop-down menu to choose identity provider groups](/assets/images/help/teams/choose-an-idp-group.png) -6. Click **Save changes**. +{% if currentVersion == "free-pro-team@latest" %} +6. Under "Identity Provider Groups", use the drop-down menu, and select up to 5 identity provider groups. + ![Drop-down menu to choose identity provider groups](/assets/images/help/teams/choose-an-idp-group.png){% elsif currentVersion == "github-ae@latest" %} +6. Under "Identity Provider Group", use the drop-down menu, and select an identity provider group from the list. + ![Drop-down menu to choose identity provider group](/assets/images/enterprise/github-ae/teams/choose-an-idp-group.png){% endif %} +7. Click **Save changes**. ### Disconnecting an IdP group from a team -If you disconnect an IdP group from a {% data variables.product.prodname_dotcom %} team, team members that were assigned to the {% data variables.product.prodname_dotcom %} team through the IdP group will be removed from the team. +If you disconnect an IdP group from a {% data variables.product.prodname_dotcom %} team, team members that were assigned to the {% data variables.product.prodname_dotcom %} team through the IdP group will be removed from the team. {% if currentVersion == "github-ae@latest" %} Any users who were members of the parent organization only because of that team connection are also removed from the organization.{% endif %} {% data reusables.profile.access_profile %} {% data reusables.profile.access_org %} {% data reusables.organizations.specific_team %} {% data reusables.organizations.team_settings %} +{% if currentVersion == "free-pro-team@latest" %} 6. Under "Identity Provider Groups", to the right of the IdP group you want to disconnect, click {% octicon "x" aria-label="X symbol" %}. - ![Unselect a connected IdP group from the GitHub team](/assets/images/help/teams/unselect-idp-group.png) + ![Unselect a connected IdP group from the GitHub team](/assets/images/help/teams/unselect-idp-group.png){% elsif currentVersion == "github-ae@latest" %} +6. Under "Identity Provider Group", to the right of the IdP group you want to disconnect, click {% octicon "x" aria-label="X symbol" %}. + ![Unselect a connected IdP group from the GitHub team](/assets/images/enterprise/github-ae/teams/unselect-idp-group.png){% endif %} 7. Click **Save changes**. diff --git a/content/github/setting-up-and-managing-organizations-and-teams/transferring-organization-ownership.md b/content/github/setting-up-and-managing-organizations-and-teams/transferring-organization-ownership.md index 8cb3565f91..1fc1cea562 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/transferring-organization-ownership.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/transferring-organization-ownership.md @@ -8,6 +8,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - organizations + - teams --- 1. If you're the only member with *owner* privileges, give another organization member the owner role. For more information, see "[Appointing an organization owner](/github/setting-up-and-managing-organizations-and-teams/maintaining-ownership-continuity-for-your-organization#appointing-an-organization-owner)." diff --git a/content/github/setting-up-and-managing-organizations-and-teams/upgrading-to-the-corporate-terms-of-service.md b/content/github/setting-up-and-managing-organizations-and-teams/upgrading-to-the-corporate-terms-of-service.md index 95b65b7aea..2d8302bb1d 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/upgrading-to-the-corporate-terms-of-service.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/upgrading-to-the-corporate-terms-of-service.md @@ -5,6 +5,9 @@ redirect_from: - /articles/upgrading-to-the-corporate-terms-of-service versions: free-pro-team: '*' +topics: + - organizations + - teams --- The Standard Terms of Service is an agreement between {% data variables.product.prodname_dotcom %} and you as an individual. To enter into an agreement with {% data variables.product.prodname_dotcom %} on behalf of an entity, such as a company, non-profit, or group, organization owners can upgrade to the Corporate Terms of Service. diff --git a/content/github/setting-up-and-managing-organizations-and-teams/verifying-your-organizations-domain.md b/content/github/setting-up-and-managing-organizations-and-teams/verifying-your-organizations-domain.md index db0098a2c9..2aaf181720 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/verifying-your-organizations-domain.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/verifying-your-organizations-domain.md @@ -6,6 +6,9 @@ redirect_from: - /articles/verifying-your-organizations-domain versions: free-pro-team: '*' +topics: + - organizations + - teams --- ### About domain verification diff --git a/content/github/setting-up-and-managing-organizations-and-teams/viewing-and-managing-a-members-saml-access-to-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/viewing-and-managing-a-members-saml-access-to-your-organization.md index c323c79f03..484baa617a 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/viewing-and-managing-a-members-saml-access-to-your-organization.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/viewing-and-managing-a-members-saml-access-to-your-organization.md @@ -8,6 +8,9 @@ redirect_from: - /github/setting-up-and-managing-organizations-and-teams/viewing-and-revoking-organization-members-authorized-access-tokens versions: free-pro-team: '*' +topics: + - organizations + - teams --- ### About SAML access to your organization diff --git a/content/github/setting-up-and-managing-organizations-and-teams/viewing-insights-for-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/viewing-insights-for-your-organization.md index 4e18a1b3a6..ff36847928 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/viewing-insights-for-your-organization.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/viewing-insights-for-your-organization.md @@ -6,6 +6,9 @@ redirect_from: - /articles/viewing-insights-for-your-organization versions: free-pro-team: '*' +topics: + - organizations + - teams --- All members of an organization can view organization insights. For more information, see "[Permission levels for an organization](/articles/permission-levels-for-an-organization)." diff --git a/content/github/setting-up-and-managing-organizations-and-teams/viewing-people-with-access-to-your-repository.md b/content/github/setting-up-and-managing-organizations-and-teams/viewing-people-with-access-to-your-repository.md index 9e67d74307..eda9a879d3 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/viewing-people-with-access-to-your-repository.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/viewing-people-with-access-to-your-repository.md @@ -7,6 +7,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - organizations + - teams --- Administrators can use this information to help off-board people, gather data for compliance, and other general security checkups. diff --git a/content/github/setting-up-and-managing-organizations-and-teams/viewing-whether-users-in-your-organization-have-2fa-enabled.md b/content/github/setting-up-and-managing-organizations-and-teams/viewing-whether-users-in-your-organization-have-2fa-enabled.md index dd257564d0..3b499d3b26 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/viewing-whether-users-in-your-organization-have-2fa-enabled.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/viewing-whether-users-in-your-organization-have-2fa-enabled.md @@ -6,6 +6,9 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '*' +topics: + - organizations + - teams --- {% note %} diff --git a/content/github/setting-up-and-managing-your-enterprise/about-enterprise-accounts.md b/content/github/setting-up-and-managing-your-enterprise/about-enterprise-accounts.md index 3322d7a400..1135c38618 100644 --- a/content/github/setting-up-and-managing-your-enterprise/about-enterprise-accounts.md +++ b/content/github/setting-up-and-managing-your-enterprise/about-enterprise-accounts.md @@ -9,6 +9,8 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '*' +topics: + - enterprise --- ### About enterprise accounts diff --git a/content/github/setting-up-and-managing-your-enterprise/about-identity-and-access-management-for-your-enterprise-account.md b/content/github/setting-up-and-managing-your-enterprise/about-identity-and-access-management-for-your-enterprise-account.md index 056c663408..92325c05be 100644 --- a/content/github/setting-up-and-managing-your-enterprise/about-identity-and-access-management-for-your-enterprise-account.md +++ b/content/github/setting-up-and-managing-your-enterprise/about-identity-and-access-management-for-your-enterprise-account.md @@ -1,9 +1,11 @@ --- title: About identity and access management for your enterprise account -intro: You can centrally manage access to your enterprise's resources, organization membership, and team membership using your identity provider (IdP). +intro: 'You can centrally manage access to your enterprise''s resources, organization membership, and team membership using your identity provider (IdP).' product: '{% data reusables.gated-features.enterprise-accounts %}' versions: free-pro-team: '*' +topics: + - enterprise --- ### About identity and access management for your enterprise account diff --git a/content/github/setting-up-and-managing-your-enterprise/about-user-provisioning-for-organizations-in-your-enterprise-account.md b/content/github/setting-up-and-managing-your-enterprise/about-user-provisioning-for-organizations-in-your-enterprise-account.md index 9ffac5db1a..f98b9981a5 100644 --- a/content/github/setting-up-and-managing-your-enterprise/about-user-provisioning-for-organizations-in-your-enterprise-account.md +++ b/content/github/setting-up-and-managing-your-enterprise/about-user-provisioning-for-organizations-in-your-enterprise-account.md @@ -4,6 +4,8 @@ intro: You can manage organization membership in an enterprise account directly product: '{% data reusables.gated-features.enterprise-accounts %}' versions: free-pro-team: '*' +topics: + - enterprise --- {% data reusables.enterprise-accounts.user-provisioning-release-stage %} diff --git a/content/github/setting-up-and-managing-your-enterprise/adding-organizations-to-your-enterprise-account.md b/content/github/setting-up-and-managing-your-enterprise/adding-organizations-to-your-enterprise-account.md index 893493f000..463ae97339 100644 --- a/content/github/setting-up-and-managing-your-enterprise/adding-organizations-to-your-enterprise-account.md +++ b/content/github/setting-up-and-managing-your-enterprise/adding-organizations-to-your-enterprise-account.md @@ -7,6 +7,8 @@ redirect_from: - /github/setting-up-and-managing-your-enterprise-account/adding-organizations-to-your-enterprise-account versions: free-pro-team: '*' +topics: + - enterprise --- Enterprise owners can create new organizations within an enterprise account's settings. diff --git a/content/github/setting-up-and-managing-your-enterprise/configuring-identity-and-access-management-for-your-enterprise-account.md b/content/github/setting-up-and-managing-your-enterprise/configuring-identity-and-access-management-for-your-enterprise-account.md index 2e1d9a2c7b..19fe6d4cad 100644 --- a/content/github/setting-up-and-managing-your-enterprise/configuring-identity-and-access-management-for-your-enterprise-account.md +++ b/content/github/setting-up-and-managing-your-enterprise/configuring-identity-and-access-management-for-your-enterprise-account.md @@ -1,9 +1,11 @@ --- title: Configuring identity and access management for your enterprise account -intro: You can manage SAML single sign-on, user provisioning, and team synchronization for your enterprise. +intro: 'You can manage SAML single sign-on, user provisioning, and team synchronization for your enterprise.' product: '{% data reusables.gated-features.enterprise-accounts %}' mapTopic: true versions: free-pro-team: '*' +topics: + - enterprise --- diff --git a/content/github/setting-up-and-managing-your-enterprise/configuring-saml-single-sign-on-and-scim-for-your-enterprise-account-using-okta.md b/content/github/setting-up-and-managing-your-enterprise/configuring-saml-single-sign-on-and-scim-for-your-enterprise-account-using-okta.md index b1fd95b884..a3ed7851ea 100644 --- a/content/github/setting-up-and-managing-your-enterprise/configuring-saml-single-sign-on-and-scim-for-your-enterprise-account-using-okta.md +++ b/content/github/setting-up-and-managing-your-enterprise/configuring-saml-single-sign-on-and-scim-for-your-enterprise-account-using-okta.md @@ -7,6 +7,8 @@ redirect_from: - /github/setting-up-and-managing-your-enterprise-account/configuring-saml-single-sign-on-and-scim-for-your-enterprise-account-using-okta versions: free-pro-team: '*' +topics: + - enterprise --- {% data reusables.enterprise-accounts.user-provisioning-release-stage %} diff --git a/content/github/setting-up-and-managing-your-enterprise/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-enterprise-account.md b/content/github/setting-up-and-managing-your-enterprise/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-enterprise-account.md index 2bd1d3b766..bf16b25a80 100644 --- a/content/github/setting-up-and-managing-your-enterprise/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-enterprise-account.md +++ b/content/github/setting-up-and-managing-your-enterprise/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-enterprise-account.md @@ -8,6 +8,9 @@ miniTocMaxHeadingLevel: 4 versions: free-pro-team: '*' enterprise-server: '>=2.23' + github-ae: '*' +topics: + - enterprise --- {% data reusables.actions.about-artifact-log-retention %} diff --git a/content/github/setting-up-and-managing-your-enterprise/configuring-webhooks-for-organization-events-in-your-enterprise-account.md b/content/github/setting-up-and-managing-your-enterprise/configuring-webhooks-for-organization-events-in-your-enterprise-account.md index 9aeb15a046..51a4749ae6 100644 --- a/content/github/setting-up-and-managing-your-enterprise/configuring-webhooks-for-organization-events-in-your-enterprise-account.md +++ b/content/github/setting-up-and-managing-your-enterprise/configuring-webhooks-for-organization-events-in-your-enterprise-account.md @@ -8,6 +8,8 @@ redirect_from: - /github/setting-up-and-managing-your-enterprise-account/configuring-webhooks-for-organization-events-in-your-enterprise-account versions: free-pro-team: '*' +topics: + - enterprise --- You can configure webhooks to receive events from organizations owned by your enterprise account. For more information about webhooks, see "[Webhooks](/webhooks/)." diff --git a/content/github/setting-up-and-managing-your-enterprise/enabling-saml-single-sign-on-for-organizations-in-your-enterprise-account.md b/content/github/setting-up-and-managing-your-enterprise/enabling-saml-single-sign-on-for-organizations-in-your-enterprise-account.md index 0e002776cb..4743ba484e 100644 --- a/content/github/setting-up-and-managing-your-enterprise/enabling-saml-single-sign-on-for-organizations-in-your-enterprise-account.md +++ b/content/github/setting-up-and-managing-your-enterprise/enabling-saml-single-sign-on-for-organizations-in-your-enterprise-account.md @@ -5,6 +5,8 @@ product: '{% data reusables.gated-features.enterprise-accounts %}' permissions: Enterprise owners can enable SAML single sign-on for organizations in an enterprise account. versions: free-pro-team: '*' +topics: + - enterprise --- ### About SAML single sign-on for enterprise accounts diff --git a/content/github/setting-up-and-managing-your-enterprise/enforcing-a-policy-on-dependency-insights-in-your-enterprise-account.md b/content/github/setting-up-and-managing-your-enterprise/enforcing-a-policy-on-dependency-insights-in-your-enterprise-account.md index 036f99a198..e2333feeee 100644 --- a/content/github/setting-up-and-managing-your-enterprise/enforcing-a-policy-on-dependency-insights-in-your-enterprise-account.md +++ b/content/github/setting-up-and-managing-your-enterprise/enforcing-a-policy-on-dependency-insights-in-your-enterprise-account.md @@ -8,6 +8,8 @@ redirect_from: - /github/setting-up-and-managing-your-enterprise-account/enforcing-a-policy-on-dependency-insights-in-your-enterprise-account versions: free-pro-team: '*' +topics: + - enterprise --- In organizations owned by an enterprise account, organization owners can set limitations for viewing organization dependency insights. For more information, see "[Changing the visibility of your organization's dependency insights](/articles/changing-the-visibility-of-your-organizations-dependency-insights)." diff --git a/content/github/setting-up-and-managing-your-enterprise/enforcing-github-actions-policies-in-your-enterprise-account.md b/content/github/setting-up-and-managing-your-enterprise/enforcing-github-actions-policies-in-your-enterprise-account.md index 7ef386c2ae..99413f99b7 100644 --- a/content/github/setting-up-and-managing-your-enterprise/enforcing-github-actions-policies-in-your-enterprise-account.md +++ b/content/github/setting-up-and-managing-your-enterprise/enforcing-github-actions-policies-in-your-enterprise-account.md @@ -7,6 +7,8 @@ redirect_from: miniTocMaxHeadingLevel: 4 versions: free-pro-team: '*' +topics: + - enterprise --- ### About {% data variables.product.prodname_actions %} permissions for your enterprise account diff --git a/content/github/setting-up-and-managing-your-enterprise/enforcing-project-board-policies-in-your-enterprise-account.md b/content/github/setting-up-and-managing-your-enterprise/enforcing-project-board-policies-in-your-enterprise-account.md index 2b1f5bec09..fc56be779a 100644 --- a/content/github/setting-up-and-managing-your-enterprise/enforcing-project-board-policies-in-your-enterprise-account.md +++ b/content/github/setting-up-and-managing-your-enterprise/enforcing-project-board-policies-in-your-enterprise-account.md @@ -9,6 +9,8 @@ redirect_from: - /github/setting-up-and-managing-your-enterprise-account/enforcing-project-board-policies-in-your-enterprise-account versions: free-pro-team: '*' +topics: + - enterprise --- For more information about types of project boards, see "[About project boards](/articles/about-project-boards)." diff --git a/content/github/setting-up-and-managing-your-enterprise/enforcing-repository-management-policies-in-your-enterprise-account.md b/content/github/setting-up-and-managing-your-enterprise/enforcing-repository-management-policies-in-your-enterprise-account.md index f5e9e4c082..c3becba29a 100644 --- a/content/github/setting-up-and-managing-your-enterprise/enforcing-repository-management-policies-in-your-enterprise-account.md +++ b/content/github/setting-up-and-managing-your-enterprise/enforcing-repository-management-policies-in-your-enterprise-account.md @@ -9,6 +9,8 @@ redirect_from: - /github/setting-up-and-managing-your-enterprise-account/enforcing-repository-management-policies-in-your-enterprise-account versions: free-pro-team: '*' +topics: + - enterprise --- For more information, see "[Repository permission levels for an organization](/articles/repository-permission-levels-for-an-organization)." diff --git a/content/github/setting-up-and-managing-your-enterprise/enforcing-security-settings-in-your-enterprise-account.md b/content/github/setting-up-and-managing-your-enterprise/enforcing-security-settings-in-your-enterprise-account.md index 2b0f109f96..8271ab0077 100644 --- a/content/github/setting-up-and-managing-your-enterprise/enforcing-security-settings-in-your-enterprise-account.md +++ b/content/github/setting-up-and-managing-your-enterprise/enforcing-security-settings-in-your-enterprise-account.md @@ -11,6 +11,8 @@ redirect_from: - /github/setting-up-and-managing-your-enterprise-account/enforcing-security-settings-in-your-enterprise-account versions: free-pro-team: '*' +topics: + - enterprise --- ### Requiring two-factor authentication for organizations in your enterprise account diff --git a/content/github/setting-up-and-managing-your-enterprise/enforcing-team-policies-in-your-enterprise-account.md b/content/github/setting-up-and-managing-your-enterprise/enforcing-team-policies-in-your-enterprise-account.md index 6d95d38f9f..cbe70eef28 100644 --- a/content/github/setting-up-and-managing-your-enterprise/enforcing-team-policies-in-your-enterprise-account.md +++ b/content/github/setting-up-and-managing-your-enterprise/enforcing-team-policies-in-your-enterprise-account.md @@ -9,11 +9,13 @@ redirect_from: - /github/setting-up-and-managing-your-enterprise-account/enforcing-team-policies-in-your-enterprise-account versions: free-pro-team: '*' +topics: + - enterprise --- ### Enforcing a policy for team discussions -Across all organizations owned by your enterprise account, you can enable or disable team discussions, or allow owners to administer the setting on the organization level. For more information, see "[About team discussions](/articles/about-team-discussions/)." +Across all organizations owned by your enterprise account, you can enable or disable team discussions, or allow owners to administer the setting on the organization level. For more information, see "[About team discussions](/github/setting-up-and-managing-organizations-and-teams/about-team-discussions/)." {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.policies-tab %} diff --git a/content/github/setting-up-and-managing-your-enterprise/index.md b/content/github/setting-up-and-managing-your-enterprise/index.md index b2a9848b92..e6f5d91294 100644 --- a/content/github/setting-up-and-managing-your-enterprise/index.md +++ b/content/github/setting-up-and-managing-your-enterprise/index.md @@ -9,6 +9,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- @@ -29,7 +31,6 @@ versions: {% link_in_list /managing-unowned-organizations-in-your-enterprise-account %} {% link_in_list /viewing-the-audit-logs-for-organizations-in-your-enterprise-account %} {% link_in_list /configuring-webhooks-for-organization-events-in-your-enterprise-account %} - {% link_in_list /managing-use-of-advanced-security-for-organizations-in-your-enterprise-account %} {% topic_link_in_list /configuring-identity-and-access-management-for-your-enterprise-account %} {% link_in_list /about-identity-and-access-management-for-your-enterprise-account %} {% link_in_list /enabling-saml-single-sign-on-for-organizations-in-your-enterprise-account %} diff --git a/content/github/setting-up-and-managing-your-enterprise/inviting-people-to-manage-your-enterprise.md b/content/github/setting-up-and-managing-your-enterprise/inviting-people-to-manage-your-enterprise.md index 5f847dd348..e25cf3136e 100644 --- a/content/github/setting-up-and-managing-your-enterprise/inviting-people-to-manage-your-enterprise.md +++ b/content/github/setting-up-and-managing-your-enterprise/inviting-people-to-manage-your-enterprise.md @@ -9,6 +9,8 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '*' +topics: + - enterprise --- ### About inviting people to manage your enterprise account diff --git a/content/github/setting-up-and-managing-your-enterprise/managing-licenses-for-visual-studio-subscription-with-github-enterprise.md b/content/github/setting-up-and-managing-your-enterprise/managing-licenses-for-visual-studio-subscription-with-github-enterprise.md index 6a02ac8400..6596a04d44 100644 --- a/content/github/setting-up-and-managing-your-enterprise/managing-licenses-for-visual-studio-subscription-with-github-enterprise.md +++ b/content/github/setting-up-and-managing-your-enterprise/managing-licenses-for-visual-studio-subscription-with-github-enterprise.md @@ -9,6 +9,8 @@ redirect_from: - /github/setting-up-and-managing-your-enterprise-account/managing-licenses-for-visual-studio-subscription-with-github-enterprise versions: free-pro-team: '*' +topics: + - enterprise --- ### About {% data variables.product.prodname_vss_ghe %} diff --git a/content/github/setting-up-and-managing-your-enterprise/managing-organizations-in-your-enterprise-account.md b/content/github/setting-up-and-managing-your-enterprise/managing-organizations-in-your-enterprise-account.md index 9045814fc6..64cb68fdcb 100644 --- a/content/github/setting-up-and-managing-your-enterprise/managing-organizations-in-your-enterprise-account.md +++ b/content/github/setting-up-and-managing-your-enterprise/managing-organizations-in-your-enterprise-account.md @@ -7,4 +7,7 @@ redirect_from: - /github/setting-up-and-managing-your-enterprise-account/managing-organizations-in-your-enterprise-account versions: free-pro-team: '*' +topics: + - enterprise --- + diff --git a/content/github/setting-up-and-managing-your-enterprise/managing-team-synchronization-for-organizations-in-your-enterprise-account.md b/content/github/setting-up-and-managing-your-enterprise/managing-team-synchronization-for-organizations-in-your-enterprise-account.md index a8ce59ba50..ef3f0b988a 100644 --- a/content/github/setting-up-and-managing-your-enterprise/managing-team-synchronization-for-organizations-in-your-enterprise-account.md +++ b/content/github/setting-up-and-managing-your-enterprise/managing-team-synchronization-for-organizations-in-your-enterprise-account.md @@ -5,6 +5,8 @@ product: '{% data reusables.gated-features.enterprise-accounts %}' permissions: Enterprise owners can manage team synchronization for an enterprise account. versions: free-pro-team: '*' +topics: + - enterprise --- ### About team synchronization for enterprise accounts diff --git a/content/github/setting-up-and-managing-your-enterprise/managing-unowned-organizations-in-your-enterprise-account.md b/content/github/setting-up-and-managing-your-enterprise/managing-unowned-organizations-in-your-enterprise-account.md index 5b1ed4ce48..1c3f9e78b5 100644 --- a/content/github/setting-up-and-managing-your-enterprise/managing-unowned-organizations-in-your-enterprise-account.md +++ b/content/github/setting-up-and-managing-your-enterprise/managing-unowned-organizations-in-your-enterprise-account.md @@ -7,6 +7,8 @@ redirect_from: - /github/setting-up-and-managing-your-enterprise-account/managing-unowned-organizations-in-your-enterprise-account versions: free-pro-team: '*' +topics: + - enterprise --- If you enable user deprovisioning to manage organization membership in your enterprise account, you could end up with an organization that has no organization owners. For more information, see "[About user provisioning for organizations in your enterprise account](/github/setting-up-and-managing-your-enterprise/about-user-provisioning-for-organizations-in-your-enterprise-account)." diff --git a/content/github/setting-up-and-managing-your-enterprise/managing-use-of-advanced-security-for-organizations-in-your-enterprise-account.md b/content/github/setting-up-and-managing-your-enterprise/managing-use-of-advanced-security-for-organizations-in-your-enterprise-account.md deleted file mode 100644 index 7463c8055f..0000000000 --- a/content/github/setting-up-and-managing-your-enterprise/managing-use-of-advanced-security-for-organizations-in-your-enterprise-account.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: Managing use of Advanced Security for organizations in your enterprise account -intro: 'You can review and manage the use of {% data variables.product.prodname_GH_advanced_security %} for organizations owned by an enterprise account.' -shortTitle: Managing use of Advanced Security -product: '{% data reusables.gated-features.enterprise-accounts %}' -permissions: Enterprise owners can manage access to {% data variables.product.prodname_GH_advanced_security %} for organizations and repositories in an enterprise account. -versions: - free-pro-team: '*' ---- - -### About {% data variables.product.prodname_GH_advanced_security %} for enterprise accounts - -{% data variables.product.prodname_dotcom %} makes additional security features available to private repositories owned by enterprise accounts with a license for {% data variables.product.prodname_GH_advanced_security %}. {% data reusables.advanced-security.more-info-ghas %} - -{% data reusables.advanced-security.license-overview %} - -You can see a summary of your current license usage for each organization on the billing page for the enterprise account (see below). - -### About committer numbers for enterprise accounts - -The {% data variables.product.prodname_GH_advanced_security %} summary for an enterprise account reports two numbers of committers for each organization: - -- **Committers** is the number of committers who contributed to at least one private repository in the organization and who use a seat in your enterprise license. That is, they are an organization member, external collaborator to a repository, or have a pending invitation to join your enterprise account. -- **Unique to this organization** is the number of committers who contributed only to repositories in that organization. This number shows how many license seats you can free up by disabling {% data variables.product.prodname_GH_advanced_security %} for that organization. - -{% data reusables.advanced-security.enable-disable-committer-info %} - -### Managing the use of {% data variables.product.prodname_GH_advanced_security %} for an enterprise account - -If you have a license for {% data variables.product.prodname_GH_advanced_security %}, the enterprise billing page includes a "{% data variables.product.prodname_GH_advanced_security %}" section that lists the organizations that use the feature. - -{% data reusables.enterprise-accounts.access-enterprise %} -{% data reusables.enterprise-accounts.settings-tab %} -{% data reusables.enterprise-accounts.billing-tab %} -1. In the "{% data variables.product.prodname_GH_advanced_security %}" section you can see the number of committers and unique committers for each organization. - ![{% data variables.product.prodname_GH_advanced_security %} in enterprise billing settings](/assets/images/help/enterprises/ghas-orgs-list.png) -1. If you are an organization owner, you can click the name to display the billings and plans for the organization. - ![Owned organization in {% data variables.product.prodname_GH_advanced_security %} section of enterprise billing settings](/assets/images/help/enterprises/ghas-orgs-list-click-org.png) - -For detailed information of which repositories in an organization use {% data variables.product.prodname_GH_advanced_security %}, view the "Security & analysis" page for an organization. - -For more information, see "[Managing security and analysis settings for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization)." diff --git a/content/github/setting-up-and-managing-your-enterprise/managing-users-in-your-enterprise.md b/content/github/setting-up-and-managing-your-enterprise/managing-users-in-your-enterprise.md index 6ccf673df3..b5a764d7bc 100644 --- a/content/github/setting-up-and-managing-your-enterprise/managing-users-in-your-enterprise.md +++ b/content/github/setting-up-and-managing-your-enterprise/managing-users-in-your-enterprise.md @@ -11,4 +11,7 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- + diff --git a/content/github/setting-up-and-managing-your-enterprise/managing-your-enterprise-account.md b/content/github/setting-up-and-managing-your-enterprise/managing-your-enterprise-account.md index 348926c13c..143d0baadd 100644 --- a/content/github/setting-up-and-managing-your-enterprise/managing-your-enterprise-account.md +++ b/content/github/setting-up-and-managing-your-enterprise/managing-your-enterprise-account.md @@ -7,5 +7,7 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '*' +topics: + - enterprise --- diff --git a/content/github/setting-up-and-managing-your-enterprise/restricting-email-notifications-for-your-enterprise-account-to-approved-domains.md b/content/github/setting-up-and-managing-your-enterprise/restricting-email-notifications-for-your-enterprise-account-to-approved-domains.md index e02bb0e7c0..651e15af7b 100644 --- a/content/github/setting-up-and-managing-your-enterprise/restricting-email-notifications-for-your-enterprise-account-to-approved-domains.md +++ b/content/github/setting-up-and-managing-your-enterprise/restricting-email-notifications-for-your-enterprise-account-to-approved-domains.md @@ -1,14 +1,14 @@ --- title: Restricting email notifications for your enterprise account to approved domains -intro: "You can prevent your enterprise's information from leaking into personal accounts by restricting email notifications about activity in organizations owned by your enterprise account to verified domains." +intro: You can prevent your enterprise's information from leaking into personal accounts by restricting email notifications about activity in organizations owned by your enterprise account to verified domains. product: '{% data reusables.gated-features.enterprise-accounts %}' versions: free-pro-team: '*' permissions: Enterprise owners can restrict email notifications for an enterprise account. +topics: + - enterprise --- -{% data reusables.enterprise-accounts.verifying-domains-release-phase %} - ### About email restrictions for your enterprise account When you restrict email notifications to verified domains, enterprise members can only use an email address associated with a verified domain to receive email notifications about activity in organizations owned by your enterprise account. The domains can be inherited from the enterprise account or configured for the specific organization. For more information about email restrictions for organizations, see "[Restricting email notifications to an approved domain](/github/setting-up-and-managing-organizations-and-teams/restricting-email-notifications-to-an-approved-domain)." diff --git a/content/github/setting-up-and-managing-your-enterprise/roles-in-an-enterprise.md b/content/github/setting-up-and-managing-your-enterprise/roles-in-an-enterprise.md index a0323d4f21..bc2568895a 100644 --- a/content/github/setting-up-and-managing-your-enterprise/roles-in-an-enterprise.md +++ b/content/github/setting-up-and-managing-your-enterprise/roles-in-an-enterprise.md @@ -10,6 +10,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- ### About roles in an enterprise diff --git a/content/github/setting-up-and-managing-your-enterprise/setting-policies-for-organizations-in-your-enterprise-account.md b/content/github/setting-up-and-managing-your-enterprise/setting-policies-for-organizations-in-your-enterprise-account.md index 27d125ccd8..1295569fe5 100644 --- a/content/github/setting-up-and-managing-your-enterprise/setting-policies-for-organizations-in-your-enterprise-account.md +++ b/content/github/setting-up-and-managing-your-enterprise/setting-policies-for-organizations-in-your-enterprise-account.md @@ -7,4 +7,7 @@ redirect_from: - /github/setting-up-and-managing-your-enterprise-account/setting-policies-for-organizations-in-your-enterprise-account versions: free-pro-team: '*' +topics: + - enterprise --- + diff --git a/content/github/setting-up-and-managing-your-enterprise/verifying-your-enterprise-accounts-domain.md b/content/github/setting-up-and-managing-your-enterprise/verifying-your-enterprise-accounts-domain.md index 7ff5dfb144..96714ca44c 100644 --- a/content/github/setting-up-and-managing-your-enterprise/verifying-your-enterprise-accounts-domain.md +++ b/content/github/setting-up-and-managing-your-enterprise/verifying-your-enterprise-accounts-domain.md @@ -8,10 +8,10 @@ permissions: Enterprise owners can verify an enterprise account's domain. redirect_from: - /github/articles/verifying-your-enterprise-accounts-domain - /early-access/github/articles/verifying-your-enterprise-accounts-domain +topics: + - enterprise --- -{% data reusables.enterprise-accounts.verifying-domains-release-phase %} - ### About domain verification You can confirm that the websites and email addresses listed on the profiles of any organization owned by your enterprise account are controlled by your enterprise by verifying the domains. Verified domains for an enterprise account apply to every organization owned by the enterprise account, and organization owners can verify additional domains for their organizations. For more information, see "[Verifying your organization's domain](/github/setting-up-and-managing-organizations-and-teams/verifying-your-organizations-domain)." @@ -41,4 +41,4 @@ To verify your enterprise account's domain, you must have access to modify domai ``` {% data reusables.organizations.continue-verifying-domain %} 1. Optionally, after the "Verified" badge is visible on your organizations' profiles, delete the TXT entry from the DNS record at your domain hosting service. -![Verified badge](/assets/images/help/organizations/verified-badge.png) \ No newline at end of file +![Verified badge](/assets/images/help/organizations/verified-badge.png) diff --git a/content/github/setting-up-and-managing-your-enterprise/viewing-and-managing-a-users-saml-access-to-your-enterprise.md b/content/github/setting-up-and-managing-your-enterprise/viewing-and-managing-a-users-saml-access-to-your-enterprise.md index 8ec6200f48..79372cb903 100644 --- a/content/github/setting-up-and-managing-your-enterprise/viewing-and-managing-a-users-saml-access-to-your-enterprise.md +++ b/content/github/setting-up-and-managing-your-enterprise/viewing-and-managing-a-users-saml-access-to-your-enterprise.md @@ -8,6 +8,8 @@ redirect_from: - /github/setting-up-and-managing-your-enterprise-account/viewing-and-managing-a-users-saml-access-to-your-enterprise-account versions: free-pro-team: '*' +topics: + - enterprise --- ### About SAML access to your enterprise account diff --git a/content/github/setting-up-and-managing-your-enterprise/viewing-people-in-your-enterprise.md b/content/github/setting-up-and-managing-your-enterprise/viewing-people-in-your-enterprise.md index ba548c7c1d..8ffa84213a 100644 --- a/content/github/setting-up-and-managing-your-enterprise/viewing-people-in-your-enterprise.md +++ b/content/github/setting-up-and-managing-your-enterprise/viewing-people-in-your-enterprise.md @@ -9,6 +9,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- ### Viewing enterprise owners{% if currentVersion == "free-pro-team@latest" %} and billing managers{% endif %} @@ -23,7 +25,7 @@ You can view enterprise owners {% if currentVersion == "free-pro-team@latest" %} ### Viewing members and outside collaborators -You can view the number of pending members and outside collaborators. You can filter the list of members by {% if currentVersion == "free-pro-team@latest" %}deployment ({% data variables.product.prodname_ghe_cloud %} or {% data variables.product.prodname_ghe_server %}),{% endif %}role {% if currentVersion == "free-pro-team@latest" %}, and{% elsif currentVersion == "github-ae@latest" %}or {% endif %}organization. You can filter the list of outside collaborators by the visibility of the repositories the collaborator has access to. You can find a specific person by searching for their username or display name. +You can view the number of pending members and outside collaborators. You can filter the list of members by {% if currentVersion == "free-pro-team@latest" %}deployment ({% data variables.product.prodname_ghe_cloud %} or {% data variables.product.prodname_ghe_server %}),{% endif %} role{% if currentVersion == "free-pro-team@latest" %}, and{% else %} or {% endif %} organization. You can filter the list of outside collaborators by the visibility of the repositories the collaborator has access to. You can find a specific person by searching for their username or display name. You can view {% if currentVersion == "free-pro-team@latest" %}all the {% data variables.product.prodname_ghe_cloud %} organizations and {% data variables.product.prodname_ghe_server %} instances that a member belongs to, and {% endif %}which repositories an outside collaborator has access to{% if currentVersion == "free-pro-team@latest" %}, {% endif %} by clicking on the person's name. diff --git a/content/github/setting-up-and-managing-your-enterprise/viewing-the-audit-logs-for-organizations-in-your-enterprise-account.md b/content/github/setting-up-and-managing-your-enterprise/viewing-the-audit-logs-for-organizations-in-your-enterprise-account.md index b63394ccd3..4227e55e42 100644 --- a/content/github/setting-up-and-managing-your-enterprise/viewing-the-audit-logs-for-organizations-in-your-enterprise-account.md +++ b/content/github/setting-up-and-managing-your-enterprise/viewing-the-audit-logs-for-organizations-in-your-enterprise-account.md @@ -8,6 +8,8 @@ redirect_from: - /github/setting-up-and-managing-your-enterprise-account/viewing-the-audit-logs-for-organizations-in-your-enterprise-account versions: free-pro-team: '*' +topics: + - enterprise --- Each audit log entry shows applicable information about an event, such as: diff --git a/content/github/setting-up-and-managing-your-enterprise/viewing-the-subscription-and-usage-for-your-enterprise-account.md b/content/github/setting-up-and-managing-your-enterprise/viewing-the-subscription-and-usage-for-your-enterprise-account.md index 94a279cfb9..452442dbdd 100644 --- a/content/github/setting-up-and-managing-your-enterprise/viewing-the-subscription-and-usage-for-your-enterprise-account.md +++ b/content/github/setting-up-and-managing-your-enterprise/viewing-the-subscription-and-usage-for-your-enterprise-account.md @@ -2,13 +2,15 @@ title: Viewing the subscription and usage for your enterprise account intro: 'You can view the current subscription, license usage, invoices, payment history, and other billing information for your enterprise account.' product: '{% data reusables.gated-features.enterprise-accounts %}' -permissions: 'Enterprise owners and billing managers can access and manage all billing settings for enterprise accounts.' +permissions: Enterprise owners and billing managers can access and manage all billing settings for enterprise accounts. redirect_from: - /github/setting-up-and-managing-your-enterprise-account/viewing-the-subscription-and-usage-for-your-enterprise-account - /articles/viewing-the-subscription-and-usage-for-your-enterprise-account versions: free-pro-team: '*' enterprise-server: '*' +topics: + - enterprise --- ### About billing for enterprise accounts @@ -37,6 +39,6 @@ For more information about managing billing managers, see "[Inviting people to m - "[About billing for GitHub Actions](/github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-actions#about-billing-for-github-actions)" - "[About billing for Git Large File Storage](/github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-git-large-file-storage)" -- "[Managing use of Advanced Security for organizations in your enterprise account](/github/setting-up-and-managing-your-enterprise/managing-use-of-advanced-security-for-organizations-in-your-enterprise-account)" +- "[About licensing for {% data variables.product.prodname_GH_advanced_security %}](/github/setting-up-and-managing-billing-and-payments-on-github/about-licensing-for-github-advanced-security)" {% endif %} diff --git a/content/github/setting-up-and-managing-your-github-profile/about-your-organizations-profile.md b/content/github/setting-up-and-managing-your-github-profile/about-your-organizations-profile.md index d5b5bcbbf2..0a158f8e14 100644 --- a/content/github/setting-up-and-managing-your-github-profile/about-your-organizations-profile.md +++ b/content/github/setting-up-and-managing-your-github-profile/about-your-organizations-profile.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - profiles --- You can optionally choose to add a description, location, website, and email address for your organization, and pin important repositories to the top of the page. diff --git a/content/github/setting-up-and-managing-your-github-profile/about-your-profile.md b/content/github/setting-up-and-managing-your-github-profile/about-your-profile.md index b2ba70604a..6d98ca7dbf 100644 --- a/content/github/setting-up-and-managing-your-github-profile/about-your-profile.md +++ b/content/github/setting-up-and-managing-your-github-profile/about-your-profile.md @@ -9,6 +9,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - profiles --- You can add personal information about yourself in your bio, like previous places you've worked, projects you've contributed to, or interests you have that other people may like to know about. For more information, see "[Adding a bio to your profile](/articles/personalizing-your-profile/#adding-a-bio-to-your-profile)." diff --git a/content/github/setting-up-and-managing-your-github-profile/customizing-your-profile.md b/content/github/setting-up-and-managing-your-github-profile/customizing-your-profile.md index 6a1a2d651a..529e65c64d 100644 --- a/content/github/setting-up-and-managing-your-github-profile/customizing-your-profile.md +++ b/content/github/setting-up-and-managing-your-github-profile/customizing-your-profile.md @@ -8,5 +8,7 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - profiles --- diff --git a/content/github/setting-up-and-managing-your-github-profile/index.md b/content/github/setting-up-and-managing-your-github-profile/index.md index b6ef2bc555..65df71a043 100644 --- a/content/github/setting-up-and-managing-your-github-profile/index.md +++ b/content/github/setting-up-and-managing-your-github-profile/index.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - profiles --- diff --git a/content/github/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile.md b/content/github/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile.md index e12a79ddba..54d688fdac 100644 --- a/content/github/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile.md +++ b/content/github/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile.md @@ -8,5 +8,7 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - profiles --- diff --git a/content/github/setting-up-and-managing-your-github-profile/managing-your-profile-readme.md b/content/github/setting-up-and-managing-your-github-profile/managing-your-profile-readme.md index 9829c4a9ac..32ed768480 100644 --- a/content/github/setting-up-and-managing-your-github-profile/managing-your-profile-readme.md +++ b/content/github/setting-up-and-managing-your-github-profile/managing-your-profile-readme.md @@ -4,6 +4,8 @@ intro: 'You can add a README to your {% data variables.product.prodname_dotcom % versions: free-pro-team: '*' enterprise-server: '>=2.22' +topics: + - profiles --- ### About your profile README diff --git a/content/github/setting-up-and-managing-your-github-profile/personalizing-your-profile.md b/content/github/setting-up-and-managing-your-github-profile/personalizing-your-profile.md index 1845388433..b5cdcf5792 100644 --- a/content/github/setting-up-and-managing-your-github-profile/personalizing-your-profile.md +++ b/content/github/setting-up-and-managing-your-github-profile/personalizing-your-profile.md @@ -12,6 +12,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - profiles --- ### Changing your profile picture diff --git a/content/github/setting-up-and-managing-your-github-profile/pinning-items-to-your-profile.md b/content/github/setting-up-and-managing-your-github-profile/pinning-items-to-your-profile.md index 99905412a6..9ad1c75672 100644 --- a/content/github/setting-up-and-managing-your-github-profile/pinning-items-to-your-profile.md +++ b/content/github/setting-up-and-managing-your-github-profile/pinning-items-to-your-profile.md @@ -1,12 +1,14 @@ --- title: Pinning items to your profile -intro: 'You can pin gists and repositories to your profile so other people can quickly see your best work.' +intro: You can pin gists and repositories to your profile so other people can quickly see your best work. redirect_from: - /articles/pinning-repositories-to-your-profile/ - /articles/pinning-items-to-your-profile versions: free-pro-team: '*' enterprise-server: '*' +topics: + - profiles --- You can pin a public repository if you own the repository or you've made contributions to the repository. Commits to forks don't count as contributions, so you can't pin a fork that you don't own. For more information, see "[Why are my contributions not showing up on my profile?](/articles/why-are-my-contributions-not-showing-up-on-my-profile)" diff --git a/content/github/setting-up-and-managing-your-github-profile/publicizing-or-hiding-your-private-contributions-on-your-profile.md b/content/github/setting-up-and-managing-your-github-profile/publicizing-or-hiding-your-private-contributions-on-your-profile.md index a4fb392c7b..9f0ba1abbf 100644 --- a/content/github/setting-up-and-managing-your-github-profile/publicizing-or-hiding-your-private-contributions-on-your-profile.md +++ b/content/github/setting-up-and-managing-your-github-profile/publicizing-or-hiding-your-private-contributions-on-your-profile.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - profiles --- If you publicize your private contributions, people without access to the private repositories you work in won't be able to see the details of your private contributions. Instead, they'll see the number of private contributions you made on any given day. Your public contributions will include detailed information. For more information, see "[Viewing contributions on your profile page](/articles/viewing-contributions-on-your-profile-page)". diff --git a/content/github/setting-up-and-managing-your-github-profile/sending-your-github-enterprise-server-contributions-to-your-githubcom-profile.md b/content/github/setting-up-and-managing-your-github-profile/sending-your-github-enterprise-server-contributions-to-your-githubcom-profile.md index a81413352b..80ff1b97b7 100644 --- a/content/github/setting-up-and-managing-your-github-profile/sending-your-github-enterprise-server-contributions-to-your-githubcom-profile.md +++ b/content/github/setting-up-and-managing-your-github-profile/sending-your-github-enterprise-server-contributions-to-your-githubcom-profile.md @@ -8,6 +8,8 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '*' +topics: + - profiles --- {% note %} diff --git a/content/github/setting-up-and-managing-your-github-profile/showing-an-overview-of-your-activity-on-your-profile.md b/content/github/setting-up-and-managing-your-github-profile/showing-an-overview-of-your-activity-on-your-profile.md index a7fc39ffc8..93f96972bb 100644 --- a/content/github/setting-up-and-managing-your-github-profile/showing-an-overview-of-your-activity-on-your-profile.md +++ b/content/github/setting-up-and-managing-your-github-profile/showing-an-overview-of-your-activity-on-your-profile.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - profiles --- {% data reusables.profile.activity-overview-summary %} For more information, see "[Viewing contributions on your profile](/articles/viewing-contributions-on-your-profile)." diff --git a/content/github/setting-up-and-managing-your-github-profile/troubleshooting-commits-on-your-timeline.md b/content/github/setting-up-and-managing-your-github-profile/troubleshooting-commits-on-your-timeline.md index c175ed7288..786fe7da85 100644 --- a/content/github/setting-up-and-managing-your-github-profile/troubleshooting-commits-on-your-timeline.md +++ b/content/github/setting-up-and-managing-your-github-profile/troubleshooting-commits-on-your-timeline.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - profiles --- ### Expected behavior to view commit details diff --git a/content/github/setting-up-and-managing-your-github-profile/viewing-contributions-on-your-profile.md b/content/github/setting-up-and-managing-your-github-profile/viewing-contributions-on-your-profile.md index 2620b22569..08de8cfc3e 100644 --- a/content/github/setting-up-and-managing-your-github-profile/viewing-contributions-on-your-profile.md +++ b/content/github/setting-up-and-managing-your-github-profile/viewing-contributions-on-your-profile.md @@ -9,6 +9,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - profiles --- {% if currentVersion == "free-pro-team@latest" or enterpriseServerVersions contains currentVersion %}Your contribution graph shows activity from public repositories. {% endif %}You can choose to show activity from {% if currentVersion == "free-pro-team@latest" or enterpriseServerVersions contains currentVersion %}both public and {% endif %}private repositories, with specific details of your activity in private repositories anonymized. For more information, see "[Publicizing or hiding your private contributions on your profile](/articles/publicizing-or-hiding-your-private-contributions-on-your-profile)." diff --git a/content/github/setting-up-and-managing-your-github-profile/why-are-my-contributions-not-showing-up-on-my-profile.md b/content/github/setting-up-and-managing-your-github-profile/why-are-my-contributions-not-showing-up-on-my-profile.md index b03f183b73..84d3bddd57 100644 --- a/content/github/setting-up-and-managing-your-github-profile/why-are-my-contributions-not-showing-up-on-my-profile.md +++ b/content/github/setting-up-and-managing-your-github-profile/why-are-my-contributions-not-showing-up-on-my-profile.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - profiles --- ### Contributions that are counted diff --git a/content/github/setting-up-and-managing-your-github-user-account/about-organization-membership.md b/content/github/setting-up-and-managing-your-github-user-account/about-organization-membership.md index 26871dae11..cb1ddd422b 100644 --- a/content/github/setting-up-and-managing-your-github-user-account/about-organization-membership.md +++ b/content/github/setting-up-and-managing-your-github-user-account/about-organization-membership.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - accounts --- An organization owner can invite you to join their organization as a member, billing manager, or owner. An organization owner or member with admin privileges for a repository can invite you to collaborate in one or more repositories as an outside collaborator. For more information, see "[Permission levels for an organization](/articles/permission-levels-for-an-organization)." diff --git a/content/github/setting-up-and-managing-your-github-user-account/about-your-personal-dashboard.md b/content/github/setting-up-and-managing-your-github-user-account/about-your-personal-dashboard.md index 56bc439f15..8eb29afb79 100644 --- a/content/github/setting-up-and-managing-your-github-user-account/about-your-personal-dashboard.md +++ b/content/github/setting-up-and-managing-your-github-user-account/about-your-personal-dashboard.md @@ -9,6 +9,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - accounts --- ### Accessing your personal dashboard diff --git a/content/github/setting-up-and-managing-your-github-user-account/accessing-an-organization.md b/content/github/setting-up-and-managing-your-github-user-account/accessing-an-organization.md index d02c1a7a1b..f47c140a3b 100644 --- a/content/github/setting-up-and-managing-your-github-user-account/accessing-an-organization.md +++ b/content/github/setting-up-and-managing-your-github-user-account/accessing-an-organization.md @@ -10,6 +10,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - accounts --- {% tip %} diff --git a/content/github/setting-up-and-managing-your-github-user-account/adding-an-email-address-to-your-github-account.md b/content/github/setting-up-and-managing-your-github-user-account/adding-an-email-address-to-your-github-account.md index c72f08f6d5..2ad2b2a46c 100644 --- a/content/github/setting-up-and-managing-your-github-user-account/adding-an-email-address-to-your-github-account.md +++ b/content/github/setting-up-and-managing-your-github-user-account/adding-an-email-address-to-your-github-account.md @@ -6,6 +6,9 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '*' +topics: + - accounts + - notifications --- {% if currentVersion == "free-pro-team@latest" %} diff --git a/content/github/setting-up-and-managing-your-github-user-account/best-practices-for-leaving-your-company.md b/content/github/setting-up-and-managing-your-github-user-account/best-practices-for-leaving-your-company.md index 923402231b..9bba3b05ed 100644 --- a/content/github/setting-up-and-managing-your-github-user-account/best-practices-for-leaving-your-company.md +++ b/content/github/setting-up-and-managing-your-github-user-account/best-practices-for-leaving-your-company.md @@ -5,6 +5,8 @@ redirect_from: - /articles/best-practices-for-leaving-your-company versions: free-pro-team: '*' +topics: + - accounts --- Before you leave your company, make sure you update the following information in your user account: diff --git a/content/github/setting-up-and-managing-your-github-user-account/blocking-command-line-pushes-that-expose-your-personal-email-address.md b/content/github/setting-up-and-managing-your-github-user-account/blocking-command-line-pushes-that-expose-your-personal-email-address.md index a61ec05adb..13dfbff92f 100644 --- a/content/github/setting-up-and-managing-your-github-user-account/blocking-command-line-pushes-that-expose-your-personal-email-address.md +++ b/content/github/setting-up-and-managing-your-github-user-account/blocking-command-line-pushes-that-expose-your-personal-email-address.md @@ -5,6 +5,9 @@ redirect_from: - /articles/blocking-command-line-pushes-that-expose-your-personal-email-address versions: free-pro-team: '*' +topics: + - accounts + - notifications --- When you push commits from the command line, the email address that you've [set in Git](/articles/setting-your-commit-email-address) is associated with your commits. This setting blocks you from pushing commits on the command line that use your personal email address. diff --git a/content/github/setting-up-and-managing-your-github-user-account/changing-your-github-username.md b/content/github/setting-up-and-managing-your-github-user-account/changing-your-github-username.md index 8140f49101..08ec06aef5 100644 --- a/content/github/setting-up-and-managing-your-github-user-account/changing-your-github-username.md +++ b/content/github/setting-up-and-managing-your-github-user-account/changing-your-github-username.md @@ -10,6 +10,8 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '*' +topics: + - accounts --- ### About username changes diff --git a/content/github/setting-up-and-managing-your-github-user-account/changing-your-primary-email-address.md b/content/github/setting-up-and-managing-your-github-user-account/changing-your-primary-email-address.md index 7704249f86..c5e362db8d 100644 --- a/content/github/setting-up-and-managing-your-github-user-account/changing-your-primary-email-address.md +++ b/content/github/setting-up-and-managing-your-github-user-account/changing-your-primary-email-address.md @@ -6,6 +6,9 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '*' +topics: + - accounts + - notifications --- {% note %} diff --git a/content/github/setting-up-and-managing-your-github-user-account/converting-a-user-into-an-organization.md b/content/github/setting-up-and-managing-your-github-user-account/converting-a-user-into-an-organization.md index 9094888ead..73250f620d 100644 --- a/content/github/setting-up-and-managing-your-github-user-account/converting-a-user-into-an-organization.md +++ b/content/github/setting-up-and-managing-your-github-user-account/converting-a-user-into-an-organization.md @@ -8,6 +8,8 @@ intro: You can convert your user account into an organization. This allows more versions: free-pro-team: '*' enterprise-server: '*' +topics: + - accounts --- {% warning %} diff --git a/content/github/setting-up-and-managing-your-github-user-account/deleting-your-user-account.md b/content/github/setting-up-and-managing-your-github-user-account/deleting-your-user-account.md index 2073ac5e5e..b8177c6b3b 100644 --- a/content/github/setting-up-and-managing-your-github-user-account/deleting-your-user-account.md +++ b/content/github/setting-up-and-managing-your-github-user-account/deleting-your-user-account.md @@ -7,6 +7,8 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '*' +topics: + - accounts --- Deleting your user account removes all repositories, forks of private repositories, wikis, issues, pull requests, and pages owned by your account. {% if currentVersion == "free-pro-team@latest" %} Issues and pull requests you've created and comments you've made in repositories owned by other users will not be deleted - instead, they'll be associated with our [Ghost user](https://github.com/ghost).{% else %}Issues and pull requests you've created and comments you've made in repositories owned by other users will not be deleted.{% endif %} diff --git a/content/github/setting-up-and-managing-your-github-user-account/index.md b/content/github/setting-up-and-managing-your-github-user-account/index.md index 352849bd57..550c5b1f3b 100644 --- a/content/github/setting-up-and-managing-your-github-user-account/index.md +++ b/content/github/setting-up-and-managing-your-github-user-account/index.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - accounts --- diff --git a/content/github/setting-up-and-managing-your-github-user-account/inviting-collaborators-to-a-personal-repository.md b/content/github/setting-up-and-managing-your-github-user-account/inviting-collaborators-to-a-personal-repository.md index 8d3b6a831b..ce6539cb9d 100644 --- a/content/github/setting-up-and-managing-your-github-user-account/inviting-collaborators-to-a-personal-repository.md +++ b/content/github/setting-up-and-managing-your-github-user-account/inviting-collaborators-to-a-personal-repository.md @@ -10,6 +10,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - accounts + - repositories --- Repositories owned by an organization can grant more granular access. For more information, see "[Access permissions on {% data variables.product.product_name %}](/articles/access-permissions-on-github)." diff --git a/content/github/setting-up-and-managing-your-github-user-account/maintaining-ownership-continuity-of-your-user-accounts-repositories.md b/content/github/setting-up-and-managing-your-github-user-account/maintaining-ownership-continuity-of-your-user-accounts-repositories.md index a01d522898..9e18f58d24 100644 --- a/content/github/setting-up-and-managing-your-github-user-account/maintaining-ownership-continuity-of-your-user-accounts-repositories.md +++ b/content/github/setting-up-and-managing-your-github-user-account/maintaining-ownership-continuity-of-your-user-accounts-repositories.md @@ -3,6 +3,9 @@ title: Maintaining ownership continuity of your user account's repositories intro: You can invite someone to manage your user owned repositories if you are not able to. versions: free-pro-team: '*' +topics: + - accounts + - repositories --- ### About successors diff --git a/content/github/setting-up-and-managing-your-github-user-account/managing-access-to-your-personal-repositories.md b/content/github/setting-up-and-managing-your-github-user-account/managing-access-to-your-personal-repositories.md index 4676b8aeae..eb7faf4527 100644 --- a/content/github/setting-up-and-managing-your-github-user-account/managing-access-to-your-personal-repositories.md +++ b/content/github/setting-up-and-managing-your-github-user-account/managing-access-to-your-personal-repositories.md @@ -11,5 +11,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - accounts + - repositories --- diff --git a/content/github/setting-up-and-managing-your-github-user-account/managing-access-to-your-user-accounts-project-boards.md b/content/github/setting-up-and-managing-your-github-user-account/managing-access-to-your-user-accounts-project-boards.md index ea304c8f15..223fdd8e99 100644 --- a/content/github/setting-up-and-managing-your-github-user-account/managing-access-to-your-user-accounts-project-boards.md +++ b/content/github/setting-up-and-managing-your-github-user-account/managing-access-to-your-user-accounts-project-boards.md @@ -9,6 +9,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - accounts --- A collaborator is a person who has permissions to a project board you own. A collaborator's permissions will default to read access. For more information, see "[Permission levels for user-owned project boards](/articles/permission-levels-for-user-owned-project-boards)." diff --git a/content/github/setting-up-and-managing-your-github-user-account/managing-email-preferences.md b/content/github/setting-up-and-managing-your-github-user-account/managing-email-preferences.md index b53a647506..0b29ed6699 100644 --- a/content/github/setting-up-and-managing-your-github-user-account/managing-email-preferences.md +++ b/content/github/setting-up-and-managing-your-github-user-account/managing-email-preferences.md @@ -9,5 +9,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - accounts + - notifications --- diff --git a/content/github/setting-up-and-managing-your-github-user-account/managing-marketing-emails-from-github.md b/content/github/setting-up-and-managing-your-github-user-account/managing-marketing-emails-from-github.md index 04633f58fd..7dcd5e60c2 100644 --- a/content/github/setting-up-and-managing-your-github-user-account/managing-marketing-emails-from-github.md +++ b/content/github/setting-up-and-managing-your-github-user-account/managing-marketing-emails-from-github.md @@ -5,6 +5,9 @@ redirect_from: - /articles/managing-marketing-emails-from-github versions: free-pro-team: '*' +topics: + - accounts + - notifications --- ### Unsubscribing from {% data variables.product.prodname_dotcom %} marketing emails diff --git a/content/github/setting-up-and-managing-your-github-user-account/managing-security-and-analysis-settings-for-your-user-account.md b/content/github/setting-up-and-managing-your-github-user-account/managing-security-and-analysis-settings-for-your-user-account.md index d7d17817c2..d28e5fb58a 100644 --- a/content/github/setting-up-and-managing-your-github-user-account/managing-security-and-analysis-settings-for-your-user-account.md +++ b/content/github/setting-up-and-managing-your-github-user-account/managing-security-and-analysis-settings-for-your-user-account.md @@ -3,6 +3,8 @@ title: Managing security and analysis settings for your user account intro: 'You can control features that secure and analyze the code in your projects on {% data variables.product.prodname_dotcom %}.' versions: free-pro-team: '*' +topics: + - accounts --- ### About management of security and analysis settings @@ -28,6 +30,8 @@ For an overview of repository-level security, see "[About securing your reposito 7. Click **Disable FEATURE** or **Enable FEATURE** to disable or enable the feature for all the repositories you own. ![Button to disable or enable feature](/assets/images/help/settings/security-and-analysis-enable-dependency-graph.png) +{% data reusables.security.displayed-information %} + ### Enabling or disabling features for new repositories {% data reusables.user_settings.access_settings %} diff --git a/content/github/setting-up-and-managing-your-github-user-account/managing-the-default-branch-name-for-your-repositories.md b/content/github/setting-up-and-managing-your-github-user-account/managing-the-default-branch-name-for-your-repositories.md index 0524ab40ce..b199768a7b 100644 --- a/content/github/setting-up-and-managing-your-github-user-account/managing-the-default-branch-name-for-your-repositories.md +++ b/content/github/setting-up-and-managing-your-github-user-account/managing-the-default-branch-name-for-your-repositories.md @@ -5,6 +5,8 @@ versions: free-pro-team: '*' enterprise-server: '>=2.23' github-ae: '*' +topics: + - accounts --- ### About management of the default branch name diff --git a/content/github/setting-up-and-managing-your-github-user-account/managing-user-account-settings.md b/content/github/setting-up-and-managing-your-github-user-account/managing-user-account-settings.md index 3e31dd2814..fcbe11a0a4 100644 --- a/content/github/setting-up-and-managing-your-github-user-account/managing-user-account-settings.md +++ b/content/github/setting-up-and-managing-your-github-user-account/managing-user-account-settings.md @@ -10,5 +10,7 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - accounts --- diff --git a/content/github/setting-up-and-managing-your-github-user-account/managing-your-membership-in-organizations.md b/content/github/setting-up-and-managing-your-github-user-account/managing-your-membership-in-organizations.md index 80a10eb4a8..37b22a88d8 100644 --- a/content/github/setting-up-and-managing-your-github-user-account/managing-your-membership-in-organizations.md +++ b/content/github/setting-up-and-managing-your-github-user-account/managing-your-membership-in-organizations.md @@ -8,5 +8,7 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - accounts --- diff --git a/content/github/setting-up-and-managing-your-github-user-account/managing-your-scheduled-reminders.md b/content/github/setting-up-and-managing-your-github-user-account/managing-your-scheduled-reminders.md index 0cb96a4754..2284aaf647 100644 --- a/content/github/setting-up-and-managing-your-github-user-account/managing-your-scheduled-reminders.md +++ b/content/github/setting-up-and-managing-your-github-user-account/managing-your-scheduled-reminders.md @@ -3,6 +3,8 @@ title: Managing your scheduled reminders intro: Get reminders in Slack when you or your team have pull requests waiting for review. versions: free-pro-team: '*' +topics: + - accounts --- ### About scheduled reminders for users diff --git a/content/github/setting-up-and-managing-your-github-user-account/managing-your-theme-settings.md b/content/github/setting-up-and-managing-your-github-user-account/managing-your-theme-settings.md index 93091a6db3..609bb5e5a3 100644 --- a/content/github/setting-up-and-managing-your-github-user-account/managing-your-theme-settings.md +++ b/content/github/setting-up-and-managing-your-github-user-account/managing-your-theme-settings.md @@ -1,8 +1,10 @@ --- title: Managing your theme settings -intro: You can manage how {% data variables.product.product_name %} looks to you by setting a theme preference that either follows your system settings or always uses light mode or dark mode. +intro: 'You can manage how {% data variables.product.product_name %} looks to you by setting a theme preference that either follows your system settings or always uses light mode or dark mode.' versions: free-pro-team: '*' +topics: + - accounts --- {% note %} diff --git a/content/github/setting-up-and-managing-your-github-user-account/merging-multiple-user-accounts.md b/content/github/setting-up-and-managing-your-github-user-account/merging-multiple-user-accounts.md index 6939ca2d09..6882f942b3 100644 --- a/content/github/setting-up-and-managing-your-github-user-account/merging-multiple-user-accounts.md +++ b/content/github/setting-up-and-managing-your-github-user-account/merging-multiple-user-accounts.md @@ -7,6 +7,8 @@ redirect_from: - /articles/merging-multiple-user-accounts versions: free-pro-team: '*' +topics: + - accounts --- {% tip %} diff --git a/content/github/setting-up-and-managing-your-github-user-account/permission-levels-for-a-user-account-repository.md b/content/github/setting-up-and-managing-your-github-user-account/permission-levels-for-a-user-account-repository.md index 04f6dd83c5..1c52e2bd81 100644 --- a/content/github/setting-up-and-managing-your-github-user-account/permission-levels-for-a-user-account-repository.md +++ b/content/github/setting-up-and-managing-your-github-user-account/permission-levels-for-a-user-account-repository.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - accounts --- ### About permissions levels for a user account repository @@ -35,8 +37,9 @@ The repository owner has full control of the repository. In addition to the acti | Delete the repository | "[Deleting a repository](/github/administering-a-repository/deleting-a-repository)" | | Manage the repository's topics | "[Classifying your repository with topics](/github/administering-a-repository/classifying-your-repository-with-topics)" |{% if currentVersion == "free-pro-team@latest" %} | Manage security and analysis settings for the repository | "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)" |{% endif %}{% if currentVersion == "free-pro-team@latest" %} -| Enable the dependency graph for a private repository | "[Exploring the dependencies of a repository](/github/visualizing-repository-data-with-graphs/exploring-the-dependencies-of-a-repository#enabling-and-disabling-the-dependency-graph-for-a-private-repository)" |{% endif %}{% if currentVersion == "free-pro-team@latest" %} -| Delete packages | "[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package)" |{% endif %} +| Enable the dependency graph for a private repository | "[Exploring the dependencies of a repository](/github/visualizing-repository-data-with-graphs/exploring-the-dependencies-of-a-repository#enabling-and-disabling-the-dependency-graph-for-a-private-repository)" |{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} +| Delete and restore packages | "[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package)" |{% endif %}{% if currentVersion == "enterprise-server@2.22" or currentVersion == "enterprise-server@3.0" or currentVersion == "github-ae@latest" %} +| Delete packages | "[Deleting packages](/packages/learn-github-packages/deleting-a-package)" |{% endif %} | Customize the repository's social media preview | "[Customizing your repository's social media preview](/github/administering-a-repository/customizing-your-repositorys-social-media-preview)" | | Create a template from the repository | "[Creating a template repository](/github/creating-cloning-and-archiving-repositories/creating-a-template-repository)" |{% if currentVersion == "free-pro-team@latest" or enterpriseServerVersions contains currentVersion %} | Receive {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot_alerts %}{% else %}security alerts{% endif %} for vulnerable dependencies | "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)" |{% endif %}{% if currentVersion == "free-pro-team@latest" %} @@ -45,7 +48,7 @@ The repository owner has full control of the repository. In addition to the acti | Define code owners for the repository | "[About code owners](/github/creating-cloning-and-archiving-repositories/about-code-owners)" | | Archive the repository | "[About archiving repositories](/github/creating-cloning-and-archiving-repositories/about-archiving-repositories)" |{% if currentVersion == "free-pro-team@latest" %} | Create security advisories | "[About {% data variables.product.prodname_security_advisories %}](/github/managing-security-vulnerabilities/about-github-security-advisories)" | -| Display a sponsor button | "[Displaying a sponsor button in your repository](/github/administering-a-repository/displaying-a-sponsor-button-in-your-repository)" |{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} +| Display a sponsor button | "[Displaying a sponsor button in your repository](/github/administering-a-repository/displaying-a-sponsor-button-in-your-repository)" |{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@3.0" %} | Allow or disallow auto-merge for pull requests | "[Managing auto-merge for pull requests in your repository](/github/administering-a-repository/managing-auto-merge-for-pull-requests-in-your-repository)" | {% endif %} ### Collaborator access for a repository owned by a user account @@ -69,14 +72,14 @@ Collaborators can also perform the following actions. | Manage labels for issues and pull requests in the repository | "[Labeling issues and pull requests](/github/managing-your-work-on-github/labeling-issues-and-pull-requests)" | | Manage milestones for issues and pull requests in the repository | "[Creating and editing milestones for issues and pull requests](/github/managing-your-work-on-github/creating-and-editing-milestones-for-issues-and-pull-requests)" | | Mark an issue or pull request in the repository as a duplicate | "[About duplicate issues and pull requests](/github/managing-your-work-on-github/about-duplicate-issues-and-pull-requests)" | -| Create, merge, and close pull requests in the repository | "[Proposing changes to your work with pull requests](/github/collaborating-with-issues-and-pull-requests/proposing-changes-to-your-work-with-pull-requests)" |{% if currentVersion == "free-pro-team@latest" %} +| Create, merge, and close pull requests in the repository | "[Proposing changes to your work with pull requests](/github/collaborating-with-issues-and-pull-requests/proposing-changes-to-your-work-with-pull-requests)" |{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@3.0" %} | Enable and disable auto-merge for a pull request | "[Automatically merging a pull request](/github/collaborating-with-issues-and-pull-requests/automatically-merging-a-pull-request)"{% endif %} | Apply suggested changes to pull requests in the repository |"[Incorporating feedback in your pull request](/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request)" | | Create a pull request from a fork of the repository | "[Creating a pull request from a fork](/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork)" | | Submit a review on a pull request that affects the mergeability of the pull request | "[Reviewing proposed changes in a pull request](/github/collaborating-with-issues-and-pull-requests/reviewing-proposed-changes-in-a-pull-request)" | | Create and edit a wiki for the repository | "[About wikis](/github/building-a-strong-community/about-wikis)" | | Create and edit releases for the repository | "[Managing releases in a repository](/github/administering-a-repository/managing-releases-in-a-repository)" | -| Act as a code owner for the repository | "[About code owners](/articles/about-code-owners)" |{% if currentVersion == "free-pro-team@latest" %} +| Act as a code owner for the repository | "[About code owners](/articles/about-code-owners)" |{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" %} | Publish, view, or install packages | "[Publishing and managing packages](/github/managing-packages-with-github-packages/publishing-and-managing-packages)" |{% endif %} | Remove themselves as collaborators on the repository | "[Removing yourself from a collaborator's repository](/github/setting-up-and-managing-your-github-user-account/removing-yourself-from-a-collaborators-repository)" | diff --git a/content/github/setting-up-and-managing-your-github-user-account/permission-levels-for-user-owned-project-boards.md b/content/github/setting-up-and-managing-your-github-user-account/permission-levels-for-user-owned-project-boards.md index d77c697386..8c834e7dad 100644 --- a/content/github/setting-up-and-managing-your-github-user-account/permission-levels-for-user-owned-project-boards.md +++ b/content/github/setting-up-and-managing-your-github-user-account/permission-levels-for-user-owned-project-boards.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - accounts --- ### Permissions overview diff --git a/content/github/setting-up-and-managing-your-github-user-account/publicizing-or-hiding-organization-membership.md b/content/github/setting-up-and-managing-your-github-user-account/publicizing-or-hiding-organization-membership.md index 5eda5de372..97cdce17af 100644 --- a/content/github/setting-up-and-managing-your-github-user-account/publicizing-or-hiding-organization-membership.md +++ b/content/github/setting-up-and-managing-your-github-user-account/publicizing-or-hiding-organization-membership.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - accounts --- ![Profile organizations box](/assets/images/help/profile/profile_orgs_box.png) diff --git a/content/github/setting-up-and-managing-your-github-user-account/remembering-your-github-username-or-email.md b/content/github/setting-up-and-managing-your-github-user-account/remembering-your-github-username-or-email.md index d9e43ab812..a438da5c1b 100644 --- a/content/github/setting-up-and-managing-your-github-user-account/remembering-your-github-username-or-email.md +++ b/content/github/setting-up-and-managing-your-github-user-account/remembering-your-github-username-or-email.md @@ -8,6 +8,9 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '*' +topics: + - accounts + - notifications --- {% mac %} diff --git a/content/github/setting-up-and-managing-your-github-user-account/removing-a-collaborator-from-a-personal-repository.md b/content/github/setting-up-and-managing-your-github-user-account/removing-a-collaborator-from-a-personal-repository.md index 34e08f8885..a1aa21b439 100644 --- a/content/github/setting-up-and-managing-your-github-user-account/removing-a-collaborator-from-a-personal-repository.md +++ b/content/github/setting-up-and-managing-your-github-user-account/removing-a-collaborator-from-a-personal-repository.md @@ -13,6 +13,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - accounts + - repositories --- ### Deleting forks of private repositories diff --git a/content/github/setting-up-and-managing-your-github-user-account/removing-yourself-from-a-collaborators-repository.md b/content/github/setting-up-and-managing-your-github-user-account/removing-yourself-from-a-collaborators-repository.md index 5a5c84520d..aec4a67b0f 100644 --- a/content/github/setting-up-and-managing-your-github-user-account/removing-yourself-from-a-collaborators-repository.md +++ b/content/github/setting-up-and-managing-your-github-user-account/removing-yourself-from-a-collaborators-repository.md @@ -12,6 +12,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - accounts + - repositories --- {% data reusables.user_settings.access_settings %} diff --git a/content/github/setting-up-and-managing-your-github-user-account/removing-yourself-from-an-organization.md b/content/github/setting-up-and-managing-your-github-user-account/removing-yourself-from-an-organization.md index 0a90a82e59..8b37bf683b 100644 --- a/content/github/setting-up-and-managing-your-github-user-account/removing-yourself-from-an-organization.md +++ b/content/github/setting-up-and-managing-your-github-user-account/removing-yourself-from-an-organization.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - accounts --- {% if currentVersion == "free-pro-team@latest" %} diff --git a/content/github/setting-up-and-managing-your-github-user-account/requesting-organization-approval-for-oauth-apps.md b/content/github/setting-up-and-managing-your-github-user-account/requesting-organization-approval-for-oauth-apps.md index 1ffc7304d1..c4a4c40a9f 100644 --- a/content/github/setting-up-and-managing-your-github-user-account/requesting-organization-approval-for-oauth-apps.md +++ b/content/github/setting-up-and-managing-your-github-user-account/requesting-organization-approval-for-oauth-apps.md @@ -7,6 +7,8 @@ redirect_from: - /articles/requesting-organization-approval-for-oauth-apps versions: free-pro-team: '*' +topics: + - accounts --- ### Requesting organization approval for an {% data variables.product.prodname_oauth_app %} you've already authorized for your personal account diff --git a/content/github/setting-up-and-managing-your-github-user-account/setting-a-backup-email-address.md b/content/github/setting-up-and-managing-your-github-user-account/setting-a-backup-email-address.md index e43a3ba4e4..d29f41ccea 100644 --- a/content/github/setting-up-and-managing-your-github-user-account/setting-a-backup-email-address.md +++ b/content/github/setting-up-and-managing-your-github-user-account/setting-a-backup-email-address.md @@ -1,12 +1,15 @@ --- title: Setting a backup email address -intro: Use a backup email address as an additional destination for security-relevant account notifications{% if currentVersion != "github-ae@latest" %} and to securely reset your password if you can no longer access your primary email address{% endif %}. +intro: 'Use a backup email address as an additional destination for security-relevant account notifications{% if currentVersion != "github-ae@latest" %} and to securely reset your password if you can no longer access your primary email address{% endif %}.' redirect_from: - /articles/setting-a-backup-email-address versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - accounts + - notifications --- {% data reusables.user_settings.access_settings %} diff --git a/content/github/setting-up-and-managing-your-github-user-account/setting-your-commit-email-address.md b/content/github/setting-up-and-managing-your-github-user-account/setting-your-commit-email-address.md index efc2bc6f58..c2ee6b124f 100644 --- a/content/github/setting-up-and-managing-your-github-user-account/setting-your-commit-email-address.md +++ b/content/github/setting-up-and-managing-your-github-user-account/setting-your-commit-email-address.md @@ -14,6 +14,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - accounts + - notifications --- ### About commit email addresses diff --git a/content/github/setting-up-and-managing-your-github-user-account/types-of-emails-github-sends.md b/content/github/setting-up-and-managing-your-github-user-account/types-of-emails-github-sends.md index 48115cd1c3..6fcfee0db7 100644 --- a/content/github/setting-up-and-managing-your-github-user-account/types-of-emails-github-sends.md +++ b/content/github/setting-up-and-managing-your-github-user-account/types-of-emails-github-sends.md @@ -5,6 +5,9 @@ redirect_from: - /articles/types-of-emails-github-sends versions: free-pro-team: '*' +topics: + - accounts + - notifications --- ### Notification emails diff --git a/content/github/setting-up-and-managing-your-github-user-account/viewing-peoples-roles-in-an-organization.md b/content/github/setting-up-and-managing-your-github-user-account/viewing-peoples-roles-in-an-organization.md index 3e366d76a8..6e5cb96277 100644 --- a/content/github/setting-up-and-managing-your-github-user-account/viewing-peoples-roles-in-an-organization.md +++ b/content/github/setting-up-and-managing-your-github-user-account/viewing-peoples-roles-in-an-organization.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - accounts --- {% note %} diff --git a/content/github/setting-up-and-managing-your-github-user-account/what-does-the-available-for-hire-checkbox-do.md b/content/github/setting-up-and-managing-your-github-user-account/what-does-the-available-for-hire-checkbox-do.md index d6a14d6120..f878c2ad80 100644 --- a/content/github/setting-up-and-managing-your-github-user-account/what-does-the-available-for-hire-checkbox-do.md +++ b/content/github/setting-up-and-managing-your-github-user-account/what-does-the-available-for-hire-checkbox-do.md @@ -5,6 +5,8 @@ redirect_from: - /articles/what-does-the-available-for-hire-checkbox-do versions: free-pro-team: '*' +topics: + - accounts --- The [GitHub Jobs](https://jobs.github.com/) board is a great way to find employment in tech. You can opt to see jobs posted there on your GitHub dashboard. diff --git a/content/github/site-policy-deprecated/github-ae-data-protection-agreement.md b/content/github/site-policy-deprecated/github-ae-data-protection-agreement.md index 4d37fb38e9..191e7275f8 100644 --- a/content/github/site-policy-deprecated/github-ae-data-protection-agreement.md +++ b/content/github/site-policy-deprecated/github-ae-data-protection-agreement.md @@ -331,7 +331,7 @@ Data exporter: Customer is the data exporter. However, because the data importer provides storage services and does not control the categories of data it stores, the data exporter may choose to transfer special categories of data. Consequently, the data exporter is solely responsible for ensuring that it complies with all obligations imposed by applicable laws and regulations relating to the collection and processing of any special categories of data, including obtaining the explicit consent of the data subject prior to processing sensitive personal data. **Processing operations:** The personal data transferred will be subject to the following basic processing activities: -GitHub uses personal data for the limited purposes set forth in the GitHub Privacy Statement, available at https://help.github.com/articles/github-privacy-statement/, and the “Data Processing” section of the DPA. +GitHub uses personal data for the limited purposes set forth in the GitHub Privacy Statement, available at https://docs.github.com/articles/github-privacy-statement/, and the “Data Processing” section of the DPA. **Subcontractors:** In accordance with the DPA, the data importer may hire other companies to provide limited services on data importer’s behalf, such as providing customer support. Any such subcontractors will be permitted to obtain Customer Personal Data only to deliver the services the data importer has retained them to provide, and they are prohibited from using Customer Personal Data for any other purpose. diff --git a/content/github/site-policy/dmca-takedown-policy.md b/content/github/site-policy/dmca-takedown-policy.md index c73627ff5d..449c6d616c 100644 --- a/content/github/site-policy/dmca-takedown-policy.md +++ b/content/github/site-policy/dmca-takedown-policy.md @@ -8,6 +8,9 @@ redirect_from: - /articles/dmca-takedown-policy versions: free-pro-team: '*' +topics: + - policy + - legal --- Welcome to GitHub's Guide to the Digital Millennium Copyright Act, commonly known as the "DMCA." This page is not meant as a comprehensive primer to the statute. However, if you've received a DMCA takedown notice targeting content you've posted on GitHub or if you're a rights-holder looking to issue such a notice, this page will hopefully help to demystify the law a bit as well as our policies for complying with it. diff --git a/content/github/site-policy/github-acceptable-use-policies.md b/content/github/site-policy/github-acceptable-use-policies.md index 0ed0d7ec13..ff37a78d38 100644 --- a/content/github/site-policy/github-acceptable-use-policies.md +++ b/content/github/site-policy/github-acceptable-use-policies.md @@ -4,6 +4,9 @@ redirect_from: - /articles/github-acceptable-use-policies versions: free-pro-team: '*' +topics: + - policy + - legal --- **Short version:** _We host a wide variety of collaborative projects from all over the world, and that collaboration only works when our users are able to work together in good faith. While using the Service, you must comply with our Acceptable Use Policies, which include some restrictions on content you can post, conduct on the service, and other limitations. In short, be excellent to each other._ diff --git a/content/github/site-policy/github-additional-product-terms.md b/content/github/site-policy/github-additional-product-terms.md index 48b68a79f8..7c6d29ca79 100644 --- a/content/github/site-policy/github-additional-product-terms.md +++ b/content/github/site-policy/github-additional-product-terms.md @@ -2,6 +2,9 @@ title: GitHub Additional Product Terms versions: free-pro-team: '*' +topics: + - policy + - legal --- Version Effective Date: February 22, 2021 diff --git a/content/github/site-policy/github-and-trade-controls.md b/content/github/site-policy/github-and-trade-controls.md index aff71cd6e9..a8cbb44eb8 100644 --- a/content/github/site-policy/github-and-trade-controls.md +++ b/content/github/site-policy/github-and-trade-controls.md @@ -7,6 +7,9 @@ redirect_from: - /github/site-policy/github-and-export-controls versions: free-pro-team: '*' +topics: + - policy + - legal --- GitHub.com, GitHub Enterprise Server, and the information you upload to either product may be subject to trade control regulations, including under the U.S. Export Administration Regulations (the EAR). diff --git a/content/github/site-policy/github-anti-bribery-statement.md b/content/github/site-policy/github-anti-bribery-statement.md index 0b66ee43c5..b78ee543f6 100644 --- a/content/github/site-policy/github-anti-bribery-statement.md +++ b/content/github/site-policy/github-anti-bribery-statement.md @@ -4,6 +4,9 @@ redirect_from: - /articles/github-anti-bribery-statement versions: free-pro-team: '*' +topics: + - policy + - legal --- GitHub upholds our commitment to ethical business practices, including by prohibiting bribery and corruption. As [Transparency International](https://www.transparency.org/what-is-corruption#costs-of-corruption) explains, the costs of corruption are - **political**, by posing a major obstacle to democracy and the rule of law diff --git a/content/github/site-policy/github-bug-bounty-program-legal-safe-harbor.md b/content/github/site-policy/github-bug-bounty-program-legal-safe-harbor.md index 97bff67a75..0a63b70043 100644 --- a/content/github/site-policy/github-bug-bounty-program-legal-safe-harbor.md +++ b/content/github/site-policy/github-bug-bounty-program-legal-safe-harbor.md @@ -4,6 +4,9 @@ redirect_from: - /articles/github-bug-bounty-program-legal-safe-harbor versions: free-pro-team: '*' +topics: + - policy + - legal --- ### Summary diff --git a/content/github/site-policy/github-candidate-privacy-policy.md b/content/github/site-policy/github-candidate-privacy-policy.md new file mode 100644 index 0000000000..b329a301ed --- /dev/null +++ b/content/github/site-policy/github-candidate-privacy-policy.md @@ -0,0 +1,75 @@ +--- +title: GitHub Candidate Privacy Policy +versions: + free-pro-team: '*' +topics: + - policy + - legal +--- + +Effective Date: March 8, 2021 + +This GitHub Candidate Privacy Policy explains what information we collect about you during the application or recruitment process for employment with GitHub, as well as the purposes for which we collect and use that information. + +For the purposes of this policy: + +“Candidate” includes applicants and candidates who are part of the GitHub application or recruitment process; and + +"Candidate Personal Information" refers to any information we collect about one of our Candidates during the application or recruitment process which could, alone or together with other information, personally identify them or otherwise be reasonably linked or connected with them. + +This policy does not apply to the use of GitHub services, which are covered under our [GitHub Privacy Statement](/github/site-policy/github-privacy-statement). + +### What Candidate Personal Information do we collect? + +The Candidate Personal Information we collect, use, and maintain (or “process”) can include the following, but is not limited to: + +**Identification and contact information**, including your name, email address, phone number, location, GitHub profile, and any other information you provide (such as referrals and references). + +**National identifiers**, such as your citizenship status, residency and work permit status. + +**Employment and education history**, such as your resume or CV, cover letter, details of how you heard about the position you are applying for, information about any previous employment at GitHub or affiliates of GitHub, or other information you provide to us in support of an application and/or the application and recruitment process. + +**Professional or employment information**, including your desired salary or terms related to benefits, willingness to relocate, other job preferences, interview details, reference information and/or information received from background checks (where applicable), and information from publicly available resources (such as your LinkedIn profile or website). + +**Sensitive or demographic information**, such as your gender, medical or health information, veteran status, or your racial or ethnic origin. + +### How do we use the Candidate Personal Information we collect? + +We use the Candidate Personal Information for the following purposes: + - To assess your skills, qualifications and interests for employment opportunities with GitHub; + - To verify the information provided by you or others, including checking your references; + - To communicate with you about your application and the recruitment process, including informing you of other potential employment opportunities at GitHub; + - If you were referred, to inform the referrer of the status of your application; + - If you are offered a position, to prepare your offer letter and conduct a background check (to the extent permitted by applicable law); + - If you are offered a position and where requested by you, to assist you with obtaining an immigration visa or work permit; + - To comply with local laws, regulations, legal processes or enforceable government requests; and + - To prepare and submit reports as required under local laws and regulations; + - To manage and improve our application and recruitment process (such as making the application process more efficient and improving our diversity practices). + + ### How do we share your Candidate Personal Information? + +GitHub will share your Candidate Personal Information with those who have a legitimate business need for it. Whenever we permit a third party to access your Candidate Personal Information, we will make sure the information is used in a manner consistent with this policy. Your Candidate Personal Information may be shared with our affiliates (such as Microsoft) and other third parties (such as vendors) for the following purposes: +1. In order to carry out the uses of Candidate Personal Information described above; +2. To enable third parties to provide products or services to us or on our behalf (such as to facilitate the application process or conduct background checks). +3. To comply with our legal obligations, regulations or contracts, or to respond to a court order, administrative or judicial process (such as subpoena, government audit or search warrant) or, in response to lawful requests by public authorities (such as national security or law enforcement); +4. As necessary to establish, exercise, or defend against potential or pending litigation; +5. Where necessary to protect GitHub, your vital interests (such as safety and security), or those of another person; or +6. With your consent (such to contact your referees). It is your responsibility to obtain consent from referees before providing their personal information to GitHub. + +### Your rights to your Candidate Personal Information + +In some locations, Candidates may have certain rights under applicable local privacy laws (such as the European General Data Protection Regulation). However, regardless of your location, we provide the same high standard of privacy protection to all of our Candidates around the world. + +This includes the rights to request access or correct your information, request that your information be deleted, or object to or restrict GitHub from using it for certain purposes. + +You can make a request to do so by contacting privacy@github.com. We will respond to all requests in accordance with applicable data protection laws. + +### How long do we retain your Candidate Personal Information? + +Candidate Personal Information will be stored for one year after your application to comply with our legal obligations. After that time, we will contact you and ask for your consent to continue to retain your personal information so that we can consider you for any future job opportunities at GitHub. + +If you are hired for a position at GitHub, we will retain the information provided during the application and recruitment process as part of your employee record. + +### Changes to this Policy + +We may occasionally update this GitHub Candidate Privacy Policy. When we do make changes to this page, we will update the "last updated" date. diff --git a/content/github/site-policy/github-community-forum-code-of-conduct.md b/content/github/site-policy/github-community-forum-code-of-conduct.md index edffc306ec..aa9b32dd80 100644 --- a/content/github/site-policy/github-community-forum-code-of-conduct.md +++ b/content/github/site-policy/github-community-forum-code-of-conduct.md @@ -4,6 +4,9 @@ redirect_from: - /articles/github-community-forum-code-of-conduct versions: free-pro-team: '*' +topics: + - policy + - legal --- ### Overview and Purpose diff --git a/content/github/site-policy/github-community-guidelines.md b/content/github/site-policy/github-community-guidelines.md index 3e82aa45b7..29faa59f3b 100644 --- a/content/github/site-policy/github-community-guidelines.md +++ b/content/github/site-policy/github-community-guidelines.md @@ -5,6 +5,9 @@ redirect_from: - /articles/github-community-guidelines versions: free-pro-team: '*' +topics: + - policy + - legal --- Millions of developers host millions of projects on GitHub — both open and closed source — and we're honored to play a part in enabling collaboration across the community every day. Together, we all have an exciting opportunity and responsibility to make this a community we can be proud of. diff --git a/content/github/site-policy/github-corporate-terms-of-service.md b/content/github/site-policy/github-corporate-terms-of-service.md index 9139ffcb29..da405f50f0 100644 --- a/content/github/site-policy/github-corporate-terms-of-service.md +++ b/content/github/site-policy/github-corporate-terms-of-service.md @@ -4,6 +4,9 @@ redirect_from: - /articles/github-corporate-terms-of-service versions: free-pro-team: '*' +topics: + - policy + - legal --- THANK YOU FOR CHOOSING GITHUB FOR YOUR COMPANY’S BUSINESS NEEDS. PLEASE READ THIS AGREEMENT CAREFULLY AS IT GOVERNS USE OF THE PRODUCTS (AS DEFINED BELOW), UNLESS GITHUB HAS EXECUTED A SEPARATE WRITTEN AGREEMENT WITH CUSTOMER FOR THAT PURPOSE. diff --git a/content/github/site-policy/github-deceased-user-policy.md b/content/github/site-policy/github-deceased-user-policy.md index af27d5a37d..70a7a11a20 100644 --- a/content/github/site-policy/github-deceased-user-policy.md +++ b/content/github/site-policy/github-deceased-user-policy.md @@ -2,6 +2,9 @@ title: GitHub Deceased User Policy versions: free-pro-team: '*' +topics: + - policy + - legal --- In the event that a GitHub user passes away, we can work with an authorized individual to determine what happens to the account's content. diff --git a/content/github/site-policy/github-event-code-of-conduct.md b/content/github/site-policy/github-event-code-of-conduct.md index 9610d2f73e..c52346dc67 100644 --- a/content/github/site-policy/github-event-code-of-conduct.md +++ b/content/github/site-policy/github-event-code-of-conduct.md @@ -4,6 +4,9 @@ redirect_from: - /articles/github-event-code-of-conduct versions: free-pro-team: '*' +topics: + - policy + - legal --- GitHub events are community events intended for networking and collaboration in the tech community. diff --git a/content/github/site-policy/github-event-terms.md b/content/github/site-policy/github-event-terms.md index 6e8c43ce05..5145ee3b6c 100644 --- a/content/github/site-policy/github-event-terms.md +++ b/content/github/site-policy/github-event-terms.md @@ -4,6 +4,9 @@ redirect_from: - /articles/github-event-terms versions: free-pro-team: '*' +topics: + - policy + - legal --- By RSVP'ing to or attending a GitHub event, including any of the events or activities organized by GitHub in association with the GitHub event (collectively the "Event"), you signal that you have read, understand, and agree to the following Event Terms and Conditions. diff --git a/content/github/site-policy/github-gifts-and-entertainment-policy.md b/content/github/site-policy/github-gifts-and-entertainment-policy.md index 9cfae9d2b9..1daaf9078e 100644 --- a/content/github/site-policy/github-gifts-and-entertainment-policy.md +++ b/content/github/site-policy/github-gifts-and-entertainment-policy.md @@ -4,6 +4,9 @@ redirect_from: - /articles/github-gifts-and-entertainment-policy versions: free-pro-team: '*' +topics: + - policy + - legal --- GitHub recognizes that our business is built on positive and transparent relationships. While informal interactions and exchanges of gifts may be part of developing those relationships and may even be considered customary in some countries, we need to ensure that we’re following anti-bribery laws. We have a legal obligation to behave ethically, including by not using such interactions to create a special advantage or influence a deal. diff --git a/content/github/site-policy/github-government-takedown-policy.md b/content/github/site-policy/github-government-takedown-policy.md index 23c2723731..830528e58a 100644 --- a/content/github/site-policy/github-government-takedown-policy.md +++ b/content/github/site-policy/github-government-takedown-policy.md @@ -2,6 +2,9 @@ title: GitHub Government Takedown Policy versions: free-pro-team: '*' +topics: + - policy + - legal --- #### What is this? From time to time, GitHub receives requests from governments to remove content that has been declared unlawful in their local jurisdiction. Although we may not always agree with those laws, we may need to block content if we receive a complete request from a government official so that our users in that jurisdiction may continue to have access to GitHub to collaborate and build software. diff --git a/content/github/site-policy/github-gpl-cooperation-commitment.md b/content/github/site-policy/github-gpl-cooperation-commitment.md index b0129962bf..db08f7cc2f 100644 --- a/content/github/site-policy/github-gpl-cooperation-commitment.md +++ b/content/github/site-policy/github-gpl-cooperation-commitment.md @@ -4,6 +4,9 @@ redirect_from: - /articles/github-gpl-cooperation-commitment versions: free-pro-team: '*' +topics: + - policy + - legal --- This commitment pertains to GitHub contributions to Git, the Linux kernel, and other programs under covered licenses (scroll to the end for definitions). diff --git a/content/github/site-policy/github-insights-and-data-protection-for-your-organization.md b/content/github/site-policy/github-insights-and-data-protection-for-your-organization.md index 70d4eb12aa..a4b4d3fc5e 100644 --- a/content/github/site-policy/github-insights-and-data-protection-for-your-organization.md +++ b/content/github/site-policy/github-insights-and-data-protection-for-your-organization.md @@ -9,6 +9,9 @@ redirect_from: - /enterprise-server@2.20/github/site-policy/github-insights-and-data-protection-for-your-organization versions: free-pro-team: '*' +topics: + - policy + - legal --- For more information about the terms that govern {% data variables.product.prodname_insights %}, see your {% data variables.product.prodname_ghe_one %} subscription agreement. diff --git a/content/github/site-policy/github-logo-policy.md b/content/github/site-policy/github-logo-policy.md index 2e09b76469..ce0de00a56 100644 --- a/content/github/site-policy/github-logo-policy.md +++ b/content/github/site-policy/github-logo-policy.md @@ -6,6 +6,9 @@ redirect_from: - /articles/github-logo-policy versions: free-pro-team: '*' +topics: + - policy + - legal --- You can add {% data variables.product.prodname_dotcom %} logos to your website or third-party application in some scenarios. For more information and specific guidelines on logo usage, see the [{% data variables.product.prodname_dotcom %} Logos and Usage page](https://github.com/logos). diff --git a/content/github/site-policy/github-marketplace-developer-agreement.md b/content/github/site-policy/github-marketplace-developer-agreement.md index d92ec43248..1db5534558 100644 --- a/content/github/site-policy/github-marketplace-developer-agreement.md +++ b/content/github/site-policy/github-marketplace-developer-agreement.md @@ -4,6 +4,9 @@ redirect_from: - /articles/github-marketplace-developer-agreement versions: free-pro-team: '*' +topics: + - policy + - legal --- **THESE TERMS AND CONDITIONS (THE "AGREEMENT") GOVERN YOUR PARTICIPATION IN GITHUB’S MARKETPLACE PROGRAM. BY ENROLLING TO PARTICIPATE IN THE MARKETPLACE PROGRAM OR BY CLICKING “I ACCEPT” BELOW, YOU ARE CONFIRMING THAT YOU UNDERSTAND THIS AGREEMENT, AND THAT YOU ACCEPT ALL OF ITS TERMS AND CONDITIONS. IF YOU ARE ENTERING INTO THIS AGREEMENT ON BEHALF OF A COMPANY OR OTHER LEGAL ENTITY, YOU REPRESENT THAT YOU HAVE THE LEGAL AUTHORITY TO BIND THE ENTITY TO THIS AGREEMENT, IN WHICH CASE “YOU” WILL MEAN THE ENTITY YOU REPRESENT.** diff --git a/content/github/site-policy/github-marketplace-terms-of-service.md b/content/github/site-policy/github-marketplace-terms-of-service.md index 2d3b9ed203..63e80b6c36 100644 --- a/content/github/site-policy/github-marketplace-terms-of-service.md +++ b/content/github/site-policy/github-marketplace-terms-of-service.md @@ -4,6 +4,9 @@ redirect_from: - /articles/github-marketplace-terms-of-service versions: free-pro-team: '*' +topics: + - policy + - legal --- Welcome to GitHub Marketplace ("Marketplace")! We're happy you're here. Please read these Terms of Service ("Marketplace Terms") carefully before accessing or using GitHub Marketplace. GitHub Marketplace is a platform that allows you to select developer apps or actions (for free or for a charge) that can be used with your GitHub.com account ("Developer Products"). Although offered by GitHub, Inc. ("GitHub", "we", "us"), Developer Products may be developed and maintained by either GitHub or by third-party software providers. Your selection or use of Developer Products is subject to these Marketplace Terms and any applicable fees, and may require you to agree to additional terms as provided by the third party licensor of that Developer Product (the "Product Provider"). diff --git a/content/github/site-policy/github-open-source-applications-terms-and-conditions.md b/content/github/site-policy/github-open-source-applications-terms-and-conditions.md index 4b2b6ba059..d6f59db4b7 100644 --- a/content/github/site-policy/github-open-source-applications-terms-and-conditions.md +++ b/content/github/site-policy/github-open-source-applications-terms-and-conditions.md @@ -4,6 +4,9 @@ redirect_from: - /articles/github-open-source-applications-terms-and-conditions versions: free-pro-team: '*' +topics: + - policy + - legal --- These GitHub Open Source Applications Terms and Conditions ("Application Terms") are a legal agreement between you (either as an individual or on behalf of an entity) and GitHub, Inc. regarding your use of GitHub's applications, such as GitHub Desktop™ and associated documentation ("Software"). These Application Terms apply to the executable code version of the Software. Source code for the Software is available separately and free of charge under open source software license agreements. If you do not agree to all of the terms in these Application Terms, do not download, install, use, or copy the Software. diff --git a/content/github/site-policy/github-pre-release-program.md b/content/github/site-policy/github-pre-release-program.md index dc6f74153f..b9c0617da3 100644 --- a/content/github/site-policy/github-pre-release-program.md +++ b/content/github/site-policy/github-pre-release-program.md @@ -4,6 +4,9 @@ redirect_from: - /articles/github-pre-release-program versions: free-pro-team: '*' +topics: + - policy + - legal --- Thanks for signing up to participate in GitHub pre-release programs! As a trusted member of our community, your feedback on new and experimental features is important to us. In order to share these new products and services with you – many of which are still secret and in development – we’ll need you to agree to a special set of terms. Welcome to the Pre-release Program Agreement (“Agreement”). diff --git a/content/github/site-policy/github-privacy-statement.md b/content/github/site-policy/github-privacy-statement.md index 7dbbaa9dc1..52c319b8e4 100644 --- a/content/github/site-policy/github-privacy-statement.md +++ b/content/github/site-policy/github-privacy-statement.md @@ -9,6 +9,9 @@ redirect_from: - /articles/github-privacy-statement/ versions: free-pro-team: '*' +topics: + - policy + - legal --- Effective date: December 19, 2020 diff --git a/content/github/site-policy/github-private-information-removal-policy.md b/content/github/site-policy/github-private-information-removal-policy.md new file mode 100644 index 0000000000..f2afae3359 --- /dev/null +++ b/content/github/site-policy/github-private-information-removal-policy.md @@ -0,0 +1,91 @@ +--- +title: GitHub Private Information Removal Policy +redirect_from: + - /articles/github-sensitive-data-removal-policy + - /github/site-policy/github-sensitive-data-removal-policy +versions: + free-pro-team: '*' +topics: + - policy + - legal +--- + +We offer this private information removal process as an exceptional service only for high-risk content that violates [GitHub's Terms of Service](/github/site-policy/github-acceptable-use-policies#3-conduct-restrictions), such as when your security is at risk from exposed access credentials. This guide describes the information GitHub needs from you in order to process a request to remove private information from a repository. + +### What is Private Information? + +For the purposes of this document, “private information” refers to content that (i) should have been kept confidential, *and* (ii) whose public availability poses a specific or targeted security risk to you or your organization. + +"Security risk" refers to a situation involving exposure to physical danger, identity theft, or increased likelihood of unauthorized access to physical or network facilities. + +#### Private information removal requests are appropriate for: +- Access credentials, such as user names combined with passwords, access tokens, or other sensitive secrets that can grant access to your organization's server, network, or domain. +- AWS tokens and other similar access credentials that grant access to a third party on your behalf. You must be able to show that the token does belong to you. +- Documentation (such as network diagrams or architecture) that poses a specific security risk for an organization. +- [Information](/github/site-policy/github-community-guidelines#doxxing-and-invasion-of-privacy) related to, and posing a security risk to, you as an individual (such as social security numbers or other government identification numbers). + +#### Private information removal requests are _not_ appropriate for: +- Internal server names, IP addresses, and URLs, on their own. You must be able to show that their use in a particular file or piece of code poses a security threat. +- Mere mentions of your company's identity, name, brand, domain name, or other references to your company in files on GitHub. You must be able to articulate why a use of your company's identity is a threat to your company's security posture. +- Entire files or repositories that do not pose a specific security risk, but you believe are otherwise objectionable. +- Requests to remove content that may infringe your or your organization's copyright rights. If you have questions about how GitHub handles copyright-related matters or would like to report potentially infringing content, please review our [DMCA Takedown Policy](/articles/dmca-takedown-policy/). The private information removal process is generally not intended for the removal of full files or repositories — only for the specific pieces of private information in those files. While there may be cases where files are filled entirely with private information, you must justify the security risk for the removal of such files, and this may increase the time required to process your request. +- Trademark disputes. If you have questions about how GitHub handles trademark-related matters or would like to report content containing your organization's trade or service marks, please review our [Trademark Policy](/articles/github-trademark-policy/). +- Privacy complaints. If you wish to access, transfer, change, or delete your personal information on GitHub, please contact us via [our Privacy contact form](https://github.com/contact/privacy). +- Content governed by our [Community Guidelines](/articles/github-community-guidelines/), such as malware or general-purpose tools. If you have questions about our Community Guidelines or believe that content on GitHub might violate our guidelines, you can use {% data variables.contact.report_content %} to contact us. + +### Things to Know + +**Ask Nicely First.** A great first step before sending us a request to remove data is to try contacting the user directly. They may have listed contact information on their public profile page or in the repository's README or Support file, or you could get in touch by creating an issue or pull request in the repository. This is not strictly required, but it is appreciated. + +**No Bots.** You should have a trained professional evaluate the facts of every request you send. If you're outsourcing your efforts to a third party, make sure you know how they operate, and make sure they are not using automated bots to submit complaints in bulk. These complaints often include data that does not pose any security threats, and they do not include sufficient explanations, requiring additional back-and-forth and resulting in delays, even when the complaint is valid. + +**Send In The Correct Request.** As noted above, we offer this private information removal process as an exceptional service only for high-risk content. We are not able to use this process to remove other kinds of content, such as potentially infringing content, and we are not able to process any other kinds of removal requests simultaneously while processing private information removal requests. We will be able to help you more quickly if you send in your private information removal requests separately from any requests to remove potentially infringing content. If you are unsure whether your request involves only private information or also involves other legal matters, please consult legal counsel. + +**Processing Time.** While we do process private information removal requests as quickly as possible, due to the volume of requests we process, it may take some time for your request to be reviewed. Additional requests, or multiple requests from additional points of contact, may result in delays. + +### How Does This Actually Work? + +1. **Complainant Investigates.** It is up to the requesting party to conduct their own investigation and to provide us with the [details we require](#your-request-must-include) — most importantly, an explanation of how the data poses a security risk. GitHub is not in a position to search for or make initial determinations about private information on any individual's or organization's behalf. + +2. **Complainant Sends a Private Information Removal Request.** After conducting an investigation, the complainant prepares and [sends a private information removal request](#sending-a-private-information-removal-request) to GitHub. If the request is not sufficiently detailed to demonstrate the security risk and for GitHub to locate the data, we will reply and ask for more information. + +3. **GitHub Asks User to Make Changes.** In most cases, we will contact the user who created the repository and give them an opportunity to delete or modify the private information specified in the request or to dispute the claim. + +4. **User Notifies GitHub of Changes.** If the user chooses to make the specified changes, they must tell us so within the window of time they've been allowed. If they don't, we will disable the repository. If the user notifies us that they made changes, we will verify that the changes have been made and notify the complainant. + + OR + +5. **User May Dispute the Request.** If a user believes the content in question is not private information subject to this Policy, they may dispute it. If they do, we will generally leave it up to the complainant to contact the user and work things out with them directly, within reason. + +6. **Complainant Reviews Changes.** If the user makes changes, the complainant must review them. If the changes are insufficient, the complainant must provide GitHub with details explaining why. GitHub may disable the repository or give the user an additional chance to make the changes. + +7. **User May Request an Additional Window to Make Changes.** If the user missed their opportunity to remove the private information specified in the notice, we may allow them an additional window of approximately 1 business day, upon request, to make those changes. In that event, GitHub will notify the complainant. + +#### What About Forks? (or What's a Fork?) +One of the best features of GitHub is the ability for users to "fork" one another's repositories. What does that mean? In essence, it means that users can make a copy of a project on GitHub into their own repositories. As the license or the law allows, users can then make changes to that fork to either push back to the main project or just keep as their own variation of a project. Each of these copies is a "[fork](/articles/github-glossary/#fork)" of the original repository, which in turn may also be called the "parent" of the fork. + +GitHub will not automatically disable forks when disabling a parent repository. This is because forks belong to different users and may have been altered in significant ways. GitHub does not conduct any independent investigation into forks. We expect those sending private information removal requests to conduct that investigation and, if they believe that the forks also contain private information, expressly include forks in their request. + +If at the time that you submitted your notice, you identified all existing forks of that repository, we would process a valid claim against all forks in that network at the time we process the notice. We would do this given the likelihood that all newly created forks would contain the same content. In addition, if the reported network that contains the reported content is larger than one hundred (100) repositories and thus would be difficult to review in its entirety, we may consider disabling the entire network if you state in your notice that, based on the representative number of forks you have reviewed, you believe that all or most of the forks contain the content reported in the parent repository. + +### Sending A Private Information Removal Request + +Due to the type of content GitHub hosts (mostly software code) and the way that content is managed (with Git), we need complaints to be as specific as possible. In order for us to verify that a user has removed reported private information completely, we need to know exactly where to look. + +These guidelines are designed to make the processing of requests to remove private information as straightforward as possible. + +#### Your Request Must Include: + +1. A working, clickable link to each file containing private information. (Note that we're not able to work from search results, examples, or screenshots.) +2. Specific line numbers within each file containing the private information. +3. A brief description of how each item you've identified poses a security risk to you or your organization. ***It is important that you provide an explanation of how the data poses a security risk beyond merely stating that it does.*** +4. If you are a third party acting as an agent for an organization facing a security risk, include a statement that you have a legal right to act on behalf of that organization. +5. OPTIONAL: Let us know if your request is particularly urgent, and why. We respond to all private information removal requests as quickly as possible. However, if this request is especially time-sensitive, such as a very recent credential exposure, please explain why. + +### How to Submit Your Request + +You can submit your request to remove private information via our [contact form](https://support.github.com/contact?tags=docs-private-information). Please include a plain-text version of your request in the body of your message. Sending your request in an attachment may result in processing delays. + +### Disputes + +If you received a private information removal request from us, you can dispute it by replying to our email and letting us know — in as much detail as possible — why you think the content in question is not private information subject to this Policy. diff --git a/content/github/site-policy/github-registered-developer-agreement.md b/content/github/site-policy/github-registered-developer-agreement.md index a28e956a51..f3c3a6cde9 100644 --- a/content/github/site-policy/github-registered-developer-agreement.md +++ b/content/github/site-policy/github-registered-developer-agreement.md @@ -4,6 +4,9 @@ redirect_from: - /articles/github-registered-developer-agreement versions: free-pro-team: '*' +topics: + - policy + - legal --- GitHub is fortunate to have many developers integrating with our platform. We think that’s awesome, and we want to make that experience even better. GitHub’s Developer Program (the “Program”) helps us to connect with you, share information with you, and support your creative efforts better than ever before. The special relationship between GitHub and the developer community that the Program creates requires a special set of terms. Welcome to the Registered Developer Agreement (“Agreement”). diff --git a/content/github/site-policy/github-research-program-terms.md b/content/github/site-policy/github-research-program-terms.md index f16cccc3d9..cebfafa12d 100644 --- a/content/github/site-policy/github-research-program-terms.md +++ b/content/github/site-policy/github-research-program-terms.md @@ -4,6 +4,9 @@ redirect_from: - /articles/github-research-program-terms versions: free-pro-team: '*' +topics: + - policy + - legal --- Welcome to the GitHub Research Program (the "Program")! To participate, we’ll need you to agree to a special set of terms, the GitHub Research Program Agreement (“Agreement”). diff --git a/content/github/site-policy/github-sensitive-data-removal-policy.md b/content/github/site-policy/github-sensitive-data-removal-policy.md deleted file mode 100644 index bd37e5d322..0000000000 --- a/content/github/site-policy/github-sensitive-data-removal-policy.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -title: GitHub Sensitive Data Removal Policy -redirect_from: - - /articles/github-sensitive-data-removal-policy -versions: - free-pro-team: '*' ---- -If you believe that content on GitHub infringes a valid copyright you own, please see our [DMCA Takedown Policy](/articles/dmca-takedown-policy/) and our [Guide to Submitting a DMCA Takedown Notice](/articles/guide-to-submitting-a-dmca-takedown-notice/). We rely on the DMCA notice and takedown process for the majority of our removal actions. - -However, we understand that sensitive, security-related content may get published on GitHub – whether accidentally or on purpose – from time to time. We provide our sensitive data removal process to remove this sensitive data in certain exceptional circumstances where the DMCA process would not be applicable, such as when your security is at risk from exposed passwords and you do not own the copyright to the specific content that you need removed, or the content is not protectable by copyright. This guide describes the information GitHub needs from you in order to process a request to remove sensitive data from a repository. - -### What is Sensitive Data? - -For the purposes of this document, “sensitive data” refers to content that (i) should have been kept confidential, *and* (ii) whose public availability poses a specific or targeted security risk to you or your organization. - -#### Sensitive data removal requests are appropriate for: -- Access credentials, such as user names combined with passwords, access tokens, or other sensitive secrets that can grant access to your organization's server, network, or domain. -- AWS tokens and other similar access credentials that grant access to a third party on your behalf. You must be able to show that the token does belong to you. -- Documentation (such as network diagrams) that poses a specific security risk for an organization. Internal server names, IP addresses, and URLs, on their own, are not sufficiently sensitive; you must be able to show that the internal server name's use in a particular file or piece of code poses a security threat. - -#### Sensitive data removal requests are _not_ appropriate for: -- Requests to remove content that may infringe your or your organization's copyright rights. If you have questions about how GitHub handles copyright-related matters or would like to report potentially infringing content, please review our [DMCA Takedown Policy](/articles/dmca-takedown-policy/). The sensitive data removal process is generally not intended for the removal of full files or repositories — only for the specific pieces of sensitive data in those files. While there may be cases where files are filled entirely with sensitive information, you must justify the security risk for the removal of such files, and this may increase the time required to process your request. -- Trademark disputes. If you have questions about how GitHub handles trademark-related matters or would like to report content containing your organization's trade or service marks, please review our [Trademark Policy](/articles/github-trademark-policy/). -- Mere mentions of your company's identity, name, brand, domain name, or other references to your company in files on GitHub. You must be able to articulate why a use of your company's identity is a threat to your company's security posture before we will take action under this policy. -- Privacy complaints. If you have concerns about your own privacy or you are contacting us on behalf of your employees due to a privacy concern — for example, if there are private email addresses or other personal information posted — please contact us via [our Privacy contact form](https://github.com/contact/privacy). -- Entire files or repositories that do not pose a specific security risk, but you believe are otherwise objectionable. -- Content governed by our [Community Guidelines](/articles/github-community-guidelines/), such as malware or general-purpose tools. If you have questions about our Community Guidelines or believe that content on GitHub might violate our guidelines, you can use {% data variables.contact.report_content %} to contact us. - -### Things to Know - -**Ask Nicely First.** A great first step before sending us a request to remove data is to try contacting the user directly. They may have listed contact information on their public profile page or in the repository's README or Support file, or you could get in touch by creating an issue or pull request in the repository. This is not strictly required, but it is appreciated. - -**No Bots.** You should have a trained professional evaluate the facts of every request you send. If you're outsourcing your efforts to a third party, make sure you know how they operate, and make sure they are not using automated bots to submit complaints in bulk. These complaints often include data that does not pose any security threats, and they do not include sufficient explanations, requiring additional back-and-forth and resulting in delays, even when the complaint is valid. - -**Send In The Correct Request.** We offer this sensitive data removal process as an exceptional service only for high-risk content. We are not able to use this process to remove other kinds of content, such as potentially infringing content, and we are not able to process any other kinds of removal requests simultaneously while processing sensitive removal requests. We will be able to help you more quickly if you send in your sensitive data removal requests separately from any requests to remove potentially infringing content. If you are unsure whether your request involves only sensitive data or also involves other legal matters, please consult legal counsel. - -**Processing Time.** While we do process sensitive data removal requests as quickly as possible, due to the volume of requests we process, it may take some time for your request to be reviewed. Additional requests, or multiple requests from additional points of contact, may result in delays. - -### How Does This Actually Work? - -1. **Complainant Investigates.** It is up to the requesting party to conduct their own investigation and to provide us with the [details we require](#your-request-must-include) — most importantly, an explanation of how the data poses a security risk. GitHub is not in a position to search for or make initial determinations about sensitive data on any individual's or organization's behalf. - -2. **Complainant Sends a Sensitive Data Removal Request.** After conducting an investigation, the complainant prepares and [sends a sensitive data removal request](#sending-a-sensitive-data-removal-request) to GitHub. If the request is not sufficiently detailed to demonstrate the security risk and for GitHub to locate the data, we will reply and ask for more information. - -3. **GitHub Asks User to Make Changes.** In most cases, we will contact the user who created the repository and give them an opportunity to delete or modify the sensitive data specified in the request or to dispute the claim. - -4. **User Notifies GitHub of Changes.** If the user chooses to make the specified changes, they must tell us so within the window of time they've been allowed. If they don't, we will disable the repository. If the user notifies us that they made changes, we will verify that the changes have been made and notify the complainant. - - OR - -5. **User May Dispute the Request.** If a user believes the content in question is not sensitive data subject to this Policy, they may dispute it. If they do, we will generally leave it up to the complainant to contact the user and work things out with them directly, within reason. - -6. **Complainant Reviews Changes.** If the user makes changes, the complainant must review them. If the changes are insufficient, the complainant must provide GitHub with details explaining why. GitHub may disable the repository or give the user an additional chance to make the changes. - -7. **User May Request an Additional Window to Make Changes.** If the user missed their opportunity to remove the sensitive data specified in the notice, we may allow them an additional window of approximately 1 business day, upon request, to make those changes. In that event, GitHub will notify the complainant. - -#### What About Forks? (or What's a Fork?) -One of the best features of GitHub is the ability for users to "fork" one another's repositories. What does that mean? In essence, it means that users can make a copy of a project on GitHub into their own repositories. As the license or the law allows, users can then make changes to that fork to either push back to the main project or just keep as their own variation of a project. Each of these copies is a "[fork](/articles/github-glossary/#fork)" of the original repository, which in turn may also be called the "parent" of the fork. - -GitHub will not automatically disable forks when disabling a parent repository. This is because forks belong to different users and may have been altered in significant ways. GitHub does not conduct any independent investigation into forks. We expect those sending sensitive data removal requests to conduct that investigation and, if they believe that the forks also contain sensitive data, expressly include forks in their request. - -### Sending A Sensitive Data Removal Request - -Due to the type of content GitHub hosts (mostly software code) and the way that content is managed (with Git), we need complaints to be as specific as possible. In order for us to verify that a user has removed reported sensitive data completely, we need to know exactly where to look. - -These guidelines are designed to make the processing of requests to remove sensitive data as straightforward as possible. - -#### Your Request Must Include: - -1. A working, clickable link to each file containing sensitive data. (Note that we're not able to work from search results, examples, or screenshots.) -2. Specific line numbers within each file containing the sensitive data. -3. A brief description of how each item you've identified poses a security risk to you or your organization. ***It is important that you provide an explanation of how the data poses a security risk beyond merely stating that it does.*** -4. If you are a third party acting as an agent for an organization facing a security risk, include a statement that you have a legal right to act on behalf of that organization. -5. OPTIONAL: Let us know if your request is particularly urgent, and why. We respond to all sensitive data removal requests as quickly as possible. However, if this request is especially time-sensitive, such as a very recent credential exposure, please explain why. - -### How to Submit Your Request - -You can submit your request to remove sensitive data via our [contact form](https://support.github.com/contact?tags=docs-sensitive-data). Please include a plain-text version of your request in the body of your message. Sending your request in an attachment may result in processing delays. - -### Disputes - -If you received a sensitive data removal request from us, you can dispute it by replying to our email and letting us know — in as much detail as possible — why you think the content in question is not sensitive data subject to this Policy. diff --git a/content/github/site-policy/github-sponsors-additional-terms.md b/content/github/site-policy/github-sponsors-additional-terms.md index 343c68a35c..060865d633 100644 --- a/content/github/site-policy/github-sponsors-additional-terms.md +++ b/content/github/site-policy/github-sponsors-additional-terms.md @@ -4,6 +4,9 @@ redirect_from: - /articles/github-sponsors-additional-terms versions: free-pro-team: '*' +topics: + - policy + - legal --- Your participation in the GitHub Sponsors Program (the "Program") is subject to the [GitHub Terms of Service](/github/site-policy/github-terms-of-service) (the "Agreement"), as well as the following additional terms ("Additional Terms"). Any use of the GitHub Sponsors Program that violates the Agreement will also be a violation of these Additional Terms. Any capitalized terms used but not defined below have the meanings in the Agreement. These Additional Terms for the GitHub Sponsors Program describe the relationship between GitHub and you, the "Sponsored Developer", for the Program. The Additional Terms are effective as of the date you accept them ("Effective Date"). @@ -118,7 +121,7 @@ During the term, GitHub will remit to you all Sponsored Developer Payments recei - For newly created Sponsored Developer Accounts, GitHub will remit to you all Sponsored Developer Payments received in a given month within 90 days of the creation of your Sponsored Developer Account, subject to the variables below. Payments thereafter will be remitted within 30 days of the close of that month, in accordance with this section. -- If you are paid through Stripe Connect, you will receive payouts on the 22nd of the month for your balance at the end of the previous month, regardless of the amount of the balance. +- If you are paid through Stripe Connect, you will receive payouts on the 22nd of the month for the balance accrued since the last payout, regardless of the amount of the balance. Payout initiation dates vary by country, and can change from month to month due to public holidays, weekends, and other factors. - If you are paid through ACH transfer or wire transfer, you will receive payouts on the third Thursday of the month. GitHub will issue a payout to you for any month that your balance reaches $100 USD. Contributions from the GitHub Sponsors Matching Fund do not count towards this threshold. If your balance is below $100 at the end of the month, the balance will accrue until the next time your balance is above the threshold at the end of the month. If you leave GitHub Sponsors, GitHub will issue a payout for your remaining balance even if the balance is below $100. diff --git a/content/github/site-policy/github-statement-against-modern-slavery-and-child-labor.md b/content/github/site-policy/github-statement-against-modern-slavery-and-child-labor.md index 8d41be2fb7..9ca2aa38b1 100644 --- a/content/github/site-policy/github-statement-against-modern-slavery-and-child-labor.md +++ b/content/github/site-policy/github-statement-against-modern-slavery-and-child-labor.md @@ -4,6 +4,9 @@ redirect_from: - /articles/github-statement-against-modern-slavery-and-child-labor versions: free-pro-team: '*' +topics: + - policy + - legal --- *2018 statement* diff --git a/content/github/site-policy/github-subprocessors-and-cookies.md b/content/github/site-policy/github-subprocessors-and-cookies.md index fcb3e91945..c36e6115d1 100644 --- a/content/github/site-policy/github-subprocessors-and-cookies.md +++ b/content/github/site-policy/github-subprocessors-and-cookies.md @@ -8,6 +8,9 @@ redirect_from: - /articles/github-subprocessors-and-cookies versions: free-pro-team: '*' +topics: + - policy + - legal --- Effective date: **January 29, 2021** @@ -50,6 +53,7 @@ Since the number and names of cookies may change, the table below may be updated | Service Provider | Cookie Name | Description | Expiration* | |:---|:---|:---|:---| | GitHub | `app_manifest_token` | This cookie is used during the App Manifest flow to maintain the state of the flow during the redirect to fetch a user session. | five minutes | +| GitHub | `color_mode` | This cookie is used to indicate the user selected theme preference. | session | | GitHub | `_device_id` | This cookie is used to track recognized devices for security purposes. | one year | | GitHub | `dotcom_user` | This cookie is used to signal to us that the user is already logged in. | one year | | GitHub | `_gh_ent` | This cookie is used for temporary application and framework state between pages like what step the customer is on in a multiple step form. | two weeks | diff --git a/content/github/site-policy/github-terms-of-service.md b/content/github/site-policy/github-terms-of-service.md index db3a28ec38..77d9fc4fb5 100644 --- a/content/github/site-policy/github-terms-of-service.md +++ b/content/github/site-policy/github-terms-of-service.md @@ -8,6 +8,9 @@ redirect_from: - /articles/github-terms-of-service versions: free-pro-team: '*' +topics: + - policy + - legal --- Thank you for using GitHub! We're happy you're here. Please read this Terms of Service agreement carefully before accessing or using GitHub. Because it is such an important contract between us and our users, we have tried to make it as clear as possible. For your convenience, we have presented these terms in a short non-binding summary followed by the full legal terms. @@ -180,7 +183,7 @@ GitHub may offer subscription-based access to our API for those Users who requir Some Service features may be subject to additional terms specific to that feature or product as set forth in the GitHub Additional Product Terms. By accessing or using the Services, you also agree to the [GitHub Additional Product Terms](/github/site-policy/github-additional-product-terms). ### J. Beta Previews -**Short version:** *Beta Previews may not be supported or may change at any time, you may receive confidential information through those programs that must remain confidential while the program is private, and we'd love your feedback to make our Beta Previews better.* +**Short version:** *Beta Previews may not be supported or may change at any time. You may receive confidential information through those programs that must remain confidential while the program is private. We'd love your feedback to make our Beta Previews better.* #### 1. Subject to Change diff --git a/content/github/site-policy/github-trademark-policy.md b/content/github/site-policy/github-trademark-policy.md index e2dd80c88a..c1f4986beb 100644 --- a/content/github/site-policy/github-trademark-policy.md +++ b/content/github/site-policy/github-trademark-policy.md @@ -4,6 +4,9 @@ redirect_from: - /articles/github-trademark-policy versions: free-pro-team: '*' +topics: + - policy + - legal --- ### What is a GitHub Trademark Policy Violation? diff --git a/content/github/site-policy/github-username-policy.md b/content/github/site-policy/github-username-policy.md index 532399005d..89ef4713f9 100644 --- a/content/github/site-policy/github-username-policy.md +++ b/content/github/site-policy/github-username-policy.md @@ -5,6 +5,9 @@ redirect_from: - /articles/github-username-policy versions: free-pro-team: '*' +topics: + - policy + - legal --- GitHub account names are available on a first-come, first-served basis, and are intended for immediate and active use. diff --git a/content/github/site-policy/githubs-notice-about-the-california-consumer-privacy-act.md b/content/github/site-policy/githubs-notice-about-the-california-consumer-privacy-act.md index 0fa984fdf7..4506d018c8 100644 --- a/content/github/site-policy/githubs-notice-about-the-california-consumer-privacy-act.md +++ b/content/github/site-policy/githubs-notice-about-the-california-consumer-privacy-act.md @@ -2,6 +2,9 @@ title: GitHub's Notice about the California Consumer Privacy Act versions: free-pro-team: '*' +topics: + - policy + - legal --- Effective January 1, 2020 diff --git a/content/github/site-policy/global-privacy-practices.md b/content/github/site-policy/global-privacy-practices.md index 492baa42d6..a9a8e8c8ec 100644 --- a/content/github/site-policy/global-privacy-practices.md +++ b/content/github/site-policy/global-privacy-practices.md @@ -5,6 +5,9 @@ redirect_from: - /articles/global-privacy-practices versions: free-pro-team: '*' +topics: + - policy + - legal --- Effective date: July 22, 2020 diff --git a/content/github/site-policy/guide-to-submitting-a-dmca-counter-notice.md b/content/github/site-policy/guide-to-submitting-a-dmca-counter-notice.md index 67029fd81e..ec9f4459ed 100644 --- a/content/github/site-policy/guide-to-submitting-a-dmca-counter-notice.md +++ b/content/github/site-policy/guide-to-submitting-a-dmca-counter-notice.md @@ -6,6 +6,9 @@ redirect_from: - /articles/guide-to-submitting-a-dmca-counter-notice versions: free-pro-team: '*' +topics: + - policy + - legal --- This guide describes the information that GitHub needs in order to process a counter notice to a DMCA takedown request. If you have more general questions about what the DMCA is or how GitHub processes DMCA takedown requests, please review our [DMCA Takedown Policy](/articles/dmca-takedown-policy). diff --git a/content/github/site-policy/guide-to-submitting-a-dmca-takedown-notice.md b/content/github/site-policy/guide-to-submitting-a-dmca-takedown-notice.md index 78989d6112..63df89aedf 100644 --- a/content/github/site-policy/guide-to-submitting-a-dmca-takedown-notice.md +++ b/content/github/site-policy/guide-to-submitting-a-dmca-takedown-notice.md @@ -6,6 +6,9 @@ redirect_from: - /articles/guide-to-submitting-a-dmca-takedown-notice versions: free-pro-team: '*' +topics: + - policy + - legal --- This guide describes the information that GitHub needs in order to process a DMCA takedown request. If you have more general questions about what the DMCA is or how GitHub processes DMCA takedown requests, please review our [DMCA Takedown Policy](/articles/dmca-takedown-policy). diff --git a/content/github/site-policy/guidelines-for-legal-requests-of-user-data.md b/content/github/site-policy/guidelines-for-legal-requests-of-user-data.md index f045697c83..d5639fc952 100644 --- a/content/github/site-policy/guidelines-for-legal-requests-of-user-data.md +++ b/content/github/site-policy/guidelines-for-legal-requests-of-user-data.md @@ -5,6 +5,9 @@ redirect_from: - /articles/guidelines-for-legal-requests-of-user-data versions: free-pro-team: '*' +topics: + - policy + - legal --- Are you a law enforcement officer conducting an investigation that may involve user content hosted on GitHub? diff --git a/content/github/site-policy/index.md b/content/github/site-policy/index.md index 03094d4478..9d4e8b3ef8 100644 --- a/content/github/site-policy/index.md +++ b/content/github/site-policy/index.md @@ -5,6 +5,9 @@ redirect_from: - /categories/site-policy versions: free-pro-team: '*' +topics: + - policy + - legal --- @@ -24,7 +27,7 @@ versions: {% link_in_list /guide-to-submitting-a-dmca-takedown-notice %} {% link_in_list /guide-to-submitting-a-dmca-counter-notice %} {% link_in_list /github-trademark-policy %} -{% link_in_list /github-sensitive-data-removal-policy %} +{% link_in_list /github-private-information-removal-policy %} {% link_in_list /github-subprocessors-and-cookies %} {% link_in_list /github-bug-bounty-program-legal-safe-harbor %} {% link_in_list /responsible-disclosure-of-security-vulnerabilities %} @@ -44,6 +47,7 @@ versions: {% link_in_list /github-deceased-user-policy %} {% link_in_list /github-statement-against-modern-slavery-and-child-labor %} {% link_in_list /github-anti-bribery-statement %} +{% link_in_list /github-candidate-privacy-policy %} {% link_in_list /github-gifts-and-entertainment-policy %} {% link_in_list /github-event-terms %} {% link_in_list /github-event-code-of-conduct %} diff --git a/content/github/site-policy/responsible-disclosure-of-security-vulnerabilities.md b/content/github/site-policy/responsible-disclosure-of-security-vulnerabilities.md index 34dd98fa5d..35a5ae50cf 100644 --- a/content/github/site-policy/responsible-disclosure-of-security-vulnerabilities.md +++ b/content/github/site-policy/responsible-disclosure-of-security-vulnerabilities.md @@ -5,6 +5,9 @@ redirect_from: - /articles/responsible-disclosure-of-security-vulnerabilities versions: free-pro-team: '*' +topics: + - policy + - legal --- We want to keep GitHub safe for everyone. If you've discovered a security vulnerability in GitHub, we appreciate your help in disclosing it to us in a responsible manner. diff --git a/content/github/site-policy/submitting-content-removal-requests.md b/content/github/site-policy/submitting-content-removal-requests.md index ce08d27706..88c636f344 100644 --- a/content/github/site-policy/submitting-content-removal-requests.md +++ b/content/github/site-policy/submitting-content-removal-requests.md @@ -4,13 +4,16 @@ redirect_from: - /articles/submitting-content-removal-requests versions: free-pro-team: '*' +topics: + - policy + - legal --- -We understand that copyrighted, trademarked, or sensitive content may get published on GitHub – either accidentally or on purpose – sometimes in repositories that you do not own. Because the nature of this content varies, and because of different applicable laws, each category has its own, distinct reporting requirements outlined in our policies. +We understand that copyrighted, trademarked, or private content may get published on GitHub – either accidentally or on purpose – sometimes in repositories that you do not own. Because the nature of this content varies, and because of different applicable laws, each category has its own, distinct reporting requirements outlined in our policies. If you'd like to request that content be removed from GitHub, please take some time to acquaint yourself with each of these policies and their respective reporting requirements before submitting a report. If we receive an incomplete report, we'll need to ask for clarifications or revisions and you’ll need to re-submit a revised report. -Please note that we're not able to help you determine which policy is appropriate for your specific situation. If you’ve reviewed the policies below and still have questions about whether or not content should be reported as copyright, trademark, or sensitive data, we recommend consulting with independent legal counsel. +Please note that we're not able to help you determine which policy is appropriate for your specific situation. If you’ve reviewed the policies below and still have questions about whether or not content should be reported as copyright, trademark, or private information, we recommend consulting with independent legal counsel. ### [DMCA Takedown Policy](/articles/dmca-takedown-policy) The DMCA Takedown Policy can be used to report content that you believe infringes a copyright owned by you or your organization. Once you have reviewed the policy, you may also want to review our [Guide to Submitting a DMCA Takedown Notice](/articles/guide-to-submitting-a-dmca-takedown-notice/) before submitting a report. @@ -18,5 +21,5 @@ The DMCA Takedown Policy can be used to report content that you believe infringe ### [GitHub Trademark Policy](/articles/github-trademark-policy) The GitHub Trademark Policy can be used to report content that appears to use your company or business name, logo, or other trademark-protected materials in a manner that may mislead or confuse others about brand or business affiliation. -### [GitHub Sensitive Data Removal Policy](/articles/github-sensitive-data-removal-policy) -The GitHub Sensitive Data Removal Policy can be used to report data that is sensitive or confidential and poses a security risk, but that is not necessarily protected by copyright or trademark. +### [GitHub Private Information Removal Policy](/github/site-policy/github-private-information-removal-policy) +The GitHub Private Information Removal Policy can be used to report data that is private (confidential and poses a security risk), but that is not necessarily protected by copyright or trademark. diff --git a/content/github/supporting-the-open-source-community-with-github-sponsors/about-github-sponsors-for-open-source-contributors.md b/content/github/supporting-the-open-source-community-with-github-sponsors/about-github-sponsors-for-open-source-contributors.md index 003da8a970..567107b3e5 100644 --- a/content/github/supporting-the-open-source-community-with-github-sponsors/about-github-sponsors-for-open-source-contributors.md +++ b/content/github/supporting-the-open-source-community-with-github-sponsors/about-github-sponsors-for-open-source-contributors.md @@ -6,6 +6,8 @@ redirect_from: - /github/supporting-the-open-source-community-with-github-sponsors/about-github-sponsors-for-sponsored-developers versions: free-pro-team: '*' +topics: + - sponsors --- ### Joining {% data variables.product.prodname_sponsors %} diff --git a/content/github/supporting-the-open-source-community-with-github-sponsors/about-github-sponsors.md b/content/github/supporting-the-open-source-community-with-github-sponsors/about-github-sponsors.md index b3bb5af8c9..0169550a2d 100644 --- a/content/github/supporting-the-open-source-community-with-github-sponsors/about-github-sponsors.md +++ b/content/github/supporting-the-open-source-community-with-github-sponsors/about-github-sponsors.md @@ -5,6 +5,8 @@ redirect_from: - /articles/about-github-sponsors versions: free-pro-team: '*' +topics: + - sponsors --- ### About {% data variables.product.prodname_sponsors %} diff --git a/content/github/supporting-the-open-source-community-with-github-sponsors/attributing-sponsorships-to-your-organization.md b/content/github/supporting-the-open-source-community-with-github-sponsors/attributing-sponsorships-to-your-organization.md index 993701f37c..f85f61fdfc 100644 --- a/content/github/supporting-the-open-source-community-with-github-sponsors/attributing-sponsorships-to-your-organization.md +++ b/content/github/supporting-the-open-source-community-with-github-sponsors/attributing-sponsorships-to-your-organization.md @@ -1,9 +1,11 @@ --- title: Attributing sponsorships to your organization -intro: 'You can attribute the sponsorships paid by one of your organizations to another organization.' +intro: You can attribute the sponsorships paid by one of your organizations to another organization. versions: free-pro-team: '*' permissions: People who are organization owners of both organizations can attribute one organization's sponsorships to another organization. +topics: + - sponsors --- 1. Navigate to the organization whose sponsorships you want to attribute to another organization. @@ -14,4 +16,4 @@ permissions: People who are organization owners of both organizations can attrib 1. Under "Link sponsorships to another account", use the drop-down menu, then click the organization you want this organization's sponsorships to be attributed to. ![Drop-down menu to select account](/assets/images/help/sponsors/select-an-account-drop-down.png) 1. Click **Link account**. - !["Link account" button](/assets/images/help/sponsors/link-account-button.png) \ No newline at end of file + !["Link account" button](/assets/images/help/sponsors/link-account-button.png) diff --git a/content/github/supporting-the-open-source-community-with-github-sponsors/changing-your-sponsorship-tiers.md b/content/github/supporting-the-open-source-community-with-github-sponsors/changing-your-sponsorship-tiers.md index f9b176f55d..f6d6dc0bd7 100644 --- a/content/github/supporting-the-open-source-community-with-github-sponsors/changing-your-sponsorship-tiers.md +++ b/content/github/supporting-the-open-source-community-with-github-sponsors/changing-your-sponsorship-tiers.md @@ -5,6 +5,8 @@ redirect_from: - /articles/changing-your-sponsorship-tiers versions: free-pro-team: '*' +topics: + - sponsors --- ### About sponsorship tiers @@ -29,4 +31,4 @@ versions: {% data reusables.sponsors.edit-tier %} {% data reusables.sponsors.tier-price-description %} {% data reusables.sponsors.tier-update %} -{% data reusables.sponsors.retire-tier %} \ No newline at end of file +{% data reusables.sponsors.retire-tier %} diff --git a/content/github/supporting-the-open-source-community-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account.md b/content/github/supporting-the-open-source-community-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account.md index 0cae836a8f..861e9dd6de 100644 --- a/content/github/supporting-the-open-source-community-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account.md +++ b/content/github/supporting-the-open-source-community-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account.md @@ -3,6 +3,8 @@ title: Configuring webhooks for events in your sponsored account intro: You can configure webhooks to alert you when you receive new sponsorships or existing sponsors make changes to their sponsorships. versions: free-pro-team: '*' +topics: + - sponsors --- ### About webhooks for events in your sponsored account @@ -19,4 +21,4 @@ To monitor changes to your sponsorships, such as cancellations at the end of a p {% data reusables.sponsors.webhook-secret-token %} {% data reusables.sponsors.add-active-triggers %} {% data reusables.sponsors.confirm-add-webhook %} -{% data reusables.sponsors.manage-existing-webhooks %} \ No newline at end of file +{% data reusables.sponsors.manage-existing-webhooks %} diff --git a/content/github/supporting-the-open-source-community-with-github-sponsors/contacting-your-sponsors.md b/content/github/supporting-the-open-source-community-with-github-sponsors/contacting-your-sponsors.md index 640d965448..5b8efe069c 100644 --- a/content/github/supporting-the-open-source-community-with-github-sponsors/contacting-your-sponsors.md +++ b/content/github/supporting-the-open-source-community-with-github-sponsors/contacting-your-sponsors.md @@ -5,6 +5,8 @@ redirect_from: - /articles/contacting-your-sponsors versions: free-pro-team: '*' +topics: + - sponsors --- ### About sponsorship updates diff --git a/content/github/supporting-the-open-source-community-with-github-sponsors/editing-your-profile-details-for-github-sponsors.md b/content/github/supporting-the-open-source-community-with-github-sponsors/editing-your-profile-details-for-github-sponsors.md index 53004b7463..83b5544581 100644 --- a/content/github/supporting-the-open-source-community-with-github-sponsors/editing-your-profile-details-for-github-sponsors.md +++ b/content/github/supporting-the-open-source-community-with-github-sponsors/editing-your-profile-details-for-github-sponsors.md @@ -6,6 +6,8 @@ redirect_from: - /github/supporting-the-open-source-community-with-github-sponsors/editing-your-sponsored-developer-profile versions: free-pro-team: '*' +topics: + - sponsors --- ### About sponsor profiles @@ -23,4 +25,4 @@ Your {% data variables.product.prodname_sponsors %} profile tells potential spon {% data reusables.sponsors.add-introduction %} {% data reusables.sponsors.edit-featured-work %} {% data reusables.sponsors.opt-in-to-being-featured %} -{% data reusables.sponsors.save-profile %} \ No newline at end of file +{% data reusables.sponsors.save-profile %} diff --git a/content/github/supporting-the-open-source-community-with-github-sponsors/index.md b/content/github/supporting-the-open-source-community-with-github-sponsors/index.md index 48892ef8f2..6623eceb6b 100644 --- a/content/github/supporting-the-open-source-community-with-github-sponsors/index.md +++ b/content/github/supporting-the-open-source-community-with-github-sponsors/index.md @@ -6,6 +6,8 @@ redirect_from: - /categories/supporting-the-open-source-community-with-github-sponsors versions: free-pro-team: '*' +topics: + - sponsors --- diff --git a/content/github/supporting-the-open-source-community-with-github-sponsors/managing-your-payouts-from-github-sponsors.md b/content/github/supporting-the-open-source-community-with-github-sponsors/managing-your-payouts-from-github-sponsors.md index abfed9bd2c..caa1572855 100644 --- a/content/github/supporting-the-open-source-community-with-github-sponsors/managing-your-payouts-from-github-sponsors.md +++ b/content/github/supporting-the-open-source-community-with-github-sponsors/managing-your-payouts-from-github-sponsors.md @@ -5,6 +5,8 @@ redirect_from: - /articles/managing-your-payouts-from-github-sponsors versions: free-pro-team: '*' +topics: + - sponsors --- ### About payouts from {% data variables.product.prodname_sponsors %} @@ -17,4 +19,4 @@ You can only manage your payouts from {% data variables.product.prodname_sponsor {% data reusables.sponsors.navigate-to-sponsors-dashboard %} {% data reusables.sponsors.navigate-to-payouts-tab %} -{% data reusables.sponsors.edit-bank-information %} \ No newline at end of file +{% data reusables.sponsors.edit-bank-information %} diff --git a/content/github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship-goal.md b/content/github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship-goal.md index a4d3bdc206..1d9a6e18e3 100644 --- a/content/github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship-goal.md +++ b/content/github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship-goal.md @@ -3,6 +3,8 @@ title: Managing your sponsorship goal intro: You can set a goal for your sponsored developer or sponsored organization account to help the community understand the impact of sponsoring you. versions: free-pro-team: '*' +topics: + - sponsors --- ### About sponsorship goals diff --git a/content/github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship.md b/content/github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship.md index ad0e8d461d..2088f90c19 100644 --- a/content/github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship.md +++ b/content/github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship.md @@ -5,6 +5,8 @@ redirect_from: - /articles/managing-your-sponsorship versions: free-pro-team: '*' +topics: + - sponsors --- {% data reusables.sponsors.org-sponsors-release-phase %} @@ -32,4 +34,4 @@ You can choose whether an account you sponsor can send you email updates about t ### Further reading - "[Upgrading a sponsorship](/articles/upgrading-a-sponsorship)" -- "[Downgrading a sponsorship](/articles/downgrading-a-sponsorship)" \ No newline at end of file +- "[Downgrading a sponsorship](/articles/downgrading-a-sponsorship)" diff --git a/content/github/supporting-the-open-source-community-with-github-sponsors/overview.md b/content/github/supporting-the-open-source-community-with-github-sponsors/overview.md index f5271481a4..b068234cb2 100644 --- a/content/github/supporting-the-open-source-community-with-github-sponsors/overview.md +++ b/content/github/supporting-the-open-source-community-with-github-sponsors/overview.md @@ -4,5 +4,7 @@ intro: 'Learn about {% data variables.product.prodname_sponsors %} and how you c mapTopic: true versions: free-pro-team: '*' +topics: + - sponsors --- diff --git a/content/github/supporting-the-open-source-community-with-github-sponsors/receiving-sponsorships-through-github-sponsors.md b/content/github/supporting-the-open-source-community-with-github-sponsors/receiving-sponsorships-through-github-sponsors.md index 02aec92e58..fb2a1f92f9 100644 --- a/content/github/supporting-the-open-source-community-with-github-sponsors/receiving-sponsorships-through-github-sponsors.md +++ b/content/github/supporting-the-open-source-community-with-github-sponsors/receiving-sponsorships-through-github-sponsors.md @@ -8,5 +8,7 @@ redirect_from: - /github/supporting-the-open-source-community-with-github-sponsors/receiving-sponsorships-as-a-sponsored-developer versions: free-pro-team: '*' +topics: + - sponsors --- diff --git a/content/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-organization.md b/content/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-organization.md index 3d15b43662..5a7e674121 100644 --- a/content/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-organization.md +++ b/content/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-organization.md @@ -7,6 +7,8 @@ redirect_from: permissions: 'Organization owners can set up {% data variables.product.prodname_sponsors %} for an organization.' versions: free-pro-team: '*' +topics: + - sponsors --- ### Joining {% data variables.product.prodname_sponsors %} diff --git a/content/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-user-account.md b/content/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-user-account.md index 5b14699adc..6104ee4c03 100644 --- a/content/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-user-account.md +++ b/content/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-user-account.md @@ -6,6 +6,8 @@ redirect_from: - /github/supporting-the-open-source-community-with-github-sponsors/becoming-a-sponsored-developer versions: free-pro-team: '*' +topics: + - sponsors --- ### Joining {% data variables.product.prodname_sponsors %} diff --git a/content/github/supporting-the-open-source-community-with-github-sponsors/sponsoring-an-open-source-contributor.md b/content/github/supporting-the-open-source-community-with-github-sponsors/sponsoring-an-open-source-contributor.md index c51237a55c..c09ee905fb 100644 --- a/content/github/supporting-the-open-source-community-with-github-sponsors/sponsoring-an-open-source-contributor.md +++ b/content/github/supporting-the-open-source-community-with-github-sponsors/sponsoring-an-open-source-contributor.md @@ -8,6 +8,8 @@ redirect_from: versions: free-pro-team: '*' permissions: Anyone can sponsor accounts on behalf of their own user account. Organization owners and billing managers can sponsor accounts on behalf of their organization. +topics: + - sponsors --- {% data reusables.sponsors.org-sponsors-release-phase %} diff --git a/content/github/supporting-the-open-source-community-with-github-sponsors/sponsoring-open-source-contributors.md b/content/github/supporting-the-open-source-community-with-github-sponsors/sponsoring-open-source-contributors.md index dd52943a77..afbdabd06a 100644 --- a/content/github/supporting-the-open-source-community-with-github-sponsors/sponsoring-open-source-contributors.md +++ b/content/github/supporting-the-open-source-community-with-github-sponsors/sponsoring-open-source-contributors.md @@ -7,5 +7,7 @@ redirect_from: - /github/supporting-the-open-source-community-with-github-sponsors/sponsoring-open-source-developers versions: free-pro-team: '*' +topics: + - sponsors --- diff --git a/content/github/supporting-the-open-source-community-with-github-sponsors/tax-information-for-github-sponsors.md b/content/github/supporting-the-open-source-community-with-github-sponsors/tax-information-for-github-sponsors.md index 2f881fc29a..82ebe0fca0 100644 --- a/content/github/supporting-the-open-source-community-with-github-sponsors/tax-information-for-github-sponsors.md +++ b/content/github/supporting-the-open-source-community-with-github-sponsors/tax-information-for-github-sponsors.md @@ -6,6 +6,8 @@ redirect_from: - /github/supporting-the-open-source-community-with-github-sponsors/tax-information-for-sponsored-developers versions: free-pro-team: '*' +topics: + - sponsors --- If you are a taxpayer in the United States, you must submit a W-9 before you can receive payments. If you are a taxpayer in any other region besides the United States, you must submit a W-8BEN before you can receive payments. For more information, see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-user-account#submitting-your-tax-information)" and "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-organization#submitting-your-tax-information)." {% data variables.product.prodname_dotcom %} will send you the appropriate forms, notify you when they are due, and give you a reasonable amount of time to complete and send in the forms. diff --git a/content/github/supporting-the-open-source-community-with-github-sponsors/viewing-your-sponsors-and-sponsorships.md b/content/github/supporting-the-open-source-community-with-github-sponsors/viewing-your-sponsors-and-sponsorships.md index 20cf721790..79bd24bdcc 100644 --- a/content/github/supporting-the-open-source-community-with-github-sponsors/viewing-your-sponsors-and-sponsorships.md +++ b/content/github/supporting-the-open-source-community-with-github-sponsors/viewing-your-sponsors-and-sponsorships.md @@ -5,6 +5,8 @@ redirect_from: - /articles/viewing-your-sponsors-and-sponsorships versions: free-pro-team: '*' +topics: + - sponsors --- ### About sponsors and sponsorships @@ -31,4 +33,4 @@ You can export your sponsorship transactions by month. {% data variables.product 1. Click {% octicon "download" aria-label="The download icon" %} **Export**. ![Export button](/assets/images/help/sponsors/export-all.png) 1. Choose a time frame and a format for the data you'd like to export, then click **Start export**. - ![Options for data export](/assets/images/help/sponsors/export-your-sponsors.png) \ No newline at end of file + ![Options for data export](/assets/images/help/sponsors/export-your-sponsors.png) diff --git a/content/github/understanding-how-github-uses-and-protects-your-data/about-githubs-use-of-your-data.md b/content/github/understanding-how-github-uses-and-protects-your-data/about-githubs-use-of-your-data.md index 6f402fa285..d8c5ccd8f1 100644 --- a/content/github/understanding-how-github-uses-and-protects-your-data/about-githubs-use-of-your-data.md +++ b/content/github/understanding-how-github-uses-and-protects-your-data/about-githubs-use-of-your-data.md @@ -6,6 +6,9 @@ redirect_from: intro: '{% data variables.product.product_name %} uses your repository''s data to connect you to relevant tools, people, projects, and information.' versions: free-pro-team: '*' +topics: + - policy + - legal --- ### About {% data variables.product.product_name %}'s use of your data diff --git a/content/github/understanding-how-github-uses-and-protects-your-data/managing-data-use-settings-for-your-private-repository.md b/content/github/understanding-how-github-uses-and-protects-your-data/managing-data-use-settings-for-your-private-repository.md index 75069e955c..0c50b67417 100644 --- a/content/github/understanding-how-github-uses-and-protects-your-data/managing-data-use-settings-for-your-private-repository.md +++ b/content/github/understanding-how-github-uses-and-protects-your-data/managing-data-use-settings-for-your-private-repository.md @@ -6,6 +6,9 @@ redirect_from: - /github/understanding-how-github-uses-and-protects-your-data/opting-into-or-out-of-data-use-for-your-private-repository versions: free-pro-team: '*' +topics: + - policy + - legal --- ### About data use for your private repository @@ -14,8 +17,6 @@ When you enable data use for your private repository, you'll be able to access t ### Enabling or disabling data use features -{% data reusables.security.some-security-and-analysis-features-are-enabled-by-default %} - {% data reusables.security.security-and-analysis-features-enable-read-only %} {% data reusables.repositories.navigate-to-repo %} diff --git a/content/github/understanding-how-github-uses-and-protects-your-data/opting-into-or-out-of-the-github-archive-program-for-your-public-repository.md b/content/github/understanding-how-github-uses-and-protects-your-data/opting-into-or-out-of-the-github-archive-program-for-your-public-repository.md index 33b5ccc121..15b3026ba4 100644 --- a/content/github/understanding-how-github-uses-and-protects-your-data/opting-into-or-out-of-the-github-archive-program-for-your-public-repository.md +++ b/content/github/understanding-how-github-uses-and-protects-your-data/opting-into-or-out-of-the-github-archive-program-for-your-public-repository.md @@ -4,6 +4,9 @@ intro: 'You can manage whether {% data variables.product.prodname_dotcom %} incl permissions: 'People with admin permissions to a public repository can opt into or out of the {% data variables.product.prodname_archive %}.' versions: free-pro-team: '*' +topics: + - policy + - legal --- {% data reusables.repositories.about-github-archive-program %} For more information, see "[About archiving content and data on {% data variables.product.prodname_dotcom %}](/github/creating-cloning-and-archiving-repositories/about-archiving-content-and-data-on-github#about-the-github-archive-program)." diff --git a/content/github/understanding-how-github-uses-and-protects-your-data/requesting-an-archive-of-your-personal-accounts-data.md b/content/github/understanding-how-github-uses-and-protects-your-data/requesting-an-archive-of-your-personal-accounts-data.md index a04e115614..cbbff257f7 100644 --- a/content/github/understanding-how-github-uses-and-protects-your-data/requesting-an-archive-of-your-personal-accounts-data.md +++ b/content/github/understanding-how-github-uses-and-protects-your-data/requesting-an-archive-of-your-personal-accounts-data.md @@ -6,6 +6,9 @@ redirect_from: intro: '{% data reusables.user_settings.export-data %}' versions: free-pro-team: '*' +topics: + - policy + - legal --- {% data variables.product.product_name %} stores repository and profile metadata from your personal account's activity. You can export your personal account's data through settings on {% data variables.product.prodname_dotcom_the_website %} or with the User Migration API. diff --git a/content/github/using-git/updating-credentials-from-the-macos-keychain.md b/content/github/using-git/updating-credentials-from-the-macos-keychain.md index 6e76758512..f126ccd8c9 100644 --- a/content/github/using-git/updating-credentials-from-the-macos-keychain.md +++ b/content/github/using-git/updating-credentials-from-the-macos-keychain.md @@ -31,7 +31,7 @@ protocol=https > [Press Return] ``` -If it's successful, nothing will print out. To test that it works, try and clone a repository from {% data variables.product.product_location %}. If you are prompted for a password, the keychain entry was deleted. +If it's successful, nothing will print out. To test that it works, try and clone a private repository from {% data variables.product.product_location %}. If you are prompted for a password, the keychain entry was deleted. ### Further reading diff --git a/content/github/visualizing-repository-data-with-graphs/about-repository-graphs.md b/content/github/visualizing-repository-data-with-graphs/about-repository-graphs.md index 10a714d35b..d4ccc71ae2 100644 --- a/content/github/visualizing-repository-data-with-graphs/about-repository-graphs.md +++ b/content/github/visualizing-repository-data-with-graphs/about-repository-graphs.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- A repository's graphs give you information on {% if currentVersion == "free-pro-team@latest" %} traffic, projects that depend on the repository,{% endif %} contributors and commits to the repository, and a repository's forks and network. If you maintain a repository, you can use this data to get a better understanding of who's using your repository and why they're using it. diff --git a/content/github/visualizing-repository-data-with-graphs/about-the-dependency-graph.md b/content/github/visualizing-repository-data-with-graphs/about-the-dependency-graph.md index 1a66878f1a..626cd9509e 100644 --- a/content/github/visualizing-repository-data-with-graphs/about-the-dependency-graph.md +++ b/content/github/visualizing-repository-data-with-graphs/about-the-dependency-graph.md @@ -4,6 +4,8 @@ intro: 'Detailed information about the dependency graph, the ecosystems it suppo versions: free-pro-team: '*' enterprise-server: '*' +topics: + - repositories --- ### Dependency graph availability @@ -64,13 +66,16 @@ When the dependency graph is first enabled, any manifest and lock files for supp The recommended formats explicitly define which versions are used for all direct and all indirect dependencies. If you use these formats, your dependency graph is more accurate. It also reflects the current build set up and enables the dependency graph to report vulnerabilities in both direct and indirect dependencies.{% if currentVersion == "free-pro-team@latest" %} Indirect dependencies that are inferred from a manifest file (or equivalent) are excluded from the checks for vulnerable dependencies.{% endif %} +{% if currentVersion == "free-pro-team@latest" %}The ecosystems listed below are supported for the dependency graph, {% data variables.product.prodname_dependabot_alerts %}, and {% data variables.product.prodname_dependabot_security_updates %}.{% endif %} +{% if currentVersion ver_gt "enterprise-server@2.21" %}The ecosystems listed below are supported for the dependency graph and {% data variables.product.prodname_dependabot_alerts %}.{% endif %} + | Package manager | Languages | Recommended formats | All supported formats | | --- | --- | --- | ---| | Composer | PHP | `composer.lock` | `composer.json`, `composer.lock` | | `dotnet` CLI | .NET languages (C#, C++, F#, VB) | `.csproj`, `.vbproj`, `.nuspec`, `.vcxproj`, `.fsproj` | `.csproj`, `.vbproj`, `.nuspec`, `.vcxproj`, `.fsproj`, `packages.config` | | Maven | Java, Scala | `pom.xml` | `pom.xml` | | npm | JavaScript | `package-lock.json` | `package-lock.json`, `package.json`| -| Python PIP | Python | `requirements.txt`, `pipfile.lock` | `requirements.txt`, `pipfile.lock`, `setup.py`* | +| Python PIP | Python | `requirements.txt`, `pipfile.lock` | `requirements.txt`, `pipfile`, `pipfile.lock`, `setup.py`* | | RubyGems | Ruby | `Gemfile.lock` | `Gemfile.lock`, `Gemfile`, `*.gemspec` | | Yarn | JavaScript | `yarn.lock` | `package.json`, `yarn.lock` | diff --git a/content/github/visualizing-repository-data-with-graphs/accessing-basic-repository-data.md b/content/github/visualizing-repository-data-with-graphs/accessing-basic-repository-data.md index bf325418e0..b5f1e57168 100644 --- a/content/github/visualizing-repository-data-with-graphs/accessing-basic-repository-data.md +++ b/content/github/visualizing-repository-data-with-graphs/accessing-basic-repository-data.md @@ -8,5 +8,7 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- diff --git a/content/github/visualizing-repository-data-with-graphs/analyzing-changes-to-a-repositorys-content.md b/content/github/visualizing-repository-data-with-graphs/analyzing-changes-to-a-repositorys-content.md index 1bcc381a77..46548cb73a 100644 --- a/content/github/visualizing-repository-data-with-graphs/analyzing-changes-to-a-repositorys-content.md +++ b/content/github/visualizing-repository-data-with-graphs/analyzing-changes-to-a-repositorys-content.md @@ -10,5 +10,7 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- diff --git a/content/github/visualizing-repository-data-with-graphs/exploring-the-dependencies-of-a-repository.md b/content/github/visualizing-repository-data-with-graphs/exploring-the-dependencies-of-a-repository.md index c78fdbcd3f..8dad33dd99 100644 --- a/content/github/visualizing-repository-data-with-graphs/exploring-the-dependencies-of-a-repository.md +++ b/content/github/visualizing-repository-data-with-graphs/exploring-the-dependencies-of-a-repository.md @@ -10,6 +10,8 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '*' +topics: + - repositories --- ### Viewing the dependency graph diff --git a/content/github/visualizing-repository-data-with-graphs/index.md b/content/github/visualizing-repository-data-with-graphs/index.md index bbe4472b6b..a993301675 100644 --- a/content/github/visualizing-repository-data-with-graphs/index.md +++ b/content/github/visualizing-repository-data-with-graphs/index.md @@ -9,6 +9,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- diff --git a/content/github/visualizing-repository-data-with-graphs/listing-the-forks-of-a-repository.md b/content/github/visualizing-repository-data-with-graphs/listing-the-forks-of-a-repository.md index efe4b1170c..0a0cc5f54e 100644 --- a/content/github/visualizing-repository-data-with-graphs/listing-the-forks-of-a-repository.md +++ b/content/github/visualizing-repository-data-with-graphs/listing-the-forks-of-a-repository.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- Forks are listed alphabetically by the username of the person who forked the repository. You can click on the username to be redirected to the user's {% data variables.product.product_name %} profile page or click on the fork name to be redirected to the specific fork of the repository. diff --git a/content/github/visualizing-repository-data-with-graphs/understanding-connections-between-repositories.md b/content/github/visualizing-repository-data-with-graphs/understanding-connections-between-repositories.md index 3159e6eab6..4ebccd26f2 100644 --- a/content/github/visualizing-repository-data-with-graphs/understanding-connections-between-repositories.md +++ b/content/github/visualizing-repository-data-with-graphs/understanding-connections-between-repositories.md @@ -8,5 +8,7 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- diff --git a/content/github/visualizing-repository-data-with-graphs/viewing-a-projects-contributors.md b/content/github/visualizing-repository-data-with-graphs/viewing-a-projects-contributors.md index 2b091f4867..62b061ec2a 100644 --- a/content/github/visualizing-repository-data-with-graphs/viewing-a-projects-contributors.md +++ b/content/github/visualizing-repository-data-with-graphs/viewing-a-projects-contributors.md @@ -10,6 +10,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- ### About contributors diff --git a/content/github/visualizing-repository-data-with-graphs/viewing-a-repositorys-network.md b/content/github/visualizing-repository-data-with-graphs/viewing-a-repositorys-network.md index 9227b4a81d..12a6d53185 100644 --- a/content/github/visualizing-repository-data-with-graphs/viewing-a-repositorys-network.md +++ b/content/github/visualizing-repository-data-with-graphs/viewing-a-repositorys-network.md @@ -9,6 +9,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- ![Repository network graph](/assets/images/help/graphs/repo_network_graph.png) diff --git a/content/github/visualizing-repository-data-with-graphs/viewing-a-summary-of-repository-activity.md b/content/github/visualizing-repository-data-with-graphs/viewing-a-summary-of-repository-activity.md index e9bfbbaf20..a5e0b26677 100644 --- a/content/github/visualizing-repository-data-with-graphs/viewing-a-summary-of-repository-activity.md +++ b/content/github/visualizing-repository-data-with-graphs/viewing-a-summary-of-repository-activity.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- Commit co-authors are included in the commit activity summary if their commits were merged into the repository's default branch and they're in the top 15 users who have contributed the most commits. diff --git a/content/github/visualizing-repository-data-with-graphs/viewing-traffic-to-a-repository.md b/content/github/visualizing-repository-data-with-graphs/viewing-traffic-to-a-repository.md index 5597ba9682..022031753d 100644 --- a/content/github/visualizing-repository-data-with-graphs/viewing-traffic-to-a-repository.md +++ b/content/github/visualizing-repository-data-with-graphs/viewing-traffic-to-a-repository.md @@ -6,6 +6,8 @@ redirect_from: - /articles/viewing-traffic-to-a-repository versions: free-pro-team: '*' +topics: + - repositories --- You can navigate to referring sites, excluding search engines and {% data variables.product.product_name %} itself, from the links the specific paths were referred from. The popular content links to the specific content that generated traffic. diff --git a/content/github/visualizing-repository-data-with-graphs/visualizing-additions-and-deletions-to-content-in-a-repository.md b/content/github/visualizing-repository-data-with-graphs/visualizing-additions-and-deletions-to-content-in-a-repository.md index 547d43123b..36db23194d 100644 --- a/content/github/visualizing-repository-data-with-graphs/visualizing-additions-and-deletions-to-content-in-a-repository.md +++ b/content/github/visualizing-repository-data-with-graphs/visualizing-additions-and-deletions-to-content-in-a-repository.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- {% if currentVersion == "free-pro-team@latest" %} diff --git a/content/github/visualizing-repository-data-with-graphs/visualizing-commits-in-a-repository.md b/content/github/visualizing-repository-data-with-graphs/visualizing-commits-in-a-repository.md index 512af56ba8..1085f95882 100644 --- a/content/github/visualizing-repository-data-with-graphs/visualizing-commits-in-a-repository.md +++ b/content/github/visualizing-repository-data-with-graphs/visualizing-commits-in-a-repository.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- The top graph shows commits for the entire year by week. diff --git a/content/github/working-with-github-pages/about-custom-domains-and-github-pages.md b/content/github/working-with-github-pages/about-custom-domains-and-github-pages.md index 6e91515f92..e4df3a2b7f 100644 --- a/content/github/working-with-github-pages/about-custom-domains-and-github-pages.md +++ b/content/github/working-with-github-pages/about-custom-domains-and-github-pages.md @@ -9,6 +9,8 @@ redirect_from: product: '{% data reusables.gated-features.pages %}' versions: free-pro-team: '*' +topics: + - pages --- ### Supported custom domains diff --git a/content/github/working-with-github-pages/about-github-pages-and-jekyll.md b/content/github/working-with-github-pages/about-github-pages-and-jekyll.md index f846f7c244..29cb2ecc6a 100644 --- a/content/github/working-with-github-pages/about-github-pages-and-jekyll.md +++ b/content/github/working-with-github-pages/about-github-pages-and-jekyll.md @@ -22,6 +22,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pages --- ### About Jekyll diff --git a/content/github/working-with-github-pages/about-github-pages.md b/content/github/working-with-github-pages/about-github-pages.md index 71923497cc..fc1ad704c5 100644 --- a/content/github/working-with-github-pages/about-github-pages.md +++ b/content/github/working-with-github-pages/about-github-pages.md @@ -14,6 +14,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pages --- ### About {% data variables.product.prodname_pages %} diff --git a/content/github/working-with-github-pages/about-jekyll-build-errors-for-github-pages-sites.md b/content/github/working-with-github-pages/about-jekyll-build-errors-for-github-pages-sites.md index d472ee4b10..aaac77ac7d 100644 --- a/content/github/working-with-github-pages/about-jekyll-build-errors-for-github-pages-sites.md +++ b/content/github/working-with-github-pages/about-jekyll-build-errors-for-github-pages-sites.md @@ -10,6 +10,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pages --- ### About Jekyll build errors diff --git a/content/github/working-with-github-pages/adding-a-theme-to-your-github-pages-site-using-jekyll.md b/content/github/working-with-github-pages/adding-a-theme-to-your-github-pages-site-using-jekyll.md index 8d27177055..99062c6ee8 100644 --- a/content/github/working-with-github-pages/adding-a-theme-to-your-github-pages-site-using-jekyll.md +++ b/content/github/working-with-github-pages/adding-a-theme-to-your-github-pages-site-using-jekyll.md @@ -10,6 +10,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pages --- People with write permissions for a repository can add a theme to a {% data variables.product.prodname_pages %} site using Jekyll. diff --git a/content/github/working-with-github-pages/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser.md b/content/github/working-with-github-pages/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser.md index 54505770e5..c7ffa5b088 100644 --- a/content/github/working-with-github-pages/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser.md +++ b/content/github/working-with-github-pages/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser.md @@ -8,6 +8,8 @@ redirect_from: product: '{% data reusables.gated-features.pages %}' versions: free-pro-team: '*' +topics: + - pages --- People with admin permissions for a repository can use the theme chooser to add a theme to a {% data variables.product.prodname_pages %} site. diff --git a/content/github/working-with-github-pages/adding-content-to-your-github-pages-site-using-jekyll.md b/content/github/working-with-github-pages/adding-content-to-your-github-pages-site-using-jekyll.md index 26e7f87d19..bf7966fab7 100644 --- a/content/github/working-with-github-pages/adding-content-to-your-github-pages-site-using-jekyll.md +++ b/content/github/working-with-github-pages/adding-content-to-your-github-pages-site-using-jekyll.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pages --- People with write permissions for a repository can add content to a {% data variables.product.prodname_pages %} site using Jekyll. diff --git a/content/github/working-with-github-pages/changing-the-visibility-of-your-github-pages-site.md b/content/github/working-with-github-pages/changing-the-visibility-of-your-github-pages-site.md index 8f5f5a099d..bf7722bc93 100644 --- a/content/github/working-with-github-pages/changing-the-visibility-of-your-github-pages-site.md +++ b/content/github/working-with-github-pages/changing-the-visibility-of-your-github-pages-site.md @@ -11,7 +11,14 @@ permissions: People with admin permissions for a repository can change the visib If your project site is published from a private or internal repository that's owned by an organization using {% data variables.product.prodname_ghe_cloud %}, you can manage access control for the site. With access control, you can choose to publish the site publicly to anyone on the internet or privately to people with read access to your repository. A privately published site can be used to share your internal documentation or knowledge base with members of your enterprise. You cannot manage access control for an organization site. For more information about the types of {% data variables.product.prodname_pages %} sites, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages#types-of-github-pages-sites)." -Privately published sites are available at a different subdomain than publicly published sites. You can see your site's URL in the repository settings. If you're using a static site generator configured to build the site with the repository name as a path, you may need to update the settings for the static site generator when changing the site to private. For more information, see "[Configuring Jekyll in your {% data variables.product.prodname_pages %} site](/github/working-with-github-pages/managing-a-custom-domain-for-your-github-pages-site#configuring-a-subdomain)" or the documentation for your static site generator. +Privately published sites are available at a different subdomain than publicly published sites. This ensures that your {% data variables.product.prodname_pages %} site is secure from the moment it's published: + +- We automatically secure every subdomain of `*.pages.github.io` with a TLS certificate, and enforce HSTS to ensure that browsers always serve the page over HTTPS. +- We use a unique subdomain for the private page to ensure that other repositories in your organization cannot publish content on the same origin as the private page. This protects your private page from "[cookie tossing](https://github.blog/2013-04-09-yummy-cookies-across-domains/)". This is also why we don't host {% data variables.product.prodname_pages %} sites on the `github.com` domain. + +You can see your site's unique subdomain in the pages tab of your repository settings. If you're using a static site generator configured to build the site with the repository name as a path, you may need to update the settings for the static site generator when changing the site to private. For more information, see "[Configuring Jekyll in your {% data variables.product.prodname_pages %} site](/github/working-with-github-pages/managing-a-custom-domain-for-your-github-pages-site#configuring-a-subdomain)" or the documentation for your static site generator. + +To use a shorter and more memorable domain for your private {% data variables.product.prodname_pages %} site, you can configure a custom domain. For more information, see "[Configuring a custom domain for your {% data variables.product.prodname_pages %} site](/github/working-with-github-pages/configuring-a-custom-domain-for-your-github-pages-site)." ### Changing the visibility of your {% data variables.product.prodname_pages %} site diff --git a/content/github/working-with-github-pages/configuring-a-custom-domain-for-your-github-pages-site.md b/content/github/working-with-github-pages/configuring-a-custom-domain-for-your-github-pages-site.md index b61565f5a4..59a714c5d8 100644 --- a/content/github/working-with-github-pages/configuring-a-custom-domain-for-your-github-pages-site.md +++ b/content/github/working-with-github-pages/configuring-a-custom-domain-for-your-github-pages-site.md @@ -14,5 +14,7 @@ product: '{% data reusables.gated-features.pages %}' mapTopic: true versions: free-pro-team: '*' +topics: + - pages --- diff --git a/content/github/working-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site.md b/content/github/working-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site.md index 03b0b70f08..34fa16eaba 100644 --- a/content/github/working-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site.md +++ b/content/github/working-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site.md @@ -10,6 +10,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pages --- For more information about publishing sources, see "[About {% data variables.product.prodname_pages %}](/articles/about-github-pages#publishing-sources-for-github-pages-sites)." diff --git a/content/github/working-with-github-pages/creating-a-custom-404-page-for-your-github-pages-site.md b/content/github/working-with-github-pages/creating-a-custom-404-page-for-your-github-pages-site.md index e64b467d98..b4d87e69b1 100644 --- a/content/github/working-with-github-pages/creating-a-custom-404-page-for-your-github-pages-site.md +++ b/content/github/working-with-github-pages/creating-a-custom-404-page-for-your-github-pages-site.md @@ -9,6 +9,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pages --- {% data reusables.pages.navigate-site-repo %} diff --git a/content/github/working-with-github-pages/creating-a-github-pages-site-with-jekyll.md b/content/github/working-with-github-pages/creating-a-github-pages-site-with-jekyll.md index a6857aa6ed..bf7f5f5cb1 100644 --- a/content/github/working-with-github-pages/creating-a-github-pages-site-with-jekyll.md +++ b/content/github/working-with-github-pages/creating-a-github-pages-site-with-jekyll.md @@ -9,6 +9,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pages --- {% data reusables.pages.org-owners-can-restrict-pages-creation %} diff --git a/content/github/working-with-github-pages/creating-a-github-pages-site.md b/content/github/working-with-github-pages/creating-a-github-pages-site.md index d8d0f6a57d..07106d9952 100644 --- a/content/github/working-with-github-pages/creating-a-github-pages-site.md +++ b/content/github/working-with-github-pages/creating-a-github-pages-site.md @@ -12,6 +12,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pages --- {% data reusables.pages.org-owners-can-restrict-pages-creation %} diff --git a/content/github/working-with-github-pages/getting-started-with-github-pages.md b/content/github/working-with-github-pages/getting-started-with-github-pages.md index 2c570f5de4..12d5e61d51 100644 --- a/content/github/working-with-github-pages/getting-started-with-github-pages.md +++ b/content/github/working-with-github-pages/getting-started-with-github-pages.md @@ -11,5 +11,7 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pages --- diff --git a/content/github/working-with-github-pages/index.md b/content/github/working-with-github-pages/index.md index 23e60f9646..3580a1e6b2 100644 --- a/content/github/working-with-github-pages/index.md +++ b/content/github/working-with-github-pages/index.md @@ -15,6 +15,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pages --- diff --git a/content/github/working-with-github-pages/managing-a-custom-domain-for-your-github-pages-site.md b/content/github/working-with-github-pages/managing-a-custom-domain-for-your-github-pages-site.md index 52661f89b4..da288d5eab 100644 --- a/content/github/working-with-github-pages/managing-a-custom-domain-for-your-github-pages-site.md +++ b/content/github/working-with-github-pages/managing-a-custom-domain-for-your-github-pages-site.md @@ -13,6 +13,8 @@ redirect_from: product: '{% data reusables.gated-features.pages %}' versions: free-pro-team: '*' +topics: + - pages --- People with admin permissions for a repository can configure a custom domain for a {% data variables.product.prodname_pages %} site. diff --git a/content/github/working-with-github-pages/securing-your-github-pages-site-with-https.md b/content/github/working-with-github-pages/securing-your-github-pages-site-with-https.md index 5b4d1ccac3..8fde3a5ee5 100644 --- a/content/github/working-with-github-pages/securing-your-github-pages-site-with-https.md +++ b/content/github/working-with-github-pages/securing-your-github-pages-site-with-https.md @@ -6,6 +6,8 @@ redirect_from: - /articles/securing-your-github-pages-site-with-https versions: free-pro-team: '*' +topics: + - pages --- People with admin permissions for a repository can enforce HTTPS for a {% data variables.product.prodname_pages %} site. diff --git a/content/github/working-with-github-pages/setting-a-markdown-processor-for-your-github-pages-site-using-jekyll.md b/content/github/working-with-github-pages/setting-a-markdown-processor-for-your-github-pages-site-using-jekyll.md index 93c5e1e0d6..aec7dde42f 100644 --- a/content/github/working-with-github-pages/setting-a-markdown-processor-for-your-github-pages-site-using-jekyll.md +++ b/content/github/working-with-github-pages/setting-a-markdown-processor-for-your-github-pages-site-using-jekyll.md @@ -10,6 +10,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pages --- People with write permissions for a repository can set the Markdown processor for a {% data variables.product.prodname_pages %} site. diff --git a/content/github/working-with-github-pages/setting-up-a-github-pages-site-with-jekyll.md b/content/github/working-with-github-pages/setting-up-a-github-pages-site-with-jekyll.md index b1ec8358fd..6f204fdb8a 100644 --- a/content/github/working-with-github-pages/setting-up-a-github-pages-site-with-jekyll.md +++ b/content/github/working-with-github-pages/setting-up-a-github-pages-site-with-jekyll.md @@ -11,5 +11,7 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pages --- diff --git a/content/github/working-with-github-pages/testing-your-github-pages-site-locally-with-jekyll.md b/content/github/working-with-github-pages/testing-your-github-pages-site-locally-with-jekyll.md index 283cb86b68..d24b5f19f7 100644 --- a/content/github/working-with-github-pages/testing-your-github-pages-site-locally-with-jekyll.md +++ b/content/github/working-with-github-pages/testing-your-github-pages-site-locally-with-jekyll.md @@ -10,6 +10,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pages --- Anyone with read permissions for a repository can test a {% data variables.product.prodname_pages %} site locally. diff --git a/content/github/working-with-github-pages/troubleshooting-custom-domains-and-github-pages.md b/content/github/working-with-github-pages/troubleshooting-custom-domains-and-github-pages.md index 132048eabb..1c6c9279c0 100644 --- a/content/github/working-with-github-pages/troubleshooting-custom-domains-and-github-pages.md +++ b/content/github/working-with-github-pages/troubleshooting-custom-domains-and-github-pages.md @@ -9,6 +9,8 @@ redirect_from: product: '{% data reusables.gated-features.pages %}' versions: free-pro-team: '*' +topics: + - pages --- ### _CNAME_ errors diff --git a/content/github/working-with-github-pages/troubleshooting-jekyll-build-errors-for-github-pages-sites.md b/content/github/working-with-github-pages/troubleshooting-jekyll-build-errors-for-github-pages-sites.md index 22f7e9a648..9d5eb1717f 100644 --- a/content/github/working-with-github-pages/troubleshooting-jekyll-build-errors-for-github-pages-sites.md +++ b/content/github/working-with-github-pages/troubleshooting-jekyll-build-errors-for-github-pages-sites.md @@ -29,6 +29,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pages --- ### Troubleshooting build errors diff --git a/content/github/working-with-github-pages/unpublishing-a-github-pages-site.md b/content/github/working-with-github-pages/unpublishing-a-github-pages-site.md index 7fbd610e00..912cc52b6f 100644 --- a/content/github/working-with-github-pages/unpublishing-a-github-pages-site.md +++ b/content/github/working-with-github-pages/unpublishing-a-github-pages-site.md @@ -13,6 +13,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pages --- ### Unpublishing a project site diff --git a/content/github/working-with-github-pages/using-submodules-with-github-pages.md b/content/github/working-with-github-pages/using-submodules-with-github-pages.md index f3dd9add82..a68562a1ce 100644 --- a/content/github/working-with-github-pages/using-submodules-with-github-pages.md +++ b/content/github/working-with-github-pages/using-submodules-with-github-pages.md @@ -7,6 +7,8 @@ redirect_from: product: '{% data reusables.gated-features.pages %}' versions: free-pro-team: '*' +topics: + - pages --- If the repository for your {% data variables.product.prodname_pages %} site contains submodules, their contents will automatically be pulled in when your site is built. diff --git a/content/github/working-with-github-support/about-github-premium-support-for-github-enterprise-cloud.md b/content/github/working-with-github-support/about-github-premium-support-for-github-enterprise-cloud.md index 37248a0158..82c8aa865b 100644 --- a/content/github/working-with-github-support/about-github-premium-support-for-github-enterprise-cloud.md +++ b/content/github/working-with-github-support/about-github-premium-support-for-github-enterprise-cloud.md @@ -6,6 +6,8 @@ redirect_from: - /articles/about-github-premium-support-for-github-enterprise-cloud versions: free-pro-team: '*' +topics: + - jobs --- {% note %} diff --git a/content/github/working-with-github-support/about-github-support.md b/content/github/working-with-github-support/about-github-support.md index d99fa74258..88a7af7ff5 100644 --- a/content/github/working-with-github-support/about-github-support.md +++ b/content/github/working-with-github-support/about-github-support.md @@ -5,6 +5,8 @@ redirect_from: - /articles/about-github-support versions: free-pro-team: '*' +topics: + - jobs --- ### About {% data variables.contact.github_support %} diff --git a/content/github/working-with-github-support/github-enterprise-cloud-support.md b/content/github/working-with-github-support/github-enterprise-cloud-support.md index 2fbdf674e3..412a41aeca 100644 --- a/content/github/working-with-github-support/github-enterprise-cloud-support.md +++ b/content/github/working-with-github-support/github-enterprise-cloud-support.md @@ -7,6 +7,8 @@ redirect_from: intro: '{% data variables.product.prodname_ghe_cloud %} includes a target eight-hour response time for priority support requests, Monday to Friday in your local time zone.' versions: free-pro-team: '*' +topics: + - jobs --- {% note %} diff --git a/content/github/working-with-github-support/github-marketplace-support.md b/content/github/working-with-github-support/github-marketplace-support.md index cfa20c4dc6..b548f03fcc 100644 --- a/content/github/working-with-github-support/github-marketplace-support.md +++ b/content/github/working-with-github-support/github-marketplace-support.md @@ -5,6 +5,8 @@ redirect_from: - /articles/github-marketplace-support versions: free-pro-team: '*' +topics: + - jobs --- diff --git a/content/github/working-with-github-support/index.md b/content/github/working-with-github-support/index.md index 1ea83fac6b..5e266237af 100644 --- a/content/github/working-with-github-support/index.md +++ b/content/github/working-with-github-support/index.md @@ -5,6 +5,8 @@ redirect_from: - /forum versions: free-pro-team: '*' +topics: + - jobs --- diff --git a/content/github/working-with-github-support/submitting-a-ticket.md b/content/github/working-with-github-support/submitting-a-ticket.md index f3fa8d8493..616b7929fd 100644 --- a/content/github/working-with-github-support/submitting-a-ticket.md +++ b/content/github/working-with-github-support/submitting-a-ticket.md @@ -5,6 +5,8 @@ redirect_from: - /articles/submitting-a-ticket versions: free-pro-team: '*' +topics: + - jobs --- If your account uses a paid {% data variables.product.prodname_dotcom %} product, you can directly contact {% data variables.contact.github_support %}. If your account uses {% data variables.product.prodname_free_user %} for user accounts and organizations, you can contact {% data variables.contact.contact_support %} to report account, security, and abuse issues. For more information, see "[About GitHub Support](/github/working-with-github-support/about-github-support)." diff --git a/content/github/writing-on-github/basic-writing-and-formatting-syntax.md b/content/github/writing-on-github/basic-writing-and-formatting-syntax.md index 833bf2592f..5886cb0717 100644 --- a/content/github/writing-on-github/basic-writing-and-formatting-syntax.md +++ b/content/github/writing-on-github/basic-writing-and-formatting-syntax.md @@ -197,7 +197,7 @@ For more information, see "[Autolinked references and URLs](/articles/autolinked Some {% data variables.product.prodname_github_app %}s provide information in {% data variables.product.product_name %} for URLs that link to their registered domains. {% data variables.product.product_name %} renders the information provided by the app under the URL in the body or comment of an issue or pull request. -![Content attachment](/assets/images/help/writing/content-attachment.png) +![Content attachment](/assets/images/github-apps/content_reference_attachment.png) To see content attachments, you must have a {% data variables.product.prodname_github_app %} that uses the Content Attachments API installed on the repository.{% if currentVersion == "free-pro-team@latest" %} For more information, see "[Installing an app in your personal account](/articles/installing-an-app-in-your-personal-account)" and "[Installing an app in your organization](/articles/installing-an-app-in-your-organization)."{% endif %} diff --git a/content/graphql/guides/forming-calls-with-graphql.md b/content/graphql/guides/forming-calls-with-graphql.md index 4a826e8d0e..aebd9103f9 100644 --- a/content/graphql/guides/forming-calls-with-graphql.md +++ b/content/graphql/guides/forming-calls-with-graphql.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - api --- ### Authenticating with GraphQL @@ -26,9 +28,10 @@ The following scopes are recommended: {% endif %} + ``` -user -public_repo +user{% if currentVersion != "github-ae@latest" %} +public_repo{% endif %} repo repo_deployment repo:status @@ -246,7 +249,7 @@ Looking at the composition line by line: The `labels` field has the type [`LabelConnection`](/graphql/reference/objects#labelconnection). As with the `issues` object, because `labels` is a connection, we must travel its edges to a connected node: the `label` object. At the node, we can specify the `label` object fields we want to return, in this case, `name`. -You may notice that running this query on the Octocat's public `Hello-World` repository won't return many labels. Try running it on one of your own repositories that does use labels, and you'll likely see a difference. +You may notice that running this query on the Octocat's {% if currentVersion != "github-ae@latest" %}public{% endif %} `Hello-World` repository won't return many labels. Try running it on one of your own repositories that does use labels, and you'll likely see a difference. ### Example mutation diff --git a/content/graphql/guides/index.md b/content/graphql/guides/index.md index 35387642ba..ca2df6f367 100644 --- a/content/graphql/guides/index.md +++ b/content/graphql/guides/index.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - api --- {% link_in_list /introduction-to-graphql %} diff --git a/content/graphql/guides/introduction-to-graphql.md b/content/graphql/guides/introduction-to-graphql.md index 542305f7ca..7c4720043c 100644 --- a/content/graphql/guides/introduction-to-graphql.md +++ b/content/graphql/guides/introduction-to-graphql.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - api --- ### GraphQL terminology diff --git a/content/graphql/guides/managing-enterprise-accounts.md b/content/graphql/guides/managing-enterprise-accounts.md index edf73fa449..acb2035bf1 100644 --- a/content/graphql/guides/managing-enterprise-accounts.md +++ b/content/graphql/guides/managing-enterprise-accounts.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - api --- ### About managing enterprise accounts with GraphQL @@ -58,9 +60,7 @@ For some example queries, see "[An example query using the Enterprise Accounts A - `admin:enterprise`: Gives full control of enterprises (includes `manage_billing:enterprise` and `read:enterprise`) - `manage_billing:enterprise`: Read and write enterprise billing data. - `read:enterprise`: Read enterprise profile data. - - ![Permissions options for personal access token](/assets/images/developer/graphql/permissions-for-access-token.png) - + 4. Copy your personal access token and keep it in a secure place until you add it to your GraphQL client. #### 2. Choose a GraphQL client @@ -68,7 +68,7 @@ For some example queries, see "[An example query using the Enterprise Accounts A We recommend you use GraphiQL or another standalone GraphQL client that lets you configure the base URL. You may also consider using these GraphQL clients: - - [Insomnia](https://insomnia.rest/graphql/) + - [Insomnia](https://support.insomnia.rest/article/176-graphql-queries) - [GraphiQL](https://www.gatsbyjs.org/docs/running-queries-with-graphiql/) - [Postman](https://learning.getpostman.com/docs/postman/sending_api_requests/graphql/) @@ -95,7 +95,9 @@ Now you are ready to start making queries. ### An example query using the Enterprise Accounts API -This GraphQL query requests the total number of `public` repositories in each of your appliance's organizations using the Enterprise Accounts API. To customize this query, replace `` with the slug of your Enterprise's instance slug. +This GraphQL query requests the total number of {% if currentVersion != "github-ae@latest" %}`public`{% else %}`private`{% endif %} repositories in each of your appliance's organizations using the Enterprise Accounts API. To customize this query, replace `` with the slug of your Enterprise's instance slug. + +{% if currentVersion != "github-ae@latest" %} ```graphql query publicRepositoriesByOrganization($slug: String!) { @@ -127,8 +129,42 @@ variables { } ``` -The next GraphQL query example shows how challenging it is to retrieve the number of `public` repositories in each organization without using the Enterprise Account API. Notice that the GraphQL Enterprise Accounts API has made this task simpler for enterprises since you only need to customize a single variable. To customize this query, replace `` and ``, etc. with the organization names on your instance. +{% else %} +```graphql +query privateRepositoriesByOrganization($slug: String!) { + enterprise(slug: $slug) { + ...enterpriseFragment + } +} + +fragment enterpriseFragment on Enterprise { + ... on Enterprise{ + name + organizations(first: 100){ + nodes{ + name + ... on Organization{ + name + repositories(privacy: PRIVATE){ + totalCount + } + } + } + } + } +} + +# Passing our Enterprise Account as a variable +variables { + "slug": "" +} +``` +{% endif %} + +The next GraphQL query example shows how challenging it is to retrieve the number of {% if currentVersion != "github-ae@latest" %}`public`{% else %}`private`{% endif %} repositories in each organization without using the Enterprise Account API. Notice that the GraphQL Enterprise Accounts API has made this task simpler for enterprises since you only need to customize a single variable. To customize this query, replace `` and ``, etc. with the organization names on your instance. + +{% if currentVersion != "github-ae@latest" %} ```graphql # Each organization is queried separately { @@ -150,9 +186,34 @@ fragment repositories on Organization { } } ``` +{% else %} +```graphql +# Each organization is queried separately +{ + organizationOneAlias: organization(login: "name-of-organization-one") { + # How to use a fragment + ...repositories + } + organizationTwoAlias: organization(login: "name-of-organization-two") { + ...repositories + } + # organizationThreeAlias ... and so on up-to lets say 100 +} + +## How to define a fragment +fragment repositories on Organization { + name + repositories(privacy: PRIVATE){ + totalCount + } +} +``` +{% endif %} ### Query each organization separately +{% if currentVersion != "github-ae@latest" %} + ```graphql query publicRepositoriesByOrganization { organizationOneAlias: organization(login: "") { @@ -173,6 +234,30 @@ fragment repositories on Organization { } ``` +{% else %} + +```graphql +query privateRepositoriesByOrganization { + organizationOneAlias: organization(login: "") { + # How to use a fragment + ...repositories + } + organizationTwoAlias: organization(login: "") { + ...repositories + } + # organizationThreeAlias ... and so on up-to lets say 100 +} +# How to define a fragment +fragment repositories on Organization { + name + repositories(privacy: PRIVATE){ + totalCount + } +} +``` + +{% endif %} + This GraphQL query requests the last 5 log entries for an enterprise organization. To customize this query, replace `` and ``. ```graphql diff --git a/content/graphql/guides/migrating-from-rest-to-graphql.md b/content/graphql/guides/migrating-from-rest-to-graphql.md index 27493df1c5..f51a5ec5e3 100644 --- a/content/graphql/guides/migrating-from-rest-to-graphql.md +++ b/content/graphql/guides/migrating-from-rest-to-graphql.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - api --- ### Differences in API logic diff --git a/content/graphql/guides/using-global-node-ids.md b/content/graphql/guides/using-global-node-ids.md index 0fb33e4920..80ef4ebd38 100644 --- a/content/graphql/guides/using-global-node-ids.md +++ b/content/graphql/guides/using-global-node-ids.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - api --- You can access most objects in GitHub (users, issues, pull requests, etc.) using either the REST API or the GraphQL API. With a [recent update](https://developer.github.com/changes/2017-12-19-graphql-node-id/), you can find the **global node ID** of many objects from within the REST API and use these IDs in your GraphQL operations. diff --git a/content/graphql/guides/using-the-explorer.md b/content/graphql/guides/using-the-explorer.md index b0ebb7c5bc..705a2c3416 100644 --- a/content/graphql/guides/using-the-explorer.md +++ b/content/graphql/guides/using-the-explorer.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - api --- ## About the GraphQL Explorer diff --git a/content/graphql/guides/using-the-graphql-api-for-discussions.md b/content/graphql/guides/using-the-graphql-api-for-discussions.md index ad50406a54..97837ee030 100644 --- a/content/graphql/guides/using-the-graphql-api-for-discussions.md +++ b/content/graphql/guides/using-the-graphql-api-for-discussions.md @@ -83,7 +83,7 @@ discussionCategories( ### Repository.discussion -Get a discussion. Returns `null` if discussion with the specified ID exists. +Get a discussion. Returns `null` if discussion with the specified ID does not exist. _Signature:_ diff --git a/content/graphql/overview/about-the-graphql-api.md b/content/graphql/overview/about-the-graphql-api.md index 0c7b36f81b..cb5eab5f5b 100644 --- a/content/graphql/overview/about-the-graphql-api.md +++ b/content/graphql/overview/about-the-graphql-api.md @@ -5,6 +5,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - api --- ### Overview diff --git a/content/graphql/overview/breaking-changes.md b/content/graphql/overview/breaking-changes.md index ba29ae3c09..6cdf450bef 100644 --- a/content/graphql/overview/breaking-changes.md +++ b/content/graphql/overview/breaking-changes.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - api --- ### About breaking changes diff --git a/content/graphql/overview/changelog.md b/content/graphql/overview/changelog.md index 6c051b659f..3ecd22c955 100644 --- a/content/graphql/overview/changelog.md +++ b/content/graphql/overview/changelog.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - api --- Breaking changes include changes that will break existing queries or could affect the runtime behavior of clients. For a list of breaking changes and when they will occur, see our [breaking changes log](/graphql/overview/breaking-changes). diff --git a/content/graphql/overview/explorer.md b/content/graphql/overview/explorer.md index 74540b78a4..b4d07c0939 100644 --- a/content/graphql/overview/explorer.md +++ b/content/graphql/overview/explorer.md @@ -8,5 +8,7 @@ versions: enterprise-server: '*' github-ae: '*' layout: graphql-explorer +topics: + - api --- diff --git a/content/graphql/overview/public-schema.md b/content/graphql/overview/public-schema.md index d2a8c7309b..81dceae4a8 100644 --- a/content/graphql/overview/public-schema.md +++ b/content/graphql/overview/public-schema.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - api --- You can [perform introspection](/graphql/guides/introduction-to-graphql#discovering-the-graphql-api) against the GraphQL API directly. diff --git a/content/graphql/overview/resource-limitations.md b/content/graphql/overview/resource-limitations.md index 636fee5b9c..4ca5ba3f63 100644 --- a/content/graphql/overview/resource-limitations.md +++ b/content/graphql/overview/resource-limitations.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - api --- ## Node limit diff --git a/content/graphql/overview/schema-previews.md b/content/graphql/overview/schema-previews.md index 6272f17066..d653fad776 100644 --- a/content/graphql/overview/schema-previews.md +++ b/content/graphql/overview/schema-previews.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - api --- ### About schema previews diff --git a/content/graphql/reference/enums.md b/content/graphql/reference/enums.md index 50ff25548c..108b9b8be4 100644 --- a/content/graphql/reference/enums.md +++ b/content/graphql/reference/enums.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - api --- ### About enums diff --git a/content/graphql/reference/input-objects.md b/content/graphql/reference/input-objects.md index ad927ff2bb..35065838c7 100644 --- a/content/graphql/reference/input-objects.md +++ b/content/graphql/reference/input-objects.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - api --- ### About input objects diff --git a/content/graphql/reference/interfaces.md b/content/graphql/reference/interfaces.md index 492e7b535c..175ff95b3d 100644 --- a/content/graphql/reference/interfaces.md +++ b/content/graphql/reference/interfaces.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - api --- ### About interfaces diff --git a/content/graphql/reference/mutations.md b/content/graphql/reference/mutations.md index 387dcd51ac..f523fd3168 100644 --- a/content/graphql/reference/mutations.md +++ b/content/graphql/reference/mutations.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - api --- ### About mutations diff --git a/content/graphql/reference/objects.md b/content/graphql/reference/objects.md index 7872b01baa..c99b46cca6 100644 --- a/content/graphql/reference/objects.md +++ b/content/graphql/reference/objects.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - api --- ### About objects diff --git a/content/graphql/reference/queries.md b/content/graphql/reference/queries.md index 48b714cd4b..208f468589 100644 --- a/content/graphql/reference/queries.md +++ b/content/graphql/reference/queries.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - api --- ### About queries diff --git a/content/graphql/reference/scalars.md b/content/graphql/reference/scalars.md index 2863a61f0d..8df4267a78 100644 --- a/content/graphql/reference/scalars.md +++ b/content/graphql/reference/scalars.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - api --- ### About scalars diff --git a/content/graphql/reference/unions.md b/content/graphql/reference/unions.md index 2c9b6a7862..9b7381ec3f 100644 --- a/content/graphql/reference/unions.md +++ b/content/graphql/reference/unions.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - api --- ### About unions 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 18658d914d..60e25e8f1a 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 @@ -33,22 +33,22 @@ To connect {% data variables.product.prodname_insights %} to {% data variables.p {% data reusables.organizations.org_settings %} {% data reusables.organizations.github-apps-settings-sidebar %} 5. Click **New {% data variables.product.prodname_github_app %}**. - ![New GitHub App button](/assets/images/help/apps/github_apps_new.png) + ![New GitHub App button](/assets/images/github-apps/github_apps_new.png) 6. Under "{% data variables.product.prodname_github_app %} name", type a name for the app. Your app cannot have the same name as an existing user or organization, unless the name is your own user or organization name. - ![GitHub App name field](/assets/images/help/apps/github_apps_app_name.png) + ![GitHub App name field](/assets/images/github-apps/github_apps_app_name.png) 7. Under "Homepage URL", type the URL of the application server for {% data variables.product.prodname_insights %}. For more information, see "[System overview for {% data variables.product.prodname_insights %}](/insights/installing-and-configuring-github-insights/system-overview-for-github-insights#requirements-for-running-github-insights)." - ![Homepage URL field](/assets/images/help/apps/github_apps_homepage_url.png) + ![Homepage URL field](/assets/images/github-apps/github_apps_homepage_url.png) 8. Under "User authorization callback URL", type the following, replacing `` with the URL of the application server. ``` /public/applogin ``` - ![User authorization callback field](/assets/images/help/apps/github_apps_user_authorization.png) + ![User authorization callback field](/assets/images/github-apps/github_apps_user_authorization.png) 9. Under "Setup URL", type `/public/setup`. ![Setup URL field](/assets/images/help/apps/github-apps-setup-url.png) 9. Under "Webhook URL", type `/webhooks`. - ![Webhook URL field](/assets/images/help/apps/github_apps_webhook_url.png) + ![Webhook URL field](/assets/images/github-apps/github_apps_webhook_url.png) 10. Under "Webhook secret", type a secret, then record the secret for later reference. - ![Webhook secret field](/assets/images/help/apps/github_apps_webhook_secret.png) + ![Webhook secret field](/assets/images/github-apps/github_apps_webhook_secret.png) 11. Under "Permissions", use the drop-down menus and configure the following permissions for the app. - Repository: - Contents: **Read-only** @@ -71,7 +71,7 @@ To connect {% data variables.product.prodname_insights %} to {% data variables.p 13. To enable the {% data variables.product.prodname_github_app %} to access data from any user or organization in {% data variables.product.product_location %}, under "Where can this {% data variables.product.prodname_github_app %} be installed?", select **Any account**. ![Radio buttons to enable access to any account](/assets/images/help/apps/github_apps_installation_options_any_account.png) 14. Click **Create {% data variables.product.prodname_github_app %}**. - ![Create GitHub App button](/assets/images/help/apps/github_apps_create_github_app.png) + ![Create GitHub App button](/assets/images/github-apps/github_apps_create_github_app.png) 15. Review your app's configuration. 16. Under "Private keys", click **Generate a private key**. ![Generate a private key button](/assets/images/help/apps/generate-private-key.png) diff --git a/content/packages/guides/about-github-container-registry.md b/content/packages/guides/about-github-container-registry.md index 70ca2942cd..8d1ae32708 100644 --- a/content/packages/guides/about-github-container-registry.md +++ b/content/packages/guides/about-github-container-registry.md @@ -74,7 +74,7 @@ To use or manage a package hosted by a package registry, you must use a token wi | --- | --- | |`read:packages`| Download and install container images from {% data variables.product.prodname_github_container_registry %} | |`write:packages`| Upload and publish container images to {% data variables.product.prodname_github_container_registry %} | -| `delete:packages` | Delete specified versions of private or public container images from {% data variables.product.prodname_github_container_registry %}. For more information, see "{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif currentVersion ver_lt "enterprise-server@3.0" %}[Deleting a package](/packages/learn-github-packages/deleting-a-package){% endif %}." | +| `delete:packages` | Delete specified versions of private or public container images from {% data variables.product.prodname_github_container_registry %}. For more information, see "[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package)." | To learn about available scopes and permissions for container images, see "[Configuring access control and visibility for container images](/packages/guides/configuring-access-control-and-visibility-for-container-images)." diff --git a/content/packages/guides/configuring-apache-maven-for-use-with-github-packages.md b/content/packages/guides/configuring-apache-maven-for-use-with-github-packages.md index 0ea1460fc7..65df92a2b7 100644 --- a/content/packages/guides/configuring-apache-maven-for-use-with-github-packages.md +++ b/content/packages/guides/configuring-apache-maven-for-use-with-github-packages.md @@ -10,9 +10,11 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.package_registry.packages-ghes-release-stage %} +{% data reusables.package_registry.packages-ghae-release-stage %} {% data reusables.package_registry.admins-can-configure-package-types %} @@ -28,7 +30,7 @@ You can authenticate to {% data variables.product.prodname_registry %} with Apac In the `servers` tag, add a child `server` tag with an `id`, replacing *USERNAME* with your {% data variables.product.prodname_dotcom %} username, and *TOKEN* with your personal access token. -In the `repositories` tag, configure a repository by mapping the `id` of the repository to the `id` you added in the `server` tag containing your credentials. Replace {% if enterpriseServerVersions contains currentVersion %}*HOSTNAME* with the host name of your {% data variables.product.prodname_ghe_server %} instance, {% endif %}*REPOSITORY* with the name of the repository you'd like to publish a package to or install a package from, and *OWNER* with the name of the user or organization account that owns the repository. Because uppercase letters aren't supported, you must use lowercase letters for the repository owner even if the {% data variables.product.prodname_dotcom %} user or organization name contains uppercase letters. +In the `repositories` tag, configure a repository by mapping the `id` of the repository to the `id` you added in the `server` tag containing your credentials. Replace {% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}*HOSTNAME* with the host name of {% data variables.product.product_location %}, {% endif %}*REPOSITORY* with the name of the repository you'd like to publish a package to or install a package from, and *OWNER* with the name of the user or organization account that owns the repository. Because uppercase letters aren't supported, you must use lowercase letters for the repository owner even if the {% data variables.product.prodname_dotcom %} user or organization name contains uppercase letters. If you want to interact with multiple repositories, you can add each repository to separate `repository` children in the `repositories` tag, mapping the `id` of each to the credentials in the `servers` tag. @@ -55,13 +57,13 @@ If your instance has subdomain isolation enabled: central https://repo1.maven.org/maven2 - true - true github - GitHub OWNER Apache Maven Packages - https://{% if currentVersion == "free-pro-team@latest" %}maven.pkg.github.com{% else %}maven.HOSTNAME{% endif %}/OWNER/REPOSITORY + https://{% if currentVersion == "free-pro-team@latest" %}maven.pkg.github.com{% else %}maven.HOSTNAME{% endif %}/OWNER/* + + true + @@ -97,13 +99,13 @@ If your instance has subdomain isolation disabled: central https://repo1.maven.org/maven2 - true - true github - GitHub OWNER Apache Maven Packages - https://HOSTNAME/_registry/maven/OWNER/REPOSITORY + https://maven.pkg.github.com/OWNER/* + + true + @@ -132,7 +134,7 @@ If you would like to publish multiple packages to the same repository, you can i For more information on creating a package, see the [maven.apache.org documentation](https://maven.apache.org/guides/getting-started/maven-in-five-minutes.html). -1. Edit the `distributionManagement` element of the *pom.xml* file located in your package directory, replacing {% if enterpriseServerVersions contains currentVersion %}*HOSTNAME* with the host name of your {% data variables.product.prodname_ghe_server %} instance, {% endif %}`OWNER` with the name of the user or organization account that owns the repository and `REPOSITORY` with the name of the repository containing your project. +1. Edit the `distributionManagement` element of the *pom.xml* file located in your package directory, replacing {% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}*HOSTNAME* with the host name of {% data variables.product.product_location %}, {% endif %}`OWNER` with the name of the user or organization account that owns the repository and `REPOSITORY` with the name of the repository containing your project. {% if enterpriseServerVersions contains currentVersion %} If your instance has subdomain isolation enabled: {% endif %} @@ -190,4 +192,4 @@ To install an Apache Maven package from {% data variables.product.prodname_regis ### Further reading - "[Configuring Gradle for use with {% data variables.product.prodname_registry %}](/packages/guides/configuring-gradle-for-use-with-github-packages)" -- "{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif currentVersion ver_lt "enterprise-server@3.0" %}[Deleting a package](/packages/learn-github-packages/deleting-a-package){% endif %}." +- "{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif currentVersion ver_lt "enterprise-server@3.1" or currentVersion == "github-ae@latest" %}[Deleting a package](/packages/learn-github-packages/deleting-a-package){% endif %}" diff --git a/content/packages/guides/configuring-docker-for-use-with-github-packages.md b/content/packages/guides/configuring-docker-for-use-with-github-packages.md index 0b46e533b1..5b793e9236 100644 --- a/content/packages/guides/configuring-docker-for-use-with-github-packages.md +++ b/content/packages/guides/configuring-docker-for-use-with-github-packages.md @@ -10,9 +10,11 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.package_registry.packages-ghes-release-stage %} +{% data reusables.package_registry.packages-ghae-release-stage %} {% data reusables.package_registry.admins-can-configure-package-types %} @@ -48,9 +50,8 @@ To keep your credentials secure, we recommend you save your personal access toke {% endraw %} {% endif %} -{% if enterpriseServerVersions contains currentVersion %} - -{% if currentVersion == "enterprise-server@3.0" or currentVersion ver_gt "enterprise-server@3.0" %} +{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %} +{% if currentVersion ver_gt "enterprise-server@2.22" %} If your instance has subdomain isolation enabled: {% endif %} {% raw %} @@ -58,7 +59,7 @@ If your instance has subdomain isolation enabled: $ cat ~/TOKEN.txt | docker login docker.HOSTNAME -u USERNAME --password-stdin ``` {% endraw %} -{% if currentVersion == "enterprise-server@3.0" or currentVersion ver_gt "enterprise-server@3.0" %} +{% if currentVersion ver_gt "enterprise-server@2.22" %} If your instance has subdomain isolation disabled: {% raw %} @@ -70,7 +71,7 @@ If your instance has subdomain isolation disabled: {% endif %} -To use this example login command, replace `USERNAME` with your {% data variables.product.product_name %} username{% if enterpriseServerVersions contains currentVersion %}, `HOSTNAME` with the URL for {% data variables.product.product_location %},{% endif %} and `~/TOKEN.txt` with the file path to your personal access token for {% data variables.product.product_name %}. +To use this example login command, replace `USERNAME` with your {% data variables.product.product_name %} username{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}, `HOSTNAME` with the URL for {% data variables.product.product_location %},{% endif %} and `~/TOKEN.txt` with the file path to your personal access token for {% data variables.product.product_name %}. For more information, see "[Docker login](https://docs.docker.com/engine/reference/commandline/login/#provide-a-password-using-stdin)." @@ -99,40 +100,38 @@ For more information, see "[Docker login](https://docs.docker.com/engine/referen > REPOSITORY TAG IMAGE ID CREATED SIZE > IMAGE_NAME VERSION IMAGE_ID 4 weeks ago 1.11MB ``` -2. Using the Docker image ID, tag the docker image, replacing *OWNER* with the name of the user or organization account that owns the repository, *REPOSITORY* with the name of the repository containing your project, *IMAGE_NAME* with name of the package or image,{% if enterpriseServerVersions contains currentVersion %} *HOSTNAME* with the hostname of {% data variables.product.product_location %},{% endif %} and *VERSION* with package version at build time. +2. Using the Docker image ID, tag the docker image, replacing *OWNER* with the name of the user or organization account that owns the repository, *REPOSITORY* with the name of the repository containing your project, *IMAGE_NAME* with name of the package or image,{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %} *HOSTNAME* with the hostname of {% data variables.product.product_location %},{% endif %} and *VERSION* with package version at build time. {% if currentVersion == "free-pro-team@latest" %} ```shell $ docker tag IMAGE_ID docker.pkg.github.com/OWNER/REPOSITORY/IMAGE_NAME:VERSION ``` {% else %} - - {% if currentVersion == "enterprise-server@3.0" or currentVersion ver_gt "enterprise-server@3.0" %} + {% if currentVersion ver_gt "enterprise-server@2.22" %} If your instance has subdomain isolation enabled: {% endif %} ```shell $ docker tag IMAGE_ID docker.HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:VERSION ``` - {% if currentVersion == "enterprise-server@3.0" or currentVersion ver_gt "enterprise-server@3.0" %} + {% if currentVersion ver_gt "enterprise-server@2.22" %} If your instance has subdomain isolation disabled: ```shell $ docker tag IMAGE_ID HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:VERSION ``` {% endif %} {% endif %} -3. If you haven't already built a docker image for the package, build the image, replacing *OWNER* with the name of the user or organization account that owns the repository, *REPOSITORY* with the name of the repository containing your project, *IMAGE_NAME* with name of the package or image, *VERSION* with package version at build time,{% if enterpriseServerVersions contains currentVersion %} *HOSTNAME* with the hostname of {% data variables.product.product_location %},{% endif %} and *PATH* to the image if it isn't in the current working directory. +3. If you haven't already built a docker image for the package, build the image, replacing *OWNER* with the name of the user or organization account that owns the repository, *REPOSITORY* with the name of the repository containing your project, *IMAGE_NAME* with name of the package or image, *VERSION* with package version at build time,{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %} *HOSTNAME* with the hostname of {% data variables.product.product_location %},{% endif %} and *PATH* to the image if it isn't in the current working directory. {% if currentVersion == "free-pro-team@latest" %} ```shell $ docker build -t docker.pkg.github.com/OWNER/REPOSITORY/IMAGE_NAME:VERSION PATH ``` {% else %} - - {% if currentVersion == "enterprise-server@3.0" or currentVersion ver_gt "enterprise-server@3.0" %} + {% if currentVersion ver_gt "enterprise-server@2.22" %} If your instance has subdomain isolation enabled: {% endif %} ```shell $ docker build -t docker.HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:VERSION PATH ``` - {% if currentVersion == "enterprise-server@3.0" or currentVersion ver_gt "enterprise-server@3.0" %} + {% if currentVersion ver_gt "enterprise-server@2.22" %} If your instance has subdomain isolation disabled: ```shell $ docker build -t HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:VERSION PATH @@ -145,14 +144,13 @@ For more information, see "[Docker login](https://docs.docker.com/engine/referen $ docker push docker.pkg.github.com/OWNER/REPOSITORY/IMAGE_NAME:VERSION ``` {% else %} - - {% if currentVersion == "enterprise-server@3.0" or currentVersion ver_gt "enterprise-server@3.0" %} + {% if currentVersion ver_gt "enterprise-server@2.22" %} If your instance has subdomain isolation enabled: {% endif %} ```shell $ docker push docker.HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:VERSION ``` - {% if currentVersion == "enterprise-server@3.0" or currentVersion ver_gt "enterprise-server@3.0" %} + {% if currentVersion ver_gt "enterprise-server@2.22" %} If your instance has subdomain isolation disabled: ```shell $ docker push HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:VERSION @@ -167,15 +165,10 @@ For more information, see "[Docker login](https://docs.docker.com/engine/referen #### Example publishing a Docker image -{% if enterpriseServerVersions contains currentVersion %} - -{% if currentVersion == "enterprise-server@3.0" or currentVersion ver_gt "enterprise-server@3.0" %} +{% if currentVersion ver_gt "enterprise-server@2.22" %} These examples assume your instance has subdomain isolation enabled. {% endif %} - -{% endif %} - You can publish version 1.0 of the `monalisa` image to the `octocat/octo-app` repository using an image ID. {% if currentVersion == "free-pro-team@latest" %} @@ -236,7 +229,7 @@ $ docker push docker.HOSTNAME/octocat/octo-app/monalisa:1.0 {% data reusables.package_registry.docker_registry_deprecation_status %} -You can use the `docker pull` command to install a docker image from {% data variables.product.prodname_registry %}, replacing *OWNER* with the name of the user or organization account that owns the repository, *REPOSITORY* with the name of the repository containing your project, *IMAGE_NAME* with name of the package or image,{% if enterpriseServerVersions contains currentVersion %}*HOSTNAME* with the host name of your {% data variables.product.prodname_ghe_server %} instance, {% endif %} and *TAG_NAME* with tag for the image you want to install. +You can use the `docker pull` command to install a docker image from {% data variables.product.prodname_registry %}, replacing *OWNER* with the name of the user or organization account that owns the repository, *REPOSITORY* with the name of the repository containing your project, *IMAGE_NAME* with name of the package or image,{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %} *HOSTNAME* with the host name of {% data variables.product.product_location %}, {% endif %} and *TAG_NAME* with tag for the image you want to install. {% if currentVersion == "free-pro-team@latest" %} ```shell @@ -244,13 +237,13 @@ $ docker pull docker.pkg.github.com/OWNER/REPOSITORY/IMAGE_NAME:TAG_NAME -{% if currentVersion == "enterprise-server@3.0" or currentVersion ver_gt "enterprise-server@3.0" %} +{% if currentVersion ver_gt "enterprise-server@2.22" %} If your instance has subdomain isolation enabled: {% endif %} ```shell $ docker pull docker.HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:TAG_NAME ``` -{% if currentVersion == "enterprise-server@3.0" or currentVersion ver_gt "enterprise-server@3.0" %} +{% if currentVersion ver_gt "enterprise-server@2.22" %} If your instance has subdomain isolation disabled: ```shell $ docker pull HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:TAG_NAME @@ -266,4 +259,4 @@ $ docker pull HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:TAG_NAME ### Further reading -- "{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif currentVersion ver_lt "enterprise-server@3.0" %}[Deleting a package](/packages/learn-github-packages/deleting-a-package){% endif %}." +- "{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif currentVersion ver_lt "enterprise-server@3.1" or currentVersion == "github-ae@latest" %}[Deleting a package](/packages/learn-github-packages/deleting-a-package){% endif %}" diff --git a/content/packages/guides/configuring-dotnet-cli-for-use-with-github-packages.md b/content/packages/guides/configuring-dotnet-cli-for-use-with-github-packages.md index 3a48e2e9ab..b8e5b0a4fd 100644 --- a/content/packages/guides/configuring-dotnet-cli-for-use-with-github-packages.md +++ b/content/packages/guides/configuring-dotnet-cli-for-use-with-github-packages.md @@ -11,9 +11,11 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.package_registry.packages-ghes-release-stage %} +{% data reusables.package_registry.packages-ghae-release-stage %} {% data reusables.package_registry.admins-can-configure-package-types %} @@ -30,10 +32,10 @@ To authenticate to {% data variables.product.prodname_registry %} with the `dotn You must replace: - `USERNAME` with the name of your user account on {% data variables.product.prodname_dotcom %}. - `TOKEN` with your personal access token. -- `OWNER` with the name of the user or organization account that owns the repository containing your project.{% if enterpriseServerVersions contains currentVersion %} -- `HOSTNAME` with the host name for your {% data variables.product.prodname_ghe_server %} instance. +- `OWNER` with the name of the user or organization account that owns the repository containing your project.{%if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %} +- `HOSTNAME` with the host name for {% data variables.product.product_location %}.{% endif %} -If your instance has subdomain isolation enabled: +{%if enterpriseServerVersions contains currentVersion %}If your instance has subdomain isolation enabled: {% endif %} ```xml @@ -78,9 +80,9 @@ If your instance has subdomain isolation disabled: ### Publishing a package -You can publish a package to {% data variables.product.prodname_registry %} by authenticating with a *nuget.config* file{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}, or by using the `--api-key` command line option with your {% data variables.product.prodname_dotcom %} personal access token (PAT){% endif %}. +You can publish a package to {% data variables.product.prodname_registry %} by authenticating with a *nuget.config* file{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest"%}, or by using the `--api-key` command line option with your {% data variables.product.prodname_dotcom %} personal access token (PAT){% endif %}. -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} #### Publishing a package using a GitHub PAT as your API key If you don't already have a PAT to use for your {% data variables.product.prodname_dotcom %} account, see "[Creating a personal access token](/github/authenticating-to-github/creating-a-personal-access-token)." @@ -115,8 +117,8 @@ When publishing, you need to use the same value for `OWNER` in your *csproj* fil 3. Add your project's specific information to your project's file, which ends in *.csproj*. You must replace: - `OWNER` with the name of the user or organization account that owns the repository containing your project. - `REPOSITORY` with the name of the repository containing the package you want to publish. - - `1.0.0` with the version number of the package.{% if enterpriseServerVersions contains currentVersion %} - - `HOSTNAME` with the host name for your {% data variables.product.prodname_ghe_server %} instance.{% endif %} + - `1.0.0` with the version number of the package.{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %} + - `HOSTNAME` with the host name for {% data variables.product.product_location %}.{% endif %} ``` xml @@ -220,4 +222,4 @@ Using packages from {% data variables.product.prodname_dotcom %} in your project ### Further reading -- "{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif currentVersion ver_lt "enterprise-server@3.0" %}[Deleting a package](/packages/learn-github-packages/deleting-a-package){% endif %}." +- "{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif currentVersion ver_lt "enterprise-server@3.1" or currentVersion == "github-ae@latest" %}[Deleting a package](/packages/learn-github-packages/deleting-a-package){% endif %}" diff --git a/content/packages/guides/configuring-gradle-for-use-with-github-packages.md b/content/packages/guides/configuring-gradle-for-use-with-github-packages.md index eb3d6632f7..c144f63b6d 100644 --- a/content/packages/guides/configuring-gradle-for-use-with-github-packages.md +++ b/content/packages/guides/configuring-gradle-for-use-with-github-packages.md @@ -10,9 +10,11 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.package_registry.packages-ghes-release-stage %} +{% data reusables.package_registry.packages-ghae-release-stage %} {% data reusables.package_registry.admins-can-configure-package-types %} @@ -28,6 +30,8 @@ You can authenticate to {% data variables.product.prodname_registry %} with Grad {% if enterpriseServerVersions contains currentVersion %} Replace *REGISTRY-URL* with the URL for your instance's Maven registry. If your instance has subdomain isolation enabled, use `maven.HOSTNAME`. If your instance has subdomain isolation disabled, use `HOSTNAME/_registry/maven`. In either case, replace *HOSTNAME* with the host name of your {% data variables.product.prodname_ghe_server %} instance. +{% elsif currentVersion == "github-ae@latest" %} +Replace *REGISTRY-URL* with the URL for your enterprise's Maven registry, `maven.HOSTNAME`. Replace *HOSTNAME* with the host name of {% data variables.product.product_location %}. {% endif %} Replace *USERNAME* with your {% data variables.product.prodname_dotcom %} username, *TOKEN* with your personal access token, *REPOSITORY* with the name of the repository containing the package you want to publish, and *OWNER* with the name of the user or organization account on {% data variables.product.prodname_dotcom %} that owns the repository. Because uppercase letters aren't supported, you must use lowercase letters for the repository owner even if the {% data variables.product.prodname_dotcom %} user or organization name contains uppercase letters. @@ -211,4 +215,4 @@ You can install a package by adding the package as a dependency to your project. ### Further reading - "[Configuring Apache Maven for use with {% data variables.product.prodname_registry %}](/packages/using-github-packages-with-your-projects-ecosystem/configuring-apache-maven-for-use-with-github-packages)" -- "{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif currentVersion ver_lt "enterprise-server@3.0" %}[Deleting a package](/packages/learn-github-packages/deleting-a-package){% endif %}." +- "{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif currentVersion ver_lt "enterprise-server@3.1" or currentVersion == "github-ae@latest" %}[Deleting a package](/packages/learn-github-packages/deleting-a-package){% endif %}" diff --git a/content/packages/guides/configuring-npm-for-use-with-github-packages.md b/content/packages/guides/configuring-npm-for-use-with-github-packages.md index 661a4a6c6e..ef6474ff35 100644 --- a/content/packages/guides/configuring-npm-for-use-with-github-packages.md +++ b/content/packages/guides/configuring-npm-for-use-with-github-packages.md @@ -10,20 +10,22 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.package_registry.packages-ghes-release-stage %} +{% data reusables.package_registry.packages-ghae-release-stage %} {% data reusables.package_registry.admins-can-configure-package-types %} -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} ### Limits for published npm versions If you publish over 1,000 npm package versions to {% data variables.product.prodname_registry %}, you may see performance issues and timeouts occur during usage. In the future, to improve performance of the service, you won't be able to publish more than 1,000 versions of a package on {% data variables.product.prodname_dotcom %}. Any versions published before hitting this limit will still be readable. -If you reach this limit, consider deleting package versions or contact Support for help. When this limit is enforced, our documentation will be updated with a way to work around this limit. For more information, see "{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif currentVersion ver_lt "enterprise-server@3.0" %}[Deleting a package](/packages/learn-github-packages/deleting-a-package){% endif %}" or "[Contacting Support](/packages/learn-github-packages/about-github-packages#contacting-support)." +If you reach this limit, consider deleting package versions or contact Support for help. When this limit is enforced, our documentation will be updated with a way to work around this limit. For more information, see "{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif currentVersion ver_lt "enterprise-server@3.1" or currentVersion == "github-ae@latest" %}[Deleting a package](/packages/learn-github-packages/deleting-a-package){% endif %}" or "[Contacting Support](/packages/learn-github-packages/about-github-packages#contacting-support)." {% endif %} @@ -37,7 +39,7 @@ If you reach this limit, consider deleting package versions or contact Support f You can authenticate to {% data variables.product.prodname_registry %} with npm by either editing your per-user *~/.npmrc* file to include your personal access token or by logging in to npm on the command line using your username and personal access token. -To authenticate by adding your personal access token to your *~/.npmrc* file, edit the *~/.npmrc* file for your project to include the following line, replacing {% if enterpriseServerVersions contains currentVersion %}*HOSTNAME* with the host name of your {% data variables.product.prodname_ghe_server %} instance and {% endif %}*TOKEN* with your personal access token. Create a new *~/.npmrc* file if one doesn't exist. +To authenticate by adding your personal access token to your *~/.npmrc* file, edit the *~/.npmrc* file for your project to include the following line, replacing {% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}*HOSTNAME* with the host name of {% data variables.product.product_location %} and {% endif %}*TOKEN* with your personal access token. Create a new *~/.npmrc* file if one doesn't exist. {% if enterpriseServerVersions contains currentVersion %} If your instance has subdomain isolation enabled: @@ -183,7 +185,7 @@ You also need to add the *.npmrc* file to your project so all requests to instal #### Installing packages from other organizations -By default, you can only use {% data variables.product.prodname_registry %} packages from one organization. If you'd like to route package requests to multiple organizations and users, you can add additional lines to your *.npmrc* file, replacing {% if enterpriseServerVersions contains currentVersion %}*HOSTNAME* with the host name of your {% data variables.product.prodname_ghe_server %} instance and {% endif %}*OWNER* with the name of the user or organization account that owns the repository containing your project. +By default, you can only use {% data variables.product.prodname_registry %} packages from one organization. If you'd like to route package requests to multiple organizations and users, you can add additional lines to your *.npmrc* file, replacing {% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}*HOSTNAME* with the host name of {% data variables.product.product_location %} and {% endif %}*OWNER* with the name of the user or organization account that owns the repository containing your project. {% if enterpriseServerVersions contains currentVersion %} If your instance has subdomain isolation enabled: @@ -205,7 +207,7 @@ registry=https://HOSTNAME/_registry/npm/OWNER ``` {% endif %} -{% if currentVersion == "enterprise-server@3.0" or currentVersion ver_gt "enterprise-server@3.0" %} +{% if currentVersion ver_gt "enterprise-server@2.22" %} ### Using the official NPM registry {% data variables.product.prodname_registry %} allows you to access the official NPM registry at `registry.npmjs.com`, if your {% data variables.product.prodname_ghe_server %} administrator has enabled this feature. For more information, see [Connecting to the official NPM registry](/admin/packages/configuring-packages-support-for-your-enterprise#connecting-to-the-official-npm-registry). @@ -213,4 +215,4 @@ registry=https://HOSTNAME/_registry/npm/OWNER ### Further reading -- "{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif currentVersion ver_lt "enterprise-server@3.0" %}[Deleting a package](/packages/learn-github-packages/deleting-a-package){% endif %}." +- "{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif currentVersion ver_lt "enterprise-server@3.1" or currentVersion == "github-ae@latest" %}[Deleting a package](/packages/learn-github-packages/deleting-a-package){% endif %}" diff --git a/content/packages/guides/configuring-rubygems-for-use-with-github-packages.md b/content/packages/guides/configuring-rubygems-for-use-with-github-packages.md index 95ee9b221c..5a045c4629 100644 --- a/content/packages/guides/configuring-rubygems-for-use-with-github-packages.md +++ b/content/packages/guides/configuring-rubygems-for-use-with-github-packages.md @@ -10,9 +10,11 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.package_registry.packages-ghes-release-stage %} +{% data reusables.package_registry.packages-ghae-release-stage %} {% data reusables.package_registry.admins-can-configure-package-types %} @@ -59,6 +61,8 @@ To install gems, you need to authenticate to {% data variables.product.prodname_ - `TOKEN` with your personal access token. - `OWNER` with the name of the user or organization account that owns the repository containing your project.{% if enterpriseServerVersions contains currentVersion %} - `REGISTRY-URL` with the URL for your instance's Rubygems registry. If your instance has subdomain isolation enabled, use `rubygems.HOSTNAME`. If your instance has subdomain isolation disabled, use `HOSTNAME/_registry/rubygems`. In either case, replace *HOSTNAME* with the hostname of your {% data variables.product.prodname_ghe_server %} instance. +{% elsif currentVersion == "github-ae@latest" %} + - `REGISTRY-URL` with the URL for your instance's Rubygems registry, `rubygems.HOSTNAME`. Replace *HOSTNAME* with the hostname of {% data variables.product.product_location %}. {% endif %} If you don't have a *~/.gemrc* file, create a new *~/.gemrc* file using this example. @@ -75,7 +79,7 @@ If you don't have a *~/.gemrc* file, create a new *~/.gemrc* file using this exa ``` -To authenticate with Bundler, configure Bundler to use your personal access token, replacing *USERNAME* with your {% data variables.product.prodname_dotcom %} username, *TOKEN* with your personal access token, and *OWNER* with the name of the user or organization account that owns the repository containing your project.{% if enterpriseServerVersions contains currentVersion %} Replace `REGISTRY-URL` with the URL for your instance's Rubygems registry. If your instance has subdomain isolation enabled, use `rubygems.HOSTNAME`. If your instance has subdomain isolation disabled, use `HOSTNAME/_registry/rubygems`. In either case, replace *HOSTNAME* with the hostname of your {% data variables.product.prodname_ghe_server %} instance.{% endif %} +To authenticate with Bundler, configure Bundler to use your personal access token, replacing *USERNAME* with your {% data variables.product.prodname_dotcom %} username, *TOKEN* with your personal access token, and *OWNER* with the name of the user or organization account that owns the repository containing your project.{% if enterpriseServerVersions contains currentVersion %} Replace `REGISTRY-URL` with the URL for your instance's Rubygems registry. If your instance has subdomain isolation enabled, use `rubygems.HOSTNAME`. If your instance has subdomain isolation disabled, use `HOSTNAME/_registry/rubygems`. In either case, replace *HOSTNAME* with the hostname of your {% data variables.product.prodname_ghe_server %} instance.{% elsif currentVersion == "github-ae@latest" %}Replace `REGISTRY-URL` with the URL for your instance's Rubygems registry, `rubygems.HOSTNAME`. Replace *HOSTNAME* with the hostname of {% data variables.product.product_location %}.{% endif %} ```shell $ bundle config https://{% if currentVersion == "free-pro-team@latest" %}rubygems.pkg.github.com{% else %}REGISTRY-URL{% endif %}/OWNER USERNAME:TOKEN @@ -96,7 +100,7 @@ $ bundle config https://{% if currentVersion == "free-pro-team@latest" %}rubygem ```shell gem build OCTO-GEM.gemspec ``` -3. Publish a package to {% data variables.product.prodname_registry %}, replacing `OWNER` with the name of the user or organization account that owns the repository containing your project and `OCTO-GEM` with the name of your gem package.{% if enterpriseServerVersions contains currentVersion %} Replace `REGISTRY-URL` with the URL for your instance's Rubygems registry. If your instance has subdomain isolation enabled, use `rubygems.HOSTNAME`. If your instance has subdomain isolation disabled, use `HOSTNAME/_registry/rubygems`. In either case, replace *HOSTNAME* with the host name of your {% data variables.product.prodname_ghe_server %} instance.{% endif %} +3. Publish a package to {% data variables.product.prodname_registry %}, replacing `OWNER` with the name of the user or organization account that owns the repository containing your project and `OCTO-GEM` with the name of your gem package.{% if enterpriseServerVersions contains currentVersion %} Replace `REGISTRY-URL` with the URL for your instance's Rubygems registry. If your instance has subdomain isolation enabled, use `rubygems.HOSTNAME`. If your instance has subdomain isolation disabled, use `HOSTNAME/_registry/rubygems`. In either case, replace *HOSTNAME* with the host name of your {% data variables.product.prodname_ghe_server %} instance.{% elsif currentVersion == "github-ae@latest" %} Replace `REGISTRY-URL` with the URL for your instance's Rubygems registry, `rubygems.HOSTNAME`. Replace *HOSTNAME* with the hostname of {% data variables.product.product_location %}.{% endif %} ```shell $ gem push --key github \ @@ -106,7 +110,7 @@ $ bundle config https://{% if currentVersion == "free-pro-team@latest" %}rubygem ### Publishing multiple packages to the same repository -To publish multiple gems to the same repository, you can include the URL to the {% data variables.product.prodname_dotcom %} repository in the `github_repo` field in `gem.metadata`. If you include this field, {% data variables.product.prodname_dotcom %} matches the repository based on this value, instead of using the gem name.{% if enterpriseServerVersions contains currentVersion %} Replace *HOSTNAME* with the host name of your {% data variables.product.prodname_ghe_server %} instance.{% endif %} +To publish multiple gems to the same repository, you can include the URL to the {% data variables.product.prodname_dotcom %} repository in the `github_repo` field in `gem.metadata`. If you include this field, {% data variables.product.prodname_dotcom %} matches the repository based on this value, instead of using the gem name.{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %} Replace *HOSTNAME* with the host name of {% data variables.product.product_location %}.{% endif %} ```ruby gem.metadata = { "github_repo" => "ssh://{% if currentVersion == "free-pro-team@latest" %}github.com{% else %}HOSTNAME{% endif %}/OWNER/REPOSITORY" } @@ -117,7 +121,7 @@ gem.metadata = { "github_repo" => "ssh://{% if currentVersion == "free-pro-team@ You can use gems from {% data variables.product.prodname_registry %} much like you use gems from *rubygems.org*. You need to authenticate to {% data variables.product.prodname_registry %} by adding your {% data variables.product.prodname_dotcom %} user or organization as a source in the *~/.gemrc* file or by using Bundler and editing you *Gemfile*. {% data reusables.package_registry.authenticate-step %} -2. For Bundler, add your {% data variables.product.prodname_dotcom %} user or organization as a source in your *Gemfile* to fetch gems from this new source. For example, you can add a new `source` block to your *Gemfile* that uses {% data variables.product.prodname_registry %} only for the packages you specify, replacing *GEM NAME* with the package you want to install from {% data variables.product.prodname_registry %} and *OWNER* with the user or organization that owns the repository containing the gem you want to install.{% if enterpriseServerVersions contains currentVersion %} Replace `REGISTRY-URL` with the URL for your instance's Rubygems registry. If your instance has subdomain isolation enabled, use `rubygems.HOSTNAME`. If your instance has subdomain isolation disabled, use `HOSTNAME/_registry/rubygems`. In either case, replace *HOSTNAME* with the host name of your {% data variables.product.prodname_ghe_server %} instance.{% endif %} +1. For Bundler, add your {% data variables.product.prodname_dotcom %} user or organization as a source in your *Gemfile* to fetch gems from this new source. For example, you can add a new `source` block to your *Gemfile* that uses {% data variables.product.prodname_registry %} only for the packages you specify, replacing *GEM NAME* with the package you want to install from {% data variables.product.prodname_registry %} and *OWNER* with the user or organization that owns the repository containing the gem you want to install.{% if enterpriseServerVersions contains currentVersion %} Replace `REGISTRY-URL` with the URL for your instance's Rubygems registry. If your instance has subdomain isolation enabled, use `rubygems.HOSTNAME`. If your instance has subdomain isolation disabled, use `HOSTNAME/_registry/rubygems`. In either case, replace *HOSTNAME* with the host name of your {% data variables.product.prodname_ghe_server %} instance.{% elsif currentVersion == "github-ae@latest" %} Replace `REGISTRY-URL` with the URL for your instance's Rubygems registry, `rubygems.HOSTNAME`. Replace *HOSTNAME* with the hostname of {% data variables.product.product_location %}.{% endif %} ```ruby source "https://rubygems.org" @@ -146,4 +150,4 @@ You can use gems from {% data variables.product.prodname_registry %} much like y ### Further reading -- "{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif currentVersion ver_lt "enterprise-server@3.0" %}[Deleting a package](/packages/learn-github-packages/deleting-a-package){% endif %}." +- "{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif currentVersion ver_lt "enterprise-server@3.1" or currentVersion == "github-ae@latest" %}[Deleting a package](/packages/learn-github-packages/deleting-a-package){% endif %}" diff --git a/content/packages/guides/container-guides-for-github-packages.md b/content/packages/guides/container-guides-for-github-packages.md index 31b8f63889..1b482e040a 100644 --- a/content/packages/guides/container-guides-for-github-packages.md +++ b/content/packages/guides/container-guides-for-github-packages.md @@ -6,5 +6,6 @@ mapTopic: true versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- diff --git a/content/packages/guides/index.md b/content/packages/guides/index.md index f7aefb201f..923574422e 100644 --- a/content/packages/guides/index.md +++ b/content/packages/guides/index.md @@ -8,9 +8,11 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.package_registry.packages-ghes-release-stage %} +{% data reusables.package_registry.packages-ghae-release-stage %} ### Table of Contents diff --git a/content/packages/guides/package-client-guides-for-github-packages.md b/content/packages/guides/package-client-guides-for-github-packages.md index 6f77e8b9bd..27432d0717 100644 --- a/content/packages/guides/package-client-guides-for-github-packages.md +++ b/content/packages/guides/package-client-guides-for-github-packages.md @@ -6,5 +6,6 @@ mapTopic: true versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- diff --git a/content/packages/guides/using-github-packages-with-github-actions.md b/content/packages/guides/using-github-packages-with-github-actions.md index 8f9a3f5c6d..f04d9c2b5b 100644 --- a/content/packages/guides/using-github-packages-with-github-actions.md +++ b/content/packages/guides/using-github-packages-with-github-actions.md @@ -8,9 +8,13 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.package_registry.packages-ghes-release-stage %} +{% data reusables.package_registry.packages-ghae-release-stage %} +{% data reusables.actions.ae-beta %} +{% data reusables.actions.ae-self-hosted-runners-notice %} ### About {% data variables.product.prodname_registry %} with {% data variables.product.prodname_actions %} @@ -45,7 +49,7 @@ The following example demonstrates how you can use {% data variables.product.pro - Create a new workflow file in your repository (such as `.github/workflows/deploy-image.yml`), and add the following YAML: {% raw %} - ``` + ```yaml{:copy} name: Create and publish a package on: push: @@ -99,7 +103,7 @@ The following example demonstrates how you can use {% data variables.product.pro with: username: ${{ github.actor }} password: ${{ secrets.GITHUB_TOKEN }} - registry: docker.pkg.github.com + registry: {% endraw %}{% if currentVersion == "github-ae@latest" %}docker.YOUR-HOSTNAME.com{% else %}docker.pkg.github.com{% endif %}{% raw %} repository: ${{ github.repository }}/octo-image tag_with_sha: true tag_with_ref: true @@ -251,14 +255,12 @@ password: ${{ secrets.GITHUB_TOKEN }} -{% raw %} ```yaml -registry: docker.pkg.github.com +registry: {% if currentVersion == "github-ae@latest" %}docker.YOUR-HOSTNAME.com{% else %}docker.pkg.github.com{% endif %} ``` -{% endraw %} - Defines the registry that will host the resulting packages. This example uses {% data variables.product.prodname_registry %}. + Defines the registry that will host the resulting packages. This example uses {% data variables.product.prodname_registry %}.{% if currentVersion == "github-ae@latest" %} Replace YOUR-HOSTNAME with the name of your enterprise.{% endif %} @@ -302,7 +304,7 @@ tag_with_ref: true -- This new workflow will run automatically every time you push a change to the repository. You can view the progress in the **Actions** tab. +- This new workflow will run automatically every time you push a change to a branch named `release` in the repository. You can view the progress in the **Actions** tab. - A few minutes after the workflow has completed, the new package will visible in your repository. To find your available packages, see "[Viewing a repository's packages](/packages/publishing-and-managing-packages/viewing-packages#viewing-a-repositorys-packages)." ### Installing a package using an action diff --git a/content/packages/index.md b/content/packages/index.md index 46b6102074..14afebfca8 100644 --- a/content/packages/index.md +++ b/content/packages/index.md @@ -37,6 +37,7 @@ layout: product-landing versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- diff --git a/content/packages/learn-github-packages/about-github-packages.md b/content/packages/learn-github-packages/about-github-packages.md index 68a5a00f5d..3aa637f5d7 100644 --- a/content/packages/learn-github-packages/about-github-packages.md +++ b/content/packages/learn-github-packages/about-github-packages.md @@ -1,6 +1,6 @@ --- title: About GitHub Packages -intro: '{% data variables.product.prodname_registry %} is a software package hosting service that allows you to host your software packages privately or publicly and use packages as dependencies in your projects.' +intro: '{% data variables.product.prodname_registry %} is a software package hosting service that allows you to host your software packages privately {% if currentVersion == "github-ae@latest" %} for specified users or internally for your enterprise{% else %}or publicly{% endif %} and use packages as dependencies in your projects.' product: '{% data reusables.gated-features.packages %}' redirect_from: - /articles/about-github-package-registry @@ -10,32 +10,27 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.package_registry.packages-ghes-release-stage %} +{% data reusables.package_registry.packages-ghae-release-stage %} ### About {% data variables.product.prodname_registry %} -{% data variables.product.prodname_registry %} is a platform for hosting and managing packages, including containers and other dependencies. {% data variables.product.prodname_registry %} combines your source code and packages in one place to provide integrated permissions management and billing, so you can centralize your software development on {% data variables.product.product_name %}. +{% data variables.product.prodname_registry %} is a platform for hosting and managing packages, including containers and other dependencies. {% data variables.product.prodname_registry %} combines your source code and packages in one place to provide integrated permissions management{% if currentVersion != "github-ae@latest" %} and billing{% endif %}, so you can centralize your software development on {% data variables.product.product_name %}. You can integrate {% data variables.product.prodname_registry %} with {% data variables.product.product_name %} APIs, {% data variables.product.prodname_actions %}, and webhooks to create an end-to-end DevOps workflow that includes your code, CI, and deployment solutions. {% data variables.product.prodname_registry %} offers different package registries for commonly used packages, such as for Node, RubyGems, Apache Maven, Gradle, and Nuget. - -{% if currentVersion ver_gt "enterprise-server@2.21" %} - -![Diagram showing the GitHub Packages hosting urls for npm, RubyGems, Apache Maven, Gradle, Nuget, and Docker](/assets/images/help/package-registry/ghes-packages-diagram.png) - -{% endif %} +![Diagram showing packages support for npm, RubyGems, Apache Maven, Gradle, Nuget, and Docker](/assets/images/help/package-registry/packages-overview-diagram.png) {% if currentVersion == "free-pro-team@latest" %} {% data variables.product.prodname_registry %} also offers a {% data variables.product.prodname_container_registry %} designed to support the unique needs of container images. For more information, see "[About {% data variables.product.prodname_github_container_registry %}](/packages/guides/about-github-container-registry)." {% data reusables.package_registry.container-registry-beta %} -![Diagram showing the GitHub Packages hosting urls for npm, RubyGems, Apache Maven, Gradle, Nuget, and Docker](/assets/images/help/package-registry/packages-overview-diagram.png) - {% endif %} #### Viewing packages @@ -63,52 +58,16 @@ You can review the package's README, some metadata like licensing, download stat {% data variables.product.prodname_registry %} uses the native package tooling commands you're already familiar with to publish and install package versions. #### Support for package registries -{% if currentVersion == "free-pro-team@latest" %} -Package registries use `PACKAGE-TYPE.pkg.github.com/OWNER/REPOSITORY/IMAGE-NAME` as the package host URL, replacing `PACKAGE-TYPE` with the Package namespace. For example, your Gemfile will be hosted at `rubygems.pkg.github.com/OWNER/REPOSITORY/IMAGE-NAME`. - -{% else %} - -The package types supported on {% data variables.product.product_location %} may vary since your site administrator can enable or disable support for different package types. For more information, see "[Managing GitHub Packages for your enterprise](/enterprise/admin/packages)." - -If {% data variables.product.product_location %} has subdomain isolation enabled, then package registries will use `PACKAGE-TYPE.HOSTNAME/OWNER/REPOSITORY/IMAGE-NAME` as the package host URL, replacing `PACKAGE-TYPE` with the Package namespace. For example, your Dockerfile will be hosted at `docker.HOSTNAME/OWNER/REPOSITORY/IMAGE-NAME`. - -If {% data variables.product.product_location %} has subdomain isolation disabled, then package registries will use `HOSTNAME/_registry/PACKAGE-TYPE/OWNER/REPOSITORY/IMAGE-NAME` as the package host URL. For example, your Gemfile will be hosted at `HOSTNAME/_registry/rubygems/OWNER/REPOSITORY/IMAGE-NAME`, replacing *HOSTNAME* with the host name of your {% data variables.product.prodname_ghe_server %} instance. - -{% endif %} - -{% if currentVersion == "free-pro-team@latest" %} - -| Language | Description | Package format | Package client | Package namespace | -| --- | --- | --- | --- | --- | -| JavaScript | Node package manager | `package.json` | `npm` | `npm.pkg.github.com/OWNER/REPOSITORY/IMAGE-NAME` -| Ruby | RubyGems package manager | `Gemfile` | `gem` | `rubygems.pkg.github.com/OWNER/REPOSITORY/IMAGE-NAME` -| Java | Apache Maven project management and comprehension tool | `pom.xml` | `mvn` | `maven.pkg.github.com/OWNER/REPOSITORY/IMAGE-NAME` -| Java | Gradle build automation tool for Java | `build.gradle` or `build.gradle.kts` | `gradle` | `maven.pkg.github.com/OWNER/REPOSITORY/IMAGE-NAME` -| .NET | NuGet package management for .NET | `nupkg` | `dotnet` CLI | `nuget.pkg.github.com/OWNER/REPOSITORY/IMAGE-NAME` - -{% else %} - -With subdomain isolation enabled on {% data variables.product.product_location %}: - -| Language | Description | Package format | Package client | Package namespace | -| --- | --- | --- | --- | --- | -| JavaScript | Node package manager | `package.json` | `npm` | `npm.HOSTNAME/OWNER/REPOSITORY/IMAGE-NAME` -| Ruby | RubyGems package manager | `Gemfile` | `gem` | `rubygems.HOSTNAME/OWNER/REPOSITORY/IMAGE-NAME` -| Java | Apache Maven project management and comprehension tool | `pom.xml` | `mvn` | `maven.HOSTNAME/OWNER/REPOSITORY/IMAGE-NAME` -| Java | Gradle build automation tool for Java | `build.gradle` or `build.gradle.kts` | `gradle` | `maven.HOSTNAME/OWNER/REPOSITORY/IMAGE-NAME` -| .NET | NuGet package management for .NET | `nupkg` | `dotnet` CLI | `nuget.HOSTNAME/OWNER/REPOSITORY/IMAGE-NAME` -| N/A | Docker container management | `Dockerfile` | `Docker` | `docker.HOSTNAME/OWNER/REPOSITORY/IMAGE-NAME` - -With subdomain isolation disabled on {% data variables.product.product_location %}: - -| Language | Description | Package format | Package client | Package namespace | -| --- | --- | --- | --- | --- | -| JavaScript | Node package manager | `package.json` | `npm` | `HOSTNAME/_registry/npm/OWNER/REPOSITORY/IMAGE-NAME` -| Ruby | RubyGems package manager | `Gemfile` | `gem` | `HOSTNAME/_registry/rubygems/OWNER/REPOSITORY/IMAGE-NAME` -| Java | Apache Maven project management and comprehension tool | `pom.xml` | `mvn` | `HOSTNAME/_registry/maven/OWNER/REPOSITORY/IMAGE-NAME` -| Java | Gradle build automation tool for Java | `build.gradle` or `build.gradle.kts` | `gradle` | `HOSTNAME/_registry/maven/OWNER/REPOSITORY/IMAGE-NAME` -| .NET | NuGet package management for .NET | `nupkg` | `dotnet` CLI | `HOSTNAME/_registry/nuget/OWNER/REPOSITORY/IMAGE-NAME` +| Language | Description | Package format | Package client | +| --- | --- | --- | --- | +| JavaScript | Node package manager | `package.json` | `npm` | +| Ruby | RubyGems package manager | `Gemfile` | `gem` | +| Java | Apache Maven project management and comprehension tool | `pom.xml` | `mvn` | +| Java | Gradle build automation tool for Java | `build.gradle` or `build.gradle.kts` | `gradle` | +| .NET | NuGet package management for .NET | `nupkg` | `dotnet` CLI | +| N/A | Docker container management | `Dockerfile` | `Docker` | +{% if currentVersion ver_gt "enterprise-server@2.22" %} {% note %} **Note:** Docker is not supported when subdomain isolation is disabled. @@ -134,13 +93,13 @@ To use or manage a package hosted by a package registry, you must use a token wi For example: - To download and install packages from a repository, your token must have the `read:packages` scope, and your user account must have read permissions for the repository. -- {% if currentVersion == "free-pro-team@latest" or if currentVersion ver_gt "enterprise-server@3.0" %}To delete a package on {% data variables.product.product_name %}, your token must at least have the `delete:packages` and `read:packages` scope. The `repo` scope is also required for repo-scoped packages.{% endif %}{% if currentVersion ver_lt "enterprise-server@3.1" %}To delete a specified version of a private package on {% data variables.product.product_name %}, your token must have the `delete:packages` and `repo` scope. Public packages cannot be deleted.{% endif %} For more information, see "{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif currentVersion ver_lt "enterprise-server@3.1" %}[Deleting a package](/packages/learn-github-packages/deleting-a-package){% endif %}." +- {% if currentVersion == "free-pro-team@latest" or if currentVersion ver_gt "enterprise-server@3.0" %}To delete a package on {% data variables.product.product_name %}, your token must at least have the `delete:packages` and `read:packages` scope. The `repo` scope is also required for repo-scoped packages.{% elsif currentVersion ver_lt "enterprise-server@3.1" %}To delete a specified version of a private package on {% data variables.product.product_name %}, your token must have the `delete:packages` and `repo` scope. Public packages cannot be deleted.{% elsif currentVersion == "github-ae@latest" %}To delete a specified version of a package on {% data variables.product.product_name %}, your token must have the `delete:packages` and `repo` scope.{% endif %} For more information, see "{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif currentVersion ver_lt "enterprise-server@3.1" or currentVersion == "github-ae@latest" %}[Deleting a package](/packages/learn-github-packages/deleting-a-package){% endif %}." | Scope | Description | Repository permissions | | --- | --- | --- | |`read:packages`| Download and install packages from {% data variables.product.prodname_registry %} | read | |`write:packages`| Upload and publish packages to {% data variables.product.prodname_registry %} | write | -| `delete:packages` | {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} Delete packages from {% data variables.product.prodname_registry %} {% endif %}{% if currentVersion ver_lt "enterprise-server@3.1" %} Delete specified versions of private packages from {% data variables.product.prodname_registry %} {% endif %} | admin | +| `delete:packages` | {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} Delete packages from {% data variables.product.prodname_registry %} {% elsif currentVersion ver_lt "enterprise-server@3.1" %} Delete specified versions of private packages from {% data variables.product.prodname_registry %}{% elsif currentVersion == "github-ae@latest" %} Delete specified versions of packages from {% data variables.product.prodname_registry %} {% endif %} | admin | | `repo` | Upload and delete packages (along with `write:packages`, or `delete:packages`) | write, or admin | When you create a {% data variables.product.prodname_actions %} workflow, you can use the `GITHUB_TOKEN` to publish and install packages in {% data variables.product.prodname_registry %} without needing to store and manage a personal access token. @@ -164,7 +123,11 @@ You can delete a private or public package in the {% data variables.product.prod You can delete a version of a private package in the {% data variables.product.product_name %} user interface or using the GraphQL API. {% endif %} -When you use the GraphQL API to query and delete private packages, you must use the same token you use to authenticate to {% data variables.product.prodname_registry %}. For more information, see "{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif currentVersion ver_lt "enterprise-server@3.1" %}[Deleting a package](/packages/learn-github-packages/deleting-a-package){% endif %}" and "[Forming calls with GraphQL](/graphql/guides/forming-calls-with-graphql)." +{% if currentVersion == "github-ae@latest" %} +You can delete a version of a package in the {% data variables.product.product_name %} user interface or using the GraphQL API. +{% endif %} + +When you use the GraphQL API to query and delete private packages, you must use the same token you use to authenticate to {% data variables.product.prodname_registry %}. For more information, see "{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif currentVersion ver_lt "enterprise-server@3.1" or currentVersion == "github-ae@latest" %}[Deleting a package](/packages/learn-github-packages/deleting-a-package){% endif %}" and "[Forming calls with GraphQL](/graphql/guides/forming-calls-with-graphql)." You can configure webhooks to subscribe to package-related events, such as when a package is published or updated. For more information, see the "[`package` webhook event](/webhooks/event-payloads/#package)." diff --git a/content/packages/learn-github-packages/core-concepts-for-github-packages.md b/content/packages/learn-github-packages/core-concepts-for-github-packages.md index 07b7774cd7..25a14cbc94 100644 --- a/content/packages/learn-github-packages/core-concepts-for-github-packages.md +++ b/content/packages/learn-github-packages/core-concepts-for-github-packages.md @@ -7,9 +7,11 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.package_registry.packages-ghes-release-stage %} +{% data reusables.package_registry.packages-ghae-release-stage %} ### Package diff --git a/content/packages/learn-github-packages/deleting-a-package.md b/content/packages/learn-github-packages/deleting-a-package.md index 0a09d23e8b..d23b0e652e 100644 --- a/content/packages/learn-github-packages/deleting-a-package.md +++ b/content/packages/learn-github-packages/deleting-a-package.md @@ -1,20 +1,22 @@ --- title: Deleting a package -intro: 'You can delete a version of a private package using GraphQL or on {% data variables.product.product_name %}.' +intro: 'You can delete a version of a {% if currentVersion != "github-ae@latest" %}private{% endif %} package using GraphQL or on {% data variables.product.product_name %}.' product: '{% data reusables.gated-features.packages %}' versions: enterprise-server: '>=2.22 <3.1' + github-ae: '*' --- {% data reusables.package_registry.packages-ghes-release-stage %} +{% data reusables.package_registry.packages-ghae-release-stage %} -At this time, {% data variables.product.prodname_registry %} on {% data variables.product.product_location %} does not support deleting public packages. +{% if currentVersion != "github-ae@latest" %}At this time, {% data variables.product.prodname_registry %} on {% data variables.product.product_location %} does not support deleting public packages.{% endif %} -You can only delete a specified version of a private package on {% data variables.product.product_name %} or with the GraphQL API. To remove an entire private package from appearing on {% data variables.product.product_name %}, you must delete every version of the package first. +You can only delete a specified version of a {% if currentVersion != "github-ae@latest" %}private {% endif %}package on {% data variables.product.product_name %} or with the GraphQL API. To remove an entire {% if currentVersion != "github-ae@latest" %}private {% endif %}package from appearing on {% data variables.product.product_name %}, you must delete every version of the package first. -### Deleting a version of a private package on {% data variables.product.product_name %} +### Deleting a version of a {% if currentVersion != "github-ae@latest" %}private {% endif %}package on {% data variables.product.product_name %} -To delete a private package version, you must have admin permissions in the repository. +To delete a {% if currentVersion != "github-ae@latest" %}private {% endif %}package version, you must have admin permissions in the repository. {% data reusables.repositories.navigate-to-repo %} {% data reusables.package_registry.packages-from-code-tab %} @@ -27,7 +29,7 @@ To delete a private package version, you must have admin permissions in the repo 6. To confirm deletion, type the package name and click **I understand the consequences, delete this version**. ![Confirm package deletion button](/assets/images/help/package-registry/confirm-package-deletion.png) -### Deleting a version of a private package with GraphQL +### Deleting a version of a {% if currentVersion != "github-ae@latest" %}private {% endif %}package with GraphQL Use the `deletePackageVersion` mutation in the GraphQL API. You must use a token with the `read:packages`, `delete:packages`, and `repo` scopes. For more information about tokens, see "[About {% data variables.product.prodname_registry %}](/packages/publishing-and-managing-packages/about-github-packages#authenticating-to-github-packages)." @@ -41,7 +43,7 @@ curl -X POST \ HOSTNAME/graphql ``` -To find all of the private packages you have published to {% data variables.product.prodname_registry %}, along with the version IDs for the packages, you can use the `packages` connection through the `repository` object. You will need a token with the `read:packages` and `repo` scopes. For more information, see the [`packages`](/graphql/reference/objects#repository) connection or the [`PackageOwner`](/graphql/reference/interfaces#packageowner) interface. +To find all of the {% if currentVersion != "github-ae@latest" %}private {% endif %}packages you have published to {% data variables.product.prodname_registry %}, along with the version IDs for the packages, you can use the `packages` connection through the `repository` object. You will need a token with the `read:packages` and `repo` scopes. For more information, see the [`packages`](/graphql/reference/objects#repository) connection or the [`PackageOwner`](/graphql/reference/interfaces#packageowner) interface. For more information about the `deletePackageVersion` mutation, see "[`deletePackageVersion`](/graphql/reference/mutations#deletepackageversion)." diff --git a/content/packages/learn-github-packages/index.md b/content/packages/learn-github-packages/index.md index 9af1511955..cd736ad2b3 100644 --- a/content/packages/learn-github-packages/index.md +++ b/content/packages/learn-github-packages/index.md @@ -7,9 +7,11 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.package_registry.packages-ghes-release-stage %} +{% data reusables.package_registry.packages-ghae-release-stage %} {% link_in_list /about-github-packages %} {% link_in_list /core-concepts-for-github-packages %} diff --git a/content/packages/learn-github-packages/publishing-a-package.md b/content/packages/learn-github-packages/publishing-a-package.md index 9294af45b6..674946386a 100644 --- a/content/packages/learn-github-packages/publishing-a-package.md +++ b/content/packages/learn-github-packages/publishing-a-package.md @@ -9,9 +9,11 @@ permissions: Anyone with write permissions for a repository can publish a packag versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.package_registry.packages-ghes-release-stage %} +{% data reusables.package_registry.packages-ghae-release-stage %} ### About published packages @@ -25,7 +27,7 @@ If a new version of a package fixes a security vulnerability, you should publish ### Publishing a package -You can publish a package to {% data variables.product.prodname_registry %} using any {% if currentVersion == "free-pro-team@latest" %}supported package client{% else %}package type enabled for your instance{% endif %} by following the same general guidelines. +You can publish a package to {% data variables.product.prodname_registry %} using any {% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" %}supported package client{% else %}package type enabled for your instance{% endif %} by following the same general guidelines. 1. Create or use an existing access token with the appropriate scopes for the task you want to accomplish. For more information, see "[About {% data variables.product.prodname_registry %}](/packages/publishing-and-managing-packages/about-github-packages#authenticating-to-github-packages)." 2. Authenticate to {% data variables.product.prodname_registry %} using your access token and the instructions for your package client. diff --git a/content/packages/manage-packages/index.md b/content/packages/manage-packages/index.md index 21d7e0d6c3..cfeaf4c7a6 100644 --- a/content/packages/manage-packages/index.md +++ b/content/packages/manage-packages/index.md @@ -9,9 +9,11 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.package_registry.packages-ghes-release-stage %} +{% data reusables.package_registry.packages-ghae-release-stage %} {% link_in_list /viewing-packages %} {% link_in_list /installing-a-package %} diff --git a/content/packages/manage-packages/installing-a-package.md b/content/packages/manage-packages/installing-a-package.md index 007e344089..6b67f161ad 100644 --- a/content/packages/manage-packages/installing-a-package.md +++ b/content/packages/manage-packages/installing-a-package.md @@ -9,9 +9,11 @@ permissions: Anyone with read permissions for a repository can install a package versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.package_registry.packages-ghes-release-stage %} +{% data reusables.package_registry.packages-ghae-release-stage %} ### About package installation @@ -21,7 +23,7 @@ After you find a package, you can read the package's description and installatio ### Installing a package -You can install a package from {% data variables.product.prodname_registry %} using any {% if currentVersion == "free-pro-team@latest" %}supported package client{% else %}package type enabled for your instance{% endif %} by following the same general guidelines. +You can install a package from {% data variables.product.prodname_registry %} using any {% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" %}supported package client{% else %}package type enabled for your instance{% endif %} by following the same general guidelines. 1. Authenticate to {% data variables.product.prodname_registry %} using the instructions for your package client. For more information, see "[About tokens](/packages/publishing-and-managing-packages/about-github-packages#authenticating-to-github-packages)." 2. Install the package using the instructions for your package client. diff --git a/content/packages/manage-packages/viewing-packages.md b/content/packages/manage-packages/viewing-packages.md index d61604627e..ee2985a359 100644 --- a/content/packages/manage-packages/viewing-packages.md +++ b/content/packages/manage-packages/viewing-packages.md @@ -11,9 +11,11 @@ permissions: Anyone with read permissions to a repository can view the repositor versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.package_registry.packages-ghes-release-stage %} +{% data reusables.package_registry.packages-ghae-release-stage %} ### About package views diff --git a/content/packages/quickstart.md b/content/packages/quickstart.md index 99e96e8a87..cb593588cf 100644 --- a/content/packages/quickstart.md +++ b/content/packages/quickstart.md @@ -1,33 +1,36 @@ --- title: Quickstart for GitHub Packages -intro: 'Publish to {% data variables.product.prodname_registry %} in 5 minutes or less with {% data variables.product.prodname_actions %}.' +intro: 'Publish to {% data variables.product.prodname_registry %} with {% data variables.product.prodname_actions %}.' allowTitleToDifferFromFilename: true versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- +{% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} +{% data reusables.actions.ae-self-hosted-runners-notice %} + ### Introduction -You only need an existing {% data variables.product.prodname_dotcom %} repository to publish a package to {% data variables.product.prodname_registry %}. In this guide, you'll create a {% data variables.product.prodname_actions %} workflow to test your code and then publish it to {% data variables.product.prodname_registry %}. Feel free to create a new repository for this Quickstart. You can use it to test this and future {% data variables.product.prodname_actions %} workflows. +In this guide, you'll create a {% data variables.product.prodname_actions %} workflow to test your code and then publish it to {% data variables.product.prodname_registry %}. ### Publishing your package 1. Create a new repository on {% data variables.product.prodname_dotcom %}, adding the `.gitignore` for Node. {% if currentVersion ver_lt "enterprise-server@3.1" %} Create a private repository if you’d like to delete this package later, public packages cannot be deleted.{% endif %} For more information, see "[Creating a new repository](/github/creating-cloning-and-archiving-repositories/creating-a-new-repository)." 2. Clone the repository to your local machine. - {% raw %} ```shell - $ git clone https://github.com/YOUR-USERNAME/YOUR-REPOSITORY.git + $ git clone https://{% if currentVersion == "github-ae@latest" %}YOUR-HOSTNAME{% else %}github.com{% endif %}/YOUR-USERNAME/YOUR-REPOSITORY.git $ cd YOUR-REPOSITORY ``` - {% endraw %} 3. Create an `index.js` file and add a basic alert to say "Hello world!" {% raw %} ```javascript{:copy} alert("Hello, World!"); ``` {% endraw %} -4. Initialize an npm package. In the package initialization wizard, enter your package with the name: _`@YOUR-USERNAME/YOUR-REPOSITORY`_, and set the test script to `exit 0` if you do not have any tests. Commit your changes and push them to {% data variables.product.prodname_dotcom %}. +4. Initialize an npm package with `npm init`. In the package initialization wizard, enter your package with the name: _`@YOUR-USERNAME/YOUR-REPOSITORY`_, and set the test script to `exit 0`. This will generate a `package.json` file with information about your package. {% raw %} ```shell $ npm init @@ -35,17 +38,19 @@ You only need an existing {% data variables.product.prodname_dotcom %} repositor package name: @YOUR-USERNAME/YOUR-REPOSITORY ... test command: exit 0 - ... + ... + ``` + {% endraw %} +5. Run `npm install` to generate the `package-lock.json` file, then commit and push your changes to {% data variables.product.prodname_dotcom %}. + ```shell $ npm install $ git add index.js package.json package-lock.json $ git commit -m "initialize npm package" $ git push ``` - {% endraw %} -5. From your repository on {% data variables.product.prodname_dotcom %}, create a new file in the `.github/workflows` directory named `release-package.yml`. For more information, see "[Creating new files](/github/managing-files-in-a-repository/creating-new-files)." -6. Copy the following YAML content into the `release-package.yml` file. - {% raw %} +6. Create a `.github/workflows` directory. In that directory, create a file named `release-package.yml`. +7. Copy the following YAML content into the `release-package.yml` file{% if currentVersion == "github-ae@latest" %}, replacing `YOUR-HOSTNAME` with the name of your enterprise{% endif %}. ```yaml{:copy} name: Node.js Package @@ -72,18 +77,21 @@ You only need an existing {% data variables.product.prodname_dotcom %} repositor - uses: actions/setup-node@v1 with: node-version: 12 - registry-url: https://npm.pkg.github.com/ + registry-url: {% if currentVersion == "github-ae@latest" %}https://npm.YOUR-HOSTNAME.com/{% else %}https://npm.pkg.github.com/{% endif %} - run: npm ci - run: npm publish env: - NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}} + NODE_AUTH_TOKEN: ${% raw %}{{secrets.GITHUB_TOKEN}}{% endraw %} ``` - {% endraw %} -7. Scroll to the bottom of the page and select **Create a new branch for this commit and start a pull request**. Then, to create a pull request, click **Propose new file**. -8. **Merge** the pull request. -9. Navigate to the **Code** tab and create a new release to test the workflow. For more information, see "[Managing releases in a repository](/github/administering-a-repository/managing-releases-in-a-repository#creating-a-release)." - -Creating a new release in your repository triggers the workflow to build and test your code. If the tests pass, then the package will be published to {% data variables.product.prodname_registry %}. +8. Commit and push your changes to {% data variables.product.prodname_dotcom %}. + ```shell + $ git add .github/workflows/release-package.yml + $ git commit -m "workflow to publish package" + $ git push + ``` +9. The workflow that you created will run whenever a new release is created in your repository. If the tests pass, then the package will be published to {% data variables.product.prodname_registry %}. + + To test this out, navigate to the **Code** tab in your repository and create a new release. For more information, see "[Managing releases in a repository](/github/administering-a-repository/managing-releases-in-a-repository#creating-a-release)." ### Viewing your published package diff --git a/content/rest/guides/basics-of-authentication.md b/content/rest/guides/basics-of-authentication.md index 1cbc4cdb95..5613158c98 100644 --- a/content/rest/guides/basics-of-authentication.md +++ b/content/rest/guides/basics-of-authentication.md @@ -9,6 +9,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - api --- diff --git a/content/rest/guides/best-practices-for-integrators.md b/content/rest/guides/best-practices-for-integrators.md index c9bed981f3..fc3a313eb2 100644 --- a/content/rest/guides/best-practices-for-integrators.md +++ b/content/rest/guides/best-practices-for-integrators.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - api --- diff --git a/content/rest/guides/building-a-ci-server.md b/content/rest/guides/building-a-ci-server.md index a084419a96..77b0d89956 100644 --- a/content/rest/guides/building-a-ci-server.md +++ b/content/rest/guides/building-a-ci-server.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - api --- diff --git a/content/rest/guides/delivering-deployments.md b/content/rest/guides/delivering-deployments.md index b9ef899783..b5340295e8 100644 --- a/content/rest/guides/delivering-deployments.md +++ b/content/rest/guides/delivering-deployments.md @@ -9,6 +9,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - api --- diff --git a/content/rest/guides/discovering-resources-for-a-user.md b/content/rest/guides/discovering-resources-for-a-user.md index 5dec470323..1c6177f34e 100644 --- a/content/rest/guides/discovering-resources-for-a-user.md +++ b/content/rest/guides/discovering-resources-for-a-user.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - api --- @@ -22,7 +24,7 @@ If you haven't already, you should read the ["Basics of Authentication"][basics- ### Discover the repositories that your app can access for a user -In addition to having their own personal repositories, a user may be a collaborator on repositories owned by other users and organizations. Collectively, these are the repositories where the user has privileged access: either it's a private repository where the user has read or write access, or it's a public repository where the user has write access. +In addition to having their own personal repositories, a user may be a collaborator on repositories owned by other users and organizations. Collectively, these are the repositories where the user has privileged access: either it's a private repository where the user has read or write access, or it's a {% if currentVersion != "github-ae@latest" %}public{% else %}internal{% endif %} repository where the user has write access. [OAuth scopes][scopes] and [organization application policies][oap] determine which of those repositories your app can access for a user. Use the workflow below to discover those repositories. @@ -87,11 +89,11 @@ client.organizations.each do |organization| end ``` -#### Don’t rely on public organizations +#### Return all of the user's organization memberships If you've read the docs from cover to cover, you may have noticed an [API method for listing a user's public organization memberships][list-public-orgs]. Most applications should avoid this API method. This method only returns the user's public organization memberships, not their private organization memberships. -As an application, you typically want all of the user's organizations (public and private) that your app is authorized to access. The workflow above will give you exactly that. +As an application, you typically want all of the user's organizations that your app is authorized to access. The workflow above will give you exactly that. [basics-of-authentication]: /rest/guides/basics-of-authentication [list-public-orgs]: /rest/reference/orgs#list-organizations-for-a-user diff --git a/content/rest/guides/getting-started-with-the-checks-api.md b/content/rest/guides/getting-started-with-the-checks-api.md index e83f7ecde7..66e353a328 100644 --- a/content/rest/guides/getting-started-with-the-checks-api.md +++ b/content/rest/guides/getting-started-with-the-checks-api.md @@ -5,6 +5,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - api --- ### Overview diff --git a/content/rest/guides/getting-started-with-the-git-database-api.md b/content/rest/guides/getting-started-with-the-git-database-api.md index f95f46749d..7ce9354f48 100644 --- a/content/rest/guides/getting-started-with-the-git-database-api.md +++ b/content/rest/guides/getting-started-with-the-git-database-api.md @@ -5,6 +5,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - api --- ### Overview diff --git a/content/rest/guides/getting-started-with-the-rest-api.md b/content/rest/guides/getting-started-with-the-rest-api.md index 3a40af9cfc..2e5a47f87b 100644 --- a/content/rest/guides/getting-started-with-the-rest-api.md +++ b/content/rest/guides/getting-started-with-the-rest-api.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - api --- @@ -155,9 +157,7 @@ $ curl -i -u your_username:your_token {% data variables.produc ``` This time, in addition to the same set of public information we -retrieved for [@defunkt][defunkt github] earlier, you should also see the non-public -information for your user profile. For example, you'll see a `plan` object -in the response which gives details about the {% data variables.product.product_name %} plan for the account. +retrieved for [@defunkt][defunkt github] earlier, you should also see the non-public information for your user profile. For example, you'll see a `plan` object in the response which gives details about the {% data variables.product.product_name %} plan for the account. #### Using OAuth tokens for apps @@ -215,8 +215,9 @@ $ curl -i {% data variables.product.api_url_pre %}/orgs/octo-org/repos The information returned from these calls will depend on which scopes our token has when we authenticate: -* A token with `public_repo` [scope][scopes] returns a response that includes all public repositories we have access to see on github.com. -* A token with `repo` [scope][scopes] returns a response that includes all public and private repositories we have access to see on github.com. +{% if currentVersion != "github-ae@latest" %} +* A token with `public_repo` [scope][scopes] returns a response that includes all public repositories we have access to see on github.com.{% endif %} +* A token with `repo` [scope][scopes] returns a response that includes all {% if currentVersion != "github-ae@latest" %}public{% else %}internal{% endif %} and private repositories we have access to see on {% data variables.product.product_location %}. As the [docs][repos-api] indicate, these methods take a `type` parameter that can filter the repositories returned based on what type of access the user has @@ -249,10 +250,8 @@ $ curl -i -H "Authorization: token 5199831f4dd3b79e7c5b7e0ebe75d67aa66e79d4" \ {% data variables.product.api_url_pre %}/user/repos ``` -In this minimal example, we create a new repository for our blog (to be served -on [GitHub Pages][pages], perhaps). Though the blog will be public, we've made -the repository private. In this single step, we'll also initialize it with -a README and a [nanoc][nanoc]-flavored [.gitignore template][gitignore templates]. +In this minimal example, we create a new private repository for our blog (to be served +on [GitHub Pages][pages], perhaps). Though the blog {% if currentVersion != "github-ae@latest" %}will be public{% else %}is accessible to all enterprise members{% endif %}, we've made the repository private. In this single step, we'll also initialize it with a README and a [nanoc][nanoc]-flavored [.gitignore template][gitignore templates]. The resulting repository will be found at `https://github.com//blog`. To create a repository under an organization for which you're diff --git a/content/rest/guides/index.md b/content/rest/guides/index.md index bbdd90cbcc..1e63a63190 100644 --- a/content/rest/guides/index.md +++ b/content/rest/guides/index.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - api --- This section of the documentation is intended to get you up-and-running with diff --git a/content/rest/guides/rendering-data-as-graphs.md b/content/rest/guides/rendering-data-as-graphs.md index 1fb621b0b7..cbd50a3e8f 100644 --- a/content/rest/guides/rendering-data-as-graphs.md +++ b/content/rest/guides/rendering-data-as-graphs.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - api --- diff --git a/content/rest/guides/traversing-with-pagination.md b/content/rest/guides/traversing-with-pagination.md index 9ee0ffc050..50c89b4bdc 100644 --- a/content/rest/guides/traversing-with-pagination.md +++ b/content/rest/guides/traversing-with-pagination.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - api --- diff --git a/content/rest/guides/working-with-comments.md b/content/rest/guides/working-with-comments.md index 5b760d1877..5606e2030c 100644 --- a/content/rest/guides/working-with-comments.md +++ b/content/rest/guides/working-with-comments.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - api --- diff --git a/content/rest/overview/api-previews.md b/content/rest/overview/api-previews.md index e4f5ef4da8..02151bb9fe 100644 --- a/content/rest/overview/api-previews.md +++ b/content/rest/overview/api-previews.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - api --- @@ -165,7 +167,7 @@ Allows a GitHub App to run external checks on a repository's code. See the [Chec **Announced:** [2018-05-07](https://developer.github.com/changes/2018-05-07-new-checks-api-public-beta/) {% endif %} -{% if currentVersion == "github-ae@latest" or enterpriseServerVersions contains currentVersion %} +{% if currentVersion == enterpriseServerVersions contains currentVersion %} ### Anonymous Git access to repositories diff --git a/content/rest/overview/endpoints-available-for-github-apps.md b/content/rest/overview/endpoints-available-for-github-apps.md index bae1b28804..8105ff975c 100644 --- a/content/rest/overview/endpoints-available-for-github-apps.md +++ b/content/rest/overview/endpoints-available-for-github-apps.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - api --- You must use an installation access token to access endpoints using your {% data variables.product.prodname_github_app %}. For more information, see "[Authenticating with {% data variables.product.prodname_github_apps %}](/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation)." diff --git a/content/rest/overview/index.md b/content/rest/overview/index.md index 7e4de671cb..287f95ae14 100644 --- a/content/rest/overview/index.md +++ b/content/rest/overview/index.md @@ -6,6 +6,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - api --- ### Table of Contents diff --git a/content/rest/overview/libraries.md b/content/rest/overview/libraries.md index 6222ff0c3b..75cb6828c6 100644 --- a/content/rest/overview/libraries.md +++ b/content/rest/overview/libraries.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - api ---
@@ -80,7 +82,7 @@ Library name | Repository | Library name | Repository | |---|---| -**GitHub.jl**|[WestleyArgentum/GitHub.jl](https://github.com/WestleyArgentum/GitHub.jl) +**GitHub.jl**|[JuliaWeb/GitHub.jl](https://github.com/JuliaWeb/GitHub.jl) ### OCaml @@ -108,6 +110,12 @@ Library name | Repository **GitHub bridge for Laravel**|[GrahamCampbell/Laravel-GitHub](https://github.com/GrahamCampbell/Laravel-GitHub) **PHP7 Client & WebHook wrapper**|[FlexyProject/GitHubAPI](https://github.com/FlexyProject/GitHubAPI) +### PowerShell + +Library name | Repository +|---|---| +**PowerShellForGitHub**|[microsoft/PowerShellForGitHub](https://github.com/microsoft/PowerShellForGitHub) + ### Python Library name | Repository diff --git a/content/rest/overview/media-types.md b/content/rest/overview/media-types.md index ccbfff6046..25ece0fa28 100644 --- a/content/rest/overview/media-types.md +++ b/content/rest/overview/media-types.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - api --- diff --git a/content/rest/overview/openapi-description.md b/content/rest/overview/openapi-description.md index cdd2e1188e..9b38ae760b 100644 --- a/content/rest/overview/openapi-description.md +++ b/content/rest/overview/openapi-description.md @@ -1,9 +1,11 @@ --- title: OpenAPI description -intro: The {% data variables.product.product_name %} REST API is fully described in an OpenAPI 3.0 compliant document. +intro: 'The {% data variables.product.product_name %} REST API is fully described in an OpenAPI 3.0 compliant document.' versions: free-pro-team: '*' enterprise-server: '*' +topics: + - api --- ### About OpenAPI descriptions diff --git a/content/rest/overview/other-authentication-methods.md b/content/rest/overview/other-authentication-methods.md index e641de8216..8020cfd01a 100644 --- a/content/rest/overview/other-authentication-methods.md +++ b/content/rest/overview/other-authentication-methods.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - api --- diff --git a/content/rest/overview/resources-in-the-rest-api.md b/content/rest/overview/resources-in-the-rest-api.md index ef7a03c456..5344440e1d 100644 --- a/content/rest/overview/resources-in-the-rest-api.md +++ b/content/rest/overview/resources-in-the-rest-api.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - api --- @@ -178,7 +180,7 @@ For `POST`, `PATCH`, `PUT`, and `DELETE` requests, parameters not included in th with a Content-Type of 'application/json': ```shell -$ curl -i -u username -d '{"scopes":["public_repo"]}' {% data variables.product.api_url_pre %}/authorizations +$ curl -i -u username -d '{"scopes":["repo_deployment"]}' {% data variables.product.api_url_pre %}/authorizations ``` ### Root endpoint @@ -360,6 +362,8 @@ For users that belong to a {% data variables.product.prodname_ghe_cloud %} accou {% endif %} +When using the built-in `GITHUB_TOKEN` in GitHub Actions, the rate limit is 1,000 requests per hour per repository. For organizations that belong to a GitHub Enterprise Cloud account, this limit is 15,000 requests per hour per repository. + For unauthenticated requests, the rate limit allows for up to 60 requests per hour. Unauthenticated requests are associated with the originating IP address, and not the user making requests. {% data reusables.enterprise.rate_limit %} diff --git a/content/rest/overview/troubleshooting.md b/content/rest/overview/troubleshooting.md index a430cfd7be..1b163b90f5 100644 --- a/content/rest/overview/troubleshooting.md +++ b/content/rest/overview/troubleshooting.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - api --- diff --git a/content/rest/reference/actions.md b/content/rest/reference/actions.md index cf127e9282..e8b3a61288 100644 --- a/content/rest/reference/actions.md +++ b/content/rest/reference/actions.md @@ -6,8 +6,13 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' +topics: + - api --- +{% data reusables.actions.ae-beta %} + The {% data variables.product.prodname_actions %} API enables you to manage {% data variables.product.prodname_actions %} using the REST API. {% data reusables.actions.actions-authentication %} {% data variables.product.prodname_github_app %}s require the permissions mentioned in each endpoint. For more information, see "[{% data variables.product.prodname_actions %} Documentation](/actions)." {% for operation in currentRestOperations %} @@ -16,6 +21,8 @@ The {% data variables.product.prodname_actions %} API enables you to manage {% d ## Artifacts +{% data reusables.actions.ae-beta %} + The Artifacts API allows you to download, delete, and retrieve information about workflow artifacts. {% data reusables.actions.about-artifacts %} For more information, see "[Persisting workflow data using artifacts](/actions/automating-your-workflow-with-github-actions/persisting-workflow-data-using-artifacts)." {% data reusables.actions.actions-authentication %} {% data reusables.actions.actions-app-actions-permissions-api %} @@ -24,9 +31,11 @@ The Artifacts API allows you to download, delete, and retrieve information about {% if operation.subcategory == 'artifacts' %}{% include rest_operation %}{% endif %} {% endfor %} -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} ## Permissions +{% data reusables.actions.ae-beta %} + The Permissions API allows you to set permissions for what organizations and repositories are allowed to run {% data variables.product.prodname_actions %}, and what actions are allowed to run. For more information, see "[Usage limits, billing, and administration](/actions/reference/usage-limits-billing-and-administration#disabling-or-limiting-github-actions-for-your-repository-or-organization)." You can also set permissions for an enterprise. For more information, see the "[{% data variables.product.prodname_dotcom %} Enterprise administration](/rest/reference/enterprise-admin#github-actions)" REST API. @@ -38,6 +47,8 @@ You can also set permissions for an enterprise. For more information, see the "[ ## Secrets +{% data reusables.actions.ae-beta %} + The Secrets API lets you create, update, delete, and retrieve information about encrypted secrets. {% data reusables.actions.about-secrets %} For more information, see "[Creating and using encrypted secrets](/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets)." {% data reusables.actions.actions-authentication %} {% data variables.product.prodname_github_app %}s must have the `secrets` permission to use this API. Authenticated users must have collaborator access to a repository to create, update, or read secrets. @@ -48,6 +59,9 @@ The Secrets API lets you create, update, delete, and retrieve information about ## Self-hosted runners +{% data reusables.actions.ae-beta %} +{% data reusables.actions.ae-self-hosted-runners-notice %} + The Self-hosted Runners API allows you to register, view, and delete self-hosted runners. {% data reusables.actions.about-self-hosted-runners %} For more information, see "[Hosting your own runners](/actions/hosting-your-own-runners)." {% data reusables.actions.actions-authentication %} {% data variables.product.prodname_github_app %}s must have the `administration` permission for repositories or the `organization_self_hosted_runners` permission for organizations. Authenticated users must have admin access to the repository or organization to use this API. @@ -60,6 +74,9 @@ You can manage self-hosted runners for an enterprise. For more information, see ## Self-hosted runner groups +{% data reusables.actions.ae-beta %} +{% data reusables.actions.ae-self-hosted-runners-notice %} + The Self-hosted Runners Groups API allows you manage groups of self-hosted runners. For more information, see "[Managing access to self-hosted runners using groups](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups)." {% data reusables.actions.actions-authentication %} {% data variables.product.prodname_github_app %}s must have the `administration` permission for repositories or the `organization_self_hosted_runners` permission for organizations. Authenticated users must have admin access to the repository or organization to use this API. @@ -72,6 +89,8 @@ You can manage self-hosted runner groups for an enterprise. For more information ## Workflows +{% data reusables.actions.ae-beta %} + The Workflows API allows you to view workflows for a repository. {% data reusables.actions.about-workflows %} For more information, see "[Automating your workflow with GitHub Actions](/actions/automating-your-workflow-with-github-actions)." {% data reusables.actions.actions-authentication %} {% data reusables.actions.actions-app-actions-permissions-api %} @@ -82,6 +101,8 @@ The Workflows API allows you to view workflows for a repository. {% data reusabl ## Workflow jobs +{% data reusables.actions.ae-beta %} + The Workflow Jobs API allows you to view logs and workflow jobs. {% data reusables.actions.about-workflow-jobs %} For more information, see "[Workflow syntax for GitHub Actions](/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions)". {% data reusables.actions.actions-authentication %} {% data reusables.actions.actions-app-actions-permissions-api %} @@ -92,6 +113,8 @@ The Workflow Jobs API allows you to view logs and workflow jobs. {% data reusabl ## Workflow runs +{% data reusables.actions.ae-beta %} + The Workflow Runs API allows you to view, re-run, cancel, and view logs for workflow runs. {% data reusables.actions.about-workflow-runs %} For more information, see "[Managing a workflow run](/actions/automating-your-workflow-with-github-actions/managing-a-workflow-run)." {% data reusables.actions.actions-authentication %} {% data reusables.actions.actions-app-actions-permissions-api %} diff --git a/content/rest/reference/activity.md b/content/rest/reference/activity.md index d80553b6c3..ac89e3da37 100644 --- a/content/rest/reference/activity.md +++ b/content/rest/reference/activity.md @@ -6,6 +6,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - api --- {% for operation in currentRestOperations %} @@ -33,8 +35,6 @@ $ -H 'If-None-Match: "a18c3bded88eb5dbb5c849a489412bf3"' > X-Poll-Interval: 60 ``` -Events support pagination, however the `per_page` option is unsupported. The fixed page size is 30 items. Fetching up to ten pages is supported, for a total of 300 events. For information, see "[Traversing with pagination](/rest/guides/traversing-with-pagination)." - Only events created within the past 90 days will be included in timelines. Events older than 90 days will not be included (even if the total number of events in the timeline is less than 300). {% for operation in currentRestOperations %} diff --git a/content/rest/reference/apps.md b/content/rest/reference/apps.md index bb5f310f7d..9238601e1a 100644 --- a/content/rest/reference/apps.md +++ b/content/rest/reference/apps.md @@ -6,6 +6,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - api --- The GitHub Apps API enables you to get high-level information about a GitHub App as well as specific information about installations of the app. To learn more about GitHub Apps, see "[Authenticating as a GitHub App](/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app)." diff --git a/content/rest/reference/billing.md b/content/rest/reference/billing.md index e0ff6110c9..0fab2af1cd 100644 --- a/content/rest/reference/billing.md +++ b/content/rest/reference/billing.md @@ -2,6 +2,8 @@ title: Billing versions: free-pro-team: '*' +topics: + - api --- You can monitor your {% data variables.product.prodname_actions %} and {% data variables.product.prodname_registry %} charges and usage for a user and organization through the Billing API. diff --git a/content/rest/reference/checks.md b/content/rest/reference/checks.md index 67ba813b87..3b1a680aa1 100644 --- a/content/rest/reference/checks.md +++ b/content/rest/reference/checks.md @@ -6,6 +6,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - api --- The Checks API enables you to build GitHub Apps that run powerful checks against code changes in a repository. You can create apps that perform continuous integration, code linting, or code scanning services and provide detailed feedback on commits. For more information, see "[Getting started with the checks API](/rest/guides/getting-started-with-the-checks-api)" and "[Creating CI tests with the Checks API](/apps/quickstart-guides/creating-ci-tests-with-the-checks-api/)." diff --git a/content/rest/reference/code-scanning.md b/content/rest/reference/code-scanning.md index 71998e764e..535217ba8c 100644 --- a/content/rest/reference/code-scanning.md +++ b/content/rest/reference/code-scanning.md @@ -6,13 +6,16 @@ product: '{% data reusables.gated-features.code-scanning %}' versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' +topics: + - api --- {% data reusables.code-scanning.beta %} The {% data variables.product.prodname_code_scanning %} API lets you retrieve and update {% data variables.product.prodname_code_scanning %} alerts from a repository. You can use the endpoints to create automated reports for the {% data variables.product.prodname_code_scanning %} alerts in an organization or upload analysis results generated using offline {% data variables.product.prodname_code_scanning %} tools. For more information, see "[Finding security vulnerabilities and errors in your code](/github/finding-security-vulnerabilities-and-errors-in-your-code)." -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %} ### Custom media type for {% data variables.product.prodname_code_scanning %} There is one supported custom media type for the {% data variables.product.prodname_code_scanning %} REST API. You can use this with `GET` requests sent to the `/analyses/{analysis_id}` endpoint. When you use this media type with this operation, the response includes a subset of the actual data that was uploaded for the specified analysis, rather than details about the analysis, which is returned when you use the default media type. The response also includes additional data such as the `github/alertNumber` and `github/alertUrl` properties. The data is formatted as [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). diff --git a/content/rest/reference/codes-of-conduct.md b/content/rest/reference/codes-of-conduct.md index 50cb78757e..109bf9e922 100644 --- a/content/rest/reference/codes-of-conduct.md +++ b/content/rest/reference/codes-of-conduct.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - api --- You can use the Codes of Conduct API to retrieve information about a repository's code of conduct. To get a repository's code of conduct, use the "[Get a repository](/rest/reference/repos#get-a-repository)" endpoint. diff --git a/content/rest/reference/emojis.md b/content/rest/reference/emojis.md index ea2ca0751d..ec918c60c2 100644 --- a/content/rest/reference/emojis.md +++ b/content/rest/reference/emojis.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - api --- {% include rest_operations_at_current_path %} diff --git a/content/rest/reference/enterprise-admin.md b/content/rest/reference/enterprise-admin.md index fdeb04fecb..eca5f8f968 100644 --- a/content/rest/reference/enterprise-admin.md +++ b/content/rest/reference/enterprise-admin.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - api --- You can use these endpoints to administer your enterprise. @@ -16,7 +18,7 @@ You can use these endpoints to administer your enterprise. {% note %} -**Note:** This article applies to {% data variables.product.prodname_ghe_cloud %}. To see the {% data variables.product.prodname_ghe_server %} version, use the **{% data ui.pages.article_version %}** drop-down menu. +**Note:** This article applies to {% data variables.product.prodname_ghe_cloud %}. To see the {% data variables.product.prodname_ghe_managed %} or {% data variables.product.prodname_ghe_server %} version, use the **{% data ui.pages.article_version %}** drop-down menu. {% endnote %} @@ -79,9 +81,11 @@ You can also read the current version by calling the [meta endpoint](/rest/refer {% endif %} -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %} ## GitHub Actions +{% data reusables.actions.ae-beta %} + {% for operation in currentRestOperations %} {% if operation.subcategory == 'actions' %}{% include rest_operation %}{% endif %} {% endfor %} diff --git a/content/rest/reference/gists.md b/content/rest/reference/gists.md index 1ff371cc24..58d47faa72 100644 --- a/content/rest/reference/gists.md +++ b/content/rest/reference/gists.md @@ -6,6 +6,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - api --- ### Authentication diff --git a/content/rest/reference/git.md b/content/rest/reference/git.md index b7f6a6ffaa..19e1c541ad 100644 --- a/content/rest/reference/git.md +++ b/content/rest/reference/git.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - api --- The Git Database API gives you access to read and write raw Git objects to your Git database on {% data variables.product.product_name %} and to list and update your references (branch heads and tags). For more information about using the Git Database API, see "[Getting started with the Git data API](/rest/guides/getting-started-with-the-git-database-api)." diff --git a/content/rest/reference/gitignore.md b/content/rest/reference/gitignore.md index 21728e0dd3..08f18a2449 100644 --- a/content/rest/reference/gitignore.md +++ b/content/rest/reference/gitignore.md @@ -6,6 +6,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - api --- When you create a new {% data variables.product.product_name %} repository via the API, you can specify a [.gitignore template](/github/using-git/ignoring-files) to apply to the repository upon creation. The .gitignore templates API lists and fetches templates from the {% data variables.product.product_name %} [.gitignore repository](https://github.com/github/gitignore). diff --git a/content/rest/reference/index.md b/content/rest/reference/index.md index 3e0c064f4c..88efef37c8 100644 --- a/content/rest/reference/index.md +++ b/content/rest/reference/index.md @@ -6,6 +6,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - api --- ### Table of Contents diff --git a/content/rest/reference/interactions.md b/content/rest/reference/interactions.md index 1fb73f9948..bce7ba6dff 100644 --- a/content/rest/reference/interactions.md +++ b/content/rest/reference/interactions.md @@ -4,6 +4,8 @@ redirect_from: - /v3/interactions versions: free-pro-team: '*' +topics: + - api --- Users interact with repositories by commenting, opening issues, and creating pull requests. The Interactions APIs allow people with owner or admin access to temporarily restrict interaction with public repositories to a certain type of user. diff --git a/content/rest/reference/issues.md b/content/rest/reference/issues.md index d2bc96ed21..f69333fbc5 100644 --- a/content/rest/reference/issues.md +++ b/content/rest/reference/issues.md @@ -6,6 +6,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - api --- ### Custom media types for issues diff --git a/content/rest/reference/licenses.md b/content/rest/reference/licenses.md index 080f5cba43..3a67c0b3c8 100644 --- a/content/rest/reference/licenses.md +++ b/content/rest/reference/licenses.md @@ -6,6 +6,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - api --- The Licenses API returns metadata about popular open source licenses and information about a particular project's license file. diff --git a/content/rest/reference/markdown.md b/content/rest/reference/markdown.md index 5a71bd7804..e978876791 100644 --- a/content/rest/reference/markdown.md +++ b/content/rest/reference/markdown.md @@ -6,6 +6,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - api --- {% include rest_operations_at_current_path %} diff --git a/content/rest/reference/meta.md b/content/rest/reference/meta.md index b261f929a2..6cd6fa2083 100644 --- a/content/rest/reference/meta.md +++ b/content/rest/reference/meta.md @@ -6,6 +6,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - api --- {% include rest_operations_at_current_path %} diff --git a/content/rest/reference/migrations.md b/content/rest/reference/migrations.md index f1709a3c8f..c75353316f 100644 --- a/content/rest/reference/migrations.md +++ b/content/rest/reference/migrations.md @@ -6,6 +6,8 @@ redirect_from: - /v3/migration/migrations versions: free-pro-team: '*' +topics: + - api --- {% for operation in currentRestOperations %} diff --git a/content/rest/reference/orgs.md b/content/rest/reference/orgs.md index 919098c451..45d9e1c36c 100644 --- a/content/rest/reference/orgs.md +++ b/content/rest/reference/orgs.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - api --- {% for operation in currentRestOperations %} diff --git a/content/rest/reference/packages.md b/content/rest/reference/packages.md index 53450d887c..36dc874017 100644 --- a/content/rest/reference/packages.md +++ b/content/rest/reference/packages.md @@ -3,6 +3,8 @@ title: Packages product: '{% data reusables.gated-features.packages %}' versions: free-pro-team: '*' +topics: + - api --- The {% data variables.product.prodname_registry %} API enables you to manage packages using the REST API. To learn more about restoring or deleting packages, see "[Restoring and deleting packages](/packages/learn-github-packages/deleting-and-restoring-a-package)." diff --git a/content/rest/reference/permissions-required-for-github-apps.md b/content/rest/reference/permissions-required-for-github-apps.md index 1aff449d4c..9f6a813ca7 100644 --- a/content/rest/reference/permissions-required-for-github-apps.md +++ b/content/rest/reference/permissions-required-for-github-apps.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - api --- ### About {% data variables.product.prodname_github_app %} permissions @@ -837,29 +839,29 @@ _Teams_ - [`PATCH /repos/:owner/:repo/secret-scanning/alerts/:alert_number`](/rest/reference/secret-scanning#update-a-secret-scanning-alert) (:write) {% endif %} -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %} ### Permission on "security events" - [`GET /repos/:owner/:repo/code-scanning/alerts`](/rest/reference/code-scanning#list-code-scanning-alerts-for-a-repository) (:read) - [`GET /repos/:owner/:repo/code-scanning/alerts/:alert_number`](/rest/reference/code-scanning#get-a-code-scanning-alert) (:read) - [`PATCH /repos/:owner/:repo/code-scanning/alerts/:alert_number`](/rest/reference/code-scanning#update-a-code-scanning-alert) (:write) {% endif %} -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %} - [`GET /repos/:owner/:repo/code-scanning/alerts/:alert_number/instances`](/rest/reference/code-scanning#list-instances-of-a-code-scanning-alert) (:read) {% endif %} -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %} - [`GET /repos/:owner/:repo/code-scanning/analyses`](/rest/reference/code-scanning#list-code-scanning-analyses-for-a-repository) (:read) {% endif %} -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %} - [`GET /repos/:owner/:repo/code-scanning/analyses/:analysis_id`](/rest/reference/code-scanning#get-a-code-scanning-analysis-for-a-repository) (:read) {% endif %} {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} - [`DELETE /repos/:owner/:repo/code-scanning/analyses/:analysis_id`](/rest/reference/code-scanning#delete-a-code-scanning-analysis-from-a-repository) (:write) {% endif %} -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %} -- [`POST /repos/:owner/:repo/code-scanning/sarifs`](/rest/reference/code-scanning#upload-a-sarif-file) (:write) +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %} +- [`POST /repos/:owner/:repo/code-scanning/sarifs`](/rest/reference/code-scanning#upload-an-analysis-as-sarif-data) (:write) {% endif %} -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %} - [`GET /repos/:owner/:repo/code-scanning/sarifs/:sarif_id`](/rest/reference/code-scanning#get-information-about-a-sarif-upload) (:read) {% endif %} diff --git a/content/rest/reference/projects.md b/content/rest/reference/projects.md index 9ff76062b5..30b524f6e5 100644 --- a/content/rest/reference/projects.md +++ b/content/rest/reference/projects.md @@ -6,6 +6,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - api --- {% for operation in currentRestOperations %} diff --git a/content/rest/reference/pulls.md b/content/rest/reference/pulls.md index 2009b2db26..ebd99b432d 100644 --- a/content/rest/reference/pulls.md +++ b/content/rest/reference/pulls.md @@ -6,6 +6,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - api --- The Pull Request API allows you to list, view, edit, create, and even merge pull requests. Comments on pull requests can be managed via the [Issue Comments API](/rest/reference/issues#comments). diff --git a/content/rest/reference/rate-limit.md b/content/rest/reference/rate-limit.md index 01e09ecc01..6b744f26b4 100644 --- a/content/rest/reference/rate-limit.md +++ b/content/rest/reference/rate-limit.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - api --- The REST API overview documentation describes the [rate limit rules](/rest/overview/resources-in-the-rest-api#rate-limiting). You can check your current rate limit status at any time using the Rate Limit API described below. diff --git a/content/rest/reference/reactions.md b/content/rest/reference/reactions.md index 8992d99049..7ddd930ec4 100644 --- a/content/rest/reference/reactions.md +++ b/content/rest/reference/reactions.md @@ -6,6 +6,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - api --- ### Reaction types diff --git a/content/rest/reference/repos.md b/content/rest/reference/repos.md index 7233e0457f..19579cf814 100644 --- a/content/rest/reference/repos.md +++ b/content/rest/reference/repos.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - api --- {% for operation in currentRestOperations %} @@ -140,7 +142,8 @@ Below is a simple sequence diagram for how these interactions would work. Keep in mind that GitHub is never actually accessing your servers. It's up to your third-party integration to interact with deployment events. Multiple systems can listen for deployment events, and it's up to each of those systems to decide whether they're responsible for pushing the code out to your servers, building native code, etc. -Note that the `repo_deployment` [OAuth scope](/developers/apps/scopes-for-oauth-apps) grants targeted access to deployments and deployment statuses **without** granting access to repository code, while the `public_repo` and `repo` scopes grant permission to code as well. +Note that the `repo_deployment` [OAuth scope](/developers/apps/scopes-for-oauth-apps) grants targeted access to deployments and deployment statuses **without** granting access to repository code, while the {% if currentVersion != "github-ae@latest" %}`public_repo` and{% endif %}`repo` scopes grant permission to code as well. + ### Inactive deployments @@ -152,7 +155,7 @@ You can communicate that a transient environment no longer exists by setting its {% if operation.subcategory == 'deployments' %}{% include rest_operation %}{% endif %} {% endfor %} -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %} ## Environments The Environments API allows you to create, configure, and delete environments. For more information about environments, see "[Environments](/actions/reference/environments)." @@ -197,7 +200,7 @@ The authenticated user will be the author of any merges done through this endpoi ## Pages -The {% data variables.product.prodname_pages %} API retrieves information about your {% data variables.product.prodname_pages %} configuration, and the statuses of your builds. Information about the site and the builds can only be accessed by authenticated owners, even though the websites are public. For more information, see "[About {% data variables.product.prodname_pages %}](/github/working-with-github-pages/about-github-pages)." +The {% data variables.product.prodname_pages %} API retrieves information about your {% data variables.product.prodname_pages %} configuration, and the statuses of your builds. Information about the site and the builds can only be accessed by authenticated owners{% if currentVersion != "github-ae@latest" %}, even if the websites are public{% endif %}. For more information, see "[About {% data variables.product.prodname_pages %}](/github/working-with-github-pages/about-github-pages)." In {% data variables.product.prodname_pages %} API endpoints with a `status` key in their response, the value can be one of: * `null`: The site has yet to be built. diff --git a/content/rest/reference/scim.md b/content/rest/reference/scim.md index fb032ed898..df50c65a89 100644 --- a/content/rest/reference/scim.md +++ b/content/rest/reference/scim.md @@ -4,6 +4,8 @@ redirect_from: - /v3/scim versions: free-pro-team: '*' +topics: + - api --- ### SCIM Provisioning for Organizations diff --git a/content/rest/reference/search.md b/content/rest/reference/search.md index fc289eac25..7de75572c3 100644 --- a/content/rest/reference/search.md +++ b/content/rest/reference/search.md @@ -6,6 +6,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - api --- The Search API helps you search for the specific item you want to find. For example, you can find a user or a specific file in a repository. Think of it the way you think of performing a search on Google. It's designed to help you find the one result you're looking for (or maybe the few results you're looking for). Just like searching on Google, you sometimes want to see a few pages of search results so that you can find the item that best meets your needs. To satisfy that need, the {% data variables.product.product_name %} Search API provides **up to 1,000 results for each search**. diff --git a/content/rest/reference/teams.md b/content/rest/reference/teams.md index 7223e949ec..7f6b2a3bf4 100644 --- a/content/rest/reference/teams.md +++ b/content/rest/reference/teams.md @@ -6,6 +6,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - api --- This API is only available to authenticated members of the team's [organization](/rest/reference/orgs). OAuth access tokens require the `read:org` [scope](/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). {% data variables.product.prodname_dotcom %} generates the team's `slug` from the team `name`. @@ -16,7 +18,7 @@ This API is only available to authenticated members of the team's [organization] ## Discussions -The team discussions API allows you to get, create, edit, and delete discussion posts on a team's page. You can use team discussions to have conversations that are not specific to a repository or project. Any member of the team's [organization](/rest/reference/orgs) can create and read public discussion posts. For more details, see "[About team discussions](/articles/about-team-discussions/)." To learn more about commenting on a discussion post, see the [team discussion comments API](/rest/reference/teams#discussion-comments). This API is only available to authenticated members of the team's organization. +The team discussions API allows you to get, create, edit, and delete discussion posts on a team's page. You can use team discussions to have conversations that are not specific to a repository or project. Any member of the team's [organization](/rest/reference/orgs) can create and read public discussion posts. For more details, see "[About team discussions](/github/setting-up-and-managing-organizations-and-teams/about-team-discussions/)." To learn more about commenting on a discussion post, see the [team discussion comments API](/rest/reference/teams#discussion-comments). This API is only available to authenticated members of the team's organization. {% for operation in currentRestOperations %} {% if operation.subcategory == 'discussions' %}{% include rest_operation %}{% endif %} @@ -24,7 +26,7 @@ The team discussions API allows you to get, create, edit, and delete discussion ## Discussion comments -The team discussion comments API allows you to get, create, edit, and delete discussion comments on a [team discussion](/rest/reference/teams#discussions) post. Any member of the team's [organization](/rest/reference/orgs) can create and read comments on a public discussion. For more details, see "[About team discussions](/articles/about-team-discussions/)." This API is only available to authenticated members of the team's organization. +The team discussion comments API allows you to get, create, edit, and delete discussion comments on a [team discussion](/rest/reference/teams#discussions) post. Any member of the team's [organization](/rest/reference/orgs) can create and read comments on a public discussion. For more details, see "[About team discussions](/github/setting-up-and-managing-organizations-and-teams/about-team-discussions/)." This API is only available to authenticated members of the team's organization. {% for operation in currentRestOperations %} {% if operation.subcategory == 'discussion-comments' %}{% include rest_operation %}{% endif %} diff --git a/content/rest/reference/users.md b/content/rest/reference/users.md index 5371d5569c..a8be9cb182 100644 --- a/content/rest/reference/users.md +++ b/content/rest/reference/users.md @@ -6,6 +6,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - api --- Many of the resources on the users API provide a shortcut for getting information about the currently authenticated user. If a request URL does not include a `{username}` parameter then the response will be for the logged in user (and you must pass [authentication information](/rest/overview/resources-in-the-rest-api#authentication) with your request).{% if currentVersion == "free-pro-team@latest" or enterpriseServerVersions contains currentVersion %} Additional private information, such as whether a user has two-factor authentication enabled, is included when authenticated through basic auth or OAuth with the `user` scope.{% endif %} diff --git a/contributing/github-partners/README.md b/contributing/github-partners/README.md new file mode 100644 index 0000000000..598ad25148 --- /dev/null +++ b/contributing/github-partners/README.md @@ -0,0 +1,19 @@ +# GitHub Partners + +This folder contains templates to be used by GitHub's technology partners when contributing documentation, such as guides. + +To get started, please [open an issue using this link](https://github.com/github/docs/issues/new?template=partner-contributed-documentation.md). + +## Templates + +### Tutorial template +Tutorials guide the reader through an entire workflow to complete a task. + +You should consider creating a tutorial when: + +- The user has a basic understanding of the product and is interested in extending their use and understanding to solve a specific problem. +- The user is looking for expert advice and a detailed discussion on best practices related their problem. +- The user may have implemented a similar solution in the past using a different product. +- The user wants to validate whether the solution is appropriate for their needs. + +Get started with this template [here](tutorial.md). diff --git a/contributing/github-partners/tutorial.md b/contributing/github-partners/tutorial.md new file mode 100644 index 0000000000..e18d0c9a76 --- /dev/null +++ b/contributing/github-partners/tutorial.md @@ -0,0 +1,56 @@ +--- +title: Tutorial title +intro: 'Article intro. See tips for a great intro below' +product: '{{ optional product callout }}' +productVersions: +contributor: + name: + URL: +--- + + + + +### Introduction + + + +### Step 1: Action the user will take + + + + + +#### Task chunk + + + + + + +#### Another task chunk + + + +### Step 2: Do the next thing + + + +```yaml +on: + schedule: + - cron: "40 19 * * *" +``` + +### Further reading + + + +- "[Article title](article-URL)" diff --git a/contributing/search.md b/contributing/search.md index 093a419341..aad358bdf0 100644 --- a/contributing/search.md +++ b/contributing/search.md @@ -14,9 +14,26 @@ To see all existing search-related issues and pull requests, visit [github.com/g ## How to search -The site search is part of every version of docs.github.com. On any page, you can use the search box to search the documents we've indexed. -You can also query our search endpoint directly at: https://docs.github.com/search?language=en&version=dotcom&query=jekyll -This endpoint responds in JSON format, and fronts Algolia and Lunr. We recommend using this endpoint over directly integrating with Algolia or Lunr, as the endpoint will be more stable. +The site search is part of every version of docs.github.com. This endpoint responds in JSON format, and fronts Algolia and Lunr. We recommend using this endpoint over directly integrating with Algolia or Lunr, as the endpoint will be more stable. On any page, you can use the search box to search the documents we've indexed. +You can also query our search endpoint directly at: +`https://docs.github.com/search?version=&language=&filters=topics:&query=` + +- The VERSION can be any numbered GitHub Enterprise Server version (e.g., `2.22`, `3.0`), GitHub AE (`ghae`), or the Free pro team plan (`dotcom`). +- The LANGUAGE CODE can be: `cn`, `de`, `en`, `es`, `ja`, or `pt`. +- TOPIC can be any topics in [the allowed list of topics](/data/allowed-topics.js). The values in the `topics` attribute are **not** case sensitive, so filtering on `GitHub actions` or `github actions` will return the same result. **Note:** Currently, the topics filter only works for the dotcom version in the English language. We plan to expand this search query to other languages and versions in the future. +- Any search QUERY you'd like. + +For example, to filter on the topic `ssh` and the query `passphrases`, you'd use this search query: + +https://docs.github.com/search?version=dotcom&language=en&filters=topics:ssh&query=passphrases + +To filter for the topics `oauth apps` and `github apps` and the query `install`, you'd use this search query: + +https://docs.github.com/search?version=dotcom&language=en&filters=topics:'oauth apps'+AND+topics:'github apps'&query=install + +### Using the topics search filter + +Using the attribute `topics` in your query will only return results that have the matching topic value. The `topics` attribute is configured as a [`filter only` facet in Algolia](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/). When the topic contains spaces, you must use quotes. For Algolia, [here](https://www.algolia.com/doc/api-reference/api-parameters/filters/#handle-attributes-with-spaces) is an example for filters containing spaces. Algolia also requires [boolean operators](https://www.algolia.com/doc/api-reference/api-parameters/filters) to combine more than one filter. ## Production deploys @@ -116,7 +133,7 @@ Each record represents a section of a page. Sections are derived by splitting up ```js { objectID: '/en/actions/creating-actions/about-actions#about-actions', - url: 'https://help.github.com/en/actions/creating-actions/about-actions#about-actions', + url: 'https://docs.github.com/en/actions/creating-actions/about-actions#about-actions', slug: 'about-actions', breadcrumbs: 'GitHub Actions / Creating actions / About actions', heading: 'About actions', diff --git a/data/allowed-topics.js b/data/allowed-topics.js new file mode 100644 index 0000000000..a309eccd03 --- /dev/null +++ b/data/allowed-topics.js @@ -0,0 +1,84 @@ +// This is an AllowList of topics that are approved for use in `topics` +// frontmatter property. If a new topic is added to a Markdown file it must +// also be added to this file. + +// The purpose of this list is to ensure we prevent typos and put a process in +// place to keep a curated list of topics. This list also serves as a list of +// available topics filters when using the search endpoint +// (see /contributing/search#how-to-search) +// If you'd like to add a new topic, consult the topic guidelines in the +// content model, add the entry to this list, and ensure you loop in the +// content and/or content strategy team for review. + +module.exports = [ + '2fa', + 'Action development', + 'Amazon ECS', + 'Ant', + 'Azure App Service', + 'Azure Pipelines', + 'CD', + 'CI', + 'CircleCI', + 'Containers', + 'Docker', + 'Fundamentals', + 'GitLab', + 'Google Kubernetes Engine', + 'Gradle', + 'Java', + 'JavaScript', + 'Jenkins', + 'Maven', + 'Migration', + 'Node', + 'Packaging', + 'Powershell', + 'Project management', + 'Publishing', + 'Python', + 'Ruby', + 'Security', + 'Travis CI', + 'Workflows', + 'access management', + 'accounts', + 'api', + 'billing', + 'cli', + 'codespaces', + 'community', + 'desktop', + 'device verification', + 'early access', + 'enterprise', + 'events', + 'github', + 'github apps', + 'github search', + 'identity', + 'issues', + 'jobs', + 'legal', + 'marketplace', + 'mobile', + 'notifications', + 'oauth apps', + 'open source', + 'organizations', + 'pages', + 'permissions', + 'policy', + 'profile', + 'profiles', + 'projects', + 'pull requests', + 'repositories', + 'security', + 'sponsors', + 'ssh', + 'sso', + 'teams', + 'usernames', + 'webhooks' +] diff --git a/data/graphql/ghae/graphql_previews.ghae.yml b/data/graphql/ghae/graphql_previews.ghae.yml index 7efae64179..7d84d7d5da 100644 --- a/data/graphql/ghae/graphql_previews.ghae.yml +++ b/data/graphql/ghae/graphql_previews.ghae.yml @@ -84,20 +84,6 @@ - Mutation.createContentAttachment owning_teams: - '@github/feature-lifecycle' -- title: Pinned Issues Preview - description: This preview adds support for pinned issues. - toggled_by: ':elektra-preview' - announcement: null - updates: null - toggled_on: - - Repository.pinnedIssues - - PinnedIssue - - PinnedIssueEdge - - PinnedIssueConnection - - Mutation.pinIssue - - Mutation.unpinIssue - owning_teams: - - '@github/pe-pull-requests' - title: Labels Preview description: >- This preview adds support for adding, updating, creating and deleting diff --git a/data/graphql/ghae/schema.docs-ghae.graphql b/data/graphql/ghae/schema.docs-ghae.graphql index 486eff1a56..27a701c161 100644 --- a/data/graphql/ghae/schema.docs-ghae.graphql +++ b/data/graphql/ghae/schema.docs-ghae.graphql @@ -593,6 +593,41 @@ type AddStarPayload { starrable: Starrable } +""" +Autogenerated input type of AddVerifiableDomain +""" +input AddVerifiableDomainInput { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The URL of the domain + """ + domain: URI! + + """ + The ID of the owner to add the domain to + """ + ownerId: ID! @possibleTypes(concreteTypes: ["Enterprise", "Organization"], abstractType: "VerifiableDomainOwner") +} + +""" +Autogenerated return type of AddVerifiableDomain +""" +type AddVerifiableDomainPayload { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The verifiable domain that was added. + """ + domain: VerifiableDomain +} + """ Represents a 'added_to_project' event on a given issue or pull request. """ @@ -685,6 +720,36 @@ type App implements Node { url: URI! } +""" +Autogenerated input type of ApproveVerifiableDomain +""" +input ApproveVerifiableDomainInput { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The ID of the verifiable domain to approve. + """ + id: ID! @possibleTypes(concreteTypes: ["VerifiableDomain"]) +} + +""" +Autogenerated return type of ApproveVerifiableDomain +""" +type ApproveVerifiableDomainPayload { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The verifiable domain that was approved. + """ + domain: VerifiableDomain +} + """ Autogenerated input type of ArchiveRepository """ @@ -2067,6 +2132,16 @@ type CheckRun implements Node & UniformResourceLocatable { externalId: String id: ID! + """ + Whether this check run is required to pass before merging. + """ + isRequired( + """ + The pull request this check is required for + """ + pullRequestId: ID! + ): Boolean! + """ The name of the check for this check run. """ @@ -5113,6 +5188,61 @@ type CreateDeploymentStatusPayload @preview(toggledBy: "flash-preview") { deploymentStatus: DeploymentStatus } +""" +Autogenerated input type of CreateEnterpriseOrganization +""" +input CreateEnterpriseOrganizationInput { + """ + The logins for the administrators of the new organization. + """ + adminLogins: [String!]! + + """ + The email used for sending billing receipts. + """ + billingEmail: String! + + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The ID of the enterprise owning the new organization. + """ + enterpriseId: ID! @possibleTypes(concreteTypes: ["Enterprise"]) + + """ + The login of the new organization. + """ + login: String! + + """ + The profile name of the new organization. + """ + profileName: String! +} + +""" +Autogenerated return type of CreateEnterpriseOrganization +""" +type CreateEnterpriseOrganizationPayload { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The enterprise that owns the created organization. + """ + enterprise: Enterprise + + """ + The organization that was created. + """ + organization: Organization +} + """ Autogenerated input type of CreateIpAllowListEntry """ @@ -6481,6 +6611,36 @@ type DeleteTeamDiscussionPayload { clientMutationId: String } +""" +Autogenerated input type of DeleteVerifiableDomain +""" +input DeleteVerifiableDomainInput { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The ID of the verifiable domain to delete. + """ + id: ID! @possibleTypes(concreteTypes: ["VerifiableDomain"]) +} + +""" +Autogenerated return type of DeleteVerifiableDomain +""" +type DeleteVerifiableDomainPayload { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The owning account from which the domain was deleted. + """ + owner: VerifiableDomainOwner +} + """ Represents a 'demilestoned' event on a given issue or pull request. """ @@ -8200,6 +8360,41 @@ type EnterpriseOwnerInfo { value: DefaultRepositoryPermissionField! ): OrganizationConnection! + """ + A list of domains owned by the enterprise. + """ + domains( + """ + Returns the elements in the list that come after the specified cursor. + """ + after: String + + """ + Returns the elements in the list that come before the specified cursor. + """ + before: String + + """ + Returns the first _n_ elements from the list. + """ + first: Int + + """ + Filter whether or not the domain is verified. + """ + isVerified: Boolean = null + + """ + Returns the last _n_ elements from the list. + """ + last: Int + + """ + Ordering options for verifiable domains returned. + """ + orderBy: VerifiableDomainOrder = {field: DOMAIN, direction: ASC} + ): VerifiableDomainConnection! + """ The setting value for whether the enterprise has an IP allow list enabled. """ @@ -11259,6 +11454,11 @@ type Issue implements Assignable & Closable & Comment & Labelable & Lockable & N """ includesCreatedEdit: Boolean! + """ + Indicates whether or not this issue is currently pinned to the repository issues list + """ + isPinned: Boolean + """ Is this issue read by the viewer """ @@ -14152,577 +14352,1212 @@ type Mutation { """ Adds assignees to an assignable object. """ - addAssigneesToAssignable(input: AddAssigneesToAssignableInput!): AddAssigneesToAssignablePayload + addAssigneesToAssignable( + """ + Parameters for AddAssigneesToAssignable + """ + input: AddAssigneesToAssignableInput! + ): AddAssigneesToAssignablePayload """ Adds a comment to an Issue or Pull Request. """ - addComment(input: AddCommentInput!): AddCommentPayload + addComment( + """ + Parameters for AddComment + """ + input: AddCommentInput! + ): AddCommentPayload """ Adds an administrator to the global enterprise account. """ - addEnterpriseAdmin(input: AddEnterpriseAdminInput!): AddEnterpriseAdminPayload + addEnterpriseAdmin( + """ + Parameters for AddEnterpriseAdmin + """ + input: AddEnterpriseAdminInput! + ): AddEnterpriseAdminPayload """ Adds labels to a labelable object. """ - addLabelsToLabelable(input: AddLabelsToLabelableInput!): AddLabelsToLabelablePayload + addLabelsToLabelable( + """ + Parameters for AddLabelsToLabelable + """ + input: AddLabelsToLabelableInput! + ): AddLabelsToLabelablePayload """ Adds a card to a ProjectColumn. Either `contentId` or `note` must be provided but **not** both. """ - addProjectCard(input: AddProjectCardInput!): AddProjectCardPayload + addProjectCard( + """ + Parameters for AddProjectCard + """ + input: AddProjectCardInput! + ): AddProjectCardPayload """ Adds a column to a Project. """ - addProjectColumn(input: AddProjectColumnInput!): AddProjectColumnPayload + addProjectColumn( + """ + Parameters for AddProjectColumn + """ + input: AddProjectColumnInput! + ): AddProjectColumnPayload """ Adds a review to a Pull Request. """ - addPullRequestReview(input: AddPullRequestReviewInput!): AddPullRequestReviewPayload + addPullRequestReview( + """ + Parameters for AddPullRequestReview + """ + input: AddPullRequestReviewInput! + ): AddPullRequestReviewPayload """ Adds a comment to a review. """ - addPullRequestReviewComment(input: AddPullRequestReviewCommentInput!): AddPullRequestReviewCommentPayload + addPullRequestReviewComment( + """ + Parameters for AddPullRequestReviewComment + """ + input: AddPullRequestReviewCommentInput! + ): AddPullRequestReviewCommentPayload """ Adds a new thread to a pending Pull Request Review. """ - addPullRequestReviewThread(input: AddPullRequestReviewThreadInput!): AddPullRequestReviewThreadPayload + addPullRequestReviewThread( + """ + Parameters for AddPullRequestReviewThread + """ + input: AddPullRequestReviewThreadInput! + ): AddPullRequestReviewThreadPayload """ Adds a reaction to a subject. """ - addReaction(input: AddReactionInput!): AddReactionPayload + addReaction( + """ + Parameters for AddReaction + """ + input: AddReactionInput! + ): AddReactionPayload """ Adds a star to a Starrable. """ - addStar(input: AddStarInput!): AddStarPayload + addStar( + """ + Parameters for AddStar + """ + input: AddStarInput! + ): AddStarPayload + + """ + Adds a verifiable domain to an owning account. + """ + addVerifiableDomain( + """ + Parameters for AddVerifiableDomain + """ + input: AddVerifiableDomainInput! + ): AddVerifiableDomainPayload + + """ + Approve a verifiable domain for notification delivery. + """ + approveVerifiableDomain( + """ + Parameters for ApproveVerifiableDomain + """ + input: ApproveVerifiableDomainInput! + ): ApproveVerifiableDomainPayload """ Marks a repository as archived. """ - archiveRepository(input: ArchiveRepositoryInput!): ArchiveRepositoryPayload + archiveRepository( + """ + Parameters for ArchiveRepository + """ + input: ArchiveRepositoryInput! + ): ArchiveRepositoryPayload """ Update your status on GitHub. """ - changeUserStatus(input: ChangeUserStatusInput!): ChangeUserStatusPayload + changeUserStatus( + """ + Parameters for ChangeUserStatus + """ + input: ChangeUserStatusInput! + ): ChangeUserStatusPayload """ Clears all labels from a labelable object. """ - clearLabelsFromLabelable(input: ClearLabelsFromLabelableInput!): ClearLabelsFromLabelablePayload + clearLabelsFromLabelable( + """ + Parameters for ClearLabelsFromLabelable + """ + input: ClearLabelsFromLabelableInput! + ): ClearLabelsFromLabelablePayload """ Creates a new project by cloning configuration from an existing project. """ - cloneProject(input: CloneProjectInput!): CloneProjectPayload + cloneProject( + """ + Parameters for CloneProject + """ + input: CloneProjectInput! + ): CloneProjectPayload """ Create a new repository with the same files and directory structure as a template repository. """ - cloneTemplateRepository(input: CloneTemplateRepositoryInput!): CloneTemplateRepositoryPayload + cloneTemplateRepository( + """ + Parameters for CloneTemplateRepository + """ + input: CloneTemplateRepositoryInput! + ): CloneTemplateRepositoryPayload """ Close an issue. """ - closeIssue(input: CloseIssueInput!): CloseIssuePayload + closeIssue( + """ + Parameters for CloseIssue + """ + input: CloseIssueInput! + ): CloseIssuePayload """ Close a pull request. """ - closePullRequest(input: ClosePullRequestInput!): ClosePullRequestPayload + closePullRequest( + """ + Parameters for ClosePullRequest + """ + input: ClosePullRequestInput! + ): ClosePullRequestPayload """ Convert a project note card to one associated with a newly created issue. """ - convertProjectCardNoteToIssue(input: ConvertProjectCardNoteToIssueInput!): ConvertProjectCardNoteToIssuePayload + convertProjectCardNoteToIssue( + """ + Parameters for ConvertProjectCardNoteToIssue + """ + input: ConvertProjectCardNoteToIssueInput! + ): ConvertProjectCardNoteToIssuePayload """ Create a new branch protection rule """ - createBranchProtectionRule(input: CreateBranchProtectionRuleInput!): CreateBranchProtectionRulePayload + createBranchProtectionRule( + """ + Parameters for CreateBranchProtectionRule + """ + input: CreateBranchProtectionRuleInput! + ): CreateBranchProtectionRulePayload """ Create a check run. """ - createCheckRun(input: CreateCheckRunInput!): CreateCheckRunPayload + createCheckRun( + """ + Parameters for CreateCheckRun + """ + input: CreateCheckRunInput! + ): CreateCheckRunPayload """ Create a check suite """ - createCheckSuite(input: CreateCheckSuiteInput!): CreateCheckSuitePayload + createCheckSuite( + """ + Parameters for CreateCheckSuite + """ + input: CreateCheckSuiteInput! + ): CreateCheckSuitePayload """ Create a content attachment. """ - createContentAttachment(input: CreateContentAttachmentInput!): CreateContentAttachmentPayload @preview(toggledBy: "corsair-preview") + createContentAttachment( + """ + Parameters for CreateContentAttachment + """ + input: CreateContentAttachmentInput! + ): CreateContentAttachmentPayload @preview(toggledBy: "corsair-preview") """ Creates a new deployment event. """ - createDeployment(input: CreateDeploymentInput!): CreateDeploymentPayload @preview(toggledBy: "flash-preview") + createDeployment( + """ + Parameters for CreateDeployment + """ + input: CreateDeploymentInput! + ): CreateDeploymentPayload @preview(toggledBy: "flash-preview") """ Create a deployment status. """ - createDeploymentStatus(input: CreateDeploymentStatusInput!): CreateDeploymentStatusPayload @preview(toggledBy: "flash-preview") + createDeploymentStatus( + """ + Parameters for CreateDeploymentStatus + """ + input: CreateDeploymentStatusInput! + ): CreateDeploymentStatusPayload @preview(toggledBy: "flash-preview") + + """ + Creates an organization as part of an enterprise account. + """ + createEnterpriseOrganization( + """ + Parameters for CreateEnterpriseOrganization + """ + input: CreateEnterpriseOrganizationInput! + ): CreateEnterpriseOrganizationPayload """ Creates a new IP allow list entry. """ - createIpAllowListEntry(input: CreateIpAllowListEntryInput!): CreateIpAllowListEntryPayload + createIpAllowListEntry( + """ + Parameters for CreateIpAllowListEntry + """ + input: CreateIpAllowListEntryInput! + ): CreateIpAllowListEntryPayload """ Creates a new issue. """ - createIssue(input: CreateIssueInput!): CreateIssuePayload + createIssue( + """ + Parameters for CreateIssue + """ + input: CreateIssueInput! + ): CreateIssuePayload """ Creates a new label. """ - createLabel(input: CreateLabelInput!): CreateLabelPayload @preview(toggledBy: "bane-preview") + createLabel( + """ + Parameters for CreateLabel + """ + input: CreateLabelInput! + ): CreateLabelPayload @preview(toggledBy: "bane-preview") """ Creates a new project. """ - createProject(input: CreateProjectInput!): CreateProjectPayload + createProject( + """ + Parameters for CreateProject + """ + input: CreateProjectInput! + ): CreateProjectPayload """ Create a new pull request """ - createPullRequest(input: CreatePullRequestInput!): CreatePullRequestPayload + createPullRequest( + """ + Parameters for CreatePullRequest + """ + input: CreatePullRequestInput! + ): CreatePullRequestPayload """ Create a new Git Ref. """ - createRef(input: CreateRefInput!): CreateRefPayload + createRef( + """ + Parameters for CreateRef + """ + input: CreateRefInput! + ): CreateRefPayload """ Create a new repository. """ - createRepository(input: CreateRepositoryInput!): CreateRepositoryPayload + createRepository( + """ + Parameters for CreateRepository + """ + input: CreateRepositoryInput! + ): CreateRepositoryPayload """ Creates a new team discussion. """ - createTeamDiscussion(input: CreateTeamDiscussionInput!): CreateTeamDiscussionPayload + createTeamDiscussion( + """ + Parameters for CreateTeamDiscussion + """ + input: CreateTeamDiscussionInput! + ): CreateTeamDiscussionPayload """ Creates a new team discussion comment. """ - createTeamDiscussionComment(input: CreateTeamDiscussionCommentInput!): CreateTeamDiscussionCommentPayload + createTeamDiscussionComment( + """ + Parameters for CreateTeamDiscussionComment + """ + input: CreateTeamDiscussionCommentInput! + ): CreateTeamDiscussionCommentPayload """ Delete a branch protection rule """ - deleteBranchProtectionRule(input: DeleteBranchProtectionRuleInput!): DeleteBranchProtectionRulePayload + deleteBranchProtectionRule( + """ + Parameters for DeleteBranchProtectionRule + """ + input: DeleteBranchProtectionRuleInput! + ): DeleteBranchProtectionRulePayload """ Deletes a deployment. """ - deleteDeployment(input: DeleteDeploymentInput!): DeleteDeploymentPayload + deleteDeployment( + """ + Parameters for DeleteDeployment + """ + input: DeleteDeploymentInput! + ): DeleteDeploymentPayload """ Deletes an IP allow list entry. """ - deleteIpAllowListEntry(input: DeleteIpAllowListEntryInput!): DeleteIpAllowListEntryPayload + deleteIpAllowListEntry( + """ + Parameters for DeleteIpAllowListEntry + """ + input: DeleteIpAllowListEntryInput! + ): DeleteIpAllowListEntryPayload """ Deletes an Issue object. """ - deleteIssue(input: DeleteIssueInput!): DeleteIssuePayload + deleteIssue( + """ + Parameters for DeleteIssue + """ + input: DeleteIssueInput! + ): DeleteIssuePayload """ Deletes an IssueComment object. """ - deleteIssueComment(input: DeleteIssueCommentInput!): DeleteIssueCommentPayload + deleteIssueComment( + """ + Parameters for DeleteIssueComment + """ + input: DeleteIssueCommentInput! + ): DeleteIssueCommentPayload """ Deletes a label. """ - deleteLabel(input: DeleteLabelInput!): DeleteLabelPayload @preview(toggledBy: "bane-preview") + deleteLabel( + """ + Parameters for DeleteLabel + """ + input: DeleteLabelInput! + ): DeleteLabelPayload @preview(toggledBy: "bane-preview") """ Deletes a project. """ - deleteProject(input: DeleteProjectInput!): DeleteProjectPayload + deleteProject( + """ + Parameters for DeleteProject + """ + input: DeleteProjectInput! + ): DeleteProjectPayload """ Deletes a project card. """ - deleteProjectCard(input: DeleteProjectCardInput!): DeleteProjectCardPayload + deleteProjectCard( + """ + Parameters for DeleteProjectCard + """ + input: DeleteProjectCardInput! + ): DeleteProjectCardPayload """ Deletes a project column. """ - deleteProjectColumn(input: DeleteProjectColumnInput!): DeleteProjectColumnPayload + deleteProjectColumn( + """ + Parameters for DeleteProjectColumn + """ + input: DeleteProjectColumnInput! + ): DeleteProjectColumnPayload """ Deletes a pull request review. """ - deletePullRequestReview(input: DeletePullRequestReviewInput!): DeletePullRequestReviewPayload + deletePullRequestReview( + """ + Parameters for DeletePullRequestReview + """ + input: DeletePullRequestReviewInput! + ): DeletePullRequestReviewPayload """ Deletes a pull request review comment. """ - deletePullRequestReviewComment(input: DeletePullRequestReviewCommentInput!): DeletePullRequestReviewCommentPayload + deletePullRequestReviewComment( + """ + Parameters for DeletePullRequestReviewComment + """ + input: DeletePullRequestReviewCommentInput! + ): DeletePullRequestReviewCommentPayload """ Delete a Git Ref. """ - deleteRef(input: DeleteRefInput!): DeleteRefPayload + deleteRef( + """ + Parameters for DeleteRef + """ + input: DeleteRefInput! + ): DeleteRefPayload """ Deletes a team discussion. """ - deleteTeamDiscussion(input: DeleteTeamDiscussionInput!): DeleteTeamDiscussionPayload + deleteTeamDiscussion( + """ + Parameters for DeleteTeamDiscussion + """ + input: DeleteTeamDiscussionInput! + ): DeleteTeamDiscussionPayload """ Deletes a team discussion comment. """ - deleteTeamDiscussionComment(input: DeleteTeamDiscussionCommentInput!): DeleteTeamDiscussionCommentPayload + deleteTeamDiscussionComment( + """ + Parameters for DeleteTeamDiscussionComment + """ + input: DeleteTeamDiscussionCommentInput! + ): DeleteTeamDiscussionCommentPayload + + """ + Deletes a verifiable domain. + """ + deleteVerifiableDomain( + """ + Parameters for DeleteVerifiableDomain + """ + input: DeleteVerifiableDomainInput! + ): DeleteVerifiableDomainPayload """ Disable auto merge on the given pull request """ - disablePullRequestAutoMerge(input: DisablePullRequestAutoMergeInput!): DisablePullRequestAutoMergePayload + disablePullRequestAutoMerge( + """ + Parameters for DisablePullRequestAutoMerge + """ + input: DisablePullRequestAutoMergeInput! + ): DisablePullRequestAutoMergePayload """ Dismisses an approved or rejected pull request review. """ - dismissPullRequestReview(input: DismissPullRequestReviewInput!): DismissPullRequestReviewPayload + dismissPullRequestReview( + """ + Parameters for DismissPullRequestReview + """ + input: DismissPullRequestReviewInput! + ): DismissPullRequestReviewPayload """ Enable the default auto-merge on a pull request. """ - enablePullRequestAutoMerge(input: EnablePullRequestAutoMergeInput!): EnablePullRequestAutoMergePayload + enablePullRequestAutoMerge( + """ + Parameters for EnablePullRequestAutoMerge + """ + input: EnablePullRequestAutoMergeInput! + ): EnablePullRequestAutoMergePayload """ Follow a user. """ - followUser(input: FollowUserInput!): FollowUserPayload + followUser( + """ + Parameters for FollowUser + """ + input: FollowUserInput! + ): FollowUserPayload """ Creates a new project by importing columns and a list of issues/PRs. """ - importProject(input: ImportProjectInput!): ImportProjectPayload @preview(toggledBy: "slothette-preview") + importProject( + """ + Parameters for ImportProject + """ + input: ImportProjectInput! + ): ImportProjectPayload @preview(toggledBy: "slothette-preview") """ Creates a repository link for a project. """ - linkRepositoryToProject(input: LinkRepositoryToProjectInput!): LinkRepositoryToProjectPayload + linkRepositoryToProject( + """ + Parameters for LinkRepositoryToProject + """ + input: LinkRepositoryToProjectInput! + ): LinkRepositoryToProjectPayload """ Lock a lockable object """ - lockLockable(input: LockLockableInput!): LockLockablePayload + lockLockable( + """ + Parameters for LockLockable + """ + input: LockLockableInput! + ): LockLockablePayload """ Mark a pull request file as viewed """ - markFileAsViewed(input: MarkFileAsViewedInput!): MarkFileAsViewedPayload + markFileAsViewed( + """ + Parameters for MarkFileAsViewed + """ + input: MarkFileAsViewedInput! + ): MarkFileAsViewedPayload """ Marks a pull request ready for review. """ - markPullRequestReadyForReview(input: MarkPullRequestReadyForReviewInput!): MarkPullRequestReadyForReviewPayload + markPullRequestReadyForReview( + """ + Parameters for MarkPullRequestReadyForReview + """ + input: MarkPullRequestReadyForReviewInput! + ): MarkPullRequestReadyForReviewPayload """ Merge a head into a branch. """ - mergeBranch(input: MergeBranchInput!): MergeBranchPayload + mergeBranch( + """ + Parameters for MergeBranch + """ + input: MergeBranchInput! + ): MergeBranchPayload """ Merge a pull request. """ - mergePullRequest(input: MergePullRequestInput!): MergePullRequestPayload + mergePullRequest( + """ + Parameters for MergePullRequest + """ + input: MergePullRequestInput! + ): MergePullRequestPayload """ Minimizes a comment on an Issue, Commit, Pull Request, or Gist """ - minimizeComment(input: MinimizeCommentInput!): MinimizeCommentPayload + minimizeComment( + """ + Parameters for MinimizeComment + """ + input: MinimizeCommentInput! + ): MinimizeCommentPayload """ Moves a project card to another place. """ - moveProjectCard(input: MoveProjectCardInput!): MoveProjectCardPayload + moveProjectCard( + """ + Parameters for MoveProjectCard + """ + input: MoveProjectCardInput! + ): MoveProjectCardPayload """ Moves a project column to another place. """ - moveProjectColumn(input: MoveProjectColumnInput!): MoveProjectColumnPayload + moveProjectColumn( + """ + Parameters for MoveProjectColumn + """ + input: MoveProjectColumnInput! + ): MoveProjectColumnPayload """ Pin an issue to a repository """ - pinIssue(input: PinIssueInput!): PinIssuePayload @preview(toggledBy: "elektra-preview") + pinIssue( + """ + Parameters for PinIssue + """ + input: PinIssueInput! + ): PinIssuePayload + + """ + Regenerates a verifiable domain's verification token. + """ + regenerateVerifiableDomainToken( + """ + Parameters for RegenerateVerifiableDomainToken + """ + input: RegenerateVerifiableDomainTokenInput! + ): RegenerateVerifiableDomainTokenPayload """ Removes assignees from an assignable object. """ - removeAssigneesFromAssignable(input: RemoveAssigneesFromAssignableInput!): RemoveAssigneesFromAssignablePayload + removeAssigneesFromAssignable( + """ + Parameters for RemoveAssigneesFromAssignable + """ + input: RemoveAssigneesFromAssignableInput! + ): RemoveAssigneesFromAssignablePayload """ Removes an administrator from the enterprise. """ - removeEnterpriseAdmin(input: RemoveEnterpriseAdminInput!): RemoveEnterpriseAdminPayload + removeEnterpriseAdmin( + """ + Parameters for RemoveEnterpriseAdmin + """ + input: RemoveEnterpriseAdminInput! + ): RemoveEnterpriseAdminPayload """ Removes labels from a Labelable object. """ - removeLabelsFromLabelable(input: RemoveLabelsFromLabelableInput!): RemoveLabelsFromLabelablePayload + removeLabelsFromLabelable( + """ + Parameters for RemoveLabelsFromLabelable + """ + input: RemoveLabelsFromLabelableInput! + ): RemoveLabelsFromLabelablePayload """ Removes outside collaborator from all repositories in an organization. """ - removeOutsideCollaborator(input: RemoveOutsideCollaboratorInput!): RemoveOutsideCollaboratorPayload + removeOutsideCollaborator( + """ + Parameters for RemoveOutsideCollaborator + """ + input: RemoveOutsideCollaboratorInput! + ): RemoveOutsideCollaboratorPayload """ Removes a reaction from a subject. """ - removeReaction(input: RemoveReactionInput!): RemoveReactionPayload + removeReaction( + """ + Parameters for RemoveReaction + """ + input: RemoveReactionInput! + ): RemoveReactionPayload """ Removes a star from a Starrable. """ - removeStar(input: RemoveStarInput!): RemoveStarPayload + removeStar( + """ + Parameters for RemoveStar + """ + input: RemoveStarInput! + ): RemoveStarPayload """ Reopen a issue. """ - reopenIssue(input: ReopenIssueInput!): ReopenIssuePayload + reopenIssue( + """ + Parameters for ReopenIssue + """ + input: ReopenIssueInput! + ): ReopenIssuePayload """ Reopen a pull request. """ - reopenPullRequest(input: ReopenPullRequestInput!): ReopenPullRequestPayload + reopenPullRequest( + """ + Parameters for ReopenPullRequest + """ + input: ReopenPullRequestInput! + ): ReopenPullRequestPayload """ Set review requests on a pull request. """ - requestReviews(input: RequestReviewsInput!): RequestReviewsPayload + requestReviews( + """ + Parameters for RequestReviews + """ + input: RequestReviewsInput! + ): RequestReviewsPayload """ Rerequests an existing check suite. """ - rerequestCheckSuite(input: RerequestCheckSuiteInput!): RerequestCheckSuitePayload + rerequestCheckSuite( + """ + Parameters for RerequestCheckSuite + """ + input: RerequestCheckSuiteInput! + ): RerequestCheckSuitePayload """ Marks a review thread as resolved. """ - resolveReviewThread(input: ResolveReviewThreadInput!): ResolveReviewThreadPayload + resolveReviewThread( + """ + Parameters for ResolveReviewThread + """ + input: ResolveReviewThreadInput! + ): ResolveReviewThreadPayload """ Submits a pending pull request review. """ - submitPullRequestReview(input: SubmitPullRequestReviewInput!): SubmitPullRequestReviewPayload + submitPullRequestReview( + """ + Parameters for SubmitPullRequestReview + """ + input: SubmitPullRequestReviewInput! + ): SubmitPullRequestReviewPayload """ Transfer an issue to a different repository """ - transferIssue(input: TransferIssueInput!): TransferIssuePayload + transferIssue( + """ + Parameters for TransferIssue + """ + input: TransferIssueInput! + ): TransferIssuePayload """ Unarchives a repository. """ - unarchiveRepository(input: UnarchiveRepositoryInput!): UnarchiveRepositoryPayload + unarchiveRepository( + """ + Parameters for UnarchiveRepository + """ + input: UnarchiveRepositoryInput! + ): UnarchiveRepositoryPayload """ Unfollow a user. """ - unfollowUser(input: UnfollowUserInput!): UnfollowUserPayload + unfollowUser( + """ + Parameters for UnfollowUser + """ + input: UnfollowUserInput! + ): UnfollowUserPayload """ Deletes a repository link from a project. """ - unlinkRepositoryFromProject(input: UnlinkRepositoryFromProjectInput!): UnlinkRepositoryFromProjectPayload + unlinkRepositoryFromProject( + """ + Parameters for UnlinkRepositoryFromProject + """ + input: UnlinkRepositoryFromProjectInput! + ): UnlinkRepositoryFromProjectPayload """ Unlock a lockable object """ - unlockLockable(input: UnlockLockableInput!): UnlockLockablePayload + unlockLockable( + """ + Parameters for UnlockLockable + """ + input: UnlockLockableInput! + ): UnlockLockablePayload """ Unmark a pull request file as viewed """ - unmarkFileAsViewed(input: UnmarkFileAsViewedInput!): UnmarkFileAsViewedPayload + unmarkFileAsViewed( + """ + Parameters for UnmarkFileAsViewed + """ + input: UnmarkFileAsViewedInput! + ): UnmarkFileAsViewedPayload """ Unmark an issue as a duplicate of another issue. """ - unmarkIssueAsDuplicate(input: UnmarkIssueAsDuplicateInput!): UnmarkIssueAsDuplicatePayload + unmarkIssueAsDuplicate( + """ + Parameters for UnmarkIssueAsDuplicate + """ + input: UnmarkIssueAsDuplicateInput! + ): UnmarkIssueAsDuplicatePayload """ Unminimizes a comment on an Issue, Commit, Pull Request, or Gist """ - unminimizeComment(input: UnminimizeCommentInput!): UnminimizeCommentPayload + unminimizeComment( + """ + Parameters for UnminimizeComment + """ + input: UnminimizeCommentInput! + ): UnminimizeCommentPayload """ Unpin a pinned issue from a repository """ - unpinIssue(input: UnpinIssueInput!): UnpinIssuePayload @preview(toggledBy: "elektra-preview") + unpinIssue( + """ + Parameters for UnpinIssue + """ + input: UnpinIssueInput! + ): UnpinIssuePayload """ Marks a review thread as unresolved. """ - unresolveReviewThread(input: UnresolveReviewThreadInput!): UnresolveReviewThreadPayload + unresolveReviewThread( + """ + Parameters for UnresolveReviewThread + """ + input: UnresolveReviewThreadInput! + ): UnresolveReviewThreadPayload """ Create a new branch protection rule """ - updateBranchProtectionRule(input: UpdateBranchProtectionRuleInput!): UpdateBranchProtectionRulePayload + updateBranchProtectionRule( + """ + Parameters for UpdateBranchProtectionRule + """ + input: UpdateBranchProtectionRuleInput! + ): UpdateBranchProtectionRulePayload """ Update a check run """ - updateCheckRun(input: UpdateCheckRunInput!): UpdateCheckRunPayload + updateCheckRun( + """ + Parameters for UpdateCheckRun + """ + input: UpdateCheckRunInput! + ): UpdateCheckRunPayload """ Modifies the settings of an existing check suite """ - updateCheckSuitePreferences(input: UpdateCheckSuitePreferencesInput!): UpdateCheckSuitePreferencesPayload + updateCheckSuitePreferences( + """ + Parameters for UpdateCheckSuitePreferences + """ + input: UpdateCheckSuitePreferencesInput! + ): UpdateCheckSuitePreferencesPayload """ Sets whether private repository forks are enabled for an enterprise. """ - updateEnterpriseAllowPrivateRepositoryForkingSetting(input: UpdateEnterpriseAllowPrivateRepositoryForkingSettingInput!): UpdateEnterpriseAllowPrivateRepositoryForkingSettingPayload + updateEnterpriseAllowPrivateRepositoryForkingSetting( + """ + Parameters for UpdateEnterpriseAllowPrivateRepositoryForkingSetting + """ + input: UpdateEnterpriseAllowPrivateRepositoryForkingSettingInput! + ): UpdateEnterpriseAllowPrivateRepositoryForkingSettingPayload """ Sets the default repository permission for organizations in an enterprise. """ - updateEnterpriseDefaultRepositoryPermissionSetting(input: UpdateEnterpriseDefaultRepositoryPermissionSettingInput!): UpdateEnterpriseDefaultRepositoryPermissionSettingPayload + updateEnterpriseDefaultRepositoryPermissionSetting( + """ + Parameters for UpdateEnterpriseDefaultRepositoryPermissionSetting + """ + input: UpdateEnterpriseDefaultRepositoryPermissionSettingInput! + ): UpdateEnterpriseDefaultRepositoryPermissionSettingPayload """ Sets whether organization members with admin permissions on a repository can change repository visibility. """ - updateEnterpriseMembersCanChangeRepositoryVisibilitySetting(input: UpdateEnterpriseMembersCanChangeRepositoryVisibilitySettingInput!): UpdateEnterpriseMembersCanChangeRepositoryVisibilitySettingPayload + updateEnterpriseMembersCanChangeRepositoryVisibilitySetting( + """ + Parameters for UpdateEnterpriseMembersCanChangeRepositoryVisibilitySetting + """ + input: UpdateEnterpriseMembersCanChangeRepositoryVisibilitySettingInput! + ): UpdateEnterpriseMembersCanChangeRepositoryVisibilitySettingPayload """ Sets the members can create repositories setting for an enterprise. """ - updateEnterpriseMembersCanCreateRepositoriesSetting(input: UpdateEnterpriseMembersCanCreateRepositoriesSettingInput!): UpdateEnterpriseMembersCanCreateRepositoriesSettingPayload + updateEnterpriseMembersCanCreateRepositoriesSetting( + """ + Parameters for UpdateEnterpriseMembersCanCreateRepositoriesSetting + """ + input: UpdateEnterpriseMembersCanCreateRepositoriesSettingInput! + ): UpdateEnterpriseMembersCanCreateRepositoriesSettingPayload """ Sets the members can delete issues setting for an enterprise. """ - updateEnterpriseMembersCanDeleteIssuesSetting(input: UpdateEnterpriseMembersCanDeleteIssuesSettingInput!): UpdateEnterpriseMembersCanDeleteIssuesSettingPayload + updateEnterpriseMembersCanDeleteIssuesSetting( + """ + Parameters for UpdateEnterpriseMembersCanDeleteIssuesSetting + """ + input: UpdateEnterpriseMembersCanDeleteIssuesSettingInput! + ): UpdateEnterpriseMembersCanDeleteIssuesSettingPayload """ Sets the members can delete repositories setting for an enterprise. """ - updateEnterpriseMembersCanDeleteRepositoriesSetting(input: UpdateEnterpriseMembersCanDeleteRepositoriesSettingInput!): UpdateEnterpriseMembersCanDeleteRepositoriesSettingPayload + updateEnterpriseMembersCanDeleteRepositoriesSetting( + """ + Parameters for UpdateEnterpriseMembersCanDeleteRepositoriesSetting + """ + input: UpdateEnterpriseMembersCanDeleteRepositoriesSettingInput! + ): UpdateEnterpriseMembersCanDeleteRepositoriesSettingPayload """ Sets whether members can invite collaborators are enabled for an enterprise. """ - updateEnterpriseMembersCanInviteCollaboratorsSetting(input: UpdateEnterpriseMembersCanInviteCollaboratorsSettingInput!): UpdateEnterpriseMembersCanInviteCollaboratorsSettingPayload + updateEnterpriseMembersCanInviteCollaboratorsSetting( + """ + Parameters for UpdateEnterpriseMembersCanInviteCollaboratorsSetting + """ + input: UpdateEnterpriseMembersCanInviteCollaboratorsSettingInput! + ): UpdateEnterpriseMembersCanInviteCollaboratorsSettingPayload """ Sets whether or not an organization admin can make purchases. """ - updateEnterpriseMembersCanMakePurchasesSetting(input: UpdateEnterpriseMembersCanMakePurchasesSettingInput!): UpdateEnterpriseMembersCanMakePurchasesSettingPayload + updateEnterpriseMembersCanMakePurchasesSetting( + """ + Parameters for UpdateEnterpriseMembersCanMakePurchasesSetting + """ + input: UpdateEnterpriseMembersCanMakePurchasesSettingInput! + ): UpdateEnterpriseMembersCanMakePurchasesSettingPayload """ Sets the members can update protected branches setting for an enterprise. """ - updateEnterpriseMembersCanUpdateProtectedBranchesSetting(input: UpdateEnterpriseMembersCanUpdateProtectedBranchesSettingInput!): UpdateEnterpriseMembersCanUpdateProtectedBranchesSettingPayload + updateEnterpriseMembersCanUpdateProtectedBranchesSetting( + """ + Parameters for UpdateEnterpriseMembersCanUpdateProtectedBranchesSetting + """ + input: UpdateEnterpriseMembersCanUpdateProtectedBranchesSettingInput! + ): UpdateEnterpriseMembersCanUpdateProtectedBranchesSettingPayload """ Sets the members can view dependency insights for an enterprise. """ - updateEnterpriseMembersCanViewDependencyInsightsSetting(input: UpdateEnterpriseMembersCanViewDependencyInsightsSettingInput!): UpdateEnterpriseMembersCanViewDependencyInsightsSettingPayload + updateEnterpriseMembersCanViewDependencyInsightsSetting( + """ + Parameters for UpdateEnterpriseMembersCanViewDependencyInsightsSetting + """ + input: UpdateEnterpriseMembersCanViewDependencyInsightsSettingInput! + ): UpdateEnterpriseMembersCanViewDependencyInsightsSettingPayload """ Sets whether organization projects are enabled for an enterprise. """ - updateEnterpriseOrganizationProjectsSetting(input: UpdateEnterpriseOrganizationProjectsSettingInput!): UpdateEnterpriseOrganizationProjectsSettingPayload + updateEnterpriseOrganizationProjectsSetting( + """ + Parameters for UpdateEnterpriseOrganizationProjectsSetting + """ + input: UpdateEnterpriseOrganizationProjectsSettingInput! + ): UpdateEnterpriseOrganizationProjectsSettingPayload """ Updates an enterprise's profile. """ - updateEnterpriseProfile(input: UpdateEnterpriseProfileInput!): UpdateEnterpriseProfilePayload + updateEnterpriseProfile( + """ + Parameters for UpdateEnterpriseProfile + """ + input: UpdateEnterpriseProfileInput! + ): UpdateEnterpriseProfilePayload """ Sets whether repository projects are enabled for a enterprise. """ - updateEnterpriseRepositoryProjectsSetting(input: UpdateEnterpriseRepositoryProjectsSettingInput!): UpdateEnterpriseRepositoryProjectsSettingPayload + updateEnterpriseRepositoryProjectsSetting( + """ + Parameters for UpdateEnterpriseRepositoryProjectsSetting + """ + input: UpdateEnterpriseRepositoryProjectsSettingInput! + ): UpdateEnterpriseRepositoryProjectsSettingPayload """ Sets whether team discussions are enabled for an enterprise. """ - updateEnterpriseTeamDiscussionsSetting(input: UpdateEnterpriseTeamDiscussionsSettingInput!): UpdateEnterpriseTeamDiscussionsSettingPayload + updateEnterpriseTeamDiscussionsSetting( + """ + Parameters for UpdateEnterpriseTeamDiscussionsSetting + """ + input: UpdateEnterpriseTeamDiscussionsSettingInput! + ): UpdateEnterpriseTeamDiscussionsSettingPayload """ Sets whether two factor authentication is required for all users in an enterprise. """ - updateEnterpriseTwoFactorAuthenticationRequiredSetting(input: UpdateEnterpriseTwoFactorAuthenticationRequiredSettingInput!): UpdateEnterpriseTwoFactorAuthenticationRequiredSettingPayload + updateEnterpriseTwoFactorAuthenticationRequiredSetting( + """ + Parameters for UpdateEnterpriseTwoFactorAuthenticationRequiredSetting + """ + input: UpdateEnterpriseTwoFactorAuthenticationRequiredSettingInput! + ): UpdateEnterpriseTwoFactorAuthenticationRequiredSettingPayload """ Sets whether an IP allow list is enabled on an owner. """ - updateIpAllowListEnabledSetting(input: UpdateIpAllowListEnabledSettingInput!): UpdateIpAllowListEnabledSettingPayload + updateIpAllowListEnabledSetting( + """ + Parameters for UpdateIpAllowListEnabledSetting + """ + input: UpdateIpAllowListEnabledSettingInput! + ): UpdateIpAllowListEnabledSettingPayload """ Updates an IP allow list entry. """ - updateIpAllowListEntry(input: UpdateIpAllowListEntryInput!): UpdateIpAllowListEntryPayload + updateIpAllowListEntry( + """ + Parameters for UpdateIpAllowListEntry + """ + input: UpdateIpAllowListEntryInput! + ): UpdateIpAllowListEntryPayload """ Updates an Issue. """ - updateIssue(input: UpdateIssueInput!): UpdateIssuePayload + updateIssue( + """ + Parameters for UpdateIssue + """ + input: UpdateIssueInput! + ): UpdateIssuePayload """ Updates an IssueComment object. """ - updateIssueComment(input: UpdateIssueCommentInput!): UpdateIssueCommentPayload + updateIssueComment( + """ + Parameters for UpdateIssueComment + """ + input: UpdateIssueCommentInput! + ): UpdateIssueCommentPayload """ Updates an existing label. """ - updateLabel(input: UpdateLabelInput!): UpdateLabelPayload @preview(toggledBy: "bane-preview") + updateLabel( + """ + Parameters for UpdateLabel + """ + input: UpdateLabelInput! + ): UpdateLabelPayload @preview(toggledBy: "bane-preview") + + """ + Update the setting to restrict notifications to only verified domains available to an owner. + """ + updateNotificationRestrictionSetting( + """ + Parameters for UpdateNotificationRestrictionSetting + """ + input: UpdateNotificationRestrictionSettingInput! + ): UpdateNotificationRestrictionSettingPayload """ Updates an existing project. """ - updateProject(input: UpdateProjectInput!): UpdateProjectPayload + updateProject( + """ + Parameters for UpdateProject + """ + input: UpdateProjectInput! + ): UpdateProjectPayload """ Updates an existing project card. """ - updateProjectCard(input: UpdateProjectCardInput!): UpdateProjectCardPayload + updateProjectCard( + """ + Parameters for UpdateProjectCard + """ + input: UpdateProjectCardInput! + ): UpdateProjectCardPayload """ Updates an existing project column. """ - updateProjectColumn(input: UpdateProjectColumnInput!): UpdateProjectColumnPayload + updateProjectColumn( + """ + Parameters for UpdateProjectColumn + """ + input: UpdateProjectColumnInput! + ): UpdateProjectColumnPayload """ Update a pull request """ - updatePullRequest(input: UpdatePullRequestInput!): UpdatePullRequestPayload + updatePullRequest( + """ + Parameters for UpdatePullRequest + """ + input: UpdatePullRequestInput! + ): UpdatePullRequestPayload """ Updates the body of a pull request review. """ - updatePullRequestReview(input: UpdatePullRequestReviewInput!): UpdatePullRequestReviewPayload + updatePullRequestReview( + """ + Parameters for UpdatePullRequestReview + """ + input: UpdatePullRequestReviewInput! + ): UpdatePullRequestReviewPayload """ Updates a pull request review comment. """ - updatePullRequestReviewComment(input: UpdatePullRequestReviewCommentInput!): UpdatePullRequestReviewCommentPayload + updatePullRequestReviewComment( + """ + Parameters for UpdatePullRequestReviewComment + """ + input: UpdatePullRequestReviewCommentInput! + ): UpdatePullRequestReviewCommentPayload """ Update a Git Ref. """ - updateRef(input: UpdateRefInput!): UpdateRefPayload + updateRef( + """ + Parameters for UpdateRef + """ + input: UpdateRefInput! + ): UpdateRefPayload """ Creates, updates and/or deletes multiple refs in a repository. @@ -14744,37 +15579,82 @@ type Mutation { If `RefUpdate.force` is set to `true`, a non-fast-forward updates for the given reference will be allowed. """ - updateRefs(input: UpdateRefsInput!): UpdateRefsPayload @preview(toggledBy: "update-refs-preview") + updateRefs( + """ + Parameters for UpdateRefs + """ + input: UpdateRefsInput! + ): UpdateRefsPayload @preview(toggledBy: "update-refs-preview") """ Update information about a repository. """ - updateRepository(input: UpdateRepositoryInput!): UpdateRepositoryPayload + updateRepository( + """ + Parameters for UpdateRepository + """ + input: UpdateRepositoryInput! + ): UpdateRepositoryPayload """ Updates the state for subscribable subjects. """ - updateSubscription(input: UpdateSubscriptionInput!): UpdateSubscriptionPayload + updateSubscription( + """ + Parameters for UpdateSubscription + """ + input: UpdateSubscriptionInput! + ): UpdateSubscriptionPayload """ Updates a team discussion. """ - updateTeamDiscussion(input: UpdateTeamDiscussionInput!): UpdateTeamDiscussionPayload + updateTeamDiscussion( + """ + Parameters for UpdateTeamDiscussion + """ + input: UpdateTeamDiscussionInput! + ): UpdateTeamDiscussionPayload """ Updates a discussion comment. """ - updateTeamDiscussionComment(input: UpdateTeamDiscussionCommentInput!): UpdateTeamDiscussionCommentPayload + updateTeamDiscussionComment( + """ + Parameters for UpdateTeamDiscussionComment + """ + input: UpdateTeamDiscussionCommentInput! + ): UpdateTeamDiscussionCommentPayload """ Updates team review assignment. """ - updateTeamReviewAssignment(input: UpdateTeamReviewAssignmentInput!): UpdateTeamReviewAssignmentPayload @preview(toggledBy: "stone-crop-preview") + updateTeamReviewAssignment( + """ + Parameters for UpdateTeamReviewAssignment + """ + input: UpdateTeamReviewAssignmentInput! + ): UpdateTeamReviewAssignmentPayload @preview(toggledBy: "stone-crop-preview") """ Replaces the repository's topics with the given topics. """ - updateTopics(input: UpdateTopicsInput!): UpdateTopicsPayload + updateTopics( + """ + Parameters for UpdateTopics + """ + input: UpdateTopicsInput! + ): UpdateTopicsPayload + + """ + Verify that a verifiable domain has the expected DNS record. + """ + verifyVerifiableDomain( + """ + Parameters for VerifyVerifiableDomain + """ + input: VerifyVerifiableDomainInput! + ): VerifyVerifiableDomainPayload } """ @@ -14787,6 +15667,21 @@ interface Node { id: ID! } +""" +The possible values for the notification restriction setting. +""" +enum NotificationRestrictionSettingValue { + """ + The setting is disabled for the owner. + """ + DISABLED + + """ + The setting is enabled for the owner. + """ + ENABLED +} + """ Metadata for an audit entry with action oauth_application.* """ @@ -18047,6 +18942,41 @@ type Organization implements Actor & MemberStatusable & Node & ProfileOwner & Pr """ descriptionHTML: String + """ + A list of domains owned by the organization. + """ + domains( + """ + Returns the elements in the list that come after the specified cursor. + """ + after: String + + """ + Returns the elements in the list that come before the specified cursor. + """ + before: String + + """ + Returns the first _n_ elements from the list. + """ + first: Int + + """ + Filter by if the domain is verified. + """ + isVerified: Boolean = null + + """ + Returns the last _n_ elements from the list. + """ + last: Int + + """ + Ordering options for verifiable domains returned. + """ + orderBy: VerifiableDomainOrder = {field: DOMAIN, direction: ASC} + ): VerifiableDomainConnection + """ The organization's public email. """ @@ -18089,7 +19019,7 @@ type Organization implements Actor & MemberStatusable & Node & ProfileOwner & Pr ): IpAllowListEntryConnection! """ - Whether the organization has verified its profile email and website, always false on Enterprise. + Whether the organization has verified its profile email and website. """ isVerified: Boolean! @@ -18179,6 +19109,11 @@ type Organization implements Actor & MemberStatusable & Node & ProfileOwner & Pr """ newTeamUrl: URI! + """ + Indicates if email notification delivery for this organization is restricted to verified domains. + """ + notificationDeliveryRestrictionEnabledSetting: NotificationRestrictionSettingValue! + """ The billing email for the organization. """ @@ -19318,7 +20253,7 @@ type PinnedEvent implements Node { """ A Pinned Issue is a issue pinned to a repository's index page. """ -type PinnedIssue implements Node @preview(toggledBy: "elektra-preview") { +type PinnedIssue implements Node { """ Identifies the primary key from the database. """ @@ -19344,7 +20279,7 @@ type PinnedIssue implements Node @preview(toggledBy: "elektra-preview") { """ The connection type for PinnedIssue. """ -type PinnedIssueConnection @preview(toggledBy: "elektra-preview") { +type PinnedIssueConnection { """ A list of edges. """ @@ -19369,7 +20304,7 @@ type PinnedIssueConnection @preview(toggledBy: "elektra-preview") { """ An edge in a connection. """ -type PinnedIssueEdge @preview(toggledBy: "elektra-preview") { +type PinnedIssueEdge { """ A cursor for use in pagination. """ @@ -24073,6 +25008,36 @@ Any referencable object """ union ReferencedSubject = Issue | PullRequest +""" +Autogenerated input type of RegenerateVerifiableDomainToken +""" +input RegenerateVerifiableDomainTokenInput { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The ID of the verifiable domain to regenerate the verification token of. + """ + id: ID! @possibleTypes(concreteTypes: ["VerifiableDomain"]) +} + +""" +Autogenerated return type of RegenerateVerifiableDomainToken +""" +type RegenerateVerifiableDomainTokenPayload { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The verification token that was generated. + """ + verificationToken: String +} + """ A release contains the content for a release. """ @@ -24178,6 +25143,11 @@ type Release implements Node & UniformResourceLocatable { """ tag: Ref + """ + The tag commit for this release. + """ + tagCommit: Commit + """ The name of the release's Git tag """ @@ -27759,7 +28729,7 @@ type Repository implements Node & ProjectOwner & RepositoryInfo & Starrable & Su Returns the last _n_ elements from the list. """ last: Int - ): PinnedIssueConnection @preview(toggledBy: "elektra-preview") + ): PinnedIssueConnection """ The primary language of the repository's code. @@ -30909,6 +31879,16 @@ type StatusContext implements Node { description: String id: ID! + """ + Whether this status is required to pass before merging. + """ + isRequired( + """ + The pull request this status is required for + """ + pullRequestId: ID! + ): Boolean! + """ The state of this status context. """ @@ -35077,6 +36057,41 @@ type UpdateLabelPayload @preview(toggledBy: "bane-preview") { label: Label } +""" +Autogenerated input type of UpdateNotificationRestrictionSetting +""" +input UpdateNotificationRestrictionSettingInput { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The ID of the owner on which to set the restrict notifications setting. + """ + ownerId: ID! @possibleTypes(concreteTypes: ["Enterprise", "Organization"], abstractType: "VerifiableDomainOwner") + + """ + The value for the restrict notifications setting. + """ + settingValue: NotificationRestrictionSettingValue! +} + +""" +Autogenerated return type of UpdateNotificationRestrictionSetting +""" +type UpdateNotificationRestrictionSettingPayload { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The owner on which the setting was updated. + """ + owner: VerifiableDomainOwner +} + """ Autogenerated input type of UpdateProjectCard """ @@ -35966,6 +36981,11 @@ type User implements Actor & Node & ProfileOwner & ProjectOwner & RepositoryOwne """ isEmployee: Boolean! + """ + Whether or not this user is a member of the GitHub Stars Program. + """ + isGitHubStar: Boolean! + """ Whether or not the user has marked themselves as for hire. """ @@ -37040,6 +38060,11 @@ enum UserStatusOrderField { A domain that can be verified for an organization or an enterprise. """ type VerifiableDomain implements Node { + """ + Identifies the date and time when the object was created. + """ + createdAt: DateTime! + """ Identifies the primary key from the database. """ @@ -37091,17 +38116,122 @@ type VerifiableDomain implements Node { """ tokenExpirationTime: DateTime + """ + Identifies the date and time when the object was last updated. + """ + updatedAt: DateTime! + """ The current verification token for the domain. """ verificationToken: String } +""" +The connection type for VerifiableDomain. +""" +type VerifiableDomainConnection { + """ + A list of edges. + """ + edges: [VerifiableDomainEdge] + + """ + A list of nodes. + """ + nodes: [VerifiableDomain] + + """ + Information to aid in pagination. + """ + pageInfo: PageInfo! + + """ + Identifies the total count of items in the connection. + """ + totalCount: Int! +} + +""" +An edge in a connection. +""" +type VerifiableDomainEdge { + """ + A cursor for use in pagination. + """ + cursor: String! + + """ + The item at the end of the edge. + """ + node: VerifiableDomain +} + +""" +Ordering options for verifiable domain connections. +""" +input VerifiableDomainOrder { + """ + The ordering direction. + """ + direction: OrderDirection! + + """ + The field to order verifiable domains by. + """ + field: VerifiableDomainOrderField! +} + +""" +Properties by which verifiable domain connections can be ordered. +""" +enum VerifiableDomainOrderField { + """ + Order verifiable domains by their creation date. + """ + CREATED_AT + + """ + Order verifiable domains by the domain name. + """ + DOMAIN +} + """ Types that can own a verifiable domain. """ union VerifiableDomainOwner = Enterprise | Organization +""" +Autogenerated input type of VerifyVerifiableDomain +""" +input VerifyVerifiableDomainInput { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The ID of the verifiable domain to verify. + """ + id: ID! @possibleTypes(concreteTypes: ["VerifiableDomain"]) +} + +""" +Autogenerated return type of VerifyVerifiableDomain +""" +type VerifyVerifiableDomainPayload { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The verifiable domain that was verified. + """ + domain: VerifiableDomain +} + """ A hovercard context with a message describing how the viewer is related. """ diff --git a/data/graphql/graphql_previews.yml b/data/graphql/graphql_previews.yml index 2250a53638..181b6839c0 100644 --- a/data/graphql/graphql_previews.yml +++ b/data/graphql/graphql_previews.yml @@ -100,20 +100,6 @@ - Mutation.createContentAttachment owning_teams: - '@github/feature-lifecycle' -- title: Pinned Issues Preview - description: This preview adds support for pinned issues. - toggled_by: ':elektra-preview' - announcement: null - updates: null - toggled_on: - - Repository.pinnedIssues - - PinnedIssue - - PinnedIssueEdge - - PinnedIssueConnection - - Mutation.pinIssue - - Mutation.unpinIssue - owning_teams: - - '@github/pe-pull-requests' - title: Labels Preview description: >- This preview adds support for adding, updating, creating and deleting diff --git a/data/graphql/schema.docs.graphql b/data/graphql/schema.docs.graphql index 906aa62d6d..6b0840e26e 100644 --- a/data/graphql/schema.docs.graphql +++ b/data/graphql/schema.docs.graphql @@ -775,6 +775,36 @@ type App implements Node { url: URI! } +""" +Autogenerated input type of ApproveVerifiableDomain +""" +input ApproveVerifiableDomainInput { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The ID of the verifiable domain to approve. + """ + id: ID! @possibleTypes(concreteTypes: ["VerifiableDomain"]) +} + +""" +Autogenerated return type of ApproveVerifiableDomain +""" +type ApproveVerifiableDomainPayload { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The verifiable domain that was approved. + """ + domain: VerifiableDomain +} + """ Autogenerated input type of ArchiveRepository """ @@ -2192,6 +2222,16 @@ type CheckRun implements Node & UniformResourceLocatable { externalId: String id: ID! + """ + Whether this check run is required to pass before merging. + """ + isRequired( + """ + The pull request this check is required for + """ + pullRequestId: ID! + ): Boolean! + """ The name of the check for this check run. """ @@ -8673,7 +8713,7 @@ type EnterpriseOwnerInfo { """ Filter whether or not the domain is verified. """ - isVerified: Boolean + isVerified: Boolean = null """ Returns the last _n_ elements from the list. @@ -12025,6 +12065,11 @@ type Issue implements Assignable & Closable & Comment & Labelable & Lockable & N """ includesCreatedEdit: Boolean! + """ + Indicates whether or not this issue is currently pinned to the repository issues list + """ + isPinned: Boolean + """ Is this issue read by the viewer """ @@ -15302,677 +15347,1362 @@ type Mutation { """ Accepts a pending invitation for a user to become an administrator of an enterprise. """ - acceptEnterpriseAdministratorInvitation(input: AcceptEnterpriseAdministratorInvitationInput!): AcceptEnterpriseAdministratorInvitationPayload + acceptEnterpriseAdministratorInvitation( + """ + Parameters for AcceptEnterpriseAdministratorInvitation + """ + input: AcceptEnterpriseAdministratorInvitationInput! + ): AcceptEnterpriseAdministratorInvitationPayload """ Applies a suggested topic to the repository. """ - acceptTopicSuggestion(input: AcceptTopicSuggestionInput!): AcceptTopicSuggestionPayload + acceptTopicSuggestion( + """ + Parameters for AcceptTopicSuggestion + """ + input: AcceptTopicSuggestionInput! + ): AcceptTopicSuggestionPayload """ Adds assignees to an assignable object. """ - addAssigneesToAssignable(input: AddAssigneesToAssignableInput!): AddAssigneesToAssignablePayload + addAssigneesToAssignable( + """ + Parameters for AddAssigneesToAssignable + """ + input: AddAssigneesToAssignableInput! + ): AddAssigneesToAssignablePayload """ Adds a comment to an Issue or Pull Request. """ - addComment(input: AddCommentInput!): AddCommentPayload + addComment( + """ + Parameters for AddComment + """ + input: AddCommentInput! + ): AddCommentPayload """ Adds a support entitlement to an enterprise member. """ - addEnterpriseSupportEntitlement(input: AddEnterpriseSupportEntitlementInput!): AddEnterpriseSupportEntitlementPayload + addEnterpriseSupportEntitlement( + """ + Parameters for AddEnterpriseSupportEntitlement + """ + input: AddEnterpriseSupportEntitlementInput! + ): AddEnterpriseSupportEntitlementPayload """ Adds labels to a labelable object. """ - addLabelsToLabelable(input: AddLabelsToLabelableInput!): AddLabelsToLabelablePayload + addLabelsToLabelable( + """ + Parameters for AddLabelsToLabelable + """ + input: AddLabelsToLabelableInput! + ): AddLabelsToLabelablePayload """ Adds a card to a ProjectColumn. Either `contentId` or `note` must be provided but **not** both. """ - addProjectCard(input: AddProjectCardInput!): AddProjectCardPayload + addProjectCard( + """ + Parameters for AddProjectCard + """ + input: AddProjectCardInput! + ): AddProjectCardPayload """ Adds a column to a Project. """ - addProjectColumn(input: AddProjectColumnInput!): AddProjectColumnPayload + addProjectColumn( + """ + Parameters for AddProjectColumn + """ + input: AddProjectColumnInput! + ): AddProjectColumnPayload """ Adds a review to a Pull Request. """ - addPullRequestReview(input: AddPullRequestReviewInput!): AddPullRequestReviewPayload + addPullRequestReview( + """ + Parameters for AddPullRequestReview + """ + input: AddPullRequestReviewInput! + ): AddPullRequestReviewPayload """ Adds a comment to a review. """ - addPullRequestReviewComment(input: AddPullRequestReviewCommentInput!): AddPullRequestReviewCommentPayload + addPullRequestReviewComment( + """ + Parameters for AddPullRequestReviewComment + """ + input: AddPullRequestReviewCommentInput! + ): AddPullRequestReviewCommentPayload """ Adds a new thread to a pending Pull Request Review. """ - addPullRequestReviewThread(input: AddPullRequestReviewThreadInput!): AddPullRequestReviewThreadPayload + addPullRequestReviewThread( + """ + Parameters for AddPullRequestReviewThread + """ + input: AddPullRequestReviewThreadInput! + ): AddPullRequestReviewThreadPayload """ Adds a reaction to a subject. """ - addReaction(input: AddReactionInput!): AddReactionPayload + addReaction( + """ + Parameters for AddReaction + """ + input: AddReactionInput! + ): AddReactionPayload """ Adds a star to a Starrable. """ - addStar(input: AddStarInput!): AddStarPayload + addStar( + """ + Parameters for AddStar + """ + input: AddStarInput! + ): AddStarPayload """ Adds a verifiable domain to an owning account. """ - addVerifiableDomain(input: AddVerifiableDomainInput!): AddVerifiableDomainPayload + addVerifiableDomain( + """ + Parameters for AddVerifiableDomain + """ + input: AddVerifiableDomainInput! + ): AddVerifiableDomainPayload + + """ + Approve a verifiable domain for notification delivery. + """ + approveVerifiableDomain( + """ + Parameters for ApproveVerifiableDomain + """ + input: ApproveVerifiableDomainInput! + ): ApproveVerifiableDomainPayload """ Marks a repository as archived. """ - archiveRepository(input: ArchiveRepositoryInput!): ArchiveRepositoryPayload + archiveRepository( + """ + Parameters for ArchiveRepository + """ + input: ArchiveRepositoryInput! + ): ArchiveRepositoryPayload """ Cancels a pending invitation for an administrator to join an enterprise. """ - cancelEnterpriseAdminInvitation(input: CancelEnterpriseAdminInvitationInput!): CancelEnterpriseAdminInvitationPayload + cancelEnterpriseAdminInvitation( + """ + Parameters for CancelEnterpriseAdminInvitation + """ + input: CancelEnterpriseAdminInvitationInput! + ): CancelEnterpriseAdminInvitationPayload """ Update your status on GitHub. """ - changeUserStatus(input: ChangeUserStatusInput!): ChangeUserStatusPayload + changeUserStatus( + """ + Parameters for ChangeUserStatus + """ + input: ChangeUserStatusInput! + ): ChangeUserStatusPayload """ Clears all labels from a labelable object. """ - clearLabelsFromLabelable(input: ClearLabelsFromLabelableInput!): ClearLabelsFromLabelablePayload + clearLabelsFromLabelable( + """ + Parameters for ClearLabelsFromLabelable + """ + input: ClearLabelsFromLabelableInput! + ): ClearLabelsFromLabelablePayload """ Creates a new project by cloning configuration from an existing project. """ - cloneProject(input: CloneProjectInput!): CloneProjectPayload + cloneProject( + """ + Parameters for CloneProject + """ + input: CloneProjectInput! + ): CloneProjectPayload """ Create a new repository with the same files and directory structure as a template repository. """ - cloneTemplateRepository(input: CloneTemplateRepositoryInput!): CloneTemplateRepositoryPayload + cloneTemplateRepository( + """ + Parameters for CloneTemplateRepository + """ + input: CloneTemplateRepositoryInput! + ): CloneTemplateRepositoryPayload """ Close an issue. """ - closeIssue(input: CloseIssueInput!): CloseIssuePayload + closeIssue( + """ + Parameters for CloseIssue + """ + input: CloseIssueInput! + ): CloseIssuePayload """ Close a pull request. """ - closePullRequest(input: ClosePullRequestInput!): ClosePullRequestPayload + closePullRequest( + """ + Parameters for ClosePullRequest + """ + input: ClosePullRequestInput! + ): ClosePullRequestPayload """ Convert a project note card to one associated with a newly created issue. """ - convertProjectCardNoteToIssue(input: ConvertProjectCardNoteToIssueInput!): ConvertProjectCardNoteToIssuePayload + convertProjectCardNoteToIssue( + """ + Parameters for ConvertProjectCardNoteToIssue + """ + input: ConvertProjectCardNoteToIssueInput! + ): ConvertProjectCardNoteToIssuePayload """ Create a new branch protection rule """ - createBranchProtectionRule(input: CreateBranchProtectionRuleInput!): CreateBranchProtectionRulePayload + createBranchProtectionRule( + """ + Parameters for CreateBranchProtectionRule + """ + input: CreateBranchProtectionRuleInput! + ): CreateBranchProtectionRulePayload """ Create a check run. """ - createCheckRun(input: CreateCheckRunInput!): CreateCheckRunPayload + createCheckRun( + """ + Parameters for CreateCheckRun + """ + input: CreateCheckRunInput! + ): CreateCheckRunPayload """ Create a check suite """ - createCheckSuite(input: CreateCheckSuiteInput!): CreateCheckSuitePayload + createCheckSuite( + """ + Parameters for CreateCheckSuite + """ + input: CreateCheckSuiteInput! + ): CreateCheckSuitePayload """ Create a content attachment. """ - createContentAttachment(input: CreateContentAttachmentInput!): CreateContentAttachmentPayload @preview(toggledBy: "corsair-preview") + createContentAttachment( + """ + Parameters for CreateContentAttachment + """ + input: CreateContentAttachmentInput! + ): CreateContentAttachmentPayload @preview(toggledBy: "corsair-preview") """ Creates a new deployment event. """ - createDeployment(input: CreateDeploymentInput!): CreateDeploymentPayload @preview(toggledBy: "flash-preview") + createDeployment( + """ + Parameters for CreateDeployment + """ + input: CreateDeploymentInput! + ): CreateDeploymentPayload @preview(toggledBy: "flash-preview") """ Create a deployment status. """ - createDeploymentStatus(input: CreateDeploymentStatusInput!): CreateDeploymentStatusPayload @preview(toggledBy: "flash-preview") + createDeploymentStatus( + """ + Parameters for CreateDeploymentStatus + """ + input: CreateDeploymentStatusInput! + ): CreateDeploymentStatusPayload @preview(toggledBy: "flash-preview") """ Creates an organization as part of an enterprise account. """ - createEnterpriseOrganization(input: CreateEnterpriseOrganizationInput!): CreateEnterpriseOrganizationPayload + createEnterpriseOrganization( + """ + Parameters for CreateEnterpriseOrganization + """ + input: CreateEnterpriseOrganizationInput! + ): CreateEnterpriseOrganizationPayload """ Creates a new IP allow list entry. """ - createIpAllowListEntry(input: CreateIpAllowListEntryInput!): CreateIpAllowListEntryPayload + createIpAllowListEntry( + """ + Parameters for CreateIpAllowListEntry + """ + input: CreateIpAllowListEntryInput! + ): CreateIpAllowListEntryPayload """ Creates a new issue. """ - createIssue(input: CreateIssueInput!): CreateIssuePayload + createIssue( + """ + Parameters for CreateIssue + """ + input: CreateIssueInput! + ): CreateIssuePayload """ Creates a new label. """ - createLabel(input: CreateLabelInput!): CreateLabelPayload @preview(toggledBy: "bane-preview") + createLabel( + """ + Parameters for CreateLabel + """ + input: CreateLabelInput! + ): CreateLabelPayload @preview(toggledBy: "bane-preview") """ Creates a new project. """ - createProject(input: CreateProjectInput!): CreateProjectPayload + createProject( + """ + Parameters for CreateProject + """ + input: CreateProjectInput! + ): CreateProjectPayload """ Create a new pull request """ - createPullRequest(input: CreatePullRequestInput!): CreatePullRequestPayload + createPullRequest( + """ + Parameters for CreatePullRequest + """ + input: CreatePullRequestInput! + ): CreatePullRequestPayload """ Create a new Git Ref. """ - createRef(input: CreateRefInput!): CreateRefPayload + createRef( + """ + Parameters for CreateRef + """ + input: CreateRefInput! + ): CreateRefPayload """ Create a new repository. """ - createRepository(input: CreateRepositoryInput!): CreateRepositoryPayload + createRepository( + """ + Parameters for CreateRepository + """ + input: CreateRepositoryInput! + ): CreateRepositoryPayload """ Creates a new team discussion. """ - createTeamDiscussion(input: CreateTeamDiscussionInput!): CreateTeamDiscussionPayload + createTeamDiscussion( + """ + Parameters for CreateTeamDiscussion + """ + input: CreateTeamDiscussionInput! + ): CreateTeamDiscussionPayload """ Creates a new team discussion comment. """ - createTeamDiscussionComment(input: CreateTeamDiscussionCommentInput!): CreateTeamDiscussionCommentPayload + createTeamDiscussionComment( + """ + Parameters for CreateTeamDiscussionComment + """ + input: CreateTeamDiscussionCommentInput! + ): CreateTeamDiscussionCommentPayload """ Rejects a suggested topic for the repository. """ - declineTopicSuggestion(input: DeclineTopicSuggestionInput!): DeclineTopicSuggestionPayload + declineTopicSuggestion( + """ + Parameters for DeclineTopicSuggestion + """ + input: DeclineTopicSuggestionInput! + ): DeclineTopicSuggestionPayload """ Delete a branch protection rule """ - deleteBranchProtectionRule(input: DeleteBranchProtectionRuleInput!): DeleteBranchProtectionRulePayload + deleteBranchProtectionRule( + """ + Parameters for DeleteBranchProtectionRule + """ + input: DeleteBranchProtectionRuleInput! + ): DeleteBranchProtectionRulePayload """ Deletes a deployment. """ - deleteDeployment(input: DeleteDeploymentInput!): DeleteDeploymentPayload + deleteDeployment( + """ + Parameters for DeleteDeployment + """ + input: DeleteDeploymentInput! + ): DeleteDeploymentPayload """ Deletes an IP allow list entry. """ - deleteIpAllowListEntry(input: DeleteIpAllowListEntryInput!): DeleteIpAllowListEntryPayload + deleteIpAllowListEntry( + """ + Parameters for DeleteIpAllowListEntry + """ + input: DeleteIpAllowListEntryInput! + ): DeleteIpAllowListEntryPayload """ Deletes an Issue object. """ - deleteIssue(input: DeleteIssueInput!): DeleteIssuePayload + deleteIssue( + """ + Parameters for DeleteIssue + """ + input: DeleteIssueInput! + ): DeleteIssuePayload """ Deletes an IssueComment object. """ - deleteIssueComment(input: DeleteIssueCommentInput!): DeleteIssueCommentPayload + deleteIssueComment( + """ + Parameters for DeleteIssueComment + """ + input: DeleteIssueCommentInput! + ): DeleteIssueCommentPayload """ Deletes a label. """ - deleteLabel(input: DeleteLabelInput!): DeleteLabelPayload @preview(toggledBy: "bane-preview") + deleteLabel( + """ + Parameters for DeleteLabel + """ + input: DeleteLabelInput! + ): DeleteLabelPayload @preview(toggledBy: "bane-preview") """ Delete a package version. """ - deletePackageVersion(input: DeletePackageVersionInput!): DeletePackageVersionPayload @preview(toggledBy: "package-deletes-preview") + deletePackageVersion( + """ + Parameters for DeletePackageVersion + """ + input: DeletePackageVersionInput! + ): DeletePackageVersionPayload @preview(toggledBy: "package-deletes-preview") """ Deletes a project. """ - deleteProject(input: DeleteProjectInput!): DeleteProjectPayload + deleteProject( + """ + Parameters for DeleteProject + """ + input: DeleteProjectInput! + ): DeleteProjectPayload """ Deletes a project card. """ - deleteProjectCard(input: DeleteProjectCardInput!): DeleteProjectCardPayload + deleteProjectCard( + """ + Parameters for DeleteProjectCard + """ + input: DeleteProjectCardInput! + ): DeleteProjectCardPayload """ Deletes a project column. """ - deleteProjectColumn(input: DeleteProjectColumnInput!): DeleteProjectColumnPayload + deleteProjectColumn( + """ + Parameters for DeleteProjectColumn + """ + input: DeleteProjectColumnInput! + ): DeleteProjectColumnPayload """ Deletes a pull request review. """ - deletePullRequestReview(input: DeletePullRequestReviewInput!): DeletePullRequestReviewPayload + deletePullRequestReview( + """ + Parameters for DeletePullRequestReview + """ + input: DeletePullRequestReviewInput! + ): DeletePullRequestReviewPayload """ Deletes a pull request review comment. """ - deletePullRequestReviewComment(input: DeletePullRequestReviewCommentInput!): DeletePullRequestReviewCommentPayload + deletePullRequestReviewComment( + """ + Parameters for DeletePullRequestReviewComment + """ + input: DeletePullRequestReviewCommentInput! + ): DeletePullRequestReviewCommentPayload """ Delete a Git Ref. """ - deleteRef(input: DeleteRefInput!): DeleteRefPayload + deleteRef( + """ + Parameters for DeleteRef + """ + input: DeleteRefInput! + ): DeleteRefPayload """ Deletes a team discussion. """ - deleteTeamDiscussion(input: DeleteTeamDiscussionInput!): DeleteTeamDiscussionPayload + deleteTeamDiscussion( + """ + Parameters for DeleteTeamDiscussion + """ + input: DeleteTeamDiscussionInput! + ): DeleteTeamDiscussionPayload """ Deletes a team discussion comment. """ - deleteTeamDiscussionComment(input: DeleteTeamDiscussionCommentInput!): DeleteTeamDiscussionCommentPayload + deleteTeamDiscussionComment( + """ + Parameters for DeleteTeamDiscussionComment + """ + input: DeleteTeamDiscussionCommentInput! + ): DeleteTeamDiscussionCommentPayload """ Deletes a verifiable domain. """ - deleteVerifiableDomain(input: DeleteVerifiableDomainInput!): DeleteVerifiableDomainPayload + deleteVerifiableDomain( + """ + Parameters for DeleteVerifiableDomain + """ + input: DeleteVerifiableDomainInput! + ): DeleteVerifiableDomainPayload """ Disable auto merge on the given pull request """ - disablePullRequestAutoMerge(input: DisablePullRequestAutoMergeInput!): DisablePullRequestAutoMergePayload + disablePullRequestAutoMerge( + """ + Parameters for DisablePullRequestAutoMerge + """ + input: DisablePullRequestAutoMergeInput! + ): DisablePullRequestAutoMergePayload """ Dismisses an approved or rejected pull request review. """ - dismissPullRequestReview(input: DismissPullRequestReviewInput!): DismissPullRequestReviewPayload + dismissPullRequestReview( + """ + Parameters for DismissPullRequestReview + """ + input: DismissPullRequestReviewInput! + ): DismissPullRequestReviewPayload """ Enable the default auto-merge on a pull request. """ - enablePullRequestAutoMerge(input: EnablePullRequestAutoMergeInput!): EnablePullRequestAutoMergePayload + enablePullRequestAutoMerge( + """ + Parameters for EnablePullRequestAutoMerge + """ + input: EnablePullRequestAutoMergeInput! + ): EnablePullRequestAutoMergePayload """ Follow a user. """ - followUser(input: FollowUserInput!): FollowUserPayload + followUser( + """ + Parameters for FollowUser + """ + input: FollowUserInput! + ): FollowUserPayload """ Creates a new project by importing columns and a list of issues/PRs. """ - importProject(input: ImportProjectInput!): ImportProjectPayload @preview(toggledBy: "slothette-preview") + importProject( + """ + Parameters for ImportProject + """ + input: ImportProjectInput! + ): ImportProjectPayload @preview(toggledBy: "slothette-preview") """ Invite someone to become an administrator of the enterprise. """ - inviteEnterpriseAdmin(input: InviteEnterpriseAdminInput!): InviteEnterpriseAdminPayload + inviteEnterpriseAdmin( + """ + Parameters for InviteEnterpriseAdmin + """ + input: InviteEnterpriseAdminInput! + ): InviteEnterpriseAdminPayload """ Creates a repository link for a project. """ - linkRepositoryToProject(input: LinkRepositoryToProjectInput!): LinkRepositoryToProjectPayload + linkRepositoryToProject( + """ + Parameters for LinkRepositoryToProject + """ + input: LinkRepositoryToProjectInput! + ): LinkRepositoryToProjectPayload """ Lock a lockable object """ - lockLockable(input: LockLockableInput!): LockLockablePayload + lockLockable( + """ + Parameters for LockLockable + """ + input: LockLockableInput! + ): LockLockablePayload """ Mark a pull request file as viewed """ - markFileAsViewed(input: MarkFileAsViewedInput!): MarkFileAsViewedPayload + markFileAsViewed( + """ + Parameters for MarkFileAsViewed + """ + input: MarkFileAsViewedInput! + ): MarkFileAsViewedPayload """ Marks a pull request ready for review. """ - markPullRequestReadyForReview(input: MarkPullRequestReadyForReviewInput!): MarkPullRequestReadyForReviewPayload + markPullRequestReadyForReview( + """ + Parameters for MarkPullRequestReadyForReview + """ + input: MarkPullRequestReadyForReviewInput! + ): MarkPullRequestReadyForReviewPayload """ Merge a head into a branch. """ - mergeBranch(input: MergeBranchInput!): MergeBranchPayload + mergeBranch( + """ + Parameters for MergeBranch + """ + input: MergeBranchInput! + ): MergeBranchPayload """ Merge a pull request. """ - mergePullRequest(input: MergePullRequestInput!): MergePullRequestPayload + mergePullRequest( + """ + Parameters for MergePullRequest + """ + input: MergePullRequestInput! + ): MergePullRequestPayload """ Minimizes a comment on an Issue, Commit, Pull Request, or Gist """ - minimizeComment(input: MinimizeCommentInput!): MinimizeCommentPayload + minimizeComment( + """ + Parameters for MinimizeComment + """ + input: MinimizeCommentInput! + ): MinimizeCommentPayload """ Moves a project card to another place. """ - moveProjectCard(input: MoveProjectCardInput!): MoveProjectCardPayload + moveProjectCard( + """ + Parameters for MoveProjectCard + """ + input: MoveProjectCardInput! + ): MoveProjectCardPayload """ Moves a project column to another place. """ - moveProjectColumn(input: MoveProjectColumnInput!): MoveProjectColumnPayload + moveProjectColumn( + """ + Parameters for MoveProjectColumn + """ + input: MoveProjectColumnInput! + ): MoveProjectColumnPayload """ Pin an issue to a repository """ - pinIssue(input: PinIssueInput!): PinIssuePayload @preview(toggledBy: "elektra-preview") + pinIssue( + """ + Parameters for PinIssue + """ + input: PinIssueInput! + ): PinIssuePayload """ Regenerates the identity provider recovery codes for an enterprise """ - regenerateEnterpriseIdentityProviderRecoveryCodes(input: RegenerateEnterpriseIdentityProviderRecoveryCodesInput!): RegenerateEnterpriseIdentityProviderRecoveryCodesPayload + regenerateEnterpriseIdentityProviderRecoveryCodes( + """ + Parameters for RegenerateEnterpriseIdentityProviderRecoveryCodes + """ + input: RegenerateEnterpriseIdentityProviderRecoveryCodesInput! + ): RegenerateEnterpriseIdentityProviderRecoveryCodesPayload """ Regenerates a verifiable domain's verification token. """ - regenerateVerifiableDomainToken(input: RegenerateVerifiableDomainTokenInput!): RegenerateVerifiableDomainTokenPayload + regenerateVerifiableDomainToken( + """ + Parameters for RegenerateVerifiableDomainToken + """ + input: RegenerateVerifiableDomainTokenInput! + ): RegenerateVerifiableDomainTokenPayload """ Removes assignees from an assignable object. """ - removeAssigneesFromAssignable(input: RemoveAssigneesFromAssignableInput!): RemoveAssigneesFromAssignablePayload + removeAssigneesFromAssignable( + """ + Parameters for RemoveAssigneesFromAssignable + """ + input: RemoveAssigneesFromAssignableInput! + ): RemoveAssigneesFromAssignablePayload """ Removes an administrator from the enterprise. """ - removeEnterpriseAdmin(input: RemoveEnterpriseAdminInput!): RemoveEnterpriseAdminPayload + removeEnterpriseAdmin( + """ + Parameters for RemoveEnterpriseAdmin + """ + input: RemoveEnterpriseAdminInput! + ): RemoveEnterpriseAdminPayload """ Removes the identity provider from an enterprise """ - removeEnterpriseIdentityProvider(input: RemoveEnterpriseIdentityProviderInput!): RemoveEnterpriseIdentityProviderPayload + removeEnterpriseIdentityProvider( + """ + Parameters for RemoveEnterpriseIdentityProvider + """ + input: RemoveEnterpriseIdentityProviderInput! + ): RemoveEnterpriseIdentityProviderPayload """ Removes an organization from the enterprise """ - removeEnterpriseOrganization(input: RemoveEnterpriseOrganizationInput!): RemoveEnterpriseOrganizationPayload + removeEnterpriseOrganization( + """ + Parameters for RemoveEnterpriseOrganization + """ + input: RemoveEnterpriseOrganizationInput! + ): RemoveEnterpriseOrganizationPayload """ Removes a support entitlement from an enterprise member. """ - removeEnterpriseSupportEntitlement(input: RemoveEnterpriseSupportEntitlementInput!): RemoveEnterpriseSupportEntitlementPayload + removeEnterpriseSupportEntitlement( + """ + Parameters for RemoveEnterpriseSupportEntitlement + """ + input: RemoveEnterpriseSupportEntitlementInput! + ): RemoveEnterpriseSupportEntitlementPayload """ Removes labels from a Labelable object. """ - removeLabelsFromLabelable(input: RemoveLabelsFromLabelableInput!): RemoveLabelsFromLabelablePayload + removeLabelsFromLabelable( + """ + Parameters for RemoveLabelsFromLabelable + """ + input: RemoveLabelsFromLabelableInput! + ): RemoveLabelsFromLabelablePayload """ Removes outside collaborator from all repositories in an organization. """ - removeOutsideCollaborator(input: RemoveOutsideCollaboratorInput!): RemoveOutsideCollaboratorPayload + removeOutsideCollaborator( + """ + Parameters for RemoveOutsideCollaborator + """ + input: RemoveOutsideCollaboratorInput! + ): RemoveOutsideCollaboratorPayload """ Removes a reaction from a subject. """ - removeReaction(input: RemoveReactionInput!): RemoveReactionPayload + removeReaction( + """ + Parameters for RemoveReaction + """ + input: RemoveReactionInput! + ): RemoveReactionPayload """ Removes a star from a Starrable. """ - removeStar(input: RemoveStarInput!): RemoveStarPayload + removeStar( + """ + Parameters for RemoveStar + """ + input: RemoveStarInput! + ): RemoveStarPayload """ Reopen a issue. """ - reopenIssue(input: ReopenIssueInput!): ReopenIssuePayload + reopenIssue( + """ + Parameters for ReopenIssue + """ + input: ReopenIssueInput! + ): ReopenIssuePayload """ Reopen a pull request. """ - reopenPullRequest(input: ReopenPullRequestInput!): ReopenPullRequestPayload + reopenPullRequest( + """ + Parameters for ReopenPullRequest + """ + input: ReopenPullRequestInput! + ): ReopenPullRequestPayload """ Set review requests on a pull request. """ - requestReviews(input: RequestReviewsInput!): RequestReviewsPayload + requestReviews( + """ + Parameters for RequestReviews + """ + input: RequestReviewsInput! + ): RequestReviewsPayload """ Rerequests an existing check suite. """ - rerequestCheckSuite(input: RerequestCheckSuiteInput!): RerequestCheckSuitePayload + rerequestCheckSuite( + """ + Parameters for RerequestCheckSuite + """ + input: RerequestCheckSuiteInput! + ): RerequestCheckSuitePayload """ Marks a review thread as resolved. """ - resolveReviewThread(input: ResolveReviewThreadInput!): ResolveReviewThreadPayload + resolveReviewThread( + """ + Parameters for ResolveReviewThread + """ + input: ResolveReviewThreadInput! + ): ResolveReviewThreadPayload """ Creates or updates the identity provider for an enterprise. """ - setEnterpriseIdentityProvider(input: SetEnterpriseIdentityProviderInput!): SetEnterpriseIdentityProviderPayload + setEnterpriseIdentityProvider( + """ + Parameters for SetEnterpriseIdentityProvider + """ + input: SetEnterpriseIdentityProviderInput! + ): SetEnterpriseIdentityProviderPayload """ Set an organization level interaction limit for an organization's public repositories. """ - setOrganizationInteractionLimit(input: SetOrganizationInteractionLimitInput!): SetOrganizationInteractionLimitPayload + setOrganizationInteractionLimit( + """ + Parameters for SetOrganizationInteractionLimit + """ + input: SetOrganizationInteractionLimitInput! + ): SetOrganizationInteractionLimitPayload """ Sets an interaction limit setting for a repository. """ - setRepositoryInteractionLimit(input: SetRepositoryInteractionLimitInput!): SetRepositoryInteractionLimitPayload + setRepositoryInteractionLimit( + """ + Parameters for SetRepositoryInteractionLimit + """ + input: SetRepositoryInteractionLimitInput! + ): SetRepositoryInteractionLimitPayload """ Set a user level interaction limit for an user's public repositories. """ - setUserInteractionLimit(input: SetUserInteractionLimitInput!): SetUserInteractionLimitPayload + setUserInteractionLimit( + """ + Parameters for SetUserInteractionLimit + """ + input: SetUserInteractionLimitInput! + ): SetUserInteractionLimitPayload """ Submits a pending pull request review. """ - submitPullRequestReview(input: SubmitPullRequestReviewInput!): SubmitPullRequestReviewPayload + submitPullRequestReview( + """ + Parameters for SubmitPullRequestReview + """ + input: SubmitPullRequestReviewInput! + ): SubmitPullRequestReviewPayload """ Transfer an issue to a different repository """ - transferIssue(input: TransferIssueInput!): TransferIssuePayload + transferIssue( + """ + Parameters for TransferIssue + """ + input: TransferIssueInput! + ): TransferIssuePayload """ Unarchives a repository. """ - unarchiveRepository(input: UnarchiveRepositoryInput!): UnarchiveRepositoryPayload + unarchiveRepository( + """ + Parameters for UnarchiveRepository + """ + input: UnarchiveRepositoryInput! + ): UnarchiveRepositoryPayload """ Unfollow a user. """ - unfollowUser(input: UnfollowUserInput!): UnfollowUserPayload + unfollowUser( + """ + Parameters for UnfollowUser + """ + input: UnfollowUserInput! + ): UnfollowUserPayload """ Deletes a repository link from a project. """ - unlinkRepositoryFromProject(input: UnlinkRepositoryFromProjectInput!): UnlinkRepositoryFromProjectPayload + unlinkRepositoryFromProject( + """ + Parameters for UnlinkRepositoryFromProject + """ + input: UnlinkRepositoryFromProjectInput! + ): UnlinkRepositoryFromProjectPayload """ Unlock a lockable object """ - unlockLockable(input: UnlockLockableInput!): UnlockLockablePayload + unlockLockable( + """ + Parameters for UnlockLockable + """ + input: UnlockLockableInput! + ): UnlockLockablePayload """ Unmark a pull request file as viewed """ - unmarkFileAsViewed(input: UnmarkFileAsViewedInput!): UnmarkFileAsViewedPayload + unmarkFileAsViewed( + """ + Parameters for UnmarkFileAsViewed + """ + input: UnmarkFileAsViewedInput! + ): UnmarkFileAsViewedPayload """ Unmark an issue as a duplicate of another issue. """ - unmarkIssueAsDuplicate(input: UnmarkIssueAsDuplicateInput!): UnmarkIssueAsDuplicatePayload + unmarkIssueAsDuplicate( + """ + Parameters for UnmarkIssueAsDuplicate + """ + input: UnmarkIssueAsDuplicateInput! + ): UnmarkIssueAsDuplicatePayload """ Unminimizes a comment on an Issue, Commit, Pull Request, or Gist """ - unminimizeComment(input: UnminimizeCommentInput!): UnminimizeCommentPayload + unminimizeComment( + """ + Parameters for UnminimizeComment + """ + input: UnminimizeCommentInput! + ): UnminimizeCommentPayload """ Unpin a pinned issue from a repository """ - unpinIssue(input: UnpinIssueInput!): UnpinIssuePayload @preview(toggledBy: "elektra-preview") + unpinIssue( + """ + Parameters for UnpinIssue + """ + input: UnpinIssueInput! + ): UnpinIssuePayload """ Marks a review thread as unresolved. """ - unresolveReviewThread(input: UnresolveReviewThreadInput!): UnresolveReviewThreadPayload + unresolveReviewThread( + """ + Parameters for UnresolveReviewThread + """ + input: UnresolveReviewThreadInput! + ): UnresolveReviewThreadPayload """ Create a new branch protection rule """ - updateBranchProtectionRule(input: UpdateBranchProtectionRuleInput!): UpdateBranchProtectionRulePayload + updateBranchProtectionRule( + """ + Parameters for UpdateBranchProtectionRule + """ + input: UpdateBranchProtectionRuleInput! + ): UpdateBranchProtectionRulePayload """ Update a check run """ - updateCheckRun(input: UpdateCheckRunInput!): UpdateCheckRunPayload + updateCheckRun( + """ + Parameters for UpdateCheckRun + """ + input: UpdateCheckRunInput! + ): UpdateCheckRunPayload """ Modifies the settings of an existing check suite """ - updateCheckSuitePreferences(input: UpdateCheckSuitePreferencesInput!): UpdateCheckSuitePreferencesPayload + updateCheckSuitePreferences( + """ + Parameters for UpdateCheckSuitePreferences + """ + input: UpdateCheckSuitePreferencesInput! + ): UpdateCheckSuitePreferencesPayload """ Updates the role of an enterprise administrator. """ - updateEnterpriseAdministratorRole(input: UpdateEnterpriseAdministratorRoleInput!): UpdateEnterpriseAdministratorRolePayload + updateEnterpriseAdministratorRole( + """ + Parameters for UpdateEnterpriseAdministratorRole + """ + input: UpdateEnterpriseAdministratorRoleInput! + ): UpdateEnterpriseAdministratorRolePayload """ Sets whether private repository forks are enabled for an enterprise. """ - updateEnterpriseAllowPrivateRepositoryForkingSetting(input: UpdateEnterpriseAllowPrivateRepositoryForkingSettingInput!): UpdateEnterpriseAllowPrivateRepositoryForkingSettingPayload + updateEnterpriseAllowPrivateRepositoryForkingSetting( + """ + Parameters for UpdateEnterpriseAllowPrivateRepositoryForkingSetting + """ + input: UpdateEnterpriseAllowPrivateRepositoryForkingSettingInput! + ): UpdateEnterpriseAllowPrivateRepositoryForkingSettingPayload """ Sets the default repository permission for organizations in an enterprise. """ - updateEnterpriseDefaultRepositoryPermissionSetting(input: UpdateEnterpriseDefaultRepositoryPermissionSettingInput!): UpdateEnterpriseDefaultRepositoryPermissionSettingPayload + updateEnterpriseDefaultRepositoryPermissionSetting( + """ + Parameters for UpdateEnterpriseDefaultRepositoryPermissionSetting + """ + input: UpdateEnterpriseDefaultRepositoryPermissionSettingInput! + ): UpdateEnterpriseDefaultRepositoryPermissionSettingPayload """ Sets whether organization members with admin permissions on a repository can change repository visibility. """ - updateEnterpriseMembersCanChangeRepositoryVisibilitySetting(input: UpdateEnterpriseMembersCanChangeRepositoryVisibilitySettingInput!): UpdateEnterpriseMembersCanChangeRepositoryVisibilitySettingPayload + updateEnterpriseMembersCanChangeRepositoryVisibilitySetting( + """ + Parameters for UpdateEnterpriseMembersCanChangeRepositoryVisibilitySetting + """ + input: UpdateEnterpriseMembersCanChangeRepositoryVisibilitySettingInput! + ): UpdateEnterpriseMembersCanChangeRepositoryVisibilitySettingPayload """ Sets the members can create repositories setting for an enterprise. """ - updateEnterpriseMembersCanCreateRepositoriesSetting(input: UpdateEnterpriseMembersCanCreateRepositoriesSettingInput!): UpdateEnterpriseMembersCanCreateRepositoriesSettingPayload + updateEnterpriseMembersCanCreateRepositoriesSetting( + """ + Parameters for UpdateEnterpriseMembersCanCreateRepositoriesSetting + """ + input: UpdateEnterpriseMembersCanCreateRepositoriesSettingInput! + ): UpdateEnterpriseMembersCanCreateRepositoriesSettingPayload """ Sets the members can delete issues setting for an enterprise. """ - updateEnterpriseMembersCanDeleteIssuesSetting(input: UpdateEnterpriseMembersCanDeleteIssuesSettingInput!): UpdateEnterpriseMembersCanDeleteIssuesSettingPayload + updateEnterpriseMembersCanDeleteIssuesSetting( + """ + Parameters for UpdateEnterpriseMembersCanDeleteIssuesSetting + """ + input: UpdateEnterpriseMembersCanDeleteIssuesSettingInput! + ): UpdateEnterpriseMembersCanDeleteIssuesSettingPayload """ Sets the members can delete repositories setting for an enterprise. """ - updateEnterpriseMembersCanDeleteRepositoriesSetting(input: UpdateEnterpriseMembersCanDeleteRepositoriesSettingInput!): UpdateEnterpriseMembersCanDeleteRepositoriesSettingPayload + updateEnterpriseMembersCanDeleteRepositoriesSetting( + """ + Parameters for UpdateEnterpriseMembersCanDeleteRepositoriesSetting + """ + input: UpdateEnterpriseMembersCanDeleteRepositoriesSettingInput! + ): UpdateEnterpriseMembersCanDeleteRepositoriesSettingPayload """ Sets whether members can invite collaborators are enabled for an enterprise. """ - updateEnterpriseMembersCanInviteCollaboratorsSetting(input: UpdateEnterpriseMembersCanInviteCollaboratorsSettingInput!): UpdateEnterpriseMembersCanInviteCollaboratorsSettingPayload + updateEnterpriseMembersCanInviteCollaboratorsSetting( + """ + Parameters for UpdateEnterpriseMembersCanInviteCollaboratorsSetting + """ + input: UpdateEnterpriseMembersCanInviteCollaboratorsSettingInput! + ): UpdateEnterpriseMembersCanInviteCollaboratorsSettingPayload """ Sets whether or not an organization admin can make purchases. """ - updateEnterpriseMembersCanMakePurchasesSetting(input: UpdateEnterpriseMembersCanMakePurchasesSettingInput!): UpdateEnterpriseMembersCanMakePurchasesSettingPayload + updateEnterpriseMembersCanMakePurchasesSetting( + """ + Parameters for UpdateEnterpriseMembersCanMakePurchasesSetting + """ + input: UpdateEnterpriseMembersCanMakePurchasesSettingInput! + ): UpdateEnterpriseMembersCanMakePurchasesSettingPayload """ Sets the members can update protected branches setting for an enterprise. """ - updateEnterpriseMembersCanUpdateProtectedBranchesSetting(input: UpdateEnterpriseMembersCanUpdateProtectedBranchesSettingInput!): UpdateEnterpriseMembersCanUpdateProtectedBranchesSettingPayload + updateEnterpriseMembersCanUpdateProtectedBranchesSetting( + """ + Parameters for UpdateEnterpriseMembersCanUpdateProtectedBranchesSetting + """ + input: UpdateEnterpriseMembersCanUpdateProtectedBranchesSettingInput! + ): UpdateEnterpriseMembersCanUpdateProtectedBranchesSettingPayload """ Sets the members can view dependency insights for an enterprise. """ - updateEnterpriseMembersCanViewDependencyInsightsSetting(input: UpdateEnterpriseMembersCanViewDependencyInsightsSettingInput!): UpdateEnterpriseMembersCanViewDependencyInsightsSettingPayload + updateEnterpriseMembersCanViewDependencyInsightsSetting( + """ + Parameters for UpdateEnterpriseMembersCanViewDependencyInsightsSetting + """ + input: UpdateEnterpriseMembersCanViewDependencyInsightsSettingInput! + ): UpdateEnterpriseMembersCanViewDependencyInsightsSettingPayload """ Sets whether organization projects are enabled for an enterprise. """ - updateEnterpriseOrganizationProjectsSetting(input: UpdateEnterpriseOrganizationProjectsSettingInput!): UpdateEnterpriseOrganizationProjectsSettingPayload + updateEnterpriseOrganizationProjectsSetting( + """ + Parameters for UpdateEnterpriseOrganizationProjectsSetting + """ + input: UpdateEnterpriseOrganizationProjectsSettingInput! + ): UpdateEnterpriseOrganizationProjectsSettingPayload """ Updates an enterprise's profile. """ - updateEnterpriseProfile(input: UpdateEnterpriseProfileInput!): UpdateEnterpriseProfilePayload + updateEnterpriseProfile( + """ + Parameters for UpdateEnterpriseProfile + """ + input: UpdateEnterpriseProfileInput! + ): UpdateEnterpriseProfilePayload """ Sets whether repository projects are enabled for a enterprise. """ - updateEnterpriseRepositoryProjectsSetting(input: UpdateEnterpriseRepositoryProjectsSettingInput!): UpdateEnterpriseRepositoryProjectsSettingPayload + updateEnterpriseRepositoryProjectsSetting( + """ + Parameters for UpdateEnterpriseRepositoryProjectsSetting + """ + input: UpdateEnterpriseRepositoryProjectsSettingInput! + ): UpdateEnterpriseRepositoryProjectsSettingPayload """ Sets whether team discussions are enabled for an enterprise. """ - updateEnterpriseTeamDiscussionsSetting(input: UpdateEnterpriseTeamDiscussionsSettingInput!): UpdateEnterpriseTeamDiscussionsSettingPayload + updateEnterpriseTeamDiscussionsSetting( + """ + Parameters for UpdateEnterpriseTeamDiscussionsSetting + """ + input: UpdateEnterpriseTeamDiscussionsSettingInput! + ): UpdateEnterpriseTeamDiscussionsSettingPayload """ Sets whether two factor authentication is required for all users in an enterprise. """ - updateEnterpriseTwoFactorAuthenticationRequiredSetting(input: UpdateEnterpriseTwoFactorAuthenticationRequiredSettingInput!): UpdateEnterpriseTwoFactorAuthenticationRequiredSettingPayload + updateEnterpriseTwoFactorAuthenticationRequiredSetting( + """ + Parameters for UpdateEnterpriseTwoFactorAuthenticationRequiredSetting + """ + input: UpdateEnterpriseTwoFactorAuthenticationRequiredSettingInput! + ): UpdateEnterpriseTwoFactorAuthenticationRequiredSettingPayload """ Sets whether an IP allow list is enabled on an owner. """ - updateIpAllowListEnabledSetting(input: UpdateIpAllowListEnabledSettingInput!): UpdateIpAllowListEnabledSettingPayload + updateIpAllowListEnabledSetting( + """ + Parameters for UpdateIpAllowListEnabledSetting + """ + input: UpdateIpAllowListEnabledSettingInput! + ): UpdateIpAllowListEnabledSettingPayload """ Updates an IP allow list entry. """ - updateIpAllowListEntry(input: UpdateIpAllowListEntryInput!): UpdateIpAllowListEntryPayload + updateIpAllowListEntry( + """ + Parameters for UpdateIpAllowListEntry + """ + input: UpdateIpAllowListEntryInput! + ): UpdateIpAllowListEntryPayload """ Updates an Issue. """ - updateIssue(input: UpdateIssueInput!): UpdateIssuePayload + updateIssue( + """ + Parameters for UpdateIssue + """ + input: UpdateIssueInput! + ): UpdateIssuePayload """ Updates an IssueComment object. """ - updateIssueComment(input: UpdateIssueCommentInput!): UpdateIssueCommentPayload + updateIssueComment( + """ + Parameters for UpdateIssueComment + """ + input: UpdateIssueCommentInput! + ): UpdateIssueCommentPayload """ Updates an existing label. """ - updateLabel(input: UpdateLabelInput!): UpdateLabelPayload @preview(toggledBy: "bane-preview") + updateLabel( + """ + Parameters for UpdateLabel + """ + input: UpdateLabelInput! + ): UpdateLabelPayload @preview(toggledBy: "bane-preview") """ Update the setting to restrict notifications to only verified domains available to an owner. """ - updateNotificationRestrictionSetting(input: UpdateNotificationRestrictionSettingInput!): UpdateNotificationRestrictionSettingPayload + updateNotificationRestrictionSetting( + """ + Parameters for UpdateNotificationRestrictionSetting + """ + input: UpdateNotificationRestrictionSettingInput! + ): UpdateNotificationRestrictionSettingPayload """ Updates an existing project. """ - updateProject(input: UpdateProjectInput!): UpdateProjectPayload + updateProject( + """ + Parameters for UpdateProject + """ + input: UpdateProjectInput! + ): UpdateProjectPayload """ Updates an existing project card. """ - updateProjectCard(input: UpdateProjectCardInput!): UpdateProjectCardPayload + updateProjectCard( + """ + Parameters for UpdateProjectCard + """ + input: UpdateProjectCardInput! + ): UpdateProjectCardPayload """ Updates an existing project column. """ - updateProjectColumn(input: UpdateProjectColumnInput!): UpdateProjectColumnPayload + updateProjectColumn( + """ + Parameters for UpdateProjectColumn + """ + input: UpdateProjectColumnInput! + ): UpdateProjectColumnPayload """ Update a pull request """ - updatePullRequest(input: UpdatePullRequestInput!): UpdatePullRequestPayload + updatePullRequest( + """ + Parameters for UpdatePullRequest + """ + input: UpdatePullRequestInput! + ): UpdatePullRequestPayload """ Updates the body of a pull request review. """ - updatePullRequestReview(input: UpdatePullRequestReviewInput!): UpdatePullRequestReviewPayload + updatePullRequestReview( + """ + Parameters for UpdatePullRequestReview + """ + input: UpdatePullRequestReviewInput! + ): UpdatePullRequestReviewPayload """ Updates a pull request review comment. """ - updatePullRequestReviewComment(input: UpdatePullRequestReviewCommentInput!): UpdatePullRequestReviewCommentPayload + updatePullRequestReviewComment( + """ + Parameters for UpdatePullRequestReviewComment + """ + input: UpdatePullRequestReviewCommentInput! + ): UpdatePullRequestReviewCommentPayload """ Update a Git Ref. """ - updateRef(input: UpdateRefInput!): UpdateRefPayload + updateRef( + """ + Parameters for UpdateRef + """ + input: UpdateRefInput! + ): UpdateRefPayload """ Creates, updates and/or deletes multiple refs in a repository. @@ -15994,42 +16724,82 @@ type Mutation { If `RefUpdate.force` is set to `true`, a non-fast-forward updates for the given reference will be allowed. """ - updateRefs(input: UpdateRefsInput!): UpdateRefsPayload @preview(toggledBy: "update-refs-preview") + updateRefs( + """ + Parameters for UpdateRefs + """ + input: UpdateRefsInput! + ): UpdateRefsPayload @preview(toggledBy: "update-refs-preview") """ Update information about a repository. """ - updateRepository(input: UpdateRepositoryInput!): UpdateRepositoryPayload + updateRepository( + """ + Parameters for UpdateRepository + """ + input: UpdateRepositoryInput! + ): UpdateRepositoryPayload """ Updates the state for subscribable subjects. """ - updateSubscription(input: UpdateSubscriptionInput!): UpdateSubscriptionPayload + updateSubscription( + """ + Parameters for UpdateSubscription + """ + input: UpdateSubscriptionInput! + ): UpdateSubscriptionPayload """ Updates a team discussion. """ - updateTeamDiscussion(input: UpdateTeamDiscussionInput!): UpdateTeamDiscussionPayload + updateTeamDiscussion( + """ + Parameters for UpdateTeamDiscussion + """ + input: UpdateTeamDiscussionInput! + ): UpdateTeamDiscussionPayload """ Updates a discussion comment. """ - updateTeamDiscussionComment(input: UpdateTeamDiscussionCommentInput!): UpdateTeamDiscussionCommentPayload + updateTeamDiscussionComment( + """ + Parameters for UpdateTeamDiscussionComment + """ + input: UpdateTeamDiscussionCommentInput! + ): UpdateTeamDiscussionCommentPayload """ Updates team review assignment. """ - updateTeamReviewAssignment(input: UpdateTeamReviewAssignmentInput!): UpdateTeamReviewAssignmentPayload @preview(toggledBy: "stone-crop-preview") + updateTeamReviewAssignment( + """ + Parameters for UpdateTeamReviewAssignment + """ + input: UpdateTeamReviewAssignmentInput! + ): UpdateTeamReviewAssignmentPayload @preview(toggledBy: "stone-crop-preview") """ Replaces the repository's topics with the given topics. """ - updateTopics(input: UpdateTopicsInput!): UpdateTopicsPayload + updateTopics( + """ + Parameters for UpdateTopics + """ + input: UpdateTopicsInput! + ): UpdateTopicsPayload """ Verify that a verifiable domain has the expected DNS record. """ - verifyVerifiableDomain(input: VerifyVerifiableDomainInput!): VerifyVerifiableDomainPayload + verifyVerifiableDomain( + """ + Parameters for VerifyVerifiableDomain + """ + input: VerifyVerifiableDomainInput! + ): VerifyVerifiableDomainPayload } """ @@ -19339,7 +20109,7 @@ type Organization implements Actor & MemberStatusable & Node & PackageOwner & Pr """ Filter by if the domain is verified. """ - isVerified: Boolean + isVerified: Boolean = null """ Returns the last _n_ elements from the list. @@ -19419,7 +20189,7 @@ type Organization implements Actor & MemberStatusable & Node & PackageOwner & Pr isSponsoringViewer: Boolean! """ - Whether the organization has verified its profile email and website, always false on Enterprise. + Whether the organization has verified its profile email and website. """ isVerified: Boolean! @@ -21237,7 +22007,7 @@ type PinnedEvent implements Node { """ A Pinned Issue is a issue pinned to a repository's index page. """ -type PinnedIssue implements Node @preview(toggledBy: "elektra-preview") { +type PinnedIssue implements Node { """ Identifies the primary key from the database. """ @@ -21263,7 +22033,7 @@ type PinnedIssue implements Node @preview(toggledBy: "elektra-preview") { """ The connection type for PinnedIssue. """ -type PinnedIssueConnection @preview(toggledBy: "elektra-preview") { +type PinnedIssueConnection { """ A list of edges. """ @@ -21288,7 +22058,7 @@ type PinnedIssueConnection @preview(toggledBy: "elektra-preview") { """ An edge in a connection. """ -type PinnedIssueEdge @preview(toggledBy: "elektra-preview") { +type PinnedIssueEdge { """ A cursor for use in pagination. """ @@ -26332,6 +27102,11 @@ type Release implements Node & UniformResourceLocatable { """ tag: Ref + """ + The tag commit for this release. + """ + tagCommit: Commit + """ The name of the release's Git tag """ @@ -30123,7 +30898,7 @@ type Repository implements Node & PackageOwner & ProjectOwner & RepositoryInfo & Returns the last _n_ elements from the list. """ last: Int - ): PinnedIssueConnection @preview(toggledBy: "elektra-preview") + ): PinnedIssueConnection """ The primary language of the repository's code. @@ -34037,6 +34812,16 @@ type StatusContext implements Node { description: String id: ID! + """ + Whether this status is required to pass before merging. + """ + isRequired( + """ + The pull request this status is required for + """ + pullRequestId: ID! + ): Boolean! + """ The state of this status context. """ @@ -39204,6 +39989,11 @@ type User implements Actor & Node & PackageOwner & ProfileOwner & ProjectOwner & """ isEmployee: Boolean! + """ + Whether or not this user is a member of the GitHub Stars Program. + """ + isGitHubStar: Boolean! + """ Whether or not the user has marked themselves as for hire. """ @@ -40353,6 +41143,11 @@ enum UserStatusOrderField { A domain that can be verified for an organization or an enterprise. """ type VerifiableDomain implements Node { + """ + Identifies the date and time when the object was created. + """ + createdAt: DateTime! + """ Identifies the primary key from the database. """ @@ -40404,6 +41199,11 @@ type VerifiableDomain implements Node { """ tokenExpirationTime: DateTime + """ + Identifies the date and time when the object was last updated. + """ + updatedAt: DateTime! + """ The current verification token for the domain. """ @@ -40469,6 +41269,11 @@ input VerifiableDomainOrder { Properties by which verifiable domain connections can be ordered. """ enum VerifiableDomainOrderField { + """ + Order verifiable domains by their creation date. + """ + CREATED_AT + """ Order verifiable domains by the domain name. """ diff --git a/data/release-notes/2-20/24.yml b/data/release-notes/2-20/24.yml new file mode 100644 index 0000000000..c9c6470ca0 --- /dev/null +++ b/data/release-notes/2-20/24.yml @@ -0,0 +1,27 @@ +date: '2021-03-02' +sections: + security_fixes: + - '**HIGH:** An improper access control vulnerability was identified in GitHub Enterprise Server that allowed authenticated users of the instance to gain write access to unauthorized repositories via specifically crafted pull requests and REST API requests. An attacker would need to be able to fork the targeted repository, a setting that is disabled by default for organization owned private repositories. Branch protections such as required pull request reviews or status checks would prevent unauthorized commits from being merged without further review or validation. This vulnerability has been assigned CVE-2021-22861. This issue was reported via the [GitHub Bug Bounty Program](https://bounty.github.com).' + - '**HIGH:** An improper access control vulnerability was identified in the GitHub Enterprise Server GraphQL API that allowed authenticated users of the instance to modify the maintainer collaboration permission of a pull request without proper authorization. By exploiting this vulnerability, an attacker would be able to gain access to head branches of pull requests opened on repositories of which they are a maintainer. Forking is disabled by default for organization owned private repositories and would prevent this vulnerability. Additionally, branch protections such as required pull request reviews or status checks would prevent unauthorized commits from being merged without further review or validation. This vulnerability has been assigned CVE-2021-22863. This issue was reported via the [GitHub Bug Bounty Program](https://bounty.github.com).' + - '**HIGH:** A remote code execution vulnerability was identified in GitHub Enterprise Server that could be exploited when building a GitHub Pages site. User-controlled configuration of the underlying parsers used by GitHub Pages were not sufficiently restricted and made it possible to execute commands on the GitHub Enterprise Server instance. To exploit this vulnerability, an attacker would need permission to create and build a GitHub Pages site on the GitHub Enterprise Server instance. This vulnerability has been assigned CVE-2020-10519 and was reported via the [GitHub Bug Bounty Program](https://bounty.github.com).' + - '**LOW:** A specially crafted request to the SVN bridge could trigger a long wait before failure resulting in Denial of Service (DoS).' + - 'Packages have been updated to the latest security versions.' + bugs: + - 'An informational message was unintentionally logged as an error during GitHub Enterprise Backup Utilities snapshots, which resulted in unnecessary emails being sent when backups were scheduled by cron jobs that listen for output to stderr.' + - 'While restoring a large backup, exception logging related to Redis memory exhaustion could cause the restore to fail due to a full disk.' + - 'When editing a wiki page a user could experience a 500 error when clicking the Save button.' + - 'An S/MIME signed commit using a certificate with multiple names in the subject alternative name would incorrectly show as "Unverified" in the commit badge.' + - 'Suspended user was sent emails when added to a team.' + - 'When uploading a new license file with a different number of seats from the previous license file, the seat difference was not correctly represented in the enterprise account Settings -> License page.' + - 'The "Prevent repository admins from changing anonymous Git read access" checkbox available in the enterprise account settings could not be successfully enabled or disabled.' + - 'During a leap year, the user was getting a 404 response when trying to view Contribution activity on a Monday.' + changes: + - 'Added support for [AWS EC2 r5b instance types](https://aws.amazon.com/about-aws/whats-new/2020/12/introducing-new-amazon-ec2-r5b-instances-featuring-60-gbps-of-ebs-bandwidth-and-260K-iops/).' + - 'Adjusted background queue prioritization to more evenly distribute jobs.' + known_issues: + - 'On a freshly set up GitHub Enterprise Server without any users, an attacker could create the first admin user.' + - 'Custom firewall rules are not maintained during an upgrade.' + - 'Git LFS tracked files [uploaded through the web interface](https://github.com/blog/2105-upload-files-to-your-repositories) are incorrectly added directly to the repository.' + - 'Issues cannot be closed if they contain a permalink to a blob in the same repository where the file path is longer than 255 characters.' + - 'When "Users can search GitHub.com" is enabled with GitHub Connect, issues in private and internal repositories are not included in GitHub.com search results.' + - 'Security alerts are not reported when pushing to a repository on the command line.' diff --git a/data/release-notes/2-21/0.yml b/data/release-notes/2-21/0.yml index 6bb9fb5cb8..8aaf343503 100644 --- a/data/release-notes/2-21/0.yml +++ b/data/release-notes/2-21/0.yml @@ -69,3 +69,4 @@ sections: - 'When "Users can search GitHub.com" is enabled with GitHub Connect, issues in private and internal repositories are not included in GitHub.com search results. {% comment %} https://github.com/github/admin-experience/issues/571 {% endcomment %}' - 'Security alerts are not reported when pushing to a repository on the command line. (updated 2020-06-23) {% comment %} https://github.com/github/github/issues/143190 {% endcomment %}' - 'Audit logs may be attributed to 127.0.0.1 instead of the actual source IP address. (updated 2020-11-02) {% comment %} https://github.com/github/enterprise2/issues/21514 {% endcomment %}' + - "Configuring a repository's permission to `Triage` or `Maintain` fails with an error message." diff --git a/data/release-notes/2-21/1.yml b/data/release-notes/2-21/1.yml index 5f5e6f7797..deafcf031f 100644 --- a/data/release-notes/2-21/1.yml +++ b/data/release-notes/2-21/1.yml @@ -17,3 +17,4 @@ sections: - 'When "Users can search GitHub.com" is enabled with GitHub Connect, issues in private and internal repositories are not included in GitHub.com search results. {% comment %} https://github.com/github/admin-experience/issues/571 {% endcomment %}' - 'Security alerts are not reported when pushing to a repository on the command line. {% comment %} https://github.com/github/github/issues/143190 {% endcomment %}' - 'Audit logs may be attributed to 127.0.0.1 instead of the actual source IP address. (updated 2020-11-02) {% comment %} https://github.com/github/enterprise2/issues/21514 {% endcomment %}' + - "Configuring a repository's permission to `Triage` or `Maintain` fails with an error message." diff --git a/data/release-notes/2-21/15.yml b/data/release-notes/2-21/15.yml new file mode 100644 index 0000000000..7926760a99 --- /dev/null +++ b/data/release-notes/2-21/15.yml @@ -0,0 +1,32 @@ +date: '2021-03-02' +sections: + security_fixes: + - '**HIGH:** An improper access control vulnerability was identified in GitHub Enterprise Server that allowed authenticated users of the instance to gain write access to unauthorized repositories via specifically crafted pull requests and REST API requests. An attacker would need to be able to fork the targeted repository, a setting that is disabled by default for organization owned private repositories. Branch protections such as required pull request reviews or status checks would prevent unauthorized commits from being merged without further review or validation. This vulnerability has been assigned CVE-2021-22861. This issue was reported via the [GitHub Bug Bounty Program](https://bounty.github.com).' + - '**HIGH:** An improper access control vulnerability was identified in the GitHub Enterprise Server GraphQL API that allowed authenticated users of the instance to modify the maintainer collaboration permission of a pull request without proper authorization. By exploiting this vulnerability, an attacker would be able to gain access to head branches of pull requests opened on repositories of which they are a maintainer. Forking is disabled by default for organization owned private repositories and would prevent this vulnerability. Additionally, branch protections such as required pull request reviews or status checks would prevent unauthorized commits from being merged without further review or validation. This vulnerability has been assigned CVE-2021-22863. This issue was reported via the [GitHub Bug Bounty Program](https://bounty.github.com).' + - '**HIGH:** A remote code execution vulnerability was identified in GitHub Enterprise Server that could be exploited when building a GitHub Pages site. User-controlled configuration of the underlying parsers used by GitHub Pages were not sufficiently restricted and made it possible to execute commands on the GitHub Enterprise Server instance. To exploit this vulnerability, an attacker would need permission to create and build a GitHub Pages site on the GitHub Enterprise Server instance. This vulnerability has been assigned CVE-2020-10519 and was reported via the [GitHub Bug Bounty Program](https://bounty.github.com).' + - '**MEDIUM:** GitHub Tokens from GitHub Pages builds could end up in logs.' + - '**LOW:** A specially crafted request to the SVN bridge could trigger a long wait before failure resulting in Denial of Service (DoS).' + - 'Packages have been updated to the latest security versions.' + bugs: + - 'The load-balancer health checks in some cases could cause the babeld logs to fill up with errors about the PROXY protocol.' + - 'An informational message was unintentionally logged as an error during GitHub Enterprise Backup Utilities snapshots, which resulted in unnecessary emails being sent when backups were scheduled by cron jobs that listen for output to stderr.' + - 'While restoring a large backup, exception logging related to Redis memory exhaustion could cause the restore to fail due to a full disk.' + - 'When editing a wiki page a user could experience a 500 error when clicking the Save button.' + - 'An S/MIME signed commit using a certificate with multiple names in the subject alternative name would incorrectly show as "Unverified" in the commit badge.' + - 'Suspended user was sent emails when added to a team.' + - 'When a repository had a large number of manifests an error `You have reached the maximum number of allowed manifest files (20) for this repository.` was shown on the Insights -> Dependency graph tab. For more information, see [Visualization limits](https://docs.github.com/en/github/managing-security-vulnerabilities/troubleshooting-the-detection-of-vulnerable-dependencies#are-there-limits-which-affect-the-dependency-graph-data).' + - 'When uploading a new license file with a different number of seats from the previous license file, the seat difference was not correctly represented in the enterprise account Settings -> License page.' + - 'The "Prevent repository admins from changing anonymous Git read access" checkbox available in the enterprise account settings could not be successfully enabled or disabled.' + - 'When a GitHub Pages build failed, the email notification contained an incorrect link for support location.' + - 'During a leap year, the user was getting a 404 response when trying to view Contribution activity on a Monday.' + - 'Visiting the *Explore* section failed with a 500 Internal Server error.' + changes: + - 'Added support for [AWS EC2 r5b instance types](https://aws.amazon.com/about-aws/whats-new/2020/12/introducing-new-amazon-ec2-r5b-instances-featuring-60-gbps-of-ebs-bandwidth-and-260K-iops/).' + - 'Adjusted background queue prioritization to more evenly distribute jobs.' + known_issues: + - 'On a freshly set up GitHub Enterprise Server without any users, an attacker could create the first admin user.' + - 'Custom firewall rules are not maintained during an upgrade.' + - 'Git LFS tracked files [uploaded through the web interface](https://github.com/blog/2105-upload-files-to-your-repositories) are incorrectly added directly to the repository.' + - 'Issues cannot be closed if they contain a permalink to a blob in the same repository where the file path is longer than 255 characters.' + - 'When "Users can search GitHub.com" is enabled with GitHub Connect, issues in private and internal repositories are not included in GitHub.com search results.' + - 'Security alerts are not reported when pushing to a repository on the command line.' diff --git a/data/release-notes/2-21/16.yml b/data/release-notes/2-21/16.yml new file mode 100644 index 0000000000..ac4c83fe6d --- /dev/null +++ b/data/release-notes/2-21/16.yml @@ -0,0 +1,13 @@ +date: '2021-03-16' +sections: + security_fixes: + - Packages have been updated to the latest security versions. + bugs: + - Importing of repository archives from GitHub Enterprise Server that are missing repository files would fail with an error. + known_issues: + - On a freshly set up GitHub Enterprise Server without any users, an attacker could create the first admin user. + - Custom firewall rules are not maintained during an upgrade. + - Git LFS tracked files [uploaded through the web interface](https://github.com/blog/2105-upload-files-to-your-repositories) are incorrectly added directly to the repository. + - Issues cannot be closed if they contain a permalink to a blob in the same repository where the file path is longer than 255 characters. + - When "Users can search GitHub.com" is enabled with GitHub Connect, issues in private and internal repositories are not included in GitHub.com search results. + - Security alerts are not reported when pushing to a repository on the command line. diff --git a/data/release-notes/2-21/2.yml b/data/release-notes/2-21/2.yml index 6a53b827e1..e2ebe43f81 100644 --- a/data/release-notes/2-21/2.yml +++ b/data/release-notes/2-21/2.yml @@ -17,3 +17,4 @@ sections: - 'When "Users can search GitHub.com" is enabled with GitHub Connect, issues in private and internal repositories are not included in GitHub.com search results. {% comment %} https://github.com/github/admin-experience/issues/571 {% endcomment %}' - 'Security alerts are not reported when pushing to a repository on the command line. {% comment %} https://github.com/github/github/issues/143190 {% endcomment %}' - 'Audit logs may be attributed to 127.0.0.1 instead of the actual source IP address. (updated 2020-11-02) {% comment %} https://github.com/github/enterprise2/issues/21514 {% endcomment %}' + - "Configuring a repository's permission to `Triage` or `Maintain` fails with an error message." diff --git a/data/release-notes/2-21/3.yml b/data/release-notes/2-21/3.yml index c7f17686e5..b9f06ad896 100644 --- a/data/release-notes/2-21/3.yml +++ b/data/release-notes/2-21/3.yml @@ -14,3 +14,4 @@ sections: - 'When "Users can search GitHub.com" is enabled with GitHub Connect, issues in private and internal repositories are not included in GitHub.com search results. {% comment %} https://github.com/github/admin-experience/issues/571 {% endcomment %}' - 'Security alerts are not reported when pushing to a repository on the command line. {% comment %} https://github.com/github/github/issues/143190 {% endcomment %}' - 'Audit logs may be attributed to 127.0.0.1 instead of the actual source IP address. (updated 2020-11-02) {% comment %} https://github.com/github/enterprise2/issues/21514 {% endcomment %}' + - "Configuring a repository's permission to `Triage` or `Maintain` fails with an error message." diff --git a/data/release-notes/2-21/4.yml b/data/release-notes/2-21/4.yml index b73e682200..d3cded02fc 100644 --- a/data/release-notes/2-21/4.yml +++ b/data/release-notes/2-21/4.yml @@ -24,3 +24,4 @@ sections: - 'When "Users can search GitHub.com" is enabled with GitHub Connect, issues in private and internal repositories are not included in GitHub.com search results. {% comment %} https://github.com/github/admin-experience/issues/571 {% endcomment %}' - 'Security alerts are not reported when pushing to a repository on the command line. {% comment %} https://github.com/github/github/issues/143190 {% endcomment %}' - 'Audit logs may be attributed to 127.0.0.1 instead of the actual source IP address. (updated 2020-11-02) {% comment %} https://github.com/github/enterprise2/issues/21514 {% endcomment %}' + - "Configuring a repository's permission to `Triage` or `Maintain` fails with an error message." diff --git a/data/release-notes/2-21/5.yml b/data/release-notes/2-21/5.yml index 21942a85b6..b5ddf7652f 100644 --- a/data/release-notes/2-21/5.yml +++ b/data/release-notes/2-21/5.yml @@ -12,3 +12,4 @@ sections: - 'When "Users can search GitHub.com" is enabled with GitHub Connect, issues in private and internal repositories are not included in GitHub.com search results. {% comment %} https://github.com/github/admin-experience/issues/571 {% endcomment %}' - 'Security alerts are not reported when pushing to a repository on the command line. {% comment %} https://github.com/github/github/issues/143190 {% endcomment %}' - 'Audit logs may be attributed to 127.0.0.1 instead of the actual source IP address. (updated 2020-11-02) {% comment %} https://github.com/github/enterprise2/issues/21514 {% endcomment %}' + - "Configuring a repository's permission to `Triage` or `Maintain` fails with an error message." diff --git a/data/release-notes/2-21/6.yml b/data/release-notes/2-21/6.yml index 8638d1d9cd..03c71afb3a 100644 --- a/data/release-notes/2-21/6.yml +++ b/data/release-notes/2-21/6.yml @@ -24,3 +24,4 @@ sections: - 'When "Users can search GitHub.com" is enabled with GitHub Connect, issues in private and internal repositories are not included in GitHub.com search results. {% comment %} https://github.com/github/admin-experience/issues/571 {% endcomment %}' - 'Security alerts are not reported when pushing to a repository on the command line. {% comment %} https://github.com/github/github/issues/143190 {% endcomment %}' - 'Audit logs may be attributed to 127.0.0.1 instead of the actual source IP address. (updated 2020-11-02) {% comment %} https://github.com/github/enterprise2/issues/21514 {% endcomment %}' + - "Configuring a repository's permission to `Triage` or `Maintain` fails with an error message." diff --git a/data/release-notes/2-21/7.yml b/data/release-notes/2-21/7.yml index 7dbc04c989..994797e2d5 100644 --- a/data/release-notes/2-21/7.yml +++ b/data/release-notes/2-21/7.yml @@ -3,6 +3,7 @@ sections: bugs: - 'A service health check caused session growth resulting in filesystem inode exhaustion. {% comment %} https://github.com/github/enterprise2/pull/22481, https://github.com/github/enterprise2/pull/22475 {% endcomment %}' - "Upgrading using a hotpatch could fail with an error: `'libdbi1' was not found` {% comment %} https://github.com/github/enterprise2/pull/22556, https://github.com/github/enterprise2/pull/22552 {% endcomment %}" + - "Configuring a repository's permission to `Triage` or `Maintain` no longer fails." known_issues: - 'On a freshly set up GitHub Enterprise Server without any users, an attacker could create the first admin user. {% comment %} https://github.com/github/enterprise2/issues/1889 {% endcomment %}' - 'Custom firewall rules are not maintained during an upgrade. {% comment %} https://github.com/github/enterprise2/issues/2823 {% endcomment %}' diff --git a/data/release-notes/2-22/5.yml b/data/release-notes/2-22/5.yml index 6801ba1b04..3498f14906 100644 --- a/data/release-notes/2-22/5.yml +++ b/data/release-notes/2-22/5.yml @@ -11,7 +11,7 @@ sections: - 'The way SSH certificates were applied between Organizations and Businesses was inconsistent. {% comment %} https://github.com/github/github/pull/163423, https://github.com/github/github/pull/159538, https://github.com/github/authentication/issues/115 {% endcomment %}' - 'When an account was rate limited due to using incorrect passwords, it could be locked out for up to 24 hours. {% comment %} https://github.com/github/github/pull/163433, https://github.com/github/github/pull/162938, https://github.com/github/github-ds/pull/51 {% endcomment %}' - 'Pull request synchronization on repositories with many references could cause worker queues to fall behind. {% comment %} https://github.com/github/github/pull/163573, https://github.com/github/github/pull/163142 {% endcomment %}' - - 'When signing in after attempting to visit a specific page, people were sent to the home page instead of their intended destination. {% comment %} https://github.com/github/github/pull/163782, https://github.com/github/github/pull/163579, https://github.com/github/github/pull/154117, https://github.com/github/ecosystem-apps/issues/1076 {% endcomment %}' + - 'When signing in with a local username and password (built-in authentication) after attempting to visit a specific page, the user was sent to the home page instead of their intended destination. {% comment %} https://github.com/github/github/pull/163782, https://github.com/github/github/pull/163579, https://github.com/github/github/pull/154117, https://github.com/github/ecosystem-apps/issues/1076 {% endcomment %}' - 'For GHES instances using built-in authentication with an internal SAML identity provider, users without an associated email address could not create a commit from the web interface. {% comment %} https://github.com/github/github/pull/164009, https://github.com/github/github/pull/163530, https://github.com/github/github/issues/163524 {% endcomment %}' known_issues: - 'On a freshly set up GitHub Enterprise Server without any users, an attacker could create the first admin user. {% comment %} https://github.com/github/enterprise2/issues/1889 {% endcomment %}' diff --git a/data/release-notes/2-22/7.yml b/data/release-notes/2-22/7.yml new file mode 100644 index 0000000000..e443324f36 --- /dev/null +++ b/data/release-notes/2-22/7.yml @@ -0,0 +1,34 @@ +date: '2021-03-02' +sections: + security_fixes: + - '**HIGH:** An improper access control vulnerability was identified in GitHub Enterprise Server that allowed authenticated users of the instance to gain write access to unauthorized repositories via specifically crafted pull requests and REST API requests. An attacker would need to be able to fork the targeted repository, a setting that is disabled by default for organization owned private repositories. Branch protections such as required pull request reviews or status checks would prevent unauthorized commits from being merged without further review or validation. This vulnerability has been assigned CVE-2021-22861. This issue was reported via the [GitHub Bug Bounty Program](https://bounty.github.com).' + - '**HIGH:** An improper access control vulnerability was identified in the GitHub Enterprise Server GraphQL API that allowed authenticated users of the instance to modify the maintainer collaboration permission of a pull request without proper authorization. By exploiting this vulnerability, an attacker would be able to gain access to head branches of pull requests opened on repositories of which they are a maintainer. Forking is disabled by default for organization owned private repositories and would prevent this vulnerability. Additionally, branch protections such as required pull request reviews or status checks would prevent unauthorized commits from being merged without further review or validation. This vulnerability has been assigned CVE-2021-22863. This issue was reported via the [GitHub Bug Bounty Program](https://bounty.github.com).' + - '**HIGH:** A remote code execution vulnerability was identified in GitHub Enterprise Server that could be exploited when building a GitHub Pages site. User-controlled configuration of the underlying parsers used by GitHub Pages were not sufficiently restricted and made it possible to execute commands on the GitHub Enterprise Server instance. To exploit this vulnerability, an attacker would need permission to create and build a GitHub Pages site on the GitHub Enterprise Server instance. This vulnerability has been assigned CVE-2020-10519 and was reported via the [GitHub Bug Bounty Program](https://bounty.github.com).' + - '**MEDIUM:** GitHub Tokens from GitHub Pages builds could end up in logs.' + - '**LOW:** A specially crafted request to the SVN bridge could trigger a long wait before failure resulting in Denial of Service (DoS).' + - 'Packages have been updated to the latest security versions.' + bugs: + - 'The load-balancer health checks in some cases could cause the babeld logs to fill up with errors about the PROXY protocol.' + - 'An informational message was unintentionally logged as an error during GitHub Enterprise Backup Utilities snapshots, which resulted in unnecessary emails being sent when backups were scheduled by cron jobs that listen for output to stderr.' + - 'While restoring a large backup, exception logging related to Redis memory exhaustion could cause the restore to fail due to a full disk.' + - 'When first setting up a new instance, if you selected "Configure as Replica" you would be unable to start replication.' + - 'When GitHub Actions was enabled, disabling maintenance mode in the management console failed.' + - 'When editing a wiki page a user could experience a 500 error when clicking the Save button.' + - 'An S/MIME signed commit using a certificate with multiple names in the subject alternative name would incorrectly show as "Unverified" in the commit badge.' + - 'Suspended user was sent emails when added to a team.' + - 'User saw 500 error when executing git operations on an instance configured with LDAP authentication.' + - 'The `remove_org_member_package_access` background job was visible in the management console and would continually increase.' + - 'When a repository had a large number of manifests an error `You have reached the maximum number of allowed manifest files (20) for this repository.` was shown on the Insights -> Dependency graph tab. For more information, see [Visualization limits](https://docs.github.com/en/github/managing-security-vulnerabilities/troubleshooting-the-detection-of-vulnerable-dependencies#are-there-limits-which-affect-the-dependency-graph-data).' + - 'When uploading a new license file with a different number of seats from the previous license file, the seat difference was not correctly represented in the enterprise account Settings -> License page.' + - 'The "Prevent repository admins from changing anonymous Git read access" checkbox available in the enterprise account settings could not be successfully enabled or disabled.' + - 'When a GitHub Pages build failed, the email notification contained an incorrect link for support location.' + - 'During a leap year, the user was getting a 404 response when trying to view Contribution activity on a Monday.' + changes: + - 'Added support for [AWS EC2 r5b instance types](https://aws.amazon.com/about-aws/whats-new/2020/12/introducing-new-amazon-ec2-r5b-instances-featuring-60-gbps-of-ebs-bandwidth-and-260K-iops/).' + - 'Adjusted background queue prioritization to more evenly distribute jobs.' + known_issues: + - 'On a freshly set up GitHub Enterprise Server without any users, an attacker could create the first admin user.' + - 'Custom firewall rules are not maintained during an upgrade.' + - 'Git LFS tracked files [uploaded through the web interface](https://github.com/blog/2105-upload-files-to-your-repositories) are incorrectly added directly to the repository.' + - 'Issues cannot be closed if they contain a permalink to a blob in the same repository where the file path is longer than 255 characters.' + - 'When "Users can search GitHub.com" is enabled with GitHub Connect, issues in private and internal repositories are not included in GitHub.com search results.' diff --git a/data/release-notes/2-22/8.yml b/data/release-notes/2-22/8.yml new file mode 100644 index 0000000000..d1f7ca16f3 --- /dev/null +++ b/data/release-notes/2-22/8.yml @@ -0,0 +1,14 @@ +date: '2021-03-16' +sections: + security_fixes: + - Packages have been updated to the latest security versions. + bugs: + - Systemd journal logs were duplicated in multiple places. + - A site admin could get a 500 error page while trying to view issues referenced from private repositories. + - Importing of repository archives from GitHub Enterprise Server that are missing repository files would fail with an error. + known_issues: + - On a freshly set up GitHub Enterprise Server without any users, an attacker could create the first admin user. + - Custom firewall rules are not maintained during an upgrade. + - Git LFS tracked files [uploaded through the web interface](https://github.com/blog/2105-upload-files-to-your-repositories) are incorrectly added directly to the repository. + - Issues cannot be closed if they contain a permalink to a blob in the same repository where the file path is longer than 255 characters. + - When "Users can search GitHub.com" is enabled with GitHub Connect, issues in private and internal repositories are not included in GitHub.com search results. diff --git a/data/release-notes/3-0/0-rc1.yml b/data/release-notes/3-0/0-rc1.yml index 5d46eae41d..eff12aeed9 100644 --- a/data/release-notes/3-0/0-rc1.yml +++ b/data/release-notes/3-0/0-rc1.yml @@ -1,5 +1,6 @@ date: '2021-01-12' release_candidate: true +deprecated: true intro: Release candidate versions should be tested on non-production environments. For more information about the Release Candidate Program, see the [GitHub Blog](https://github.blog/2020-12-03-improving-the-ghes-release-process-release-candidates/) or "[About upgrades to new releases](/admin/overview/about-upgrades-to-new-releases)". sections: bugs: diff --git a/data/release-notes/3-0/0-rc2.yml b/data/release-notes/3-0/0-rc2.yml index 5357fd478b..a21cbb9e64 100644 --- a/data/release-notes/3-0/0-rc2.yml +++ b/data/release-notes/3-0/0-rc2.yml @@ -1,5 +1,6 @@ date: '2021-01-29' release_candidate: true +deprecated: true intro: Release candidate versions should be tested on non-production environments. For more information about the Release Candidate Program, see the [GitHub Blog](https://github.blog/2020-12-03-improving-the-ghes-release-process-release-candidates/) or "[About upgrades to new releases](/admin/overview/about-upgrades-to-new-releases)." sections: bugs: diff --git a/data/release-notes/3-0/0.yml b/data/release-notes/3-0/0.yml index 0ba564dd7f..37e8d44005 100644 --- a/data/release-notes/3-0/0.yml +++ b/data/release-notes/3-0/0.yml @@ -1,6 +1,8 @@ date: '2021-02-16' intro: The minimum infrastructure requirements have increased for {% data variables.product.prodname_ghe_server %} 3.0+. For more information, see "[About minimum requirements for GitHub Enterprise Server 3.0 and later](/admin/enterprise-management/upgrading-github-enterprise-server#about-minimum-requirements-for-github-enterprise-server-30-and-later)." sections: + security_fixes: + - '**HIGH:** A remote code execution vulnerability was identified in {% data variables.product.prodname_ghe_server %} that could be exploited when building a {% data variables.product.prodname_pages %} site. User-controlled configuration of the underlying parsers used by {% data variables.product.prodname_pages %} were not sufficiently restricted and made it possible to execute commands on the {% data variables.product.prodname_ghe_server %} instance. To exploit this vulnerability, an attacker would need permission to create and build a {% data variables.product.prodname_pages %} site on the {% data variables.product.prodname_ghe_server %} instance. This vulnerability has been assigned CVE-2020-10519 and was reported via the [GitHub Bug Bounty Program](https://bounty.github.com).' features: - heading: GitHub Actions notes: @@ -111,6 +113,7 @@ sections: - The format of several log files have changed, including the addition of a PID for different log types. This does not affect how GitHub Enterprise Support uses support bundles to troubleshoot issues. - A PATCH request to the webhook configuration API no longer erases the webhook secret. - Certain types of pre-receive hooks were failing. + - 'The Packages NuGet service now normalizes semantic versions on publish. An invalid semantic version (for example: v1.0.0.0.0.0) is not downloadable by NuGet clients and therefore a NuGet service is expected to normalize those versions (for example: v1.0.0.0.0.0 --> v1.0.0). Any original, non-normalized, version will be available in the `verbatimVersion` field. No changes to client configurations are required.' known_issues: - On a freshly set up {% data variables.product.prodname_ghe_server %} without any users, an attacker could create the first admin user. @@ -119,6 +122,14 @@ sections: - When "Users can search GitHub.com" is enabled with GitHub Connect, issues in private and internal repositories are not included in GitHub.com search results. - When maintenance mode is enabled, some services continue to be listed as "active processes". The services identified are expected to run during maintenance mode. If you experience this issue and are unsure, contact {% data variables.contact.contact_ent_support %}. - When GitHub Actions is enabled, use '`ghe-maintenance -u`' to unset maintenance mode. + - 'Duplicated logging to `/var/log/messages`, `/var/log/syslog`, and `/var/log/user.log` results in increased root volume utilization.' + - Users can dismiss a mandatory message without checking all checkboxes. + - '[Pre-receive hook scripts](/admin/policies/enforcing-policy-with-pre-receive-hooks) cannot write temporary files, which may cause script execution to fail. Users who use pre-receive hooks should test in a staging environment to see if scripts require write access.' + - Repository [deploy keys](/developers/overview/managing-deploy-keys) are unable to be used with repositories containing LFS objects. + - Juypter Notebook rendering in the web UI may fail if the notebook includes non UTF-8 encoded characters. + - Dependency graph fails to parse `setup.py` Python manifest files, resulting in HTTP 500 errors in logs. This, combined with the duplicated logging issue, results in increased root volume utilization. + - A race condition can cause dependency graph database migrations to appear to fail. + - Instances with a custom timezone that were upgraded from an earlier release of GitHub Enterprise Server may have incorrect timestamps in the web UI. deprecations: - heading: Deprecation of GitHub Enterprise Server 2.19 diff --git a/data/release-notes/3-0/1.yml b/data/release-notes/3-0/1.yml new file mode 100644 index 0000000000..abc20d1d7c --- /dev/null +++ b/data/release-notes/3-0/1.yml @@ -0,0 +1,43 @@ +date: '2021-03-02' +sections: + security_fixes: + - '**HIGH:** An improper access control vulnerability was identified in GitHub Enterprise Server that allowed authenticated users of the instance to gain write access to unauthorized repositories via specifically crafted pull requests and REST API requests. An attacker would need to be able to fork the targeted repository, a setting that is disabled by default for organization owned private repositories. Branch protections such as required pull request reviews or status checks would prevent unauthorized commits from being merged without further review or validation. This vulnerability has been assigned CVE-2021-22861. This issue was reported via the [GitHub Bug Bounty Program](https://bounty.github.com).' + - '**HIGH:** An improper access control vulnerability was identified in the GitHub Enterprise Server GraphQL API that allowed authenticated users of the instance to modify the maintainer collaboration permission of a pull request without proper authorization. By exploiting this vulnerability, an attacker would be able to gain access to head branches of pull requests opened on repositories of which they are a maintainer. Forking is disabled by default for organization owned private repositories and would prevent this vulnerability. Additionally, branch protections such as required pull request reviews or status checks would prevent unauthorized commits from being merged without further review or validation. This vulnerability has been assigned CVE-2021-22863. This issue was reported via the [GitHub Bug Bounty Program](https://bounty.github.com).' + - '**HIGH:** An improper access control vulnerability was identified in GitHub Enterprise Server that allowed an authenticated user with the ability to fork a repository to disclose Actions secrets for the parent repository of the fork. This vulnerability existed due to a flaw that allowed the base reference of a pull request to be updated to point to an arbitrary SHA or another pull request outside of the fork repository. By establishing this incorrect reference in a PR, the restrictions that limit the Actions secrets sent a workflow from forks could be bypassed. This vulnerability affected GitHub Enterprise Server versions 3.0.0, 3.0.0.rc2, and 3.0.0.rc1 and has been assigned CVE-2021-22862. This vulnerability was reported via the GitHub Bug Bounty program.' + - '**MEDIUM:** GitHub Tokens from GitHub Pages builds could end up in logs.' + - 'Packages have been updated to the latest security versions.' + bugs: + - 'The load-balancer health checks in some cases could cause the babeld logs to fill up with errors about the PROXY protocol.' + - 'The HTTP headers were not compliant with HTTP RFC standards in specific responses like 304 status for archives.' + - 'On instances that host Python repositories with the Dependency Graph feature enabled, the instance could become unresponsive due to the root disk filling with error logs.' + - 'An informational message was unintentionally logged as an error during GitHub Enterprise Backup Utilities snapshots, which resulted in unnecessary emails being sent when backups were scheduled by cron jobs that listen for output to stderr.' + - 'On VMWare ESX 6.7 the initial configuration could hang while creating host keys which left the instance inaccessible via SSH.' + - 'When GitHub Actions was enabled, disabling maintenance mode in the management console failed.' + - 'The Package creation setting was shown on the organization member settings page, though this feature is not yet available.' + - 'While enabling secret scanning on the Security & Analysis page the dialog incorrectly mentions private repositories.' + - 'When editing a wiki page a user could experience a 500 error when clicking the Save button.' + - 'An S/MIME signed commit using a certificate with multiple names in the subject alternative name would incorrectly show as "Unverified" in the commit badge.' + - 'User saw 500 error when executing git operations on an instance configured with LDAP authentication.' + - 'Suspended user was sent emails when added to a team.' + - 'When a repository had a large number of manifests an error `You have reached the maximum number of allowed manifest files (20) for this repository.` was shown on the Insights -> Dependency graph tab. For more information, see [Visualization limits](https://docs.github.com/en/github/managing-security-vulnerabilities/troubleshooting-the-detection-of-vulnerable-dependencies#are-there-limits-which-affect-the-dependency-graph-data).' + - 'Fixes users being shown the option to set up the Code Scanning CodeQL Action even if Actions was not enabled for their repository.' + - 'The "Prevent repository admins from changing anonymous Git read access" checkbox available in the enterprise account settings could not be successfully enabled or disabled.' + - 'The modal used to display a mandatory message contained no vertical scrollbar, meaning longer messages could not be viewed in full.' + - 'Redis would sometimes fail to start after a hard reboot or application crash.' + - 'Dependency graph fails to parse `setup.py` Python manifest files, resulting in HTTP 500 errors in logs. This, combined with the duplicated logging issue, results in increased root volume utilization.' + changes: + - 'Satisfy requests concurrently when multiple users are downloading the same archive, resulting in improved performance.' + known_issues: + - 'On a freshly set up GitHub Enterprise Server without any users, an attacker could create the first admin user.' + - 'Custom firewall rules are not maintained during an upgrade.' + - 'Git LFS tracked files [uploaded through the web interface](https://github.com/blog/2105-upload-files-to-your-repositories) are incorrectly added directly to the repository.' + - 'Issues cannot be closed if they contain a permalink to a blob in the same repository where the file path is longer than 255 characters.' + - 'When "Users can search GitHub.com" is enabled with GitHub Connect, issues in private and internal repositories are not included in GitHub.com search results.' + - 'When maintenance mode is enabled, some services continue to be listed as "active processes". The services identified are expected to run during maintenance mode. If you experience this issue and are unsure, contact [GitHub Enterprise Support](https://enterprise.githubsupport.com/hc/en-us) or [GitHub Premium Support](https://premium.githubsupport.com/).' + - 'Duplicated logging to `/var/log/messages`, `/var/log/syslog`, and `/var/log/user.log` results in increased root volume utilization.' + - 'Users can dismiss a mandatory message without checking all checkboxes.' + - '[Pre-receive hook scripts](/admin/policies/enforcing-policy-with-pre-receive-hooks) cannot write temporary files, which may cause script execution to fail. Users who use pre-receive hooks should test in a staging environment to see if scripts require write access.' + - 'Repository [deploy keys](/developers/overview/managing-deploy-keys) are unable to be used with repositories containing LFS objects.' + - 'Juypter Notebook rendering in the web UI may fail if the notebook includes non UTF-8 encoded characters.' + - 'Dependency graph fails to parse `yarn.lock` Javascript manifest files, resulting in HTTP 500 errors in logs.' + - 'Instances with a custom timezone that were upgraded from an earlier release of GitHub Enterprise Server may have incorrect timestamps in the web UI.' diff --git a/data/release-notes/3-0/2.yml b/data/release-notes/3-0/2.yml new file mode 100644 index 0000000000..5090c38c5b --- /dev/null +++ b/data/release-notes/3-0/2.yml @@ -0,0 +1,28 @@ +date: '2021-03-16' +sections: + security_fixes: + - Packages have been updated to the latest security versions. + bugs: + - During a backup an error "Warning: One or more storage objects were not found on the source appliance." was occurring when attempting to clean up purgeable storage objects. + - Dependency graph failed to parse `yarn.lock` JavaScript manifest files, resulting in HTTP 500 errors in logs. + - Disabling GitHub Actions would sometimes fail. + - Custom pre-receive hooks weren't allowed to write to `/tmp`, preventing some scripts from running correctly. + - Systemd journal logs were duplicated in multiple places. + - A timezone set on GitHub Enterprise 11.10.x or earlier was reset to UTC time after upgrading to 3.0 which caused timestamps to shift in some instances. + - Clicking "Publish your first package" in the packages sidebar on a repository would lead to an empty page. + - A site admin could get a 500 error page while trying to view issues referenced from private repositories. + - After disabling GitHub Packages, some organization pages would return an HTTP 500 error response. + - Importing of repository archives from GitHub Enterprise Server that are missing repository files would fail with an error. + - Repository [deploy keys](/developers/overview/managing-deploy-keys) were unable to be used with repositories containing LFS objects. + - In the packages sidebar of a repository, the Docker icon was gray and a tool tip displayed "This service is deprecated". + - Webhooks configured with a content type of `application/x-www-form-urlencoded` did not receive query parameters in the POST request body. + - Users could dismiss a mandatory message without checking all checkboxes. + - In some cases after upgrading from a 2.22.X instance, the web interface assets were missing and the page would not render correctly. + known_issues: + - On a freshly set up GitHub Enterprise Server without any users, an attacker could create the first admin user. + - Custom firewall rules are not maintained during an upgrade. + - Git LFS tracked files [uploaded through the web interface](https://github.com/blog/2105-upload-files-to-your-repositories) are incorrectly added directly to the repository. + - Issues cannot be closed if they contain a permalink to a blob in the same repository where the file path is longer than 255 characters. + - When "Users can search GitHub.com" is enabled with GitHub Connect, issues in private and internal repositories are not included in GitHub.com search results. + - When maintenance mode is enabled, some services continue to be listed as "active processes". The services identified are expected to run during maintenance mode. If you experience this issue and are unsure, contact [GitHub Enterprise Support](https://enterprise.githubsupport.com/hc/en-us) or [GitHub Premium Support](https://premium.githubsupport.com/). + - Juypter Notebook rendering in the web UI may fail if the notebook includes non UTF-8 encoded characters. diff --git a/data/reusables/actions/about-secrets.md b/data/reusables/actions/about-secrets.md index 073ff29d32..8ee1bee116 100644 --- a/data/reusables/actions/about-secrets.md +++ b/data/reusables/actions/about-secrets.md @@ -1 +1 @@ -Encrypted secrets allow you to store sensitive information, such as access tokens, in your repository{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}, repository environments,{% endif %} or organization. \ No newline at end of file +Encrypted secrets allow you to store sensitive information, such as access tokens, in your repository{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %}, repository environments,{% endif %} or organization. \ No newline at end of file diff --git a/data/reusables/actions/actions-audit-events-for-enterprise.md b/data/reusables/actions/actions-audit-events-for-enterprise.md index fc57d1e2da..2c0c30d196 100644 --- a/data/reusables/actions/actions-audit-events-for-enterprise.md +++ b/data/reusables/actions/actions-audit-events-for-enterprise.md @@ -1,10 +1,12 @@ | Action | Description |------------------|------------------- -| `register_self_hosted_runner` | Triggered when a new self-hosted runner is registered. For more information, see "[Adding a self-hosted runner to an enterprise](/actions/hosting-your-own-runners/adding-self-hosted-runners#adding-a-self-hosted-runner-to-an-enterprise)." -| `runner_group_created` | Triggered when a self-hosted runner group is created. For more information, see "[Creating a self-hosted runner group for an enterprise](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#creating-a-self-hosted-runner-group-for-an-enterprise). +| `remove_self_hosted_runner` | Triggered when a self-hosted runner is removed. +| `register_self_hosted_runner` | Triggered when a new self-hosted runner is registered. For more information, see "[Adding self-hosted runners](/actions/hosting-your-own-runners/adding-self-hosted-runners)." +| `runner_group_created` | Triggered when a self-hosted runner group is created. For more information, see "[About self-hosted runner groups](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#about-self-hosted-runner-groups). | `runner_group_removed` | Triggered when a self-hosted runner group is removed. For more information, see "[Removing a self-hosted runner group](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#removing-a-self-hosted-runner-group)." -| `runner_group_runner_removed` | Triggered when a self-hosted runner is removed from a group. +| `runner_group_runner_removed` | Triggered when the REST API is used to remove a self-hosted runner from a group. | `runner_group_runners_added` | Triggered when a self-hosted runner is added to a group. For more information, see "[Moving a self-hosted runner to a group](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#moving-a-self-hosted-runner-to-a-group)." +| `runner_group_runners_updated` | Triggered when a runner group's list of members is updated. For more information, see "[Set self-hosted runners in a group for an organization](/rest/reference/actions#set-self-hosted-runners-in-a-group-for-an-organization)." | `runner_group_updated` | Triggered when the configuration of a self-hosted runner group is changed. For more information, see "[Changing the access policy of a self-hosted runner group](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#changing-the-access-policy-of-a-self-hosted-runner-group)." | `self_hosted_runner_updated` | Triggered when the runner application is updated. Can be viewed using the REST API and the UI; not visible in the JSON/CSV export. For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners#about-self-hosted-runners)." diff --git a/data/reusables/actions/actions-authentication.md b/data/reusables/actions/actions-authentication.md index a047e0b5c4..9200794395 100644 --- a/data/reusables/actions/actions-authentication.md +++ b/data/reusables/actions/actions-authentication.md @@ -1 +1 @@ -This API is available for authenticated users, {% data variables.product.prodname_oauth_app %}s, and {% data variables.product.prodname_github_app %}s. Access tokens require [`repo` scope](/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/#available-scopes) for private repos and [`public_repo` scope](/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/#available-scopes) for public repos. +This API is available for authenticated users, {% data variables.product.prodname_oauth_app %}s, and {% data variables.product.prodname_github_app %}s. Access tokens require [`repo` scope](/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/#available-scopes) for private repos and [`public_repo` scope](/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/#available-scopes) for {% if currentVersion == "github-ae@latest" %} for internal repos that are available to everyone on the enterprise.{% else %}public repos.{% endif %} diff --git a/data/reusables/actions/ae-beta.md b/data/reusables/actions/ae-beta.md new file mode 100644 index 0000000000..0724c250bf --- /dev/null +++ b/data/reusables/actions/ae-beta.md @@ -0,0 +1,7 @@ +{% if currentVersion == "github-ae@latest" %} +{% note %} + +**Note:** {% data variables.product.prodname_actions %} is currently in beta for {% data variables.product.prodname_ghe_managed %}. + +{% endnote %} +{% endif %} diff --git a/data/reusables/actions/ae-self-hosted-runners-notice.md b/data/reusables/actions/ae-self-hosted-runners-notice.md new file mode 100644 index 0000000000..6d854cf0bb --- /dev/null +++ b/data/reusables/actions/ae-self-hosted-runners-notice.md @@ -0,0 +1,9 @@ +{% if currentVersion == "github-ae@latest" %} +{% warning %} + +** Warning:** Self-hosted runners are currently disabled for {% data variables.product.prodname_ghe_managed %}. This is because {% data variables.product.prodname_ghe_managed %} offers guarantees for security boundaries which are incompatible with how self-hosted runners work. However, if you do need to use self-hosted runners with {% data variables.product.prodname_ghe_managed %} and understand the security implications, you can contact {% data variables.product.prodname_dotcom %} support for a security exception that will enable self-hosted runners. + +If you don't need self-hosted runners, then you can use {% data variables.actions.hosted_runner %}s to run your workflows. For more information, see "[About {% data variables.actions.hosted_runner %}s](/actions/using-github-hosted-runners/about-ae-hosted-runners)." + +{% endwarning %} +{% endif %} diff --git a/data/reusables/actions/choose-repo.md b/data/reusables/actions/choose-repo.md new file mode 100644 index 0000000000..362868f66b --- /dev/null +++ b/data/reusables/actions/choose-repo.md @@ -0,0 +1 @@ +Choose a repository where you want to apply this project management workflow. You can use an existing repository that you have write access to, or you can create a new repository. For more information about creating a repository, see "[Creating a new repository](/articles/creating-a-new-repository)." \ No newline at end of file diff --git a/data/reusables/actions/commit-workflow.md b/data/reusables/actions/commit-workflow.md new file mode 100644 index 0000000000..fe2ce9b187 --- /dev/null +++ b/data/reusables/actions/commit-workflow.md @@ -0,0 +1 @@ +Commit your workflow file to the default branch of your repository. For more information, see "[Creating new files](/github/managing-files-in-a-repository/creating-new-files)." \ No newline at end of file diff --git a/data/reusables/actions/enterprise-hardware-considerations.md b/data/reusables/actions/enterprise-hardware-considerations.md deleted file mode 100644 index 5b80ff26c2..0000000000 --- a/data/reusables/actions/enterprise-hardware-considerations.md +++ /dev/null @@ -1 +0,0 @@ -If you {% if currentVersion == "enterprise-server@2.22" %} configured the beta of{% else %} configure{% endif %} {% data variables.product.prodname_actions %} for the users of your {% data variables.product.prodname_ghe_server %} instance, you may need to provision additional CPU and memory resources. The additional resources you need to provision depend on the number of workflows your users run concurrently, and the overall levels of activity for your instance. For more information about monitoring the capacity and performance of {% data variables.product.prodname_ghe_server %}, see "[Monitoring your appliance](/admin/enterprise-management/monitoring-your-appliance)." diff --git a/data/reusables/actions/enterprise-setup-prereq.md b/data/reusables/actions/enterprise-setup-prereq.md index 6646511192..16e647c097 100644 --- a/data/reusables/actions/enterprise-setup-prereq.md +++ b/data/reusables/actions/enterprise-setup-prereq.md @@ -1,4 +1,4 @@ -{% if enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.21" %} +{% if enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %} #### Using self-hosted runners on {% data variables.product.prodname_ghe_server %} diff --git a/data/reusables/actions/environments-beta.md b/data/reusables/actions/environments-beta.md index 5fe1386417..0ab094d719 100644 --- a/data/reusables/actions/environments-beta.md +++ b/data/reusables/actions/environments-beta.md @@ -1,4 +1,4 @@ -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %} {% note %} diff --git a/data/reusables/actions/make-workflow-file.md b/data/reusables/actions/make-workflow-file.md new file mode 100644 index 0000000000..82be838ded --- /dev/null +++ b/data/reusables/actions/make-workflow-file.md @@ -0,0 +1 @@ +In your repository, create a file called `.github/workflows/YOUR_WORKFLOW.yml`, replacing `YOUR_WORKFLOW` with a name of your choice. This is a workflow file. For more information about creating new files on GitHub, see "[Creating new files](/github/managing-files-in-a-repository/creating-new-files)." \ No newline at end of file diff --git a/data/reusables/actions/schedule-delay.md b/data/reusables/actions/schedule-delay.md new file mode 100644 index 0000000000..ecbd927178 --- /dev/null +++ b/data/reusables/actions/schedule-delay.md @@ -0,0 +1,5 @@ +{% note %} + +Note: The `schedule` event can be delayed during periods of high loads of {% data variables.product.prodname_actions %} workflow runs. + +{% endnote %} diff --git a/data/reusables/actions/visualization-beta.md b/data/reusables/actions/visualization-beta.md index ee3ad11ef4..da3ac2b0d2 100644 --- a/data/reusables/actions/visualization-beta.md +++ b/data/reusables/actions/visualization-beta.md @@ -1,4 +1,4 @@ -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %} {% note %} **Note:** The workflow visualization graph for {% data variables.product.prodname_actions %} is currently in beta and subject to change. diff --git a/data/reusables/actions/workflow-runs-dependabot-note.md b/data/reusables/actions/workflow-runs-dependabot-note.md new file mode 100644 index 0000000000..bbf085d6bf --- /dev/null +++ b/data/reusables/actions/workflow-runs-dependabot-note.md @@ -0,0 +1,7 @@ +{% if currentVersion == "free-pro-team@latest" %} +{% note %} + +**Note:** Workflow runs triggered by {% data variables.product.prodname_dependabot %} pull requests run as if they are from a forked repository, and therefore use a read-only `GITHUB_TOKEN`. These workflow runs cannot access any secrets. See ["Keeping your GitHub Actions and workflows secure: Preventing pwn requests"](https://securitylab.github.com/research/github-actions-preventing-pwn-requests) for strategies to keep these workflows secure. + +{% endnote %} +{% endif %} diff --git a/data/reusables/advanced-security/enable-disable-committer-info.md b/data/reusables/advanced-security/enable-disable-committer-info.md deleted file mode 100644 index 87a49d2dbf..0000000000 --- a/data/reusables/advanced-security/enable-disable-committer-info.md +++ /dev/null @@ -1 +0,0 @@ -When you enable {% data variables.product.prodname_GH_advanced_security %}, {% data variables.product.prodname_dotcom %} shows how many extra committers this will add and prompts for confirmation. If you disable access to {% data variables.product.prodname_GH_advanced_security %}, you can see how many seats this will free before you confirm the change. This makes it easy to see the impact of your changes on the use of your license. diff --git a/data/reusables/advanced-security/license-overview.md b/data/reusables/advanced-security/license-overview.md index 525f4d0aeb..0cf5f16b96 100644 --- a/data/reusables/advanced-security/license-overview.md +++ b/data/reusables/advanced-security/license-overview.md @@ -1 +1 @@ -Each license for {% data variables.product.prodname_GH_advanced_security %} specifies a maximum number of committers whose work can use these features. A committer is someone who authored at least one commit that was pushed to the repository in the last 90 days. Each committer is counted once, no matter how many repositories they contribute to. \ No newline at end of file +Each license for {% data variables.product.prodname_GH_advanced_security %} specifies a maximum number of accounts, or seats, that can use these features. Each active committer to at least one repository with the feature enabled uses one seat. An active committer is someone who authored at least one commit that was pushed to the repository in the last 90 days. diff --git a/data/reusables/advanced-security/more-info-ghas.md b/data/reusables/advanced-security/more-info-ghas.md index 4a510456e9..e3602931e4 100644 --- a/data/reusables/advanced-security/more-info-ghas.md +++ b/data/reusables/advanced-security/more-info-ghas.md @@ -1,3 +1,3 @@ -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} For more information, see "[About {% data variables.product.prodname_GH_advanced_security %}](/github/getting-started-with-github/about-github-advanced-security)." {% endif %} diff --git a/data/reusables/advanced-security/note-org-enable-uses-seats.md b/data/reusables/advanced-security/note-org-enable-uses-seats.md index 733e8e8a97..ff72be9b61 100644 --- a/data/reusables/advanced-security/note-org-enable-uses-seats.md +++ b/data/reusables/advanced-security/note-org-enable-uses-seats.md @@ -1,7 +1,6 @@ {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} {% note %} -**Note:** If you enable {% data variables.product.prodname_GH_advanced_security %}, committers to these repositories will use seats on your {% data variables.product.prodname_GH_advanced_security %} license. This option controls access to all {% data variables.product.prodname_advanced_security %} features including {% if currentVersion == "free-pro-team@latest" %}dependency review,{% endif %} {% data variables.product.prodname_code_scanning %}, and {% data variables.product.prodname_secret_scanning %}. - +**Note:** If you enable {% data variables.product.prodname_GH_advanced_security %}, committers to these repositories will use seats on your {% data variables.product.prodname_GH_advanced_security %} license. This option is disabled if you have exceeded your license capacity. {% if currentVersion == "free-pro-team@latest" %}For more information, see "[About licensing for {% data variables.product.prodname_GH_advanced_security %}](/github/setting-up-and-managing-billing-and-payments-on-github/about-licensing-for-github-advanced-security)."{% endif %} {% endnote %} {% endif %} \ No newline at end of file diff --git a/data/reusables/code-scanning/about-code-scanning.md b/data/reusables/code-scanning/about-code-scanning.md index 054042ee8c..6d556ec455 100644 --- a/data/reusables/code-scanning/about-code-scanning.md +++ b/data/reusables/code-scanning/about-code-scanning.md @@ -1 +1 @@ -{% data variables.product.prodname_code_scanning_capc %} is a feature that you use to analyze the code in a {% data variables.product.prodname_dotcom %} repository to find security vulnerabilities and coding errors. Any problems identified by the analysis are shown in {% if currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %}{% data variables.product.prodname_ghe_server %}{% else %}{% data variables.product.prodname_dotcom %}{% endif %}. +{% data variables.product.prodname_code_scanning_capc %} is a feature that you use to analyze the code in a {% data variables.product.prodname_dotcom %} repository to find security vulnerabilities and coding errors. Any problems identified by the analysis are shown in {% data variables.product.product_name %}. diff --git a/data/reusables/code-scanning/beta.md b/data/reusables/code-scanning/beta.md index 7d1b5dbc94..9da0119339 100644 --- a/data/reusables/code-scanning/beta.md +++ b/data/reusables/code-scanning/beta.md @@ -6,4 +6,12 @@ {% endnote %} +{% elsif currentVersion == "github-ae@latest" %} + +{% note %} + +**Note:** {% data variables.product.prodname_code_scanning_capc %} is currently in beta and subject to change. + +{% endnote %} + {% endif %} diff --git a/data/reusables/code-scanning/codeql-runner-analyze-example.md b/data/reusables/code-scanning/codeql-runner-analyze-example.md new file mode 100644 index 0000000000..01e6a97f91 --- /dev/null +++ b/data/reusables/code-scanning/codeql-runner-analyze-example.md @@ -0,0 +1,25 @@ +1. Populate the {% data variables.product.prodname_codeql %} databases, analyze them, and upload the results to {% data variables.product.product_name %}. The results will appear in the **Security** tab for your repository. + + ```shell + $ /path/to-runner/codeql-runner-linux analyze --repository octo-org/example-repo + --github-url {% data variables.command_line.git_url_example %} --github-auth TOKEN + --commit 5b6a3078b31dc346e5ce7b86837d6abbe7a18bbd --ref refs/heads/my-branch + > Finalizing database creation + > ... + > POST /repos/octo-org/example-repo/code-scanning/sarifs - 202 in 786ms + > Successfully uploaded results + ``` + +1. To upload {% data variables.product.prodname_code_scanning %} results as pull request checks, specify the pull request using the `--ref` flag. We recommend setting up the {% data variables.product.prodname_codeql_runner %} so that it runs on the [`pull_request`](/developers/webhooks-and-events/webhook-events-and-payloads#pull_request) webhook event. + + ```shell + $ /path/to-runner/codeql-runner-linux analyze --repository octo-org/example-repo + --github-url {% data variables.command_line.git_url_example %} --github-auth TOKEN + --commit 1dc7a1346e5ce7b86835b68bbda3078b37d6abbe --ref refs/pull/123/merge + > Finalizing database creation + > ... + > POST /repos/octo-org/example-repo/code-scanning/sarifs - 202 in 786ms + > Successfully uploaded results + ``` + +For more information about viewing {% data variables.product.prodname_code_scanning %} alerts, see "[Triaging code scanning alerts in pull requests](/github/finding-security-vulnerabilities-and-errors-in-your-code/triaging-code-scanning-alerts-in-pull-requests)" and "[Managing code scanning alerts for your repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository)." diff --git a/data/reusables/code-scanning/custom-configuration-file.md b/data/reusables/code-scanning/custom-configuration-file.md new file mode 100644 index 0000000000..69fcb66027 --- /dev/null +++ b/data/reusables/code-scanning/custom-configuration-file.md @@ -0,0 +1 @@ +The configuration file can be located within the repository you are analyzing, or in an external repository. Using an external repository allows you to specify configuration options for multiple repositories in a single place. When you reference a configuration file located in an external repository, you can use the _OWNER/REPOSITORY/FILENAME@BRANCH_ syntax. For example, _monacorp/shared/codeql-config.yml@main_. diff --git a/data/reusables/code-scanning/run-additional-queries.md b/data/reusables/code-scanning/run-additional-queries.md index acc2be78d1..c6783f7b97 100644 --- a/data/reusables/code-scanning/run-additional-queries.md +++ b/data/reusables/code-scanning/run-additional-queries.md @@ -1,9 +1,9 @@ When you use {% data variables.product.prodname_codeql %} to scan code, the {% data variables.product.prodname_codeql %} analysis engine generates a database from the code and runs queries on it. For more information, see "[About {% data variables.product.prodname_code_scanning %}](/github/finding-security-vulnerabilities-and-errors-in-your-code/about-code-scanning#about-codeql)." -{% data variables.product.prodname_codeql %} analysis uses a default set of queries, but you can specify more queries to run, in addition to the default queries. The queries you want to run must belong to a {% data variables.product.prodname_ql %} pack and can be in your own repository or any public repository. For more information, see "[About {% data variables.product.prodname_ql %} packs](https://help.semmle.com/codeql/codeql-cli/reference/qlpack-overview.html)." +{% data variables.product.prodname_codeql %} analysis uses a default set of queries, but you can specify more queries to run, in addition to the default queries. The queries you want to run must belong to a {% data variables.product.prodname_ql %} pack in a repository. For more information, see "[About {% data variables.product.prodname_ql %} packs](https://codeql.github.com/docs/codeql-cli/about-ql-packs/)." -Queries must only depend on the standard libraries (that is, the libraries referenced by an `import LANGUAGE` statement in your query), or libraries in the same {% data variables.product.prodname_ql %} pack as the query. The standard libraries are located in the [github/codeql](https://github.com/github/codeql) repository. For more information, see "[About CodeQL queries](https://help.semmle.com/QL/learn-ql/writing-queries/introduction-to-queries.html)." +Queries must only depend on the standard libraries (that is, the libraries referenced by an `import LANGUAGE` statement in your query), or libraries in the same {% data variables.product.prodname_ql %} pack as the query. The standard libraries are located in the [github/codeql](https://github.com/github/codeql) repository. For more information, see "[About CodeQL queries](https://codeql.github.com/docs/writing-codeql-queries/about-codeql-queries/)." -You can specify a single _.ql_ file, a directory containing multiple _.ql_ files, a _.qls_ query suite definition file, or any combination. For more information about query suite definitions, see "[Creating {% data variables.product.prodname_codeql %} query suites](https://help.semmle.com/codeql/codeql-cli/procedures/query-suites.html)." +You can specify a single _.ql_ file, a directory containing multiple _.ql_ files, a _.qls_ query suite definition file, or any combination. For more information about query suite definitions, see "[Creating {% data variables.product.prodname_codeql %} query suites](https://codeql.github.com/docs/codeql-cli/creating-codeql-query-suites/)." {% if currentVersion == "free-pro-team@latest" %}We don't recommend referencing query suites directly from the `github/codeql` repository, like `github/codeql/cpp/ql/src@main`. Such queries may not be compiled with the same version of {% data variables.product.prodname_codeql %} as used for your other queries, which could lead to errors during analysis.{% endif %} diff --git a/data/reusables/dependabot/dependabot-secrets-button.md b/data/reusables/dependabot/dependabot-secrets-button.md new file mode 100644 index 0000000000..1e46dd9f8a --- /dev/null +++ b/data/reusables/dependabot/dependabot-secrets-button.md @@ -0,0 +1,2 @@ +1. In the sidebar, click **{% data variables.product.prodname_dependabot %}**. + ![{% data variables.product.prodname_dependabot %} secrets sidebar option](/assets/images/help/dependabot/dependabot-secrets.png) \ No newline at end of file diff --git a/data/reusables/dependabot/initial-updates.md b/data/reusables/dependabot/initial-updates.md index fe4154576b..ecc053f362 100644 --- a/data/reusables/dependabot/initial-updates.md +++ b/data/reusables/dependabot/initial-updates.md @@ -1,3 +1,5 @@ -When you first enable version updates, you may have many dependencies that are outdated and some may be many versions behind the latest version. {% data variables.product.prodname_dependabot %} checks for outdated dependencies as soon as it's enabled. You may see new pull requests for version updates within minutes of adding the configuration file, depending on the number of manifest files for which you configure updates. +When you first enable version updates, you may have many dependencies that are outdated and some may be many versions behind the latest version. {% data variables.product.prodname_dependabot %} checks for outdated dependencies as soon as it's enabled. You may see new pull requests for version updates within minutes of adding the configuration file, depending on the number of manifest files for which you configure updates. {% data variables.product.prodname_dependabot %} will also run an update on subsequent changes to the configuration file. -To keep pull requests manageable and easy to review, {% data variables.product.prodname_dependabot %} raises a maximum of five pull requests to start bringing dependencies up to the latest version. If you merge some of these first pull requests before the next scheduled update, then further pull requests are opened up to a maximum of five (you can change this limit). +{% data variables.product.prodname_dependabot %} may also create pull requests when you change a manifest file after an update has failed. This is because changes to a manifest, such as removing the dependency that caused the update to fail, may cause the newly triggered update to succeed. + +To keep pull requests manageable and easy to review, {% data variables.product.prodname_dependabot %} raises a maximum of five pull requests to start bringing dependencies up to the latest version. If you merge some of these first pull requests before the next scheduled update, remaining pull requests will be opened on the next update, up to that maximum. You can change the maximum number of open pull requests by setting the [`open-pull-requests-limit` configuration option](/github/administering-a-repository/configuration-options-for-dependency-updates#open-pull-requests-limit). diff --git a/data/reusables/dependabot/private-dependencies-note.md b/data/reusables/dependabot/private-dependencies-note.md index 18554c0ce1..7dd8f996d0 100644 --- a/data/reusables/dependabot/private-dependencies-note.md +++ b/data/reusables/dependabot/private-dependencies-note.md @@ -1,3 +1 @@ -When running security or version updates, some ecosystems must be able to resolve all dependencies from their source to verify that updates have been successful. If your manifest or lock files contain any private dependencies, {% data variables.product.prodname_dependabot %} must be able to access the location at which those dependencies are hosted. Organization owners can grant {% data variables.product.prodname_dependabot %} access to private repositories containing dependencies for a project within the same organization. For more information, see "[Managing security and analysis settings for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization#allowing-dependabot-to-access-private-repositories)." - -Currently, {% data variables.product.prodname_dependabot %} version updates doesn't support manifest or lock files that contain any dependencies hosted in private registries, or in private {% data variables.product.prodname_dotcom %} repositories that belong to a different organization than the dependent project. +When running security or version updates, some ecosystems must be able to resolve all dependencies from their source to verify that updates have been successful. If your manifest or lock files contain any private dependencies, {% data variables.product.prodname_dependabot %} must be able to access the location at which those dependencies are hosted. Organization owners can grant {% data variables.product.prodname_dependabot %} access to private repositories containing dependencies for a project within the same organization. For more information, see "[Managing security and analysis settings for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization#allowing-dependabot-to-access-private-dependencies)." You can configure access to private registries in a repository's _dependabot.yml_ configuration file. For more information, see "[Configuration options for dependency updates](/github/administering-a-repository/configuration-options-for-dependency-updates#configuration-options-for-private-registries)." diff --git a/data/reusables/dependabot/pull-request-security-vs-version-updates.md b/data/reusables/dependabot/pull-request-security-vs-version-updates.md new file mode 100644 index 0000000000..94bfc388d9 --- /dev/null +++ b/data/reusables/dependabot/pull-request-security-vs-version-updates.md @@ -0,0 +1,4 @@ +When {% data variables.product.prodname_dependabot %} raises pull requests, these pull requests could be for _security_ or _version_ updates: + +- {% data variables.product.prodname_dependabot_security_updates %} are automated pull requests that help you update dependencies with known vulnerabilities. +- {% data variables.product.prodname_dependabot_version_updates %} are automated pull requests that keep your dependencies updated, even when they don’t have any vulnerabilities. To check the status of version updates, navigate to the Insights tab of your repository, then Dependency Graph, and {% data variables.product.prodname_dependabot %}. diff --git a/data/reusables/dependabot/supported-package-managers.md b/data/reusables/dependabot/supported-package-managers.md index 6369d25a75..d4929ca10a 100644 --- a/data/reusables/dependabot/supported-package-managers.md +++ b/data/reusables/dependabot/supported-package-managers.md @@ -1,30 +1,30 @@ The following table shows, for each package manager: - The YAML value to use in the *dependabot.yml* file - The supported versions of the package manager -- Whether dependencies in private {% data variables.product.prodname_dotcom %} repositories are supported +- Whether dependencies in private {% data variables.product.prodname_dotcom %} repositories or registries are supported - Whether vendored dependencies are supported -Package manager | YAML value | Supported versions | Private repositories | Vendoring ---- | --- | --- |:---:|:---: -Bundler | `bundler` | v1 | | **✓** | -Cargo | `cargo` | v1 | **✓** | | -Composer | `composer` | v1, v2 | **✓** | | -Docker | `docker` | v1 | **✓** | | -Elixir | `mix` | v1 | | | -Elm | `elm` | v0.18, v0.19 | **✓** | | -git submodule | `gitsubmodule` | N/A (no version) | **✓** | | -GitHub Actions | `github-actions` | N/A (no version) | **✓** | | -Go modules | `gomod` | v1 | **✓** | **✓** | -Gradle | `gradle` | N/A (no version)[1] | **✓** | | -Maven | `maven` | N/A (no version)[2] | **✓** | | -npm | `npm` | v6, v7 | **✓** | | -NuGet | `nuget` | <= 4.8[3] | **✓** | | -pip | `pip` | v20 | | | -pipenv | `pip` | <= 2018.11.26 | | | -pip-compile | `pip` | 5.5.0 | | | -poetry | `pip` | v1 | | | -Terraform | `terraform` | <= 0.11 | **✓** | | -yarn | `npm` | v1 | **✓** | | +Package manager | YAML value | Supported versions | Private repositories | Private registries | Vendoring +---------------|------------------|------------------|:---:|:---:|:---: +Bundler | `bundler` | v1 | | **✓** | **✓** | +Cargo | `cargo` | v1 | **✓** | **✓** | | +Composer | `composer` | v1, v2 | **✓** | **✓** | | +Docker | `docker` | v1 | **✓** | **✓** | | +Hex | `mix` | v1 | | **✓** | | +elm-package | `elm` | v0.18, v0.19 | **✓** | **✓** | | +git submodule | `gitsubmodule` | N/A (no version) | **✓** | **✓** | | +GitHub Actions | `github-actions` | N/A (no version) | **✓** | **✓** | | +Go modules | `gomod` | v1 | **✓** | **✓** | **✓** | +Gradle | `gradle` | N/A (no version)[1] | **✓** | **✓** | | +Maven | `maven` | N/A (no version)[2] | **✓** | **✓** | | +npm | `npm` | v6, v7 | **✓** | **✓** | | +NuGet | `nuget` | <= 4.8[3] | **✓** | **✓** | | +pip | `pip` | v20 | | **✓** | | +pipenv | `pip` | <= 2018.11.26 | | **✓** | | +pip-compile | `pip` | 5.5.0 | | **✓** | | +poetry | `pip` | v1 | | **✓** | | +Terraform | `terraform` | <= 0.11 | **✓** | **✓** | | +yarn | `npm` | v1 | **✓** | **✓** | | [1] {% data variables.product.prodname_dependabot %} doesn't run Gradle but supports updates to the following files: `build.gradle` and `build.gradle.kts` (for Kotlin projects). diff --git a/data/reusables/desktop/click-changed-files-header.md b/data/reusables/desktop/click-changed-files-header.md new file mode 100644 index 0000000000..ddd2e675db --- /dev/null +++ b/data/reusables/desktop/click-changed-files-header.md @@ -0,0 +1,13 @@ +1. Right click the **changed files** header. + + {% mac %} + + ![The changed files header](/assets/images/help/desktop/mac-changed-file-header.png) + + {% endmac %} + + {% windows %} + + ![The changed files header](/assets/images/help/desktop/windows-changed-file-header.png) + + {% endwindows %} \ No newline at end of file diff --git a/data/reusables/desktop/click-discard.md b/data/reusables/desktop/click-discard.md new file mode 100644 index 0000000000..95b253fef3 --- /dev/null +++ b/data/reusables/desktop/click-discard.md @@ -0,0 +1,13 @@ +1. Click **Discard**. + + {% mac %} + + ![Discard stashed changes button](/assets/images/help/desktop/mac-discard-stashed-changes-button.png) + + {% endmac %} + + {% windows %} + + ![Discard stashed changes button](/assets/images/help/desktop/windows-discard-stashed-changes-button.png) + + {% endwindows %} diff --git a/data/reusables/desktop/click-restore.md b/data/reusables/desktop/click-restore.md new file mode 100644 index 0000000000..ce7cbdfc9c --- /dev/null +++ b/data/reusables/desktop/click-restore.md @@ -0,0 +1,13 @@ +1. Click **Restore**. + + {% mac %} + + ![Restore stashed changes button](/assets/images/help/desktop/mac-restore-stashed-changes-button.png) + + {% endmac %} + + {% windows %} + + ![Restore stashed changes button](/assets/images/help/desktop/windows-restore-stashed-changes-button.png) + + {% endwindows %} diff --git a/data/reusables/desktop/click-stash-all-changes.md b/data/reusables/desktop/click-stash-all-changes.md new file mode 100644 index 0000000000..deab24f201 --- /dev/null +++ b/data/reusables/desktop/click-stash-all-changes.md @@ -0,0 +1,13 @@ +1. Click **Stash All Changes**. + + {% mac %} + + ![The Stash All Changes menu item](/assets/images/help/desktop/mac-stash-all-changes.png) + + {% endmac %} + + {% windows %} + + ![The Stash all changes menu item](/assets/images/help/desktop/windows-stash-all-changes.png) + + {% endwindows %} \ No newline at end of file diff --git a/data/reusables/desktop/click-stashed-changes.md b/data/reusables/desktop/click-stashed-changes.md new file mode 100644 index 0000000000..b2c82378c4 --- /dev/null +++ b/data/reusables/desktop/click-stashed-changes.md @@ -0,0 +1,2 @@ +1. In the left sidebar, click **Stashed Changes**. + ![Stashed changes option](/assets/images/help/desktop/stashed-changes.png) \ No newline at end of file diff --git a/data/reusables/desktop/navigate-to-stashed-changes.md b/data/reusables/desktop/navigate-to-stashed-changes.md new file mode 100644 index 0000000000..9980422ed5 --- /dev/null +++ b/data/reusables/desktop/navigate-to-stashed-changes.md @@ -0,0 +1,2 @@ +1. If you are not already on the branch where the changes are stashed, click {% octicon "git-branch" aria-label="The branch icon" %} **Current Branch**, then click the branch with stashed changes. + ![List of branches in the repository](/assets/images/help/desktop/click-branch-in-drop-down-mac.png) \ No newline at end of file diff --git a/data/reusables/developer-site/pull_request_forked_repos_link.md b/data/reusables/developer-site/pull_request_forked_repos_link.md index 144420eb2f..54d745b497 100644 --- a/data/reusables/developer-site/pull_request_forked_repos_link.md +++ b/data/reusables/developer-site/pull_request_forked_repos_link.md @@ -11,3 +11,9 @@ When you create a pull request from a forked repository to the base repository, Workflows don't run on forked repositories by default. You must enable GitHub Actions in the **Actions** tab of the forked repository. {% data reusables.actions.forked-secrets %} The permissions for the `GITHUB_TOKEN` in forked repositories is read-only. For more information, see "[Authenticating with the GITHUB_TOKEN](/actions/configuring-and-managing-workflows/authenticating-with-the-github_token)." + +{% note %} + +**Note:** Workflows triggered by {% data variables.product.prodname_dependabot %} pull requests are treated as though they are from a forked repository, and are also subject to these restrictions. + +{% endnote %} diff --git a/data/reusables/enterprise-accounts/email-tab.md b/data/reusables/enterprise-accounts/email-tab.md new file mode 100644 index 0000000000..c00994a9ed --- /dev/null +++ b/data/reusables/enterprise-accounts/email-tab.md @@ -0,0 +1,2 @@ +1. Under {% octicon "gear" aria-label="The Settings gear" %} **Settings**, click **Email**. + ![Email tab in the enterprise account sidebar](/assets/images/enterprise/configuration/enterprise-account-email-tab.png) diff --git a/data/reusables/enterprise-accounts/verifying-domains-release-phase.md b/data/reusables/enterprise-accounts/verifying-domains-release-phase.md deleted file mode 100644 index 331fb63c15..0000000000 --- a/data/reusables/enterprise-accounts/verifying-domains-release-phase.md +++ /dev/null @@ -1,5 +0,0 @@ -{% note %} - -**Note:** Verifying an enterprise account's domain is currently in beta and subject to change. - -{% endnote %} \ No newline at end of file diff --git a/data/reusables/enterprise_installation/hardware-considerations-all-platforms.md b/data/reusables/enterprise_installation/hardware-considerations-all-platforms.md index ec895f314d..324d2da0b7 100644 --- a/data/reusables/enterprise_installation/hardware-considerations-all-platforms.md +++ b/data/reusables/enterprise_installation/hardware-considerations-all-platforms.md @@ -17,7 +17,7 @@ Your instance requires a persistent data disk separate from the root disk. For m {% if currentVersion ver_gt "enterprise-server@2.21" %} -To configure{% if currentVersion == "enterprise-server@2.22" %} the beta of{% endif %} {% data variables.product.prodname_actions %}, you must provide external blob storage. For more information, see "[Getting started with {% data variables.product.prodname_actions %} for {% data variables.product.prodname_ghe_server %}](/admin/github-actions/getting-started-with-github-actions-for-github-enterprise-server)." +To configure{% if currentVersion == "enterprise-server@2.22" %} the beta of{% endif %} {% data variables.product.prodname_actions %}, you must provide external blob storage. For more information, see "[Getting started with {% data variables.product.prodname_actions %} for {% data variables.product.prodname_ghe_server %}](/admin/github-actions/getting-started-with-github-actions-for-github-enterprise-server##external-storage-requirements)." {% endif %} @@ -25,7 +25,13 @@ You can resize your instance's root disk by building a new instance or using an #### CPU and memory -The CPU and memory resources that {% data variables.product.prodname_ghe_server %} requires depend on the levels of activity for users, automations, and integrations. {% if currentVersion ver_gt "enterprise-server@2.21" %}{% data reusables.actions.enterprise-hardware-considerations %}{% endif %} +The CPU and memory resources that {% data variables.product.prodname_ghe_server %} requires depend on the levels of activity for users, automations, and integrations. + +{% if currentVersion ver_gt "enterprise-server@2.21" %} + +If you {% if currentVersion == "enterprise-server@2.22" %}enabled the beta of{% else %}plan to enable{% endif %} {% data variables.product.prodname_actions %} for the users of your {% data variables.product.prodname_ghe_server %} instance, you may need to provision additional CPU and memory resources for your instance. For more information, see "[Getting started with {% data variables.product.prodname_actions %} for {% data variables.product.prodname_ghe_server %}](/admin/github-actions/getting-started-with-github-actions-for-github-enterprise-server#review-hardware-considerations)." + +{% endif %} {% data reusables.enterprise_installation.increasing-cpus-req %} @@ -35,4 +41,6 @@ The CPU and memory resources that {% data variables.product.prodname_ghe_server {% endwarning %} +For more information about monitoring the capacity and performance of {% data variables.product.prodname_ghe_server %}, see "[Monitoring your appliance](/admin/enterprise-management/monitoring-your-appliance)." + You can increase your instance's CPU or memory resources. For more information, see "[Increasing CPU or memory resources](/enterprise/admin/installation/increasing-cpu-or-memory-resources)." diff --git a/data/reusables/enterprise_installation/hardware-rec-table.md b/data/reusables/enterprise_installation/hardware-rec-table.md index ec31219568..7c8049ec2d 100644 --- a/data/reusables/enterprise_installation/hardware-rec-table.md +++ b/data/reusables/enterprise_installation/hardware-rec-table.md @@ -30,20 +30,22 @@ {% endif %} -{% data reusables.enterprise_installation.about-adjusting-resources %} - {% if currentVersion ver_gt "enterprise-server@2.22" %} -If you plan to configure {% data variables.product.prodname_actions %} for your instance, you should provision additional resources. You must also configure at least one self-hosted runner to execute workflows. For more information, see "[Getting started with {% data variables.product.prodname_actions %} for {% data variables.product.prodname_ghe_server %}](/admin/github-actions/getting-started-with-github-actions-for-github-enterprise-server)." +If you plan to enable {% data variables.product.prodname_actions %} for the users of your instance, review the requirements for hardware, external storage, and runners in "[Getting started with {% data variables.product.prodname_actions %} for {% data variables.product.prodname_ghe_server %}](/admin/github-actions/getting-started-with-github-actions-for-github-enterprise-server)." {% endif %} +{% data reusables.enterprise_installation.about-adjusting-resources %} + {% if currentVersion == "enterprise-server@2.22" %} #### Beta features in {% data variables.product.prodname_ghe_server %} 2.22 {% data variables.product.prodname_ghe_server %} 2.22 offered features in beta, such as {% data variables.product.prodname_actions %}, {% data variables.product.prodname_registry %}, and {% data variables.product.prodname_code_scanning %}. For more information, see the [{% data variables.product.prodname_ghe_server %} 2.22 release notes](/enterprise-server@2.22/admin/release-notes#2.22.0). -If you enabled beta features for {% data variables.product.prodname_ghe_server %} 2.22, your instance requires additional hardware resources. For more information, see "[Minimum requirements](#minimum-requirements)". +If you enabled beta features for {% data variables.product.prodname_ghe_server %} 2.22, your instance requires additional hardware resources. For more information about minimum requirements, see "[Minimum requirements](#minimum-requirements)." + +For more information about the hardware requirements for {% data variables.product.prodname_actions %}, see "[Getting started with {% data variables.product.prodname_actions %} for {% data variables.product.prodname_ghe_server %}](/admin/github-actions/getting-started-with-github-actions-for-github-enterprise-server#review-hardware-considerations)." {% endif %} diff --git a/data/reusables/files/choose-commit-email.md b/data/reusables/files/choose-commit-email.md index bd6dd63297..d92bbe1813 100644 --- a/data/reusables/files/choose-commit-email.md +++ b/data/reusables/files/choose-commit-email.md @@ -1,4 +1,4 @@ {% if currentVersion == "free-pro-team@latest" %} -1. Below the commit message fields, click the email address drop-down menu and choose a Git author email address. Only verified email addresses appear in this drop-down menu. If you enabled email address privacy, then `@users.noreply.github.com` is the default commit author email address. For more information, see "[Setting your commit email address](/articles/setting-your-commit-email-address)." +1. If you have more than one email address associated with your {% data variables.product.product_name %} account, click the email address drop-down menu and select the email address to use as the Git author email address. Only verified email addresses appear in this drop-down menu. If you enabled email address privacy, then `@users.noreply.github.com` is the default commit author email address. For more information, see "[Setting your commit email address](/articles/setting-your-commit-email-address)." ![Choose commit email addresses](/assets/images/help/repository/choose-commit-email-address.png) {% endif %} diff --git a/data/reusables/gated-features/actions-shared.md b/data/reusables/gated-features/actions-shared.md index 57b1ab7a7d..d5bceb9ab1 100644 --- a/data/reusables/gated-features/actions-shared.md +++ b/data/reusables/gated-features/actions-shared.md @@ -1 +1 @@ -{% data variables.product.prodname_actions %} is available with {% data variables.product.prodname_free_user %}, {% data variables.product.prodname_pro %}, {% data variables.product.prodname_free_team %} for organizations, {% data variables.product.prodname_team %}, {% data variables.product.prodname_ghe_cloud %}, {% data variables.product.prodname_ghe_server %}, and {% data variables.product.prodname_ghe_one %}. {% data variables.product.prodname_actions %} is not available for private repositories owned by accounts using legacy per-repository plans. +{% data variables.product.prodname_actions %} is available with {% data variables.product.prodname_free_user %}, {% data variables.product.prodname_pro %}, {% data variables.product.prodname_free_team %} for organizations, {% data variables.product.prodname_team %}, {% data variables.product.prodname_ghe_cloud %}, {% data variables.product.prodname_ghe_server %}, {% data variables.product.prodname_ghe_one %}, and {% data variables.product.prodname_ghe_managed %}. {% data variables.product.prodname_actions %} is not available for private repositories owned by accounts using legacy per-repository plans. diff --git a/data/reusables/gated-features/allowed-ip-addresses.md b/data/reusables/gated-features/allowed-ip-addresses.md index 501edab172..b96ddd2ecf 100644 --- a/data/reusables/gated-features/allowed-ip-addresses.md +++ b/data/reusables/gated-features/allowed-ip-addresses.md @@ -1 +1 @@ -Allowed IP addresses are available with {% data variables.product.prodname_ghe_cloud %}. For more information, see "[{% data variables.product.prodname_dotcom %}'s products](/articles/github-s-products)." +Allowed IP addresses are available with {% data variables.product.prodname_ghe_cloud %} and {% data variables.product.prodname_ghe_managed %}. For more information, see "[{% data variables.product.prodname_dotcom %}'s products](/articles/github-s-products)." diff --git a/data/reusables/gated-features/auto-merge.md b/data/reusables/gated-features/auto-merge.md index acfb4dddff..4f05ac43bd 100644 --- a/data/reusables/gated-features/auto-merge.md +++ b/data/reusables/gated-features/auto-merge.md @@ -1 +1 @@ -Auto-merge for pull requests is available in public repositories with {% data variables.product.prodname_free_user %} and {% data variables.product.prodname_free_team %} for organizations, and in public and private repositories with {% data variables.product.prodname_pro %}, {% data variables.product.prodname_team %}, {% data variables.product.prodname_ghe_cloud %}, and {% data variables.product.prodname_ghe_server %}. {% if currentVersion == "free-pro-team@latest" %}{% data reusables.gated-features.more-info %}{% endif %} +{% if currentVersion == "github-ae@latest" %}Auto-merge for pull requests is available in internal and private repositories with {% data variables.product.prodname_ghe_managed %}, {% else %}Auto-merge for pull requests is available {% endif %} in public repositories with {% data variables.product.prodname_free_user %} and {% data variables.product.prodname_free_team %} for organizations, and in public and private repositories with {% data variables.product.prodname_pro %}, {% data variables.product.prodname_team %}, {% data variables.product.prodname_ghe_cloud %}, and {% data variables.product.prodname_ghe_server %}. {% if currentVersion == "free-pro-team@latest" %}{% data reusables.gated-features.more-info %}{% endif %} diff --git a/data/reusables/gated-features/code-scanning.md b/data/reusables/gated-features/code-scanning.md index 35598cce54..775fa28256 100644 --- a/data/reusables/gated-features/code-scanning.md +++ b/data/reusables/gated-features/code-scanning.md @@ -1,4 +1,6 @@ {% if currentVersion == "free-pro-team@latest" %}{% data variables.product.prodname_code_scanning_capc %} is available for all public repositories and for private repositories owned by organizations where {% data variables.product.prodname_GH_advanced_security %} is enabled. {%- elsif currentVersion ver_gt "enterprise-server@3.0" %}{% data variables.product.prodname_code_scanning_capc %} is available if {% data variables.product.prodname_GH_advanced_security %} is enabled for the repository. +{%- elsif currentVersion == "github-ae@latest" %} +{% data variables.product.prodname_code_scanning_capc %} is available as part of {% data variables.product.prodname_GH_advanced_security %}, which is free during the beta release. {%- else %} {% data variables.product.prodname_code_scanning_capc %} is available if you have a license for {% data variables.product.prodname_GH_advanced_security %}.{% endif %} {% data reusables.advanced-security.more-info-ghas %} diff --git a/data/reusables/gated-features/discussions.md b/data/reusables/gated-features/discussions.md index 5ada0a25ee..860427abe2 100644 --- a/data/reusables/gated-features/discussions.md +++ b/data/reusables/gated-features/discussions.md @@ -1 +1 @@ -{% data variables.product.prodname_discussions %} is available in beta for public repositories on {% data variables.product.prodname_dotcom_the_website %}. {% data reusables.gated-features.more-info-org-products %} +{% data variables.product.prodname_discussions %} is available in beta for public and private repositories on {% data variables.product.prodname_dotcom_the_website %}. {% data reusables.gated-features.more-info-org-products %} diff --git a/data/reusables/gated-features/ghas.md b/data/reusables/gated-features/ghas.md new file mode 100644 index 0000000000..fcf1b455c7 --- /dev/null +++ b/data/reusables/gated-features/ghas.md @@ -0,0 +1 @@ +{% data variables.product.prodname_GH_advanced_security %} licenses are available for enterprise accounts on {% data variables.product.prodname_ghe_cloud %}{% if currentVersion == "github-ae@latest" %}, {% data variables.product.prodname_ghe_managed %},{% endif %} and {% data variables.product.prodname_ghe_server %}. {% data variables.product.prodname_GH_advanced_security %} is also included in {% data variables.product.prodname_ghe_one %}{% if currentVersion == "free-pro-team@latest" %} and in all public repositories on {% data variables.product.prodname_dotcom_the_website %}{% endif %}. For more information, see "[About GitHub's products](/github/getting-started-with-github/githubs-products)." \ No newline at end of file diff --git a/data/reusables/gated-features/okta-team-sync.md b/data/reusables/gated-features/okta-team-sync.md index 6c7ea925c5..632b0a2d3a 100644 --- a/data/reusables/gated-features/okta-team-sync.md +++ b/data/reusables/gated-features/okta-team-sync.md @@ -1,5 +1,9 @@ +{% if currentVersion != "github-ae@latest" %} + {% note %} -**Note:** Team synchronization with Okta is currently in beta and subject to change. +**Note:** Team synchronization with Okta is currently in beta and subject to change. Please contact your GitHub Sales account representative to register for the beta. {% endnote %} + +{% endif %} diff --git a/data/reusables/gated-features/packages.md b/data/reusables/gated-features/packages.md index 7abac09055..e0cfb66045 100644 --- a/data/reusables/gated-features/packages.md +++ b/data/reusables/gated-features/packages.md @@ -1,4 +1,4 @@ -{% data variables.product.prodname_registry %} is available with {% data variables.product.prodname_free_user %}, {% data variables.product.prodname_pro %}, {% data variables.product.prodname_free_team %} for organizations, {% data variables.product.prodname_team %}, {% data variables.product.prodname_ghe_cloud %}, {% data variables.product.prodname_ghe_server %} 2.22, and {% data variables.product.prodname_ghe_one %}. +{% data variables.product.prodname_registry %} is available with {% data variables.product.prodname_free_user %}, {% data variables.product.prodname_pro %}, {% data variables.product.prodname_free_team %} for organizations, {% data variables.product.prodname_team %}, {% data variables.product.prodname_ghe_cloud %}, {% data variables.product.prodname_ghe_server %} 2.22, {% data variables.product.prodname_ghe_one %}, and {% data variables.product.prodname_ghe_managed %}. {% if currentVersion == "free-pro-team@latest" %}
{% data variables.product.prodname_registry %} is not available for private repositories owned by accounts using legacy per-repository plans. Also, accounts using legacy per-repository plans cannot access {% data variables.product.prodname_github_container_registry %} since these accounts are billed by repository. {% data reusables.gated-features.more-info %} {% endif %} diff --git a/data/reusables/gated-features/secret-scanning.md b/data/reusables/gated-features/secret-scanning.md index 7396ad8e24..f67bcdf4e4 100644 --- a/data/reusables/gated-features/secret-scanning.md +++ b/data/reusables/gated-features/secret-scanning.md @@ -1 +1,7 @@ +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} {% data variables.product.prodname_secret_scanning_caps %} is available {% if currentVersion == "free-pro-team@latest" %}in public repositories, and in private repositories owned by organizations with {% else %}if you have {% endif %}an {% data variables.product.prodname_advanced_security %} license. {% data reusables.advanced-security.more-info-ghas %} +{% endif %} + +{% if currentVersion == "github-ae@latest" %} +{% data variables.product.prodname_secret_scanning_caps %} is available as part of {% data variables.product.prodname_GH_advanced_security %}, which is free during the beta release. +{% endif %} \ No newline at end of file diff --git a/data/reusables/gated-features/team-synchronization.md b/data/reusables/gated-features/team-synchronization.md index 896fbab1d6..0851c08049 100644 --- a/data/reusables/gated-features/team-synchronization.md +++ b/data/reusables/gated-features/team-synchronization.md @@ -1 +1 @@ -Team synchronization is available for organizations and enterprise accounts using {% data variables.product.prodname_ghe_cloud %}. {% data reusables.gated-features.more-info-org-products %} +{% if currentVersion == "free-pro-team@latest" %}Team synchronization is available for organizations and enterprise accounts using {% data variables.product.prodname_ghe_cloud %}. {% data reusables.gated-features.more-info-org-products %}{% elsif currentVersion == "github-ae@latest" %}Synchronization of teams with SCIM groups is available for organizations using {% data variables.product.prodname_ghe_managed %}. For more information, see "[GitHub's products](/github/getting-started-with-github/githubs-products)."{% endif %} diff --git a/data/reusables/github-actions/artifact-log-retention-statement.md b/data/reusables/github-actions/artifact-log-retention-statement.md index 00249ec8d5..badcea5006 100644 --- a/data/reusables/github-actions/artifact-log-retention-statement.md +++ b/data/reusables/github-actions/artifact-log-retention-statement.md @@ -1,2 +1,2 @@ -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} By default, {% data variables.product.product_name %} stores build logs and artifacts for 90 days, and this retention period can be customized. For more information, see "[Usage limits, billing, and administration](/actions/reference/usage-limits-billing-and-administration#artifact-and-log-retention-policy)".{% endif %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} By default, {% data variables.product.product_name %} stores build logs and artifacts for 90 days, and this retention period can be customized. For more information, see "[Usage limits, billing, and administration](/actions/reference/usage-limits-billing-and-administration#artifact-and-log-retention-policy)".{% endif %} {% if currentVersion == "enterprise-server@2.22" %} {% data variables.product.product_name %} stores full build logs and artifacts for 90 days.{% endif %} diff --git a/data/reusables/github-actions/disabling-github-actions.md b/data/reusables/github-actions/disabling-github-actions.md index 56bbb36bee..0481ab8bab 100644 --- a/data/reusables/github-actions/disabling-github-actions.md +++ b/data/reusables/github-actions/disabling-github-actions.md @@ -1 +1 @@ -By default, {% if currentVersion ver_gt "enterprise-server@2.21" %}after {% data variables.product.prodname_actions %} is enabled on {% data variables.product.product_location %}, it{% elsif currentVersion == "free-pro-team@latest" %}{% data variables.product.prodname_actions %}{% endif %} is enabled on all repositories and organizations. You can choose to disable {% data variables.product.prodname_actions %} or limit them to private actions only, which means that people can only use actions that exist in your repository. +By default, {% if currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %}after {% data variables.product.prodname_actions %} is enabled on {% data variables.product.product_location %}, it{% elsif currentVersion == "free-pro-team@latest" %}{% data variables.product.prodname_actions %}{% endif %} is enabled on all repositories and organizations. You can choose to disable {% data variables.product.prodname_actions %} or limit them to private actions only, which means that people can only use actions that exist in your repository. diff --git a/data/reusables/github-actions/expression-syntax-if.md b/data/reusables/github-actions/expression-syntax-if.md index 69549fd112..70a79eb94f 100644 --- a/data/reusables/github-actions/expression-syntax-if.md +++ b/data/reusables/github-actions/expression-syntax-if.md @@ -1 +1 @@ -When you use expressions in an `if` conditional, you may omit the expression syntax ({% raw %}`${{ }}`{% endraw %}) because {% data variables.product.prodname_dotcom %} automatically evaluates the `if` conditional as an expression. +When you use expressions in an `if` conditional, you may omit the expression syntax ({% raw %}`${{ }}`{% endraw %}) because {% data variables.product.prodname_dotcom %} automatically evaluates the `if` conditional as an expression, unless the expression contains any operators. If the expression contains any operators, the expression must be contained within {% raw %}`${{ }}`{% endraw %} to explicitly mark it for evaluation. diff --git a/data/reusables/github-actions/hosted-runner-configure-runner-group-access.md b/data/reusables/github-actions/hosted-runner-configure-runner-group-access.md new file mode 100644 index 0000000000..1546336d05 --- /dev/null +++ b/data/reusables/github-actions/hosted-runner-configure-runner-group-access.md @@ -0,0 +1,2 @@ +1. In the runner section of the settings page, click {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %} next to the runner group you'd like to configure, then click **Edit name and [organization|repository] access**. +1. Modify your policy options, or change the runner group name. diff --git a/data/reusables/github-actions/hosted-runner-labels-view-assigned-labels.md b/data/reusables/github-actions/hosted-runner-labels-view-assigned-labels.md new file mode 100644 index 0000000000..a070ec7fb9 --- /dev/null +++ b/data/reusables/github-actions/hosted-runner-labels-view-assigned-labels.md @@ -0,0 +1,3 @@ +1. Locate the runner you want to update, and click {% octicon "triangle-down" aria-label="The downward triangle" %} to view the label selection menu. This menu displays all the custom labels available to your runner. Labels already assigned to your runner have a {% octicon "check" aria-label="Check mark" %} next to them. + + ![Change runner label](/assets/images/help/settings/actions-hosted-runner-list-label.png) diff --git a/data/reusables/github-actions/hosted-runner-list-group.md b/data/reusables/github-actions/hosted-runner-list-group.md new file mode 100644 index 0000000000..932c3059f2 --- /dev/null +++ b/data/reusables/github-actions/hosted-runner-list-group.md @@ -0,0 +1,3 @@ +1. If your runner is in a group, locate the runner group and click {% octicon "chevron-down" aria-label="The downward chevron" %} to view the list of runners. + + ![List runner group](/assets/images/help/settings/actions-hosted-runner-group-members.png) diff --git a/data/reusables/github-actions/hosted-runner-list.md b/data/reusables/github-actions/hosted-runner-list.md new file mode 100644 index 0000000000..9b5de7045f --- /dev/null +++ b/data/reusables/github-actions/hosted-runner-list.md @@ -0,0 +1 @@ +1. Click the "Self-hosted runners" tab, and locate the list of runners. diff --git a/data/reusables/github-actions/hosted-runner-navigate-to-repo-org-enterprise.md b/data/reusables/github-actions/hosted-runner-navigate-to-repo-org-enterprise.md new file mode 100644 index 0000000000..ae17dc7e2e --- /dev/null +++ b/data/reusables/github-actions/hosted-runner-navigate-to-repo-org-enterprise.md @@ -0,0 +1,15 @@ +1. Navigate to where your {% data variables.actions.hosted_runner %} is registered: + * **In an organization or repository**: navigate to the main page and click {% octicon "gear" aria-label="The Settings gear" %} **Settings**. + * **If using an enterprise-level runner**: + + 1. In the upper-right corner of any page, click {% octicon "rocket" aria-label="The rocket ship" %}. + 1. In the left sidebar, click **Enterprise overview**. + 1. In the enterprise sidebar, click {% octicon "law" aria-label="The law icon" %} **Policies**. +1. Navigate to the {% data variables.product.prodname_actions %} settings: + * **In an organization or repository**: Click **Actions** in the left sidebar. + + ![Actions setting](/assets/images/help/settings/settings-sidebar-actions.png) + * **If using an enterprise-level runner**: Under "{% octicon "law" aria-label="The law icon" %} Policies", click **Actions**. + + ![Actions setting](/assets/images/help/settings/actions-enterprise-policies.png) + diff --git a/data/reusables/github-actions/ip-allow-list-hosted-runners.md b/data/reusables/github-actions/ip-allow-list-hosted-runners.md new file mode 100644 index 0000000000..caa664045e --- /dev/null +++ b/data/reusables/github-actions/ip-allow-list-hosted-runners.md @@ -0,0 +1,3 @@ +To allow your {% data variables.actions.hosted_runner %}s to communicate with {% data variables.product.prodname_dotcom %}, add the IP address or IP address range of your {% data variables.actions.hosted_runner %}s to the IP allow list. For more information, see "[Adding an allowed IP address](#adding-an-allowed-ip-address)." + +For more information about {% data variables.actions.hosted_runner %}s, see "[About {% data variables.actions.hosted_runner %}s](/github-ae@latest/actions/using-github-hosted-runners/about-ae-hosted-runners)." diff --git a/data/reusables/github-actions/ip-allow-list-self-hosted-runners.md b/data/reusables/github-actions/ip-allow-list-self-hosted-runners.md index 95bc1896b9..f24c38c911 100644 --- a/data/reusables/github-actions/ip-allow-list-self-hosted-runners.md +++ b/data/reusables/github-actions/ip-allow-list-self-hosted-runners.md @@ -1,3 +1,6 @@ +{% if currentVersion == "github-ae@latest" %} +To allow your {% data variables.actions.hosted_runner %}s to communicate with {% data variables.product.prodname_dotcom %}, add the IP address or IP address range of your {% data variables.actions.hosted_runner %}s to the IP allow list. For more information, see "[Adding an allowed IP address](#adding-an-allowed-ip-address)." +{% else %} {% warning %} **Warning**: If you use an IP allow list and would also like to use {% data variables.product.prodname_actions %}, you must use self-hosted runners. For more information, see "[Hosting your own runners](/actions/automating-your-workflow-with-github-actions/about-self-hosted-runners)." @@ -5,3 +8,4 @@ {% endwarning %} To allow your self-hosted runners to communicate with {% data variables.product.prodname_dotcom %}, add the IP address or IP address range of your self-hosted runners to the IP allow list. For more information, see "[Adding an allowed IP address](#adding-an-allowed-ip-address)." +{% endif %} diff --git a/data/reusables/github-actions/runner-workflow-continuity.md b/data/reusables/github-actions/runner-workflow-continuity.md new file mode 100644 index 0000000000..16288f57b1 --- /dev/null +++ b/data/reusables/github-actions/runner-workflow-continuity.md @@ -0,0 +1 @@ +If {% data variables.product.prodname_actions %} services are temporarily unavailable, then a workflow run is discarded if it has not been queued within 30 minutes of being triggered. For example, if a workflow is triggered and the {% data variables.product.prodname_actions %} services are unavailable for 31 minutes or longer, then the workflow run will not be processed. diff --git a/data/reusables/github-actions/self-hosted-runner-management-permissions-required.md b/data/reusables/github-actions/self-hosted-runner-management-permissions-required.md index 9ddc7c7b5c..bb97717160 100644 --- a/data/reusables/github-actions/self-hosted-runner-management-permissions-required.md +++ b/data/reusables/github-actions/self-hosted-runner-management-permissions-required.md @@ -1,9 +1,9 @@ -A self-hosted runner can be located in either your repository, organization, or {% if currentVersion == "free-pro-team@latest" %}enterprise account settings on {% data variables.product.prodname_dotcom %}{% elsif enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.21" %} enterprise settings on {% data variables.product.product_location %}{% endif %}. To manage a self-hosted runner, you must have the following permissions, depending on where the self-hosted runner was added: +A self-hosted runner can be located in either your repository, organization, or {% if currentVersion == "free-pro-team@latest" %}enterprise account settings on {% data variables.product.prodname_dotcom %}{% elsif enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %} enterprise settings on {% data variables.product.product_location %}{% endif %}. To manage a self-hosted runner, you must have the following permissions, depending on where the self-hosted runner was added: - **User repository**: You must be the repository owner. - **Organization**: You must be an organization owner. - **Organization repository**: You must be an organization owner, or have admin access to the repository. {% if currentVersion == "free-pro-team@latest" %} - **Enterprise account**: You must be an enterprise owner. -{% elsif enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.21" %} +{% elsif enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %} - **Enterprise**: You must be a {% data variables.product.prodname_enterprise %} site administrator. {% endif %} diff --git a/data/reusables/github-actions/self-hosted-runner-navigate-to-repo-org-enterprise.md b/data/reusables/github-actions/self-hosted-runner-navigate-to-repo-org-enterprise.md index 12756c93a0..313c117a3e 100644 --- a/data/reusables/github-actions/self-hosted-runner-navigate-to-repo-org-enterprise.md +++ b/data/reusables/github-actions/self-hosted-runner-navigate-to-repo-org-enterprise.md @@ -1,6 +1,6 @@ 1. Navigate to where your self-hosted runner is registered: * **In an organization or repository**: navigate to the main page and click {% octicon "gear" aria-label="The Settings gear" %} **Settings**. - * {% if currentVersion == "free-pro-team@latest" %}**If using an enterprise account**: navigate to your enterprise account by visiting `https://github.com/enterprises/ENTERPRISE-NAME`, replacing `ENTERPRISE-NAME` with your enterprise account's name.{% elsif enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.21" %}**If using an enterprise-level runner**: + * {% if currentVersion == "free-pro-team@latest" %}**If using an enterprise account**: navigate to your enterprise account by visiting `https://github.com/enterprises/ENTERPRISE-NAME`, replacing `ENTERPRISE-NAME` with your enterprise account's name.{% elsif enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %}**If using an enterprise-level runner**: 1. In the upper-right corner of any page, click {% octicon "rocket" aria-label="The rocket ship" %}. 1. In the left sidebar, click **Enterprise overview**. @@ -9,4 +9,4 @@ * **In an organization or repository**: click **Actions** in the left sidebar. ![Actions setting](/assets/images/help/settings/settings-sidebar-actions.png) - * {% if currentVersion == "free-pro-team@latest" %}**If using an enterprise account**{% elsif enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.21" %}**If using an enterprise-level runner**{% endif %}: click **Actions** under "{% octicon "law" aria-label="The law icon" %} Policies". + * {% if currentVersion == "free-pro-team@latest" %}**If using an enterprise account**{% elsif enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %}**If using an enterprise-level runner**{% endif %}: click **Actions** under "{% octicon "law" aria-label="The law icon" %} Policies". diff --git a/data/reusables/github-actions/self-hosted-runner-security.md b/data/reusables/github-actions/self-hosted-runner-security.md index 446a9ca1db..0d4c1556b1 100644 --- a/data/reusables/github-actions/self-hosted-runner-security.md +++ b/data/reusables/github-actions/self-hosted-runner-security.md @@ -1,3 +1 @@ -We recommend that you do not use self-hosted runners with public repositories. - -Forks of your public repository can potentially run dangerous code on your self-hosted runner machine by creating a pull request that executes the code in a workflow. +We recommend that you only use self-hosted runners with private repositories. This is because forks of your repository can potentially run dangerous code on your self-hosted runner machine by creating a pull request that executes the code in a workflow. diff --git a/data/reusables/github-actions/supported-github-runners.md b/data/reusables/github-actions/supported-github-runners.md index 3af3da15cb..514e6e3e37 100644 --- a/data/reusables/github-actions/supported-github-runners.md +++ b/data/reusables/github-actions/supported-github-runners.md @@ -1,8 +1,8 @@ | Virtual environment | YAML workflow label | | --------------------|---------------------| | Windows Server 2019 | `windows-latest` or `windows-2019` | -| Ubuntu 20.04 | `ubuntu-latest` (see note) or `ubuntu-20.04` | -| Ubuntu 18.04 | `ubuntu-latest` (see note) or `ubuntu-18.04` | +| Ubuntu 20.04 | `ubuntu-latest` or `ubuntu-20.04` | +| Ubuntu 18.04 | `ubuntu-18.04` | | Ubuntu 16.04 | `ubuntu-16.04` | | macOS Big Sur 11.0 | `macos-11.0` | | macOS Catalina 10.15 | `macos-latest` or `macos-10.15` | diff --git a/data/reusables/github-actions/ubuntu-runner-preview.md b/data/reusables/github-actions/ubuntu-runner-preview.md deleted file mode 100644 index 6eb91edc13..0000000000 --- a/data/reusables/github-actions/ubuntu-runner-preview.md +++ /dev/null @@ -1,5 +0,0 @@ -{% note %} - -**Note:** The `ubuntu-latest` label is currently being migrated from the Ubuntu 18.04 virtual environment to Ubuntu 20.04. Specifying the `ubuntu-latest` label during the migration might use either virtual environment. To explicitly use Ubuntu 20.04 or Ubuntu 18.04, specify `ubuntu-20.04` or `ubuntu-18.04`. When the migration is complete, `ubuntu-latest` will use the Ubuntu 20.04 virtual environment. For more information about the migration, see "[Ubuntu-latest workflows will use Ubuntu-20.04](https://github.com/actions/virtual-environments/issues/1816)." - -{% endnote %} diff --git a/data/reusables/github-ae/github-ae-enables-you.md b/data/reusables/github-ae/github-ae-enables-you.md index dd699d9ad6..b7adad1f46 100644 --- a/data/reusables/github-ae/github-ae-enables-you.md +++ b/data/reusables/github-ae/github-ae-enables-you.md @@ -1 +1 @@ -{% data variables.product.prodname_ghe_managed %} enables you to move your software development to the cloud while meeting the most stringent security and compliance requirements. +{% data variables.product.prodname_ghe_managed %} enables you to move your DevOps workload to the cloud while meeting stringent security and compliance requirements. diff --git a/data/reusables/mobile/push-notifications-on-ghes.md b/data/reusables/mobile/push-notifications-on-ghes.md index 94535c20d3..954c32fc7b 100644 --- a/data/reusables/mobile/push-notifications-on-ghes.md +++ b/data/reusables/mobile/push-notifications-on-ghes.md @@ -1 +1 @@ -For {% data variables.product.prodname_ghe_server %}, push notifications for direct mentions are currently supported on iOS and coming soon to Android. {% data variables.product.prodname_ghe_server %} uses background fetch to support push notifications without sending your information to a third-party service, so you may experience a delay in receiving push notifications. \ No newline at end of file +{% data variables.product.prodname_ghe_server %} uses background fetch to support push notifications without sending your information to a third-party service, so you may experience a delay in receiving push notifications. \ No newline at end of file diff --git a/data/reusables/notifications/vulnerable-dependency-notification-options.md b/data/reusables/notifications/vulnerable-dependency-notification-options.md index 6fd66803d4..c85f038f8a 100644 --- a/data/reusables/notifications/vulnerable-dependency-notification-options.md +++ b/data/reusables/notifications/vulnerable-dependency-notification-options.md @@ -1,14 +1,26 @@ -{% if currentVersion == "free-pro-team@latest" %} -By default, you will receive notification of new {% data variables.product.prodname_dependabot_alerts %}: -- by email, an email is sent every time a vulnerability with a critical or high severity is found (**Email each time a vulnerability is found** option) -- in the user interface, a warning is shown in your repository's file and code views if there are any vulnerable dependencies (**UI alerts** option) -- on the command line, warnings are displayed as callbacks when you push to repositories with any vulnerable dependencies (**Command Line** option) -- in your inbox, as web notifications for new vulnerabilities with a critical or high severity (**Web** option) +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" %} +{% if currentVersion == "free-pro-team@latest"%}By default, you will receive notifications:{% endif %}{% if enterpriseServerVersions contains currentVersion and currentVersion gt "enterprise-server@3.1" %}By default, if your site administrator has configured email for notifications on your instance, you will receive {% data variables.product.prodname_dependabot_alerts %}:{% endif %} + +- by email, an email is sent when {% data variables.product.prodname_dependabot %} is enabled for a repository, when a new manifest file is committed to the repository, and when a new vulnerability with a critical or high severity is found (**Email each time a vulnerability is found** option). +- in the user interface, a warning is shown in your repository's file and code views if there are any vulnerable dependencies (**UI alerts** option). +- on the command line, warnings are displayed as callbacks when you push to repositories with any vulnerable dependencies (**Command Line** option). +- in your inbox, as web notifications. A web notification is sent when {% data variables.product.prodname_dependabot %} is enabled for a repository, when a new manifest file is committed to the repository, and when a new vulnerability with a critical or high severity is found (**Web** option). +- on {% data variables.product.prodname_mobile %}, as web notifications. For more information, see "[Enabling push notifications with GitHub for mobile](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#enabling-push-notifications-with-github-for-mobile)." + +{% note %} + +**Note:** The email and web/{% data variables.product.prodname_mobile %} notifications are: + +- _per repository_ when {% data variables.product.prodname_dependabot %} is enabled on the repository, or when a new manifest file is committed to the repository. + +- _per organization_ when a new vulnerability is discovered. + +{% endnote %} You can customize the way you are notified about {% data variables.product.prodname_dependabot_alerts %}. For example, you can receive a weekly digest email summarizing alerts for up to 10 of your repositories using the **Email a digest summary of vulnerabilities** and **Weekly security email digest** options. {% endif %} -{% if enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.21" %} +{% if currentVersion == "enterprise-server@2.22" or currentVersion == "enterprise-server@3.0" or currentVersion == "enterprise-server@3.1" %} By default, if your site administrator has configured email for notifications on your instance, you will receive {% data variables.product.prodname_dependabot_alerts %}: - by email, an email is sent every time a vulnerability {% if currentVersion ver_gt "enterprise-server@2.23" %}with a critical or high severity {% endif %}is found (**Email each time a vulnerability is found** option) - in the user interface, a warning is shown in your repository's file and code views if there are any vulnerable dependencies (**UI alerts** option) diff --git a/data/reusables/organizations/billing_planning.md b/data/reusables/organizations/billing_planning.md new file mode 100644 index 0000000000..bc12e659ae --- /dev/null +++ b/data/reusables/organizations/billing_planning.md @@ -0,0 +1,2 @@ +1. In your organization's Settings sidebar, click **Billing & planning**. +![Billing settings](/assets/images/help/billing/settings_organization_billing_planning_tab.png) diff --git a/data/reusables/organizations/invite_to_org.md b/data/reusables/organizations/invite_to_org.md index e20170e43d..dd528442c2 100644 --- a/data/reusables/organizations/invite_to_org.md +++ b/data/reusables/organizations/invite_to_org.md @@ -1,4 +1,4 @@ {% if currentVersion == "free-pro-team@latest" %}1. Type the username, full name, or email address of the person you want to invite and click **Invite**. ![Invite member form](/assets/images/help/organizations/org-invite-modal.png){% else %} 1. Type the username, full name, or email address of the person you want to add and click **Invite**. - ![Invite member form](/assets/images/help/organizations/org-invite-modal-ghe.png){% endif %} + ![Invite member form](/assets/images/help/organizations/org-invite-modal.png){% endif %} diff --git a/data/reusables/organizations/security.md b/data/reusables/organizations/security.md index e8bb0ed5d7..a29659283c 100644 --- a/data/reusables/organizations/security.md +++ b/data/reusables/organizations/security.md @@ -1,7 +1,6 @@ {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %} 1. In the left sidebar, click **Organization security**. - ![Organization security settings](/assets/images/help/organizations/org-security-settings-tab.png) {% else %} 1. In the left sidebar, click **Security**. - ![Organization security settings](/assets/images/help/organizations/org-settings-security-tab.png) {% endif %} + ![Organization security settings](/assets/images/help/organizations/org-security-settings-tab.png) \ No newline at end of file diff --git a/data/reusables/organizations/team-discussions-are-for-orgs.md b/data/reusables/organizations/team-discussions-are-for-orgs.md index e2d9192787..cb0f53f8ed 100644 --- a/data/reusables/organizations/team-discussions-are-for-orgs.md +++ b/data/reusables/organizations/team-discussions-are-for-orgs.md @@ -1 +1 @@ -Team discussions are only available on team pages in organizations. For more information, see "[About team discussions](/articles/about-team-discussions)." +Team discussions are only available on team pages in organizations. For more information, see "[About team discussions](/github/setting-up-and-managing-organizations-and-teams/about-team-discussions)." diff --git a/data/reusables/organizations/team-synchronization.md b/data/reusables/organizations/team-synchronization.md index 121340e06b..a609ef11b9 100644 --- a/data/reusables/organizations/team-synchronization.md +++ b/data/reusables/organizations/team-synchronization.md @@ -1,3 +1,3 @@ -{% if currentVersion == "free-pro-team@latest" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" %} You can use team synchronization to automatically add and remove organization members to teams through an identity provider. For more information, see "[Synchronizing a team with an identity provider group](/github/setting-up-and-managing-organizations-and-teams/synchronizing-a-team-with-an-identity-provider-group)." {% endif %} diff --git a/data/reusables/package_registry/apache-maven-snapshot-versions-supported.md b/data/reusables/package_registry/apache-maven-snapshot-versions-supported.md index b26c0fb5d6..8728373612 100644 --- a/data/reusables/package_registry/apache-maven-snapshot-versions-supported.md +++ b/data/reusables/package_registry/apache-maven-snapshot-versions-supported.md @@ -1 +1 @@ -{% data variables.product.prodname_registry %} supports `SNAPSHOT` versions of Apache Maven. To use a repository for downloading this type of artifact, you must enable SNAPSHOTS in your *~/.m2/settings.xml* file. +{% data variables.product.prodname_registry %} supports `SNAPSHOT` versions of Apache Maven. To use the {% data variables.product.prodname_registry %} repository for downloading `SNAPSHOT` artifacts, enable SNAPSHOTS in the POM of the consuming project or your *~/.m2/settings.xml* file. diff --git a/data/reusables/package_registry/docker_registry_deprecation_status.md b/data/reusables/package_registry/docker_registry_deprecation_status.md index a23fdc598b..73a07a040b 100644 --- a/data/reusables/package_registry/docker_registry_deprecation_status.md +++ b/data/reusables/package_registry/docker_registry_deprecation_status.md @@ -1,5 +1,5 @@ {% warning %} -**Note:** The {% data variables.product.prodname_registry %} Docker registry will be superseded by {% data variables.product.prodname_github_container_registry %}{% if enterpriseServerVersions contains currentVersion %} in a future {% data variables.product.product_name %} release{% endif %}.{% if currentVersion == "free-pro-team@latest" %} To learn how to migrate your existing Docker images and any workflows using them, see "[Migrating to {% data variables.product.prodname_github_container_registry %} for Docker images](/packages/guides/migrating-to-github-container-registry-for-docker-images)" and "[Container guides for {% data variables.product.prodname_registry %}](/packages/guides/container-guides-for-github-packages)."{% endif %} +**Note:** The {% data variables.product.prodname_registry %} Docker registry {% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %} will offer improved container support in a future {% data variables.product.product_name %} release.{% elsif currentVersion == "free-pro-team@latest" %} now offers improved container support. For more information, see "[About GitHub Container Registry](/packages/guides/about-github-container-registry)." To learn how to migrate your existing Docker images and any workflows using them, see "[Migrating to {% data variables.product.prodname_github_container_registry %} for Docker images](/packages/guides/migrating-to-github-container-registry-for-docker-images)" and "[Container guides for {% data variables.product.prodname_registry %}](/packages/guides/container-guides-for-github-packages)."{% endif %} {% endwarning %} diff --git a/data/reusables/package_registry/packages-ghae-release-stage.md b/data/reusables/package_registry/packages-ghae-release-stage.md new file mode 100644 index 0000000000..1fa479c335 --- /dev/null +++ b/data/reusables/package_registry/packages-ghae-release-stage.md @@ -0,0 +1,7 @@ +{% if currentVersion == "github-ae@latest" %} +{% note %} + +**Note:** {% data variables.product.prodname_registry %} is currently in beta for {% data variables.product.prodname_ghe_managed %}. + +{% endnote %} +{% endif %} diff --git a/data/reusables/package_registry/packages-ghes-release-stage.md b/data/reusables/package_registry/packages-ghes-release-stage.md index 04e4ffd9ea..3d3510d9b8 100644 --- a/data/reusables/package_registry/packages-ghes-release-stage.md +++ b/data/reusables/package_registry/packages-ghes-release-stage.md @@ -1,7 +1,7 @@ {% if currentVersion == "enterprise-server@2.22" %} {% note %} -**Note:** {% data variables.product.prodname_registry %} is currently in beta for {% data variables.product.prodname_ghe_server %} 2.22. To join the beta for your {% data variables.product.product_location %}, use the [sign-up form](https://resources.github.com/beta-signup/). +**Note:** {% data variables.product.prodname_registry %} is currently in beta for {% data variables.product.prodname_ghe_server %} 2.22. To join the beta for {% data variables.product.product_location %}, use the [sign-up form](https://resources.github.com/beta-signup/). {% endnote %} {% endif %} diff --git a/data/reusables/package_registry/public-or-private-packages.md b/data/reusables/package_registry/public-or-private-packages.md index 96876d84f3..2838a57470 100644 --- a/data/reusables/package_registry/public-or-private-packages.md +++ b/data/reusables/package_registry/public-or-private-packages.md @@ -1 +1 @@ -You can publish packages in a public repository (public packages) to share with {% if currentVersion == "free-pro-team@latest" %}all of {% data variables.product.prodname_dotcom %}{% else %}everyone on your instance{% endif %}, or in a private repository (private packages) to share with collaborators or an organization. +You can publish packages in {% if currentVersion == "github-ae@latest" %}an internal{% else %}a public{% endif %} repository ({% if currentVersion == "github-ae@latest" %}internal{% else %}public{% endif %} packages) to share with {% if currentVersion == "free-pro-team@latest" %}all of {% data variables.product.prodname_dotcom %}{% else %}everyone on your enterprise{% endif %}, or in a private repository (private packages) to share with collaborators or an organization. diff --git a/data/reusables/pull_requests/you-can-auto-merge.md b/data/reusables/pull_requests/you-can-auto-merge.md index 5da386a3d1..917e7d9452 100644 --- a/data/reusables/pull_requests/you-can-auto-merge.md +++ b/data/reusables/pull_requests/you-can-auto-merge.md @@ -1,3 +1,3 @@ -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@3.0" %} You can configure a pull request to merge automatically when all merge requirements are met. For more information, see "[Automatically merging a pull request](/github/collaborating-with-issues-and-pull-requests/automatically-merging-a-pull-request)." {% endif %} diff --git a/data/reusables/secret-scanning/beta.md b/data/reusables/secret-scanning/beta.md index 82fdadded9..e0b230700b 100644 --- a/data/reusables/secret-scanning/beta.md +++ b/data/reusables/secret-scanning/beta.md @@ -1,7 +1,7 @@ -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} {% note %} -**Note:** {% data variables.product.prodname_secret_scanning_caps %} for organization-owned{% if currentVersion ver_gt "enterprise-server@2.22" %} public and{% endif %} private repositories is currently in beta and subject to change. +**Note:** {% data variables.product.prodname_secret_scanning_caps %} for organization-owned{% if currentVersion == "free-pro-team@latest" %} private{% endif %} repositories is currently in beta and subject to change. {% endnote %} diff --git a/data/reusables/secret-scanning/partner-secret-list-private-repo.md b/data/reusables/secret-scanning/partner-secret-list-private-repo.md index d5701ad58f..36d8331ce5 100644 --- a/data/reusables/secret-scanning/partner-secret-list-private-repo.md +++ b/data/reusables/secret-scanning/partner-secret-list-private-repo.md @@ -1,5 +1,5 @@ -Partner | Supported secret | API slug ---- | --- | --- +Partner | Supported secret | API slug +--- | --- | --- n/a | JSON Web Token | json_web_token n/a | OAuth Client Credential | api_credential_assignment Adafruit IO | Adafruit IO Key | adafruit_io_key @@ -51,6 +51,7 @@ Proctorio | Proctorio Secret Key | proctorio_secret_key Pulumi | Pulumi Access Token | pulumi_access_token Samsara | Samsara API Token | samsara_api_token Samsara | Samsara OAuth Access Token | samsara_oauth_access_token +SendGrid | SendGrid API Key | sendgrid_api_key Shopify | Shopify App Shared Secret | shopify_app_shared_secret Shopify | Shopify Access Token | shopify_access_token Shopify | Shopify Custom App Access Token | shopify_custom_app_access_token diff --git a/data/reusables/security/displayed-information.md b/data/reusables/security/displayed-information.md new file mode 100644 index 0000000000..02f38c36db --- /dev/null +++ b/data/reusables/security/displayed-information.md @@ -0,0 +1,7 @@ +When you enable one or more security and analysis features for existing repositories, you will see any results displayed on {% data variables.product.prodname_dotcom %} within minutes: + +- All the existing repositories will have the selected configuration. +- New repositories will follow the selected configuration if you've enabled the checkbox for new repositories.{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} +- We use the permissions to scan for manifest files to apply the relevant services. +- You'll see information on your dependency graph. +- {% data variables.product.prodname_dotcom %} will generate {% data variables.product.prodname_dependabot_alerts %}{% endif %}{% if currentVersion == "free-pro-team@latest" %} and raise pull requests{% endif %}. diff --git a/data/reusables/user-settings/oauth_apps.md b/data/reusables/user-settings/oauth_apps.md index ad5f4e71d6..dca540647b 100644 --- a/data/reusables/user-settings/oauth_apps.md +++ b/data/reusables/user-settings/oauth_apps.md @@ -1,2 +1,2 @@ 1. In the left sidebar, click **OAuth Apps**. -![OAuth Apps section](/assets/images/settings/oauth_apps_post2dot12.png) +![OAuth Apps section](/assets/images/help/settings/developer-settings-oauth-apps.png) diff --git a/data/reusables/webhooks/check_run_properties.md b/data/reusables/webhooks/check_run_properties.md index eca6f57502..15905ea4c6 100644 --- a/data/reusables/webhooks/check_run_properties.md +++ b/data/reusables/webhooks/check_run_properties.md @@ -6,7 +6,7 @@ Key | Type | Description `check_run[conclusion]`|`string` | The result of the completed check run. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" or currentVersion == "github-ae@latest" %}`action_required` or `stale`{% else %}or `action_required`{% endif %}. This value will be `null` until the check run has `completed`. `check_run[name]`|`string` | The name of the check run. `check_run[check_suite][id]`|`integer` | The id of the check suite that this check run is part of. -`check_run[check_suite][pull_requests]`|`array`| An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty.{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} -`deployment`|`object`| A deployment to a repository environment. This will only be populated if the check run was created by a {% data variables.product.prodname_actions %} workflow job that references an environment.{% endif %} +`check_run[check_suite][pull_requests]`|`array`| An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty.{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %} +`check_run[check_suite][deployment]`|`object`| A deployment to a repository environment. This will only be populated if the check run was created by a {% data variables.product.prodname_actions %} workflow job that references an environment.{% endif %} `requested_action`|`object` | The action requested by the user. `requested_action[identifier]`|`string` | The integrator reference of the action requested by the user. diff --git a/data/reusables/webhooks/create_properties.md b/data/reusables/webhooks/create_properties.md index 4f876a5925..23e8dcf25c 100644 --- a/data/reusables/webhooks/create_properties.md +++ b/data/reusables/webhooks/create_properties.md @@ -2,5 +2,5 @@ Key | Type | Description ----|------|------------- `ref`|`string` | The [`git ref`](/rest/reference/git#get-a-reference) resource. `ref_type`|`string` | The type of Git ref object created in the repository. Can be either `branch` or `tag`. -`master_branch`|`string` | The name of the repository's default branch (usually {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.23" %}`main`{% else %}`master`{% endif %}). +`master_branch`|`string` | The name of the repository's default branch (usually {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.23" or currentVersion == "github-ae@latest" %}`main`{% else %}`master`{% endif %}). `description`|`string` | The repository's current description. diff --git a/data/reusables/webhooks/pull_request_webhook_properties.md b/data/reusables/webhooks/pull_request_webhook_properties.md index ecd62db727..1f6e268bdf 100644 --- a/data/reusables/webhooks/pull_request_webhook_properties.md +++ b/data/reusables/webhooks/pull_request_webhook_properties.md @@ -1,3 +1,3 @@ Key | Type | Description ----|------|------------- -`action`|`string` | The action that was performed. Can be one of `opened`, `edited`, `closed`, `assigned`, `unassigned`, `review_requested`, `review_request_removed`, `ready_for_review`, `converted_to_draft`, `labeled`, `unlabeled`, `synchronize`, {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}`auto_merge_enabled`, `auto_merge_disabled`,{% endif %} `locked`, `unlocked`, or `reopened`. If the action is `closed` and the `merged` key is `false`, the pull request was closed with unmerged commits. If the action is `closed` and the `merged` key is `true`, the pull request was merged. +`action`|`string` | The action that was performed. Can be one of `opened`, `edited`, `closed`, `assigned`, `unassigned`, `review_requested`, `review_request_removed`, `ready_for_review`, `converted_to_draft`, `labeled`, `unlabeled`, `synchronize`, {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %}`auto_merge_enabled`, `auto_merge_disabled`,{% endif %} `locked`, `unlocked`, or `reopened`. If the action is `closed` and the `merged` key is `false`, the pull request was closed with unmerged commits. If the action is `closed` and the `merged` key is `true`, the pull request was merged. diff --git a/data/reusables/webhooks/pusher_type_desc.md b/data/reusables/webhooks/pusher_type_desc.md new file mode 100644 index 0000000000..867fad6a56 --- /dev/null +++ b/data/reusables/webhooks/pusher_type_desc.md @@ -0,0 +1 @@ +`pusher_type`|`string`| The pusher type for the event. Can be either `user` or a deploy key. \ No newline at end of file diff --git a/data/reusables/webhooks/secret.md b/data/reusables/webhooks/secret.md index a92e5fca87..95f3a341ca 100644 --- a/data/reusables/webhooks/secret.md +++ b/data/reusables/webhooks/secret.md @@ -1 +1 @@ -Setting a webhook secret allows you to ensure that `POST` requests sent to the payload URL are from {% data variables.product.product_name %}. When you set a secret, you'll receive the {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}`X-Hub-Signature` and `X-Hub-Signature-256` headers{% elsif currentVersion ver_lt "enterprise-server@2.23" %}`X-Hub-Signature` header{% elsif currentVersion == "github-ae@latest" %}`X-Hub-Signature-256` header{% endif %} in the webhook `POST` request. For more information on how to use a secret with a signature header to secure your webhook payloads, see "[Securing your webhooks](/webhooks/securing/)." +Setting a webhook secret allows you to ensure that `POST` requests sent to the payload URL are from {% data variables.product.product_name %}. When you set a secret, you'll receive the {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %}`X-Hub-Signature` and `X-Hub-Signature-256` headers{% elsif currentVersion ver_lt "enterprise-server@2.23" %}`X-Hub-Signature` header{% elsif currentVersion == "github-ae@latest" %}`X-Hub-Signature-256` header{% endif %} in the webhook `POST` request. For more information on how to use a secret with a signature header to secure your webhook payloads, see "[Securing your webhooks](/webhooks/securing/)." diff --git a/data/reusables/webhooks/webhooks-rest-api-links.md b/data/reusables/webhooks/webhooks-rest-api-links.md index 3882222b05..1dd3383c2f 100644 --- a/data/reusables/webhooks/webhooks-rest-api-links.md +++ b/data/reusables/webhooks/webhooks-rest-api-links.md @@ -1,4 +1,4 @@ -You can use the repository, organization, and app webhook REST APIs to create, update, delete, and ping webhooks. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}You can also use the REST API to change the configuration of the webhook. For example, you can modify the payload URL, content type, SSL verification, and secret. {% endif %}For more information, see: +You can use the repository, organization, and app webhook REST APIs to create, update, delete, and ping webhooks. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %}You can also use the REST API to change the configuration of the webhook. For example, you can modify the payload URL, content type, SSL verification, and secret. {% endif %}For more information, see: - [Repository Webhooks REST API](/rest/reference/repos#webhooks) -- [Organization Webhooks REST API](/rest/reference/orgs#webhooks){% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} +- [Organization Webhooks REST API](/rest/reference/orgs#webhooks){% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} - [GitHub App Webhooks REST API](/rest/reference/apps#webhooks){% endif %} diff --git a/data/reusables/webhooks/workflow_desc.md b/data/reusables/webhooks/workflow_desc.md new file mode 100644 index 0000000000..6f716dbe56 --- /dev/null +++ b/data/reusables/webhooks/workflow_desc.md @@ -0,0 +1 @@ +`workflow` | `object` | The workflow that generated the workflow run. diff --git a/data/reusables/webhooks/workflow_run_desc.md b/data/reusables/webhooks/workflow_run_desc.md index 8866577116..486a20dcd1 100644 --- a/data/reusables/webhooks/workflow_run_desc.md +++ b/data/reusables/webhooks/workflow_run_desc.md @@ -1,4 +1,5 @@ +This event occurs when a workflow run is requested or completed, and allows you to execute a workflow based on the finished result of another workflow. A workflow run is triggered regardless of the result of the previous workflow. -This event occurs when a workflow run is requested or completed, and allows you to execute a workflow based on the finished result of another workflow. For example, if your `pull_request` workflow generates build artifacts, you can create a new workflow that uses `workflow_run` to analyze the results and add a comment to the original pull request. +For example, if your `pull_request` workflow generates build artifacts, you can create a new workflow that uses `workflow_run` to analyze the results and add a comment to the original pull request. -The workflow started by the `workflow_run` event is able to access the secrets and write tokens used by the original workflow. +The workflow started by the `workflow_run` event is able to access secrets and write tokens, even if the previous workflow was not. This is useful in cases where the previous workflow is intentionally not privileged, but you need to take a privileged action in a later workflow. diff --git a/data/reusables/webhooks/workflow_run_properties.md b/data/reusables/webhooks/workflow_run_properties.md new file mode 100644 index 0000000000..1ff99e14f5 --- /dev/null +++ b/data/reusables/webhooks/workflow_run_properties.md @@ -0,0 +1,4 @@ +Key | Type | Description +----|------|------------- +`action`|`string` | The action that was performed. Can be one of `requested` or `completed`. +`workflow_run`| `object` | The workflow run. Many `workflow_run` keys, such as `head_branch`, `conclusion`, and `pull_requests` are the same as those in a [`check_suite`](#check_suite) object. diff --git a/data/ui.yml b/data/ui.yml index 1979c0563e..8b8c5cabc6 100644 --- a/data/ui.yml +++ b/data/ui.yml @@ -11,7 +11,7 @@ header: For the most current information, please visit the English documentation. If there's a problem with translations on this page, please - let us know. + let us know. localization_in_progress: Hello, explorer! This page is under active development or still in translation. For the most up-to-date and accurate information, @@ -158,3 +158,4 @@ product_sublanding: learning_track_nav: prevGuide: Previous guide nextGuide: Next guide +contributor_callout: This article is contributed and maintained by diff --git a/data/variables/actions.yml b/data/variables/actions.yml new file mode 100644 index 0000000000..35d247f297 --- /dev/null +++ b/data/variables/actions.yml @@ -0,0 +1 @@ +hosted_runner: 'AE hosted runner' diff --git a/includes/all-articles-category.html b/includes/all-articles-category.html new file mode 100644 index 0000000000..0e1fdbd61b --- /dev/null +++ b/includes/all-articles-category.html @@ -0,0 +1,32 @@ +{% assign category = siteTree[currentLanguage][currentVersion].products[currentProduct].categories[currentPath] %} + +{% assign maxArticles = 10 %} + +
+

{{ category.title }} docs

+ +
+ {% for xmaptopic in category.maptopics %} + {% assign maptopic = xmaptopic[1] %} + {% unless maptopic.hidden %} +
+

{{ maptopic.title }}

+
    + {% for xarticle in maptopic.articles %} + {% assign article = xarticle[1] %} +
  • + + {{ article.title }} + +
  • + {% endfor %} + {% assign numArticles = maptopic.childArticles | obj_size %} + {% if numArticles > maxArticles %} + + {% endif %} +
+
+ {% endunless %} + {% endfor %} +
+
diff --git a/includes/all-articles.html b/includes/all-articles-product.html similarity index 100% rename from includes/all-articles.html rename to includes/all-articles-product.html diff --git a/includes/article.html b/includes/article.html index fe8f4c89ee..27d916ec04 100644 --- a/includes/article.html +++ b/includes/article.html @@ -20,6 +20,12 @@
+ {% if page.contributor %} +
+

{% octicon "info" %}{% data ui.contributor_callout %} {{ page.contributor.name }}.

+
+ {% endif %} + {% if page.intro %}
{{ page.intro }}
{% endif %} diff --git a/includes/footer.html b/includes/footer.html index d8c92ce3d0..d7477ba2da 100644 --- a/includes/footer.html +++ b/includes/footer.html @@ -12,7 +12,7 @@
  • {% data ui.footer.product.links.features %}
  • {% data ui.footer.product.links.security %}
  • {% data ui.footer.product.links.enterprise %}
  • -
  • {% data ui.footer.product.links.case_studies %}
  • +
  • {% data ui.footer.product.links.case_studies %}
  • {% data ui.footer.product.links.pricing %}
  • {% data ui.footer.product.links.resources %}
  • @@ -34,7 +34,7 @@
  • {% data ui.footer.support.links.community_forum %}
  • {% data ui.footer.support.links.training %}
  • {% data ui.footer.support.links.status %}
  • -
  • {% data ui.footer.support.links.contact_github %}
  • +
  • {% data ui.footer.support.links.contact_github %}
  • diff --git a/includes/head.html b/includes/head.html index 5d931a9048..0cd6b63fad 100644 --- a/includes/head.html +++ b/includes/head.html @@ -11,6 +11,9 @@ {% if page.intro %} {% endif %} + {% if page.topics %} + + {% endif %} {% if page.hidden %} {% endif %} diff --git a/includes/small-footer.html b/includes/small-footer.html index 61e56abbb4..5bf248e873 100644 --- a/includes/small-footer.html +++ b/includes/small-footer.html @@ -10,7 +10,7 @@
  • {% data ui.footer.product.links.security %}
  • {% data ui.footer.support.links.status %}
  • {% data ui.footer.support.links.help %}
  • -
  • {% data ui.footer.support.links.contact_github %}
  • +
  • {% data ui.footer.support.links.contact_github %}
  • {% data ui.footer.product.links.pricing %}
  • {% data ui.footer.platform.links.developer_api %}
  • {% data ui.footer.support.links.training %}
  • diff --git a/javascripts/display-platform-specific-content.js b/javascripts/display-platform-specific-content.js index 0e7035eba5..841d1cbdae 100644 --- a/javascripts/display-platform-specific-content.js +++ b/javascripts/display-platform-specific-content.js @@ -12,6 +12,7 @@ export default function displayPlatformSpecificContent () { if (platform === 'darwin') platform = 'mac' if (platform === 'ios') platform = 'mac' if (platform === 'android') platform = 'linux' + if (platform === 'cros') platform = 'linux' if (platform.startsWith('win')) platform = 'windows' const platformsInContent = findPlatformSpecificContent(platform) diff --git a/javascripts/search.js b/javascripts/search.js index 760bce874b..edc7def535 100644 --- a/javascripts/search.js +++ b/javascripts/search.js @@ -261,8 +261,8 @@ function tmplSearchResult ({ url, breadcrumbs, heading, title, content }) { { 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 - markify((breadcrumbs || '').replace(` / ${title}`, '')) + // Breadcrumbs in search records don't include the page title + markify(breadcrumbs || '') ), div( { class: 'search-result-title d-block h4-mktg text-gray-dark' }, diff --git a/javascripts/user-agent.js b/javascripts/user-agent.js index 659dd1a66d..2f76724992 100644 --- a/javascripts/user-agent.js +++ b/javascripts/user-agent.js @@ -6,6 +6,7 @@ const OS_REGEXPS = [ /(mac) os x ([^);]+)/i, /(windows) ([^);]+)/i, /(android) ([^);]+)/i, + /(cros) ([^);]+)/i, /(linux) ([^);]+)/i ] diff --git a/layouts/product-landing.html b/layouts/product-landing.html index fbda1d8334..fc8e00406d 100644 --- a/layouts/product-landing.html +++ b/layouts/product-landing.html @@ -60,7 +60,9 @@
      {% for link in featuredLinks.guides %} @@ -125,13 +127,19 @@ {% render guide-card for guideCards as guide %}
    - Explore guides {% octicon "arrow-right" %} + {% unless currentCategory %} + Explore guides {% octicon "arrow-right" %} + {% endunless %}
    {% endif %}
    - {% include all-articles %} + {% if currentCategory %} + {% include all-articles-category %} + {% else %} + {% include all-articles-product %} + {% endif %}
    diff --git a/layouts/release-notes.html b/layouts/release-notes.html index 0f3096a615..f5ce1d2975 100644 --- a/layouts/release-notes.html +++ b/layouts/release-notes.html @@ -39,7 +39,7 @@
    {% for patch in releaseNotes %} -
    +

    @@ -62,7 +62,7 @@

    {{ patch.date | date: "%B %d, %Y" }}

    -
    +
    {{ patch.intro }}
    {% for section in patch.sections %} diff --git a/lib/enterprise-dates.json b/lib/enterprise-dates.json index 41765e2002..3921dd7c0b 100644 --- a/lib/enterprise-dates.json +++ b/lib/enterprise-dates.json @@ -81,7 +81,7 @@ }, "2.20": { "releaseDate": "2020-02-11", - "deprecationDate": "2021-02-11" + "deprecationDate": "2021-03-02" }, "2.21": { "releaseDate": "2020-06-09", @@ -95,4 +95,4 @@ "releaseDate": "2021-01-12", "deprecationDate": "2022-01-20" } -} \ No newline at end of file +} diff --git a/lib/enterprise-server-releases.js b/lib/enterprise-server-releases.js index 3e6f83c31a..0e620ec0c5 100644 --- a/lib/enterprise-server-releases.js +++ b/lib/enterprise-server-releases.js @@ -4,6 +4,9 @@ const versionSatisfiesRange = require('./version-satisfies-range') // enterprise-releases/docs/supported-versions.md#release-lifecycle-dates const dates = require('../lib/enterprise-dates.json') +// Some frontmatter may contain the upcoming GHES release number +const next = '3.1' + const supported = [ '3.0', '2.22', @@ -57,6 +60,7 @@ const deprecatedReleasesWithNewFormat = deprecated.filter(version => versionSati const deprecatedReleasesOnDeveloperSite = deprecated.filter(version => versionSatisfiesRange(version, '<=2.16')) module.exports = { + next, supported, deprecated, legacyAssetVersions, diff --git a/lib/frontmatter.js b/lib/frontmatter.js index 9a0f390f1d..c875db2515 100644 --- a/lib/frontmatter.js +++ b/lib/frontmatter.js @@ -119,6 +119,14 @@ const schema = { defaultPlatform: { type: 'string', enum: ['mac', 'windows', 'linux'] + }, + // Documentation contributed by a third party, such as a GitHub Partner + contributor: { + type: 'object', + properties: { + name: { type: 'string' }, + URL: { type: 'string' } + } } } } diff --git a/lib/get-applicable-versions.js b/lib/get-applicable-versions.js index a05880799e..ec64f109ff 100644 --- a/lib/get-applicable-versions.js +++ b/lib/get-applicable-versions.js @@ -1,4 +1,5 @@ const allVersions = require('./all-versions') +const { next } = require('./enterprise-server-releases') const versionSatisfiesRange = require('./version-satisfies-range') // return an array of versions that an article's product versions encompasses @@ -15,6 +16,8 @@ function getApplicableVersions (frontmatterVersions, filepath) { // get an array like: [ 'free-pro-team@latest', 'enterprise-server@2.21', 'enterprise-cloud@latest' ] const applicableVersions = [] + let nextVersion = false + // where frontmatter is something like: // free-pro-team: '*' // enterprise-server: '>=2.19' @@ -23,6 +26,15 @@ function getApplicableVersions (frontmatterVersions, filepath) { // ^ where each key corresponds to a plan Object.entries(frontmatterVersions) .forEach(([plan, planValue]) => { + // Special handling for frontmatter that evalues to the next GHES release number or a hardcoded `next`: + // we don't want to return it in the applicable versions array or it will become a permalink, + // but we also don't want to throw an error if no other versions are found. + if (planValue !== '*') { + if (versionSatisfiesRange(next, planValue) || planValue === 'next') { + nextVersion = true + } + } + // for each plan (e.g., enterprise-server), get matching versions from allVersions object const relevantVersions = Object.values(allVersions).filter(v => v.plan === plan) @@ -42,7 +54,7 @@ function getApplicableVersions (frontmatterVersions, filepath) { }) }) - if (!applicableVersions.length) { + if (!applicableVersions.length && !nextVersion) { throw new Error(`No applicable versions found for ${filepath}. Please double-check the page's \`versions\` frontmatter.`) } diff --git a/lib/graphql/static/changelog.json b/lib/graphql/static/changelog.json index 9d5002a4df..69caab8ea6 100644 --- a/lib/graphql/static/changelog.json +++ b/lib/graphql/static/changelog.json @@ -1,4 +1,63 @@ [ + { + "schemaChanges": [ + { + "title": "The GraphQL schema includes these changes:", + "changes": [ + "Field `isRequired` was added to object type `CheckRun`", + "Field `isRequired` was added to object type `StatusContext`" + ] + } + ], + "previewChanges": [], + "upcomingChanges": [], + "date": "2021-03-18" + }, + { + "schemaChanges": [ + { + "title": "The GraphQL schema includes these changes:", + "changes": [ + "Field `isPinned` was added to object type `Issue`", + "Enum value 'CREATED_AT` was added to enum `VerifiableDomainOrderField'", + "Field `createdAt` was added to object type `VerifiableDomain`", + "Field `updatedAt` was added to object type `VerifiableDomain`" + ] + } + ], + "previewChanges": [], + "upcomingChanges": [], + "date": "2021-03-03" + }, + { + "schemaChanges": [ + { + "title": "The GraphQL schema includes these changes:", + "changes": [ + "Field `isGitHubStar` was added to object type `User`", + "Field `tagCommit` was added to object type `Release`" + ] + } + ], + "previewChanges": [], + "upcomingChanges": [], + "date": "2021-03-02" + }, + { + "schemaChanges": [ + { + "title": "The GraphQL schema includes these changes:", + "changes": [ + "Type `ApproveVerifiableDomainInput` was added", + "Type `ApproveVerifiableDomainPayload` was added", + "Field `approveVerifiableDomain` was added to object type `Mutation`" + ] + } + ], + "previewChanges": [], + "upcomingChanges": [], + "date": "2021-02-25" + }, { "schemaChanges": [ { diff --git a/lib/graphql/static/prerendered-objects.json b/lib/graphql/static/prerendered-objects.json index cb9ad8d040..71b186520f 100644 --- a/lib/graphql/static/prerendered-objects.json +++ b/lib/graphql/static/prerendered-objects.json @@ -1,6 +1,6 @@ { "dotcom": { - "html": "
    \n
    \n

    \n ActorLocation\n

    \n

    Location information for an actor.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    city (String)

    City.

    \n\n\n\n\n\n\n\n\n\n\n\n

    country (String)

    Country name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    countryCode (String)

    Country code.

    \n\n\n\n\n\n\n\n\n\n\n\n

    region (String)

    Region name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    regionCode (String)

    Region or state code.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n AddedToProjectEvent\n

    \n

    Represents aadded_to_projectevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    project (Project)

    Project referenced by event.

    \n\n\n\n\n
    \n

    Preview notice

    \n

    project is available under the Project event details preview. During the preview period, the API may change without notice.

    \n
    \n\n\n\n\n\n\n\n\n

    projectCard (ProjectCard)

    Project card referenced by this project event.

    \n\n\n\n\n
    \n

    Preview notice

    \n

    projectCard is available under the Project event details preview. During the preview period, the API may change without notice.

    \n
    \n\n\n\n\n\n\n\n\n

    projectColumnName (String!)

    Column name referenced by this project event.

    \n\n\n\n\n
    \n

    Preview notice

    \n

    projectColumnName is available under the Project event details preview. During the preview period, the API may change without notice.

    \n
    \n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n App\n

    \n

    A GitHub App.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String)

    The description of the app.

    \n\n\n\n\n\n\n\n\n\n\n\n

    logoBackgroundColor (String!)

    The hex color code, without the leading '#', for the logo background.

    \n\n\n\n\n\n\n\n\n\n\n\n

    logoUrl (URI!)

    A URL pointing to the app's logo.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    size (Int)

    \n

    The size of the resulting image.

    \n\n
    \n\n
    \n\n\n

    name (String!)

    The name of the app.

    \n\n\n\n\n\n\n\n\n\n\n\n

    slug (String!)

    A slug based on the name of the app for use in URLs.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The URL to the app's homepage.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n AssignedEvent\n

    \n

    Represents anassignedevent on any assignable object.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    assignable (Assignable!)

    Identifies the assignable associated with the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    assignee (Assignee)

    Identifies the user or mannequin that was assigned.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    Identifies the user who was assigned.

    \n\n\n\n\n\n\n
    \n

    Deprecation notice

    \n

    user is deprecated.

    Assignees can now be mannequins. Use the assignee field instead. Removal on 2020-01-01 UTC.

    \n
    \n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n AutoMergeDisabledEvent\n

    \n

    Represents aauto_merge_disabledevent on a given pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    disabler (User)

    The user who disabled auto-merge for this Pull Request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest)

    PullRequest referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reason (String)

    The reason auto-merge was disabled.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reasonCode (String)

    The reason_code relating to why auto-merge was disabled.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n AutoMergeEnabledEvent\n

    \n

    Represents aauto_merge_enabledevent on a given pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enabler (User)

    The user who enabled auto-merge for this Pull Request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest)

    PullRequest referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n AutoMergeRequest\n

    \n

    Represents an auto-merge request for a pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    authorEmail (String)

    The email address of the author of this auto-merge request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commitBody (String)

    The commit message of the auto-merge request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commitHeadline (String)

    The commit title of the auto-merge request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enabledAt (DateTime)

    When was this auto-merge request was enabled.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enabledBy (Actor)

    The actor who created the auto-merge request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    mergeMethod (PullRequestMergeMethod!)

    The merge method of the auto-merge request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    The pull request that this auto-merge request is set against.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n AutoRebaseEnabledEvent\n

    \n

    Represents aauto_rebase_enabledevent on a given pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enabler (User)

    The user who enabled auto-merge (rebase) for this Pull Request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest)

    PullRequest referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n AutoSquashEnabledEvent\n

    \n

    Represents aauto_squash_enabledevent on a given pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enabler (User)

    The user who enabled auto-merge (squash) for this Pull Request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest)

    PullRequest referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n AutomaticBaseChangeFailedEvent\n

    \n

    Represents aautomatic_base_change_failedevent on a given pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    newBase (String!)

    The new base for this PR.

    \n\n\n\n\n\n\n\n\n\n\n\n

    oldBase (String!)

    The old base for this PR.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    PullRequest referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n AutomaticBaseChangeSucceededEvent\n

    \n

    Represents aautomatic_base_change_succeededevent on a given pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    newBase (String!)

    The new base for this PR.

    \n\n\n\n\n\n\n\n\n\n\n\n

    oldBase (String!)

    The old base for this PR.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    PullRequest referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n BaseRefChangedEvent\n

    \n

    Represents abase_ref_changedevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    currentRefName (String!)

    Identifies the name of the base ref for the pull request after it was changed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    previousRefName (String!)

    Identifies the name of the base ref for the pull request before it was changed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    PullRequest referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n BaseRefDeletedEvent\n

    \n

    Represents abase_ref_deletedevent on a given pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    baseRefName (String)

    Identifies the name of the Ref associated with the base_ref_deleted event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest)

    PullRequest referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n BaseRefForcePushedEvent\n

    \n

    Represents abase_ref_force_pushedevent on a given pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    afterCommit (Commit)

    Identifies the after commit SHA for thebase_ref_force_pushedevent.

    \n\n\n\n\n\n\n\n\n\n\n\n

    beforeCommit (Commit)

    Identifies the before commit SHA for thebase_ref_force_pushedevent.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    PullRequest referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ref (Ref)

    Identifies the fully qualified ref name for thebase_ref_force_pushedevent.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Blame\n

    \n

    Represents a Git blame.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    ranges ([BlameRange!]!)

    The list of ranges from a Git blame.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n BlameRange\n

    \n

    Represents a range of information from a Git blame.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    age (Int!)

    Identifies the recency of the change, from 1 (new) to 10 (old). This is\ncalculated as a 2-quantile and determines the length of distance between the\nmedian age of all the changes in the file and the recency of the current\nrange's change.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commit (Commit!)

    Identifies the line author.

    \n\n\n\n\n\n\n\n\n\n\n\n

    endingLine (Int!)

    The ending line for the range.

    \n\n\n\n\n\n\n\n\n\n\n\n

    startingLine (Int!)

    The starting line for the range.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Blob\n

    \n

    Represents a Git blob.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    abbreviatedOid (String!)

    An abbreviated version of the Git object ID.

    \n\n\n\n\n\n\n\n\n\n\n\n

    byteSize (Int!)

    Byte size of Blob object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commitResourcePath (URI!)

    The HTTP path for this Git object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commitUrl (URI!)

    The HTTP URL for this Git object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isBinary (Boolean)

    Indicates whether the Blob is binary or text. Returns null if unable to determine the encoding.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isTruncated (Boolean!)

    Indicates whether the contents is truncated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    oid (GitObjectID!)

    The Git object ID.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository!)

    The Repository the Git object belongs to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    text (String)

    UTF8 text data or null if the Blob is binary.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Bot\n

    \n

    A special type of user which takes actions on behalf of GitHub Apps.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    avatarUrl (URI!)

    A URL pointing to the GitHub App's public avatar.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    size (Int)

    \n

    The size of the resulting square image.

    \n\n
    \n\n
    \n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    login (String!)

    The username of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this bot.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this bot.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n BranchProtectionRule\n

    \n

    A branch protection rule.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    allowsDeletions (Boolean!)

    Can this branch be deleted.

    \n\n\n\n\n\n\n\n\n\n\n\n

    allowsForcePushes (Boolean!)

    Are force pushes allowed on this branch.

    \n\n\n\n\n\n\n\n\n\n\n\n

    branchProtectionRuleConflicts (BranchProtectionRuleConflictConnection!)

    A list of conflicts matching branches protection rule and other branch protection rules.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    creator (Actor)

    The actor who created this branch protection rule.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    dismissesStaleReviews (Boolean!)

    Will new commits pushed to matching branches dismiss pull request review approvals.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isAdminEnforced (Boolean!)

    Can admins overwrite branch protection.

    \n\n\n\n\n\n\n\n\n\n\n\n

    matchingRefs (RefConnection!)

    Repository refs that are protected by this rule.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    query (String)

    \n

    Filters refs with query on name.

    \n\n
    \n\n
    \n\n\n

    pattern (String!)

    Identifies the protection rule pattern.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pushAllowances (PushAllowanceConnection!)

    A list push allowances for this branch protection rule.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    repository (Repository)

    The repository associated with this branch protection rule.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiredApprovingReviewCount (Int)

    Number of approving reviews required to update matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiredStatusCheckContexts ([String])

    List of required status check contexts that must pass for commits to be accepted to matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiresApprovingReviews (Boolean!)

    Are approving reviews required to update matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiresCodeOwnerReviews (Boolean!)

    Are reviews from code owners required to update matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiresCommitSignatures (Boolean!)

    Are commits required to be signed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiresLinearHistory (Boolean!)

    Are merge commits prohibited from being pushed to this branch.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiresStatusChecks (Boolean!)

    Are status checks required to update matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiresStrictStatusChecks (Boolean!)

    Are branches required to be up to date before merging.

    \n\n\n\n\n\n\n\n\n\n\n\n

    restrictsPushes (Boolean!)

    Is pushing to matching branches restricted.

    \n\n\n\n\n\n\n\n\n\n\n\n

    restrictsReviewDismissals (Boolean!)

    Is dismissal of pull request reviews restricted.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reviewDismissalAllowances (ReviewDismissalAllowanceConnection!)

    A list review dismissal allowances for this branch protection rule.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n BranchProtectionRuleConflict\n

    \n

    A conflict between two branch protection rules.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    branchProtectionRule (BranchProtectionRule)

    Identifies the branch protection rule.

    \n\n\n\n\n\n\n\n\n\n\n\n

    conflictingBranchProtectionRule (BranchProtectionRule)

    Identifies the conflicting branch protection rule.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ref (Ref)

    Identifies the branch ref that has conflicting rules.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n BranchProtectionRuleConflictConnection\n

    \n

    The connection type for BranchProtectionRuleConflict.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([BranchProtectionRuleConflictEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([BranchProtectionRuleConflict])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n BranchProtectionRuleConflictEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (BranchProtectionRuleConflict)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n BranchProtectionRuleConnection\n

    \n

    The connection type for BranchProtectionRule.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([BranchProtectionRuleEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([BranchProtectionRule])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n BranchProtectionRuleEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (BranchProtectionRule)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CVSS\n

    \n

    The Common Vulnerability Scoring System.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    score (Float!)

    The CVSS score associated with this advisory.

    \n\n\n\n\n\n\n\n\n\n\n\n

    vectorString (String)

    The CVSS vector string associated with this advisory.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CWE\n

    \n

    A common weakness enumeration.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cweId (String!)

    The id of the CWE.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String!)

    A detailed description of this CWE.

    \n\n\n\n\n\n\n\n\n\n\n\n

    id (ID!)

    ID of the object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The name of this CWE.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CWEConnection\n

    \n

    The connection type for CWE.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([CWEEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([CWE])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CWEEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (CWE)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CheckAnnotation\n

    \n

    A single check annotation.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    annotationLevel (CheckAnnotationLevel)

    The annotation's severity level.

    \n\n\n\n\n\n\n\n\n\n\n\n

    blobUrl (URI!)

    The path to the file that this annotation was made on.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    location (CheckAnnotationSpan!)

    The position of this annotation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    message (String!)

    The annotation's message.

    \n\n\n\n\n\n\n\n\n\n\n\n

    path (String!)

    The path that this annotation was made on.

    \n\n\n\n\n\n\n\n\n\n\n\n

    rawDetails (String)

    Additional information about the annotation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    title (String)

    The annotation's title.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CheckAnnotationConnection\n

    \n

    The connection type for CheckAnnotation.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([CheckAnnotationEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([CheckAnnotation])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CheckAnnotationEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (CheckAnnotation)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CheckAnnotationPosition\n

    \n

    A character position in a check annotation.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    column (Int)

    Column number (1 indexed).

    \n\n\n\n\n\n\n\n\n\n\n\n

    line (Int!)

    Line number (1 indexed).

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CheckAnnotationSpan\n

    \n

    An inclusive pair of positions for a check annotation.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    end (CheckAnnotationPosition!)

    End position (inclusive).

    \n\n\n\n\n\n\n\n\n\n\n\n

    start (CheckAnnotationPosition!)

    Start position (inclusive).

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CheckRun\n

    \n

    A check run.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    annotations (CheckAnnotationConnection)

    The check run's annotations.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    checkSuite (CheckSuite!)

    The check suite that this run is a part of.

    \n\n\n\n\n\n\n\n\n\n\n\n

    completedAt (DateTime)

    Identifies the date and time when the check run was completed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    conclusion (CheckConclusionState)

    The conclusion of the check run.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    detailsUrl (URI)

    The URL from which to find full details of the check run on the integrator's site.

    \n\n\n\n\n\n\n\n\n\n\n\n

    externalId (String)

    A reference for the check run on the integrator's system.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The name of the check for this check run.

    \n\n\n\n\n\n\n\n\n\n\n\n

    permalink (URI!)

    The permalink to the check run summary.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository!)

    The repository associated with this check run.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this check run.

    \n\n\n\n\n\n\n\n\n\n\n\n

    startedAt (DateTime)

    Identifies the date and time when the check run was started.

    \n\n\n\n\n\n\n\n\n\n\n\n

    status (CheckStatusState!)

    The current status of the check run.

    \n\n\n\n\n\n\n\n\n\n\n\n

    summary (String)

    A string representing the check run's summary.

    \n\n\n\n\n\n\n\n\n\n\n\n

    text (String)

    A string representing the check run's text.

    \n\n\n\n\n\n\n\n\n\n\n\n

    title (String)

    A string representing the check run.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this check run.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CheckRunConnection\n

    \n

    The connection type for CheckRun.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([CheckRunEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([CheckRun])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CheckRunEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (CheckRun)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CheckSuite\n

    \n

    A check suite.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    app (App)

    The GitHub App which created this check suite.

    \n\n\n\n\n\n\n\n\n\n\n\n

    branch (Ref)

    The name of the branch for this check suite.

    \n\n\n\n\n\n\n\n\n\n\n\n

    checkRuns (CheckRunConnection)

    The check runs associated with a check suite.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    filterBy (CheckRunFilter)

    \n

    Filters the check runs by this type.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    commit (Commit!)

    The commit for this check suite.

    \n\n\n\n\n\n\n\n\n\n\n\n

    conclusion (CheckConclusionState)

    The conclusion of this check suite.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    matchingPullRequests (PullRequestConnection)

    A list of open pull requests matching the check suite.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    baseRefName (String)

    \n

    The base ref name to filter the pull requests by.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    headRefName (String)

    \n

    The head ref name to filter the pull requests by.

    \n\n
    \n\n
    \n

    labels ([String!])

    \n

    A list of label names to filter the pull requests by.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (IssueOrder)

    \n

    Ordering options for pull requests returned from the connection.

    \n\n
    \n\n
    \n

    states ([PullRequestState!])

    \n

    A list of states to filter the pull requests by.

    \n\n
    \n\n
    \n\n\n

    push (Push)

    The push that triggered this check suite.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository!)

    The repository associated with this check suite.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this check suite.

    \n\n\n\n\n\n\n\n\n\n\n\n

    status (CheckStatusState!)

    The status of this check suite.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this check suite.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CheckSuiteConnection\n

    \n

    The connection type for CheckSuite.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([CheckSuiteEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([CheckSuite])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CheckSuiteEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (CheckSuite)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ClosedEvent\n

    \n

    Represents aclosedevent on any Closable.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    closable (Closable!)

    Object that was closed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    closer (Closer)

    Object which triggered the creation of this event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this closed event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this closed event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CodeOfConduct\n

    \n

    The Code of Conduct for a repository.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String)

    The body of the Code of Conduct.

    \n\n\n\n\n\n\n\n\n\n\n\n

    key (String!)

    The key for the Code of Conduct.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The formal name of the Code of Conduct.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI)

    The HTTP path for this Code of Conduct.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI)

    The HTTP URL for this Code of Conduct.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CommentDeletedEvent\n

    \n

    Represents acomment_deletedevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    deletedCommentAuthor (Actor)

    The user who authored the deleted comment.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Commit\n

    \n

    Represents a Git commit.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    abbreviatedOid (String!)

    An abbreviated version of the Git object ID.

    \n\n\n\n\n\n\n\n\n\n\n\n

    additions (Int!)

    The number of additions in this commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    associatedPullRequests (PullRequestConnection)

    The pull requests associated with a commit.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (PullRequestOrder)

    \n

    Ordering options for pull requests.

    \n\n
    \n\n
    \n\n\n

    author (GitActor)

    Authorship details of the commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    authoredByCommitter (Boolean!)

    Check if the committer and the author match.

    \n\n\n\n\n\n\n\n\n\n\n\n

    authoredDate (DateTime!)

    The datetime when this commit was authored.

    \n\n\n\n\n\n\n\n\n\n\n\n

    authors (GitActorConnection!)

    The list of authors for this commit based on the git author and the Co-authored-by\nmessage trailer. The git author will always be first.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    blame (Blame!)

    Fetches git blame information.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    path (String!)

    \n

    The file whose Git blame information you want.

    \n\n
    \n\n
    \n\n\n

    changedFiles (Int!)

    The number of changed files in this commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    checkSuites (CheckSuiteConnection)

    The check suites associated with a commit.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    filterBy (CheckSuiteFilter)

    \n

    Filters the check suites by this type.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    comments (CommitCommentConnection!)

    Comments made on the commit.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    commitResourcePath (URI!)

    The HTTP path for this Git object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commitUrl (URI!)

    The HTTP URL for this Git object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    committedDate (DateTime!)

    The datetime when this commit was committed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    committedViaWeb (Boolean!)

    Check if committed via GitHub web UI.

    \n\n\n\n\n\n\n\n\n\n\n\n

    committer (GitActor)

    Committer details of the commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    deletions (Int!)

    The number of deletions in this commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    deployments (DeploymentConnection)

    The deployments associated with a commit.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    environments ([String!])

    \n

    Environments to list deployments for.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (DeploymentOrder)

    \n

    Ordering options for deployments returned from the connection.

    \n\n
    \n\n
    \n\n\n

    file (TreeEntry)

    The tree entry representing the file located at the given path.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    path (String!)

    \n

    The path for the file.

    \n\n
    \n\n
    \n\n\n

    history (CommitHistoryConnection!)

    The linear commit history starting from (and including) this commit, in the same order as git log.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    author (CommitAuthor)

    \n

    If non-null, filters history to only show commits with matching authorship.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    path (String)

    \n

    If non-null, filters history to only show commits touching files under this path.

    \n\n
    \n\n
    \n

    since (GitTimestamp)

    \n

    Allows specifying a beginning time or date for fetching commits.

    \n\n
    \n\n
    \n

    until (GitTimestamp)

    \n

    Allows specifying an ending time or date for fetching commits.

    \n\n
    \n\n
    \n\n\n

    message (String!)

    The Git commit message.

    \n\n\n\n\n\n\n\n\n\n\n\n

    messageBody (String!)

    The Git commit message body.

    \n\n\n\n\n\n\n\n\n\n\n\n

    messageBodyHTML (HTML!)

    The commit message body rendered to HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    messageHeadline (String!)

    The Git commit message headline.

    \n\n\n\n\n\n\n\n\n\n\n\n

    messageHeadlineHTML (HTML!)

    The commit message headline rendered to HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    oid (GitObjectID!)

    The Git object ID.

    \n\n\n\n\n\n\n\n\n\n\n\n

    onBehalfOf (Organization)

    The organization this commit was made on behalf of.

    \n\n\n\n\n\n\n\n\n\n\n\n

    parents (CommitConnection!)

    The parents of a commit.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    pushedDate (DateTime)

    The datetime when this commit was pushed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository!)

    The Repository this commit belongs to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    signature (GitSignature)

    Commit signing information, if present.

    \n\n\n\n\n\n\n\n\n\n\n\n

    status (Status)

    Status information for this commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    statusCheckRollup (StatusCheckRollup)

    Check and Status rollup information for this commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    submodules (SubmoduleConnection!)

    Returns a list of all submodules in this repository as of this Commit parsed from the .gitmodules file.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    tarballUrl (URI!)

    Returns a URL to download a tarball archive for a repository.\nNote: For private repositories, these links are temporary and expire after five minutes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    tree (Tree!)

    Commit's root Tree.

    \n\n\n\n\n\n\n\n\n\n\n\n

    treeResourcePath (URI!)

    The HTTP path for the tree of this commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    treeUrl (URI!)

    The HTTP URL for the tree of this commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanSubscribe (Boolean!)

    Check if the viewer is able to change their subscription status for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerSubscription (SubscriptionState)

    Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

    \n\n\n\n\n\n\n\n\n\n\n\n

    zipballUrl (URI!)

    Returns a URL to download a zipball archive for a repository.\nNote: For private repositories, these links are temporary and expire after five minutes.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CommitComment\n

    \n

    Represents a comment on a given Commit.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    author (Actor)

    The actor who authored the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    authorAssociation (CommentAuthorAssociation!)

    Author's association with the subject of the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    body (String!)

    Identifies the comment body.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyHTML (HTML!)

    The body rendered to HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyText (String!)

    The body rendered to text.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commit (Commit)

    Identifies the commit associated with the comment, if the commit exists.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdViaEmail (Boolean!)

    Check if this comment was created via an email reply.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    editor (Actor)

    The actor who edited the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    includesCreatedEdit (Boolean!)

    Check if this comment was edited and includes an edit with the creation data.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isMinimized (Boolean!)

    Returns whether or not a comment has been minimized.

    \n\n\n\n\n\n\n\n\n\n\n\n

    lastEditedAt (DateTime)

    The moment the editor made the last edit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    minimizedReason (String)

    Returns why the comment was minimized.

    \n\n\n\n\n\n\n\n\n\n\n\n

    path (String)

    Identifies the file path associated with the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    position (Int)

    Identifies the line position associated with the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    publishedAt (DateTime)

    Identifies when the comment was published at.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reactionGroups ([ReactionGroup!])

    A list of reactions grouped by content left on the subject.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reactions (ReactionConnection!)

    A list of Reactions left on the Issue.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    content (ReactionContent)

    \n

    Allows filtering Reactions by emoji.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (ReactionOrder)

    \n

    Allows specifying the order in which reactions are returned.

    \n\n
    \n\n
    \n\n\n

    repository (Repository!)

    The repository associated with this node.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path permalink for this commit comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL permalink for this commit comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userContentEdits (UserContentEditConnection)

    A list of edits to this content.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    viewerCanDelete (Boolean!)

    Check if the current viewer can delete this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanMinimize (Boolean!)

    Check if the current viewer can minimize this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanReact (Boolean!)

    Can user react to this subject.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanUpdate (Boolean!)

    Check if the current viewer can update this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

    Reasons why the current viewer can not update this comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerDidAuthor (Boolean!)

    Did the viewer author this comment.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CommitCommentConnection\n

    \n

    The connection type for CommitComment.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([CommitCommentEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([CommitComment])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CommitCommentEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (CommitComment)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CommitCommentThread\n

    \n

    A thread of comments on a commit.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    comments (CommitCommentConnection!)

    The comments that exist in this thread.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    commit (Commit)

    The commit the comments were made on.

    \n\n\n\n\n\n\n\n\n\n\n\n

    path (String)

    The file the comments were made on.

    \n\n\n\n\n\n\n\n\n\n\n\n

    position (Int)

    The position in the diff for the commit that the comment was made on.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository!)

    The repository associated with this node.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CommitConnection\n

    \n

    The connection type for Commit.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([CommitEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Commit])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CommitContributionsByRepository\n

    \n

    This aggregates commits made by a user within one repository.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    contributions (CreatedCommitContributionConnection!)

    The commit contributions, each representing a day.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (CommitContributionOrder)

    \n

    Ordering options for commit contributions returned from the connection.

    \n\n
    \n\n
    \n\n\n

    repository (Repository!)

    The repository in which the commits were made.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for the user's commits to the repository in this time range.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for the user's commits to the repository in this time range.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CommitEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (Commit)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CommitHistoryConnection\n

    \n

    The connection type for Commit.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([CommitEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Commit])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ConnectedEvent\n

    \n

    Represents aconnectedevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isCrossRepository (Boolean!)

    Reference originated in a different repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    source (ReferencedSubject!)

    Issue or pull request that made the reference.

    \n\n\n\n\n\n\n\n\n\n\n\n

    subject (ReferencedSubject!)

    Issue or pull request which was connected.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ContentAttachment\n

    \n

    A content attachment.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String!)

    The body text of the content attachment. This parameter supports markdown.

    \n\n\n\n\n\n\n\n\n\n\n\n

    contentReference (ContentReference!)

    The content reference that the content attachment is attached to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int!)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    title (String!)

    The title of the content attachment.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ContentReference\n

    \n

    A content reference.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    databaseId (Int!)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reference (String!)

    The reference of the content reference.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ContributionCalendar\n

    \n

    A calendar of contributions made on GitHub by a user.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    colors ([String!]!)

    A list of hex color codes used in this calendar. The darker the color, the more contributions it represents.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isHalloween (Boolean!)

    Determine if the color set was chosen because it's currently Halloween.

    \n\n\n\n\n\n\n\n\n\n\n\n

    months ([ContributionCalendarMonth!]!)

    A list of the months of contributions in this calendar.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalContributions (Int!)

    The count of total contributions in the calendar.

    \n\n\n\n\n\n\n\n\n\n\n\n

    weeks ([ContributionCalendarWeek!]!)

    A list of the weeks of contributions in this calendar.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ContributionCalendarDay\n

    \n

    Represents a single day of contributions on GitHub by a user.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    color (String!)

    The hex color code that represents how many contributions were made on this day compared to others in the calendar.

    \n\n\n\n\n\n\n\n\n\n\n\n

    contributionCount (Int!)

    How many contributions were made by the user on this day.

    \n\n\n\n\n\n\n\n\n\n\n\n

    contributionLevel (ContributionLevel!)

    Indication of contributions, relative to other days. Can be used to indicate\nwhich color to represent this day on a calendar.

    \n\n\n\n\n\n\n\n\n\n\n\n

    date (Date!)

    The day this square represents.

    \n\n\n\n\n\n\n\n\n\n\n\n

    weekday (Int!)

    A number representing which day of the week this square represents, e.g., 1 is Monday.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ContributionCalendarMonth\n

    \n

    A month of contributions in a user's contribution graph.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    firstDay (Date!)

    The date of the first day of this month.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The name of the month.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalWeeks (Int!)

    How many weeks started in this month.

    \n\n\n\n\n\n\n\n\n\n\n\n

    year (Int!)

    The year the month occurred in.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ContributionCalendarWeek\n

    \n

    A week of contributions in a user's contribution graph.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    contributionDays ([ContributionCalendarDay!]!)

    The days of contributions in this week.

    \n\n\n\n\n\n\n\n\n\n\n\n

    firstDay (Date!)

    The date of the earliest square in this week.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ContributionsCollection\n

    \n

    A contributions collection aggregates contributions such as opened issues and commits created by a user.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    commitContributionsByRepository ([CommitContributionsByRepository!]!)

    Commit contributions made by the user, grouped by repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    maxRepositories (Int)

    \n

    How many repositories should be included.

    \n

    The default value is 25.

    \n
    \n\n
    \n\n\n

    contributionCalendar (ContributionCalendar!)

    A calendar of this user's contributions on GitHub.

    \n\n\n\n\n\n\n\n\n\n\n\n

    contributionYears ([Int!]!)

    The years the user has been making contributions with the most recent year first.

    \n\n\n\n\n\n\n\n\n\n\n\n

    doesEndInCurrentMonth (Boolean!)

    Determine if this collection's time span ends in the current month.

    \n\n\n\n\n\n\n\n\n\n\n\n

    earliestRestrictedContributionDate (Date)

    The date of the first restricted contribution the user made in this time\nperiod. Can only be non-null when the user has enabled private contribution counts.

    \n\n\n\n\n\n\n\n\n\n\n\n

    endedAt (DateTime!)

    The ending date and time of this collection.

    \n\n\n\n\n\n\n\n\n\n\n\n

    firstIssueContribution (CreatedIssueOrRestrictedContribution)

    The first issue the user opened on GitHub. This will be null if that issue was\nopened outside the collection's time range and ignoreTimeRange is false. If\nthe issue is not visible but the user has opted to show private contributions,\na RestrictedContribution will be returned.

    \n\n\n\n\n\n\n\n\n\n\n\n

    firstPullRequestContribution (CreatedPullRequestOrRestrictedContribution)

    The first pull request the user opened on GitHub. This will be null if that\npull request was opened outside the collection's time range and\nignoreTimeRange is not true. If the pull request is not visible but the user\nhas opted to show private contributions, a RestrictedContribution will be returned.

    \n\n\n\n\n\n\n\n\n\n\n\n

    firstRepositoryContribution (CreatedRepositoryOrRestrictedContribution)

    The first repository the user created on GitHub. This will be null if that\nfirst repository was created outside the collection's time range and\nignoreTimeRange is false. If the repository is not visible, then a\nRestrictedContribution is returned.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hasActivityInThePast (Boolean!)

    Does the user have any more activity in the timeline that occurred prior to the collection's time range?.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hasAnyContributions (Boolean!)

    Determine if there are any contributions in this collection.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hasAnyRestrictedContributions (Boolean!)

    Determine if the user made any contributions in this time frame whose details\nare not visible because they were made in a private repository. Can only be\ntrue if the user enabled private contribution counts.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isSingleDay (Boolean!)

    Whether or not the collector's time span is all within the same day.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issueContributions (CreatedIssueContributionConnection!)

    A list of issues the user opened.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    excludeFirst (Boolean)

    \n

    Should the user's first issue ever be excluded from the result.

    \n

    The default value is false.

    \n
    \n\n
    \n

    excludePopular (Boolean)

    \n

    Should the user's most commented issue be excluded from the result.

    \n

    The default value is false.

    \n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (ContributionOrder)

    \n

    Ordering options for contributions returned from the connection.

    \n\n
    \n\n
    \n\n\n

    issueContributionsByRepository ([IssueContributionsByRepository!]!)

    Issue contributions made by the user, grouped by repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    excludeFirst (Boolean)

    \n

    Should the user's first issue ever be excluded from the result.

    \n

    The default value is false.

    \n
    \n\n
    \n

    excludePopular (Boolean)

    \n

    Should the user's most commented issue be excluded from the result.

    \n

    The default value is false.

    \n
    \n\n
    \n

    maxRepositories (Int)

    \n

    How many repositories should be included.

    \n

    The default value is 25.

    \n
    \n\n
    \n\n\n

    joinedGitHubContribution (JoinedGitHubContribution)

    When the user signed up for GitHub. This will be null if that sign up date\nfalls outside the collection's time range and ignoreTimeRange is false.

    \n\n\n\n\n\n\n\n\n\n\n\n

    latestRestrictedContributionDate (Date)

    The date of the most recent restricted contribution the user made in this time\nperiod. Can only be non-null when the user has enabled private contribution counts.

    \n\n\n\n\n\n\n\n\n\n\n\n

    mostRecentCollectionWithActivity (ContributionsCollection)

    When this collection's time range does not include any activity from the user, use this\nto get a different collection from an earlier time range that does have activity.

    \n\n\n\n\n\n\n\n\n\n\n\n

    mostRecentCollectionWithoutActivity (ContributionsCollection)

    Returns a different contributions collection from an earlier time range than this one\nthat does not have any contributions.

    \n\n\n\n\n\n\n\n\n\n\n\n

    popularIssueContribution (CreatedIssueContribution)

    The issue the user opened on GitHub that received the most comments in the specified\ntime frame.

    \n\n\n\n\n\n\n\n\n\n\n\n

    popularPullRequestContribution (CreatedPullRequestContribution)

    The pull request the user opened on GitHub that received the most comments in the\nspecified time frame.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestContributions (CreatedPullRequestContributionConnection!)

    Pull request contributions made by the user.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    excludeFirst (Boolean)

    \n

    Should the user's first pull request ever be excluded from the result.

    \n

    The default value is false.

    \n
    \n\n
    \n

    excludePopular (Boolean)

    \n

    Should the user's most commented pull request be excluded from the result.

    \n

    The default value is false.

    \n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (ContributionOrder)

    \n

    Ordering options for contributions returned from the connection.

    \n\n
    \n\n
    \n\n\n

    pullRequestContributionsByRepository ([PullRequestContributionsByRepository!]!)

    Pull request contributions made by the user, grouped by repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    excludeFirst (Boolean)

    \n

    Should the user's first pull request ever be excluded from the result.

    \n

    The default value is false.

    \n
    \n\n
    \n

    excludePopular (Boolean)

    \n

    Should the user's most commented pull request be excluded from the result.

    \n

    The default value is false.

    \n
    \n\n
    \n

    maxRepositories (Int)

    \n

    How many repositories should be included.

    \n

    The default value is 25.

    \n
    \n\n
    \n\n\n

    pullRequestReviewContributions (CreatedPullRequestReviewContributionConnection!)

    Pull request review contributions made by the user.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (ContributionOrder)

    \n

    Ordering options for contributions returned from the connection.

    \n\n
    \n\n
    \n\n\n

    pullRequestReviewContributionsByRepository ([PullRequestReviewContributionsByRepository!]!)

    Pull request review contributions made by the user, grouped by repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    maxRepositories (Int)

    \n

    How many repositories should be included.

    \n

    The default value is 25.

    \n
    \n\n
    \n\n\n

    repositoryContributions (CreatedRepositoryContributionConnection!)

    A list of repositories owned by the user that the user created in this time range.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    excludeFirst (Boolean)

    \n

    Should the user's first repository ever be excluded from the result.

    \n

    The default value is false.

    \n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (ContributionOrder)

    \n

    Ordering options for contributions returned from the connection.

    \n\n
    \n\n
    \n\n\n

    restrictedContributionsCount (Int!)

    A count of contributions made by the user that the viewer cannot access. Only\nnon-zero when the user has chosen to share their private contribution counts.

    \n\n\n\n\n\n\n\n\n\n\n\n

    startedAt (DateTime!)

    The beginning date and time of this collection.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCommitContributions (Int!)

    How many commits were made by the user in this time span.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalIssueContributions (Int!)

    How many issues the user opened.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    excludeFirst (Boolean)

    \n

    Should the user's first issue ever be excluded from this count.

    \n

    The default value is false.

    \n
    \n\n
    \n

    excludePopular (Boolean)

    \n

    Should the user's most commented issue be excluded from this count.

    \n

    The default value is false.

    \n
    \n\n
    \n\n\n

    totalPullRequestContributions (Int!)

    How many pull requests the user opened.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    excludeFirst (Boolean)

    \n

    Should the user's first pull request ever be excluded from this count.

    \n

    The default value is false.

    \n
    \n\n
    \n

    excludePopular (Boolean)

    \n

    Should the user's most commented pull request be excluded from this count.

    \n

    The default value is false.

    \n
    \n\n
    \n\n\n

    totalPullRequestReviewContributions (Int!)

    How many pull request reviews the user left.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalRepositoriesWithContributedCommits (Int!)

    How many different repositories the user committed to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalRepositoriesWithContributedIssues (Int!)

    How many different repositories the user opened issues in.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    excludeFirst (Boolean)

    \n

    Should the user's first issue ever be excluded from this count.

    \n

    The default value is false.

    \n
    \n\n
    \n

    excludePopular (Boolean)

    \n

    Should the user's most commented issue be excluded from this count.

    \n

    The default value is false.

    \n
    \n\n
    \n\n\n

    totalRepositoriesWithContributedPullRequestReviews (Int!)

    How many different repositories the user left pull request reviews in.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalRepositoriesWithContributedPullRequests (Int!)

    How many different repositories the user opened pull requests in.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    excludeFirst (Boolean)

    \n

    Should the user's first pull request ever be excluded from this count.

    \n

    The default value is false.

    \n
    \n\n
    \n

    excludePopular (Boolean)

    \n

    Should the user's most commented pull request be excluded from this count.

    \n

    The default value is false.

    \n
    \n\n
    \n\n\n

    totalRepositoryContributions (Int!)

    How many repositories the user created.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    excludeFirst (Boolean)

    \n

    Should the user's first repository ever be excluded from this count.

    \n

    The default value is false.

    \n
    \n\n
    \n\n\n

    user (User!)

    The user who made the contributions in this collection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ConvertToDraftEvent\n

    \n

    Represents aconvert_to_draftevent on a given pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    PullRequest referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this convert to draft event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this convert to draft event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ConvertedNoteToIssueEvent\n

    \n

    Represents aconverted_note_to_issueevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    project (Project)

    Project referenced by event.

    \n\n\n\n\n
    \n

    Preview notice

    \n

    project is available under the Project event details preview. During the preview period, the API may change without notice.

    \n
    \n\n\n\n\n\n\n\n\n

    projectCard (ProjectCard)

    Project card referenced by this project event.

    \n\n\n\n\n
    \n

    Preview notice

    \n

    projectCard is available under the Project event details preview. During the preview period, the API may change without notice.

    \n
    \n\n\n\n\n\n\n\n\n

    projectColumnName (String!)

    Column name referenced by this project event.

    \n\n\n\n\n
    \n

    Preview notice

    \n

    projectColumnName is available under the Project event details preview. During the preview period, the API may change without notice.

    \n
    \n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CreatedCommitContribution\n

    \n

    Represents the contribution a user made by committing to a repository.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    commitCount (Int!)

    How many commits were made on this day to this repository by the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isRestricted (Boolean!)

    Whether this contribution is associated with a record you do not have access to. For\nexample, your own 'first issue' contribution may have been made on a repository you can no\nlonger access.

    \n\n\n\n\n\n\n\n\n\n\n\n

    occurredAt (DateTime!)

    When this contribution was made.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository!)

    The repository the user made a commit in.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User!)

    The user who made this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CreatedCommitContributionConnection\n

    \n

    The connection type for CreatedCommitContribution.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([CreatedCommitContributionEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([CreatedCommitContribution])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of commits across days and repositories in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CreatedCommitContributionEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (CreatedCommitContribution)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CreatedIssueContribution\n

    \n

    Represents the contribution a user made on GitHub by opening an issue.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    isRestricted (Boolean!)

    Whether this contribution is associated with a record you do not have access to. For\nexample, your own 'first issue' contribution may have been made on a repository you can no\nlonger access.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issue (Issue!)

    The issue that was opened.

    \n\n\n\n\n\n\n\n\n\n\n\n

    occurredAt (DateTime!)

    When this contribution was made.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User!)

    The user who made this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CreatedIssueContributionConnection\n

    \n

    The connection type for CreatedIssueContribution.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([CreatedIssueContributionEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([CreatedIssueContribution])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CreatedIssueContributionEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (CreatedIssueContribution)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CreatedPullRequestContribution\n

    \n

    Represents the contribution a user made on GitHub by opening a pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    isRestricted (Boolean!)

    Whether this contribution is associated with a record you do not have access to. For\nexample, your own 'first issue' contribution may have been made on a repository you can no\nlonger access.

    \n\n\n\n\n\n\n\n\n\n\n\n

    occurredAt (DateTime!)

    When this contribution was made.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    The pull request that was opened.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User!)

    The user who made this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CreatedPullRequestContributionConnection\n

    \n

    The connection type for CreatedPullRequestContribution.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([CreatedPullRequestContributionEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([CreatedPullRequestContribution])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CreatedPullRequestContributionEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (CreatedPullRequestContribution)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CreatedPullRequestReviewContribution\n

    \n

    Represents the contribution a user made by leaving a review on a pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    isRestricted (Boolean!)

    Whether this contribution is associated with a record you do not have access to. For\nexample, your own 'first issue' contribution may have been made on a repository you can no\nlonger access.

    \n\n\n\n\n\n\n\n\n\n\n\n

    occurredAt (DateTime!)

    When this contribution was made.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    The pull request the user reviewed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestReview (PullRequestReview!)

    The review the user left on the pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository!)

    The repository containing the pull request that the user reviewed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User!)

    The user who made this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CreatedPullRequestReviewContributionConnection\n

    \n

    The connection type for CreatedPullRequestReviewContribution.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([CreatedPullRequestReviewContributionEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([CreatedPullRequestReviewContribution])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CreatedPullRequestReviewContributionEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (CreatedPullRequestReviewContribution)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CreatedRepositoryContribution\n

    \n

    Represents the contribution a user made on GitHub by creating a repository.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    isRestricted (Boolean!)

    Whether this contribution is associated with a record you do not have access to. For\nexample, your own 'first issue' contribution may have been made on a repository you can no\nlonger access.

    \n\n\n\n\n\n\n\n\n\n\n\n

    occurredAt (DateTime!)

    When this contribution was made.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository!)

    The repository that was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User!)

    The user who made this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CreatedRepositoryContributionConnection\n

    \n

    The connection type for CreatedRepositoryContribution.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([CreatedRepositoryContributionEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([CreatedRepositoryContribution])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CreatedRepositoryContributionEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (CreatedRepositoryContribution)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CrossReferencedEvent\n

    \n

    Represents a mention made by one issue or pull request to another.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isCrossRepository (Boolean!)

    Reference originated in a different repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    referencedAt (DateTime!)

    Identifies when the reference was made.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    source (ReferencedSubject!)

    Issue or pull request that made the reference.

    \n\n\n\n\n\n\n\n\n\n\n\n

    target (ReferencedSubject!)

    Issue or pull request to which the reference was made.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    willCloseTarget (Boolean!)

    Checks if the target will be closed when the source is merged.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n DemilestonedEvent\n

    \n

    Represents ademilestonedevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    milestoneTitle (String!)

    Identifies the milestone title associated with thedemilestonedevent.

    \n\n\n\n\n\n\n\n\n\n\n\n

    subject (MilestoneItem!)

    Object referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n DependencyGraphDependency\n

    \n

    A dependency manifest entry.

    \n
    \n\n
    \n \n
    \n

    Preview notice

    \n

    DependencyGraphDependency is available under the Access to a repositories dependency graph preview. During the preview period, the API may change without notice.

    \n
    \n\n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    hasDependencies (Boolean!)

    Does the dependency itself have dependencies?.

    \n\n\n\n\n\n\n\n\n\n\n\n

    packageManager (String)

    The dependency package manager.

    \n\n\n\n\n\n\n\n\n\n\n\n

    packageName (String!)

    The required package name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository containing the package.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requirements (String!)

    The dependency version requirements.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n DependencyGraphDependencyConnection\n

    \n

    The connection type for DependencyGraphDependency.

    \n
    \n\n
    \n \n
    \n

    Preview notice

    \n

    DependencyGraphDependencyConnection is available under the Access to a repositories dependency graph preview. During the preview period, the API may change without notice.

    \n
    \n\n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([DependencyGraphDependencyEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([DependencyGraphDependency])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n DependencyGraphDependencyEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n
    \n

    Preview notice

    \n

    DependencyGraphDependencyEdge is available under the Access to a repositories dependency graph preview. During the preview period, the API may change without notice.

    \n
    \n\n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (DependencyGraphDependency)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n DependencyGraphManifest\n

    \n

    Dependency manifest for a repository.

    \n
    \n\n
    \n \n
    \n

    Preview notice

    \n

    DependencyGraphManifest is available under the Access to a repositories dependency graph preview. During the preview period, the API may change without notice.

    \n
    \n\n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    blobPath (String!)

    Path to view the manifest file blob.

    \n\n\n\n\n\n\n\n\n\n\n\n

    dependencies (DependencyGraphDependencyConnection)

    A list of manifest dependencies.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    dependenciesCount (Int)

    The number of dependencies listed in the manifest.

    \n\n\n\n\n\n\n\n\n\n\n\n

    exceedsMaxSize (Boolean!)

    Is the manifest too big to parse?.

    \n\n\n\n\n\n\n\n\n\n\n\n

    filename (String!)

    Fully qualified manifest filename.

    \n\n\n\n\n\n\n\n\n\n\n\n

    parseable (Boolean!)

    Were we able to parse the manifest?.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository!)

    The repository containing the manifest.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n DependencyGraphManifestConnection\n

    \n

    The connection type for DependencyGraphManifest.

    \n
    \n\n
    \n \n
    \n

    Preview notice

    \n

    DependencyGraphManifestConnection is available under the Access to a repositories dependency graph preview. During the preview period, the API may change without notice.

    \n
    \n\n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([DependencyGraphManifestEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([DependencyGraphManifest])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n DependencyGraphManifestEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n
    \n

    Preview notice

    \n

    DependencyGraphManifestEdge is available under the Access to a repositories dependency graph preview. During the preview period, the API may change without notice.

    \n
    \n\n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (DependencyGraphManifest)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n DeployKey\n

    \n

    A repository deploy key.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    key (String!)

    The deploy key.

    \n\n\n\n\n\n\n\n\n\n\n\n

    readOnly (Boolean!)

    Whether or not the deploy key is read only.

    \n\n\n\n\n\n\n\n\n\n\n\n

    title (String!)

    The deploy key title.

    \n\n\n\n\n\n\n\n\n\n\n\n

    verified (Boolean!)

    Whether or not the deploy key has been verified.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n DeployKeyConnection\n

    \n

    The connection type for DeployKey.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([DeployKeyEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([DeployKey])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n DeployKeyEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (DeployKey)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n DeployedEvent\n

    \n

    Represents adeployedevent on a given pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    deployment (Deployment!)

    The deployment associated with thedeployedevent.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    PullRequest referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ref (Ref)

    The ref associated with thedeployedevent.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Deployment\n

    \n

    Represents triggered deployment instance.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    commit (Commit)

    Identifies the commit sha of the deployment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commitOid (String!)

    Identifies the oid of the deployment commit, even if the commit has been deleted.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    creator (Actor!)

    Identifies the actor who triggered the deployment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String)

    The deployment description.

    \n\n\n\n\n\n\n\n\n\n\n\n

    environment (String)

    The latest environment to which this deployment was made.

    \n\n\n\n\n\n\n\n\n\n\n\n

    latestEnvironment (String)

    The latest environment to which this deployment was made.

    \n\n\n\n\n\n\n\n\n\n\n\n

    latestStatus (DeploymentStatus)

    The latest status of this deployment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    originalEnvironment (String)

    The original environment to which this deployment was made.

    \n\n\n\n\n\n\n\n\n\n\n\n

    payload (String)

    Extra information that a deployment system might need.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ref (Ref)

    Identifies the Ref of the deployment, if the deployment was created by ref.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository!)

    Identifies the repository associated with the deployment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    state (DeploymentState)

    The current state of the deployment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    statuses (DeploymentStatusConnection)

    A list of statuses associated with the deployment.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    task (String)

    The deployment task.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n DeploymentConnection\n

    \n

    The connection type for Deployment.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([DeploymentEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Deployment])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n DeploymentEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (Deployment)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n DeploymentEnvironmentChangedEvent\n

    \n

    Represents adeployment_environment_changedevent on a given pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    deploymentStatus (DeploymentStatus!)

    The deployment status that updated the deployment environment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    PullRequest referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n DeploymentStatus\n

    \n

    Describes the status of a given deployment attempt.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    creator (Actor!)

    Identifies the actor who triggered the deployment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    deployment (Deployment!)

    Identifies the deployment associated with status.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String)

    Identifies the description of the deployment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    environment (String)

    Identifies the environment of the deployment at the time of this deployment status.

    \n\n\n\n\n
    \n

    Preview notice

    \n

    environment is available under the Deployments preview. During the preview period, the API may change without notice.

    \n
    \n\n\n\n\n\n\n\n\n

    environmentUrl (URI)

    Identifies the environment URL of the deployment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    logUrl (URI)

    Identifies the log URL of the deployment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    state (DeploymentStatusState!)

    Identifies the current state of the deployment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n DeploymentStatusConnection\n

    \n

    The connection type for DeploymentStatus.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([DeploymentStatusEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([DeploymentStatus])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n DeploymentStatusEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (DeploymentStatus)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n DisconnectedEvent\n

    \n

    Represents adisconnectedevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isCrossRepository (Boolean!)

    Reference originated in a different repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    source (ReferencedSubject!)

    Issue or pull request from which the issue was disconnected.

    \n\n\n\n\n\n\n\n\n\n\n\n

    subject (ReferencedSubject!)

    Issue or pull request which was disconnected.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Enterprise\n

    \n

    An account to manage multiple organizations with consolidated policy and billing.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    avatarUrl (URI!)

    A URL pointing to the enterprise's public avatar.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    size (Int)

    \n

    The size of the resulting square image.

    \n\n
    \n\n
    \n\n\n

    billingInfo (EnterpriseBillingInfo)

    Enterprise billing information visible to enterprise billing managers.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String)

    The description of the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    descriptionHTML (HTML!)

    The description of the enterprise as HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    location (String)

    The location of the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    members (EnterpriseMemberConnection!)

    A list of users who are members of this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    deployment (EnterpriseUserDeployment)

    \n

    Only return members within the selected GitHub Enterprise deployment.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (EnterpriseMemberOrder)

    \n

    Ordering options for members returned from the connection.

    \n\n
    \n\n
    \n

    organizationLogins ([String!])

    \n

    Only return members within the organizations with these logins.

    \n\n
    \n\n
    \n

    query (String)

    \n

    The search string to look for.

    \n\n
    \n\n
    \n

    role (EnterpriseUserAccountMembershipRole)

    \n

    The role of the user in the enterprise organization or server.

    \n\n
    \n\n
    \n\n\n

    name (String!)

    The name of the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizations (OrganizationConnection!)

    A list of organizations that belong to this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (OrganizationOrder)

    \n

    Ordering options for organizations returned from the connection.

    \n\n
    \n\n
    \n

    query (String)

    \n

    The search string to look for.

    \n\n
    \n\n
    \n\n\n

    ownerInfo (EnterpriseOwnerInfo)

    Enterprise information only visible to enterprise owners.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    slug (String!)

    The URL-friendly identifier for the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userAccounts (EnterpriseUserAccountConnection!)

    A list of user accounts on this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    viewerIsAdmin (Boolean!)

    Is the current viewer an admin of this enterprise?.

    \n\n\n\n\n\n\n\n\n\n\n\n

    websiteUrl (URI)

    The URL of the enterprise website.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseAdministratorConnection\n

    \n

    The connection type for User.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([EnterpriseAdministratorEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([User])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseAdministratorEdge\n

    \n

    A User who is an administrator of an enterprise.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (User)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n

    role (EnterpriseAdministratorRole!)

    The role of the administrator.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseAdministratorInvitation\n

    \n

    An invitation for a user to become an owner or billing manager of an enterprise.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    email (String)

    The email of the person who was invited to the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterprise (Enterprise!)

    The enterprise the invitation is for.

    \n\n\n\n\n\n\n\n\n\n\n\n

    invitee (User)

    The user who was invited to the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    inviter (User)

    The user who created the invitation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    role (EnterpriseAdministratorRole!)

    The invitee's pending role in the enterprise (owner or billing_manager).

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseAdministratorInvitationConnection\n

    \n

    The connection type for EnterpriseAdministratorInvitation.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([EnterpriseAdministratorInvitationEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([EnterpriseAdministratorInvitation])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseAdministratorInvitationEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (EnterpriseAdministratorInvitation)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseBillingInfo\n

    \n

    Enterprise billing information visible to enterprise billing managers and owners.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    allLicensableUsersCount (Int!)

    The number of licenseable users/emails across the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    assetPacks (Int!)

    The number of data packs used by all organizations owned by the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    availableSeats (Int!)

    The number of available seats across all owned organizations based on the unique number of billable users.

    \n\n\n\n\n\n\n
    \n

    Deprecation notice

    \n

    availableSeats is deprecated.

    availableSeats will be replaced with totalAvailableLicenses to provide more clarity on the value being returned Use EnterpriseBillingInfo.totalAvailableLicenses instead. Removal on 2020-01-01 UTC.

    \n
    \n\n\n\n\n\n\n

    bandwidthQuota (Float!)

    The bandwidth quota in GB for all organizations owned by the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bandwidthUsage (Float!)

    The bandwidth usage in GB for all organizations owned by the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bandwidthUsagePercentage (Int!)

    The bandwidth usage as a percentage of the bandwidth quota.

    \n\n\n\n\n\n\n\n\n\n\n\n

    seats (Int!)

    The total seats across all organizations owned by the enterprise.

    \n\n\n\n\n\n\n
    \n

    Deprecation notice

    \n

    seats is deprecated.

    seats will be replaced with totalLicenses to provide more clarity on the value being returned Use EnterpriseBillingInfo.totalLicenses instead. Removal on 2020-01-01 UTC.

    \n
    \n\n\n\n\n\n\n

    storageQuota (Float!)

    The storage quota in GB for all organizations owned by the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    storageUsage (Float!)

    The storage usage in GB for all organizations owned by the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    storageUsagePercentage (Int!)

    The storage usage as a percentage of the storage quota.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalAvailableLicenses (Int!)

    The number of available licenses across all owned organizations based on the unique number of billable users.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalLicenses (Int!)

    The total number of licenses allocated.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseIdentityProvider\n

    \n

    An identity provider configured to provision identities for an enterprise.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    digestMethod (SamlDigestAlgorithm)

    The digest algorithm used to sign SAML requests for the identity provider.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterprise (Enterprise)

    The enterprise this identity provider belongs to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    externalIdentities (ExternalIdentityConnection!)

    ExternalIdentities provisioned by this identity provider.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    idpCertificate (X509Certificate)

    The x509 certificate used by the identity provider to sign assertions and responses.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issuer (String)

    The Issuer Entity ID for the SAML identity provider.

    \n\n\n\n\n\n\n\n\n\n\n\n

    recoveryCodes ([String!])

    Recovery codes that can be used by admins to access the enterprise if the identity provider is unavailable.

    \n\n\n\n\n\n\n\n\n\n\n\n

    signatureMethod (SamlSignatureAlgorithm)

    The signature algorithm used to sign SAML requests for the identity provider.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ssoUrl (URI)

    The URL endpoint for the identity provider's SAML SSO.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseMemberConnection\n

    \n

    The connection type for EnterpriseMember.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([EnterpriseMemberEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([EnterpriseMember])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseMemberEdge\n

    \n

    A User who is a member of an enterprise through one or more organizations.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isUnlicensed (Boolean!)

    Whether the user does not have a license for the enterprise.

    \n\n\n\n\n\n\n
    \n

    Deprecation notice

    \n

    isUnlicensed is deprecated.

    All members consume a license Removal on 2021-01-01 UTC.

    \n
    \n\n\n\n\n\n\n

    node (EnterpriseMember)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseOrganizationMembershipConnection\n

    \n

    The connection type for Organization.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([EnterpriseOrganizationMembershipEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Organization])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseOrganizationMembershipEdge\n

    \n

    An enterprise organization that a user is a member of.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (Organization)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n

    role (EnterpriseUserAccountMembershipRole!)

    The role of the user in the enterprise membership.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseOutsideCollaboratorConnection\n

    \n

    The connection type for User.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([EnterpriseOutsideCollaboratorEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([User])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseOutsideCollaboratorEdge\n

    \n

    A User who is an outside collaborator of an enterprise through one or more organizations.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isUnlicensed (Boolean!)

    Whether the outside collaborator does not have a license for the enterprise.

    \n\n\n\n\n\n\n
    \n

    Deprecation notice

    \n

    isUnlicensed is deprecated.

    All outside collaborators consume a license Removal on 2021-01-01 UTC.

    \n
    \n\n\n\n\n\n\n

    node (User)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositories (EnterpriseRepositoryInfoConnection!)

    The enterprise organization repositories this user is a member of.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (RepositoryOrder)

    \n

    Ordering options for repositories.

    \n\n
    \n\n
    \n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseOwnerInfo\n

    \n

    Enterprise information only visible to enterprise owners.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    admins (EnterpriseAdministratorConnection!)

    A list of all of the administrators for this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (EnterpriseMemberOrder)

    \n

    Ordering options for administrators returned from the connection.

    \n\n
    \n\n
    \n

    query (String)

    \n

    The search string to look for.

    \n\n
    \n\n
    \n

    role (EnterpriseAdministratorRole)

    \n

    The role to filter by.

    \n\n
    \n\n
    \n\n\n

    affiliatedUsersWithTwoFactorDisabled (UserConnection!)

    A list of users in the enterprise who currently have two-factor authentication disabled.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    affiliatedUsersWithTwoFactorDisabledExist (Boolean!)

    Whether or not affiliated users with two-factor authentication disabled exist in the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    allowPrivateRepositoryForkingSetting (EnterpriseEnabledDisabledSettingValue!)

    The setting value for whether private repository forking is enabled for repositories in organizations in this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    allowPrivateRepositoryForkingSettingOrganizations (OrganizationConnection!)

    A list of enterprise organizations configured with the provided private repository forking setting value.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (OrganizationOrder)

    \n

    Ordering options for organizations with this setting.

    \n\n
    \n\n
    \n

    value (Boolean!)

    \n

    The setting value to find organizations for.

    \n\n
    \n\n
    \n\n\n

    defaultRepositoryPermissionSetting (EnterpriseDefaultRepositoryPermissionSettingValue!)

    The setting value for base repository permissions for organizations in this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    defaultRepositoryPermissionSettingOrganizations (OrganizationConnection!)

    A list of enterprise organizations configured with the provided default repository permission.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (OrganizationOrder)

    \n

    Ordering options for organizations with this setting.

    \n\n
    \n\n
    \n

    value (DefaultRepositoryPermissionField!)

    \n

    The permission to find organizations for.

    \n\n
    \n\n
    \n\n\n

    domains (VerifiableDomainConnection!)

    A list of domains owned by the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    isVerified (Boolean)

    \n

    Filter whether or not the domain is verified.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (VerifiableDomainOrder)

    \n

    Ordering options for verifiable domains returned.

    \n\n
    \n\n
    \n\n\n

    enterpriseServerInstallations (EnterpriseServerInstallationConnection!)

    Enterprise Server installations owned by the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    connectedOnly (Boolean)

    \n

    Whether or not to only return installations discovered via GitHub Connect.

    \n

    The default value is false.

    \n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (EnterpriseServerInstallationOrder)

    \n

    Ordering options for Enterprise Server installations returned.

    \n\n
    \n\n
    \n\n\n

    ipAllowListEnabledSetting (IpAllowListEnabledSettingValue!)

    The setting value for whether the enterprise has an IP allow list enabled.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ipAllowListEntries (IpAllowListEntryConnection!)

    The IP addresses that are allowed to access resources owned by the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (IpAllowListEntryOrder)

    \n

    Ordering options for IP allow list entries returned.

    \n\n
    \n\n
    \n\n\n

    isUpdatingDefaultRepositoryPermission (Boolean!)

    Whether or not the default repository permission is currently being updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isUpdatingTwoFactorRequirement (Boolean!)

    Whether the two-factor authentication requirement is currently being enforced.

    \n\n\n\n\n\n\n\n\n\n\n\n

    membersCanChangeRepositoryVisibilitySetting (EnterpriseEnabledDisabledSettingValue!)

    The setting value for whether organization members with admin permissions on a\nrepository can change repository visibility.

    \n\n\n\n\n\n\n\n\n\n\n\n

    membersCanChangeRepositoryVisibilitySettingOrganizations (OrganizationConnection!)

    A list of enterprise organizations configured with the provided can change repository visibility setting value.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (OrganizationOrder)

    \n

    Ordering options for organizations with this setting.

    \n\n
    \n\n
    \n

    value (Boolean!)

    \n

    The setting value to find organizations for.

    \n\n
    \n\n
    \n\n\n

    membersCanCreateInternalRepositoriesSetting (Boolean)

    The setting value for whether members of organizations in the enterprise can create internal repositories.

    \n\n\n\n\n\n\n\n\n\n\n\n

    membersCanCreatePrivateRepositoriesSetting (Boolean)

    The setting value for whether members of organizations in the enterprise can create private repositories.

    \n\n\n\n\n\n\n\n\n\n\n\n

    membersCanCreatePublicRepositoriesSetting (Boolean)

    The setting value for whether members of organizations in the enterprise can create public repositories.

    \n\n\n\n\n\n\n\n\n\n\n\n

    membersCanCreateRepositoriesSetting (EnterpriseMembersCanCreateRepositoriesSettingValue)

    The setting value for whether members of organizations in the enterprise can create repositories.

    \n\n\n\n\n\n\n\n\n\n\n\n

    membersCanCreateRepositoriesSettingOrganizations (OrganizationConnection!)

    A list of enterprise organizations configured with the provided repository creation setting value.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (OrganizationOrder)

    \n

    Ordering options for organizations with this setting.

    \n\n
    \n\n
    \n

    value (OrganizationMembersCanCreateRepositoriesSettingValue!)

    \n

    The setting to find organizations for.

    \n\n
    \n\n
    \n\n\n

    membersCanDeleteIssuesSetting (EnterpriseEnabledDisabledSettingValue!)

    The setting value for whether members with admin permissions for repositories can delete issues.

    \n\n\n\n\n\n\n\n\n\n\n\n

    membersCanDeleteIssuesSettingOrganizations (OrganizationConnection!)

    A list of enterprise organizations configured with the provided members can delete issues setting value.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (OrganizationOrder)

    \n

    Ordering options for organizations with this setting.

    \n\n
    \n\n
    \n

    value (Boolean!)

    \n

    The setting value to find organizations for.

    \n\n
    \n\n
    \n\n\n

    membersCanDeleteRepositoriesSetting (EnterpriseEnabledDisabledSettingValue!)

    The setting value for whether members with admin permissions for repositories can delete or transfer repositories.

    \n\n\n\n\n\n\n\n\n\n\n\n

    membersCanDeleteRepositoriesSettingOrganizations (OrganizationConnection!)

    A list of enterprise organizations configured with the provided members can delete repositories setting value.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (OrganizationOrder)

    \n

    Ordering options for organizations with this setting.

    \n\n
    \n\n
    \n

    value (Boolean!)

    \n

    The setting value to find organizations for.

    \n\n
    \n\n
    \n\n\n

    membersCanInviteCollaboratorsSetting (EnterpriseEnabledDisabledSettingValue!)

    The setting value for whether members of organizations in the enterprise can invite outside collaborators.

    \n\n\n\n\n\n\n\n\n\n\n\n

    membersCanInviteCollaboratorsSettingOrganizations (OrganizationConnection!)

    A list of enterprise organizations configured with the provided members can invite collaborators setting value.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (OrganizationOrder)

    \n

    Ordering options for organizations with this setting.

    \n\n
    \n\n
    \n

    value (Boolean!)

    \n

    The setting value to find organizations for.

    \n\n
    \n\n
    \n\n\n

    membersCanMakePurchasesSetting (EnterpriseMembersCanMakePurchasesSettingValue!)

    Indicates whether members of this enterprise's organizations can purchase additional services for those organizations.

    \n\n\n\n\n\n\n\n\n\n\n\n

    membersCanUpdateProtectedBranchesSetting (EnterpriseEnabledDisabledSettingValue!)

    The setting value for whether members with admin permissions for repositories can update protected branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    membersCanUpdateProtectedBranchesSettingOrganizations (OrganizationConnection!)

    A list of enterprise organizations configured with the provided members can update protected branches setting value.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (OrganizationOrder)

    \n

    Ordering options for organizations with this setting.

    \n\n
    \n\n
    \n

    value (Boolean!)

    \n

    The setting value to find organizations for.

    \n\n
    \n\n
    \n\n\n

    membersCanViewDependencyInsightsSetting (EnterpriseEnabledDisabledSettingValue!)

    The setting value for whether members can view dependency insights.

    \n\n\n\n\n\n\n\n\n\n\n\n

    membersCanViewDependencyInsightsSettingOrganizations (OrganizationConnection!)

    A list of enterprise organizations configured with the provided members can view dependency insights setting value.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (OrganizationOrder)

    \n

    Ordering options for organizations with this setting.

    \n\n
    \n\n
    \n

    value (Boolean!)

    \n

    The setting value to find organizations for.

    \n\n
    \n\n
    \n\n\n

    notificationDeliveryRestrictionEnabledSetting (NotificationRestrictionSettingValue!)

    Indicates if email notification delivery for this enterprise is restricted to verified domains.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationProjectsSetting (EnterpriseEnabledDisabledSettingValue!)

    The setting value for whether organization projects are enabled for organizations in this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationProjectsSettingOrganizations (OrganizationConnection!)

    A list of enterprise organizations configured with the provided organization projects setting value.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (OrganizationOrder)

    \n

    Ordering options for organizations with this setting.

    \n\n
    \n\n
    \n

    value (Boolean!)

    \n

    The setting value to find organizations for.

    \n\n
    \n\n
    \n\n\n

    outsideCollaborators (EnterpriseOutsideCollaboratorConnection!)

    A list of outside collaborators across the repositories in the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    login (String)

    \n

    The login of one specific outside collaborator.

    \n\n
    \n\n
    \n

    orderBy (EnterpriseMemberOrder)

    \n

    Ordering options for outside collaborators returned from the connection.

    \n\n
    \n\n
    \n

    query (String)

    \n

    The search string to look for.

    \n\n
    \n\n
    \n

    visibility (RepositoryVisibility)

    \n

    Only return outside collaborators on repositories with this visibility.

    \n\n
    \n\n
    \n\n\n

    pendingAdminInvitations (EnterpriseAdministratorInvitationConnection!)

    A list of pending administrator invitations for the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (EnterpriseAdministratorInvitationOrder)

    \n

    Ordering options for pending enterprise administrator invitations returned from the connection.

    \n\n
    \n\n
    \n

    query (String)

    \n

    The search string to look for.

    \n\n
    \n\n
    \n

    role (EnterpriseAdministratorRole)

    \n

    The role to filter by.

    \n\n
    \n\n
    \n\n\n

    pendingCollaboratorInvitations (RepositoryInvitationConnection!)

    A list of pending collaborator invitations across the repositories in the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (RepositoryInvitationOrder)

    \n

    Ordering options for pending repository collaborator invitations returned from the connection.

    \n\n
    \n\n
    \n

    query (String)

    \n

    The search string to look for.

    \n\n
    \n\n
    \n\n\n

    pendingCollaborators (EnterprisePendingCollaboratorConnection!)

    A list of pending collaborators across the repositories in the enterprise.

    \n\n\n\n\n\n\n
    \n

    Deprecation notice

    \n

    pendingCollaborators is deprecated.

    Repository invitations can now be associated with an email, not only an invitee. Use the pendingCollaboratorInvitations field instead. Removal on 2020-10-01 UTC.

    \n
    \n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (RepositoryInvitationOrder)

    \n

    Ordering options for pending repository collaborator invitations returned from the connection.

    \n\n
    \n\n
    \n

    query (String)

    \n

    The search string to look for.

    \n\n
    \n\n
    \n\n\n

    pendingMemberInvitations (EnterprisePendingMemberInvitationConnection!)

    A list of pending member invitations for organizations in the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    query (String)

    \n

    The search string to look for.

    \n\n
    \n\n
    \n\n\n

    repositoryProjectsSetting (EnterpriseEnabledDisabledSettingValue!)

    The setting value for whether repository projects are enabled in this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryProjectsSettingOrganizations (OrganizationConnection!)

    A list of enterprise organizations configured with the provided repository projects setting value.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (OrganizationOrder)

    \n

    Ordering options for organizations with this setting.

    \n\n
    \n\n
    \n

    value (Boolean!)

    \n

    The setting value to find organizations for.

    \n\n
    \n\n
    \n\n\n

    samlIdentityProvider (EnterpriseIdentityProvider)

    The SAML Identity Provider for the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    samlIdentityProviderSettingOrganizations (OrganizationConnection!)

    A list of enterprise organizations configured with the SAML single sign-on setting value.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (OrganizationOrder)

    \n

    Ordering options for organizations with this setting.

    \n\n
    \n\n
    \n

    value (IdentityProviderConfigurationState!)

    \n

    The setting value to find organizations for.

    \n\n
    \n\n
    \n\n\n

    supportEntitlements (EnterpriseMemberConnection!)

    A list of members with a support entitlement.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (EnterpriseMemberOrder)

    \n

    Ordering options for support entitlement users returned from the connection.

    \n\n
    \n\n
    \n\n\n

    teamDiscussionsSetting (EnterpriseEnabledDisabledSettingValue!)

    The setting value for whether team discussions are enabled for organizations in this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamDiscussionsSettingOrganizations (OrganizationConnection!)

    A list of enterprise organizations configured with the provided team discussions setting value.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (OrganizationOrder)

    \n

    Ordering options for organizations with this setting.

    \n\n
    \n\n
    \n

    value (Boolean!)

    \n

    The setting value to find organizations for.

    \n\n
    \n\n
    \n\n\n

    twoFactorRequiredSetting (EnterpriseEnabledSettingValue!)

    The setting value for whether the enterprise requires two-factor authentication for its organizations and users.

    \n\n\n\n\n\n\n\n\n\n\n\n

    twoFactorRequiredSettingOrganizations (OrganizationConnection!)

    A list of enterprise organizations configured with the two-factor authentication setting value.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (OrganizationOrder)

    \n

    Ordering options for organizations with this setting.

    \n\n
    \n\n
    \n

    value (Boolean!)

    \n

    The setting value to find organizations for.

    \n\n
    \n\n
    \n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterprisePendingCollaboratorConnection\n

    \n

    The connection type for User.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([EnterprisePendingCollaboratorEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([User])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterprisePendingCollaboratorEdge\n

    \n

    A user with an invitation to be a collaborator on a repository owned by an organization in an enterprise.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isUnlicensed (Boolean!)

    Whether the invited collaborator does not have a license for the enterprise.

    \n\n\n\n\n\n\n
    \n

    Deprecation notice

    \n

    isUnlicensed is deprecated.

    All pending collaborators consume a license Removal on 2021-01-01 UTC.

    \n
    \n\n\n\n\n\n\n

    node (User)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositories (EnterpriseRepositoryInfoConnection!)

    The enterprise organization repositories this user is a member of.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (RepositoryOrder)

    \n

    Ordering options for repositories.

    \n\n
    \n\n
    \n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterprisePendingMemberInvitationConnection\n

    \n

    The connection type for OrganizationInvitation.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([EnterprisePendingMemberInvitationEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([OrganizationInvitation])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalUniqueUserCount (Int!)

    Identifies the total count of unique users in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterprisePendingMemberInvitationEdge\n

    \n

    An invitation to be a member in an enterprise organization.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isUnlicensed (Boolean!)

    Whether the invitation has a license for the enterprise.

    \n\n\n\n\n\n\n
    \n

    Deprecation notice

    \n

    isUnlicensed is deprecated.

    All pending members consume a license Removal on 2020-07-01 UTC.

    \n
    \n\n\n\n\n\n\n

    node (OrganizationInvitation)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseRepositoryInfo\n

    \n

    A subset of repository information queryable from an enterprise.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    isPrivate (Boolean!)

    Identifies if the repository is private.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The repository's name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nameWithOwner (String!)

    The repository's name with owner.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseRepositoryInfoConnection\n

    \n

    The connection type for EnterpriseRepositoryInfo.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([EnterpriseRepositoryInfoEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([EnterpriseRepositoryInfo])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseRepositoryInfoEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (EnterpriseRepositoryInfo)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseServerInstallation\n

    \n

    An Enterprise Server installation.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    customerName (String!)

    The customer name to which the Enterprise Server installation belongs.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hostName (String!)

    The host name of the Enterprise Server installation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isConnected (Boolean!)

    Whether or not the installation is connected to an Enterprise Server installation via GitHub Connect.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userAccounts (EnterpriseServerUserAccountConnection!)

    User accounts on this Enterprise Server installation.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (EnterpriseServerUserAccountOrder)

    \n

    Ordering options for Enterprise Server user accounts returned from the connection.

    \n\n
    \n\n
    \n\n\n

    userAccountsUploads (EnterpriseServerUserAccountsUploadConnection!)

    User accounts uploads for the Enterprise Server installation.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (EnterpriseServerUserAccountsUploadOrder)

    \n

    Ordering options for Enterprise Server user accounts uploads returned from the connection.

    \n\n
    \n\n
    \n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseServerInstallationConnection\n

    \n

    The connection type for EnterpriseServerInstallation.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([EnterpriseServerInstallationEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([EnterpriseServerInstallation])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseServerInstallationEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (EnterpriseServerInstallation)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseServerUserAccount\n

    \n

    A user account on an Enterprise Server installation.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    emails (EnterpriseServerUserAccountEmailConnection!)

    User emails belonging to this user account.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (EnterpriseServerUserAccountEmailOrder)

    \n

    Ordering options for Enterprise Server user account emails returned from the connection.

    \n\n
    \n\n
    \n\n\n

    enterpriseServerInstallation (EnterpriseServerInstallation!)

    The Enterprise Server installation on which this user account exists.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isSiteAdmin (Boolean!)

    Whether the user account is a site administrator on the Enterprise Server installation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    login (String!)

    The login of the user account on the Enterprise Server installation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    profileName (String)

    The profile name of the user account on the Enterprise Server installation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    remoteCreatedAt (DateTime!)

    The date and time when the user account was created on the Enterprise Server installation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    remoteUserId (Int!)

    The ID of the user account on the Enterprise Server installation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseServerUserAccountConnection\n

    \n

    The connection type for EnterpriseServerUserAccount.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([EnterpriseServerUserAccountEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([EnterpriseServerUserAccount])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseServerUserAccountEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (EnterpriseServerUserAccount)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseServerUserAccountEmail\n

    \n

    An email belonging to a user account on an Enterprise Server installation.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    email (String!)

    The email address.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isPrimary (Boolean!)

    Indicates whether this is the primary email of the associated user account.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userAccount (EnterpriseServerUserAccount!)

    The user account to which the email belongs.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseServerUserAccountEmailConnection\n

    \n

    The connection type for EnterpriseServerUserAccountEmail.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([EnterpriseServerUserAccountEmailEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([EnterpriseServerUserAccountEmail])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseServerUserAccountEmailEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (EnterpriseServerUserAccountEmail)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseServerUserAccountsUpload\n

    \n

    A user accounts upload from an Enterprise Server installation.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterprise (Enterprise!)

    The enterprise to which this upload belongs.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseServerInstallation (EnterpriseServerInstallation!)

    The Enterprise Server installation for which this upload was generated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The name of the file uploaded.

    \n\n\n\n\n\n\n\n\n\n\n\n

    syncState (EnterpriseServerUserAccountsUploadSyncState!)

    The synchronization state of the upload.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseServerUserAccountsUploadConnection\n

    \n

    The connection type for EnterpriseServerUserAccountsUpload.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([EnterpriseServerUserAccountsUploadEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([EnterpriseServerUserAccountsUpload])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseServerUserAccountsUploadEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (EnterpriseServerUserAccountsUpload)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseUserAccount\n

    \n

    An account for a user who is an admin of an enterprise or a member of an enterprise through one or more organizations.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    avatarUrl (URI!)

    A URL pointing to the enterprise user account's public avatar.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    size (Int)

    \n

    The size of the resulting square image.

    \n\n
    \n\n
    \n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterprise (Enterprise!)

    The enterprise in which this user account exists.

    \n\n\n\n\n\n\n\n\n\n\n\n

    login (String!)

    An identifier for the enterprise user account, a login or email address.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String)

    The name of the enterprise user account.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizations (EnterpriseOrganizationMembershipConnection!)

    A list of enterprise organizations this user is a member of.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (OrganizationOrder)

    \n

    Ordering options for organizations returned from the connection.

    \n\n
    \n\n
    \n

    query (String)

    \n

    The search string to look for.

    \n\n
    \n\n
    \n

    role (EnterpriseUserAccountMembershipRole)

    \n

    The role of the user in the enterprise organization.

    \n\n
    \n\n
    \n\n\n

    resourcePath (URI!)

    The HTTP path for this user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user within the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseUserAccountConnection\n

    \n

    The connection type for EnterpriseUserAccount.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([EnterpriseUserAccountEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([EnterpriseUserAccount])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseUserAccountEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (EnterpriseUserAccount)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ExternalIdentity\n

    \n

    An external identity provisioned by SAML SSO or SCIM.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    guid (String!)

    The GUID for this identity.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationInvitation (OrganizationInvitation)

    Organization invitation for this SCIM-provisioned external identity.

    \n\n\n\n\n\n\n\n\n\n\n\n

    samlIdentity (ExternalIdentitySamlAttributes)

    SAML Identity attributes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    scimIdentity (ExternalIdentityScimAttributes)

    SCIM Identity attributes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    User linked to this external identity. Will be NULL if this identity has not been claimed by an organization member.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ExternalIdentityConnection\n

    \n

    The connection type for ExternalIdentity.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([ExternalIdentityEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([ExternalIdentity])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ExternalIdentityEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (ExternalIdentity)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ExternalIdentitySamlAttributes\n

    \n

    SAML attributes for the External Identity.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    emails ([UserEmailMetadata!])

    The emails associated with the SAML identity.

    \n\n\n\n\n\n\n\n\n\n\n\n

    familyName (String)

    Family name of the SAML identity.

    \n\n\n\n\n\n\n\n\n\n\n\n

    givenName (String)

    Given name of the SAML identity.

    \n\n\n\n\n\n\n\n\n\n\n\n

    groups ([String!])

    The groups linked to this identity in IDP.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nameId (String)

    The NameID of the SAML identity.

    \n\n\n\n\n\n\n\n\n\n\n\n

    username (String)

    The userName of the SAML identity.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ExternalIdentityScimAttributes\n

    \n

    SCIM attributes for the External Identity.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    emails ([UserEmailMetadata!])

    The emails associated with the SCIM identity.

    \n\n\n\n\n\n\n\n\n\n\n\n

    familyName (String)

    Family name of the SCIM identity.

    \n\n\n\n\n\n\n\n\n\n\n\n

    givenName (String)

    Given name of the SCIM identity.

    \n\n\n\n\n\n\n\n\n\n\n\n

    groups ([String!])

    The groups linked to this identity in IDP.

    \n\n\n\n\n\n\n\n\n\n\n\n

    username (String)

    The userName of the SCIM identity.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n FollowerConnection\n

    \n

    The connection type for User.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([UserEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([User])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n FollowingConnection\n

    \n

    The connection type for User.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([UserEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([User])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n FundingLink\n

    \n

    A funding platform link for a repository.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    platform (FundingPlatform!)

    The funding platform this link is for.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The configured URL for this funding link.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n GenericHovercardContext\n

    \n

    A generic hovercard context with a message and icon.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    message (String!)

    A string describing this context.

    \n\n\n\n\n\n\n\n\n\n\n\n

    octicon (String!)

    An octicon to accompany this context.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Gist\n

    \n

    A Gist.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    comments (GistCommentConnection!)

    A list of comments associated with the gist.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String)

    The gist description.

    \n\n\n\n\n\n\n\n\n\n\n\n

    files ([GistFile])

    The files in this gist.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    limit (Int)

    \n

    The maximum number of files to return.

    \n

    The default value is 10.

    \n
    \n\n
    \n

    oid (GitObjectID)

    \n

    The oid of the files to return.

    \n\n
    \n\n
    \n\n\n

    forks (GistConnection!)

    A list of forks associated with the gist.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (GistOrder)

    \n

    Ordering options for gists returned from the connection.

    \n\n
    \n\n
    \n\n\n

    isFork (Boolean!)

    Identifies if the gist is a fork.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isPublic (Boolean!)

    Whether the gist is public or not.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The gist name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    owner (RepositoryOwner)

    The gist owner.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pushedAt (DateTime)

    Identifies when the gist was last pushed to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTML path to this resource.

    \n\n\n\n\n\n\n\n\n\n\n\n

    stargazerCount (Int!)

    Returns a count of how many stargazers there are on this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    stargazers (StargazerConnection!)

    A list of users who have starred this starrable.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (StarOrder)

    \n

    Order for connection.

    \n\n
    \n\n
    \n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this Gist.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerHasStarred (Boolean!)

    Returns a boolean indicating whether the viewing user has starred this starrable.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n GistComment\n

    \n

    Represents a comment on an Gist.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    author (Actor)

    The actor who authored the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    authorAssociation (CommentAuthorAssociation!)

    Author's association with the gist.

    \n\n\n\n\n\n\n\n\n\n\n\n

    body (String!)

    Identifies the comment body.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyHTML (HTML!)

    The body rendered to HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyText (String!)

    The body rendered to text.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdViaEmail (Boolean!)

    Check if this comment was created via an email reply.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    editor (Actor)

    The actor who edited the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    gist (Gist!)

    The associated gist.

    \n\n\n\n\n\n\n\n\n\n\n\n

    includesCreatedEdit (Boolean!)

    Check if this comment was edited and includes an edit with the creation data.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isMinimized (Boolean!)

    Returns whether or not a comment has been minimized.

    \n\n\n\n\n\n\n\n\n\n\n\n

    lastEditedAt (DateTime)

    The moment the editor made the last edit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    minimizedReason (String)

    Returns why the comment was minimized.

    \n\n\n\n\n\n\n\n\n\n\n\n

    publishedAt (DateTime)

    Identifies when the comment was published at.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userContentEdits (UserContentEditConnection)

    A list of edits to this content.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    viewerCanDelete (Boolean!)

    Check if the current viewer can delete this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanMinimize (Boolean!)

    Check if the current viewer can minimize this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanUpdate (Boolean!)

    Check if the current viewer can update this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

    Reasons why the current viewer can not update this comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerDidAuthor (Boolean!)

    Did the viewer author this comment.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n GistCommentConnection\n

    \n

    The connection type for GistComment.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([GistCommentEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([GistComment])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n GistCommentEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (GistComment)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n GistConnection\n

    \n

    The connection type for Gist.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([GistEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Gist])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n GistEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (Gist)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n GistFile\n

    \n

    A file in a gist.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    encodedName (String)

    The file name encoded to remove characters that are invalid in URL paths.

    \n\n\n\n\n\n\n\n\n\n\n\n

    encoding (String)

    The gist file encoding.

    \n\n\n\n\n\n\n\n\n\n\n\n

    extension (String)

    The file extension from the file name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isImage (Boolean!)

    Indicates if this file is an image.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isTruncated (Boolean!)

    Whether the file's contents were truncated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    language (Language)

    The programming language this file is written in.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String)

    The gist file name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    size (Int)

    The gist file size in bytes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    text (String)

    UTF8 text data or null if the file is binary.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    truncate (Int)

    \n

    Optionally truncate the returned file to this length.

    \n\n
    \n\n
    \n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n GitActor\n

    \n

    Represents an actor in a Git commit (ie. an author or committer).

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    avatarUrl (URI!)

    A URL pointing to the author's public avatar.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    size (Int)

    \n

    The size of the resulting square image.

    \n\n
    \n\n
    \n\n\n

    date (GitTimestamp)

    The timestamp of the Git action (authoring or committing).

    \n\n\n\n\n\n\n\n\n\n\n\n

    email (String)

    The email in the Git commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String)

    The name in the Git commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The GitHub user corresponding to the email field. Null if no such user exists.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n GitActorConnection\n

    \n

    The connection type for GitActor.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([GitActorEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([GitActor])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n GitActorEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (GitActor)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n GitHubMetadata\n

    \n

    Represents information about the GitHub instance.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    gitHubServicesSha (GitObjectID!)

    Returns a String that's a SHA of github-services.

    \n\n\n\n\n\n\n\n\n\n\n\n

    gitIpAddresses ([String!])

    IP addresses that users connect to for git operations.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hookIpAddresses ([String!])

    IP addresses that service hooks are sent from.

    \n\n\n\n\n\n\n\n\n\n\n\n

    importerIpAddresses ([String!])

    IP addresses that the importer connects from.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isPasswordAuthenticationVerifiable (Boolean!)

    Whether or not users are verified.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pagesIpAddresses ([String!])

    IP addresses for GitHub Pages' A records.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n GpgSignature\n

    \n

    Represents a GPG signature on a Commit or Tag.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    email (String!)

    Email used to sign this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isValid (Boolean!)

    True if the signature is valid and verified by GitHub.

    \n\n\n\n\n\n\n\n\n\n\n\n

    keyId (String)

    Hex-encoded ID of the key that signed this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    payload (String!)

    Payload for GPG signing object. Raw ODB object without the signature header.

    \n\n\n\n\n\n\n\n\n\n\n\n

    signature (String!)

    ASCII-armored signature header from object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    signer (User)

    GitHub user corresponding to the email signing this commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    state (GitSignatureState!)

    The state of this signature. VALID if signature is valid and verified by\nGitHub, otherwise represents reason why signature is considered invalid.

    \n\n\n\n\n\n\n\n\n\n\n\n

    wasSignedByGitHub (Boolean!)

    True if the signature was made with GitHub's signing key.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n HeadRefDeletedEvent\n

    \n

    Represents ahead_ref_deletedevent on a given pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    headRef (Ref)

    Identifies the Ref associated with the head_ref_deleted event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    headRefName (String!)

    Identifies the name of the Ref associated with the head_ref_deleted event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    PullRequest referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n HeadRefForcePushedEvent\n

    \n

    Represents ahead_ref_force_pushedevent on a given pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    afterCommit (Commit)

    Identifies the after commit SHA for thehead_ref_force_pushedevent.

    \n\n\n\n\n\n\n\n\n\n\n\n

    beforeCommit (Commit)

    Identifies the before commit SHA for thehead_ref_force_pushedevent.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    PullRequest referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ref (Ref)

    Identifies the fully qualified ref name for thehead_ref_force_pushedevent.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n HeadRefRestoredEvent\n

    \n

    Represents ahead_ref_restoredevent on a given pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    PullRequest referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Hovercard\n

    \n

    Detail needed to display a hovercard for a user.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    contexts ([HovercardContext!]!)

    Each of the contexts for this hovercard.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n IpAllowListEntry\n

    \n

    An IP address or range of addresses that is allowed to access an owner's resources.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    allowListValue (String!)

    A single IP address or range of IP addresses in CIDR notation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isActive (Boolean!)

    Whether the entry is currently active.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String)

    The name of the IP allow list entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    owner (IpAllowListOwner!)

    The owner of the IP allow list entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n IpAllowListEntryConnection\n

    \n

    The connection type for IpAllowListEntry.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([IpAllowListEntryEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([IpAllowListEntry])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n IpAllowListEntryEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (IpAllowListEntry)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Issue\n

    \n

    An Issue is a place to discuss ideas, enhancements, tasks, and bugs for a project.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    activeLockReason (LockReason)

    Reason that the conversation was locked.

    \n\n\n\n\n\n\n\n\n\n\n\n

    assignees (UserConnection!)

    A list of Users assigned to this object.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    author (Actor)

    The actor who authored the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    authorAssociation (CommentAuthorAssociation!)

    Author's association with the subject of the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    body (String!)

    Identifies the body of the issue.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyHTML (HTML!)

    The body rendered to HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyResourcePath (URI!)

    The http path for this issue body.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyText (String!)

    Identifies the body of the issue rendered to text.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyUrl (URI!)

    The http URL for this issue body.

    \n\n\n\n\n\n\n\n\n\n\n\n

    closed (Boolean!)

    true if the object is closed (definition of closed may depend on type).

    \n\n\n\n\n\n\n\n\n\n\n\n

    closedAt (DateTime)

    Identifies the date and time when the object was closed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    comments (IssueCommentConnection!)

    A list of comments associated with the Issue.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (IssueCommentOrder)

    \n

    Ordering options for issue comments returned from the connection.

    \n\n
    \n\n
    \n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdViaEmail (Boolean!)

    Check if this comment was created via an email reply.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    editor (Actor)

    The actor who edited the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hovercard (Hovercard!)

    The hovercard information for this issue.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    includeNotificationContexts (Boolean)

    \n

    Whether or not to include notification contexts.

    \n

    The default value is true.

    \n
    \n\n
    \n\n\n

    includesCreatedEdit (Boolean!)

    Check if this comment was edited and includes an edit with the creation data.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isReadByViewer (Boolean)

    Is this issue read by the viewer.

    \n\n\n\n\n\n\n\n\n\n\n\n

    labels (LabelConnection)

    A list of labels associated with the object.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (LabelOrder)

    \n

    Ordering options for labels returned from the connection.

    \n\n
    \n\n
    \n\n\n

    lastEditedAt (DateTime)

    The moment the editor made the last edit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    locked (Boolean!)

    true if the object is locked.

    \n\n\n\n\n\n\n\n\n\n\n\n

    milestone (Milestone)

    Identifies the milestone associated with the issue.

    \n\n\n\n\n\n\n\n\n\n\n\n

    number (Int!)

    Identifies the issue number.

    \n\n\n\n\n\n\n\n\n\n\n\n

    participants (UserConnection!)

    A list of Users that are participating in the Issue conversation.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    projectCards (ProjectCardConnection!)

    List of project cards associated with this issue.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    archivedStates ([ProjectCardArchivedState])

    \n

    A list of archived states to filter the cards by.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    publishedAt (DateTime)

    Identifies when the comment was published at.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reactionGroups ([ReactionGroup!])

    A list of reactions grouped by content left on the subject.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reactions (ReactionConnection!)

    A list of Reactions left on the Issue.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    content (ReactionContent)

    \n

    Allows filtering Reactions by emoji.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (ReactionOrder)

    \n

    Allows specifying the order in which reactions are returned.

    \n\n
    \n\n
    \n\n\n

    repository (Repository!)

    The repository associated with this node.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this issue.

    \n\n\n\n\n\n\n\n\n\n\n\n

    state (IssueState!)

    Identifies the state of the issue.

    \n\n\n\n\n\n\n\n\n\n\n\n

    timeline (IssueTimelineConnection!)

    A list of events, comments, commits, etc. associated with the issue.

    \n\n\n\n\n\n\n
    \n

    Deprecation notice

    \n

    timeline is deprecated.

    timeline will be removed Use Issue.timelineItems instead. Removal on 2020-10-01 UTC.

    \n
    \n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    since (DateTime)

    \n

    Allows filtering timeline events by a since timestamp.

    \n\n
    \n\n
    \n\n\n

    timelineItems (IssueTimelineItemsConnection!)

    A list of events, comments, commits, etc. associated with the issue.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    itemTypes ([IssueTimelineItemsItemType!])

    \n

    Filter timeline items by type.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    since (DateTime)

    \n

    Filter timeline items by a since timestamp.

    \n\n
    \n\n
    \n

    skip (Int)

    \n

    Skips the first n elements in the list.

    \n\n
    \n\n
    \n\n\n

    title (String!)

    Identifies the issue title.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this issue.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userContentEdits (UserContentEditConnection)

    A list of edits to this content.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    viewerCanReact (Boolean!)

    Can user react to this subject.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanSubscribe (Boolean!)

    Check if the viewer is able to change their subscription status for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanUpdate (Boolean!)

    Check if the current viewer can update this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

    Reasons why the current viewer can not update this comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerDidAuthor (Boolean!)

    Did the viewer author this comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerSubscription (SubscriptionState)

    Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n IssueComment\n

    \n

    Represents a comment on an Issue.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    author (Actor)

    The actor who authored the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    authorAssociation (CommentAuthorAssociation!)

    Author's association with the subject of the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    body (String!)

    The body as Markdown.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyHTML (HTML!)

    The body rendered to HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyText (String!)

    The body rendered to text.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdViaEmail (Boolean!)

    Check if this comment was created via an email reply.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    editor (Actor)

    The actor who edited the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    includesCreatedEdit (Boolean!)

    Check if this comment was edited and includes an edit with the creation data.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isMinimized (Boolean!)

    Returns whether or not a comment has been minimized.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issue (Issue!)

    Identifies the issue associated with the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    lastEditedAt (DateTime)

    The moment the editor made the last edit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    minimizedReason (String)

    Returns why the comment was minimized.

    \n\n\n\n\n\n\n\n\n\n\n\n

    publishedAt (DateTime)

    Identifies when the comment was published at.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest)

    Returns the pull request associated with the comment, if this comment was made on a\npull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reactionGroups ([ReactionGroup!])

    A list of reactions grouped by content left on the subject.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reactions (ReactionConnection!)

    A list of Reactions left on the Issue.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    content (ReactionContent)

    \n

    Allows filtering Reactions by emoji.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (ReactionOrder)

    \n

    Allows specifying the order in which reactions are returned.

    \n\n
    \n\n
    \n\n\n

    repository (Repository!)

    The repository associated with this node.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this issue comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this issue comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userContentEdits (UserContentEditConnection)

    A list of edits to this content.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    viewerCanDelete (Boolean!)

    Check if the current viewer can delete this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanMinimize (Boolean!)

    Check if the current viewer can minimize this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanReact (Boolean!)

    Can user react to this subject.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanUpdate (Boolean!)

    Check if the current viewer can update this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

    Reasons why the current viewer can not update this comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerDidAuthor (Boolean!)

    Did the viewer author this comment.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n IssueCommentConnection\n

    \n

    The connection type for IssueComment.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([IssueCommentEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([IssueComment])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n IssueCommentEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (IssueComment)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n IssueConnection\n

    \n

    The connection type for Issue.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([IssueEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Issue])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n IssueContributionsByRepository\n

    \n

    This aggregates issues opened by a user within one repository.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    contributions (CreatedIssueContributionConnection!)

    The issue contributions.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (ContributionOrder)

    \n

    Ordering options for contributions returned from the connection.

    \n\n
    \n\n
    \n\n\n

    repository (Repository!)

    The repository in which the issues were opened.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n IssueEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (Issue)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n IssueTemplate\n

    \n

    A repository issue template.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    about (String)

    The template purpose.

    \n\n\n\n\n\n\n\n\n\n\n\n

    body (String)

    The suggested issue body.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The template name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    title (String)

    The suggested issue title.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n IssueTimelineConnection\n

    \n

    The connection type for IssueTimelineItem.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([IssueTimelineItemEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([IssueTimelineItem])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n IssueTimelineItemEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (IssueTimelineItem)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n IssueTimelineItemsConnection\n

    \n

    The connection type for IssueTimelineItems.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([IssueTimelineItemsEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    filteredCount (Int!)

    Identifies the count of items after applying before and after filters.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([IssueTimelineItems])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageCount (Int!)

    Identifies the count of items after applying before/after filters and first/last/skip slicing.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the timeline was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n IssueTimelineItemsEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (IssueTimelineItems)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n JoinedGitHubContribution\n

    \n

    Represents a user signing up for a GitHub account.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    isRestricted (Boolean!)

    Whether this contribution is associated with a record you do not have access to. For\nexample, your own 'first issue' contribution may have been made on a repository you can no\nlonger access.

    \n\n\n\n\n\n\n\n\n\n\n\n

    occurredAt (DateTime!)

    When this contribution was made.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User!)

    The user who made this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Label\n

    \n

    A label for categorizing Issues or Milestones with a given Repository.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    color (String!)

    Identifies the label color.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime)

    Identifies the date and time when the label was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String)

    A brief description of this label.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isDefault (Boolean!)

    Indicates whether or not this is a default label.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issues (IssueConnection!)

    A list of issues associated with this label.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    filterBy (IssueFilters)

    \n

    Filtering options for issues returned from the connection.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    labels ([String!])

    \n

    A list of label names to filter the pull requests by.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (IssueOrder)

    \n

    Ordering options for issues returned from the connection.

    \n\n
    \n\n
    \n

    states ([IssueState!])

    \n

    A list of states to filter the issues by.

    \n\n
    \n\n
    \n\n\n

    name (String!)

    Identifies the label name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequests (PullRequestConnection!)

    A list of pull requests associated with this label.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    baseRefName (String)

    \n

    The base ref name to filter the pull requests by.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    headRefName (String)

    \n

    The head ref name to filter the pull requests by.

    \n\n
    \n\n
    \n

    labels ([String!])

    \n

    A list of label names to filter the pull requests by.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (IssueOrder)

    \n

    Ordering options for pull requests returned from the connection.

    \n\n
    \n\n
    \n

    states ([PullRequestState!])

    \n

    A list of states to filter the pull requests by.

    \n\n
    \n\n
    \n\n\n

    repository (Repository!)

    The repository associated with this label.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this label.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime)

    Identifies the date and time when the label was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this label.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n LabelConnection\n

    \n

    The connection type for Label.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([LabelEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Label])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n LabelEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (Label)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n LabeledEvent\n

    \n

    Represents alabeledevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    label (Label!)

    Identifies the label associated with thelabeledevent.

    \n\n\n\n\n\n\n\n\n\n\n\n

    labelable (Labelable!)

    Identifies the Labelable associated with the event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Language\n

    \n

    Represents a given language found in repositories.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    color (String)

    The color defined for the current language.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The name of the current language.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n LanguageConnection\n

    \n

    A list of languages associated with the parent.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([LanguageEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Language])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalSize (Int!)

    The total size in bytes of files written in that language.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n LanguageEdge\n

    \n

    Represents the language of a repository.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    size (Int!)

    The number of bytes of code written in the language.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n License\n

    \n

    A repository's open source license.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String!)

    The full text of the license.

    \n\n\n\n\n\n\n\n\n\n\n\n

    conditions ([LicenseRule]!)

    The conditions set by the license.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String)

    A human-readable description of the license.

    \n\n\n\n\n\n\n\n\n\n\n\n

    featured (Boolean!)

    Whether the license should be featured.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hidden (Boolean!)

    Whether the license should be displayed in license pickers.

    \n\n\n\n\n\n\n\n\n\n\n\n

    implementation (String)

    Instructions on how to implement the license.

    \n\n\n\n\n\n\n\n\n\n\n\n

    key (String!)

    The lowercased SPDX ID of the license.

    \n\n\n\n\n\n\n\n\n\n\n\n

    limitations ([LicenseRule]!)

    The limitations set by the license.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The license full name specified by https://spdx.org/licenses.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nickname (String)

    Customary short name if applicable (e.g, GPLv3).

    \n\n\n\n\n\n\n\n\n\n\n\n

    permissions ([LicenseRule]!)

    The permissions set by the license.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pseudoLicense (Boolean!)

    Whether the license is a pseudo-license placeholder (e.g., other, no-license).

    \n\n\n\n\n\n\n\n\n\n\n\n

    spdxId (String)

    Short identifier specified by https://spdx.org/licenses.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI)

    URL to the license on https://choosealicense.com.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n LicenseRule\n

    \n

    Describes a License's conditions, permissions, and limitations.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    description (String!)

    A description of the rule.

    \n\n\n\n\n\n\n\n\n\n\n\n

    key (String!)

    The machine-readable rule key.

    \n\n\n\n\n\n\n\n\n\n\n\n

    label (String!)

    The human-readable rule label.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n LockedEvent\n

    \n

    Represents alockedevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    lockReason (LockReason)

    Reason that the conversation was locked (optional).

    \n\n\n\n\n\n\n\n\n\n\n\n

    lockable (Lockable!)

    Object that was locked.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Mannequin\n

    \n

    A placeholder user for attribution of imported data on GitHub.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    avatarUrl (URI!)

    A URL pointing to the GitHub App's public avatar.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    size (Int)

    \n

    The size of the resulting square image.

    \n\n
    \n\n
    \n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    email (String)

    The mannequin's email on the source instance.

    \n\n\n\n\n\n\n\n\n\n\n\n

    login (String!)

    The username of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTML path to this resource.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The URL to this resource.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n MarkedAsDuplicateEvent\n

    \n

    Represents amarked_as_duplicateevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    canonical (IssueOrPullRequest)

    The authoritative issue or pull request which has been duplicated by another.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    duplicate (IssueOrPullRequest)

    The issue or pull request which has been marked as a duplicate of another.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isCrossRepository (Boolean!)

    Canonical and duplicate belong to different repositories.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n MarketplaceCategory\n

    \n

    A public description of a Marketplace category.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    description (String)

    The category's description.

    \n\n\n\n\n\n\n\n\n\n\n\n

    howItWorks (String)

    The technical description of how apps listed in this category work with GitHub.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The category's name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    primaryListingCount (Int!)

    How many Marketplace listings have this as their primary category.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this Marketplace category.

    \n\n\n\n\n\n\n\n\n\n\n\n

    secondaryListingCount (Int!)

    How many Marketplace listings have this as their secondary category.

    \n\n\n\n\n\n\n\n\n\n\n\n

    slug (String!)

    The short name of the category used in its URL.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this Marketplace category.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n MarketplaceListing\n

    \n

    A listing in the GitHub integration marketplace.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    app (App)

    The GitHub App this listing represents.

    \n\n\n\n\n\n\n\n\n\n\n\n

    companyUrl (URI)

    URL to the listing owner's company site.

    \n\n\n\n\n\n\n\n\n\n\n\n

    configurationResourcePath (URI!)

    The HTTP path for configuring access to the listing's integration or OAuth app.

    \n\n\n\n\n\n\n\n\n\n\n\n

    configurationUrl (URI!)

    The HTTP URL for configuring access to the listing's integration or OAuth app.

    \n\n\n\n\n\n\n\n\n\n\n\n

    documentationUrl (URI)

    URL to the listing's documentation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    extendedDescription (String)

    The listing's detailed description.

    \n\n\n\n\n\n\n\n\n\n\n\n

    extendedDescriptionHTML (HTML!)

    The listing's detailed description rendered to HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    fullDescription (String!)

    The listing's introductory description.

    \n\n\n\n\n\n\n\n\n\n\n\n

    fullDescriptionHTML (HTML!)

    The listing's introductory description rendered to HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hasPublishedFreeTrialPlans (Boolean!)

    Does this listing have any plans with a free trial?.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hasTermsOfService (Boolean!)

    Does this listing have a terms of service link?.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hasVerifiedOwner (Boolean!)

    Whether the creator of the app is a verified org.

    \n\n\n\n\n\n\n\n\n\n\n\n

    howItWorks (String)

    A technical description of how this app works with GitHub.

    \n\n\n\n\n\n\n\n\n\n\n\n

    howItWorksHTML (HTML!)

    The listing's technical description rendered to HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    installationUrl (URI)

    URL to install the product to the viewer's account or organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    installedForViewer (Boolean!)

    Whether this listing's app has been installed for the current viewer.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isArchived (Boolean!)

    Whether this listing has been removed from the Marketplace.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isDraft (Boolean!)

    Whether this listing is still an editable draft that has not been submitted\nfor review and is not publicly visible in the Marketplace.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isPaid (Boolean!)

    Whether the product this listing represents is available as part of a paid plan.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isPublic (Boolean!)

    Whether this listing has been approved for display in the Marketplace.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isRejected (Boolean!)

    Whether this listing has been rejected by GitHub for display in the Marketplace.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isUnverified (Boolean!)

    Whether this listing has been approved for unverified display in the Marketplace.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isUnverifiedPending (Boolean!)

    Whether this draft listing has been submitted for review for approval to be unverified in the Marketplace.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isVerificationPendingFromDraft (Boolean!)

    Whether this draft listing has been submitted for review from GitHub for approval to be verified in the Marketplace.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isVerificationPendingFromUnverified (Boolean!)

    Whether this unverified listing has been submitted for review from GitHub for approval to be verified in the Marketplace.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isVerified (Boolean!)

    Whether this listing has been approved for verified display in the Marketplace.

    \n\n\n\n\n\n\n\n\n\n\n\n

    logoBackgroundColor (String!)

    The hex color code, without the leading '#', for the logo background.

    \n\n\n\n\n\n\n\n\n\n\n\n

    logoUrl (URI)

    URL for the listing's logo image.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    size (Int)

    \n

    The size in pixels of the resulting square image.

    \n

    The default value is 400.

    \n
    \n\n
    \n\n\n

    name (String!)

    The listing's full name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    normalizedShortDescription (String!)

    The listing's very short description without a trailing period or ampersands.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pricingUrl (URI)

    URL to the listing's detailed pricing.

    \n\n\n\n\n\n\n\n\n\n\n\n

    primaryCategory (MarketplaceCategory!)

    The category that best describes the listing.

    \n\n\n\n\n\n\n\n\n\n\n\n

    privacyPolicyUrl (URI!)

    URL to the listing's privacy policy, may return an empty string for listings that do not require a privacy policy URL.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for the Marketplace listing.

    \n\n\n\n\n\n\n\n\n\n\n\n

    screenshotUrls ([String]!)

    The URLs for the listing's screenshots.

    \n\n\n\n\n\n\n\n\n\n\n\n

    secondaryCategory (MarketplaceCategory)

    An alternate category that describes the listing.

    \n\n\n\n\n\n\n\n\n\n\n\n

    shortDescription (String!)

    The listing's very short description.

    \n\n\n\n\n\n\n\n\n\n\n\n

    slug (String!)

    The short name of the listing used in its URL.

    \n\n\n\n\n\n\n\n\n\n\n\n

    statusUrl (URI)

    URL to the listing's status page.

    \n\n\n\n\n\n\n\n\n\n\n\n

    supportEmail (String)

    An email address for support for this listing's app.

    \n\n\n\n\n\n\n\n\n\n\n\n

    supportUrl (URI!)

    Either a URL or an email address for support for this listing's app, may\nreturn an empty string for listings that do not require a support URL.

    \n\n\n\n\n\n\n\n\n\n\n\n

    termsOfServiceUrl (URI)

    URL to the listing's terms of service.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for the Marketplace listing.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanAddPlans (Boolean!)

    Can the current viewer add plans for this Marketplace listing.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanApprove (Boolean!)

    Can the current viewer approve this Marketplace listing.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanDelist (Boolean!)

    Can the current viewer delist this Marketplace listing.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanEdit (Boolean!)

    Can the current viewer edit this Marketplace listing.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanEditCategories (Boolean!)

    Can the current viewer edit the primary and secondary category of this\nMarketplace listing.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanEditPlans (Boolean!)

    Can the current viewer edit the plans for this Marketplace listing.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanRedraft (Boolean!)

    Can the current viewer return this Marketplace listing to draft state\nso it becomes editable again.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanReject (Boolean!)

    Can the current viewer reject this Marketplace listing by returning it to\nan editable draft state or rejecting it entirely.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanRequestApproval (Boolean!)

    Can the current viewer request this listing be reviewed for display in\nthe Marketplace as verified.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerHasPurchased (Boolean!)

    Indicates whether the current user has an active subscription to this Marketplace listing.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerHasPurchasedForAllOrganizations (Boolean!)

    Indicates if the current user has purchased a subscription to this Marketplace listing\nfor all of the organizations the user owns.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerIsListingAdmin (Boolean!)

    Does the current viewer role allow them to administer this Marketplace listing.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n MarketplaceListingConnection\n

    \n

    Look up Marketplace Listings.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([MarketplaceListingEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([MarketplaceListing])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n MarketplaceListingEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (MarketplaceListing)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n MembersCanDeleteReposClearAuditEntry\n

    \n

    Audit log entry for a members_can_delete_repos.clear event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseResourcePath (URI)

    The HTTP path for this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseSlug (String)

    The slug of the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseUrl (URI)

    The HTTP URL for this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n MembersCanDeleteReposDisableAuditEntry\n

    \n

    Audit log entry for a members_can_delete_repos.disable event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseResourcePath (URI)

    The HTTP path for this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseSlug (String)

    The slug of the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseUrl (URI)

    The HTTP URL for this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n MembersCanDeleteReposEnableAuditEntry\n

    \n

    Audit log entry for a members_can_delete_repos.enable event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseResourcePath (URI)

    The HTTP path for this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseSlug (String)

    The slug of the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseUrl (URI)

    The HTTP URL for this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n MentionedEvent\n

    \n

    Represents amentionedevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n MergedEvent\n

    \n

    Represents amergedevent on a given pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commit (Commit)

    Identifies the commit associated with the merge event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    mergeRef (Ref)

    Identifies the Ref associated with the merge event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    mergeRefName (String!)

    Identifies the name of the Ref associated with the merge event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    PullRequest referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this merged event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this merged event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Milestone\n

    \n

    Represents a Milestone object on a given repository.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    closed (Boolean!)

    true if the object is closed (definition of closed may depend on type).

    \n\n\n\n\n\n\n\n\n\n\n\n

    closedAt (DateTime)

    Identifies the date and time when the object was closed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    creator (Actor)

    Identifies the actor who created the milestone.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String)

    Identifies the description of the milestone.

    \n\n\n\n\n\n\n\n\n\n\n\n

    dueOn (DateTime)

    Identifies the due date of the milestone.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issues (IssueConnection!)

    A list of issues associated with the milestone.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    filterBy (IssueFilters)

    \n

    Filtering options for issues returned from the connection.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    labels ([String!])

    \n

    A list of label names to filter the pull requests by.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (IssueOrder)

    \n

    Ordering options for issues returned from the connection.

    \n\n
    \n\n
    \n

    states ([IssueState!])

    \n

    A list of states to filter the issues by.

    \n\n
    \n\n
    \n\n\n

    number (Int!)

    Identifies the number of the milestone.

    \n\n\n\n\n\n\n\n\n\n\n\n

    progressPercentage (Float!)

    Identifies the percentage complete for the milestone.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequests (PullRequestConnection!)

    A list of pull requests associated with the milestone.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    baseRefName (String)

    \n

    The base ref name to filter the pull requests by.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    headRefName (String)

    \n

    The head ref name to filter the pull requests by.

    \n\n
    \n\n
    \n

    labels ([String!])

    \n

    A list of label names to filter the pull requests by.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (IssueOrder)

    \n

    Ordering options for pull requests returned from the connection.

    \n\n
    \n\n
    \n

    states ([PullRequestState!])

    \n

    A list of states to filter the pull requests by.

    \n\n
    \n\n
    \n\n\n

    repository (Repository!)

    The repository associated with this milestone.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this milestone.

    \n\n\n\n\n\n\n\n\n\n\n\n

    state (MilestoneState!)

    Identifies the state of the milestone.

    \n\n\n\n\n\n\n\n\n\n\n\n

    title (String!)

    Identifies the title of the milestone.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this milestone.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n MilestoneConnection\n

    \n

    The connection type for Milestone.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([MilestoneEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Milestone])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n MilestoneEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (Milestone)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n MilestonedEvent\n

    \n

    Represents amilestonedevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    milestoneTitle (String!)

    Identifies the milestone title associated with themilestonedevent.

    \n\n\n\n\n\n\n\n\n\n\n\n

    subject (MilestoneItem!)

    Object referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n MovedColumnsInProjectEvent\n

    \n

    Represents amoved_columns_in_projectevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    previousProjectColumnName (String!)

    Column name the issue or pull request was moved from.

    \n\n\n\n\n
    \n

    Preview notice

    \n

    previousProjectColumnName is available under the Project event details preview. During the preview period, the API may change without notice.

    \n
    \n\n\n\n\n\n\n\n\n

    project (Project)

    Project referenced by event.

    \n\n\n\n\n
    \n

    Preview notice

    \n

    project is available under the Project event details preview. During the preview period, the API may change without notice.

    \n
    \n\n\n\n\n\n\n\n\n

    projectCard (ProjectCard)

    Project card referenced by this project event.

    \n\n\n\n\n
    \n

    Preview notice

    \n

    projectCard is available under the Project event details preview. During the preview period, the API may change without notice.

    \n
    \n\n\n\n\n\n\n\n\n

    projectColumnName (String!)

    Column name the issue or pull request was moved to.

    \n\n\n\n\n
    \n

    Preview notice

    \n

    projectColumnName is available under the Project event details preview. During the preview period, the API may change without notice.

    \n
    \n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OauthApplicationCreateAuditEntry\n

    \n

    Audit log entry for a oauth_application.create event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    applicationUrl (URI)

    The application URL of the OAuth Application.

    \n\n\n\n\n\n\n\n\n\n\n\n

    callbackUrl (URI)

    The callback URL of the OAuth Application.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    oauthApplicationName (String)

    The name of the OAuth Application.

    \n\n\n\n\n\n\n\n\n\n\n\n

    oauthApplicationResourcePath (URI)

    The HTTP path for the OAuth Application.

    \n\n\n\n\n\n\n\n\n\n\n\n

    oauthApplicationUrl (URI)

    The HTTP URL for the OAuth Application.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    rateLimit (Int)

    The rate limit of the OAuth Application.

    \n\n\n\n\n\n\n\n\n\n\n\n

    state (OauthApplicationCreateAuditEntryState)

    The state of the OAuth Application.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgAddBillingManagerAuditEntry\n

    \n

    Audit log entry for a org.add_billing_manager.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    invitationEmail (String)

    The email address used to invite a billing manager for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgAddMemberAuditEntry\n

    \n

    Audit log entry for a org.add_member.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    permission (OrgAddMemberAuditEntryPermission)

    The permission level of the member added to the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgBlockUserAuditEntry\n

    \n

    Audit log entry for a org.block_user.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    blockedUser (User)

    The blocked user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    blockedUserName (String)

    The username of the blocked user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    blockedUserResourcePath (URI)

    The HTTP path for the blocked user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    blockedUserUrl (URI)

    The HTTP URL for the blocked user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgConfigDisableCollaboratorsOnlyAuditEntry\n

    \n

    Audit log entry for a org.config.disable_collaborators_only event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgConfigEnableCollaboratorsOnlyAuditEntry\n

    \n

    Audit log entry for a org.config.enable_collaborators_only event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgCreateAuditEntry\n

    \n

    Audit log entry for a org.create event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    billingPlan (OrgCreateAuditEntryBillingPlan)

    The billing plan for the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgDisableOauthAppRestrictionsAuditEntry\n

    \n

    Audit log entry for a org.disable_oauth_app_restrictions event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgDisableSamlAuditEntry\n

    \n

    Audit log entry for a org.disable_saml event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    digestMethodUrl (URI)

    The SAML provider's digest algorithm URL.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issuerUrl (URI)

    The SAML provider's issuer URL.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    signatureMethodUrl (URI)

    The SAML provider's signature algorithm URL.

    \n\n\n\n\n\n\n\n\n\n\n\n

    singleSignOnUrl (URI)

    The SAML provider's single sign-on URL.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgDisableTwoFactorRequirementAuditEntry\n

    \n

    Audit log entry for a org.disable_two_factor_requirement event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgEnableOauthAppRestrictionsAuditEntry\n

    \n

    Audit log entry for a org.enable_oauth_app_restrictions event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgEnableSamlAuditEntry\n

    \n

    Audit log entry for a org.enable_saml event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    digestMethodUrl (URI)

    The SAML provider's digest algorithm URL.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issuerUrl (URI)

    The SAML provider's issuer URL.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    signatureMethodUrl (URI)

    The SAML provider's signature algorithm URL.

    \n\n\n\n\n\n\n\n\n\n\n\n

    singleSignOnUrl (URI)

    The SAML provider's single sign-on URL.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgEnableTwoFactorRequirementAuditEntry\n

    \n

    Audit log entry for a org.enable_two_factor_requirement event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgInviteMemberAuditEntry\n

    \n

    Audit log entry for a org.invite_member event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    email (String)

    The email address of the organization invitation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationInvitation (OrganizationInvitation)

    The organization invitation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgInviteToBusinessAuditEntry\n

    \n

    Audit log entry for a org.invite_to_business event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseResourcePath (URI)

    The HTTP path for this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseSlug (String)

    The slug of the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseUrl (URI)

    The HTTP URL for this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgOauthAppAccessApprovedAuditEntry\n

    \n

    Audit log entry for a org.oauth_app_access_approved event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    oauthApplicationName (String)

    The name of the OAuth Application.

    \n\n\n\n\n\n\n\n\n\n\n\n

    oauthApplicationResourcePath (URI)

    The HTTP path for the OAuth Application.

    \n\n\n\n\n\n\n\n\n\n\n\n

    oauthApplicationUrl (URI)

    The HTTP URL for the OAuth Application.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgOauthAppAccessDeniedAuditEntry\n

    \n

    Audit log entry for a org.oauth_app_access_denied event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    oauthApplicationName (String)

    The name of the OAuth Application.

    \n\n\n\n\n\n\n\n\n\n\n\n

    oauthApplicationResourcePath (URI)

    The HTTP path for the OAuth Application.

    \n\n\n\n\n\n\n\n\n\n\n\n

    oauthApplicationUrl (URI)

    The HTTP URL for the OAuth Application.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgOauthAppAccessRequestedAuditEntry\n

    \n

    Audit log entry for a org.oauth_app_access_requested event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    oauthApplicationName (String)

    The name of the OAuth Application.

    \n\n\n\n\n\n\n\n\n\n\n\n

    oauthApplicationResourcePath (URI)

    The HTTP path for the OAuth Application.

    \n\n\n\n\n\n\n\n\n\n\n\n

    oauthApplicationUrl (URI)

    The HTTP URL for the OAuth Application.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgRemoveBillingManagerAuditEntry\n

    \n

    Audit log entry for a org.remove_billing_manager event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reason (OrgRemoveBillingManagerAuditEntryReason)

    The reason for the billing manager being removed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgRemoveMemberAuditEntry\n

    \n

    Audit log entry for a org.remove_member event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    membershipTypes ([OrgRemoveMemberAuditEntryMembershipType!])

    The types of membership the member has with the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reason (OrgRemoveMemberAuditEntryReason)

    The reason for the member being removed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgRemoveOutsideCollaboratorAuditEntry\n

    \n

    Audit log entry for a org.remove_outside_collaborator event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    membershipTypes ([OrgRemoveOutsideCollaboratorAuditEntryMembershipType!])

    The types of membership the outside collaborator has with the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reason (OrgRemoveOutsideCollaboratorAuditEntryReason)

    The reason for the outside collaborator being removed from the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgRestoreMemberAuditEntry\n

    \n

    Audit log entry for a org.restore_member event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    restoredCustomEmailRoutingsCount (Int)

    The number of custom email routings for the restored member.

    \n\n\n\n\n\n\n\n\n\n\n\n

    restoredIssueAssignmentsCount (Int)

    The number of issue assignments for the restored member.

    \n\n\n\n\n\n\n\n\n\n\n\n

    restoredMemberships ([OrgRestoreMemberAuditEntryMembership!])

    Restored organization membership objects.

    \n\n\n\n\n\n\n\n\n\n\n\n

    restoredMembershipsCount (Int)

    The number of restored memberships.

    \n\n\n\n\n\n\n\n\n\n\n\n

    restoredRepositoriesCount (Int)

    The number of repositories of the restored member.

    \n\n\n\n\n\n\n\n\n\n\n\n

    restoredRepositoryStarsCount (Int)

    The number of starred repositories for the restored member.

    \n\n\n\n\n\n\n\n\n\n\n\n

    restoredRepositoryWatchesCount (Int)

    The number of watched repositories for the restored member.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgRestoreMemberMembershipOrganizationAuditEntryData\n

    \n

    Metadata for an organization membership for org.restore_member actions.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgRestoreMemberMembershipRepositoryAuditEntryData\n

    \n

    Metadata for a repository membership for org.restore_member actions.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgRestoreMemberMembershipTeamAuditEntryData\n

    \n

    Metadata for a team membership for org.restore_member actions.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    team (Team)

    The team associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamName (String)

    The name of the team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamResourcePath (URI)

    The HTTP path for this team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamUrl (URI)

    The HTTP URL for this team.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgUnblockUserAuditEntry\n

    \n

    Audit log entry for a org.unblock_user.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    blockedUser (User)

    The user being unblocked by the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    blockedUserName (String)

    The username of the blocked user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    blockedUserResourcePath (URI)

    The HTTP path for the blocked user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    blockedUserUrl (URI)

    The HTTP URL for the blocked user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgUpdateDefaultRepositoryPermissionAuditEntry\n

    \n

    Audit log entry for a org.update_default_repository_permission.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    permission (OrgUpdateDefaultRepositoryPermissionAuditEntryPermission)

    The new default repository permission level for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    permissionWas (OrgUpdateDefaultRepositoryPermissionAuditEntryPermission)

    The former default repository permission level for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgUpdateMemberAuditEntry\n

    \n

    Audit log entry for a org.update_member event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    permission (OrgUpdateMemberAuditEntryPermission)

    The new member permission level for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    permissionWas (OrgUpdateMemberAuditEntryPermission)

    The former member permission level for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgUpdateMemberRepositoryCreationPermissionAuditEntry\n

    \n

    Audit log entry for a org.update_member_repository_creation_permission event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    canCreateRepositories (Boolean)

    Can members create repositories in the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    visibility (OrgUpdateMemberRepositoryCreationPermissionAuditEntryVisibility)

    The permission for visibility level of repositories for this organization.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgUpdateMemberRepositoryInvitationPermissionAuditEntry\n

    \n

    Audit log entry for a org.update_member_repository_invitation_permission event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    canInviteOutsideCollaboratorsToRepositories (Boolean)

    Can outside collaborators be invited to repositories in the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Organization\n

    \n

    An account on GitHub, with one or more owners, that has repositories, members and teams.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    anyPinnableItems (Boolean!)

    Determine if this repository owner has any items that can be pinned to their profile.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    type (PinnableItemType)

    \n

    Filter to only a particular kind of pinnable item.

    \n\n
    \n\n
    \n\n\n

    auditLog (OrganizationAuditEntryConnection!)

    Audit log entries of the organization.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (AuditLogOrder)

    \n

    Ordering options for the returned audit log entries.

    \n\n
    \n\n
    \n

    query (String)

    \n

    The query string to filter audit entries.

    \n\n
    \n\n
    \n\n\n

    avatarUrl (URI!)

    A URL pointing to the organization's public avatar.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    size (Int)

    \n

    The size of the resulting square image.

    \n\n
    \n\n
    \n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String)

    The organization's public profile description.

    \n\n\n\n\n\n\n\n\n\n\n\n

    descriptionHTML (String)

    The organization's public profile description rendered to HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    domains (VerifiableDomainConnection)

    A list of domains owned by the organization.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    isVerified (Boolean)

    \n

    Filter by if the domain is verified.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (VerifiableDomainOrder)

    \n

    Ordering options for verifiable domains returned.

    \n\n
    \n\n
    \n\n\n

    email (String)

    The organization's public email.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hasSponsorsListing (Boolean!)

    True if this user/organization has a GitHub Sponsors listing.

    \n\n\n\n\n\n\n\n\n\n\n\n

    interactionAbility (RepositoryInteractionAbility)

    The interaction ability settings for this organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ipAllowListEnabledSetting (IpAllowListEnabledSettingValue!)

    The setting value for whether the organization has an IP allow list enabled.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ipAllowListEntries (IpAllowListEntryConnection!)

    The IP addresses that are allowed to access resources owned by the organization.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (IpAllowListEntryOrder)

    \n

    Ordering options for IP allow list entries returned.

    \n\n
    \n\n
    \n\n\n

    isSponsoredBy (Boolean!)

    Check if the given account is sponsoring this user/organization.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    accountLogin (String!)

    \n

    The target account's login.

    \n\n
    \n\n
    \n\n\n

    isSponsoringViewer (Boolean!)

    True if the viewer is sponsored by this user/organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isVerified (Boolean!)

    Whether the organization has verified its profile email and website, always false on Enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    itemShowcase (ProfileItemShowcase!)

    Showcases a selection of repositories and gists that the profile owner has\neither curated or that have been selected automatically based on popularity.

    \n\n\n\n\n\n\n\n\n\n\n\n

    location (String)

    The organization's public profile location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    login (String!)

    The organization's login name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    memberStatuses (UserStatusConnection!)

    Get the status messages members of this entity have set that are either public or visible only to the organization.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (UserStatusOrder)

    \n

    Ordering options for user statuses returned from the connection.

    \n\n
    \n\n
    \n\n\n

    membersWithRole (OrganizationMemberConnection!)

    A list of users who are members of this organization.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    name (String)

    The organization's public profile name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    newTeamResourcePath (URI!)

    The HTTP path creating a new team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    newTeamUrl (URI!)

    The HTTP URL creating a new team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    notificationDeliveryRestrictionEnabledSetting (NotificationRestrictionSettingValue!)

    Indicates if email notification delivery for this organization is restricted to verified domains.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationBillingEmail (String)

    The billing email for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    packages (PackageConnection!)

    A list of packages under the owner.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    names ([String])

    \n

    Find packages by their names.

    \n\n
    \n\n
    \n

    orderBy (PackageOrder)

    \n

    Ordering of the returned packages.

    \n\n
    \n\n
    \n

    packageType (PackageType)

    \n

    Filter registry package by type.

    \n\n
    \n\n
    \n

    repositoryId (ID)

    \n

    Find packages in a repository by ID.

    \n\n
    \n\n
    \n\n\n

    pendingMembers (UserConnection!)

    A list of users who have been invited to join this organization.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    pinnableItems (PinnableItemConnection!)

    A list of repositories and gists this profile owner can pin to their profile.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    types ([PinnableItemType!])

    \n

    Filter the types of pinnable items that are returned.

    \n\n
    \n\n
    \n\n\n

    pinnedItems (PinnableItemConnection!)

    A list of repositories and gists this profile owner has pinned to their profile.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    types ([PinnableItemType!])

    \n

    Filter the types of pinned items that are returned.

    \n\n
    \n\n
    \n\n\n

    pinnedItemsRemaining (Int!)

    Returns how many more items this profile owner can pin to their profile.

    \n\n\n\n\n\n\n\n\n\n\n\n

    project (Project)

    Find project by number.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    number (Int!)

    \n

    The project number to find.

    \n\n
    \n\n
    \n\n\n

    projects (ProjectConnection!)

    A list of projects under the owner.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (ProjectOrder)

    \n

    Ordering options for projects returned from the connection.

    \n\n
    \n\n
    \n

    search (String)

    \n

    Query to search projects by, currently only searching by name.

    \n\n
    \n\n
    \n

    states ([ProjectState!])

    \n

    A list of states to filter the projects by.

    \n\n
    \n\n
    \n\n\n

    projectsResourcePath (URI!)

    The HTTP path listing organization's projects.

    \n\n\n\n\n\n\n\n\n\n\n\n

    projectsUrl (URI!)

    The HTTP URL listing organization's projects.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositories (RepositoryConnection!)

    A list of repositories that the user owns.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    affiliations ([RepositoryAffiliation])

    \n

    Array of viewer's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\ncurrent viewer owns.

    \n\n
    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    isFork (Boolean)

    \n

    If non-null, filters repositories according to whether they are forks of another repository.

    \n\n
    \n\n
    \n

    isLocked (Boolean)

    \n

    If non-null, filters repositories according to whether they have been locked.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (RepositoryOrder)

    \n

    Ordering options for repositories returned from the connection.

    \n\n
    \n\n
    \n

    ownerAffiliations ([RepositoryAffiliation])

    \n

    Array of owner's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\norganization or user being viewed owns.

    \n\n
    \n\n
    \n

    privacy (RepositoryPrivacy)

    \n

    If non-null, filters repositories according to privacy.

    \n\n
    \n\n
    \n\n\n

    repository (Repository)

    Find Repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    name (String!)

    \n

    Name of Repository to find.

    \n\n
    \n\n
    \n\n\n

    requiresTwoFactorAuthentication (Boolean)

    When true the organization requires all members, billing managers, and outside\ncollaborators to enable two-factor authentication.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    samlIdentityProvider (OrganizationIdentityProvider)

    The Organization's SAML identity providers.

    \n\n\n\n\n\n\n\n\n\n\n\n

    sponsorsListing (SponsorsListing)

    The GitHub Sponsors listing for this user or organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    sponsorshipForViewerAsSponsor (Sponsorship)

    The viewer's sponsorship of this entity.

    \n\n\n\n\n\n\n\n\n\n\n\n

    sponsorshipsAsMaintainer (SponsorshipConnection!)

    This object's sponsorships as the maintainer.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    includePrivate (Boolean)

    \n

    Whether or not to include private sponsorships in the result set.

    \n

    The default value is false.

    \n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (SponsorshipOrder)

    \n

    Ordering options for sponsorships returned from this connection. If left\nblank, the sponsorships will be ordered based on relevancy to the viewer.

    \n\n
    \n\n
    \n\n\n

    sponsorshipsAsSponsor (SponsorshipConnection!)

    This object's sponsorships as the sponsor.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (SponsorshipOrder)

    \n

    Ordering options for sponsorships returned from this connection. If left\nblank, the sponsorships will be ordered based on relevancy to the viewer.

    \n\n
    \n\n
    \n\n\n

    team (Team)

    Find an organization's team by its slug.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    slug (String!)

    \n

    The name or slug of the team to find.

    \n\n
    \n\n
    \n\n\n

    teams (TeamConnection!)

    A list of teams in this organization.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    ldapMapped (Boolean)

    \n

    If true, filters teams that are mapped to an LDAP Group (Enterprise only).

    \n\n
    \n\n
    \n

    orderBy (TeamOrder)

    \n

    Ordering options for teams returned from the connection.

    \n\n
    \n\n
    \n

    privacy (TeamPrivacy)

    \n

    If non-null, filters teams according to privacy.

    \n\n
    \n\n
    \n

    query (String)

    \n

    If non-null, filters teams with query on team name and team slug.

    \n\n
    \n\n
    \n

    role (TeamRole)

    \n

    If non-null, filters teams according to whether the viewer is an admin or member on team.

    \n\n
    \n\n
    \n

    rootTeamsOnly (Boolean)

    \n

    If true, restrict to only root teams.

    \n

    The default value is false.

    \n
    \n\n
    \n

    userLogins ([String!])

    \n

    User logins to filter by.

    \n\n
    \n\n
    \n\n\n

    teamsResourcePath (URI!)

    The HTTP path listing organization's teams.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamsUrl (URI!)

    The HTTP URL listing organization's teams.

    \n\n\n\n\n\n\n\n\n\n\n\n

    twitterUsername (String)

    The organization's Twitter username.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanAdminister (Boolean!)

    Organization is adminable by the viewer.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanChangePinnedItems (Boolean!)

    Can the viewer pin repositories and gists to the profile?.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanCreateProjects (Boolean!)

    Can the current viewer create new projects on this owner.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanCreateRepositories (Boolean!)

    Viewer can create repositories on this organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanCreateTeams (Boolean!)

    Viewer can create teams on this organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanSponsor (Boolean!)

    Whether or not the viewer is able to sponsor this user/organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerIsAMember (Boolean!)

    Viewer is an active member of this organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerIsSponsoring (Boolean!)

    True if the viewer is sponsoring this user/organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    websiteUrl (URI)

    The organization's public profile URL.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrganizationAuditEntryConnection\n

    \n

    The connection type for OrganizationAuditEntry.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([OrganizationAuditEntryEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([OrganizationAuditEntry])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrganizationAuditEntryEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (OrganizationAuditEntry)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrganizationConnection\n

    \n

    The connection type for Organization.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([OrganizationEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Organization])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrganizationEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (Organization)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrganizationIdentityProvider\n

    \n

    An Identity Provider configured to provision SAML and SCIM identities for Organizations.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    digestMethod (URI)

    The digest algorithm used to sign SAML requests for the Identity Provider.

    \n\n\n\n\n\n\n\n\n\n\n\n

    externalIdentities (ExternalIdentityConnection!)

    External Identities provisioned by this Identity Provider.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    idpCertificate (X509Certificate)

    The x509 certificate used by the Identity Provider to sign assertions and responses.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issuer (String)

    The Issuer Entity ID for the SAML Identity Provider.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    Organization this Identity Provider belongs to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    signatureMethod (URI)

    The signature algorithm used to sign SAML requests for the Identity Provider.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ssoUrl (URI)

    The URL endpoint for the Identity Provider's SAML SSO.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrganizationInvitation\n

    \n

    An Invitation for a user to an organization.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    email (String)

    The email address of the user invited to the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    invitationType (OrganizationInvitationType!)

    The type of invitation that was sent (e.g. email, user).

    \n\n\n\n\n\n\n\n\n\n\n\n

    invitee (User)

    The user who was invited to the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    inviter (User!)

    The user who created the invitation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization!)

    The organization the invite is for.

    \n\n\n\n\n\n\n\n\n\n\n\n

    role (OrganizationInvitationRole!)

    The user's pending role in the organization (e.g. member, owner).

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrganizationInvitationConnection\n

    \n

    The connection type for OrganizationInvitation.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([OrganizationInvitationEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([OrganizationInvitation])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrganizationInvitationEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (OrganizationInvitation)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrganizationMemberConnection\n

    \n

    The connection type for User.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([OrganizationMemberEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([User])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrganizationMemberEdge\n

    \n

    Represents a user within an organization.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hasTwoFactorEnabled (Boolean)

    Whether the organization member has two factor enabled or not. Returns null if information is not available to viewer.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (User)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n

    role (OrganizationMemberRole)

    The role this user has in the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrganizationTeamsHovercardContext\n

    \n

    An organization teams hovercard context.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    message (String!)

    A string describing this context.

    \n\n\n\n\n\n\n\n\n\n\n\n

    octicon (String!)

    An octicon to accompany this context.

    \n\n\n\n\n\n\n\n\n\n\n\n

    relevantTeams (TeamConnection!)

    Teams in this organization the user is a member of that are relevant.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    teamsResourcePath (URI!)

    The path for the full team list for this user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamsUrl (URI!)

    The URL for the full team list for this user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalTeamCount (Int!)

    The total number of teams the user is on in the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrganizationsHovercardContext\n

    \n

    An organization list hovercard context.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    message (String!)

    A string describing this context.

    \n\n\n\n\n\n\n\n\n\n\n\n

    octicon (String!)

    An octicon to accompany this context.

    \n\n\n\n\n\n\n\n\n\n\n\n

    relevantOrganizations (OrganizationConnection!)

    Organizations this user is a member of that are relevant.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    totalOrganizationCount (Int!)

    The total number of organizations this user is in.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Package\n

    \n

    Information for an uploaded package.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    latestVersion (PackageVersion)

    Find the latest version for the package.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    Identifies the name of the package.

    \n\n\n\n\n\n\n\n\n\n\n\n

    packageType (PackageType!)

    Identifies the type of the package.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository this package belongs to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    statistics (PackageStatistics)

    Statistics about package activity.

    \n\n\n\n\n\n\n\n\n\n\n\n

    version (PackageVersion)

    Find package version by version string.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    version (String!)

    \n

    The package version.

    \n\n
    \n\n
    \n\n\n

    versions (PackageVersionConnection!)

    list of versions for this package.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (PackageVersionOrder)

    \n

    Ordering of the returned packages.

    \n\n
    \n\n
    \n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PackageConnection\n

    \n

    The connection type for Package.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([PackageEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Package])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PackageEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (Package)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PackageFile\n

    \n

    A file in a package version.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    md5 (String)

    MD5 hash of the file.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    Name of the file.

    \n\n\n\n\n\n\n\n\n\n\n\n

    packageVersion (PackageVersion)

    The package version this file belongs to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    sha1 (String)

    SHA1 hash of the file.

    \n\n\n\n\n\n\n\n\n\n\n\n

    sha256 (String)

    SHA256 hash of the file.

    \n\n\n\n\n\n\n\n\n\n\n\n

    size (Int)

    Size of the file in bytes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI)

    URL to download the asset.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PackageFileConnection\n

    \n

    The connection type for PackageFile.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([PackageFileEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([PackageFile])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PackageFileEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (PackageFile)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PackageStatistics\n

    \n

    Represents a object that contains package activity statistics such as downloads.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    downloadsTotalCount (Int!)

    Number of times the package was downloaded since it was created.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PackageTag\n

    \n

    A version tag contains the mapping between a tag name and a version.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    name (String!)

    Identifies the tag name of the version.

    \n\n\n\n\n\n\n\n\n\n\n\n

    version (PackageVersion)

    Version that the tag is associated with.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PackageVersion\n

    \n

    Information about a specific package version.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    files (PackageFileConnection!)

    List of files associated with this package version.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (PackageFileOrder)

    \n

    Ordering of the returned package files.

    \n\n
    \n\n
    \n\n\n

    package (Package)

    The package associated with this version.

    \n\n\n\n\n\n\n\n\n\n\n\n

    platform (String)

    The platform this version was built for.

    \n\n\n\n\n\n\n\n\n\n\n\n

    preRelease (Boolean!)

    Whether or not this version is a pre-release.

    \n\n\n\n\n\n\n\n\n\n\n\n

    readme (String)

    The README of this package version.

    \n\n\n\n\n\n\n\n\n\n\n\n

    release (Release)

    The release associated with this package version.

    \n\n\n\n\n\n\n\n\n\n\n\n

    statistics (PackageVersionStatistics)

    Statistics about package activity.

    \n\n\n\n\n\n\n\n\n\n\n\n

    summary (String)

    The package version summary.

    \n\n\n\n\n\n\n\n\n\n\n\n

    version (String!)

    The version string.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PackageVersionConnection\n

    \n

    The connection type for PackageVersion.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([PackageVersionEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([PackageVersion])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PackageVersionEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (PackageVersion)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PackageVersionStatistics\n

    \n

    Represents a object that contains package version activity statistics such as downloads.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    downloadsTotalCount (Int!)

    Number of times the package was downloaded since it was created.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PageInfo\n

    \n

    Information about pagination in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    endCursor (String)

    When paginating forwards, the cursor to continue.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hasNextPage (Boolean!)

    When paginating forwards, are there more items?.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hasPreviousPage (Boolean!)

    When paginating backwards, are there more items?.

    \n\n\n\n\n\n\n\n\n\n\n\n

    startCursor (String)

    When paginating backwards, the cursor to continue.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PermissionSource\n

    \n

    A level of permission and source for a user's access to a repository.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    organization (Organization!)

    The organization the repository belongs to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    permission (DefaultRepositoryPermissionField!)

    The level of access this source has granted to the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    source (PermissionGranter!)

    The source of this permission.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PinnableItemConnection\n

    \n

    The connection type for PinnableItem.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([PinnableItemEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([PinnableItem])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PinnableItemEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (PinnableItem)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PinnedEvent\n

    \n

    Represents apinnedevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issue (Issue!)

    Identifies the issue associated with the event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PinnedIssue\n

    \n

    A Pinned Issue is a issue pinned to a repository's index page.

    \n
    \n\n
    \n \n
    \n

    Preview notice

    \n

    PinnedIssue is available under the Pinned issues preview. During the preview period, the API may change without notice.

    \n
    \n\n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issue (Issue!)

    The issue that was pinned.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pinnedBy (Actor!)

    The actor that pinned this issue.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository!)

    The repository that this issue was pinned to.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PinnedIssueConnection\n

    \n

    The connection type for PinnedIssue.

    \n
    \n\n
    \n \n
    \n

    Preview notice

    \n

    PinnedIssueConnection is available under the Pinned issues preview. During the preview period, the API may change without notice.

    \n
    \n\n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([PinnedIssueEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([PinnedIssue])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PinnedIssueEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n
    \n

    Preview notice

    \n

    PinnedIssueEdge is available under the Pinned issues preview. During the preview period, the API may change without notice.

    \n
    \n\n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (PinnedIssue)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PrivateRepositoryForkingDisableAuditEntry\n

    \n

    Audit log entry for a private_repository_forking.disable event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseResourcePath (URI)

    The HTTP path for this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseSlug (String)

    The slug of the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseUrl (URI)

    The HTTP URL for this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PrivateRepositoryForkingEnableAuditEntry\n

    \n

    Audit log entry for a private_repository_forking.enable event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseResourcePath (URI)

    The HTTP path for this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseSlug (String)

    The slug of the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseUrl (URI)

    The HTTP URL for this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ProfileItemShowcase\n

    \n

    A curatable list of repositories relating to a repository owner, which defaults\nto showing the most popular repositories they own.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    hasPinnedItems (Boolean!)

    Whether or not the owner has pinned any repositories or gists.

    \n\n\n\n\n\n\n\n\n\n\n\n

    items (PinnableItemConnection!)

    The repositories and gists in the showcase. If the profile owner has any\npinned items, those will be returned. Otherwise, the profile owner's popular\nrepositories will be returned.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Project\n

    \n

    Projects manage issues, pull requests and notes within a project owner.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String)

    The project's description body.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyHTML (HTML!)

    The projects description body rendered to HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    closed (Boolean!)

    true if the object is closed (definition of closed may depend on type).

    \n\n\n\n\n\n\n\n\n\n\n\n

    closedAt (DateTime)

    Identifies the date and time when the object was closed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    columns (ProjectColumnConnection!)

    List of columns in the project.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    creator (Actor)

    The actor who originally created the project.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The project's name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    number (Int!)

    The project's number.

    \n\n\n\n\n\n\n\n\n\n\n\n

    owner (ProjectOwner!)

    The project's owner. Currently limited to repositories, organizations, and users.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pendingCards (ProjectCardConnection!)

    List of pending cards in this project.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    archivedStates ([ProjectCardArchivedState])

    \n

    A list of archived states to filter the cards by.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    progress (ProjectProgress!)

    Project progress details.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this project.

    \n\n\n\n\n\n\n\n\n\n\n\n

    state (ProjectState!)

    Whether the project is open or closed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this project.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanUpdate (Boolean!)

    Check if the current viewer can update this object.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ProjectCard\n

    \n

    A card in a project.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    column (ProjectColumn)

    The project column this card is associated under. A card may only belong to one\nproject column at a time. The column field will be null if the card is created\nin a pending state and has yet to be associated with a column. Once cards are\nassociated with a column, they will not become pending in the future.

    \n\n\n\n\n\n\n\n\n\n\n\n

    content (ProjectCardItem)

    The card content item.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    creator (Actor)

    The actor who created this card.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isArchived (Boolean!)

    Whether the card is archived.

    \n\n\n\n\n\n\n\n\n\n\n\n

    note (String)

    The card note.

    \n\n\n\n\n\n\n\n\n\n\n\n

    project (Project!)

    The project that contains this card.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this card.

    \n\n\n\n\n\n\n\n\n\n\n\n

    state (ProjectCardState)

    The state of ProjectCard.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this card.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ProjectCardConnection\n

    \n

    The connection type for ProjectCard.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([ProjectCardEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([ProjectCard])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ProjectCardEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (ProjectCard)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ProjectColumn\n

    \n

    A column inside a project.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cards (ProjectCardConnection!)

    List of cards in the column.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    archivedStates ([ProjectCardArchivedState])

    \n

    A list of archived states to filter the cards by.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The project column's name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    project (Project!)

    The project that contains this column.

    \n\n\n\n\n\n\n\n\n\n\n\n

    purpose (ProjectColumnPurpose)

    The semantic purpose of the column.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this project column.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this project column.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ProjectColumnConnection\n

    \n

    The connection type for ProjectColumn.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([ProjectColumnEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([ProjectColumn])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ProjectColumnEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (ProjectColumn)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ProjectConnection\n

    \n

    A list of projects associated with the owner.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([ProjectEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Project])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ProjectEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (Project)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ProjectProgress\n

    \n

    Project progress stats.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    doneCount (Int!)

    The number of done cards.

    \n\n\n\n\n\n\n\n\n\n\n\n

    donePercentage (Float!)

    The percentage of done cards.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enabled (Boolean!)

    Whether progress tracking is enabled and cards with purpose exist for this project.

    \n\n\n\n\n\n\n\n\n\n\n\n

    inProgressCount (Int!)

    The number of in-progress cards.

    \n\n\n\n\n\n\n\n\n\n\n\n

    inProgressPercentage (Float!)

    The percentage of in-progress cards.

    \n\n\n\n\n\n\n\n\n\n\n\n

    todoCount (Int!)

    The number of to do cards.

    \n\n\n\n\n\n\n\n\n\n\n\n

    todoPercentage (Float!)

    The percentage of to do cards.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PublicKey\n

    \n

    A user's public key.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    accessedAt (DateTime)

    The last time this authorization was used to perform an action. Values will be null for keys not owned by the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime)

    Identifies the date and time when the key was created. Keys created before\nMarch 5th, 2014 have inaccurate values. Values will be null for keys not owned by the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    fingerprint (String!)

    The fingerprint for this PublicKey.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isReadOnly (Boolean)

    Whether this PublicKey is read-only or not. Values will be null for keys not owned by the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    key (String!)

    The public key string.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime)

    Identifies the date and time when the key was updated. Keys created before\nMarch 5th, 2014 may have inaccurate values. Values will be null for keys not\nowned by the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PublicKeyConnection\n

    \n

    The connection type for PublicKey.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([PublicKeyEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([PublicKey])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PublicKeyEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (PublicKey)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequest\n

    \n

    A repository pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    activeLockReason (LockReason)

    Reason that the conversation was locked.

    \n\n\n\n\n\n\n\n\n\n\n\n

    additions (Int!)

    The number of additions in this pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    assignees (UserConnection!)

    A list of Users assigned to this object.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    author (Actor)

    The actor who authored the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    authorAssociation (CommentAuthorAssociation!)

    Author's association with the subject of the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    autoMergeRequest (AutoMergeRequest)

    Returns the auto-merge request object if one exists for this pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    baseRef (Ref)

    Identifies the base Ref associated with the pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    baseRefName (String!)

    Identifies the name of the base Ref associated with the pull request, even if the ref has been deleted.

    \n\n\n\n\n\n\n\n\n\n\n\n

    baseRefOid (GitObjectID!)

    Identifies the oid of the base ref associated with the pull request, even if the ref has been deleted.

    \n\n\n\n\n\n\n\n\n\n\n\n

    baseRepository (Repository)

    The repository associated with this pull request's base Ref.

    \n\n\n\n\n\n\n\n\n\n\n\n

    body (String!)

    The body as Markdown.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyHTML (HTML!)

    The body rendered to HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyText (String!)

    The body rendered to text.

    \n\n\n\n\n\n\n\n\n\n\n\n

    canBeRebased (Boolean!)

    Whether or not the pull request is rebaseable.

    \n\n\n\n\n
    \n

    Preview notice

    \n

    canBeRebased is available under the Merge info preview. During the preview period, the API may change without notice.

    \n
    \n\n\n\n\n\n\n\n\n

    changedFiles (Int!)

    The number of changed files in this pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    checksResourcePath (URI!)

    The HTTP path for the checks of this pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    checksUrl (URI!)

    The HTTP URL for the checks of this pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    closed (Boolean!)

    true if the pull request is closed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    closedAt (DateTime)

    Identifies the date and time when the object was closed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    comments (IssueCommentConnection!)

    A list of comments associated with the pull request.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (IssueCommentOrder)

    \n

    Ordering options for issue comments returned from the connection.

    \n\n
    \n\n
    \n\n\n

    commits (PullRequestCommitConnection!)

    A list of commits present in this pull request's head branch not present in the base branch.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdViaEmail (Boolean!)

    Check if this comment was created via an email reply.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    deletions (Int!)

    The number of deletions in this pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    editor (Actor)

    The actor who edited this pull request's body.

    \n\n\n\n\n\n\n\n\n\n\n\n

    files (PullRequestChangedFileConnection)

    Lists the files changed within this pull request.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    headRef (Ref)

    Identifies the head Ref associated with the pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    headRefName (String!)

    Identifies the name of the head Ref associated with the pull request, even if the ref has been deleted.

    \n\n\n\n\n\n\n\n\n\n\n\n

    headRefOid (GitObjectID!)

    Identifies the oid of the head ref associated with the pull request, even if the ref has been deleted.

    \n\n\n\n\n\n\n\n\n\n\n\n

    headRepository (Repository)

    The repository associated with this pull request's head Ref.

    \n\n\n\n\n\n\n\n\n\n\n\n

    headRepositoryOwner (RepositoryOwner)

    The owner of the repository associated with this pull request's head Ref.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hovercard (Hovercard!)

    The hovercard information for this issue.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    includeNotificationContexts (Boolean)

    \n

    Whether or not to include notification contexts.

    \n

    The default value is true.

    \n
    \n\n
    \n\n\n

    includesCreatedEdit (Boolean!)

    Check if this comment was edited and includes an edit with the creation data.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isCrossRepository (Boolean!)

    The head and base repositories are different.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isDraft (Boolean!)

    Identifies if the pull request is a draft.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isReadByViewer (Boolean)

    Is this pull request read by the viewer.

    \n\n\n\n\n\n\n\n\n\n\n\n

    labels (LabelConnection)

    A list of labels associated with the object.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (LabelOrder)

    \n

    Ordering options for labels returned from the connection.

    \n\n
    \n\n
    \n\n\n

    lastEditedAt (DateTime)

    The moment the editor made the last edit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    latestOpinionatedReviews (PullRequestReviewConnection)

    A list of latest reviews per user associated with the pull request.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    writersOnly (Boolean)

    \n

    Only return reviews from user who have write access to the repository.

    \n

    The default value is false.

    \n
    \n\n
    \n\n\n

    latestReviews (PullRequestReviewConnection)

    A list of latest reviews per user associated with the pull request that are not also pending review.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    locked (Boolean!)

    true if the pull request is locked.

    \n\n\n\n\n\n\n\n\n\n\n\n

    maintainerCanModify (Boolean!)

    Indicates whether maintainers can modify the pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    mergeCommit (Commit)

    The commit that was created when this pull request was merged.

    \n\n\n\n\n\n\n\n\n\n\n\n

    mergeStateStatus (MergeStateStatus!)

    Detailed information about the current pull request merge state status.

    \n\n\n\n\n
    \n

    Preview notice

    \n

    mergeStateStatus is available under the Merge info preview. During the preview period, the API may change without notice.

    \n
    \n\n\n\n\n\n\n\n\n

    mergeable (MergeableState!)

    Whether or not the pull request can be merged based on the existence of merge conflicts.

    \n\n\n\n\n\n\n\n\n\n\n\n

    merged (Boolean!)

    Whether or not the pull request was merged.

    \n\n\n\n\n\n\n\n\n\n\n\n

    mergedAt (DateTime)

    The date and time that the pull request was merged.

    \n\n\n\n\n\n\n\n\n\n\n\n

    mergedBy (Actor)

    The actor who merged the pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    milestone (Milestone)

    Identifies the milestone associated with the pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    number (Int!)

    Identifies the pull request number.

    \n\n\n\n\n\n\n\n\n\n\n\n

    participants (UserConnection!)

    A list of Users that are participating in the Pull Request conversation.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    permalink (URI!)

    The permalink to the pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    potentialMergeCommit (Commit)

    The commit that GitHub automatically generated to test if this pull request\ncould be merged. This field will not return a value if the pull request is\nmerged, or if the test merge commit is still being generated. See the\nmergeable field for more details on the mergeability of the pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    projectCards (ProjectCardConnection!)

    List of project cards associated with this pull request.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    archivedStates ([ProjectCardArchivedState])

    \n

    A list of archived states to filter the cards by.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    publishedAt (DateTime)

    Identifies when the comment was published at.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reactionGroups ([ReactionGroup!])

    A list of reactions grouped by content left on the subject.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reactions (ReactionConnection!)

    A list of Reactions left on the Issue.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    content (ReactionContent)

    \n

    Allows filtering Reactions by emoji.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (ReactionOrder)

    \n

    Allows specifying the order in which reactions are returned.

    \n\n
    \n\n
    \n\n\n

    repository (Repository!)

    The repository associated with this node.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    revertResourcePath (URI!)

    The HTTP path for reverting this pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    revertUrl (URI!)

    The HTTP URL for reverting this pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reviewDecision (PullRequestReviewDecision)

    The current status of this pull request with respect to code review.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reviewRequests (ReviewRequestConnection)

    A list of review requests associated with the pull request.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    reviewThreads (PullRequestReviewThreadConnection!)

    The list of all review threads for this pull request.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    reviews (PullRequestReviewConnection)

    A list of reviews associated with the pull request.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    author (String)

    \n

    Filter by author of the review.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    states ([PullRequestReviewState!])

    \n

    A list of states to filter the reviews.

    \n\n
    \n\n
    \n\n\n

    state (PullRequestState!)

    Identifies the state of the pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    suggestedReviewers ([SuggestedReviewer]!)

    A list of reviewer suggestions based on commit history and past review comments.

    \n\n\n\n\n\n\n\n\n\n\n\n

    timeline (PullRequestTimelineConnection!)

    A list of events, comments, commits, etc. associated with the pull request.

    \n\n\n\n\n\n\n
    \n

    Deprecation notice

    \n

    timeline is deprecated.

    timeline will be removed Use PullRequest.timelineItems instead. Removal on 2020-10-01 UTC.

    \n
    \n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    since (DateTime)

    \n

    Allows filtering timeline events by a since timestamp.

    \n\n
    \n\n
    \n\n\n

    timelineItems (PullRequestTimelineItemsConnection!)

    A list of events, comments, commits, etc. associated with the pull request.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    itemTypes ([PullRequestTimelineItemsItemType!])

    \n

    Filter timeline items by type.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    since (DateTime)

    \n

    Filter timeline items by a since timestamp.

    \n\n
    \n\n
    \n

    skip (Int)

    \n

    Skips the first n elements in the list.

    \n\n
    \n\n
    \n\n\n

    title (String!)

    Identifies the pull request title.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userContentEdits (UserContentEditConnection)

    A list of edits to this content.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    viewerCanApplySuggestion (Boolean!)

    Whether or not the viewer can apply suggestion.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanDeleteHeadRef (Boolean!)

    Check if the viewer can restore the deleted head ref.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanDisableAutoMerge (Boolean!)

    Whether or not the viewer can disable auto-merge.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanEnableAutoMerge (Boolean!)

    Whether or not the viewer can enable auto-merge.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanReact (Boolean!)

    Can user react to this subject.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanSubscribe (Boolean!)

    Check if the viewer is able to change their subscription status for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanUpdate (Boolean!)

    Check if the current viewer can update this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

    Reasons why the current viewer can not update this comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerDidAuthor (Boolean!)

    Did the viewer author this comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerMergeBodyText (String!)

    The merge body text for the viewer and method.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    mergeType (PullRequestMergeMethod)

    \n

    The merge method for the message.

    \n\n
    \n\n
    \n\n\n

    viewerMergeHeadlineText (String!)

    The merge headline text for the viewer and method.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    mergeType (PullRequestMergeMethod)

    \n

    The merge method for the message.

    \n\n
    \n\n
    \n\n\n

    viewerSubscription (SubscriptionState)

    Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestChangedFile\n

    \n

    A file changed in a pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    additions (Int!)

    The number of additions to the file.

    \n\n\n\n\n\n\n\n\n\n\n\n

    deletions (Int!)

    The number of deletions to the file.

    \n\n\n\n\n\n\n\n\n\n\n\n

    path (String!)

    The path of the file.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerViewedState (FileViewedState!)

    The state of the file for the viewer.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestChangedFileConnection\n

    \n

    The connection type for PullRequestChangedFile.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([PullRequestChangedFileEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([PullRequestChangedFile])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestChangedFileEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (PullRequestChangedFile)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestCommit\n

    \n

    Represents a Git commit part of a pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    commit (Commit!)

    The Git commit object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    The pull request this commit belongs to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this pull request commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this pull request commit.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestCommitCommentThread\n

    \n

    Represents a commit comment thread part of a pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    comments (CommitCommentConnection!)

    The comments that exist in this thread.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    commit (Commit!)

    The commit the comments were made on.

    \n\n\n\n\n\n\n\n\n\n\n\n

    path (String)

    The file the comments were made on.

    \n\n\n\n\n\n\n\n\n\n\n\n

    position (Int)

    The position in the diff for the commit that the comment was made on.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    The pull request this commit comment thread belongs to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository!)

    The repository associated with this node.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestCommitConnection\n

    \n

    The connection type for PullRequestCommit.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([PullRequestCommitEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([PullRequestCommit])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestCommitEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (PullRequestCommit)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestConnection\n

    \n

    The connection type for PullRequest.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([PullRequestEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([PullRequest])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestContributionsByRepository\n

    \n

    This aggregates pull requests opened by a user within one repository.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    contributions (CreatedPullRequestContributionConnection!)

    The pull request contributions.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (ContributionOrder)

    \n

    Ordering options for contributions returned from the connection.

    \n\n
    \n\n
    \n\n\n

    repository (Repository!)

    The repository in which the pull requests were opened.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (PullRequest)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestReview\n

    \n

    A review object for a given pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    author (Actor)

    The actor who authored the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    authorAssociation (CommentAuthorAssociation!)

    Author's association with the subject of the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    authorCanPushToRepository (Boolean!)

    Indicates whether the author of this review has push access to the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    body (String!)

    Identifies the pull request review body.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyHTML (HTML!)

    The body rendered to HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyText (String!)

    The body of this review rendered as plain text.

    \n\n\n\n\n\n\n\n\n\n\n\n

    comments (PullRequestReviewCommentConnection!)

    A list of review comments for the current pull request review.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    commit (Commit)

    Identifies the commit associated with this pull request review.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdViaEmail (Boolean!)

    Check if this comment was created via an email reply.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    editor (Actor)

    The actor who edited the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    includesCreatedEdit (Boolean!)

    Check if this comment was edited and includes an edit with the creation data.

    \n\n\n\n\n\n\n\n\n\n\n\n

    lastEditedAt (DateTime)

    The moment the editor made the last edit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    onBehalfOf (TeamConnection!)

    A list of teams that this review was made on behalf of.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    publishedAt (DateTime)

    Identifies when the comment was published at.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    Identifies the pull request associated with this pull request review.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reactionGroups ([ReactionGroup!])

    A list of reactions grouped by content left on the subject.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reactions (ReactionConnection!)

    A list of Reactions left on the Issue.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    content (ReactionContent)

    \n

    Allows filtering Reactions by emoji.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (ReactionOrder)

    \n

    Allows specifying the order in which reactions are returned.

    \n\n
    \n\n
    \n\n\n

    repository (Repository!)

    The repository associated with this node.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path permalink for this PullRequestReview.

    \n\n\n\n\n\n\n\n\n\n\n\n

    state (PullRequestReviewState!)

    Identifies the current state of the pull request review.

    \n\n\n\n\n\n\n\n\n\n\n\n

    submittedAt (DateTime)

    Identifies when the Pull Request Review was submitted.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL permalink for this PullRequestReview.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userContentEdits (UserContentEditConnection)

    A list of edits to this content.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    viewerCanDelete (Boolean!)

    Check if the current viewer can delete this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanReact (Boolean!)

    Can user react to this subject.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanUpdate (Boolean!)

    Check if the current viewer can update this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

    Reasons why the current viewer can not update this comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerDidAuthor (Boolean!)

    Did the viewer author this comment.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestReviewComment\n

    \n

    A review comment associated with a given repository pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    author (Actor)

    The actor who authored the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    authorAssociation (CommentAuthorAssociation!)

    Author's association with the subject of the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    body (String!)

    The comment body of this review comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyHTML (HTML!)

    The body rendered to HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyText (String!)

    The comment body of this review comment rendered as plain text.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commit (Commit)

    Identifies the commit associated with the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies when the comment was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdViaEmail (Boolean!)

    Check if this comment was created via an email reply.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    diffHunk (String!)

    The diff hunk to which the comment applies.

    \n\n\n\n\n\n\n\n\n\n\n\n

    draftedAt (DateTime!)

    Identifies when the comment was created in a draft state.

    \n\n\n\n\n\n\n\n\n\n\n\n

    editor (Actor)

    The actor who edited the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    includesCreatedEdit (Boolean!)

    Check if this comment was edited and includes an edit with the creation data.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isMinimized (Boolean!)

    Returns whether or not a comment has been minimized.

    \n\n\n\n\n\n\n\n\n\n\n\n

    lastEditedAt (DateTime)

    The moment the editor made the last edit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    minimizedReason (String)

    Returns why the comment was minimized.

    \n\n\n\n\n\n\n\n\n\n\n\n

    originalCommit (Commit)

    Identifies the original commit associated with the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    originalPosition (Int!)

    The original line index in the diff to which the comment applies.

    \n\n\n\n\n\n\n\n\n\n\n\n

    outdated (Boolean!)

    Identifies when the comment body is outdated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    path (String!)

    The path to which the comment applies.

    \n\n\n\n\n\n\n\n\n\n\n\n

    position (Int)

    The line index in the diff to which the comment applies.

    \n\n\n\n\n\n\n\n\n\n\n\n

    publishedAt (DateTime)

    Identifies when the comment was published at.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    The pull request associated with this review comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestReview (PullRequestReview)

    The pull request review associated with this review comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reactionGroups ([ReactionGroup!])

    A list of reactions grouped by content left on the subject.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reactions (ReactionConnection!)

    A list of Reactions left on the Issue.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    content (ReactionContent)

    \n

    Allows filtering Reactions by emoji.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (ReactionOrder)

    \n

    Allows specifying the order in which reactions are returned.

    \n\n
    \n\n
    \n\n\n

    replyTo (PullRequestReviewComment)

    The comment this is a reply to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository!)

    The repository associated with this node.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path permalink for this review comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    state (PullRequestReviewCommentState!)

    Identifies the state of the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies when the comment was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL permalink for this review comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userContentEdits (UserContentEditConnection)

    A list of edits to this content.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    viewerCanDelete (Boolean!)

    Check if the current viewer can delete this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanMinimize (Boolean!)

    Check if the current viewer can minimize this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanReact (Boolean!)

    Can user react to this subject.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanUpdate (Boolean!)

    Check if the current viewer can update this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

    Reasons why the current viewer can not update this comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerDidAuthor (Boolean!)

    Did the viewer author this comment.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestReviewCommentConnection\n

    \n

    The connection type for PullRequestReviewComment.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([PullRequestReviewCommentEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([PullRequestReviewComment])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestReviewCommentEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (PullRequestReviewComment)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestReviewConnection\n

    \n

    The connection type for PullRequestReview.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([PullRequestReviewEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([PullRequestReview])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestReviewContributionsByRepository\n

    \n

    This aggregates pull request reviews made by a user within one repository.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    contributions (CreatedPullRequestReviewContributionConnection!)

    The pull request review contributions.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (ContributionOrder)

    \n

    Ordering options for contributions returned from the connection.

    \n\n
    \n\n
    \n\n\n

    repository (Repository!)

    The repository in which the pull request reviews were made.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestReviewEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (PullRequestReview)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestReviewThread\n

    \n

    A threaded list of comments for a given pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    comments (PullRequestReviewCommentConnection!)

    A list of pull request comments associated with the thread.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    skip (Int)

    \n

    Skips the first n elements in the list.

    \n\n
    \n\n
    \n\n\n

    diffSide (DiffSide!)

    The side of the diff on which this thread was placed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isCollapsed (Boolean!)

    Whether or not the thread has been collapsed (outdated or resolved).

    \n\n\n\n\n\n\n\n\n\n\n\n

    isOutdated (Boolean!)

    Indicates whether this thread was outdated by newer changes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isResolved (Boolean!)

    Whether this thread has been resolved.

    \n\n\n\n\n\n\n\n\n\n\n\n

    line (Int)

    The line in the file to which this thread refers.

    \n\n\n\n\n\n\n\n\n\n\n\n

    originalLine (Int)

    The original line in the file to which this thread refers.

    \n\n\n\n\n\n\n\n\n\n\n\n

    originalStartLine (Int)

    The original start line in the file to which this thread refers (multi-line only).

    \n\n\n\n\n\n\n\n\n\n\n\n

    path (String!)

    Identifies the file path of this thread.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    Identifies the pull request associated with this thread.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository!)

    Identifies the repository associated with this thread.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resolvedBy (User)

    The user who resolved this thread.

    \n\n\n\n\n\n\n\n\n\n\n\n

    startDiffSide (DiffSide)

    The side of the diff that the first line of the thread starts on (multi-line only).

    \n\n\n\n\n\n\n\n\n\n\n\n

    startLine (Int)

    The start line in the file to which this thread refers (multi-line only).

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanReply (Boolean!)

    Indicates whether the current viewer can reply to this thread.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanResolve (Boolean!)

    Whether or not the viewer can resolve this thread.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanUnresolve (Boolean!)

    Whether or not the viewer can unresolve this thread.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestReviewThreadConnection\n

    \n

    Review comment threads for a pull request review.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([PullRequestReviewThreadEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([PullRequestReviewThread])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestReviewThreadEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (PullRequestReviewThread)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestRevisionMarker\n

    \n

    Represents the latest point in the pull request timeline for which the viewer has seen the pull request's commits.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    lastSeenCommit (Commit!)

    The last commit the viewer has seen.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    The pull request to which the marker belongs.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestTimelineConnection\n

    \n

    The connection type for PullRequestTimelineItem.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([PullRequestTimelineItemEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([PullRequestTimelineItem])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestTimelineItemEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (PullRequestTimelineItem)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestTimelineItemsConnection\n

    \n

    The connection type for PullRequestTimelineItems.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([PullRequestTimelineItemsEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    filteredCount (Int!)

    Identifies the count of items after applying before and after filters.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([PullRequestTimelineItems])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageCount (Int!)

    Identifies the count of items after applying before/after filters and first/last/skip slicing.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the timeline was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestTimelineItemsEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (PullRequestTimelineItems)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Push\n

    \n

    A Git push.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    nextSha (GitObjectID)

    The SHA after the push.

    \n\n\n\n\n\n\n\n\n\n\n\n

    permalink (URI!)

    The permalink for this push.

    \n\n\n\n\n\n\n\n\n\n\n\n

    previousSha (GitObjectID)

    The SHA before the push.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pusher (User!)

    The user who pushed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository!)

    The repository that was pushed to.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PushAllowance\n

    \n

    A team, user or app who has the ability to push to a protected branch.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (PushAllowanceActor)

    The actor that can push.

    \n\n\n\n\n\n\n\n\n\n\n\n

    branchProtectionRule (BranchProtectionRule)

    Identifies the branch protection rule associated with the allowed user or team.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PushAllowanceConnection\n

    \n

    The connection type for PushAllowance.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([PushAllowanceEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([PushAllowance])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PushAllowanceEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (PushAllowance)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RateLimit\n

    \n

    Represents the client's rate limit.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cost (Int!)

    The point cost for the current query counting against the rate limit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    limit (Int!)

    The maximum number of points the client is permitted to consume in a 60 minute window.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodeCount (Int!)

    The maximum number of nodes this query may return.

    \n\n\n\n\n\n\n\n\n\n\n\n

    remaining (Int!)

    The number of points remaining in the current rate limit window.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resetAt (DateTime!)

    The time at which the current rate limit window resets in UTC epoch seconds.

    \n\n\n\n\n\n\n\n\n\n\n\n

    used (Int!)

    The number of points used in the current rate limit window.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReactingUserConnection\n

    \n

    The connection type for User.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([ReactingUserEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([User])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReactingUserEdge\n

    \n

    Represents a user that's made a reaction.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reactedAt (DateTime!)

    The moment when the user made the reaction.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Reaction\n

    \n

    An emoji reaction to a particular piece of content.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    content (ReactionContent!)

    Identifies the emoji reaction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reactable (Reactable!)

    The reactable piece of content.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    Identifies the user who created this reaction.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReactionConnection\n

    \n

    A list of reactions that have been left on the subject.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([ReactionEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Reaction])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerHasReacted (Boolean!)

    Whether or not the authenticated user has left a reaction on the subject.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReactionEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (Reaction)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReactionGroup\n

    \n

    A group of emoji reactions to a particular piece of content.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    content (ReactionContent!)

    Identifies the emoji reaction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime)

    Identifies when the reaction was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    subject (Reactable!)

    The subject that was reacted to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    users (ReactingUserConnection!)

    Users who have reacted to the reaction subject with the emotion represented by this reaction group.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    viewerHasReacted (Boolean!)

    Whether or not the authenticated user has left a reaction on the subject.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReadyForReviewEvent\n

    \n

    Represents aready_for_reviewevent on a given pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    PullRequest referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this ready for review event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this ready for review event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Ref\n

    \n

    Represents a Git reference.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    associatedPullRequests (PullRequestConnection!)

    A list of pull requests with this ref as the head ref.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    baseRefName (String)

    \n

    The base ref name to filter the pull requests by.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    headRefName (String)

    \n

    The head ref name to filter the pull requests by.

    \n\n
    \n\n
    \n

    labels ([String!])

    \n

    A list of label names to filter the pull requests by.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (IssueOrder)

    \n

    Ordering options for pull requests returned from the connection.

    \n\n
    \n\n
    \n

    states ([PullRequestState!])

    \n

    A list of states to filter the pull requests by.

    \n\n
    \n\n
    \n\n\n

    branchProtectionRule (BranchProtectionRule)

    Branch protection rules for this ref.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The ref name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    prefix (String!)

    The ref's prefix, such as refs/heads/ or refs/tags/.

    \n\n\n\n\n\n\n\n\n\n\n\n

    refUpdateRule (RefUpdateRule)

    Branch protection rules that are viewable by non-admins.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository!)

    The repository the ref belongs to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    target (GitObject)

    The object the ref points to. Returns null when object does not exist.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RefConnection\n

    \n

    The connection type for Ref.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([RefEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Ref])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RefEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (Ref)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RefUpdateRule\n

    \n

    A ref update rules for a viewer.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    allowsDeletions (Boolean!)

    Can this branch be deleted.

    \n\n\n\n\n\n\n\n\n\n\n\n

    allowsForcePushes (Boolean!)

    Are force pushes allowed on this branch.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pattern (String!)

    Identifies the protection rule pattern.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiredApprovingReviewCount (Int)

    Number of approving reviews required to update matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiredStatusCheckContexts ([String])

    List of required status check contexts that must pass for commits to be accepted to matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiresLinearHistory (Boolean!)

    Are merge commits prohibited from being pushed to this branch.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiresSignatures (Boolean!)

    Are commits required to be signed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanPush (Boolean!)

    Can the viewer push to the branch.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReferencedEvent\n

    \n

    Represents areferencedevent on a given ReferencedSubject.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commit (Commit)

    Identifies the commit associated with thereferencedevent.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commitRepository (Repository!)

    Identifies the repository associated with thereferencedevent.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isCrossRepository (Boolean!)

    Reference originated in a different repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isDirectReference (Boolean!)

    Checks if the commit message itself references the subject. Can be false in the case of a commit comment reference.

    \n\n\n\n\n\n\n\n\n\n\n\n

    subject (ReferencedSubject!)

    Object referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Release\n

    \n

    A release contains the content for a release.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    author (User)

    The author of the release.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String)

    The description of the release.

    \n\n\n\n\n\n\n\n\n\n\n\n

    descriptionHTML (HTML)

    The description of this release rendered to HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isDraft (Boolean!)

    Whether or not the release is a draft.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isLatest (Boolean!)

    Whether or not the release is the latest releast.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isPrerelease (Boolean!)

    Whether or not the release is a prerelease.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String)

    The title of the release.

    \n\n\n\n\n\n\n\n\n\n\n\n

    publishedAt (DateTime)

    Identifies the date and time when the release was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    releaseAssets (ReleaseAssetConnection!)

    List of releases assets which are dependent on this release.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    name (String)

    \n

    A list of names to filter the assets by.

    \n\n
    \n\n
    \n\n\n

    repository (Repository!)

    The repository that the release belongs to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this issue.

    \n\n\n\n\n\n\n\n\n\n\n\n

    shortDescriptionHTML (HTML)

    A description of the release, rendered to HTML without any links in it.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    limit (Int)

    \n

    How many characters to return.

    \n

    The default value is 200.

    \n
    \n\n
    \n\n\n

    tag (Ref)

    The Git tag the release points to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    tagName (String!)

    The name of the release's Git tag.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this issue.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReleaseAsset\n

    \n

    A release asset contains the content for a release asset.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    contentType (String!)

    The asset's content-type.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    downloadCount (Int!)

    The number of times this asset was downloaded.

    \n\n\n\n\n\n\n\n\n\n\n\n

    downloadUrl (URI!)

    Identifies the URL where you can download the release asset via the browser.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    Identifies the title of the release asset.

    \n\n\n\n\n\n\n\n\n\n\n\n

    release (Release)

    Release that the asset is associated with.

    \n\n\n\n\n\n\n\n\n\n\n\n

    size (Int!)

    The size (in bytes) of the asset.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    uploadedBy (User!)

    The user that performed the upload.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    Identifies the URL of the release asset.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReleaseAssetConnection\n

    \n

    The connection type for ReleaseAsset.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([ReleaseAssetEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([ReleaseAsset])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReleaseAssetEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (ReleaseAsset)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReleaseConnection\n

    \n

    The connection type for Release.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([ReleaseEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Release])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReleaseEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (Release)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RemovedFromProjectEvent\n

    \n

    Represents aremoved_from_projectevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    project (Project)

    Project referenced by event.

    \n\n\n\n\n
    \n

    Preview notice

    \n

    project is available under the Project event details preview. During the preview period, the API may change without notice.

    \n
    \n\n\n\n\n\n\n\n\n

    projectColumnName (String!)

    Column name referenced by this project event.

    \n\n\n\n\n
    \n

    Preview notice

    \n

    projectColumnName is available under the Project event details preview. During the preview period, the API may change without notice.

    \n
    \n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RenamedTitleEvent\n

    \n

    Represents arenamedevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    currentTitle (String!)

    Identifies the current title of the issue or pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    previousTitle (String!)

    Identifies the previous title of the issue or pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    subject (RenamedTitleSubject!)

    Subject that was renamed.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReopenedEvent\n

    \n

    Represents areopenedevent on any Closable.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    closable (Closable!)

    Object that was reopened.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepoAccessAuditEntry\n

    \n

    Audit log entry for a repo.access event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    visibility (RepoAccessAuditEntryVisibility)

    The visibility of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepoAddMemberAuditEntry\n

    \n

    Audit log entry for a repo.add_member event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    visibility (RepoAddMemberAuditEntryVisibility)

    The visibility of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepoAddTopicAuditEntry\n

    \n

    Audit log entry for a repo.add_topic event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    topic (Topic)

    The name of the topic added to the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    topicName (String)

    The name of the topic added to the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepoArchivedAuditEntry\n

    \n

    Audit log entry for a repo.archived event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    visibility (RepoArchivedAuditEntryVisibility)

    The visibility of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepoChangeMergeSettingAuditEntry\n

    \n

    Audit log entry for a repo.change_merge_setting event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isEnabled (Boolean)

    Whether the change was to enable (true) or disable (false) the merge type.

    \n\n\n\n\n\n\n\n\n\n\n\n

    mergeType (RepoChangeMergeSettingAuditEntryMergeType)

    The merge method affected by the change.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepoConfigDisableAnonymousGitAccessAuditEntry\n

    \n

    Audit log entry for a repo.config.disable_anonymous_git_access event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepoConfigDisableCollaboratorsOnlyAuditEntry\n

    \n

    Audit log entry for a repo.config.disable_collaborators_only event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepoConfigDisableContributorsOnlyAuditEntry\n

    \n

    Audit log entry for a repo.config.disable_contributors_only event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepoConfigDisableSockpuppetDisallowedAuditEntry\n

    \n

    Audit log entry for a repo.config.disable_sockpuppet_disallowed event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepoConfigEnableAnonymousGitAccessAuditEntry\n

    \n

    Audit log entry for a repo.config.enable_anonymous_git_access event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepoConfigEnableCollaboratorsOnlyAuditEntry\n

    \n

    Audit log entry for a repo.config.enable_collaborators_only event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepoConfigEnableContributorsOnlyAuditEntry\n

    \n

    Audit log entry for a repo.config.enable_contributors_only event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepoConfigEnableSockpuppetDisallowedAuditEntry\n

    \n

    Audit log entry for a repo.config.enable_sockpuppet_disallowed event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepoConfigLockAnonymousGitAccessAuditEntry\n

    \n

    Audit log entry for a repo.config.lock_anonymous_git_access event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepoConfigUnlockAnonymousGitAccessAuditEntry\n

    \n

    Audit log entry for a repo.config.unlock_anonymous_git_access event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepoCreateAuditEntry\n

    \n

    Audit log entry for a repo.create event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    forkParentName (String)

    The name of the parent repository for this forked repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    forkSourceName (String)

    The name of the root repository for this network.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    visibility (RepoCreateAuditEntryVisibility)

    The visibility of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepoDestroyAuditEntry\n

    \n

    Audit log entry for a repo.destroy event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    visibility (RepoDestroyAuditEntryVisibility)

    The visibility of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepoRemoveMemberAuditEntry\n

    \n

    Audit log entry for a repo.remove_member event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    visibility (RepoRemoveMemberAuditEntryVisibility)

    The visibility of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepoRemoveTopicAuditEntry\n

    \n

    Audit log entry for a repo.remove_topic event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    topic (Topic)

    The name of the topic added to the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    topicName (String)

    The name of the topic added to the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Repository\n

    \n

    A repository contains the content for a project.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    assignableUsers (UserConnection!)

    A list of users that can be assigned to issues in this repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    query (String)

    \n

    Filters users with query on user name and login.

    \n\n
    \n\n
    \n\n\n

    branchProtectionRules (BranchProtectionRuleConnection!)

    A list of branch protection rules for this repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    codeOfConduct (CodeOfConduct)

    Returns the code of conduct for this repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    collaborators (RepositoryCollaboratorConnection)

    A list of collaborators associated with the repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    affiliation (CollaboratorAffiliation)

    \n

    Collaborators affiliation level with a repository.

    \n\n
    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    query (String)

    \n

    Filters users with query on user name and login.

    \n\n
    \n\n
    \n\n\n

    commitComments (CommitCommentConnection!)

    A list of commit comments associated with the repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    contactLinks ([RepositoryContactLink!])

    Returns a list of contact links associated to the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    defaultBranchRef (Ref)

    The Ref associated with the repository's default branch.

    \n\n\n\n\n\n\n\n\n\n\n\n

    deleteBranchOnMerge (Boolean!)

    Whether or not branches are automatically deleted when merged in this repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    dependencyGraphManifests (DependencyGraphManifestConnection)

    A list of dependency manifests contained in the repository.

    \n\n\n\n\n
    \n

    Preview notice

    \n

    dependencyGraphManifests is available under the Access to a repositories dependency graph preview. During the preview period, the API may change without notice.

    \n
    \n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    dependenciesAfter (String)

    \n

    Cursor to paginate dependencies.

    \n\n
    \n\n
    \n

    dependenciesFirst (Int)

    \n

    Number of dependencies to fetch.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    withDependencies (Boolean)

    \n

    Flag to scope to only manifests with dependencies.

    \n\n
    \n\n
    \n\n\n

    deployKeys (DeployKeyConnection!)

    A list of deploy keys that are on this repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    deployments (DeploymentConnection!)

    Deployments associated with the repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    environments ([String!])

    \n

    Environments to list deployments for.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (DeploymentOrder)

    \n

    Ordering options for deployments returned from the connection.

    \n\n
    \n\n
    \n\n\n

    description (String)

    The description of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    descriptionHTML (HTML!)

    The description of the repository rendered to HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    diskUsage (Int)

    The number of kilobytes this repository occupies on disk.

    \n\n\n\n\n\n\n\n\n\n\n\n

    forkCount (Int!)

    Returns how many forks there are of this repository in the whole network.

    \n\n\n\n\n\n\n\n\n\n\n\n

    forks (RepositoryConnection!)

    A list of direct forked repositories.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    affiliations ([RepositoryAffiliation])

    \n

    Array of viewer's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\ncurrent viewer owns.

    \n\n
    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    isLocked (Boolean)

    \n

    If non-null, filters repositories according to whether they have been locked.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (RepositoryOrder)

    \n

    Ordering options for repositories returned from the connection.

    \n\n
    \n\n
    \n

    ownerAffiliations ([RepositoryAffiliation])

    \n

    Array of owner's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\norganization or user being viewed owns.

    \n\n
    \n\n
    \n

    privacy (RepositoryPrivacy)

    \n

    If non-null, filters repositories according to privacy.

    \n\n
    \n\n
    \n\n\n

    fundingLinks ([FundingLink!]!)

    The funding links for this repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hasIssuesEnabled (Boolean!)

    Indicates if the repository has issues feature enabled.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hasProjectsEnabled (Boolean!)

    Indicates if the repository has the Projects feature enabled.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hasWikiEnabled (Boolean!)

    Indicates if the repository has wiki feature enabled.

    \n\n\n\n\n\n\n\n\n\n\n\n

    homepageUrl (URI)

    The repository's URL.

    \n\n\n\n\n\n\n\n\n\n\n\n

    interactionAbility (RepositoryInteractionAbility)

    The interaction ability settings for this repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isArchived (Boolean!)

    Indicates if the repository is unmaintained.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isBlankIssuesEnabled (Boolean!)

    Returns true if blank issue creation is allowed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isDisabled (Boolean!)

    Returns whether or not this repository disabled.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isEmpty (Boolean!)

    Returns whether or not this repository is empty.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isFork (Boolean!)

    Identifies if the repository is a fork.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isInOrganization (Boolean!)

    Indicates if a repository is either owned by an organization, or is a private fork of an organization repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isLocked (Boolean!)

    Indicates if the repository has been locked or not.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isMirror (Boolean!)

    Identifies if the repository is a mirror.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isPrivate (Boolean!)

    Identifies if the repository is private.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isSecurityPolicyEnabled (Boolean)

    Returns true if this repository has a security policy.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isTemplate (Boolean!)

    Identifies if the repository is a template that can be used to generate new repositories.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isUserConfigurationRepository (Boolean!)

    Is this repository a user configuration repository?.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issue (Issue)

    Returns a single issue from the current repository by number.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    number (Int!)

    \n

    The number for the issue to be returned.

    \n\n
    \n\n
    \n\n\n

    issueOrPullRequest (IssueOrPullRequest)

    Returns a single issue-like object from the current repository by number.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    number (Int!)

    \n

    The number for the issue to be returned.

    \n\n
    \n\n
    \n\n\n

    issueTemplates ([IssueTemplate!])

    Returns a list of issue templates associated to the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issues (IssueConnection!)

    A list of issues that have been opened in the repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    filterBy (IssueFilters)

    \n

    Filtering options for issues returned from the connection.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    labels ([String!])

    \n

    A list of label names to filter the pull requests by.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (IssueOrder)

    \n

    Ordering options for issues returned from the connection.

    \n\n
    \n\n
    \n

    states ([IssueState!])

    \n

    A list of states to filter the issues by.

    \n\n
    \n\n
    \n\n\n

    label (Label)

    Returns a single label by name.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    name (String!)

    \n

    Label name.

    \n\n
    \n\n
    \n\n\n

    labels (LabelConnection)

    A list of labels associated with the repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (LabelOrder)

    \n

    Ordering options for labels returned from the connection.

    \n\n
    \n\n
    \n

    query (String)

    \n

    If provided, searches labels by name and description.

    \n\n
    \n\n
    \n\n\n

    languages (LanguageConnection)

    A list containing a breakdown of the language composition of the repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (LanguageOrder)

    \n

    Order for connection.

    \n\n
    \n\n
    \n\n\n

    latestRelease (Release)

    Get the latest release for the repository if one exists.

    \n\n\n\n\n\n\n\n\n\n\n\n

    licenseInfo (License)

    The license associated with the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    lockReason (RepositoryLockReason)

    The reason the repository has been locked.

    \n\n\n\n\n\n\n\n\n\n\n\n

    mentionableUsers (UserConnection!)

    A list of Users that can be mentioned in the context of the repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    query (String)

    \n

    Filters users with query on user name and login.

    \n\n
    \n\n
    \n\n\n

    mergeCommitAllowed (Boolean!)

    Whether or not PRs are merged with a merge commit on this repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    milestone (Milestone)

    Returns a single milestone from the current repository by number.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    number (Int!)

    \n

    The number for the milestone to be returned.

    \n\n
    \n\n
    \n\n\n

    milestones (MilestoneConnection)

    A list of milestones associated with the repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (MilestoneOrder)

    \n

    Ordering options for milestones.

    \n\n
    \n\n
    \n

    query (String)

    \n

    Filters milestones with a query on the title.

    \n\n
    \n\n
    \n

    states ([MilestoneState!])

    \n

    Filter by the state of the milestones.

    \n\n
    \n\n
    \n\n\n

    mirrorUrl (URI)

    The repository's original mirror URL.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nameWithOwner (String!)

    The repository's name with owner.

    \n\n\n\n\n\n\n\n\n\n\n\n

    object (GitObject)

    A Git object in the repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    expression (String)

    \n

    A Git revision expression suitable for rev-parse.

    \n\n
    \n\n
    \n

    oid (GitObjectID)

    \n

    The Git object ID.

    \n\n
    \n\n
    \n\n\n

    openGraphImageUrl (URI!)

    The image used to represent this repository in Open Graph data.

    \n\n\n\n\n\n\n\n\n\n\n\n

    owner (RepositoryOwner!)

    The User owner of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    packages (PackageConnection!)

    A list of packages under the owner.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    names ([String])

    \n

    Find packages by their names.

    \n\n
    \n\n
    \n

    orderBy (PackageOrder)

    \n

    Ordering of the returned packages.

    \n\n
    \n\n
    \n

    packageType (PackageType)

    \n

    Filter registry package by type.

    \n\n
    \n\n
    \n

    repositoryId (ID)

    \n

    Find packages in a repository by ID.

    \n\n
    \n\n
    \n\n\n

    parent (Repository)

    The repository parent, if this is a fork.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pinnedIssues (PinnedIssueConnection)

    A list of pinned issues for this repository.

    \n\n\n\n\n
    \n

    Preview notice

    \n

    pinnedIssues is available under the Pinned issues preview. During the preview period, the API may change without notice.

    \n
    \n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    primaryLanguage (Language)

    The primary language of the repository's code.

    \n\n\n\n\n\n\n\n\n\n\n\n

    project (Project)

    Find project by number.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    number (Int!)

    \n

    The project number to find.

    \n\n
    \n\n
    \n\n\n

    projects (ProjectConnection!)

    A list of projects under the owner.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (ProjectOrder)

    \n

    Ordering options for projects returned from the connection.

    \n\n
    \n\n
    \n

    search (String)

    \n

    Query to search projects by, currently only searching by name.

    \n\n
    \n\n
    \n

    states ([ProjectState!])

    \n

    A list of states to filter the projects by.

    \n\n
    \n\n
    \n\n\n

    projectsResourcePath (URI!)

    The HTTP path listing the repository's projects.

    \n\n\n\n\n\n\n\n\n\n\n\n

    projectsUrl (URI!)

    The HTTP URL listing the repository's projects.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest)

    Returns a single pull request from the current repository by number.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    number (Int!)

    \n

    The number for the pull request to be returned.

    \n\n
    \n\n
    \n\n\n

    pullRequests (PullRequestConnection!)

    A list of pull requests that have been opened in the repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    baseRefName (String)

    \n

    The base ref name to filter the pull requests by.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    headRefName (String)

    \n

    The head ref name to filter the pull requests by.

    \n\n
    \n\n
    \n

    labels ([String!])

    \n

    A list of label names to filter the pull requests by.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (IssueOrder)

    \n

    Ordering options for pull requests returned from the connection.

    \n\n
    \n\n
    \n

    states ([PullRequestState!])

    \n

    A list of states to filter the pull requests by.

    \n\n
    \n\n
    \n\n\n

    pushedAt (DateTime)

    Identifies when the repository was last pushed to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    rebaseMergeAllowed (Boolean!)

    Whether or not rebase-merging is enabled on this repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ref (Ref)

    Fetch a given ref from the repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    qualifiedName (String!)

    \n

    The ref to retrieve. Fully qualified matches are checked in order\n(refs/heads/master) before falling back onto checks for short name matches (master).

    \n\n
    \n\n
    \n\n\n

    refs (RefConnection)

    Fetch a list of refs from the repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    direction (OrderDirection)

    \n

    DEPRECATED: use orderBy. The ordering direction.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (RefOrder)

    \n

    Ordering options for refs returned from the connection.

    \n\n
    \n\n
    \n

    query (String)

    \n

    Filters refs with query on name.

    \n\n
    \n\n
    \n

    refPrefix (String!)

    \n

    A ref name prefix like refs/heads/, refs/tags/, etc.

    \n\n
    \n\n
    \n\n\n

    release (Release)

    Lookup a single release given various criteria.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    tagName (String!)

    \n

    The name of the Tag the Release was created from.

    \n\n
    \n\n
    \n\n\n

    releases (ReleaseConnection!)

    List of releases which are dependent on this repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (ReleaseOrder)

    \n

    Order for connection.

    \n\n
    \n\n
    \n\n\n

    repositoryTopics (RepositoryTopicConnection!)

    A list of applied repository-topic associations for this repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    resourcePath (URI!)

    The HTTP path for this repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    securityPolicyUrl (URI)

    The security policy URL.

    \n\n\n\n\n\n\n\n\n\n\n\n

    shortDescriptionHTML (HTML!)

    A description of the repository, rendered to HTML without any links in it.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    limit (Int)

    \n

    How many characters to return.

    \n

    The default value is 200.

    \n
    \n\n
    \n\n\n

    squashMergeAllowed (Boolean!)

    Whether or not squash-merging is enabled on this repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    sshUrl (GitSSHRemote!)

    The SSH URL to clone this repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    stargazerCount (Int!)

    Returns a count of how many stargazers there are on this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    stargazers (StargazerConnection!)

    A list of users who have starred this starrable.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (StarOrder)

    \n

    Order for connection.

    \n\n
    \n\n
    \n\n\n

    submodules (SubmoduleConnection!)

    Returns a list of all submodules in this repository parsed from the\n.gitmodules file as of the default branch's HEAD commit.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    tempCloneToken (String)

    Temporary authentication token for cloning this repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    templateRepository (Repository)

    The repository from which this repository was generated, if any.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    usesCustomOpenGraphImage (Boolean!)

    Whether this repository has a custom image to use with Open Graph as opposed to being represented by the owner's avatar.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanAdminister (Boolean!)

    Indicates whether the viewer has admin permissions on this repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanCreateProjects (Boolean!)

    Can the current viewer create new projects on this owner.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanSubscribe (Boolean!)

    Check if the viewer is able to change their subscription status for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanUpdateTopics (Boolean!)

    Indicates whether the viewer can update the topics of this repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerDefaultCommitEmail (String)

    The last commit email for the viewer.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerDefaultMergeMethod (PullRequestMergeMethod!)

    The last used merge method by the viewer or the default for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerHasStarred (Boolean!)

    Returns a boolean indicating whether the viewing user has starred this starrable.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerPermission (RepositoryPermission)

    The users permission level on the repository. Will return null if authenticated as an GitHub App.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerPossibleCommitEmails ([String!])

    A list of emails this viewer can commit with.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerSubscription (SubscriptionState)

    Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

    \n\n\n\n\n\n\n\n\n\n\n\n

    vulnerabilityAlerts (RepositoryVulnerabilityAlertConnection)

    A list of vulnerability alerts that are on this repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    watchers (UserConnection!)

    A list of users watching the repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepositoryCollaboratorConnection\n

    \n

    The connection type for User.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([RepositoryCollaboratorEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([User])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepositoryCollaboratorEdge\n

    \n

    Represents a user who is a collaborator of a repository.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    permission (RepositoryPermission!)

    The permission the user has on the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    permissionSources ([PermissionSource!])

    A list of sources for the user's access to the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepositoryConnection\n

    \n

    A list of repositories owned by the subject.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([RepositoryEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Repository])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalDiskUsage (Int!)

    The total size in kilobytes of all repositories in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepositoryContactLink\n

    \n

    A repository contact link.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    about (String!)

    The contact link purpose.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The contact link name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The contact link URL.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepositoryEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (Repository)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepositoryInteractionAbility\n

    \n

    Repository interaction limit that applies to this object.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    expiresAt (DateTime)

    The time the currently active limit expires.

    \n\n\n\n\n\n\n\n\n\n\n\n

    limit (RepositoryInteractionLimit!)

    The current limit that is enabled on this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    origin (RepositoryInteractionLimitOrigin!)

    The origin of the currently active interaction limit.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepositoryInvitation\n

    \n

    An invitation for a user to be added to a repository.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    email (String)

    The email address that received the invitation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    invitee (User)

    The user who received the invitation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    inviter (User!)

    The user who created the invitation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    permalink (URI!)

    The permalink for this repository invitation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    permission (RepositoryPermission!)

    The permission granted on this repository by this invitation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (RepositoryInfo)

    The Repository the user is invited to.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepositoryInvitationConnection\n

    \n

    The connection type for RepositoryInvitation.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([RepositoryInvitationEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([RepositoryInvitation])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepositoryInvitationEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (RepositoryInvitation)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepositoryTopic\n

    \n

    A repository-topic connects a repository to a topic.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    resourcePath (URI!)

    The HTTP path for this repository-topic.

    \n\n\n\n\n\n\n\n\n\n\n\n

    topic (Topic!)

    The topic.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this repository-topic.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepositoryTopicConnection\n

    \n

    The connection type for RepositoryTopic.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([RepositoryTopicEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([RepositoryTopic])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepositoryTopicEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (RepositoryTopic)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepositoryVisibilityChangeDisableAuditEntry\n

    \n

    Audit log entry for a repository_visibility_change.disable event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseResourcePath (URI)

    The HTTP path for this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseSlug (String)

    The slug of the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseUrl (URI)

    The HTTP URL for this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepositoryVisibilityChangeEnableAuditEntry\n

    \n

    Audit log entry for a repository_visibility_change.enable event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseResourcePath (URI)

    The HTTP path for this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseSlug (String)

    The slug of the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseUrl (URI)

    The HTTP URL for this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepositoryVulnerabilityAlert\n

    \n

    A alert for a repository with an affected vulnerability.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    createdAt (DateTime!)

    When was the alert created?.

    \n\n\n\n\n\n\n\n\n\n\n\n

    dismissReason (String)

    The reason the alert was dismissed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    dismissedAt (DateTime)

    When was the alert dismissed?.

    \n\n\n\n\n\n\n\n\n\n\n\n

    dismisser (User)

    The user who dismissed the alert.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository!)

    The associated repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    securityAdvisory (SecurityAdvisory)

    The associated security advisory.

    \n\n\n\n\n\n\n\n\n\n\n\n

    securityVulnerability (SecurityVulnerability)

    The associated security vulnerability.

    \n\n\n\n\n\n\n\n\n\n\n\n

    vulnerableManifestFilename (String!)

    The vulnerable manifest filename.

    \n\n\n\n\n\n\n\n\n\n\n\n

    vulnerableManifestPath (String!)

    The vulnerable manifest path.

    \n\n\n\n\n\n\n\n\n\n\n\n

    vulnerableRequirements (String)

    The vulnerable requirements.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepositoryVulnerabilityAlertConnection\n

    \n

    The connection type for RepositoryVulnerabilityAlert.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([RepositoryVulnerabilityAlertEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([RepositoryVulnerabilityAlert])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepositoryVulnerabilityAlertEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (RepositoryVulnerabilityAlert)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RestrictedContribution\n

    \n

    Represents a private contribution a user made on GitHub.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    isRestricted (Boolean!)

    Whether this contribution is associated with a record you do not have access to. For\nexample, your own 'first issue' contribution may have been made on a repository you can no\nlonger access.

    \n\n\n\n\n\n\n\n\n\n\n\n

    occurredAt (DateTime!)

    When this contribution was made.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User!)

    The user who made this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReviewDismissalAllowance\n

    \n

    A team or user who has the ability to dismiss a review on a protected branch.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (ReviewDismissalAllowanceActor)

    The actor that can dismiss.

    \n\n\n\n\n\n\n\n\n\n\n\n

    branchProtectionRule (BranchProtectionRule)

    Identifies the branch protection rule associated with the allowed user or team.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReviewDismissalAllowanceConnection\n

    \n

    The connection type for ReviewDismissalAllowance.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([ReviewDismissalAllowanceEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([ReviewDismissalAllowance])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReviewDismissalAllowanceEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (ReviewDismissalAllowance)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReviewDismissedEvent\n

    \n

    Represents areview_dismissedevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    dismissalMessage (String)

    Identifies the optional message associated with thereview_dismissedevent.

    \n\n\n\n\n\n\n\n\n\n\n\n

    dismissalMessageHTML (String)

    Identifies the optional message associated with the event, rendered to HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    previousReviewState (PullRequestReviewState!)

    Identifies the previous state of the review with thereview_dismissedevent.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    PullRequest referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestCommit (PullRequestCommit)

    Identifies the commit which caused the review to become stale.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this review dismissed event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    review (PullRequestReview)

    Identifies the review associated with thereview_dismissedevent.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this review dismissed event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReviewRequest\n

    \n

    A request for a user to review a pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    asCodeOwner (Boolean!)

    Whether this request was created for a code owner.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    Identifies the pull request associated with this review request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requestedReviewer (RequestedReviewer)

    The reviewer that is requested.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReviewRequestConnection\n

    \n

    The connection type for ReviewRequest.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([ReviewRequestEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([ReviewRequest])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReviewRequestEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (ReviewRequest)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReviewRequestRemovedEvent\n

    \n

    Represents anreview_request_removedevent on a given pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    PullRequest referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requestedReviewer (RequestedReviewer)

    Identifies the reviewer whose review request was removed.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReviewRequestedEvent\n

    \n

    Represents anreview_requestedevent on a given pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    PullRequest referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requestedReviewer (RequestedReviewer)

    Identifies the reviewer whose review was requested.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReviewStatusHovercardContext\n

    \n

    A hovercard context with a message describing the current code review state of the pull\nrequest.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    message (String!)

    A string describing this context.

    \n\n\n\n\n\n\n\n\n\n\n\n

    octicon (String!)

    An octicon to accompany this context.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reviewDecision (PullRequestReviewDecision)

    The current status of the pull request with respect to code review.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SavedReply\n

    \n

    A Saved Reply is text a user can use to reply quickly.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String!)

    The body of the saved reply.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyHTML (HTML!)

    The saved reply body rendered to HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    title (String!)

    The title of the saved reply.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (Actor)

    The user that saved this reply.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SavedReplyConnection\n

    \n

    The connection type for SavedReply.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([SavedReplyEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([SavedReply])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SavedReplyEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (SavedReply)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SearchResultItemConnection\n

    \n

    A list of results that matched against a search query.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    codeCount (Int!)

    The number of pieces of code that matched the search query.

    \n\n\n\n\n\n\n\n\n\n\n\n

    edges ([SearchResultItemEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issueCount (Int!)

    The number of issues that matched the search query.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([SearchResultItem])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryCount (Int!)

    The number of repositories that matched the search query.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userCount (Int!)

    The number of users that matched the search query.

    \n\n\n\n\n\n\n\n\n\n\n\n

    wikiCount (Int!)

    The number of wiki pages that matched the search query.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SearchResultItemEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (SearchResultItem)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n

    textMatches ([TextMatch])

    Text matches on the result found.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SecurityAdvisory\n

    \n

    A GitHub Security Advisory.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cvss (CVSS!)

    The CVSS associated with this advisory.

    \n\n\n\n\n\n\n\n\n\n\n\n

    cwes (CWEConnection!)

    CWEs associated with this Advisory.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String!)

    This is a long plaintext description of the advisory.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ghsaId (String!)

    The GitHub Security Advisory ID.

    \n\n\n\n\n\n\n\n\n\n\n\n

    identifiers ([SecurityAdvisoryIdentifier!]!)

    A list of identifiers for this advisory.

    \n\n\n\n\n\n\n\n\n\n\n\n

    notificationsPermalink (URI)

    The permalink for the advisory's dependabot alerts page.

    \n\n\n\n\n\n\n\n\n\n\n\n

    origin (String!)

    The organization that originated the advisory.

    \n\n\n\n\n\n\n\n\n\n\n\n

    permalink (URI)

    The permalink for the advisory.

    \n\n\n\n\n\n\n\n\n\n\n\n

    publishedAt (DateTime!)

    When the advisory was published.

    \n\n\n\n\n\n\n\n\n\n\n\n

    references ([SecurityAdvisoryReference!]!)

    A list of references for this advisory.

    \n\n\n\n\n\n\n\n\n\n\n\n

    severity (SecurityAdvisorySeverity!)

    The severity of the advisory.

    \n\n\n\n\n\n\n\n\n\n\n\n

    summary (String!)

    A short plaintext summary of the advisory.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    When the advisory was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    vulnerabilities (SecurityVulnerabilityConnection!)

    Vulnerabilities associated with this Advisory.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    ecosystem (SecurityAdvisoryEcosystem)

    \n

    An ecosystem to filter vulnerabilities by.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (SecurityVulnerabilityOrder)

    \n

    Ordering options for the returned topics.

    \n\n
    \n\n
    \n

    package (String)

    \n

    A package name to filter vulnerabilities by.

    \n\n
    \n\n
    \n

    severities ([SecurityAdvisorySeverity!])

    \n

    A list of severities to filter vulnerabilities by.

    \n\n
    \n\n
    \n\n\n

    withdrawnAt (DateTime)

    When the advisory was withdrawn, if it has been withdrawn.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SecurityAdvisoryConnection\n

    \n

    The connection type for SecurityAdvisory.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([SecurityAdvisoryEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([SecurityAdvisory])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SecurityAdvisoryEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (SecurityAdvisory)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SecurityAdvisoryIdentifier\n

    \n

    A GitHub Security Advisory Identifier.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    type (String!)

    The identifier type, e.g. GHSA, CVE.

    \n\n\n\n\n\n\n\n\n\n\n\n

    value (String!)

    The identifier.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SecurityAdvisoryPackage\n

    \n

    An individual package.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    ecosystem (SecurityAdvisoryEcosystem!)

    The ecosystem the package belongs to, e.g. RUBYGEMS, NPM.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The package name.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SecurityAdvisoryPackageVersion\n

    \n

    An individual package version.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    identifier (String!)

    The package name or version.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SecurityAdvisoryReference\n

    \n

    A GitHub Security Advisory Reference.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    url (URI!)

    A publicly accessible reference.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SecurityVulnerability\n

    \n

    An individual vulnerability within an Advisory.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    advisory (SecurityAdvisory!)

    The Advisory associated with this Vulnerability.

    \n\n\n\n\n\n\n\n\n\n\n\n

    firstPatchedVersion (SecurityAdvisoryPackageVersion)

    The first version containing a fix for the vulnerability.

    \n\n\n\n\n\n\n\n\n\n\n\n

    package (SecurityAdvisoryPackage!)

    A description of the vulnerable package.

    \n\n\n\n\n\n\n\n\n\n\n\n

    severity (SecurityAdvisorySeverity!)

    The severity of the vulnerability within this package.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    When the vulnerability was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    vulnerableVersionRange (String!)

    A string that describes the vulnerable package versions.\nThis string follows a basic syntax with a few forms.

    \n
      \n
    • = 0.2.0 denotes a single vulnerable version.
    • \n
    • <= 1.0.8 denotes a version range up to and including the specified version
    • \n
    • < 0.1.11 denotes a version range up to, but excluding, the specified version
    • \n
    • >= 4.3.0, < 4.3.5 denotes a version range with a known minimum and maximum version.
    • \n
    • >= 0.0.1 denotes a version range with a known minimum, but no known maximum.
    • \n

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SecurityVulnerabilityConnection\n

    \n

    The connection type for SecurityVulnerability.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([SecurityVulnerabilityEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([SecurityVulnerability])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SecurityVulnerabilityEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (SecurityVulnerability)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SmimeSignature\n

    \n

    Represents an S/MIME signature on a Commit or Tag.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    email (String!)

    Email used to sign this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isValid (Boolean!)

    True if the signature is valid and verified by GitHub.

    \n\n\n\n\n\n\n\n\n\n\n\n

    payload (String!)

    Payload for GPG signing object. Raw ODB object without the signature header.

    \n\n\n\n\n\n\n\n\n\n\n\n

    signature (String!)

    ASCII-armored signature header from object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    signer (User)

    GitHub user corresponding to the email signing this commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    state (GitSignatureState!)

    The state of this signature. VALID if signature is valid and verified by\nGitHub, otherwise represents reason why signature is considered invalid.

    \n\n\n\n\n\n\n\n\n\n\n\n

    wasSignedByGitHub (Boolean!)

    True if the signature was made with GitHub's signing key.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SponsorableItemConnection\n

    \n

    The connection type for SponsorableItem.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([SponsorableItemEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([SponsorableItem])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SponsorableItemEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (SponsorableItem)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SponsorsGoal\n

    \n

    A goal associated with a GitHub Sponsors listing, representing a target the sponsored maintainer would like to attain.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    description (String)

    A description of the goal from the maintainer.

    \n\n\n\n\n\n\n\n\n\n\n\n

    kind (SponsorsGoalKind!)

    What the objective of this goal is.

    \n\n\n\n\n\n\n\n\n\n\n\n

    percentComplete (Int!)

    The percentage representing how complete this goal is, between 0-100.

    \n\n\n\n\n\n\n\n\n\n\n\n

    targetValue (Int!)

    What the goal amount is. Represents a dollar amount for monthly sponsorship\namount goals. Represents a count of unique sponsors for total sponsors count goals.

    \n\n\n\n\n\n\n\n\n\n\n\n

    title (String!)

    A brief summary of the kind and target value of this goal.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SponsorsListing\n

    \n

    A GitHub Sponsors listing.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    activeGoal (SponsorsGoal)

    The current goal the maintainer is trying to reach with GitHub Sponsors, if any.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    fullDescription (String!)

    The full description of the listing.

    \n\n\n\n\n\n\n\n\n\n\n\n

    fullDescriptionHTML (HTML!)

    The full description of the listing rendered to HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The listing's full name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    shortDescription (String!)

    The short description of the listing.

    \n\n\n\n\n\n\n\n\n\n\n\n

    slug (String!)

    The short name of the listing.

    \n\n\n\n\n\n\n\n\n\n\n\n

    tiers (SponsorsTierConnection)

    The published tiers for this GitHub Sponsors listing.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (SponsorsTierOrder)

    \n

    Ordering options for Sponsors tiers returned from the connection.

    \n\n
    \n\n
    \n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SponsorsTier\n

    \n

    A GitHub Sponsors tier associated with a GitHub Sponsors listing.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    adminInfo (SponsorsTierAdminInfo)

    SponsorsTier information only visible to users that can administer the associated Sponsors listing.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String!)

    The description of the tier.

    \n\n\n\n\n\n\n\n\n\n\n\n

    descriptionHTML (HTML!)

    The tier description rendered to HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    monthlyPriceInCents (Int!)

    How much this tier costs per month in cents.

    \n\n\n\n\n\n\n\n\n\n\n\n

    monthlyPriceInDollars (Int!)

    How much this tier costs per month in dollars.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The name of the tier.

    \n\n\n\n\n\n\n\n\n\n\n\n

    sponsorsListing (SponsorsListing!)

    The sponsors listing that this tier belongs to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SponsorsTierAdminInfo\n

    \n

    SponsorsTier information only visible to users that can administer the associated Sponsors listing.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    sponsorships (SponsorshipConnection!)

    The sponsorships associated with this tier.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    includePrivate (Boolean)

    \n

    Whether or not to include private sponsorships in the result set.

    \n

    The default value is false.

    \n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (SponsorshipOrder)

    \n

    Ordering options for sponsorships returned from this connection. If left\nblank, the sponsorships will be ordered based on relevancy to the viewer.

    \n\n
    \n\n
    \n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SponsorsTierConnection\n

    \n

    The connection type for SponsorsTier.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([SponsorsTierEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([SponsorsTier])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SponsorsTierEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (SponsorsTier)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Sponsorship\n

    \n

    A sponsorship relationship between a sponsor and a maintainer.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    maintainer (User!)

    The entity that is being sponsored.

    \n\n\n\n\n\n\n
    \n

    Deprecation notice

    \n

    maintainer is deprecated.

    Sponsorship.maintainer will be removed. Use Sponsorship.sponsorable instead. Removal on 2020-04-01 UTC.

    \n
    \n\n\n\n\n\n\n

    privacyLevel (SponsorshipPrivacy!)

    The privacy level for this sponsorship.

    \n\n\n\n\n\n\n\n\n\n\n\n

    sponsor (User)

    The user that is sponsoring. Returns null if the sponsorship is private or if sponsor is not a user.

    \n\n\n\n\n\n\n
    \n

    Deprecation notice

    \n

    sponsor is deprecated.

    Sponsorship.sponsor will be removed. Use Sponsorship.sponsorEntity instead. Removal on 2020-10-01 UTC.

    \n
    \n\n\n\n\n\n\n

    sponsorEntity (Sponsor)

    The user or organization that is sponsoring, if you have permission to view them.

    \n\n\n\n\n\n\n\n\n\n\n\n

    sponsorable (Sponsorable!)

    The entity that is being sponsored.

    \n\n\n\n\n\n\n\n\n\n\n\n

    tier (SponsorsTier)

    The associated sponsorship tier.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SponsorshipConnection\n

    \n

    The connection type for Sponsorship.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([SponsorshipEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Sponsorship])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SponsorshipEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (Sponsorship)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n StargazerConnection\n

    \n

    The connection type for User.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([StargazerEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([User])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n StargazerEdge\n

    \n

    Represents a user that's starred a repository.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    starredAt (DateTime!)

    Identifies when the item was starred.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n StarredRepositoryConnection\n

    \n

    The connection type for Repository.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([StarredRepositoryEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isOverLimit (Boolean!)

    Is the list of stars for this user truncated? This is true for users that have many stars.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Repository])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n StarredRepositoryEdge\n

    \n

    Represents a starred repository.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    starredAt (DateTime!)

    Identifies when the item was starred.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Status\n

    \n

    Represents a commit status.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    combinedContexts (StatusCheckRollupContextConnection!)

    A list of status contexts and check runs for this commit.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    commit (Commit)

    The commit this status is attached to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    context (StatusContext)

    Looks up an individual status context by context name.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    name (String!)

    \n

    The context name.

    \n\n
    \n\n
    \n\n\n

    contexts ([StatusContext!]!)

    The individual status contexts for this commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    state (StatusState!)

    The combined commit status.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n StatusCheckRollup\n

    \n

    Represents the rollup for both the check runs and status for a commit.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    commit (Commit)

    The commit the status and check runs are attached to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    contexts (StatusCheckRollupContextConnection!)

    A list of status contexts and check runs for this commit.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    state (StatusState!)

    The combined status for the commit.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n StatusCheckRollupContextConnection\n

    \n

    The connection type for StatusCheckRollupContext.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([StatusCheckRollupContextEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([StatusCheckRollupContext])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n StatusCheckRollupContextEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (StatusCheckRollupContext)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n StatusContext\n

    \n

    Represents an individual commit status context.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    avatarUrl (URI)

    The avatar of the OAuth application or the user that created the status.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    size (Int)

    \n

    The size of the resulting square image.

    \n

    The default value is 40.

    \n
    \n\n
    \n\n\n

    commit (Commit)

    This commit this status context is attached to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    context (String!)

    The name of this status context.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    creator (Actor)

    The actor who created this status context.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String)

    The description for this status context.

    \n\n\n\n\n\n\n\n\n\n\n\n

    state (StatusState!)

    The state of this status context.

    \n\n\n\n\n\n\n\n\n\n\n\n

    targetUrl (URI)

    The URL for this status context.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Submodule\n

    \n

    A pointer to a repository at a specific revision embedded inside another repository.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    branch (String)

    The branch of the upstream submodule for tracking updates.

    \n\n\n\n\n\n\n\n\n\n\n\n

    gitUrl (URI!)

    The git URL of the submodule repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The name of the submodule in .gitmodules.

    \n\n\n\n\n\n\n\n\n\n\n\n

    path (String!)

    The path in the superproject that this submodule is located in.

    \n\n\n\n\n\n\n\n\n\n\n\n

    subprojectCommitOid (GitObjectID)

    The commit revision of the subproject repository being tracked by the submodule.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SubmoduleConnection\n

    \n

    The connection type for Submodule.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([SubmoduleEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Submodule])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SubmoduleEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (Submodule)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SubscribedEvent\n

    \n

    Represents asubscribedevent on a given Subscribable.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    subscribable (Subscribable!)

    Object referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SuggestedReviewer\n

    \n

    A suggestion to review a pull request based on a user's commit history and review comments.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    isAuthor (Boolean!)

    Is this suggestion based on past commits?.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isCommenter (Boolean!)

    Is this suggestion based on past review comments?.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reviewer (User!)

    Identifies the user suggested to review the pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Tag\n

    \n

    Represents a Git tag.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    abbreviatedOid (String!)

    An abbreviated version of the Git object ID.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commitResourcePath (URI!)

    The HTTP path for this Git object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commitUrl (URI!)

    The HTTP URL for this Git object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    message (String)

    The Git tag message.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The Git tag name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    oid (GitObjectID!)

    The Git object ID.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository!)

    The Repository the Git object belongs to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    tagger (GitActor)

    Details about the tag author.

    \n\n\n\n\n\n\n\n\n\n\n\n

    target (GitObject!)

    The Git object the tag points to.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Team\n

    \n

    A team of users in an organization.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    ancestors (TeamConnection!)

    A list of teams that are ancestors of this team.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    avatarUrl (URI)

    A URL pointing to the team's avatar.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    size (Int)

    \n

    The size in pixels of the resulting square image.

    \n

    The default value is 400.

    \n
    \n\n
    \n\n\n

    childTeams (TeamConnection!)

    List of child teams belonging to this team.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    immediateOnly (Boolean)

    \n

    Whether to list immediate child teams or all descendant child teams.

    \n

    The default value is true.

    \n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (TeamOrder)

    \n

    Order for connection.

    \n\n
    \n\n
    \n

    userLogins ([String!])

    \n

    User logins to filter by.

    \n\n
    \n\n
    \n\n\n

    combinedSlug (String!)

    The slug corresponding to the organization and team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String)

    The description of the team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    discussion (TeamDiscussion)

    Find a team discussion by its number.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    number (Int!)

    \n

    The sequence number of the discussion to find.

    \n\n
    \n\n
    \n\n\n

    discussions (TeamDiscussionConnection!)

    A list of team discussions.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    isPinned (Boolean)

    \n

    If provided, filters discussions according to whether or not they are pinned.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (TeamDiscussionOrder)

    \n

    Order for connection.

    \n\n
    \n\n
    \n\n\n

    discussionsResourcePath (URI!)

    The HTTP path for team discussions.

    \n\n\n\n\n\n\n\n\n\n\n\n

    discussionsUrl (URI!)

    The HTTP URL for team discussions.

    \n\n\n\n\n\n\n\n\n\n\n\n

    editTeamResourcePath (URI!)

    The HTTP path for editing this team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    editTeamUrl (URI!)

    The HTTP URL for editing this team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    invitations (OrganizationInvitationConnection)

    A list of pending invitations for users to this team.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    memberStatuses (UserStatusConnection!)

    Get the status messages members of this entity have set that are either public or visible only to the organization.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (UserStatusOrder)

    \n

    Ordering options for user statuses returned from the connection.

    \n\n
    \n\n
    \n\n\n

    members (TeamMemberConnection!)

    A list of users who are members of this team.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    membership (TeamMembershipType)

    \n

    Filter by membership type.

    \n

    The default value is ALL.

    \n
    \n\n
    \n

    orderBy (TeamMemberOrder)

    \n

    Order for the connection.

    \n\n
    \n\n
    \n

    query (String)

    \n

    The search string to look for.

    \n\n
    \n\n
    \n

    role (TeamMemberRole)

    \n

    Filter by team member role.

    \n\n
    \n\n
    \n\n\n

    membersResourcePath (URI!)

    The HTTP path for the team' members.

    \n\n\n\n\n\n\n\n\n\n\n\n

    membersUrl (URI!)

    The HTTP URL for the team' members.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The name of the team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    newTeamResourcePath (URI!)

    The HTTP path creating a new team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    newTeamUrl (URI!)

    The HTTP URL creating a new team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization!)

    The organization that owns this team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    parentTeam (Team)

    The parent team of the team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    privacy (TeamPrivacy!)

    The level of privacy the team has.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositories (TeamRepositoryConnection!)

    A list of repositories this team has access to.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (TeamRepositoryOrder)

    \n

    Order for the connection.

    \n\n
    \n\n
    \n

    query (String)

    \n

    The search string to look for.

    \n\n
    \n\n
    \n\n\n

    repositoriesResourcePath (URI!)

    The HTTP path for this team's repositories.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoriesUrl (URI!)

    The HTTP URL for this team's repositories.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reviewRequestDelegationAlgorithm (TeamReviewAssignmentAlgorithm)

    What algorithm is used for review assignment for this team.

    \n\n\n\n\n
    \n

    Preview notice

    \n

    reviewRequestDelegationAlgorithm is available under the Team review assignments preview. During the preview period, the API may change without notice.

    \n
    \n\n\n\n\n\n\n\n\n

    reviewRequestDelegationEnabled (Boolean!)

    True if review assignment is enabled for this team.

    \n\n\n\n\n
    \n

    Preview notice

    \n

    reviewRequestDelegationEnabled is available under the Team review assignments preview. During the preview period, the API may change without notice.

    \n
    \n\n\n\n\n\n\n\n\n

    reviewRequestDelegationMemberCount (Int)

    How many team members are required for review assignment for this team.

    \n\n\n\n\n
    \n

    Preview notice

    \n

    reviewRequestDelegationMemberCount is available under the Team review assignments preview. During the preview period, the API may change without notice.

    \n
    \n\n\n\n\n\n\n\n\n

    reviewRequestDelegationNotifyTeam (Boolean!)

    When assigning team members via delegation, whether the entire team should be notified as well.

    \n\n\n\n\n
    \n

    Preview notice

    \n

    reviewRequestDelegationNotifyTeam is available under the Team review assignments preview. During the preview period, the API may change without notice.

    \n
    \n\n\n\n\n\n\n\n\n

    slug (String!)

    The slug corresponding to the team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamsResourcePath (URI!)

    The HTTP path for this team's teams.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamsUrl (URI!)

    The HTTP URL for this team's teams.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanAdminister (Boolean!)

    Team is adminable by the viewer.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanSubscribe (Boolean!)

    Check if the viewer is able to change their subscription status for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerSubscription (SubscriptionState)

    Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamAddMemberAuditEntry\n

    \n

    Audit log entry for a team.add_member event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isLdapMapped (Boolean)

    Whether the team was mapped to an LDAP Group.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    team (Team)

    The team associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamName (String)

    The name of the team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamResourcePath (URI)

    The HTTP path for this team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamUrl (URI)

    The HTTP URL for this team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamAddRepositoryAuditEntry\n

    \n

    Audit log entry for a team.add_repository event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isLdapMapped (Boolean)

    Whether the team was mapped to an LDAP Group.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    team (Team)

    The team associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamName (String)

    The name of the team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamResourcePath (URI)

    The HTTP path for this team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamUrl (URI)

    The HTTP URL for this team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamChangeParentTeamAuditEntry\n

    \n

    Audit log entry for a team.change_parent_team event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isLdapMapped (Boolean)

    Whether the team was mapped to an LDAP Group.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    parentTeam (Team)

    The new parent team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    parentTeamName (String)

    The name of the new parent team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    parentTeamNameWas (String)

    The name of the former parent team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    parentTeamResourcePath (URI)

    The HTTP path for the parent team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    parentTeamUrl (URI)

    The HTTP URL for the parent team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    parentTeamWas (Team)

    The former parent team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    parentTeamWasResourcePath (URI)

    The HTTP path for the previous parent team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    parentTeamWasUrl (URI)

    The HTTP URL for the previous parent team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    team (Team)

    The team associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamName (String)

    The name of the team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamResourcePath (URI)

    The HTTP path for this team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamUrl (URI)

    The HTTP URL for this team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamConnection\n

    \n

    The connection type for Team.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([TeamEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Team])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamDiscussion\n

    \n

    A team discussion.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    author (Actor)

    The actor who authored the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    authorAssociation (CommentAuthorAssociation!)

    Author's association with the discussion's team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    body (String!)

    The body as Markdown.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyHTML (HTML!)

    The body rendered to HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyText (String!)

    The body rendered to text.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyVersion (String!)

    Identifies the discussion body hash.

    \n\n\n\n\n\n\n\n\n\n\n\n

    comments (TeamDiscussionCommentConnection!)

    A list of comments on this discussion.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    fromComment (Int)

    \n

    When provided, filters the connection such that results begin with the comment with this number.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (TeamDiscussionCommentOrder)

    \n

    Order for connection.

    \n\n
    \n\n
    \n\n\n

    commentsResourcePath (URI!)

    The HTTP path for discussion comments.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commentsUrl (URI!)

    The HTTP URL for discussion comments.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdViaEmail (Boolean!)

    Check if this comment was created via an email reply.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    editor (Actor)

    The actor who edited the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    includesCreatedEdit (Boolean!)

    Check if this comment was edited and includes an edit with the creation data.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isPinned (Boolean!)

    Whether or not the discussion is pinned.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isPrivate (Boolean!)

    Whether or not the discussion is only visible to team members and org admins.

    \n\n\n\n\n\n\n\n\n\n\n\n

    lastEditedAt (DateTime)

    The moment the editor made the last edit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    number (Int!)

    Identifies the discussion within its team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    publishedAt (DateTime)

    Identifies when the comment was published at.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reactionGroups ([ReactionGroup!])

    A list of reactions grouped by content left on the subject.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reactions (ReactionConnection!)

    A list of Reactions left on the Issue.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    content (ReactionContent)

    \n

    Allows filtering Reactions by emoji.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (ReactionOrder)

    \n

    Allows specifying the order in which reactions are returned.

    \n\n
    \n\n
    \n\n\n

    resourcePath (URI!)

    The HTTP path for this discussion.

    \n\n\n\n\n\n\n\n\n\n\n\n

    team (Team!)

    The team that defines the context of this discussion.

    \n\n\n\n\n\n\n\n\n\n\n\n

    title (String!)

    The title of the discussion.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this discussion.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userContentEdits (UserContentEditConnection)

    A list of edits to this content.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    viewerCanDelete (Boolean!)

    Check if the current viewer can delete this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanPin (Boolean!)

    Whether or not the current viewer can pin this discussion.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanReact (Boolean!)

    Can user react to this subject.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanSubscribe (Boolean!)

    Check if the viewer is able to change their subscription status for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanUpdate (Boolean!)

    Check if the current viewer can update this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

    Reasons why the current viewer can not update this comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerDidAuthor (Boolean!)

    Did the viewer author this comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerSubscription (SubscriptionState)

    Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamDiscussionComment\n

    \n

    A comment on a team discussion.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    author (Actor)

    The actor who authored the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    authorAssociation (CommentAuthorAssociation!)

    Author's association with the comment's team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    body (String!)

    The body as Markdown.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyHTML (HTML!)

    The body rendered to HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyText (String!)

    The body rendered to text.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyVersion (String!)

    The current version of the body content.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdViaEmail (Boolean!)

    Check if this comment was created via an email reply.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    discussion (TeamDiscussion!)

    The discussion this comment is about.

    \n\n\n\n\n\n\n\n\n\n\n\n

    editor (Actor)

    The actor who edited the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    includesCreatedEdit (Boolean!)

    Check if this comment was edited and includes an edit with the creation data.

    \n\n\n\n\n\n\n\n\n\n\n\n

    lastEditedAt (DateTime)

    The moment the editor made the last edit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    number (Int!)

    Identifies the comment number.

    \n\n\n\n\n\n\n\n\n\n\n\n

    publishedAt (DateTime)

    Identifies when the comment was published at.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reactionGroups ([ReactionGroup!])

    A list of reactions grouped by content left on the subject.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reactions (ReactionConnection!)

    A list of Reactions left on the Issue.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    content (ReactionContent)

    \n

    Allows filtering Reactions by emoji.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (ReactionOrder)

    \n

    Allows specifying the order in which reactions are returned.

    \n\n
    \n\n
    \n\n\n

    resourcePath (URI!)

    The HTTP path for this comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userContentEdits (UserContentEditConnection)

    A list of edits to this content.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    viewerCanDelete (Boolean!)

    Check if the current viewer can delete this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanReact (Boolean!)

    Can user react to this subject.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanUpdate (Boolean!)

    Check if the current viewer can update this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

    Reasons why the current viewer can not update this comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerDidAuthor (Boolean!)

    Did the viewer author this comment.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamDiscussionCommentConnection\n

    \n

    The connection type for TeamDiscussionComment.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([TeamDiscussionCommentEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([TeamDiscussionComment])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamDiscussionCommentEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (TeamDiscussionComment)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamDiscussionConnection\n

    \n

    The connection type for TeamDiscussion.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([TeamDiscussionEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([TeamDiscussion])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamDiscussionEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (TeamDiscussion)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (Team)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamMemberConnection\n

    \n

    The connection type for User.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([TeamMemberEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([User])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamMemberEdge\n

    \n

    Represents a user who is a member of a team.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    memberAccessResourcePath (URI!)

    The HTTP path to the organization's member access page.

    \n\n\n\n\n\n\n\n\n\n\n\n

    memberAccessUrl (URI!)

    The HTTP URL to the organization's member access page.

    \n\n\n\n\n\n\n\n\n\n\n\n

    role (TeamMemberRole!)

    The role the member has on the team.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamRemoveMemberAuditEntry\n

    \n

    Audit log entry for a team.remove_member event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isLdapMapped (Boolean)

    Whether the team was mapped to an LDAP Group.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    team (Team)

    The team associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamName (String)

    The name of the team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamResourcePath (URI)

    The HTTP path for this team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamUrl (URI)

    The HTTP URL for this team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamRemoveRepositoryAuditEntry\n

    \n

    Audit log entry for a team.remove_repository event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isLdapMapped (Boolean)

    Whether the team was mapped to an LDAP Group.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    team (Team)

    The team associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamName (String)

    The name of the team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamResourcePath (URI)

    The HTTP path for this team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamUrl (URI)

    The HTTP URL for this team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamRepositoryConnection\n

    \n

    The connection type for Repository.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([TeamRepositoryEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Repository])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamRepositoryEdge\n

    \n

    Represents a team repository.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    permission (RepositoryPermission!)

    The permission level the team has on the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TextMatch\n

    \n

    A text match within a search result.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    fragment (String!)

    The specific text fragment within the property matched on.

    \n\n\n\n\n\n\n\n\n\n\n\n

    highlights ([TextMatchHighlight!]!)

    Highlights within the matched fragment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    property (String!)

    The property matched on.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TextMatchHighlight\n

    \n

    Represents a single highlight in a search result match.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    beginIndice (Int!)

    The indice in the fragment where the matched text begins.

    \n\n\n\n\n\n\n\n\n\n\n\n

    endIndice (Int!)

    The indice in the fragment where the matched text ends.

    \n\n\n\n\n\n\n\n\n\n\n\n

    text (String!)

    The text matched.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Topic\n

    \n

    A topic aggregates entities that are related to a subject.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    name (String!)

    The topic's name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    relatedTopics ([Topic!]!)

    A list of related topics, including aliases of this topic, sorted with the most relevant\nfirst. Returns up to 10 Topics.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    first (Int)

    \n

    How many topics to return.

    \n

    The default value is 3.

    \n
    \n\n
    \n\n\n

    stargazerCount (Int!)

    Returns a count of how many stargazers there are on this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    stargazers (StargazerConnection!)

    A list of users who have starred this starrable.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (StarOrder)

    \n

    Order for connection.

    \n\n
    \n\n
    \n\n\n

    viewerHasStarred (Boolean!)

    Returns a boolean indicating whether the viewing user has starred this starrable.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TransferredEvent\n

    \n

    Represents atransferredevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    fromRepository (Repository)

    The repository this came from.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issue (Issue!)

    Identifies the issue associated with the event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Tree\n

    \n

    Represents a Git tree.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    abbreviatedOid (String!)

    An abbreviated version of the Git object ID.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commitResourcePath (URI!)

    The HTTP path for this Git object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commitUrl (URI!)

    The HTTP URL for this Git object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    entries ([TreeEntry!])

    A list of tree entries.

    \n\n\n\n\n\n\n\n\n\n\n\n

    oid (GitObjectID!)

    The Git object ID.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository!)

    The Repository the Git object belongs to.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TreeEntry\n

    \n

    Represents a Git tree entry.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    extension (String)

    The extension of the file.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isGenerated (Boolean!)

    Whether or not this tree entry is generated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    mode (Int!)

    Entry file mode.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    Entry file name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    object (GitObject)

    Entry file object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    oid (GitObjectID!)

    Entry file Git object ID.

    \n\n\n\n\n\n\n\n\n\n\n\n

    path (String)

    The full path of the file.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository!)

    The Repository the tree entry belongs to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    submodule (Submodule)

    If the TreeEntry is for a directory occupied by a submodule project, this returns the corresponding submodule.

    \n\n\n\n\n\n\n\n\n\n\n\n

    type (String!)

    Entry file type.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n UnassignedEvent\n

    \n

    Represents anunassignedevent on any assignable object.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    assignable (Assignable!)

    Identifies the assignable associated with the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    assignee (Assignee)

    Identifies the user or mannequin that was unassigned.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    Identifies the subject (user) who was unassigned.

    \n\n\n\n\n\n\n
    \n

    Deprecation notice

    \n

    user is deprecated.

    Assignees can now be mannequins. Use the assignee field instead. Removal on 2020-01-01 UTC.

    \n
    \n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n UnknownSignature\n

    \n

    Represents an unknown signature on a Commit or Tag.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    email (String!)

    Email used to sign this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isValid (Boolean!)

    True if the signature is valid and verified by GitHub.

    \n\n\n\n\n\n\n\n\n\n\n\n

    payload (String!)

    Payload for GPG signing object. Raw ODB object without the signature header.

    \n\n\n\n\n\n\n\n\n\n\n\n

    signature (String!)

    ASCII-armored signature header from object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    signer (User)

    GitHub user corresponding to the email signing this commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    state (GitSignatureState!)

    The state of this signature. VALID if signature is valid and verified by\nGitHub, otherwise represents reason why signature is considered invalid.

    \n\n\n\n\n\n\n\n\n\n\n\n

    wasSignedByGitHub (Boolean!)

    True if the signature was made with GitHub's signing key.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n UnlabeledEvent\n

    \n

    Represents anunlabeledevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    label (Label!)

    Identifies the label associated with theunlabeledevent.

    \n\n\n\n\n\n\n\n\n\n\n\n

    labelable (Labelable!)

    Identifies the Labelable associated with the event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n UnlockedEvent\n

    \n

    Represents anunlockedevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    lockable (Lockable!)

    Object that was unlocked.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n UnmarkedAsDuplicateEvent\n

    \n

    Represents anunmarked_as_duplicateevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    canonical (IssueOrPullRequest)

    The authoritative issue or pull request which has been duplicated by another.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    duplicate (IssueOrPullRequest)

    The issue or pull request which has been marked as a duplicate of another.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isCrossRepository (Boolean!)

    Canonical and duplicate belong to different repositories.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n UnpinnedEvent\n

    \n

    Represents anunpinnedevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issue (Issue!)

    Identifies the issue associated with the event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n UnsubscribedEvent\n

    \n

    Represents anunsubscribedevent on a given Subscribable.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    subscribable (Subscribable!)

    Object referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n User\n

    \n

    A user is an individual's account on GitHub that owns repositories and can make new content.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    anyPinnableItems (Boolean!)

    Determine if this repository owner has any items that can be pinned to their profile.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    type (PinnableItemType)

    \n

    Filter to only a particular kind of pinnable item.

    \n\n
    \n\n
    \n\n\n

    avatarUrl (URI!)

    A URL pointing to the user's public avatar.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    size (Int)

    \n

    The size of the resulting square image.

    \n\n
    \n\n
    \n\n\n

    bio (String)

    The user's public profile bio.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bioHTML (HTML!)

    The user's public profile bio as HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commitComments (CommitCommentConnection!)

    A list of commit comments made by this user.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    company (String)

    The user's public profile company.

    \n\n\n\n\n\n\n\n\n\n\n\n

    companyHTML (HTML!)

    The user's public profile company as HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    contributionsCollection (ContributionsCollection!)

    The collection of contributions this user has made to different repositories.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    from (DateTime)

    \n

    Only contributions made at this time or later will be counted. If omitted, defaults to a year ago.

    \n\n
    \n\n
    \n

    organizationID (ID)

    \n

    The ID of the organization used to filter contributions.

    \n\n
    \n\n
    \n

    to (DateTime)

    \n

    Only contributions made before and up to and including this time will be\ncounted. If omitted, defaults to the current time.

    \n\n
    \n\n
    \n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    email (String!)

    The user's publicly visible profile email.

    \n\n\n\n\n\n\n\n\n\n\n\n

    followers (FollowerConnection!)

    A list of users the given user is followed by.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    following (FollowingConnection!)

    A list of users the given user is following.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    gist (Gist)

    Find gist by repo name.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    name (String!)

    \n

    The gist name to find.

    \n\n
    \n\n
    \n\n\n

    gistComments (GistCommentConnection!)

    A list of gist comments made by this user.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    gists (GistConnection!)

    A list of the Gists the user has created.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (GistOrder)

    \n

    Ordering options for gists returned from the connection.

    \n\n
    \n\n
    \n

    privacy (GistPrivacy)

    \n

    Filters Gists according to privacy.

    \n\n
    \n\n
    \n\n\n

    hasSponsorsListing (Boolean!)

    True if this user/organization has a GitHub Sponsors listing.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hovercard (Hovercard!)

    The hovercard information for this user in a given context.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    primarySubjectId (ID)

    \n

    The ID of the subject to get the hovercard in the context of.

    \n\n
    \n\n
    \n\n\n

    interactionAbility (RepositoryInteractionAbility)

    The interaction ability settings for this user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isBountyHunter (Boolean!)

    Whether or not this user is a participant in the GitHub Security Bug Bounty.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isCampusExpert (Boolean!)

    Whether or not this user is a participant in the GitHub Campus Experts Program.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isDeveloperProgramMember (Boolean!)

    Whether or not this user is a GitHub Developer Program member.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isEmployee (Boolean!)

    Whether or not this user is a GitHub employee.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isHireable (Boolean!)

    Whether or not the user has marked themselves as for hire.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isSiteAdmin (Boolean!)

    Whether or not this user is a site administrator.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isSponsoredBy (Boolean!)

    Check if the given account is sponsoring this user/organization.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    accountLogin (String!)

    \n

    The target account's login.

    \n\n
    \n\n
    \n\n\n

    isSponsoringViewer (Boolean!)

    True if the viewer is sponsored by this user/organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isViewer (Boolean!)

    Whether or not this user is the viewing user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issueComments (IssueCommentConnection!)

    A list of issue comments made by this user.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (IssueCommentOrder)

    \n

    Ordering options for issue comments returned from the connection.

    \n\n
    \n\n
    \n\n\n

    issues (IssueConnection!)

    A list of issues associated with this user.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    filterBy (IssueFilters)

    \n

    Filtering options for issues returned from the connection.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    labels ([String!])

    \n

    A list of label names to filter the pull requests by.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (IssueOrder)

    \n

    Ordering options for issues returned from the connection.

    \n\n
    \n\n
    \n

    states ([IssueState!])

    \n

    A list of states to filter the issues by.

    \n\n
    \n\n
    \n\n\n

    itemShowcase (ProfileItemShowcase!)

    Showcases a selection of repositories and gists that the profile owner has\neither curated or that have been selected automatically based on popularity.

    \n\n\n\n\n\n\n\n\n\n\n\n

    location (String)

    The user's public profile location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    login (String!)

    The username used to login.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String)

    The user's public profile name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    Find an organization by its login that the user belongs to.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    login (String!)

    \n

    The login of the organization to find.

    \n\n
    \n\n
    \n\n\n

    organizationVerifiedDomainEmails ([String!]!)

    Verified email addresses that match verified domains for a specified organization the user is a member of.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    login (String!)

    \n

    The login of the organization to match verified domains from.

    \n\n
    \n\n
    \n\n\n

    organizations (OrganizationConnection!)

    A list of organizations the user belongs to.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    packages (PackageConnection!)

    A list of packages under the owner.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    names ([String])

    \n

    Find packages by their names.

    \n\n
    \n\n
    \n

    orderBy (PackageOrder)

    \n

    Ordering of the returned packages.

    \n\n
    \n\n
    \n

    packageType (PackageType)

    \n

    Filter registry package by type.

    \n\n
    \n\n
    \n

    repositoryId (ID)

    \n

    Find packages in a repository by ID.

    \n\n
    \n\n
    \n\n\n

    pinnableItems (PinnableItemConnection!)

    A list of repositories and gists this profile owner can pin to their profile.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    types ([PinnableItemType!])

    \n

    Filter the types of pinnable items that are returned.

    \n\n
    \n\n
    \n\n\n

    pinnedItems (PinnableItemConnection!)

    A list of repositories and gists this profile owner has pinned to their profile.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    types ([PinnableItemType!])

    \n

    Filter the types of pinned items that are returned.

    \n\n
    \n\n
    \n\n\n

    pinnedItemsRemaining (Int!)

    Returns how many more items this profile owner can pin to their profile.

    \n\n\n\n\n\n\n\n\n\n\n\n

    project (Project)

    Find project by number.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    number (Int!)

    \n

    The project number to find.

    \n\n
    \n\n
    \n\n\n

    projects (ProjectConnection!)

    A list of projects under the owner.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (ProjectOrder)

    \n

    Ordering options for projects returned from the connection.

    \n\n
    \n\n
    \n

    search (String)

    \n

    Query to search projects by, currently only searching by name.

    \n\n
    \n\n
    \n

    states ([ProjectState!])

    \n

    A list of states to filter the projects by.

    \n\n
    \n\n
    \n\n\n

    projectsResourcePath (URI!)

    The HTTP path listing user's projects.

    \n\n\n\n\n\n\n\n\n\n\n\n

    projectsUrl (URI!)

    The HTTP URL listing user's projects.

    \n\n\n\n\n\n\n\n\n\n\n\n

    publicKeys (PublicKeyConnection!)

    A list of public keys associated with this user.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    pullRequests (PullRequestConnection!)

    A list of pull requests associated with this user.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    baseRefName (String)

    \n

    The base ref name to filter the pull requests by.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    headRefName (String)

    \n

    The head ref name to filter the pull requests by.

    \n\n
    \n\n
    \n

    labels ([String!])

    \n

    A list of label names to filter the pull requests by.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (IssueOrder)

    \n

    Ordering options for pull requests returned from the connection.

    \n\n
    \n\n
    \n

    states ([PullRequestState!])

    \n

    A list of states to filter the pull requests by.

    \n\n
    \n\n
    \n\n\n

    repositories (RepositoryConnection!)

    A list of repositories that the user owns.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    affiliations ([RepositoryAffiliation])

    \n

    Array of viewer's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\ncurrent viewer owns.

    \n\n
    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    isFork (Boolean)

    \n

    If non-null, filters repositories according to whether they are forks of another repository.

    \n\n
    \n\n
    \n

    isLocked (Boolean)

    \n

    If non-null, filters repositories according to whether they have been locked.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (RepositoryOrder)

    \n

    Ordering options for repositories returned from the connection.

    \n\n
    \n\n
    \n

    ownerAffiliations ([RepositoryAffiliation])

    \n

    Array of owner's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\norganization or user being viewed owns.

    \n\n
    \n\n
    \n

    privacy (RepositoryPrivacy)

    \n

    If non-null, filters repositories according to privacy.

    \n\n
    \n\n
    \n\n\n

    repositoriesContributedTo (RepositoryConnection!)

    A list of repositories that the user recently contributed to.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    contributionTypes ([RepositoryContributionType])

    \n

    If non-null, include only the specified types of contributions. The\nGitHub.com UI uses [COMMIT, ISSUE, PULL_REQUEST, REPOSITORY].

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    includeUserRepositories (Boolean)

    \n

    If true, include user repositories.

    \n\n
    \n\n
    \n

    isLocked (Boolean)

    \n

    If non-null, filters repositories according to whether they have been locked.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (RepositoryOrder)

    \n

    Ordering options for repositories returned from the connection.

    \n\n
    \n\n
    \n

    privacy (RepositoryPrivacy)

    \n

    If non-null, filters repositories according to privacy.

    \n\n
    \n\n
    \n\n\n

    repository (Repository)

    Find Repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    name (String!)

    \n

    Name of Repository to find.

    \n\n
    \n\n
    \n\n\n

    resourcePath (URI!)

    The HTTP path for this user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    savedReplies (SavedReplyConnection)

    Replies this user has saved.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (SavedReplyOrder)

    \n

    The field to order saved replies by.

    \n\n
    \n\n
    \n\n\n

    sponsorsListing (SponsorsListing)

    The GitHub Sponsors listing for this user or organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    sponsorshipForViewerAsSponsor (Sponsorship)

    The viewer's sponsorship of this entity.

    \n\n\n\n\n\n\n\n\n\n\n\n

    sponsorshipsAsMaintainer (SponsorshipConnection!)

    This object's sponsorships as the maintainer.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    includePrivate (Boolean)

    \n

    Whether or not to include private sponsorships in the result set.

    \n

    The default value is false.

    \n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (SponsorshipOrder)

    \n

    Ordering options for sponsorships returned from this connection. If left\nblank, the sponsorships will be ordered based on relevancy to the viewer.

    \n\n
    \n\n
    \n\n\n

    sponsorshipsAsSponsor (SponsorshipConnection!)

    This object's sponsorships as the sponsor.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (SponsorshipOrder)

    \n

    Ordering options for sponsorships returned from this connection. If left\nblank, the sponsorships will be ordered based on relevancy to the viewer.

    \n\n
    \n\n
    \n\n\n

    starredRepositories (StarredRepositoryConnection!)

    Repositories the user has starred.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (StarOrder)

    \n

    Order for connection.

    \n\n
    \n\n
    \n

    ownedByViewer (Boolean)

    \n

    Filters starred repositories to only return repositories owned by the viewer.

    \n\n
    \n\n
    \n\n\n

    status (UserStatus)

    The user's description of what they're currently doing.

    \n\n\n\n\n\n\n\n\n\n\n\n

    topRepositories (RepositoryConnection!)

    Repositories the user has contributed to, ordered by contribution rank, plus repositories the user has created.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (RepositoryOrder!)

    \n

    Ordering options for repositories returned from the connection.

    \n\n
    \n\n
    \n

    since (DateTime)

    \n

    How far back in time to fetch contributed repositories.

    \n\n
    \n\n
    \n\n\n

    twitterUsername (String)

    The user's Twitter username.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanChangePinnedItems (Boolean!)

    Can the viewer pin repositories and gists to the profile?.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanCreateProjects (Boolean!)

    Can the current viewer create new projects on this owner.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanFollow (Boolean!)

    Whether or not the viewer is able to follow the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanSponsor (Boolean!)

    Whether or not the viewer is able to sponsor this user/organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerIsFollowing (Boolean!)

    Whether or not this user is followed by the viewer.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerIsSponsoring (Boolean!)

    True if the viewer is sponsoring this user/organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    watching (RepositoryConnection!)

    A list of repositories the given user is watching.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    affiliations ([RepositoryAffiliation])

    \n

    Affiliation options for repositories returned from the connection. If none\nspecified, the results will include repositories for which the current\nviewer is an owner or collaborator, or member.

    \n\n
    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    isLocked (Boolean)

    \n

    If non-null, filters repositories according to whether they have been locked.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (RepositoryOrder)

    \n

    Ordering options for repositories returned from the connection.

    \n\n
    \n\n
    \n

    ownerAffiliations ([RepositoryAffiliation])

    \n

    Array of owner's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\norganization or user being viewed owns.

    \n\n
    \n\n
    \n

    privacy (RepositoryPrivacy)

    \n

    If non-null, filters repositories according to privacy.

    \n\n
    \n\n
    \n\n\n

    websiteUrl (URI)

    A URL pointing to the user's public website/blog.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n UserBlockedEvent\n

    \n

    Represents auser_blockedevent on a given user.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    blockDuration (UserBlockDuration!)

    Number of days that the user was blocked for.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    subject (User)

    The user who was blocked.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n UserConnection\n

    \n

    The connection type for User.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([UserEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([User])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n UserContentEdit\n

    \n

    An edit on user content.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    deletedAt (DateTime)

    Identifies the date and time when the object was deleted.

    \n\n\n\n\n\n\n\n\n\n\n\n

    deletedBy (Actor)

    The actor who deleted this content.

    \n\n\n\n\n\n\n\n\n\n\n\n

    diff (String)

    A summary of the changes for this edit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    editedAt (DateTime!)

    When this content was edited.

    \n\n\n\n\n\n\n\n\n\n\n\n

    editor (Actor)

    The actor who edited this content.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n UserContentEditConnection\n

    \n

    A list of edits to content.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([UserContentEditEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([UserContentEdit])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n UserContentEditEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (UserContentEdit)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n UserEdge\n

    \n

    Represents a user.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (User)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n UserEmailMetadata\n

    \n

    Email attributes from External Identity.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    primary (Boolean)

    Boolean to identify primary emails.

    \n\n\n\n\n\n\n\n\n\n\n\n

    type (String)

    Type of email.

    \n\n\n\n\n\n\n\n\n\n\n\n

    value (String!)

    Email id.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n UserStatus\n

    \n

    The user's description of what they're currently doing.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    emoji (String)

    An emoji summarizing the user's status.

    \n\n\n\n\n\n\n\n\n\n\n\n

    emojiHTML (HTML)

    The status emoji as HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    expiresAt (DateTime)

    If set, the status will not be shown after this date.

    \n\n\n\n\n\n\n\n\n\n\n\n

    id (ID!)

    ID of the object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    indicatesLimitedAvailability (Boolean!)

    Whether this status indicates the user is not fully available on GitHub.

    \n\n\n\n\n\n\n\n\n\n\n\n

    message (String)

    A brief message describing what the user is doing.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The organization whose members can see this status. If null, this status is publicly visible.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User!)

    The user who has this status.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n UserStatusConnection\n

    \n

    The connection type for UserStatus.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([UserStatusEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([UserStatus])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n UserStatusEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (UserStatus)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n VerifiableDomain\n

    \n

    A domain that can be verified for an organization or an enterprise.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    dnsHostName (URI)

    The DNS host name that should be used for verification.

    \n\n\n\n\n\n\n\n\n\n\n\n

    domain (URI!)

    The unicode encoded domain.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hasFoundHostName (Boolean!)

    Whether a TXT record for verification with the expected host name was found.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hasFoundVerificationToken (Boolean!)

    Whether a TXT record for verification with the expected verification token was found.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isRequiredForPolicyEnforcement (Boolean!)

    Whether this domain is required to exist for an organization or enterprise policy to be enforced.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isVerified (Boolean!)

    Whether or not the domain is verified.

    \n\n\n\n\n\n\n\n\n\n\n\n

    owner (VerifiableDomainOwner!)

    The owner of the domain.

    \n\n\n\n\n\n\n\n\n\n\n\n

    punycodeEncodedDomain (URI!)

    The punycode encoded domain.

    \n\n\n\n\n\n\n\n\n\n\n\n

    tokenExpirationTime (DateTime)

    The time that the current verification token will expire.

    \n\n\n\n\n\n\n\n\n\n\n\n

    verificationToken (String)

    The current verification token for the domain.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n VerifiableDomainConnection\n

    \n

    The connection type for VerifiableDomain.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([VerifiableDomainEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([VerifiableDomain])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n VerifiableDomainEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (VerifiableDomain)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ViewerHovercardContext\n

    \n

    A hovercard context with a message describing how the viewer is related.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    message (String!)

    A string describing this context.

    \n\n\n\n\n\n\n\n\n\n\n\n

    octicon (String!)

    An octicon to accompany this context.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewer (User!)

    Identifies the user who is related to this context.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n", + "html": "
    \n
    \n

    \n ActorLocation\n

    \n

    Location information for an actor.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    city (String)

    City.

    \n\n\n\n\n\n\n\n\n\n\n\n

    country (String)

    Country name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    countryCode (String)

    Country code.

    \n\n\n\n\n\n\n\n\n\n\n\n

    region (String)

    Region name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    regionCode (String)

    Region or state code.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n AddedToProjectEvent\n

    \n

    Represents aadded_to_projectevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    project (Project)

    Project referenced by event.

    \n\n\n\n\n
    \n

    Preview notice

    \n

    project is available under the Project event details preview. During the preview period, the API may change without notice.

    \n
    \n\n\n\n\n\n\n\n\n

    projectCard (ProjectCard)

    Project card referenced by this project event.

    \n\n\n\n\n
    \n

    Preview notice

    \n

    projectCard is available under the Project event details preview. During the preview period, the API may change without notice.

    \n
    \n\n\n\n\n\n\n\n\n

    projectColumnName (String!)

    Column name referenced by this project event.

    \n\n\n\n\n
    \n

    Preview notice

    \n

    projectColumnName is available under the Project event details preview. During the preview period, the API may change without notice.

    \n
    \n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n App\n

    \n

    A GitHub App.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String)

    The description of the app.

    \n\n\n\n\n\n\n\n\n\n\n\n

    logoBackgroundColor (String!)

    The hex color code, without the leading '#', for the logo background.

    \n\n\n\n\n\n\n\n\n\n\n\n

    logoUrl (URI!)

    A URL pointing to the app's logo.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    size (Int)

    \n

    The size of the resulting image.

    \n\n
    \n\n
    \n\n\n

    name (String!)

    The name of the app.

    \n\n\n\n\n\n\n\n\n\n\n\n

    slug (String!)

    A slug based on the name of the app for use in URLs.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The URL to the app's homepage.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n AssignedEvent\n

    \n

    Represents anassignedevent on any assignable object.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    assignable (Assignable!)

    Identifies the assignable associated with the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    assignee (Assignee)

    Identifies the user or mannequin that was assigned.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    Identifies the user who was assigned.

    \n\n\n\n\n\n\n
    \n

    Deprecation notice

    \n

    user is deprecated.

    Assignees can now be mannequins. Use the assignee field instead. Removal on 2020-01-01 UTC.

    \n
    \n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n AutoMergeDisabledEvent\n

    \n

    Represents aauto_merge_disabledevent on a given pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    disabler (User)

    The user who disabled auto-merge for this Pull Request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest)

    PullRequest referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reason (String)

    The reason auto-merge was disabled.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reasonCode (String)

    The reason_code relating to why auto-merge was disabled.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n AutoMergeEnabledEvent\n

    \n

    Represents aauto_merge_enabledevent on a given pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enabler (User)

    The user who enabled auto-merge for this Pull Request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest)

    PullRequest referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n AutoMergeRequest\n

    \n

    Represents an auto-merge request for a pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    authorEmail (String)

    The email address of the author of this auto-merge request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commitBody (String)

    The commit message of the auto-merge request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commitHeadline (String)

    The commit title of the auto-merge request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enabledAt (DateTime)

    When was this auto-merge request was enabled.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enabledBy (Actor)

    The actor who created the auto-merge request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    mergeMethod (PullRequestMergeMethod!)

    The merge method of the auto-merge request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    The pull request that this auto-merge request is set against.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n AutoRebaseEnabledEvent\n

    \n

    Represents aauto_rebase_enabledevent on a given pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enabler (User)

    The user who enabled auto-merge (rebase) for this Pull Request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest)

    PullRequest referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n AutoSquashEnabledEvent\n

    \n

    Represents aauto_squash_enabledevent on a given pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enabler (User)

    The user who enabled auto-merge (squash) for this Pull Request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest)

    PullRequest referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n AutomaticBaseChangeFailedEvent\n

    \n

    Represents aautomatic_base_change_failedevent on a given pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    newBase (String!)

    The new base for this PR.

    \n\n\n\n\n\n\n\n\n\n\n\n

    oldBase (String!)

    The old base for this PR.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    PullRequest referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n AutomaticBaseChangeSucceededEvent\n

    \n

    Represents aautomatic_base_change_succeededevent on a given pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    newBase (String!)

    The new base for this PR.

    \n\n\n\n\n\n\n\n\n\n\n\n

    oldBase (String!)

    The old base for this PR.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    PullRequest referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n BaseRefChangedEvent\n

    \n

    Represents abase_ref_changedevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    currentRefName (String!)

    Identifies the name of the base ref for the pull request after it was changed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    previousRefName (String!)

    Identifies the name of the base ref for the pull request before it was changed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    PullRequest referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n BaseRefDeletedEvent\n

    \n

    Represents abase_ref_deletedevent on a given pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    baseRefName (String)

    Identifies the name of the Ref associated with the base_ref_deleted event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest)

    PullRequest referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n BaseRefForcePushedEvent\n

    \n

    Represents abase_ref_force_pushedevent on a given pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    afterCommit (Commit)

    Identifies the after commit SHA for thebase_ref_force_pushedevent.

    \n\n\n\n\n\n\n\n\n\n\n\n

    beforeCommit (Commit)

    Identifies the before commit SHA for thebase_ref_force_pushedevent.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    PullRequest referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ref (Ref)

    Identifies the fully qualified ref name for thebase_ref_force_pushedevent.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Blame\n

    \n

    Represents a Git blame.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    ranges ([BlameRange!]!)

    The list of ranges from a Git blame.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n BlameRange\n

    \n

    Represents a range of information from a Git blame.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    age (Int!)

    Identifies the recency of the change, from 1 (new) to 10 (old). This is\ncalculated as a 2-quantile and determines the length of distance between the\nmedian age of all the changes in the file and the recency of the current\nrange's change.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commit (Commit!)

    Identifies the line author.

    \n\n\n\n\n\n\n\n\n\n\n\n

    endingLine (Int!)

    The ending line for the range.

    \n\n\n\n\n\n\n\n\n\n\n\n

    startingLine (Int!)

    The starting line for the range.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Blob\n

    \n

    Represents a Git blob.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    abbreviatedOid (String!)

    An abbreviated version of the Git object ID.

    \n\n\n\n\n\n\n\n\n\n\n\n

    byteSize (Int!)

    Byte size of Blob object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commitResourcePath (URI!)

    The HTTP path for this Git object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commitUrl (URI!)

    The HTTP URL for this Git object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isBinary (Boolean)

    Indicates whether the Blob is binary or text. Returns null if unable to determine the encoding.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isTruncated (Boolean!)

    Indicates whether the contents is truncated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    oid (GitObjectID!)

    The Git object ID.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository!)

    The Repository the Git object belongs to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    text (String)

    UTF8 text data or null if the Blob is binary.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Bot\n

    \n

    A special type of user which takes actions on behalf of GitHub Apps.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    avatarUrl (URI!)

    A URL pointing to the GitHub App's public avatar.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    size (Int)

    \n

    The size of the resulting square image.

    \n\n
    \n\n
    \n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    login (String!)

    The username of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this bot.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this bot.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n BranchProtectionRule\n

    \n

    A branch protection rule.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    allowsDeletions (Boolean!)

    Can this branch be deleted.

    \n\n\n\n\n\n\n\n\n\n\n\n

    allowsForcePushes (Boolean!)

    Are force pushes allowed on this branch.

    \n\n\n\n\n\n\n\n\n\n\n\n

    branchProtectionRuleConflicts (BranchProtectionRuleConflictConnection!)

    A list of conflicts matching branches protection rule and other branch protection rules.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    creator (Actor)

    The actor who created this branch protection rule.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    dismissesStaleReviews (Boolean!)

    Will new commits pushed to matching branches dismiss pull request review approvals.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isAdminEnforced (Boolean!)

    Can admins overwrite branch protection.

    \n\n\n\n\n\n\n\n\n\n\n\n

    matchingRefs (RefConnection!)

    Repository refs that are protected by this rule.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    query (String)

    \n

    Filters refs with query on name.

    \n\n
    \n\n
    \n\n\n

    pattern (String!)

    Identifies the protection rule pattern.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pushAllowances (PushAllowanceConnection!)

    A list push allowances for this branch protection rule.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    repository (Repository)

    The repository associated with this branch protection rule.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiredApprovingReviewCount (Int)

    Number of approving reviews required to update matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiredStatusCheckContexts ([String])

    List of required status check contexts that must pass for commits to be accepted to matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiresApprovingReviews (Boolean!)

    Are approving reviews required to update matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiresCodeOwnerReviews (Boolean!)

    Are reviews from code owners required to update matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiresCommitSignatures (Boolean!)

    Are commits required to be signed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiresLinearHistory (Boolean!)

    Are merge commits prohibited from being pushed to this branch.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiresStatusChecks (Boolean!)

    Are status checks required to update matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiresStrictStatusChecks (Boolean!)

    Are branches required to be up to date before merging.

    \n\n\n\n\n\n\n\n\n\n\n\n

    restrictsPushes (Boolean!)

    Is pushing to matching branches restricted.

    \n\n\n\n\n\n\n\n\n\n\n\n

    restrictsReviewDismissals (Boolean!)

    Is dismissal of pull request reviews restricted.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reviewDismissalAllowances (ReviewDismissalAllowanceConnection!)

    A list review dismissal allowances for this branch protection rule.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n BranchProtectionRuleConflict\n

    \n

    A conflict between two branch protection rules.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    branchProtectionRule (BranchProtectionRule)

    Identifies the branch protection rule.

    \n\n\n\n\n\n\n\n\n\n\n\n

    conflictingBranchProtectionRule (BranchProtectionRule)

    Identifies the conflicting branch protection rule.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ref (Ref)

    Identifies the branch ref that has conflicting rules.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n BranchProtectionRuleConflictConnection\n

    \n

    The connection type for BranchProtectionRuleConflict.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([BranchProtectionRuleConflictEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([BranchProtectionRuleConflict])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n BranchProtectionRuleConflictEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (BranchProtectionRuleConflict)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n BranchProtectionRuleConnection\n

    \n

    The connection type for BranchProtectionRule.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([BranchProtectionRuleEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([BranchProtectionRule])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n BranchProtectionRuleEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (BranchProtectionRule)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CVSS\n

    \n

    The Common Vulnerability Scoring System.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    score (Float!)

    The CVSS score associated with this advisory.

    \n\n\n\n\n\n\n\n\n\n\n\n

    vectorString (String)

    The CVSS vector string associated with this advisory.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CWE\n

    \n

    A common weakness enumeration.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cweId (String!)

    The id of the CWE.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String!)

    A detailed description of this CWE.

    \n\n\n\n\n\n\n\n\n\n\n\n

    id (ID!)

    ID of the object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The name of this CWE.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CWEConnection\n

    \n

    The connection type for CWE.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([CWEEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([CWE])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CWEEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (CWE)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CheckAnnotation\n

    \n

    A single check annotation.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    annotationLevel (CheckAnnotationLevel)

    The annotation's severity level.

    \n\n\n\n\n\n\n\n\n\n\n\n

    blobUrl (URI!)

    The path to the file that this annotation was made on.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    location (CheckAnnotationSpan!)

    The position of this annotation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    message (String!)

    The annotation's message.

    \n\n\n\n\n\n\n\n\n\n\n\n

    path (String!)

    The path that this annotation was made on.

    \n\n\n\n\n\n\n\n\n\n\n\n

    rawDetails (String)

    Additional information about the annotation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    title (String)

    The annotation's title.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CheckAnnotationConnection\n

    \n

    The connection type for CheckAnnotation.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([CheckAnnotationEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([CheckAnnotation])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CheckAnnotationEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (CheckAnnotation)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CheckAnnotationPosition\n

    \n

    A character position in a check annotation.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    column (Int)

    Column number (1 indexed).

    \n\n\n\n\n\n\n\n\n\n\n\n

    line (Int!)

    Line number (1 indexed).

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CheckAnnotationSpan\n

    \n

    An inclusive pair of positions for a check annotation.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    end (CheckAnnotationPosition!)

    End position (inclusive).

    \n\n\n\n\n\n\n\n\n\n\n\n

    start (CheckAnnotationPosition!)

    Start position (inclusive).

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CheckRun\n

    \n

    A check run.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    annotations (CheckAnnotationConnection)

    The check run's annotations.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    checkSuite (CheckSuite!)

    The check suite that this run is a part of.

    \n\n\n\n\n\n\n\n\n\n\n\n

    completedAt (DateTime)

    Identifies the date and time when the check run was completed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    conclusion (CheckConclusionState)

    The conclusion of the check run.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    detailsUrl (URI)

    The URL from which to find full details of the check run on the integrator's site.

    \n\n\n\n\n\n\n\n\n\n\n\n

    externalId (String)

    A reference for the check run on the integrator's system.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isRequired (Boolean!)

    Whether this check run is required to pass before merging.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    pullRequestId (ID!)

    \n

    The pull request this check is required for.

    \n\n
    \n\n
    \n\n\n

    name (String!)

    The name of the check for this check run.

    \n\n\n\n\n\n\n\n\n\n\n\n

    permalink (URI!)

    The permalink to the check run summary.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository!)

    The repository associated with this check run.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this check run.

    \n\n\n\n\n\n\n\n\n\n\n\n

    startedAt (DateTime)

    Identifies the date and time when the check run was started.

    \n\n\n\n\n\n\n\n\n\n\n\n

    status (CheckStatusState!)

    The current status of the check run.

    \n\n\n\n\n\n\n\n\n\n\n\n

    summary (String)

    A string representing the check run's summary.

    \n\n\n\n\n\n\n\n\n\n\n\n

    text (String)

    A string representing the check run's text.

    \n\n\n\n\n\n\n\n\n\n\n\n

    title (String)

    A string representing the check run.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this check run.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CheckRunConnection\n

    \n

    The connection type for CheckRun.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([CheckRunEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([CheckRun])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CheckRunEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (CheckRun)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CheckSuite\n

    \n

    A check suite.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    app (App)

    The GitHub App which created this check suite.

    \n\n\n\n\n\n\n\n\n\n\n\n

    branch (Ref)

    The name of the branch for this check suite.

    \n\n\n\n\n\n\n\n\n\n\n\n

    checkRuns (CheckRunConnection)

    The check runs associated with a check suite.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    filterBy (CheckRunFilter)

    \n

    Filters the check runs by this type.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    commit (Commit!)

    The commit for this check suite.

    \n\n\n\n\n\n\n\n\n\n\n\n

    conclusion (CheckConclusionState)

    The conclusion of this check suite.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    matchingPullRequests (PullRequestConnection)

    A list of open pull requests matching the check suite.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    baseRefName (String)

    \n

    The base ref name to filter the pull requests by.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    headRefName (String)

    \n

    The head ref name to filter the pull requests by.

    \n\n
    \n\n
    \n

    labels ([String!])

    \n

    A list of label names to filter the pull requests by.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (IssueOrder)

    \n

    Ordering options for pull requests returned from the connection.

    \n\n
    \n\n
    \n

    states ([PullRequestState!])

    \n

    A list of states to filter the pull requests by.

    \n\n
    \n\n
    \n\n\n

    push (Push)

    The push that triggered this check suite.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository!)

    The repository associated with this check suite.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this check suite.

    \n\n\n\n\n\n\n\n\n\n\n\n

    status (CheckStatusState!)

    The status of this check suite.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this check suite.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CheckSuiteConnection\n

    \n

    The connection type for CheckSuite.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([CheckSuiteEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([CheckSuite])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CheckSuiteEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (CheckSuite)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ClosedEvent\n

    \n

    Represents aclosedevent on any Closable.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    closable (Closable!)

    Object that was closed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    closer (Closer)

    Object which triggered the creation of this event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this closed event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this closed event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CodeOfConduct\n

    \n

    The Code of Conduct for a repository.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String)

    The body of the Code of Conduct.

    \n\n\n\n\n\n\n\n\n\n\n\n

    key (String!)

    The key for the Code of Conduct.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The formal name of the Code of Conduct.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI)

    The HTTP path for this Code of Conduct.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI)

    The HTTP URL for this Code of Conduct.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CommentDeletedEvent\n

    \n

    Represents acomment_deletedevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    deletedCommentAuthor (Actor)

    The user who authored the deleted comment.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Commit\n

    \n

    Represents a Git commit.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    abbreviatedOid (String!)

    An abbreviated version of the Git object ID.

    \n\n\n\n\n\n\n\n\n\n\n\n

    additions (Int!)

    The number of additions in this commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    associatedPullRequests (PullRequestConnection)

    The pull requests associated with a commit.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (PullRequestOrder)

    \n

    Ordering options for pull requests.

    \n\n
    \n\n
    \n\n\n

    author (GitActor)

    Authorship details of the commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    authoredByCommitter (Boolean!)

    Check if the committer and the author match.

    \n\n\n\n\n\n\n\n\n\n\n\n

    authoredDate (DateTime!)

    The datetime when this commit was authored.

    \n\n\n\n\n\n\n\n\n\n\n\n

    authors (GitActorConnection!)

    The list of authors for this commit based on the git author and the Co-authored-by\nmessage trailer. The git author will always be first.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    blame (Blame!)

    Fetches git blame information.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    path (String!)

    \n

    The file whose Git blame information you want.

    \n\n
    \n\n
    \n\n\n

    changedFiles (Int!)

    The number of changed files in this commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    checkSuites (CheckSuiteConnection)

    The check suites associated with a commit.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    filterBy (CheckSuiteFilter)

    \n

    Filters the check suites by this type.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    comments (CommitCommentConnection!)

    Comments made on the commit.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    commitResourcePath (URI!)

    The HTTP path for this Git object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commitUrl (URI!)

    The HTTP URL for this Git object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    committedDate (DateTime!)

    The datetime when this commit was committed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    committedViaWeb (Boolean!)

    Check if committed via GitHub web UI.

    \n\n\n\n\n\n\n\n\n\n\n\n

    committer (GitActor)

    Committer details of the commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    deletions (Int!)

    The number of deletions in this commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    deployments (DeploymentConnection)

    The deployments associated with a commit.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    environments ([String!])

    \n

    Environments to list deployments for.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (DeploymentOrder)

    \n

    Ordering options for deployments returned from the connection.

    \n\n
    \n\n
    \n\n\n

    file (TreeEntry)

    The tree entry representing the file located at the given path.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    path (String!)

    \n

    The path for the file.

    \n\n
    \n\n
    \n\n\n

    history (CommitHistoryConnection!)

    The linear commit history starting from (and including) this commit, in the same order as git log.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    author (CommitAuthor)

    \n

    If non-null, filters history to only show commits with matching authorship.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    path (String)

    \n

    If non-null, filters history to only show commits touching files under this path.

    \n\n
    \n\n
    \n

    since (GitTimestamp)

    \n

    Allows specifying a beginning time or date for fetching commits.

    \n\n
    \n\n
    \n

    until (GitTimestamp)

    \n

    Allows specifying an ending time or date for fetching commits.

    \n\n
    \n\n
    \n\n\n

    message (String!)

    The Git commit message.

    \n\n\n\n\n\n\n\n\n\n\n\n

    messageBody (String!)

    The Git commit message body.

    \n\n\n\n\n\n\n\n\n\n\n\n

    messageBodyHTML (HTML!)

    The commit message body rendered to HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    messageHeadline (String!)

    The Git commit message headline.

    \n\n\n\n\n\n\n\n\n\n\n\n

    messageHeadlineHTML (HTML!)

    The commit message headline rendered to HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    oid (GitObjectID!)

    The Git object ID.

    \n\n\n\n\n\n\n\n\n\n\n\n

    onBehalfOf (Organization)

    The organization this commit was made on behalf of.

    \n\n\n\n\n\n\n\n\n\n\n\n

    parents (CommitConnection!)

    The parents of a commit.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    pushedDate (DateTime)

    The datetime when this commit was pushed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository!)

    The Repository this commit belongs to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    signature (GitSignature)

    Commit signing information, if present.

    \n\n\n\n\n\n\n\n\n\n\n\n

    status (Status)

    Status information for this commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    statusCheckRollup (StatusCheckRollup)

    Check and Status rollup information for this commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    submodules (SubmoduleConnection!)

    Returns a list of all submodules in this repository as of this Commit parsed from the .gitmodules file.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    tarballUrl (URI!)

    Returns a URL to download a tarball archive for a repository.\nNote: For private repositories, these links are temporary and expire after five minutes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    tree (Tree!)

    Commit's root Tree.

    \n\n\n\n\n\n\n\n\n\n\n\n

    treeResourcePath (URI!)

    The HTTP path for the tree of this commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    treeUrl (URI!)

    The HTTP URL for the tree of this commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanSubscribe (Boolean!)

    Check if the viewer is able to change their subscription status for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerSubscription (SubscriptionState)

    Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

    \n\n\n\n\n\n\n\n\n\n\n\n

    zipballUrl (URI!)

    Returns a URL to download a zipball archive for a repository.\nNote: For private repositories, these links are temporary and expire after five minutes.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CommitComment\n

    \n

    Represents a comment on a given Commit.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    author (Actor)

    The actor who authored the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    authorAssociation (CommentAuthorAssociation!)

    Author's association with the subject of the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    body (String!)

    Identifies the comment body.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyHTML (HTML!)

    The body rendered to HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyText (String!)

    The body rendered to text.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commit (Commit)

    Identifies the commit associated with the comment, if the commit exists.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdViaEmail (Boolean!)

    Check if this comment was created via an email reply.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    editor (Actor)

    The actor who edited the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    includesCreatedEdit (Boolean!)

    Check if this comment was edited and includes an edit with the creation data.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isMinimized (Boolean!)

    Returns whether or not a comment has been minimized.

    \n\n\n\n\n\n\n\n\n\n\n\n

    lastEditedAt (DateTime)

    The moment the editor made the last edit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    minimizedReason (String)

    Returns why the comment was minimized.

    \n\n\n\n\n\n\n\n\n\n\n\n

    path (String)

    Identifies the file path associated with the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    position (Int)

    Identifies the line position associated with the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    publishedAt (DateTime)

    Identifies when the comment was published at.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reactionGroups ([ReactionGroup!])

    A list of reactions grouped by content left on the subject.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reactions (ReactionConnection!)

    A list of Reactions left on the Issue.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    content (ReactionContent)

    \n

    Allows filtering Reactions by emoji.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (ReactionOrder)

    \n

    Allows specifying the order in which reactions are returned.

    \n\n
    \n\n
    \n\n\n

    repository (Repository!)

    The repository associated with this node.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path permalink for this commit comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL permalink for this commit comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userContentEdits (UserContentEditConnection)

    A list of edits to this content.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    viewerCanDelete (Boolean!)

    Check if the current viewer can delete this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanMinimize (Boolean!)

    Check if the current viewer can minimize this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanReact (Boolean!)

    Can user react to this subject.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanUpdate (Boolean!)

    Check if the current viewer can update this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

    Reasons why the current viewer can not update this comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerDidAuthor (Boolean!)

    Did the viewer author this comment.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CommitCommentConnection\n

    \n

    The connection type for CommitComment.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([CommitCommentEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([CommitComment])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CommitCommentEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (CommitComment)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CommitCommentThread\n

    \n

    A thread of comments on a commit.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    comments (CommitCommentConnection!)

    The comments that exist in this thread.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    commit (Commit)

    The commit the comments were made on.

    \n\n\n\n\n\n\n\n\n\n\n\n

    path (String)

    The file the comments were made on.

    \n\n\n\n\n\n\n\n\n\n\n\n

    position (Int)

    The position in the diff for the commit that the comment was made on.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository!)

    The repository associated with this node.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CommitConnection\n

    \n

    The connection type for Commit.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([CommitEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Commit])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CommitContributionsByRepository\n

    \n

    This aggregates commits made by a user within one repository.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    contributions (CreatedCommitContributionConnection!)

    The commit contributions, each representing a day.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (CommitContributionOrder)

    \n

    Ordering options for commit contributions returned from the connection.

    \n\n
    \n\n
    \n\n\n

    repository (Repository!)

    The repository in which the commits were made.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for the user's commits to the repository in this time range.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for the user's commits to the repository in this time range.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CommitEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (Commit)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CommitHistoryConnection\n

    \n

    The connection type for Commit.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([CommitEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Commit])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ConnectedEvent\n

    \n

    Represents aconnectedevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isCrossRepository (Boolean!)

    Reference originated in a different repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    source (ReferencedSubject!)

    Issue or pull request that made the reference.

    \n\n\n\n\n\n\n\n\n\n\n\n

    subject (ReferencedSubject!)

    Issue or pull request which was connected.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ContentAttachment\n

    \n

    A content attachment.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String!)

    The body text of the content attachment. This parameter supports markdown.

    \n\n\n\n\n\n\n\n\n\n\n\n

    contentReference (ContentReference!)

    The content reference that the content attachment is attached to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int!)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    title (String!)

    The title of the content attachment.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ContentReference\n

    \n

    A content reference.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    databaseId (Int!)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reference (String!)

    The reference of the content reference.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ContributionCalendar\n

    \n

    A calendar of contributions made on GitHub by a user.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    colors ([String!]!)

    A list of hex color codes used in this calendar. The darker the color, the more contributions it represents.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isHalloween (Boolean!)

    Determine if the color set was chosen because it's currently Halloween.

    \n\n\n\n\n\n\n\n\n\n\n\n

    months ([ContributionCalendarMonth!]!)

    A list of the months of contributions in this calendar.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalContributions (Int!)

    The count of total contributions in the calendar.

    \n\n\n\n\n\n\n\n\n\n\n\n

    weeks ([ContributionCalendarWeek!]!)

    A list of the weeks of contributions in this calendar.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ContributionCalendarDay\n

    \n

    Represents a single day of contributions on GitHub by a user.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    color (String!)

    The hex color code that represents how many contributions were made on this day compared to others in the calendar.

    \n\n\n\n\n\n\n\n\n\n\n\n

    contributionCount (Int!)

    How many contributions were made by the user on this day.

    \n\n\n\n\n\n\n\n\n\n\n\n

    contributionLevel (ContributionLevel!)

    Indication of contributions, relative to other days. Can be used to indicate\nwhich color to represent this day on a calendar.

    \n\n\n\n\n\n\n\n\n\n\n\n

    date (Date!)

    The day this square represents.

    \n\n\n\n\n\n\n\n\n\n\n\n

    weekday (Int!)

    A number representing which day of the week this square represents, e.g., 1 is Monday.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ContributionCalendarMonth\n

    \n

    A month of contributions in a user's contribution graph.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    firstDay (Date!)

    The date of the first day of this month.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The name of the month.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalWeeks (Int!)

    How many weeks started in this month.

    \n\n\n\n\n\n\n\n\n\n\n\n

    year (Int!)

    The year the month occurred in.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ContributionCalendarWeek\n

    \n

    A week of contributions in a user's contribution graph.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    contributionDays ([ContributionCalendarDay!]!)

    The days of contributions in this week.

    \n\n\n\n\n\n\n\n\n\n\n\n

    firstDay (Date!)

    The date of the earliest square in this week.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ContributionsCollection\n

    \n

    A contributions collection aggregates contributions such as opened issues and commits created by a user.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    commitContributionsByRepository ([CommitContributionsByRepository!]!)

    Commit contributions made by the user, grouped by repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    maxRepositories (Int)

    \n

    How many repositories should be included.

    \n

    The default value is 25.

    \n
    \n\n
    \n\n\n

    contributionCalendar (ContributionCalendar!)

    A calendar of this user's contributions on GitHub.

    \n\n\n\n\n\n\n\n\n\n\n\n

    contributionYears ([Int!]!)

    The years the user has been making contributions with the most recent year first.

    \n\n\n\n\n\n\n\n\n\n\n\n

    doesEndInCurrentMonth (Boolean!)

    Determine if this collection's time span ends in the current month.

    \n\n\n\n\n\n\n\n\n\n\n\n

    earliestRestrictedContributionDate (Date)

    The date of the first restricted contribution the user made in this time\nperiod. Can only be non-null when the user has enabled private contribution counts.

    \n\n\n\n\n\n\n\n\n\n\n\n

    endedAt (DateTime!)

    The ending date and time of this collection.

    \n\n\n\n\n\n\n\n\n\n\n\n

    firstIssueContribution (CreatedIssueOrRestrictedContribution)

    The first issue the user opened on GitHub. This will be null if that issue was\nopened outside the collection's time range and ignoreTimeRange is false. If\nthe issue is not visible but the user has opted to show private contributions,\na RestrictedContribution will be returned.

    \n\n\n\n\n\n\n\n\n\n\n\n

    firstPullRequestContribution (CreatedPullRequestOrRestrictedContribution)

    The first pull request the user opened on GitHub. This will be null if that\npull request was opened outside the collection's time range and\nignoreTimeRange is not true. If the pull request is not visible but the user\nhas opted to show private contributions, a RestrictedContribution will be returned.

    \n\n\n\n\n\n\n\n\n\n\n\n

    firstRepositoryContribution (CreatedRepositoryOrRestrictedContribution)

    The first repository the user created on GitHub. This will be null if that\nfirst repository was created outside the collection's time range and\nignoreTimeRange is false. If the repository is not visible, then a\nRestrictedContribution is returned.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hasActivityInThePast (Boolean!)

    Does the user have any more activity in the timeline that occurred prior to the collection's time range?.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hasAnyContributions (Boolean!)

    Determine if there are any contributions in this collection.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hasAnyRestrictedContributions (Boolean!)

    Determine if the user made any contributions in this time frame whose details\nare not visible because they were made in a private repository. Can only be\ntrue if the user enabled private contribution counts.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isSingleDay (Boolean!)

    Whether or not the collector's time span is all within the same day.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issueContributions (CreatedIssueContributionConnection!)

    A list of issues the user opened.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    excludeFirst (Boolean)

    \n

    Should the user's first issue ever be excluded from the result.

    \n

    The default value is false.

    \n
    \n\n
    \n

    excludePopular (Boolean)

    \n

    Should the user's most commented issue be excluded from the result.

    \n

    The default value is false.

    \n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (ContributionOrder)

    \n

    Ordering options for contributions returned from the connection.

    \n\n
    \n\n
    \n\n\n

    issueContributionsByRepository ([IssueContributionsByRepository!]!)

    Issue contributions made by the user, grouped by repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    excludeFirst (Boolean)

    \n

    Should the user's first issue ever be excluded from the result.

    \n

    The default value is false.

    \n
    \n\n
    \n

    excludePopular (Boolean)

    \n

    Should the user's most commented issue be excluded from the result.

    \n

    The default value is false.

    \n
    \n\n
    \n

    maxRepositories (Int)

    \n

    How many repositories should be included.

    \n

    The default value is 25.

    \n
    \n\n
    \n\n\n

    joinedGitHubContribution (JoinedGitHubContribution)

    When the user signed up for GitHub. This will be null if that sign up date\nfalls outside the collection's time range and ignoreTimeRange is false.

    \n\n\n\n\n\n\n\n\n\n\n\n

    latestRestrictedContributionDate (Date)

    The date of the most recent restricted contribution the user made in this time\nperiod. Can only be non-null when the user has enabled private contribution counts.

    \n\n\n\n\n\n\n\n\n\n\n\n

    mostRecentCollectionWithActivity (ContributionsCollection)

    When this collection's time range does not include any activity from the user, use this\nto get a different collection from an earlier time range that does have activity.

    \n\n\n\n\n\n\n\n\n\n\n\n

    mostRecentCollectionWithoutActivity (ContributionsCollection)

    Returns a different contributions collection from an earlier time range than this one\nthat does not have any contributions.

    \n\n\n\n\n\n\n\n\n\n\n\n

    popularIssueContribution (CreatedIssueContribution)

    The issue the user opened on GitHub that received the most comments in the specified\ntime frame.

    \n\n\n\n\n\n\n\n\n\n\n\n

    popularPullRequestContribution (CreatedPullRequestContribution)

    The pull request the user opened on GitHub that received the most comments in the\nspecified time frame.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestContributions (CreatedPullRequestContributionConnection!)

    Pull request contributions made by the user.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    excludeFirst (Boolean)

    \n

    Should the user's first pull request ever be excluded from the result.

    \n

    The default value is false.

    \n
    \n\n
    \n

    excludePopular (Boolean)

    \n

    Should the user's most commented pull request be excluded from the result.

    \n

    The default value is false.

    \n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (ContributionOrder)

    \n

    Ordering options for contributions returned from the connection.

    \n\n
    \n\n
    \n\n\n

    pullRequestContributionsByRepository ([PullRequestContributionsByRepository!]!)

    Pull request contributions made by the user, grouped by repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    excludeFirst (Boolean)

    \n

    Should the user's first pull request ever be excluded from the result.

    \n

    The default value is false.

    \n
    \n\n
    \n

    excludePopular (Boolean)

    \n

    Should the user's most commented pull request be excluded from the result.

    \n

    The default value is false.

    \n
    \n\n
    \n

    maxRepositories (Int)

    \n

    How many repositories should be included.

    \n

    The default value is 25.

    \n
    \n\n
    \n\n\n

    pullRequestReviewContributions (CreatedPullRequestReviewContributionConnection!)

    Pull request review contributions made by the user.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (ContributionOrder)

    \n

    Ordering options for contributions returned from the connection.

    \n\n
    \n\n
    \n\n\n

    pullRequestReviewContributionsByRepository ([PullRequestReviewContributionsByRepository!]!)

    Pull request review contributions made by the user, grouped by repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    maxRepositories (Int)

    \n

    How many repositories should be included.

    \n

    The default value is 25.

    \n
    \n\n
    \n\n\n

    repositoryContributions (CreatedRepositoryContributionConnection!)

    A list of repositories owned by the user that the user created in this time range.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    excludeFirst (Boolean)

    \n

    Should the user's first repository ever be excluded from the result.

    \n

    The default value is false.

    \n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (ContributionOrder)

    \n

    Ordering options for contributions returned from the connection.

    \n\n
    \n\n
    \n\n\n

    restrictedContributionsCount (Int!)

    A count of contributions made by the user that the viewer cannot access. Only\nnon-zero when the user has chosen to share their private contribution counts.

    \n\n\n\n\n\n\n\n\n\n\n\n

    startedAt (DateTime!)

    The beginning date and time of this collection.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCommitContributions (Int!)

    How many commits were made by the user in this time span.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalIssueContributions (Int!)

    How many issues the user opened.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    excludeFirst (Boolean)

    \n

    Should the user's first issue ever be excluded from this count.

    \n

    The default value is false.

    \n
    \n\n
    \n

    excludePopular (Boolean)

    \n

    Should the user's most commented issue be excluded from this count.

    \n

    The default value is false.

    \n
    \n\n
    \n\n\n

    totalPullRequestContributions (Int!)

    How many pull requests the user opened.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    excludeFirst (Boolean)

    \n

    Should the user's first pull request ever be excluded from this count.

    \n

    The default value is false.

    \n
    \n\n
    \n

    excludePopular (Boolean)

    \n

    Should the user's most commented pull request be excluded from this count.

    \n

    The default value is false.

    \n
    \n\n
    \n\n\n

    totalPullRequestReviewContributions (Int!)

    How many pull request reviews the user left.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalRepositoriesWithContributedCommits (Int!)

    How many different repositories the user committed to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalRepositoriesWithContributedIssues (Int!)

    How many different repositories the user opened issues in.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    excludeFirst (Boolean)

    \n

    Should the user's first issue ever be excluded from this count.

    \n

    The default value is false.

    \n
    \n\n
    \n

    excludePopular (Boolean)

    \n

    Should the user's most commented issue be excluded from this count.

    \n

    The default value is false.

    \n
    \n\n
    \n\n\n

    totalRepositoriesWithContributedPullRequestReviews (Int!)

    How many different repositories the user left pull request reviews in.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalRepositoriesWithContributedPullRequests (Int!)

    How many different repositories the user opened pull requests in.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    excludeFirst (Boolean)

    \n

    Should the user's first pull request ever be excluded from this count.

    \n

    The default value is false.

    \n
    \n\n
    \n

    excludePopular (Boolean)

    \n

    Should the user's most commented pull request be excluded from this count.

    \n

    The default value is false.

    \n
    \n\n
    \n\n\n

    totalRepositoryContributions (Int!)

    How many repositories the user created.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    excludeFirst (Boolean)

    \n

    Should the user's first repository ever be excluded from this count.

    \n

    The default value is false.

    \n
    \n\n
    \n\n\n

    user (User!)

    The user who made the contributions in this collection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ConvertToDraftEvent\n

    \n

    Represents aconvert_to_draftevent on a given pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    PullRequest referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this convert to draft event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this convert to draft event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ConvertedNoteToIssueEvent\n

    \n

    Represents aconverted_note_to_issueevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    project (Project)

    Project referenced by event.

    \n\n\n\n\n
    \n

    Preview notice

    \n

    project is available under the Project event details preview. During the preview period, the API may change without notice.

    \n
    \n\n\n\n\n\n\n\n\n

    projectCard (ProjectCard)

    Project card referenced by this project event.

    \n\n\n\n\n
    \n

    Preview notice

    \n

    projectCard is available under the Project event details preview. During the preview period, the API may change without notice.

    \n
    \n\n\n\n\n\n\n\n\n

    projectColumnName (String!)

    Column name referenced by this project event.

    \n\n\n\n\n
    \n

    Preview notice

    \n

    projectColumnName is available under the Project event details preview. During the preview period, the API may change without notice.

    \n
    \n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CreatedCommitContribution\n

    \n

    Represents the contribution a user made by committing to a repository.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    commitCount (Int!)

    How many commits were made on this day to this repository by the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isRestricted (Boolean!)

    Whether this contribution is associated with a record you do not have access to. For\nexample, your own 'first issue' contribution may have been made on a repository you can no\nlonger access.

    \n\n\n\n\n\n\n\n\n\n\n\n

    occurredAt (DateTime!)

    When this contribution was made.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository!)

    The repository the user made a commit in.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User!)

    The user who made this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CreatedCommitContributionConnection\n

    \n

    The connection type for CreatedCommitContribution.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([CreatedCommitContributionEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([CreatedCommitContribution])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of commits across days and repositories in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CreatedCommitContributionEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (CreatedCommitContribution)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CreatedIssueContribution\n

    \n

    Represents the contribution a user made on GitHub by opening an issue.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    isRestricted (Boolean!)

    Whether this contribution is associated with a record you do not have access to. For\nexample, your own 'first issue' contribution may have been made on a repository you can no\nlonger access.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issue (Issue!)

    The issue that was opened.

    \n\n\n\n\n\n\n\n\n\n\n\n

    occurredAt (DateTime!)

    When this contribution was made.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User!)

    The user who made this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CreatedIssueContributionConnection\n

    \n

    The connection type for CreatedIssueContribution.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([CreatedIssueContributionEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([CreatedIssueContribution])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CreatedIssueContributionEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (CreatedIssueContribution)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CreatedPullRequestContribution\n

    \n

    Represents the contribution a user made on GitHub by opening a pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    isRestricted (Boolean!)

    Whether this contribution is associated with a record you do not have access to. For\nexample, your own 'first issue' contribution may have been made on a repository you can no\nlonger access.

    \n\n\n\n\n\n\n\n\n\n\n\n

    occurredAt (DateTime!)

    When this contribution was made.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    The pull request that was opened.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User!)

    The user who made this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CreatedPullRequestContributionConnection\n

    \n

    The connection type for CreatedPullRequestContribution.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([CreatedPullRequestContributionEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([CreatedPullRequestContribution])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CreatedPullRequestContributionEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (CreatedPullRequestContribution)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CreatedPullRequestReviewContribution\n

    \n

    Represents the contribution a user made by leaving a review on a pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    isRestricted (Boolean!)

    Whether this contribution is associated with a record you do not have access to. For\nexample, your own 'first issue' contribution may have been made on a repository you can no\nlonger access.

    \n\n\n\n\n\n\n\n\n\n\n\n

    occurredAt (DateTime!)

    When this contribution was made.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    The pull request the user reviewed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestReview (PullRequestReview!)

    The review the user left on the pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository!)

    The repository containing the pull request that the user reviewed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User!)

    The user who made this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CreatedPullRequestReviewContributionConnection\n

    \n

    The connection type for CreatedPullRequestReviewContribution.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([CreatedPullRequestReviewContributionEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([CreatedPullRequestReviewContribution])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CreatedPullRequestReviewContributionEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (CreatedPullRequestReviewContribution)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CreatedRepositoryContribution\n

    \n

    Represents the contribution a user made on GitHub by creating a repository.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    isRestricted (Boolean!)

    Whether this contribution is associated with a record you do not have access to. For\nexample, your own 'first issue' contribution may have been made on a repository you can no\nlonger access.

    \n\n\n\n\n\n\n\n\n\n\n\n

    occurredAt (DateTime!)

    When this contribution was made.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository!)

    The repository that was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User!)

    The user who made this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CreatedRepositoryContributionConnection\n

    \n

    The connection type for CreatedRepositoryContribution.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([CreatedRepositoryContributionEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([CreatedRepositoryContribution])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CreatedRepositoryContributionEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (CreatedRepositoryContribution)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CrossReferencedEvent\n

    \n

    Represents a mention made by one issue or pull request to another.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isCrossRepository (Boolean!)

    Reference originated in a different repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    referencedAt (DateTime!)

    Identifies when the reference was made.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    source (ReferencedSubject!)

    Issue or pull request that made the reference.

    \n\n\n\n\n\n\n\n\n\n\n\n

    target (ReferencedSubject!)

    Issue or pull request to which the reference was made.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    willCloseTarget (Boolean!)

    Checks if the target will be closed when the source is merged.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n DemilestonedEvent\n

    \n

    Represents ademilestonedevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    milestoneTitle (String!)

    Identifies the milestone title associated with thedemilestonedevent.

    \n\n\n\n\n\n\n\n\n\n\n\n

    subject (MilestoneItem!)

    Object referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n DependencyGraphDependency\n

    \n

    A dependency manifest entry.

    \n
    \n\n
    \n \n
    \n

    Preview notice

    \n

    DependencyGraphDependency is available under the Access to a repositories dependency graph preview. During the preview period, the API may change without notice.

    \n
    \n\n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    hasDependencies (Boolean!)

    Does the dependency itself have dependencies?.

    \n\n\n\n\n\n\n\n\n\n\n\n

    packageManager (String)

    The dependency package manager.

    \n\n\n\n\n\n\n\n\n\n\n\n

    packageName (String!)

    The required package name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository containing the package.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requirements (String!)

    The dependency version requirements.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n DependencyGraphDependencyConnection\n

    \n

    The connection type for DependencyGraphDependency.

    \n
    \n\n
    \n \n
    \n

    Preview notice

    \n

    DependencyGraphDependencyConnection is available under the Access to a repositories dependency graph preview. During the preview period, the API may change without notice.

    \n
    \n\n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([DependencyGraphDependencyEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([DependencyGraphDependency])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n DependencyGraphDependencyEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n
    \n

    Preview notice

    \n

    DependencyGraphDependencyEdge is available under the Access to a repositories dependency graph preview. During the preview period, the API may change without notice.

    \n
    \n\n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (DependencyGraphDependency)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n DependencyGraphManifest\n

    \n

    Dependency manifest for a repository.

    \n
    \n\n
    \n \n
    \n

    Preview notice

    \n

    DependencyGraphManifest is available under the Access to a repositories dependency graph preview. During the preview period, the API may change without notice.

    \n
    \n\n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    blobPath (String!)

    Path to view the manifest file blob.

    \n\n\n\n\n\n\n\n\n\n\n\n

    dependencies (DependencyGraphDependencyConnection)

    A list of manifest dependencies.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    dependenciesCount (Int)

    The number of dependencies listed in the manifest.

    \n\n\n\n\n\n\n\n\n\n\n\n

    exceedsMaxSize (Boolean!)

    Is the manifest too big to parse?.

    \n\n\n\n\n\n\n\n\n\n\n\n

    filename (String!)

    Fully qualified manifest filename.

    \n\n\n\n\n\n\n\n\n\n\n\n

    parseable (Boolean!)

    Were we able to parse the manifest?.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository!)

    The repository containing the manifest.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n DependencyGraphManifestConnection\n

    \n

    The connection type for DependencyGraphManifest.

    \n
    \n\n
    \n \n
    \n

    Preview notice

    \n

    DependencyGraphManifestConnection is available under the Access to a repositories dependency graph preview. During the preview period, the API may change without notice.

    \n
    \n\n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([DependencyGraphManifestEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([DependencyGraphManifest])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n DependencyGraphManifestEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n
    \n

    Preview notice

    \n

    DependencyGraphManifestEdge is available under the Access to a repositories dependency graph preview. During the preview period, the API may change without notice.

    \n
    \n\n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (DependencyGraphManifest)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n DeployKey\n

    \n

    A repository deploy key.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    key (String!)

    The deploy key.

    \n\n\n\n\n\n\n\n\n\n\n\n

    readOnly (Boolean!)

    Whether or not the deploy key is read only.

    \n\n\n\n\n\n\n\n\n\n\n\n

    title (String!)

    The deploy key title.

    \n\n\n\n\n\n\n\n\n\n\n\n

    verified (Boolean!)

    Whether or not the deploy key has been verified.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n DeployKeyConnection\n

    \n

    The connection type for DeployKey.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([DeployKeyEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([DeployKey])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n DeployKeyEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (DeployKey)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n DeployedEvent\n

    \n

    Represents adeployedevent on a given pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    deployment (Deployment!)

    The deployment associated with thedeployedevent.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    PullRequest referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ref (Ref)

    The ref associated with thedeployedevent.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Deployment\n

    \n

    Represents triggered deployment instance.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    commit (Commit)

    Identifies the commit sha of the deployment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commitOid (String!)

    Identifies the oid of the deployment commit, even if the commit has been deleted.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    creator (Actor!)

    Identifies the actor who triggered the deployment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String)

    The deployment description.

    \n\n\n\n\n\n\n\n\n\n\n\n

    environment (String)

    The latest environment to which this deployment was made.

    \n\n\n\n\n\n\n\n\n\n\n\n

    latestEnvironment (String)

    The latest environment to which this deployment was made.

    \n\n\n\n\n\n\n\n\n\n\n\n

    latestStatus (DeploymentStatus)

    The latest status of this deployment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    originalEnvironment (String)

    The original environment to which this deployment was made.

    \n\n\n\n\n\n\n\n\n\n\n\n

    payload (String)

    Extra information that a deployment system might need.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ref (Ref)

    Identifies the Ref of the deployment, if the deployment was created by ref.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository!)

    Identifies the repository associated with the deployment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    state (DeploymentState)

    The current state of the deployment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    statuses (DeploymentStatusConnection)

    A list of statuses associated with the deployment.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    task (String)

    The deployment task.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n DeploymentConnection\n

    \n

    The connection type for Deployment.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([DeploymentEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Deployment])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n DeploymentEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (Deployment)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n DeploymentEnvironmentChangedEvent\n

    \n

    Represents adeployment_environment_changedevent on a given pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    deploymentStatus (DeploymentStatus!)

    The deployment status that updated the deployment environment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    PullRequest referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n DeploymentStatus\n

    \n

    Describes the status of a given deployment attempt.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    creator (Actor!)

    Identifies the actor who triggered the deployment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    deployment (Deployment!)

    Identifies the deployment associated with status.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String)

    Identifies the description of the deployment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    environment (String)

    Identifies the environment of the deployment at the time of this deployment status.

    \n\n\n\n\n
    \n

    Preview notice

    \n

    environment is available under the Deployments preview. During the preview period, the API may change without notice.

    \n
    \n\n\n\n\n\n\n\n\n

    environmentUrl (URI)

    Identifies the environment URL of the deployment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    logUrl (URI)

    Identifies the log URL of the deployment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    state (DeploymentStatusState!)

    Identifies the current state of the deployment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n DeploymentStatusConnection\n

    \n

    The connection type for DeploymentStatus.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([DeploymentStatusEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([DeploymentStatus])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n DeploymentStatusEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (DeploymentStatus)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n DisconnectedEvent\n

    \n

    Represents adisconnectedevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isCrossRepository (Boolean!)

    Reference originated in a different repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    source (ReferencedSubject!)

    Issue or pull request from which the issue was disconnected.

    \n\n\n\n\n\n\n\n\n\n\n\n

    subject (ReferencedSubject!)

    Issue or pull request which was disconnected.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Enterprise\n

    \n

    An account to manage multiple organizations with consolidated policy and billing.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    avatarUrl (URI!)

    A URL pointing to the enterprise's public avatar.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    size (Int)

    \n

    The size of the resulting square image.

    \n\n
    \n\n
    \n\n\n

    billingInfo (EnterpriseBillingInfo)

    Enterprise billing information visible to enterprise billing managers.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String)

    The description of the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    descriptionHTML (HTML!)

    The description of the enterprise as HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    location (String)

    The location of the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    members (EnterpriseMemberConnection!)

    A list of users who are members of this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    deployment (EnterpriseUserDeployment)

    \n

    Only return members within the selected GitHub Enterprise deployment.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (EnterpriseMemberOrder)

    \n

    Ordering options for members returned from the connection.

    \n\n
    \n\n
    \n

    organizationLogins ([String!])

    \n

    Only return members within the organizations with these logins.

    \n\n
    \n\n
    \n

    query (String)

    \n

    The search string to look for.

    \n\n
    \n\n
    \n

    role (EnterpriseUserAccountMembershipRole)

    \n

    The role of the user in the enterprise organization or server.

    \n\n
    \n\n
    \n\n\n

    name (String!)

    The name of the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizations (OrganizationConnection!)

    A list of organizations that belong to this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (OrganizationOrder)

    \n

    Ordering options for organizations returned from the connection.

    \n\n
    \n\n
    \n

    query (String)

    \n

    The search string to look for.

    \n\n
    \n\n
    \n\n\n

    ownerInfo (EnterpriseOwnerInfo)

    Enterprise information only visible to enterprise owners.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    slug (String!)

    The URL-friendly identifier for the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userAccounts (EnterpriseUserAccountConnection!)

    A list of user accounts on this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    viewerIsAdmin (Boolean!)

    Is the current viewer an admin of this enterprise?.

    \n\n\n\n\n\n\n\n\n\n\n\n

    websiteUrl (URI)

    The URL of the enterprise website.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseAdministratorConnection\n

    \n

    The connection type for User.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([EnterpriseAdministratorEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([User])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseAdministratorEdge\n

    \n

    A User who is an administrator of an enterprise.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (User)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n

    role (EnterpriseAdministratorRole!)

    The role of the administrator.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseAdministratorInvitation\n

    \n

    An invitation for a user to become an owner or billing manager of an enterprise.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    email (String)

    The email of the person who was invited to the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterprise (Enterprise!)

    The enterprise the invitation is for.

    \n\n\n\n\n\n\n\n\n\n\n\n

    invitee (User)

    The user who was invited to the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    inviter (User)

    The user who created the invitation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    role (EnterpriseAdministratorRole!)

    The invitee's pending role in the enterprise (owner or billing_manager).

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseAdministratorInvitationConnection\n

    \n

    The connection type for EnterpriseAdministratorInvitation.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([EnterpriseAdministratorInvitationEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([EnterpriseAdministratorInvitation])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseAdministratorInvitationEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (EnterpriseAdministratorInvitation)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseBillingInfo\n

    \n

    Enterprise billing information visible to enterprise billing managers and owners.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    allLicensableUsersCount (Int!)

    The number of licenseable users/emails across the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    assetPacks (Int!)

    The number of data packs used by all organizations owned by the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    availableSeats (Int!)

    The number of available seats across all owned organizations based on the unique number of billable users.

    \n\n\n\n\n\n\n
    \n

    Deprecation notice

    \n

    availableSeats is deprecated.

    availableSeats will be replaced with totalAvailableLicenses to provide more clarity on the value being returned Use EnterpriseBillingInfo.totalAvailableLicenses instead. Removal on 2020-01-01 UTC.

    \n
    \n\n\n\n\n\n\n

    bandwidthQuota (Float!)

    The bandwidth quota in GB for all organizations owned by the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bandwidthUsage (Float!)

    The bandwidth usage in GB for all organizations owned by the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bandwidthUsagePercentage (Int!)

    The bandwidth usage as a percentage of the bandwidth quota.

    \n\n\n\n\n\n\n\n\n\n\n\n

    seats (Int!)

    The total seats across all organizations owned by the enterprise.

    \n\n\n\n\n\n\n
    \n

    Deprecation notice

    \n

    seats is deprecated.

    seats will be replaced with totalLicenses to provide more clarity on the value being returned Use EnterpriseBillingInfo.totalLicenses instead. Removal on 2020-01-01 UTC.

    \n
    \n\n\n\n\n\n\n

    storageQuota (Float!)

    The storage quota in GB for all organizations owned by the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    storageUsage (Float!)

    The storage usage in GB for all organizations owned by the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    storageUsagePercentage (Int!)

    The storage usage as a percentage of the storage quota.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalAvailableLicenses (Int!)

    The number of available licenses across all owned organizations based on the unique number of billable users.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalLicenses (Int!)

    The total number of licenses allocated.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseIdentityProvider\n

    \n

    An identity provider configured to provision identities for an enterprise.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    digestMethod (SamlDigestAlgorithm)

    The digest algorithm used to sign SAML requests for the identity provider.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterprise (Enterprise)

    The enterprise this identity provider belongs to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    externalIdentities (ExternalIdentityConnection!)

    ExternalIdentities provisioned by this identity provider.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    idpCertificate (X509Certificate)

    The x509 certificate used by the identity provider to sign assertions and responses.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issuer (String)

    The Issuer Entity ID for the SAML identity provider.

    \n\n\n\n\n\n\n\n\n\n\n\n

    recoveryCodes ([String!])

    Recovery codes that can be used by admins to access the enterprise if the identity provider is unavailable.

    \n\n\n\n\n\n\n\n\n\n\n\n

    signatureMethod (SamlSignatureAlgorithm)

    The signature algorithm used to sign SAML requests for the identity provider.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ssoUrl (URI)

    The URL endpoint for the identity provider's SAML SSO.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseMemberConnection\n

    \n

    The connection type for EnterpriseMember.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([EnterpriseMemberEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([EnterpriseMember])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseMemberEdge\n

    \n

    A User who is a member of an enterprise through one or more organizations.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isUnlicensed (Boolean!)

    Whether the user does not have a license for the enterprise.

    \n\n\n\n\n\n\n
    \n

    Deprecation notice

    \n

    isUnlicensed is deprecated.

    All members consume a license Removal on 2021-01-01 UTC.

    \n
    \n\n\n\n\n\n\n

    node (EnterpriseMember)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseOrganizationMembershipConnection\n

    \n

    The connection type for Organization.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([EnterpriseOrganizationMembershipEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Organization])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseOrganizationMembershipEdge\n

    \n

    An enterprise organization that a user is a member of.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (Organization)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n

    role (EnterpriseUserAccountMembershipRole!)

    The role of the user in the enterprise membership.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseOutsideCollaboratorConnection\n

    \n

    The connection type for User.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([EnterpriseOutsideCollaboratorEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([User])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseOutsideCollaboratorEdge\n

    \n

    A User who is an outside collaborator of an enterprise through one or more organizations.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isUnlicensed (Boolean!)

    Whether the outside collaborator does not have a license for the enterprise.

    \n\n\n\n\n\n\n
    \n

    Deprecation notice

    \n

    isUnlicensed is deprecated.

    All outside collaborators consume a license Removal on 2021-01-01 UTC.

    \n
    \n\n\n\n\n\n\n

    node (User)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositories (EnterpriseRepositoryInfoConnection!)

    The enterprise organization repositories this user is a member of.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (RepositoryOrder)

    \n

    Ordering options for repositories.

    \n\n
    \n\n
    \n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseOwnerInfo\n

    \n

    Enterprise information only visible to enterprise owners.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    admins (EnterpriseAdministratorConnection!)

    A list of all of the administrators for this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (EnterpriseMemberOrder)

    \n

    Ordering options for administrators returned from the connection.

    \n\n
    \n\n
    \n

    query (String)

    \n

    The search string to look for.

    \n\n
    \n\n
    \n

    role (EnterpriseAdministratorRole)

    \n

    The role to filter by.

    \n\n
    \n\n
    \n\n\n

    affiliatedUsersWithTwoFactorDisabled (UserConnection!)

    A list of users in the enterprise who currently have two-factor authentication disabled.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    affiliatedUsersWithTwoFactorDisabledExist (Boolean!)

    Whether or not affiliated users with two-factor authentication disabled exist in the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    allowPrivateRepositoryForkingSetting (EnterpriseEnabledDisabledSettingValue!)

    The setting value for whether private repository forking is enabled for repositories in organizations in this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    allowPrivateRepositoryForkingSettingOrganizations (OrganizationConnection!)

    A list of enterprise organizations configured with the provided private repository forking setting value.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (OrganizationOrder)

    \n

    Ordering options for organizations with this setting.

    \n\n
    \n\n
    \n

    value (Boolean!)

    \n

    The setting value to find organizations for.

    \n\n
    \n\n
    \n\n\n

    defaultRepositoryPermissionSetting (EnterpriseDefaultRepositoryPermissionSettingValue!)

    The setting value for base repository permissions for organizations in this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    defaultRepositoryPermissionSettingOrganizations (OrganizationConnection!)

    A list of enterprise organizations configured with the provided default repository permission.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (OrganizationOrder)

    \n

    Ordering options for organizations with this setting.

    \n\n
    \n\n
    \n

    value (DefaultRepositoryPermissionField!)

    \n

    The permission to find organizations for.

    \n\n
    \n\n
    \n\n\n

    domains (VerifiableDomainConnection!)

    A list of domains owned by the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    isVerified (Boolean)

    \n

    Filter whether or not the domain is verified.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (VerifiableDomainOrder)

    \n

    Ordering options for verifiable domains returned.

    \n\n
    \n\n
    \n\n\n

    enterpriseServerInstallations (EnterpriseServerInstallationConnection!)

    Enterprise Server installations owned by the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    connectedOnly (Boolean)

    \n

    Whether or not to only return installations discovered via GitHub Connect.

    \n

    The default value is false.

    \n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (EnterpriseServerInstallationOrder)

    \n

    Ordering options for Enterprise Server installations returned.

    \n\n
    \n\n
    \n\n\n

    ipAllowListEnabledSetting (IpAllowListEnabledSettingValue!)

    The setting value for whether the enterprise has an IP allow list enabled.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ipAllowListEntries (IpAllowListEntryConnection!)

    The IP addresses that are allowed to access resources owned by the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (IpAllowListEntryOrder)

    \n

    Ordering options for IP allow list entries returned.

    \n\n
    \n\n
    \n\n\n

    isUpdatingDefaultRepositoryPermission (Boolean!)

    Whether or not the default repository permission is currently being updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isUpdatingTwoFactorRequirement (Boolean!)

    Whether the two-factor authentication requirement is currently being enforced.

    \n\n\n\n\n\n\n\n\n\n\n\n

    membersCanChangeRepositoryVisibilitySetting (EnterpriseEnabledDisabledSettingValue!)

    The setting value for whether organization members with admin permissions on a\nrepository can change repository visibility.

    \n\n\n\n\n\n\n\n\n\n\n\n

    membersCanChangeRepositoryVisibilitySettingOrganizations (OrganizationConnection!)

    A list of enterprise organizations configured with the provided can change repository visibility setting value.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (OrganizationOrder)

    \n

    Ordering options for organizations with this setting.

    \n\n
    \n\n
    \n

    value (Boolean!)

    \n

    The setting value to find organizations for.

    \n\n
    \n\n
    \n\n\n

    membersCanCreateInternalRepositoriesSetting (Boolean)

    The setting value for whether members of organizations in the enterprise can create internal repositories.

    \n\n\n\n\n\n\n\n\n\n\n\n

    membersCanCreatePrivateRepositoriesSetting (Boolean)

    The setting value for whether members of organizations in the enterprise can create private repositories.

    \n\n\n\n\n\n\n\n\n\n\n\n

    membersCanCreatePublicRepositoriesSetting (Boolean)

    The setting value for whether members of organizations in the enterprise can create public repositories.

    \n\n\n\n\n\n\n\n\n\n\n\n

    membersCanCreateRepositoriesSetting (EnterpriseMembersCanCreateRepositoriesSettingValue)

    The setting value for whether members of organizations in the enterprise can create repositories.

    \n\n\n\n\n\n\n\n\n\n\n\n

    membersCanCreateRepositoriesSettingOrganizations (OrganizationConnection!)

    A list of enterprise organizations configured with the provided repository creation setting value.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (OrganizationOrder)

    \n

    Ordering options for organizations with this setting.

    \n\n
    \n\n
    \n

    value (OrganizationMembersCanCreateRepositoriesSettingValue!)

    \n

    The setting to find organizations for.

    \n\n
    \n\n
    \n\n\n

    membersCanDeleteIssuesSetting (EnterpriseEnabledDisabledSettingValue!)

    The setting value for whether members with admin permissions for repositories can delete issues.

    \n\n\n\n\n\n\n\n\n\n\n\n

    membersCanDeleteIssuesSettingOrganizations (OrganizationConnection!)

    A list of enterprise organizations configured with the provided members can delete issues setting value.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (OrganizationOrder)

    \n

    Ordering options for organizations with this setting.

    \n\n
    \n\n
    \n

    value (Boolean!)

    \n

    The setting value to find organizations for.

    \n\n
    \n\n
    \n\n\n

    membersCanDeleteRepositoriesSetting (EnterpriseEnabledDisabledSettingValue!)

    The setting value for whether members with admin permissions for repositories can delete or transfer repositories.

    \n\n\n\n\n\n\n\n\n\n\n\n

    membersCanDeleteRepositoriesSettingOrganizations (OrganizationConnection!)

    A list of enterprise organizations configured with the provided members can delete repositories setting value.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (OrganizationOrder)

    \n

    Ordering options for organizations with this setting.

    \n\n
    \n\n
    \n

    value (Boolean!)

    \n

    The setting value to find organizations for.

    \n\n
    \n\n
    \n\n\n

    membersCanInviteCollaboratorsSetting (EnterpriseEnabledDisabledSettingValue!)

    The setting value for whether members of organizations in the enterprise can invite outside collaborators.

    \n\n\n\n\n\n\n\n\n\n\n\n

    membersCanInviteCollaboratorsSettingOrganizations (OrganizationConnection!)

    A list of enterprise organizations configured with the provided members can invite collaborators setting value.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (OrganizationOrder)

    \n

    Ordering options for organizations with this setting.

    \n\n
    \n\n
    \n

    value (Boolean!)

    \n

    The setting value to find organizations for.

    \n\n
    \n\n
    \n\n\n

    membersCanMakePurchasesSetting (EnterpriseMembersCanMakePurchasesSettingValue!)

    Indicates whether members of this enterprise's organizations can purchase additional services for those organizations.

    \n\n\n\n\n\n\n\n\n\n\n\n

    membersCanUpdateProtectedBranchesSetting (EnterpriseEnabledDisabledSettingValue!)

    The setting value for whether members with admin permissions for repositories can update protected branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    membersCanUpdateProtectedBranchesSettingOrganizations (OrganizationConnection!)

    A list of enterprise organizations configured with the provided members can update protected branches setting value.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (OrganizationOrder)

    \n

    Ordering options for organizations with this setting.

    \n\n
    \n\n
    \n

    value (Boolean!)

    \n

    The setting value to find organizations for.

    \n\n
    \n\n
    \n\n\n

    membersCanViewDependencyInsightsSetting (EnterpriseEnabledDisabledSettingValue!)

    The setting value for whether members can view dependency insights.

    \n\n\n\n\n\n\n\n\n\n\n\n

    membersCanViewDependencyInsightsSettingOrganizations (OrganizationConnection!)

    A list of enterprise organizations configured with the provided members can view dependency insights setting value.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (OrganizationOrder)

    \n

    Ordering options for organizations with this setting.

    \n\n
    \n\n
    \n

    value (Boolean!)

    \n

    The setting value to find organizations for.

    \n\n
    \n\n
    \n\n\n

    notificationDeliveryRestrictionEnabledSetting (NotificationRestrictionSettingValue!)

    Indicates if email notification delivery for this enterprise is restricted to verified domains.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationProjectsSetting (EnterpriseEnabledDisabledSettingValue!)

    The setting value for whether organization projects are enabled for organizations in this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationProjectsSettingOrganizations (OrganizationConnection!)

    A list of enterprise organizations configured with the provided organization projects setting value.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (OrganizationOrder)

    \n

    Ordering options for organizations with this setting.

    \n\n
    \n\n
    \n

    value (Boolean!)

    \n

    The setting value to find organizations for.

    \n\n
    \n\n
    \n\n\n

    outsideCollaborators (EnterpriseOutsideCollaboratorConnection!)

    A list of outside collaborators across the repositories in the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    login (String)

    \n

    The login of one specific outside collaborator.

    \n\n
    \n\n
    \n

    orderBy (EnterpriseMemberOrder)

    \n

    Ordering options for outside collaborators returned from the connection.

    \n\n
    \n\n
    \n

    query (String)

    \n

    The search string to look for.

    \n\n
    \n\n
    \n

    visibility (RepositoryVisibility)

    \n

    Only return outside collaborators on repositories with this visibility.

    \n\n
    \n\n
    \n\n\n

    pendingAdminInvitations (EnterpriseAdministratorInvitationConnection!)

    A list of pending administrator invitations for the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (EnterpriseAdministratorInvitationOrder)

    \n

    Ordering options for pending enterprise administrator invitations returned from the connection.

    \n\n
    \n\n
    \n

    query (String)

    \n

    The search string to look for.

    \n\n
    \n\n
    \n

    role (EnterpriseAdministratorRole)

    \n

    The role to filter by.

    \n\n
    \n\n
    \n\n\n

    pendingCollaboratorInvitations (RepositoryInvitationConnection!)

    A list of pending collaborator invitations across the repositories in the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (RepositoryInvitationOrder)

    \n

    Ordering options for pending repository collaborator invitations returned from the connection.

    \n\n
    \n\n
    \n

    query (String)

    \n

    The search string to look for.

    \n\n
    \n\n
    \n\n\n

    pendingCollaborators (EnterprisePendingCollaboratorConnection!)

    A list of pending collaborators across the repositories in the enterprise.

    \n\n\n\n\n\n\n
    \n

    Deprecation notice

    \n

    pendingCollaborators is deprecated.

    Repository invitations can now be associated with an email, not only an invitee. Use the pendingCollaboratorInvitations field instead. Removal on 2020-10-01 UTC.

    \n
    \n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (RepositoryInvitationOrder)

    \n

    Ordering options for pending repository collaborator invitations returned from the connection.

    \n\n
    \n\n
    \n

    query (String)

    \n

    The search string to look for.

    \n\n
    \n\n
    \n\n\n

    pendingMemberInvitations (EnterprisePendingMemberInvitationConnection!)

    A list of pending member invitations for organizations in the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    query (String)

    \n

    The search string to look for.

    \n\n
    \n\n
    \n\n\n

    repositoryProjectsSetting (EnterpriseEnabledDisabledSettingValue!)

    The setting value for whether repository projects are enabled in this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryProjectsSettingOrganizations (OrganizationConnection!)

    A list of enterprise organizations configured with the provided repository projects setting value.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (OrganizationOrder)

    \n

    Ordering options for organizations with this setting.

    \n\n
    \n\n
    \n

    value (Boolean!)

    \n

    The setting value to find organizations for.

    \n\n
    \n\n
    \n\n\n

    samlIdentityProvider (EnterpriseIdentityProvider)

    The SAML Identity Provider for the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    samlIdentityProviderSettingOrganizations (OrganizationConnection!)

    A list of enterprise organizations configured with the SAML single sign-on setting value.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (OrganizationOrder)

    \n

    Ordering options for organizations with this setting.

    \n\n
    \n\n
    \n

    value (IdentityProviderConfigurationState!)

    \n

    The setting value to find organizations for.

    \n\n
    \n\n
    \n\n\n

    supportEntitlements (EnterpriseMemberConnection!)

    A list of members with a support entitlement.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (EnterpriseMemberOrder)

    \n

    Ordering options for support entitlement users returned from the connection.

    \n\n
    \n\n
    \n\n\n

    teamDiscussionsSetting (EnterpriseEnabledDisabledSettingValue!)

    The setting value for whether team discussions are enabled for organizations in this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamDiscussionsSettingOrganizations (OrganizationConnection!)

    A list of enterprise organizations configured with the provided team discussions setting value.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (OrganizationOrder)

    \n

    Ordering options for organizations with this setting.

    \n\n
    \n\n
    \n

    value (Boolean!)

    \n

    The setting value to find organizations for.

    \n\n
    \n\n
    \n\n\n

    twoFactorRequiredSetting (EnterpriseEnabledSettingValue!)

    The setting value for whether the enterprise requires two-factor authentication for its organizations and users.

    \n\n\n\n\n\n\n\n\n\n\n\n

    twoFactorRequiredSettingOrganizations (OrganizationConnection!)

    A list of enterprise organizations configured with the two-factor authentication setting value.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (OrganizationOrder)

    \n

    Ordering options for organizations with this setting.

    \n\n
    \n\n
    \n

    value (Boolean!)

    \n

    The setting value to find organizations for.

    \n\n
    \n\n
    \n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterprisePendingCollaboratorConnection\n

    \n

    The connection type for User.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([EnterprisePendingCollaboratorEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([User])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterprisePendingCollaboratorEdge\n

    \n

    A user with an invitation to be a collaborator on a repository owned by an organization in an enterprise.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isUnlicensed (Boolean!)

    Whether the invited collaborator does not have a license for the enterprise.

    \n\n\n\n\n\n\n
    \n

    Deprecation notice

    \n

    isUnlicensed is deprecated.

    All pending collaborators consume a license Removal on 2021-01-01 UTC.

    \n
    \n\n\n\n\n\n\n

    node (User)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositories (EnterpriseRepositoryInfoConnection!)

    The enterprise organization repositories this user is a member of.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (RepositoryOrder)

    \n

    Ordering options for repositories.

    \n\n
    \n\n
    \n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterprisePendingMemberInvitationConnection\n

    \n

    The connection type for OrganizationInvitation.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([EnterprisePendingMemberInvitationEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([OrganizationInvitation])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalUniqueUserCount (Int!)

    Identifies the total count of unique users in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterprisePendingMemberInvitationEdge\n

    \n

    An invitation to be a member in an enterprise organization.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isUnlicensed (Boolean!)

    Whether the invitation has a license for the enterprise.

    \n\n\n\n\n\n\n
    \n

    Deprecation notice

    \n

    isUnlicensed is deprecated.

    All pending members consume a license Removal on 2020-07-01 UTC.

    \n
    \n\n\n\n\n\n\n

    node (OrganizationInvitation)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseRepositoryInfo\n

    \n

    A subset of repository information queryable from an enterprise.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    isPrivate (Boolean!)

    Identifies if the repository is private.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The repository's name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nameWithOwner (String!)

    The repository's name with owner.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseRepositoryInfoConnection\n

    \n

    The connection type for EnterpriseRepositoryInfo.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([EnterpriseRepositoryInfoEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([EnterpriseRepositoryInfo])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseRepositoryInfoEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (EnterpriseRepositoryInfo)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseServerInstallation\n

    \n

    An Enterprise Server installation.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    customerName (String!)

    The customer name to which the Enterprise Server installation belongs.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hostName (String!)

    The host name of the Enterprise Server installation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isConnected (Boolean!)

    Whether or not the installation is connected to an Enterprise Server installation via GitHub Connect.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userAccounts (EnterpriseServerUserAccountConnection!)

    User accounts on this Enterprise Server installation.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (EnterpriseServerUserAccountOrder)

    \n

    Ordering options for Enterprise Server user accounts returned from the connection.

    \n\n
    \n\n
    \n\n\n

    userAccountsUploads (EnterpriseServerUserAccountsUploadConnection!)

    User accounts uploads for the Enterprise Server installation.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (EnterpriseServerUserAccountsUploadOrder)

    \n

    Ordering options for Enterprise Server user accounts uploads returned from the connection.

    \n\n
    \n\n
    \n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseServerInstallationConnection\n

    \n

    The connection type for EnterpriseServerInstallation.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([EnterpriseServerInstallationEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([EnterpriseServerInstallation])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseServerInstallationEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (EnterpriseServerInstallation)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseServerUserAccount\n

    \n

    A user account on an Enterprise Server installation.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    emails (EnterpriseServerUserAccountEmailConnection!)

    User emails belonging to this user account.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (EnterpriseServerUserAccountEmailOrder)

    \n

    Ordering options for Enterprise Server user account emails returned from the connection.

    \n\n
    \n\n
    \n\n\n

    enterpriseServerInstallation (EnterpriseServerInstallation!)

    The Enterprise Server installation on which this user account exists.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isSiteAdmin (Boolean!)

    Whether the user account is a site administrator on the Enterprise Server installation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    login (String!)

    The login of the user account on the Enterprise Server installation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    profileName (String)

    The profile name of the user account on the Enterprise Server installation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    remoteCreatedAt (DateTime!)

    The date and time when the user account was created on the Enterprise Server installation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    remoteUserId (Int!)

    The ID of the user account on the Enterprise Server installation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseServerUserAccountConnection\n

    \n

    The connection type for EnterpriseServerUserAccount.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([EnterpriseServerUserAccountEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([EnterpriseServerUserAccount])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseServerUserAccountEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (EnterpriseServerUserAccount)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseServerUserAccountEmail\n

    \n

    An email belonging to a user account on an Enterprise Server installation.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    email (String!)

    The email address.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isPrimary (Boolean!)

    Indicates whether this is the primary email of the associated user account.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userAccount (EnterpriseServerUserAccount!)

    The user account to which the email belongs.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseServerUserAccountEmailConnection\n

    \n

    The connection type for EnterpriseServerUserAccountEmail.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([EnterpriseServerUserAccountEmailEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([EnterpriseServerUserAccountEmail])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseServerUserAccountEmailEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (EnterpriseServerUserAccountEmail)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseServerUserAccountsUpload\n

    \n

    A user accounts upload from an Enterprise Server installation.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterprise (Enterprise!)

    The enterprise to which this upload belongs.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseServerInstallation (EnterpriseServerInstallation!)

    The Enterprise Server installation for which this upload was generated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The name of the file uploaded.

    \n\n\n\n\n\n\n\n\n\n\n\n

    syncState (EnterpriseServerUserAccountsUploadSyncState!)

    The synchronization state of the upload.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseServerUserAccountsUploadConnection\n

    \n

    The connection type for EnterpriseServerUserAccountsUpload.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([EnterpriseServerUserAccountsUploadEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([EnterpriseServerUserAccountsUpload])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseServerUserAccountsUploadEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (EnterpriseServerUserAccountsUpload)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseUserAccount\n

    \n

    An account for a user who is an admin of an enterprise or a member of an enterprise through one or more organizations.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    avatarUrl (URI!)

    A URL pointing to the enterprise user account's public avatar.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    size (Int)

    \n

    The size of the resulting square image.

    \n\n
    \n\n
    \n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterprise (Enterprise!)

    The enterprise in which this user account exists.

    \n\n\n\n\n\n\n\n\n\n\n\n

    login (String!)

    An identifier for the enterprise user account, a login or email address.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String)

    The name of the enterprise user account.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizations (EnterpriseOrganizationMembershipConnection!)

    A list of enterprise organizations this user is a member of.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (OrganizationOrder)

    \n

    Ordering options for organizations returned from the connection.

    \n\n
    \n\n
    \n

    query (String)

    \n

    The search string to look for.

    \n\n
    \n\n
    \n

    role (EnterpriseUserAccountMembershipRole)

    \n

    The role of the user in the enterprise organization.

    \n\n
    \n\n
    \n\n\n

    resourcePath (URI!)

    The HTTP path for this user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user within the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseUserAccountConnection\n

    \n

    The connection type for EnterpriseUserAccount.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([EnterpriseUserAccountEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([EnterpriseUserAccount])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseUserAccountEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (EnterpriseUserAccount)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ExternalIdentity\n

    \n

    An external identity provisioned by SAML SSO or SCIM.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    guid (String!)

    The GUID for this identity.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationInvitation (OrganizationInvitation)

    Organization invitation for this SCIM-provisioned external identity.

    \n\n\n\n\n\n\n\n\n\n\n\n

    samlIdentity (ExternalIdentitySamlAttributes)

    SAML Identity attributes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    scimIdentity (ExternalIdentityScimAttributes)

    SCIM Identity attributes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    User linked to this external identity. Will be NULL if this identity has not been claimed by an organization member.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ExternalIdentityConnection\n

    \n

    The connection type for ExternalIdentity.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([ExternalIdentityEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([ExternalIdentity])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ExternalIdentityEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (ExternalIdentity)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ExternalIdentitySamlAttributes\n

    \n

    SAML attributes for the External Identity.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    emails ([UserEmailMetadata!])

    The emails associated with the SAML identity.

    \n\n\n\n\n\n\n\n\n\n\n\n

    familyName (String)

    Family name of the SAML identity.

    \n\n\n\n\n\n\n\n\n\n\n\n

    givenName (String)

    Given name of the SAML identity.

    \n\n\n\n\n\n\n\n\n\n\n\n

    groups ([String!])

    The groups linked to this identity in IDP.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nameId (String)

    The NameID of the SAML identity.

    \n\n\n\n\n\n\n\n\n\n\n\n

    username (String)

    The userName of the SAML identity.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ExternalIdentityScimAttributes\n

    \n

    SCIM attributes for the External Identity.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    emails ([UserEmailMetadata!])

    The emails associated with the SCIM identity.

    \n\n\n\n\n\n\n\n\n\n\n\n

    familyName (String)

    Family name of the SCIM identity.

    \n\n\n\n\n\n\n\n\n\n\n\n

    givenName (String)

    Given name of the SCIM identity.

    \n\n\n\n\n\n\n\n\n\n\n\n

    groups ([String!])

    The groups linked to this identity in IDP.

    \n\n\n\n\n\n\n\n\n\n\n\n

    username (String)

    The userName of the SCIM identity.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n FollowerConnection\n

    \n

    The connection type for User.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([UserEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([User])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n FollowingConnection\n

    \n

    The connection type for User.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([UserEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([User])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n FundingLink\n

    \n

    A funding platform link for a repository.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    platform (FundingPlatform!)

    The funding platform this link is for.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The configured URL for this funding link.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n GenericHovercardContext\n

    \n

    A generic hovercard context with a message and icon.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    message (String!)

    A string describing this context.

    \n\n\n\n\n\n\n\n\n\n\n\n

    octicon (String!)

    An octicon to accompany this context.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Gist\n

    \n

    A Gist.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    comments (GistCommentConnection!)

    A list of comments associated with the gist.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String)

    The gist description.

    \n\n\n\n\n\n\n\n\n\n\n\n

    files ([GistFile])

    The files in this gist.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    limit (Int)

    \n

    The maximum number of files to return.

    \n

    The default value is 10.

    \n
    \n\n
    \n

    oid (GitObjectID)

    \n

    The oid of the files to return.

    \n\n
    \n\n
    \n\n\n

    forks (GistConnection!)

    A list of forks associated with the gist.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (GistOrder)

    \n

    Ordering options for gists returned from the connection.

    \n\n
    \n\n
    \n\n\n

    isFork (Boolean!)

    Identifies if the gist is a fork.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isPublic (Boolean!)

    Whether the gist is public or not.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The gist name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    owner (RepositoryOwner)

    The gist owner.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pushedAt (DateTime)

    Identifies when the gist was last pushed to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTML path to this resource.

    \n\n\n\n\n\n\n\n\n\n\n\n

    stargazerCount (Int!)

    Returns a count of how many stargazers there are on this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    stargazers (StargazerConnection!)

    A list of users who have starred this starrable.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (StarOrder)

    \n

    Order for connection.

    \n\n
    \n\n
    \n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this Gist.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerHasStarred (Boolean!)

    Returns a boolean indicating whether the viewing user has starred this starrable.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n GistComment\n

    \n

    Represents a comment on an Gist.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    author (Actor)

    The actor who authored the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    authorAssociation (CommentAuthorAssociation!)

    Author's association with the gist.

    \n\n\n\n\n\n\n\n\n\n\n\n

    body (String!)

    Identifies the comment body.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyHTML (HTML!)

    The body rendered to HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyText (String!)

    The body rendered to text.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdViaEmail (Boolean!)

    Check if this comment was created via an email reply.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    editor (Actor)

    The actor who edited the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    gist (Gist!)

    The associated gist.

    \n\n\n\n\n\n\n\n\n\n\n\n

    includesCreatedEdit (Boolean!)

    Check if this comment was edited and includes an edit with the creation data.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isMinimized (Boolean!)

    Returns whether or not a comment has been minimized.

    \n\n\n\n\n\n\n\n\n\n\n\n

    lastEditedAt (DateTime)

    The moment the editor made the last edit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    minimizedReason (String)

    Returns why the comment was minimized.

    \n\n\n\n\n\n\n\n\n\n\n\n

    publishedAt (DateTime)

    Identifies when the comment was published at.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userContentEdits (UserContentEditConnection)

    A list of edits to this content.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    viewerCanDelete (Boolean!)

    Check if the current viewer can delete this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanMinimize (Boolean!)

    Check if the current viewer can minimize this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanUpdate (Boolean!)

    Check if the current viewer can update this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

    Reasons why the current viewer can not update this comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerDidAuthor (Boolean!)

    Did the viewer author this comment.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n GistCommentConnection\n

    \n

    The connection type for GistComment.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([GistCommentEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([GistComment])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n GistCommentEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (GistComment)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n GistConnection\n

    \n

    The connection type for Gist.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([GistEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Gist])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n GistEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (Gist)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n GistFile\n

    \n

    A file in a gist.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    encodedName (String)

    The file name encoded to remove characters that are invalid in URL paths.

    \n\n\n\n\n\n\n\n\n\n\n\n

    encoding (String)

    The gist file encoding.

    \n\n\n\n\n\n\n\n\n\n\n\n

    extension (String)

    The file extension from the file name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isImage (Boolean!)

    Indicates if this file is an image.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isTruncated (Boolean!)

    Whether the file's contents were truncated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    language (Language)

    The programming language this file is written in.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String)

    The gist file name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    size (Int)

    The gist file size in bytes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    text (String)

    UTF8 text data or null if the file is binary.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    truncate (Int)

    \n

    Optionally truncate the returned file to this length.

    \n\n
    \n\n
    \n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n GitActor\n

    \n

    Represents an actor in a Git commit (ie. an author or committer).

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    avatarUrl (URI!)

    A URL pointing to the author's public avatar.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    size (Int)

    \n

    The size of the resulting square image.

    \n\n
    \n\n
    \n\n\n

    date (GitTimestamp)

    The timestamp of the Git action (authoring or committing).

    \n\n\n\n\n\n\n\n\n\n\n\n

    email (String)

    The email in the Git commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String)

    The name in the Git commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The GitHub user corresponding to the email field. Null if no such user exists.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n GitActorConnection\n

    \n

    The connection type for GitActor.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([GitActorEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([GitActor])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n GitActorEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (GitActor)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n GitHubMetadata\n

    \n

    Represents information about the GitHub instance.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    gitHubServicesSha (GitObjectID!)

    Returns a String that's a SHA of github-services.

    \n\n\n\n\n\n\n\n\n\n\n\n

    gitIpAddresses ([String!])

    IP addresses that users connect to for git operations.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hookIpAddresses ([String!])

    IP addresses that service hooks are sent from.

    \n\n\n\n\n\n\n\n\n\n\n\n

    importerIpAddresses ([String!])

    IP addresses that the importer connects from.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isPasswordAuthenticationVerifiable (Boolean!)

    Whether or not users are verified.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pagesIpAddresses ([String!])

    IP addresses for GitHub Pages' A records.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n GpgSignature\n

    \n

    Represents a GPG signature on a Commit or Tag.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    email (String!)

    Email used to sign this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isValid (Boolean!)

    True if the signature is valid and verified by GitHub.

    \n\n\n\n\n\n\n\n\n\n\n\n

    keyId (String)

    Hex-encoded ID of the key that signed this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    payload (String!)

    Payload for GPG signing object. Raw ODB object without the signature header.

    \n\n\n\n\n\n\n\n\n\n\n\n

    signature (String!)

    ASCII-armored signature header from object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    signer (User)

    GitHub user corresponding to the email signing this commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    state (GitSignatureState!)

    The state of this signature. VALID if signature is valid and verified by\nGitHub, otherwise represents reason why signature is considered invalid.

    \n\n\n\n\n\n\n\n\n\n\n\n

    wasSignedByGitHub (Boolean!)

    True if the signature was made with GitHub's signing key.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n HeadRefDeletedEvent\n

    \n

    Represents ahead_ref_deletedevent on a given pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    headRef (Ref)

    Identifies the Ref associated with the head_ref_deleted event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    headRefName (String!)

    Identifies the name of the Ref associated with the head_ref_deleted event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    PullRequest referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n HeadRefForcePushedEvent\n

    \n

    Represents ahead_ref_force_pushedevent on a given pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    afterCommit (Commit)

    Identifies the after commit SHA for thehead_ref_force_pushedevent.

    \n\n\n\n\n\n\n\n\n\n\n\n

    beforeCommit (Commit)

    Identifies the before commit SHA for thehead_ref_force_pushedevent.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    PullRequest referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ref (Ref)

    Identifies the fully qualified ref name for thehead_ref_force_pushedevent.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n HeadRefRestoredEvent\n

    \n

    Represents ahead_ref_restoredevent on a given pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    PullRequest referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Hovercard\n

    \n

    Detail needed to display a hovercard for a user.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    contexts ([HovercardContext!]!)

    Each of the contexts for this hovercard.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n IpAllowListEntry\n

    \n

    An IP address or range of addresses that is allowed to access an owner's resources.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    allowListValue (String!)

    A single IP address or range of IP addresses in CIDR notation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isActive (Boolean!)

    Whether the entry is currently active.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String)

    The name of the IP allow list entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    owner (IpAllowListOwner!)

    The owner of the IP allow list entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n IpAllowListEntryConnection\n

    \n

    The connection type for IpAllowListEntry.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([IpAllowListEntryEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([IpAllowListEntry])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n IpAllowListEntryEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (IpAllowListEntry)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Issue\n

    \n

    An Issue is a place to discuss ideas, enhancements, tasks, and bugs for a project.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    activeLockReason (LockReason)

    Reason that the conversation was locked.

    \n\n\n\n\n\n\n\n\n\n\n\n

    assignees (UserConnection!)

    A list of Users assigned to this object.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    author (Actor)

    The actor who authored the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    authorAssociation (CommentAuthorAssociation!)

    Author's association with the subject of the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    body (String!)

    Identifies the body of the issue.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyHTML (HTML!)

    The body rendered to HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyResourcePath (URI!)

    The http path for this issue body.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyText (String!)

    Identifies the body of the issue rendered to text.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyUrl (URI!)

    The http URL for this issue body.

    \n\n\n\n\n\n\n\n\n\n\n\n

    closed (Boolean!)

    true if the object is closed (definition of closed may depend on type).

    \n\n\n\n\n\n\n\n\n\n\n\n

    closedAt (DateTime)

    Identifies the date and time when the object was closed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    comments (IssueCommentConnection!)

    A list of comments associated with the Issue.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (IssueCommentOrder)

    \n

    Ordering options for issue comments returned from the connection.

    \n\n
    \n\n
    \n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdViaEmail (Boolean!)

    Check if this comment was created via an email reply.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    editor (Actor)

    The actor who edited the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hovercard (Hovercard!)

    The hovercard information for this issue.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    includeNotificationContexts (Boolean)

    \n

    Whether or not to include notification contexts.

    \n

    The default value is true.

    \n
    \n\n
    \n\n\n

    includesCreatedEdit (Boolean!)

    Check if this comment was edited and includes an edit with the creation data.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isPinned (Boolean)

    Indicates whether or not this issue is currently pinned to the repository issues list.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isReadByViewer (Boolean)

    Is this issue read by the viewer.

    \n\n\n\n\n\n\n\n\n\n\n\n

    labels (LabelConnection)

    A list of labels associated with the object.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (LabelOrder)

    \n

    Ordering options for labels returned from the connection.

    \n\n
    \n\n
    \n\n\n

    lastEditedAt (DateTime)

    The moment the editor made the last edit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    locked (Boolean!)

    true if the object is locked.

    \n\n\n\n\n\n\n\n\n\n\n\n

    milestone (Milestone)

    Identifies the milestone associated with the issue.

    \n\n\n\n\n\n\n\n\n\n\n\n

    number (Int!)

    Identifies the issue number.

    \n\n\n\n\n\n\n\n\n\n\n\n

    participants (UserConnection!)

    A list of Users that are participating in the Issue conversation.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    projectCards (ProjectCardConnection!)

    List of project cards associated with this issue.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    archivedStates ([ProjectCardArchivedState])

    \n

    A list of archived states to filter the cards by.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    publishedAt (DateTime)

    Identifies when the comment was published at.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reactionGroups ([ReactionGroup!])

    A list of reactions grouped by content left on the subject.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reactions (ReactionConnection!)

    A list of Reactions left on the Issue.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    content (ReactionContent)

    \n

    Allows filtering Reactions by emoji.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (ReactionOrder)

    \n

    Allows specifying the order in which reactions are returned.

    \n\n
    \n\n
    \n\n\n

    repository (Repository!)

    The repository associated with this node.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this issue.

    \n\n\n\n\n\n\n\n\n\n\n\n

    state (IssueState!)

    Identifies the state of the issue.

    \n\n\n\n\n\n\n\n\n\n\n\n

    timeline (IssueTimelineConnection!)

    A list of events, comments, commits, etc. associated with the issue.

    \n\n\n\n\n\n\n
    \n

    Deprecation notice

    \n

    timeline is deprecated.

    timeline will be removed Use Issue.timelineItems instead. Removal on 2020-10-01 UTC.

    \n
    \n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    since (DateTime)

    \n

    Allows filtering timeline events by a since timestamp.

    \n\n
    \n\n
    \n\n\n

    timelineItems (IssueTimelineItemsConnection!)

    A list of events, comments, commits, etc. associated with the issue.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    itemTypes ([IssueTimelineItemsItemType!])

    \n

    Filter timeline items by type.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    since (DateTime)

    \n

    Filter timeline items by a since timestamp.

    \n\n
    \n\n
    \n

    skip (Int)

    \n

    Skips the first n elements in the list.

    \n\n
    \n\n
    \n\n\n

    title (String!)

    Identifies the issue title.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this issue.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userContentEdits (UserContentEditConnection)

    A list of edits to this content.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    viewerCanReact (Boolean!)

    Can user react to this subject.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanSubscribe (Boolean!)

    Check if the viewer is able to change their subscription status for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanUpdate (Boolean!)

    Check if the current viewer can update this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

    Reasons why the current viewer can not update this comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerDidAuthor (Boolean!)

    Did the viewer author this comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerSubscription (SubscriptionState)

    Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n IssueComment\n

    \n

    Represents a comment on an Issue.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    author (Actor)

    The actor who authored the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    authorAssociation (CommentAuthorAssociation!)

    Author's association with the subject of the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    body (String!)

    The body as Markdown.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyHTML (HTML!)

    The body rendered to HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyText (String!)

    The body rendered to text.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdViaEmail (Boolean!)

    Check if this comment was created via an email reply.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    editor (Actor)

    The actor who edited the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    includesCreatedEdit (Boolean!)

    Check if this comment was edited and includes an edit with the creation data.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isMinimized (Boolean!)

    Returns whether or not a comment has been minimized.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issue (Issue!)

    Identifies the issue associated with the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    lastEditedAt (DateTime)

    The moment the editor made the last edit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    minimizedReason (String)

    Returns why the comment was minimized.

    \n\n\n\n\n\n\n\n\n\n\n\n

    publishedAt (DateTime)

    Identifies when the comment was published at.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest)

    Returns the pull request associated with the comment, if this comment was made on a\npull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reactionGroups ([ReactionGroup!])

    A list of reactions grouped by content left on the subject.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reactions (ReactionConnection!)

    A list of Reactions left on the Issue.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    content (ReactionContent)

    \n

    Allows filtering Reactions by emoji.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (ReactionOrder)

    \n

    Allows specifying the order in which reactions are returned.

    \n\n
    \n\n
    \n\n\n

    repository (Repository!)

    The repository associated with this node.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this issue comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this issue comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userContentEdits (UserContentEditConnection)

    A list of edits to this content.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    viewerCanDelete (Boolean!)

    Check if the current viewer can delete this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanMinimize (Boolean!)

    Check if the current viewer can minimize this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanReact (Boolean!)

    Can user react to this subject.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanUpdate (Boolean!)

    Check if the current viewer can update this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

    Reasons why the current viewer can not update this comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerDidAuthor (Boolean!)

    Did the viewer author this comment.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n IssueCommentConnection\n

    \n

    The connection type for IssueComment.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([IssueCommentEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([IssueComment])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n IssueCommentEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (IssueComment)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n IssueConnection\n

    \n

    The connection type for Issue.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([IssueEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Issue])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n IssueContributionsByRepository\n

    \n

    This aggregates issues opened by a user within one repository.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    contributions (CreatedIssueContributionConnection!)

    The issue contributions.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (ContributionOrder)

    \n

    Ordering options for contributions returned from the connection.

    \n\n
    \n\n
    \n\n\n

    repository (Repository!)

    The repository in which the issues were opened.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n IssueEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (Issue)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n IssueTemplate\n

    \n

    A repository issue template.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    about (String)

    The template purpose.

    \n\n\n\n\n\n\n\n\n\n\n\n

    body (String)

    The suggested issue body.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The template name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    title (String)

    The suggested issue title.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n IssueTimelineConnection\n

    \n

    The connection type for IssueTimelineItem.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([IssueTimelineItemEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([IssueTimelineItem])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n IssueTimelineItemEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (IssueTimelineItem)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n IssueTimelineItemsConnection\n

    \n

    The connection type for IssueTimelineItems.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([IssueTimelineItemsEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    filteredCount (Int!)

    Identifies the count of items after applying before and after filters.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([IssueTimelineItems])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageCount (Int!)

    Identifies the count of items after applying before/after filters and first/last/skip slicing.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the timeline was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n IssueTimelineItemsEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (IssueTimelineItems)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n JoinedGitHubContribution\n

    \n

    Represents a user signing up for a GitHub account.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    isRestricted (Boolean!)

    Whether this contribution is associated with a record you do not have access to. For\nexample, your own 'first issue' contribution may have been made on a repository you can no\nlonger access.

    \n\n\n\n\n\n\n\n\n\n\n\n

    occurredAt (DateTime!)

    When this contribution was made.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User!)

    The user who made this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Label\n

    \n

    A label for categorizing Issues or Milestones with a given Repository.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    color (String!)

    Identifies the label color.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime)

    Identifies the date and time when the label was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String)

    A brief description of this label.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isDefault (Boolean!)

    Indicates whether or not this is a default label.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issues (IssueConnection!)

    A list of issues associated with this label.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    filterBy (IssueFilters)

    \n

    Filtering options for issues returned from the connection.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    labels ([String!])

    \n

    A list of label names to filter the pull requests by.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (IssueOrder)

    \n

    Ordering options for issues returned from the connection.

    \n\n
    \n\n
    \n

    states ([IssueState!])

    \n

    A list of states to filter the issues by.

    \n\n
    \n\n
    \n\n\n

    name (String!)

    Identifies the label name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequests (PullRequestConnection!)

    A list of pull requests associated with this label.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    baseRefName (String)

    \n

    The base ref name to filter the pull requests by.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    headRefName (String)

    \n

    The head ref name to filter the pull requests by.

    \n\n
    \n\n
    \n

    labels ([String!])

    \n

    A list of label names to filter the pull requests by.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (IssueOrder)

    \n

    Ordering options for pull requests returned from the connection.

    \n\n
    \n\n
    \n

    states ([PullRequestState!])

    \n

    A list of states to filter the pull requests by.

    \n\n
    \n\n
    \n\n\n

    repository (Repository!)

    The repository associated with this label.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this label.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime)

    Identifies the date and time when the label was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this label.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n LabelConnection\n

    \n

    The connection type for Label.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([LabelEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Label])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n LabelEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (Label)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n LabeledEvent\n

    \n

    Represents alabeledevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    label (Label!)

    Identifies the label associated with thelabeledevent.

    \n\n\n\n\n\n\n\n\n\n\n\n

    labelable (Labelable!)

    Identifies the Labelable associated with the event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Language\n

    \n

    Represents a given language found in repositories.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    color (String)

    The color defined for the current language.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The name of the current language.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n LanguageConnection\n

    \n

    A list of languages associated with the parent.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([LanguageEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Language])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalSize (Int!)

    The total size in bytes of files written in that language.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n LanguageEdge\n

    \n

    Represents the language of a repository.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    size (Int!)

    The number of bytes of code written in the language.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n License\n

    \n

    A repository's open source license.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String!)

    The full text of the license.

    \n\n\n\n\n\n\n\n\n\n\n\n

    conditions ([LicenseRule]!)

    The conditions set by the license.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String)

    A human-readable description of the license.

    \n\n\n\n\n\n\n\n\n\n\n\n

    featured (Boolean!)

    Whether the license should be featured.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hidden (Boolean!)

    Whether the license should be displayed in license pickers.

    \n\n\n\n\n\n\n\n\n\n\n\n

    implementation (String)

    Instructions on how to implement the license.

    \n\n\n\n\n\n\n\n\n\n\n\n

    key (String!)

    The lowercased SPDX ID of the license.

    \n\n\n\n\n\n\n\n\n\n\n\n

    limitations ([LicenseRule]!)

    The limitations set by the license.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The license full name specified by https://spdx.org/licenses.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nickname (String)

    Customary short name if applicable (e.g, GPLv3).

    \n\n\n\n\n\n\n\n\n\n\n\n

    permissions ([LicenseRule]!)

    The permissions set by the license.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pseudoLicense (Boolean!)

    Whether the license is a pseudo-license placeholder (e.g., other, no-license).

    \n\n\n\n\n\n\n\n\n\n\n\n

    spdxId (String)

    Short identifier specified by https://spdx.org/licenses.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI)

    URL to the license on https://choosealicense.com.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n LicenseRule\n

    \n

    Describes a License's conditions, permissions, and limitations.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    description (String!)

    A description of the rule.

    \n\n\n\n\n\n\n\n\n\n\n\n

    key (String!)

    The machine-readable rule key.

    \n\n\n\n\n\n\n\n\n\n\n\n

    label (String!)

    The human-readable rule label.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n LockedEvent\n

    \n

    Represents alockedevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    lockReason (LockReason)

    Reason that the conversation was locked (optional).

    \n\n\n\n\n\n\n\n\n\n\n\n

    lockable (Lockable!)

    Object that was locked.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Mannequin\n

    \n

    A placeholder user for attribution of imported data on GitHub.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    avatarUrl (URI!)

    A URL pointing to the GitHub App's public avatar.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    size (Int)

    \n

    The size of the resulting square image.

    \n\n
    \n\n
    \n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    email (String)

    The mannequin's email on the source instance.

    \n\n\n\n\n\n\n\n\n\n\n\n

    login (String!)

    The username of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTML path to this resource.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The URL to this resource.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n MarkedAsDuplicateEvent\n

    \n

    Represents amarked_as_duplicateevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    canonical (IssueOrPullRequest)

    The authoritative issue or pull request which has been duplicated by another.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    duplicate (IssueOrPullRequest)

    The issue or pull request which has been marked as a duplicate of another.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isCrossRepository (Boolean!)

    Canonical and duplicate belong to different repositories.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n MarketplaceCategory\n

    \n

    A public description of a Marketplace category.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    description (String)

    The category's description.

    \n\n\n\n\n\n\n\n\n\n\n\n

    howItWorks (String)

    The technical description of how apps listed in this category work with GitHub.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The category's name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    primaryListingCount (Int!)

    How many Marketplace listings have this as their primary category.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this Marketplace category.

    \n\n\n\n\n\n\n\n\n\n\n\n

    secondaryListingCount (Int!)

    How many Marketplace listings have this as their secondary category.

    \n\n\n\n\n\n\n\n\n\n\n\n

    slug (String!)

    The short name of the category used in its URL.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this Marketplace category.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n MarketplaceListing\n

    \n

    A listing in the GitHub integration marketplace.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    app (App)

    The GitHub App this listing represents.

    \n\n\n\n\n\n\n\n\n\n\n\n

    companyUrl (URI)

    URL to the listing owner's company site.

    \n\n\n\n\n\n\n\n\n\n\n\n

    configurationResourcePath (URI!)

    The HTTP path for configuring access to the listing's integration or OAuth app.

    \n\n\n\n\n\n\n\n\n\n\n\n

    configurationUrl (URI!)

    The HTTP URL for configuring access to the listing's integration or OAuth app.

    \n\n\n\n\n\n\n\n\n\n\n\n

    documentationUrl (URI)

    URL to the listing's documentation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    extendedDescription (String)

    The listing's detailed description.

    \n\n\n\n\n\n\n\n\n\n\n\n

    extendedDescriptionHTML (HTML!)

    The listing's detailed description rendered to HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    fullDescription (String!)

    The listing's introductory description.

    \n\n\n\n\n\n\n\n\n\n\n\n

    fullDescriptionHTML (HTML!)

    The listing's introductory description rendered to HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hasPublishedFreeTrialPlans (Boolean!)

    Does this listing have any plans with a free trial?.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hasTermsOfService (Boolean!)

    Does this listing have a terms of service link?.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hasVerifiedOwner (Boolean!)

    Whether the creator of the app is a verified org.

    \n\n\n\n\n\n\n\n\n\n\n\n

    howItWorks (String)

    A technical description of how this app works with GitHub.

    \n\n\n\n\n\n\n\n\n\n\n\n

    howItWorksHTML (HTML!)

    The listing's technical description rendered to HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    installationUrl (URI)

    URL to install the product to the viewer's account or organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    installedForViewer (Boolean!)

    Whether this listing's app has been installed for the current viewer.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isArchived (Boolean!)

    Whether this listing has been removed from the Marketplace.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isDraft (Boolean!)

    Whether this listing is still an editable draft that has not been submitted\nfor review and is not publicly visible in the Marketplace.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isPaid (Boolean!)

    Whether the product this listing represents is available as part of a paid plan.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isPublic (Boolean!)

    Whether this listing has been approved for display in the Marketplace.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isRejected (Boolean!)

    Whether this listing has been rejected by GitHub for display in the Marketplace.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isUnverified (Boolean!)

    Whether this listing has been approved for unverified display in the Marketplace.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isUnverifiedPending (Boolean!)

    Whether this draft listing has been submitted for review for approval to be unverified in the Marketplace.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isVerificationPendingFromDraft (Boolean!)

    Whether this draft listing has been submitted for review from GitHub for approval to be verified in the Marketplace.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isVerificationPendingFromUnverified (Boolean!)

    Whether this unverified listing has been submitted for review from GitHub for approval to be verified in the Marketplace.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isVerified (Boolean!)

    Whether this listing has been approved for verified display in the Marketplace.

    \n\n\n\n\n\n\n\n\n\n\n\n

    logoBackgroundColor (String!)

    The hex color code, without the leading '#', for the logo background.

    \n\n\n\n\n\n\n\n\n\n\n\n

    logoUrl (URI)

    URL for the listing's logo image.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    size (Int)

    \n

    The size in pixels of the resulting square image.

    \n

    The default value is 400.

    \n
    \n\n
    \n\n\n

    name (String!)

    The listing's full name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    normalizedShortDescription (String!)

    The listing's very short description without a trailing period or ampersands.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pricingUrl (URI)

    URL to the listing's detailed pricing.

    \n\n\n\n\n\n\n\n\n\n\n\n

    primaryCategory (MarketplaceCategory!)

    The category that best describes the listing.

    \n\n\n\n\n\n\n\n\n\n\n\n

    privacyPolicyUrl (URI!)

    URL to the listing's privacy policy, may return an empty string for listings that do not require a privacy policy URL.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for the Marketplace listing.

    \n\n\n\n\n\n\n\n\n\n\n\n

    screenshotUrls ([String]!)

    The URLs for the listing's screenshots.

    \n\n\n\n\n\n\n\n\n\n\n\n

    secondaryCategory (MarketplaceCategory)

    An alternate category that describes the listing.

    \n\n\n\n\n\n\n\n\n\n\n\n

    shortDescription (String!)

    The listing's very short description.

    \n\n\n\n\n\n\n\n\n\n\n\n

    slug (String!)

    The short name of the listing used in its URL.

    \n\n\n\n\n\n\n\n\n\n\n\n

    statusUrl (URI)

    URL to the listing's status page.

    \n\n\n\n\n\n\n\n\n\n\n\n

    supportEmail (String)

    An email address for support for this listing's app.

    \n\n\n\n\n\n\n\n\n\n\n\n

    supportUrl (URI!)

    Either a URL or an email address for support for this listing's app, may\nreturn an empty string for listings that do not require a support URL.

    \n\n\n\n\n\n\n\n\n\n\n\n

    termsOfServiceUrl (URI)

    URL to the listing's terms of service.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for the Marketplace listing.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanAddPlans (Boolean!)

    Can the current viewer add plans for this Marketplace listing.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanApprove (Boolean!)

    Can the current viewer approve this Marketplace listing.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanDelist (Boolean!)

    Can the current viewer delist this Marketplace listing.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanEdit (Boolean!)

    Can the current viewer edit this Marketplace listing.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanEditCategories (Boolean!)

    Can the current viewer edit the primary and secondary category of this\nMarketplace listing.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanEditPlans (Boolean!)

    Can the current viewer edit the plans for this Marketplace listing.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanRedraft (Boolean!)

    Can the current viewer return this Marketplace listing to draft state\nso it becomes editable again.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanReject (Boolean!)

    Can the current viewer reject this Marketplace listing by returning it to\nan editable draft state or rejecting it entirely.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanRequestApproval (Boolean!)

    Can the current viewer request this listing be reviewed for display in\nthe Marketplace as verified.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerHasPurchased (Boolean!)

    Indicates whether the current user has an active subscription to this Marketplace listing.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerHasPurchasedForAllOrganizations (Boolean!)

    Indicates if the current user has purchased a subscription to this Marketplace listing\nfor all of the organizations the user owns.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerIsListingAdmin (Boolean!)

    Does the current viewer role allow them to administer this Marketplace listing.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n MarketplaceListingConnection\n

    \n

    Look up Marketplace Listings.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([MarketplaceListingEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([MarketplaceListing])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n MarketplaceListingEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (MarketplaceListing)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n MembersCanDeleteReposClearAuditEntry\n

    \n

    Audit log entry for a members_can_delete_repos.clear event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseResourcePath (URI)

    The HTTP path for this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseSlug (String)

    The slug of the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseUrl (URI)

    The HTTP URL for this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n MembersCanDeleteReposDisableAuditEntry\n

    \n

    Audit log entry for a members_can_delete_repos.disable event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseResourcePath (URI)

    The HTTP path for this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseSlug (String)

    The slug of the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseUrl (URI)

    The HTTP URL for this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n MembersCanDeleteReposEnableAuditEntry\n

    \n

    Audit log entry for a members_can_delete_repos.enable event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseResourcePath (URI)

    The HTTP path for this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseSlug (String)

    The slug of the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseUrl (URI)

    The HTTP URL for this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n MentionedEvent\n

    \n

    Represents amentionedevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n MergedEvent\n

    \n

    Represents amergedevent on a given pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commit (Commit)

    Identifies the commit associated with the merge event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    mergeRef (Ref)

    Identifies the Ref associated with the merge event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    mergeRefName (String!)

    Identifies the name of the Ref associated with the merge event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    PullRequest referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this merged event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this merged event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Milestone\n

    \n

    Represents a Milestone object on a given repository.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    closed (Boolean!)

    true if the object is closed (definition of closed may depend on type).

    \n\n\n\n\n\n\n\n\n\n\n\n

    closedAt (DateTime)

    Identifies the date and time when the object was closed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    creator (Actor)

    Identifies the actor who created the milestone.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String)

    Identifies the description of the milestone.

    \n\n\n\n\n\n\n\n\n\n\n\n

    dueOn (DateTime)

    Identifies the due date of the milestone.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issues (IssueConnection!)

    A list of issues associated with the milestone.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    filterBy (IssueFilters)

    \n

    Filtering options for issues returned from the connection.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    labels ([String!])

    \n

    A list of label names to filter the pull requests by.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (IssueOrder)

    \n

    Ordering options for issues returned from the connection.

    \n\n
    \n\n
    \n

    states ([IssueState!])

    \n

    A list of states to filter the issues by.

    \n\n
    \n\n
    \n\n\n

    number (Int!)

    Identifies the number of the milestone.

    \n\n\n\n\n\n\n\n\n\n\n\n

    progressPercentage (Float!)

    Identifies the percentage complete for the milestone.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequests (PullRequestConnection!)

    A list of pull requests associated with the milestone.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    baseRefName (String)

    \n

    The base ref name to filter the pull requests by.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    headRefName (String)

    \n

    The head ref name to filter the pull requests by.

    \n\n
    \n\n
    \n

    labels ([String!])

    \n

    A list of label names to filter the pull requests by.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (IssueOrder)

    \n

    Ordering options for pull requests returned from the connection.

    \n\n
    \n\n
    \n

    states ([PullRequestState!])

    \n

    A list of states to filter the pull requests by.

    \n\n
    \n\n
    \n\n\n

    repository (Repository!)

    The repository associated with this milestone.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this milestone.

    \n\n\n\n\n\n\n\n\n\n\n\n

    state (MilestoneState!)

    Identifies the state of the milestone.

    \n\n\n\n\n\n\n\n\n\n\n\n

    title (String!)

    Identifies the title of the milestone.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this milestone.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n MilestoneConnection\n

    \n

    The connection type for Milestone.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([MilestoneEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Milestone])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n MilestoneEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (Milestone)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n MilestonedEvent\n

    \n

    Represents amilestonedevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    milestoneTitle (String!)

    Identifies the milestone title associated with themilestonedevent.

    \n\n\n\n\n\n\n\n\n\n\n\n

    subject (MilestoneItem!)

    Object referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n MovedColumnsInProjectEvent\n

    \n

    Represents amoved_columns_in_projectevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    previousProjectColumnName (String!)

    Column name the issue or pull request was moved from.

    \n\n\n\n\n
    \n

    Preview notice

    \n

    previousProjectColumnName is available under the Project event details preview. During the preview period, the API may change without notice.

    \n
    \n\n\n\n\n\n\n\n\n

    project (Project)

    Project referenced by event.

    \n\n\n\n\n
    \n

    Preview notice

    \n

    project is available under the Project event details preview. During the preview period, the API may change without notice.

    \n
    \n\n\n\n\n\n\n\n\n

    projectCard (ProjectCard)

    Project card referenced by this project event.

    \n\n\n\n\n
    \n

    Preview notice

    \n

    projectCard is available under the Project event details preview. During the preview period, the API may change without notice.

    \n
    \n\n\n\n\n\n\n\n\n

    projectColumnName (String!)

    Column name the issue or pull request was moved to.

    \n\n\n\n\n
    \n

    Preview notice

    \n

    projectColumnName is available under the Project event details preview. During the preview period, the API may change without notice.

    \n
    \n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OauthApplicationCreateAuditEntry\n

    \n

    Audit log entry for a oauth_application.create event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    applicationUrl (URI)

    The application URL of the OAuth Application.

    \n\n\n\n\n\n\n\n\n\n\n\n

    callbackUrl (URI)

    The callback URL of the OAuth Application.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    oauthApplicationName (String)

    The name of the OAuth Application.

    \n\n\n\n\n\n\n\n\n\n\n\n

    oauthApplicationResourcePath (URI)

    The HTTP path for the OAuth Application.

    \n\n\n\n\n\n\n\n\n\n\n\n

    oauthApplicationUrl (URI)

    The HTTP URL for the OAuth Application.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    rateLimit (Int)

    The rate limit of the OAuth Application.

    \n\n\n\n\n\n\n\n\n\n\n\n

    state (OauthApplicationCreateAuditEntryState)

    The state of the OAuth Application.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgAddBillingManagerAuditEntry\n

    \n

    Audit log entry for a org.add_billing_manager.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    invitationEmail (String)

    The email address used to invite a billing manager for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgAddMemberAuditEntry\n

    \n

    Audit log entry for a org.add_member.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    permission (OrgAddMemberAuditEntryPermission)

    The permission level of the member added to the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgBlockUserAuditEntry\n

    \n

    Audit log entry for a org.block_user.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    blockedUser (User)

    The blocked user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    blockedUserName (String)

    The username of the blocked user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    blockedUserResourcePath (URI)

    The HTTP path for the blocked user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    blockedUserUrl (URI)

    The HTTP URL for the blocked user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgConfigDisableCollaboratorsOnlyAuditEntry\n

    \n

    Audit log entry for a org.config.disable_collaborators_only event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgConfigEnableCollaboratorsOnlyAuditEntry\n

    \n

    Audit log entry for a org.config.enable_collaborators_only event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgCreateAuditEntry\n

    \n

    Audit log entry for a org.create event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    billingPlan (OrgCreateAuditEntryBillingPlan)

    The billing plan for the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgDisableOauthAppRestrictionsAuditEntry\n

    \n

    Audit log entry for a org.disable_oauth_app_restrictions event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgDisableSamlAuditEntry\n

    \n

    Audit log entry for a org.disable_saml event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    digestMethodUrl (URI)

    The SAML provider's digest algorithm URL.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issuerUrl (URI)

    The SAML provider's issuer URL.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    signatureMethodUrl (URI)

    The SAML provider's signature algorithm URL.

    \n\n\n\n\n\n\n\n\n\n\n\n

    singleSignOnUrl (URI)

    The SAML provider's single sign-on URL.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgDisableTwoFactorRequirementAuditEntry\n

    \n

    Audit log entry for a org.disable_two_factor_requirement event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgEnableOauthAppRestrictionsAuditEntry\n

    \n

    Audit log entry for a org.enable_oauth_app_restrictions event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgEnableSamlAuditEntry\n

    \n

    Audit log entry for a org.enable_saml event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    digestMethodUrl (URI)

    The SAML provider's digest algorithm URL.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issuerUrl (URI)

    The SAML provider's issuer URL.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    signatureMethodUrl (URI)

    The SAML provider's signature algorithm URL.

    \n\n\n\n\n\n\n\n\n\n\n\n

    singleSignOnUrl (URI)

    The SAML provider's single sign-on URL.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgEnableTwoFactorRequirementAuditEntry\n

    \n

    Audit log entry for a org.enable_two_factor_requirement event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgInviteMemberAuditEntry\n

    \n

    Audit log entry for a org.invite_member event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    email (String)

    The email address of the organization invitation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationInvitation (OrganizationInvitation)

    The organization invitation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgInviteToBusinessAuditEntry\n

    \n

    Audit log entry for a org.invite_to_business event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseResourcePath (URI)

    The HTTP path for this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseSlug (String)

    The slug of the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseUrl (URI)

    The HTTP URL for this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgOauthAppAccessApprovedAuditEntry\n

    \n

    Audit log entry for a org.oauth_app_access_approved event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    oauthApplicationName (String)

    The name of the OAuth Application.

    \n\n\n\n\n\n\n\n\n\n\n\n

    oauthApplicationResourcePath (URI)

    The HTTP path for the OAuth Application.

    \n\n\n\n\n\n\n\n\n\n\n\n

    oauthApplicationUrl (URI)

    The HTTP URL for the OAuth Application.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgOauthAppAccessDeniedAuditEntry\n

    \n

    Audit log entry for a org.oauth_app_access_denied event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    oauthApplicationName (String)

    The name of the OAuth Application.

    \n\n\n\n\n\n\n\n\n\n\n\n

    oauthApplicationResourcePath (URI)

    The HTTP path for the OAuth Application.

    \n\n\n\n\n\n\n\n\n\n\n\n

    oauthApplicationUrl (URI)

    The HTTP URL for the OAuth Application.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgOauthAppAccessRequestedAuditEntry\n

    \n

    Audit log entry for a org.oauth_app_access_requested event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    oauthApplicationName (String)

    The name of the OAuth Application.

    \n\n\n\n\n\n\n\n\n\n\n\n

    oauthApplicationResourcePath (URI)

    The HTTP path for the OAuth Application.

    \n\n\n\n\n\n\n\n\n\n\n\n

    oauthApplicationUrl (URI)

    The HTTP URL for the OAuth Application.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgRemoveBillingManagerAuditEntry\n

    \n

    Audit log entry for a org.remove_billing_manager event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reason (OrgRemoveBillingManagerAuditEntryReason)

    The reason for the billing manager being removed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgRemoveMemberAuditEntry\n

    \n

    Audit log entry for a org.remove_member event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    membershipTypes ([OrgRemoveMemberAuditEntryMembershipType!])

    The types of membership the member has with the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reason (OrgRemoveMemberAuditEntryReason)

    The reason for the member being removed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgRemoveOutsideCollaboratorAuditEntry\n

    \n

    Audit log entry for a org.remove_outside_collaborator event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    membershipTypes ([OrgRemoveOutsideCollaboratorAuditEntryMembershipType!])

    The types of membership the outside collaborator has with the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reason (OrgRemoveOutsideCollaboratorAuditEntryReason)

    The reason for the outside collaborator being removed from the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgRestoreMemberAuditEntry\n

    \n

    Audit log entry for a org.restore_member event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    restoredCustomEmailRoutingsCount (Int)

    The number of custom email routings for the restored member.

    \n\n\n\n\n\n\n\n\n\n\n\n

    restoredIssueAssignmentsCount (Int)

    The number of issue assignments for the restored member.

    \n\n\n\n\n\n\n\n\n\n\n\n

    restoredMemberships ([OrgRestoreMemberAuditEntryMembership!])

    Restored organization membership objects.

    \n\n\n\n\n\n\n\n\n\n\n\n

    restoredMembershipsCount (Int)

    The number of restored memberships.

    \n\n\n\n\n\n\n\n\n\n\n\n

    restoredRepositoriesCount (Int)

    The number of repositories of the restored member.

    \n\n\n\n\n\n\n\n\n\n\n\n

    restoredRepositoryStarsCount (Int)

    The number of starred repositories for the restored member.

    \n\n\n\n\n\n\n\n\n\n\n\n

    restoredRepositoryWatchesCount (Int)

    The number of watched repositories for the restored member.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgRestoreMemberMembershipOrganizationAuditEntryData\n

    \n

    Metadata for an organization membership for org.restore_member actions.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgRestoreMemberMembershipRepositoryAuditEntryData\n

    \n

    Metadata for a repository membership for org.restore_member actions.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgRestoreMemberMembershipTeamAuditEntryData\n

    \n

    Metadata for a team membership for org.restore_member actions.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    team (Team)

    The team associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamName (String)

    The name of the team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamResourcePath (URI)

    The HTTP path for this team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamUrl (URI)

    The HTTP URL for this team.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgUnblockUserAuditEntry\n

    \n

    Audit log entry for a org.unblock_user.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    blockedUser (User)

    The user being unblocked by the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    blockedUserName (String)

    The username of the blocked user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    blockedUserResourcePath (URI)

    The HTTP path for the blocked user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    blockedUserUrl (URI)

    The HTTP URL for the blocked user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgUpdateDefaultRepositoryPermissionAuditEntry\n

    \n

    Audit log entry for a org.update_default_repository_permission.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    permission (OrgUpdateDefaultRepositoryPermissionAuditEntryPermission)

    The new default repository permission level for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    permissionWas (OrgUpdateDefaultRepositoryPermissionAuditEntryPermission)

    The former default repository permission level for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgUpdateMemberAuditEntry\n

    \n

    Audit log entry for a org.update_member event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    permission (OrgUpdateMemberAuditEntryPermission)

    The new member permission level for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    permissionWas (OrgUpdateMemberAuditEntryPermission)

    The former member permission level for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgUpdateMemberRepositoryCreationPermissionAuditEntry\n

    \n

    Audit log entry for a org.update_member_repository_creation_permission event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    canCreateRepositories (Boolean)

    Can members create repositories in the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    visibility (OrgUpdateMemberRepositoryCreationPermissionAuditEntryVisibility)

    The permission for visibility level of repositories for this organization.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgUpdateMemberRepositoryInvitationPermissionAuditEntry\n

    \n

    Audit log entry for a org.update_member_repository_invitation_permission event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    canInviteOutsideCollaboratorsToRepositories (Boolean)

    Can outside collaborators be invited to repositories in the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Organization\n

    \n

    An account on GitHub, with one or more owners, that has repositories, members and teams.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    anyPinnableItems (Boolean!)

    Determine if this repository owner has any items that can be pinned to their profile.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    type (PinnableItemType)

    \n

    Filter to only a particular kind of pinnable item.

    \n\n
    \n\n
    \n\n\n

    auditLog (OrganizationAuditEntryConnection!)

    Audit log entries of the organization.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (AuditLogOrder)

    \n

    Ordering options for the returned audit log entries.

    \n\n
    \n\n
    \n

    query (String)

    \n

    The query string to filter audit entries.

    \n\n
    \n\n
    \n\n\n

    avatarUrl (URI!)

    A URL pointing to the organization's public avatar.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    size (Int)

    \n

    The size of the resulting square image.

    \n\n
    \n\n
    \n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String)

    The organization's public profile description.

    \n\n\n\n\n\n\n\n\n\n\n\n

    descriptionHTML (String)

    The organization's public profile description rendered to HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    domains (VerifiableDomainConnection)

    A list of domains owned by the organization.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    isVerified (Boolean)

    \n

    Filter by if the domain is verified.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (VerifiableDomainOrder)

    \n

    Ordering options for verifiable domains returned.

    \n\n
    \n\n
    \n\n\n

    email (String)

    The organization's public email.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hasSponsorsListing (Boolean!)

    True if this user/organization has a GitHub Sponsors listing.

    \n\n\n\n\n\n\n\n\n\n\n\n

    interactionAbility (RepositoryInteractionAbility)

    The interaction ability settings for this organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ipAllowListEnabledSetting (IpAllowListEnabledSettingValue!)

    The setting value for whether the organization has an IP allow list enabled.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ipAllowListEntries (IpAllowListEntryConnection!)

    The IP addresses that are allowed to access resources owned by the organization.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (IpAllowListEntryOrder)

    \n

    Ordering options for IP allow list entries returned.

    \n\n
    \n\n
    \n\n\n

    isSponsoredBy (Boolean!)

    Check if the given account is sponsoring this user/organization.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    accountLogin (String!)

    \n

    The target account's login.

    \n\n
    \n\n
    \n\n\n

    isSponsoringViewer (Boolean!)

    True if the viewer is sponsored by this user/organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isVerified (Boolean!)

    Whether the organization has verified its profile email and website.

    \n\n\n\n\n\n\n\n\n\n\n\n

    itemShowcase (ProfileItemShowcase!)

    Showcases a selection of repositories and gists that the profile owner has\neither curated or that have been selected automatically based on popularity.

    \n\n\n\n\n\n\n\n\n\n\n\n

    location (String)

    The organization's public profile location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    login (String!)

    The organization's login name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    memberStatuses (UserStatusConnection!)

    Get the status messages members of this entity have set that are either public or visible only to the organization.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (UserStatusOrder)

    \n

    Ordering options for user statuses returned from the connection.

    \n\n
    \n\n
    \n\n\n

    membersWithRole (OrganizationMemberConnection!)

    A list of users who are members of this organization.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    name (String)

    The organization's public profile name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    newTeamResourcePath (URI!)

    The HTTP path creating a new team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    newTeamUrl (URI!)

    The HTTP URL creating a new team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    notificationDeliveryRestrictionEnabledSetting (NotificationRestrictionSettingValue!)

    Indicates if email notification delivery for this organization is restricted to verified domains.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationBillingEmail (String)

    The billing email for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    packages (PackageConnection!)

    A list of packages under the owner.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    names ([String])

    \n

    Find packages by their names.

    \n\n
    \n\n
    \n

    orderBy (PackageOrder)

    \n

    Ordering of the returned packages.

    \n\n
    \n\n
    \n

    packageType (PackageType)

    \n

    Filter registry package by type.

    \n\n
    \n\n
    \n

    repositoryId (ID)

    \n

    Find packages in a repository by ID.

    \n\n
    \n\n
    \n\n\n

    pendingMembers (UserConnection!)

    A list of users who have been invited to join this organization.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    pinnableItems (PinnableItemConnection!)

    A list of repositories and gists this profile owner can pin to their profile.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    types ([PinnableItemType!])

    \n

    Filter the types of pinnable items that are returned.

    \n\n
    \n\n
    \n\n\n

    pinnedItems (PinnableItemConnection!)

    A list of repositories and gists this profile owner has pinned to their profile.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    types ([PinnableItemType!])

    \n

    Filter the types of pinned items that are returned.

    \n\n
    \n\n
    \n\n\n

    pinnedItemsRemaining (Int!)

    Returns how many more items this profile owner can pin to their profile.

    \n\n\n\n\n\n\n\n\n\n\n\n

    project (Project)

    Find project by number.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    number (Int!)

    \n

    The project number to find.

    \n\n
    \n\n
    \n\n\n

    projects (ProjectConnection!)

    A list of projects under the owner.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (ProjectOrder)

    \n

    Ordering options for projects returned from the connection.

    \n\n
    \n\n
    \n

    search (String)

    \n

    Query to search projects by, currently only searching by name.

    \n\n
    \n\n
    \n

    states ([ProjectState!])

    \n

    A list of states to filter the projects by.

    \n\n
    \n\n
    \n\n\n

    projectsResourcePath (URI!)

    The HTTP path listing organization's projects.

    \n\n\n\n\n\n\n\n\n\n\n\n

    projectsUrl (URI!)

    The HTTP URL listing organization's projects.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositories (RepositoryConnection!)

    A list of repositories that the user owns.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    affiliations ([RepositoryAffiliation])

    \n

    Array of viewer's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\ncurrent viewer owns.

    \n\n
    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    isFork (Boolean)

    \n

    If non-null, filters repositories according to whether they are forks of another repository.

    \n\n
    \n\n
    \n

    isLocked (Boolean)

    \n

    If non-null, filters repositories according to whether they have been locked.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (RepositoryOrder)

    \n

    Ordering options for repositories returned from the connection.

    \n\n
    \n\n
    \n

    ownerAffiliations ([RepositoryAffiliation])

    \n

    Array of owner's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\norganization or user being viewed owns.

    \n\n
    \n\n
    \n

    privacy (RepositoryPrivacy)

    \n

    If non-null, filters repositories according to privacy.

    \n\n
    \n\n
    \n\n\n

    repository (Repository)

    Find Repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    name (String!)

    \n

    Name of Repository to find.

    \n\n
    \n\n
    \n\n\n

    requiresTwoFactorAuthentication (Boolean)

    When true the organization requires all members, billing managers, and outside\ncollaborators to enable two-factor authentication.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    samlIdentityProvider (OrganizationIdentityProvider)

    The Organization's SAML identity providers.

    \n\n\n\n\n\n\n\n\n\n\n\n

    sponsorsListing (SponsorsListing)

    The GitHub Sponsors listing for this user or organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    sponsorshipForViewerAsSponsor (Sponsorship)

    The viewer's sponsorship of this entity.

    \n\n\n\n\n\n\n\n\n\n\n\n

    sponsorshipsAsMaintainer (SponsorshipConnection!)

    This object's sponsorships as the maintainer.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    includePrivate (Boolean)

    \n

    Whether or not to include private sponsorships in the result set.

    \n

    The default value is false.

    \n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (SponsorshipOrder)

    \n

    Ordering options for sponsorships returned from this connection. If left\nblank, the sponsorships will be ordered based on relevancy to the viewer.

    \n\n
    \n\n
    \n\n\n

    sponsorshipsAsSponsor (SponsorshipConnection!)

    This object's sponsorships as the sponsor.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (SponsorshipOrder)

    \n

    Ordering options for sponsorships returned from this connection. If left\nblank, the sponsorships will be ordered based on relevancy to the viewer.

    \n\n
    \n\n
    \n\n\n

    team (Team)

    Find an organization's team by its slug.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    slug (String!)

    \n

    The name or slug of the team to find.

    \n\n
    \n\n
    \n\n\n

    teams (TeamConnection!)

    A list of teams in this organization.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    ldapMapped (Boolean)

    \n

    If true, filters teams that are mapped to an LDAP Group (Enterprise only).

    \n\n
    \n\n
    \n

    orderBy (TeamOrder)

    \n

    Ordering options for teams returned from the connection.

    \n\n
    \n\n
    \n

    privacy (TeamPrivacy)

    \n

    If non-null, filters teams according to privacy.

    \n\n
    \n\n
    \n

    query (String)

    \n

    If non-null, filters teams with query on team name and team slug.

    \n\n
    \n\n
    \n

    role (TeamRole)

    \n

    If non-null, filters teams according to whether the viewer is an admin or member on team.

    \n\n
    \n\n
    \n

    rootTeamsOnly (Boolean)

    \n

    If true, restrict to only root teams.

    \n

    The default value is false.

    \n
    \n\n
    \n

    userLogins ([String!])

    \n

    User logins to filter by.

    \n\n
    \n\n
    \n\n\n

    teamsResourcePath (URI!)

    The HTTP path listing organization's teams.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamsUrl (URI!)

    The HTTP URL listing organization's teams.

    \n\n\n\n\n\n\n\n\n\n\n\n

    twitterUsername (String)

    The organization's Twitter username.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanAdminister (Boolean!)

    Organization is adminable by the viewer.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanChangePinnedItems (Boolean!)

    Can the viewer pin repositories and gists to the profile?.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanCreateProjects (Boolean!)

    Can the current viewer create new projects on this owner.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanCreateRepositories (Boolean!)

    Viewer can create repositories on this organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanCreateTeams (Boolean!)

    Viewer can create teams on this organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanSponsor (Boolean!)

    Whether or not the viewer is able to sponsor this user/organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerIsAMember (Boolean!)

    Viewer is an active member of this organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerIsSponsoring (Boolean!)

    True if the viewer is sponsoring this user/organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    websiteUrl (URI)

    The organization's public profile URL.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrganizationAuditEntryConnection\n

    \n

    The connection type for OrganizationAuditEntry.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([OrganizationAuditEntryEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([OrganizationAuditEntry])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrganizationAuditEntryEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (OrganizationAuditEntry)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrganizationConnection\n

    \n

    The connection type for Organization.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([OrganizationEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Organization])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrganizationEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (Organization)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrganizationIdentityProvider\n

    \n

    An Identity Provider configured to provision SAML and SCIM identities for Organizations.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    digestMethod (URI)

    The digest algorithm used to sign SAML requests for the Identity Provider.

    \n\n\n\n\n\n\n\n\n\n\n\n

    externalIdentities (ExternalIdentityConnection!)

    External Identities provisioned by this Identity Provider.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    idpCertificate (X509Certificate)

    The x509 certificate used by the Identity Provider to sign assertions and responses.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issuer (String)

    The Issuer Entity ID for the SAML Identity Provider.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    Organization this Identity Provider belongs to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    signatureMethod (URI)

    The signature algorithm used to sign SAML requests for the Identity Provider.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ssoUrl (URI)

    The URL endpoint for the Identity Provider's SAML SSO.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrganizationInvitation\n

    \n

    An Invitation for a user to an organization.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    email (String)

    The email address of the user invited to the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    invitationType (OrganizationInvitationType!)

    The type of invitation that was sent (e.g. email, user).

    \n\n\n\n\n\n\n\n\n\n\n\n

    invitee (User)

    The user who was invited to the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    inviter (User!)

    The user who created the invitation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization!)

    The organization the invite is for.

    \n\n\n\n\n\n\n\n\n\n\n\n

    role (OrganizationInvitationRole!)

    The user's pending role in the organization (e.g. member, owner).

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrganizationInvitationConnection\n

    \n

    The connection type for OrganizationInvitation.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([OrganizationInvitationEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([OrganizationInvitation])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrganizationInvitationEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (OrganizationInvitation)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrganizationMemberConnection\n

    \n

    The connection type for User.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([OrganizationMemberEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([User])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrganizationMemberEdge\n

    \n

    Represents a user within an organization.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hasTwoFactorEnabled (Boolean)

    Whether the organization member has two factor enabled or not. Returns null if information is not available to viewer.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (User)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n

    role (OrganizationMemberRole)

    The role this user has in the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrganizationTeamsHovercardContext\n

    \n

    An organization teams hovercard context.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    message (String!)

    A string describing this context.

    \n\n\n\n\n\n\n\n\n\n\n\n

    octicon (String!)

    An octicon to accompany this context.

    \n\n\n\n\n\n\n\n\n\n\n\n

    relevantTeams (TeamConnection!)

    Teams in this organization the user is a member of that are relevant.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    teamsResourcePath (URI!)

    The path for the full team list for this user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamsUrl (URI!)

    The URL for the full team list for this user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalTeamCount (Int!)

    The total number of teams the user is on in the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrganizationsHovercardContext\n

    \n

    An organization list hovercard context.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    message (String!)

    A string describing this context.

    \n\n\n\n\n\n\n\n\n\n\n\n

    octicon (String!)

    An octicon to accompany this context.

    \n\n\n\n\n\n\n\n\n\n\n\n

    relevantOrganizations (OrganizationConnection!)

    Organizations this user is a member of that are relevant.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    totalOrganizationCount (Int!)

    The total number of organizations this user is in.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Package\n

    \n

    Information for an uploaded package.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    latestVersion (PackageVersion)

    Find the latest version for the package.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    Identifies the name of the package.

    \n\n\n\n\n\n\n\n\n\n\n\n

    packageType (PackageType!)

    Identifies the type of the package.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository this package belongs to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    statistics (PackageStatistics)

    Statistics about package activity.

    \n\n\n\n\n\n\n\n\n\n\n\n

    version (PackageVersion)

    Find package version by version string.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    version (String!)

    \n

    The package version.

    \n\n
    \n\n
    \n\n\n

    versions (PackageVersionConnection!)

    list of versions for this package.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (PackageVersionOrder)

    \n

    Ordering of the returned packages.

    \n\n
    \n\n
    \n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PackageConnection\n

    \n

    The connection type for Package.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([PackageEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Package])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PackageEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (Package)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PackageFile\n

    \n

    A file in a package version.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    md5 (String)

    MD5 hash of the file.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    Name of the file.

    \n\n\n\n\n\n\n\n\n\n\n\n

    packageVersion (PackageVersion)

    The package version this file belongs to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    sha1 (String)

    SHA1 hash of the file.

    \n\n\n\n\n\n\n\n\n\n\n\n

    sha256 (String)

    SHA256 hash of the file.

    \n\n\n\n\n\n\n\n\n\n\n\n

    size (Int)

    Size of the file in bytes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI)

    URL to download the asset.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PackageFileConnection\n

    \n

    The connection type for PackageFile.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([PackageFileEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([PackageFile])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PackageFileEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (PackageFile)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PackageStatistics\n

    \n

    Represents a object that contains package activity statistics such as downloads.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    downloadsTotalCount (Int!)

    Number of times the package was downloaded since it was created.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PackageTag\n

    \n

    A version tag contains the mapping between a tag name and a version.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    name (String!)

    Identifies the tag name of the version.

    \n\n\n\n\n\n\n\n\n\n\n\n

    version (PackageVersion)

    Version that the tag is associated with.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PackageVersion\n

    \n

    Information about a specific package version.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    files (PackageFileConnection!)

    List of files associated with this package version.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (PackageFileOrder)

    \n

    Ordering of the returned package files.

    \n\n
    \n\n
    \n\n\n

    package (Package)

    The package associated with this version.

    \n\n\n\n\n\n\n\n\n\n\n\n

    platform (String)

    The platform this version was built for.

    \n\n\n\n\n\n\n\n\n\n\n\n

    preRelease (Boolean!)

    Whether or not this version is a pre-release.

    \n\n\n\n\n\n\n\n\n\n\n\n

    readme (String)

    The README of this package version.

    \n\n\n\n\n\n\n\n\n\n\n\n

    release (Release)

    The release associated with this package version.

    \n\n\n\n\n\n\n\n\n\n\n\n

    statistics (PackageVersionStatistics)

    Statistics about package activity.

    \n\n\n\n\n\n\n\n\n\n\n\n

    summary (String)

    The package version summary.

    \n\n\n\n\n\n\n\n\n\n\n\n

    version (String!)

    The version string.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PackageVersionConnection\n

    \n

    The connection type for PackageVersion.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([PackageVersionEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([PackageVersion])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PackageVersionEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (PackageVersion)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PackageVersionStatistics\n

    \n

    Represents a object that contains package version activity statistics such as downloads.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    downloadsTotalCount (Int!)

    Number of times the package was downloaded since it was created.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PageInfo\n

    \n

    Information about pagination in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    endCursor (String)

    When paginating forwards, the cursor to continue.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hasNextPage (Boolean!)

    When paginating forwards, are there more items?.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hasPreviousPage (Boolean!)

    When paginating backwards, are there more items?.

    \n\n\n\n\n\n\n\n\n\n\n\n

    startCursor (String)

    When paginating backwards, the cursor to continue.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PermissionSource\n

    \n

    A level of permission and source for a user's access to a repository.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    organization (Organization!)

    The organization the repository belongs to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    permission (DefaultRepositoryPermissionField!)

    The level of access this source has granted to the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    source (PermissionGranter!)

    The source of this permission.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PinnableItemConnection\n

    \n

    The connection type for PinnableItem.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([PinnableItemEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([PinnableItem])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PinnableItemEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (PinnableItem)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PinnedEvent\n

    \n

    Represents apinnedevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issue (Issue!)

    Identifies the issue associated with the event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PinnedIssue\n

    \n

    A Pinned Issue is a issue pinned to a repository's index page.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issue (Issue!)

    The issue that was pinned.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pinnedBy (Actor!)

    The actor that pinned this issue.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository!)

    The repository that this issue was pinned to.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PinnedIssueConnection\n

    \n

    The connection type for PinnedIssue.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([PinnedIssueEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([PinnedIssue])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PinnedIssueEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (PinnedIssue)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PrivateRepositoryForkingDisableAuditEntry\n

    \n

    Audit log entry for a private_repository_forking.disable event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseResourcePath (URI)

    The HTTP path for this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseSlug (String)

    The slug of the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseUrl (URI)

    The HTTP URL for this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PrivateRepositoryForkingEnableAuditEntry\n

    \n

    Audit log entry for a private_repository_forking.enable event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseResourcePath (URI)

    The HTTP path for this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseSlug (String)

    The slug of the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseUrl (URI)

    The HTTP URL for this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ProfileItemShowcase\n

    \n

    A curatable list of repositories relating to a repository owner, which defaults\nto showing the most popular repositories they own.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    hasPinnedItems (Boolean!)

    Whether or not the owner has pinned any repositories or gists.

    \n\n\n\n\n\n\n\n\n\n\n\n

    items (PinnableItemConnection!)

    The repositories and gists in the showcase. If the profile owner has any\npinned items, those will be returned. Otherwise, the profile owner's popular\nrepositories will be returned.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Project\n

    \n

    Projects manage issues, pull requests and notes within a project owner.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String)

    The project's description body.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyHTML (HTML!)

    The projects description body rendered to HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    closed (Boolean!)

    true if the object is closed (definition of closed may depend on type).

    \n\n\n\n\n\n\n\n\n\n\n\n

    closedAt (DateTime)

    Identifies the date and time when the object was closed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    columns (ProjectColumnConnection!)

    List of columns in the project.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    creator (Actor)

    The actor who originally created the project.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The project's name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    number (Int!)

    The project's number.

    \n\n\n\n\n\n\n\n\n\n\n\n

    owner (ProjectOwner!)

    The project's owner. Currently limited to repositories, organizations, and users.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pendingCards (ProjectCardConnection!)

    List of pending cards in this project.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    archivedStates ([ProjectCardArchivedState])

    \n

    A list of archived states to filter the cards by.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    progress (ProjectProgress!)

    Project progress details.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this project.

    \n\n\n\n\n\n\n\n\n\n\n\n

    state (ProjectState!)

    Whether the project is open or closed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this project.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanUpdate (Boolean!)

    Check if the current viewer can update this object.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ProjectCard\n

    \n

    A card in a project.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    column (ProjectColumn)

    The project column this card is associated under. A card may only belong to one\nproject column at a time. The column field will be null if the card is created\nin a pending state and has yet to be associated with a column. Once cards are\nassociated with a column, they will not become pending in the future.

    \n\n\n\n\n\n\n\n\n\n\n\n

    content (ProjectCardItem)

    The card content item.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    creator (Actor)

    The actor who created this card.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isArchived (Boolean!)

    Whether the card is archived.

    \n\n\n\n\n\n\n\n\n\n\n\n

    note (String)

    The card note.

    \n\n\n\n\n\n\n\n\n\n\n\n

    project (Project!)

    The project that contains this card.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this card.

    \n\n\n\n\n\n\n\n\n\n\n\n

    state (ProjectCardState)

    The state of ProjectCard.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this card.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ProjectCardConnection\n

    \n

    The connection type for ProjectCard.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([ProjectCardEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([ProjectCard])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ProjectCardEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (ProjectCard)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ProjectColumn\n

    \n

    A column inside a project.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cards (ProjectCardConnection!)

    List of cards in the column.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    archivedStates ([ProjectCardArchivedState])

    \n

    A list of archived states to filter the cards by.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The project column's name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    project (Project!)

    The project that contains this column.

    \n\n\n\n\n\n\n\n\n\n\n\n

    purpose (ProjectColumnPurpose)

    The semantic purpose of the column.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this project column.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this project column.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ProjectColumnConnection\n

    \n

    The connection type for ProjectColumn.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([ProjectColumnEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([ProjectColumn])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ProjectColumnEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (ProjectColumn)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ProjectConnection\n

    \n

    A list of projects associated with the owner.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([ProjectEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Project])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ProjectEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (Project)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ProjectProgress\n

    \n

    Project progress stats.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    doneCount (Int!)

    The number of done cards.

    \n\n\n\n\n\n\n\n\n\n\n\n

    donePercentage (Float!)

    The percentage of done cards.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enabled (Boolean!)

    Whether progress tracking is enabled and cards with purpose exist for this project.

    \n\n\n\n\n\n\n\n\n\n\n\n

    inProgressCount (Int!)

    The number of in-progress cards.

    \n\n\n\n\n\n\n\n\n\n\n\n

    inProgressPercentage (Float!)

    The percentage of in-progress cards.

    \n\n\n\n\n\n\n\n\n\n\n\n

    todoCount (Int!)

    The number of to do cards.

    \n\n\n\n\n\n\n\n\n\n\n\n

    todoPercentage (Float!)

    The percentage of to do cards.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PublicKey\n

    \n

    A user's public key.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    accessedAt (DateTime)

    The last time this authorization was used to perform an action. Values will be null for keys not owned by the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime)

    Identifies the date and time when the key was created. Keys created before\nMarch 5th, 2014 have inaccurate values. Values will be null for keys not owned by the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    fingerprint (String!)

    The fingerprint for this PublicKey.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isReadOnly (Boolean)

    Whether this PublicKey is read-only or not. Values will be null for keys not owned by the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    key (String!)

    The public key string.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime)

    Identifies the date and time when the key was updated. Keys created before\nMarch 5th, 2014 may have inaccurate values. Values will be null for keys not\nowned by the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PublicKeyConnection\n

    \n

    The connection type for PublicKey.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([PublicKeyEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([PublicKey])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PublicKeyEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (PublicKey)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequest\n

    \n

    A repository pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    activeLockReason (LockReason)

    Reason that the conversation was locked.

    \n\n\n\n\n\n\n\n\n\n\n\n

    additions (Int!)

    The number of additions in this pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    assignees (UserConnection!)

    A list of Users assigned to this object.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    author (Actor)

    The actor who authored the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    authorAssociation (CommentAuthorAssociation!)

    Author's association with the subject of the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    autoMergeRequest (AutoMergeRequest)

    Returns the auto-merge request object if one exists for this pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    baseRef (Ref)

    Identifies the base Ref associated with the pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    baseRefName (String!)

    Identifies the name of the base Ref associated with the pull request, even if the ref has been deleted.

    \n\n\n\n\n\n\n\n\n\n\n\n

    baseRefOid (GitObjectID!)

    Identifies the oid of the base ref associated with the pull request, even if the ref has been deleted.

    \n\n\n\n\n\n\n\n\n\n\n\n

    baseRepository (Repository)

    The repository associated with this pull request's base Ref.

    \n\n\n\n\n\n\n\n\n\n\n\n

    body (String!)

    The body as Markdown.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyHTML (HTML!)

    The body rendered to HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyText (String!)

    The body rendered to text.

    \n\n\n\n\n\n\n\n\n\n\n\n

    canBeRebased (Boolean!)

    Whether or not the pull request is rebaseable.

    \n\n\n\n\n
    \n

    Preview notice

    \n

    canBeRebased is available under the Merge info preview. During the preview period, the API may change without notice.

    \n
    \n\n\n\n\n\n\n\n\n

    changedFiles (Int!)

    The number of changed files in this pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    checksResourcePath (URI!)

    The HTTP path for the checks of this pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    checksUrl (URI!)

    The HTTP URL for the checks of this pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    closed (Boolean!)

    true if the pull request is closed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    closedAt (DateTime)

    Identifies the date and time when the object was closed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    comments (IssueCommentConnection!)

    A list of comments associated with the pull request.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (IssueCommentOrder)

    \n

    Ordering options for issue comments returned from the connection.

    \n\n
    \n\n
    \n\n\n

    commits (PullRequestCommitConnection!)

    A list of commits present in this pull request's head branch not present in the base branch.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdViaEmail (Boolean!)

    Check if this comment was created via an email reply.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    deletions (Int!)

    The number of deletions in this pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    editor (Actor)

    The actor who edited this pull request's body.

    \n\n\n\n\n\n\n\n\n\n\n\n

    files (PullRequestChangedFileConnection)

    Lists the files changed within this pull request.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    headRef (Ref)

    Identifies the head Ref associated with the pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    headRefName (String!)

    Identifies the name of the head Ref associated with the pull request, even if the ref has been deleted.

    \n\n\n\n\n\n\n\n\n\n\n\n

    headRefOid (GitObjectID!)

    Identifies the oid of the head ref associated with the pull request, even if the ref has been deleted.

    \n\n\n\n\n\n\n\n\n\n\n\n

    headRepository (Repository)

    The repository associated with this pull request's head Ref.

    \n\n\n\n\n\n\n\n\n\n\n\n

    headRepositoryOwner (RepositoryOwner)

    The owner of the repository associated with this pull request's head Ref.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hovercard (Hovercard!)

    The hovercard information for this issue.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    includeNotificationContexts (Boolean)

    \n

    Whether or not to include notification contexts.

    \n

    The default value is true.

    \n
    \n\n
    \n\n\n

    includesCreatedEdit (Boolean!)

    Check if this comment was edited and includes an edit with the creation data.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isCrossRepository (Boolean!)

    The head and base repositories are different.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isDraft (Boolean!)

    Identifies if the pull request is a draft.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isReadByViewer (Boolean)

    Is this pull request read by the viewer.

    \n\n\n\n\n\n\n\n\n\n\n\n

    labels (LabelConnection)

    A list of labels associated with the object.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (LabelOrder)

    \n

    Ordering options for labels returned from the connection.

    \n\n
    \n\n
    \n\n\n

    lastEditedAt (DateTime)

    The moment the editor made the last edit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    latestOpinionatedReviews (PullRequestReviewConnection)

    A list of latest reviews per user associated with the pull request.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    writersOnly (Boolean)

    \n

    Only return reviews from user who have write access to the repository.

    \n

    The default value is false.

    \n
    \n\n
    \n\n\n

    latestReviews (PullRequestReviewConnection)

    A list of latest reviews per user associated with the pull request that are not also pending review.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    locked (Boolean!)

    true if the pull request is locked.

    \n\n\n\n\n\n\n\n\n\n\n\n

    maintainerCanModify (Boolean!)

    Indicates whether maintainers can modify the pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    mergeCommit (Commit)

    The commit that was created when this pull request was merged.

    \n\n\n\n\n\n\n\n\n\n\n\n

    mergeStateStatus (MergeStateStatus!)

    Detailed information about the current pull request merge state status.

    \n\n\n\n\n
    \n

    Preview notice

    \n

    mergeStateStatus is available under the Merge info preview. During the preview period, the API may change without notice.

    \n
    \n\n\n\n\n\n\n\n\n

    mergeable (MergeableState!)

    Whether or not the pull request can be merged based on the existence of merge conflicts.

    \n\n\n\n\n\n\n\n\n\n\n\n

    merged (Boolean!)

    Whether or not the pull request was merged.

    \n\n\n\n\n\n\n\n\n\n\n\n

    mergedAt (DateTime)

    The date and time that the pull request was merged.

    \n\n\n\n\n\n\n\n\n\n\n\n

    mergedBy (Actor)

    The actor who merged the pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    milestone (Milestone)

    Identifies the milestone associated with the pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    number (Int!)

    Identifies the pull request number.

    \n\n\n\n\n\n\n\n\n\n\n\n

    participants (UserConnection!)

    A list of Users that are participating in the Pull Request conversation.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    permalink (URI!)

    The permalink to the pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    potentialMergeCommit (Commit)

    The commit that GitHub automatically generated to test if this pull request\ncould be merged. This field will not return a value if the pull request is\nmerged, or if the test merge commit is still being generated. See the\nmergeable field for more details on the mergeability of the pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    projectCards (ProjectCardConnection!)

    List of project cards associated with this pull request.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    archivedStates ([ProjectCardArchivedState])

    \n

    A list of archived states to filter the cards by.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    publishedAt (DateTime)

    Identifies when the comment was published at.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reactionGroups ([ReactionGroup!])

    A list of reactions grouped by content left on the subject.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reactions (ReactionConnection!)

    A list of Reactions left on the Issue.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    content (ReactionContent)

    \n

    Allows filtering Reactions by emoji.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (ReactionOrder)

    \n

    Allows specifying the order in which reactions are returned.

    \n\n
    \n\n
    \n\n\n

    repository (Repository!)

    The repository associated with this node.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    revertResourcePath (URI!)

    The HTTP path for reverting this pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    revertUrl (URI!)

    The HTTP URL for reverting this pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reviewDecision (PullRequestReviewDecision)

    The current status of this pull request with respect to code review.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reviewRequests (ReviewRequestConnection)

    A list of review requests associated with the pull request.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    reviewThreads (PullRequestReviewThreadConnection!)

    The list of all review threads for this pull request.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    reviews (PullRequestReviewConnection)

    A list of reviews associated with the pull request.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    author (String)

    \n

    Filter by author of the review.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    states ([PullRequestReviewState!])

    \n

    A list of states to filter the reviews.

    \n\n
    \n\n
    \n\n\n

    state (PullRequestState!)

    Identifies the state of the pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    suggestedReviewers ([SuggestedReviewer]!)

    A list of reviewer suggestions based on commit history and past review comments.

    \n\n\n\n\n\n\n\n\n\n\n\n

    timeline (PullRequestTimelineConnection!)

    A list of events, comments, commits, etc. associated with the pull request.

    \n\n\n\n\n\n\n
    \n

    Deprecation notice

    \n

    timeline is deprecated.

    timeline will be removed Use PullRequest.timelineItems instead. Removal on 2020-10-01 UTC.

    \n
    \n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    since (DateTime)

    \n

    Allows filtering timeline events by a since timestamp.

    \n\n
    \n\n
    \n\n\n

    timelineItems (PullRequestTimelineItemsConnection!)

    A list of events, comments, commits, etc. associated with the pull request.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    itemTypes ([PullRequestTimelineItemsItemType!])

    \n

    Filter timeline items by type.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    since (DateTime)

    \n

    Filter timeline items by a since timestamp.

    \n\n
    \n\n
    \n

    skip (Int)

    \n

    Skips the first n elements in the list.

    \n\n
    \n\n
    \n\n\n

    title (String!)

    Identifies the pull request title.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userContentEdits (UserContentEditConnection)

    A list of edits to this content.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    viewerCanApplySuggestion (Boolean!)

    Whether or not the viewer can apply suggestion.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanDeleteHeadRef (Boolean!)

    Check if the viewer can restore the deleted head ref.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanDisableAutoMerge (Boolean!)

    Whether or not the viewer can disable auto-merge.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanEnableAutoMerge (Boolean!)

    Whether or not the viewer can enable auto-merge.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanReact (Boolean!)

    Can user react to this subject.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanSubscribe (Boolean!)

    Check if the viewer is able to change their subscription status for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanUpdate (Boolean!)

    Check if the current viewer can update this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

    Reasons why the current viewer can not update this comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerDidAuthor (Boolean!)

    Did the viewer author this comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerMergeBodyText (String!)

    The merge body text for the viewer and method.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    mergeType (PullRequestMergeMethod)

    \n

    The merge method for the message.

    \n\n
    \n\n
    \n\n\n

    viewerMergeHeadlineText (String!)

    The merge headline text for the viewer and method.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    mergeType (PullRequestMergeMethod)

    \n

    The merge method for the message.

    \n\n
    \n\n
    \n\n\n

    viewerSubscription (SubscriptionState)

    Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestChangedFile\n

    \n

    A file changed in a pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    additions (Int!)

    The number of additions to the file.

    \n\n\n\n\n\n\n\n\n\n\n\n

    deletions (Int!)

    The number of deletions to the file.

    \n\n\n\n\n\n\n\n\n\n\n\n

    path (String!)

    The path of the file.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerViewedState (FileViewedState!)

    The state of the file for the viewer.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestChangedFileConnection\n

    \n

    The connection type for PullRequestChangedFile.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([PullRequestChangedFileEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([PullRequestChangedFile])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestChangedFileEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (PullRequestChangedFile)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestCommit\n

    \n

    Represents a Git commit part of a pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    commit (Commit!)

    The Git commit object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    The pull request this commit belongs to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this pull request commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this pull request commit.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestCommitCommentThread\n

    \n

    Represents a commit comment thread part of a pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    comments (CommitCommentConnection!)

    The comments that exist in this thread.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    commit (Commit!)

    The commit the comments were made on.

    \n\n\n\n\n\n\n\n\n\n\n\n

    path (String)

    The file the comments were made on.

    \n\n\n\n\n\n\n\n\n\n\n\n

    position (Int)

    The position in the diff for the commit that the comment was made on.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    The pull request this commit comment thread belongs to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository!)

    The repository associated with this node.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestCommitConnection\n

    \n

    The connection type for PullRequestCommit.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([PullRequestCommitEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([PullRequestCommit])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestCommitEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (PullRequestCommit)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestConnection\n

    \n

    The connection type for PullRequest.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([PullRequestEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([PullRequest])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestContributionsByRepository\n

    \n

    This aggregates pull requests opened by a user within one repository.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    contributions (CreatedPullRequestContributionConnection!)

    The pull request contributions.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (ContributionOrder)

    \n

    Ordering options for contributions returned from the connection.

    \n\n
    \n\n
    \n\n\n

    repository (Repository!)

    The repository in which the pull requests were opened.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (PullRequest)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestReview\n

    \n

    A review object for a given pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    author (Actor)

    The actor who authored the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    authorAssociation (CommentAuthorAssociation!)

    Author's association with the subject of the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    authorCanPushToRepository (Boolean!)

    Indicates whether the author of this review has push access to the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    body (String!)

    Identifies the pull request review body.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyHTML (HTML!)

    The body rendered to HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyText (String!)

    The body of this review rendered as plain text.

    \n\n\n\n\n\n\n\n\n\n\n\n

    comments (PullRequestReviewCommentConnection!)

    A list of review comments for the current pull request review.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    commit (Commit)

    Identifies the commit associated with this pull request review.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdViaEmail (Boolean!)

    Check if this comment was created via an email reply.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    editor (Actor)

    The actor who edited the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    includesCreatedEdit (Boolean!)

    Check if this comment was edited and includes an edit with the creation data.

    \n\n\n\n\n\n\n\n\n\n\n\n

    lastEditedAt (DateTime)

    The moment the editor made the last edit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    onBehalfOf (TeamConnection!)

    A list of teams that this review was made on behalf of.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    publishedAt (DateTime)

    Identifies when the comment was published at.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    Identifies the pull request associated with this pull request review.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reactionGroups ([ReactionGroup!])

    A list of reactions grouped by content left on the subject.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reactions (ReactionConnection!)

    A list of Reactions left on the Issue.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    content (ReactionContent)

    \n

    Allows filtering Reactions by emoji.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (ReactionOrder)

    \n

    Allows specifying the order in which reactions are returned.

    \n\n
    \n\n
    \n\n\n

    repository (Repository!)

    The repository associated with this node.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path permalink for this PullRequestReview.

    \n\n\n\n\n\n\n\n\n\n\n\n

    state (PullRequestReviewState!)

    Identifies the current state of the pull request review.

    \n\n\n\n\n\n\n\n\n\n\n\n

    submittedAt (DateTime)

    Identifies when the Pull Request Review was submitted.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL permalink for this PullRequestReview.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userContentEdits (UserContentEditConnection)

    A list of edits to this content.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    viewerCanDelete (Boolean!)

    Check if the current viewer can delete this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanReact (Boolean!)

    Can user react to this subject.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanUpdate (Boolean!)

    Check if the current viewer can update this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

    Reasons why the current viewer can not update this comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerDidAuthor (Boolean!)

    Did the viewer author this comment.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestReviewComment\n

    \n

    A review comment associated with a given repository pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    author (Actor)

    The actor who authored the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    authorAssociation (CommentAuthorAssociation!)

    Author's association with the subject of the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    body (String!)

    The comment body of this review comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyHTML (HTML!)

    The body rendered to HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyText (String!)

    The comment body of this review comment rendered as plain text.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commit (Commit)

    Identifies the commit associated with the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies when the comment was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdViaEmail (Boolean!)

    Check if this comment was created via an email reply.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    diffHunk (String!)

    The diff hunk to which the comment applies.

    \n\n\n\n\n\n\n\n\n\n\n\n

    draftedAt (DateTime!)

    Identifies when the comment was created in a draft state.

    \n\n\n\n\n\n\n\n\n\n\n\n

    editor (Actor)

    The actor who edited the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    includesCreatedEdit (Boolean!)

    Check if this comment was edited and includes an edit with the creation data.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isMinimized (Boolean!)

    Returns whether or not a comment has been minimized.

    \n\n\n\n\n\n\n\n\n\n\n\n

    lastEditedAt (DateTime)

    The moment the editor made the last edit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    minimizedReason (String)

    Returns why the comment was minimized.

    \n\n\n\n\n\n\n\n\n\n\n\n

    originalCommit (Commit)

    Identifies the original commit associated with the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    originalPosition (Int!)

    The original line index in the diff to which the comment applies.

    \n\n\n\n\n\n\n\n\n\n\n\n

    outdated (Boolean!)

    Identifies when the comment body is outdated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    path (String!)

    The path to which the comment applies.

    \n\n\n\n\n\n\n\n\n\n\n\n

    position (Int)

    The line index in the diff to which the comment applies.

    \n\n\n\n\n\n\n\n\n\n\n\n

    publishedAt (DateTime)

    Identifies when the comment was published at.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    The pull request associated with this review comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestReview (PullRequestReview)

    The pull request review associated with this review comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reactionGroups ([ReactionGroup!])

    A list of reactions grouped by content left on the subject.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reactions (ReactionConnection!)

    A list of Reactions left on the Issue.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    content (ReactionContent)

    \n

    Allows filtering Reactions by emoji.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (ReactionOrder)

    \n

    Allows specifying the order in which reactions are returned.

    \n\n
    \n\n
    \n\n\n

    replyTo (PullRequestReviewComment)

    The comment this is a reply to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository!)

    The repository associated with this node.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path permalink for this review comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    state (PullRequestReviewCommentState!)

    Identifies the state of the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies when the comment was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL permalink for this review comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userContentEdits (UserContentEditConnection)

    A list of edits to this content.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    viewerCanDelete (Boolean!)

    Check if the current viewer can delete this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanMinimize (Boolean!)

    Check if the current viewer can minimize this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanReact (Boolean!)

    Can user react to this subject.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanUpdate (Boolean!)

    Check if the current viewer can update this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

    Reasons why the current viewer can not update this comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerDidAuthor (Boolean!)

    Did the viewer author this comment.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestReviewCommentConnection\n

    \n

    The connection type for PullRequestReviewComment.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([PullRequestReviewCommentEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([PullRequestReviewComment])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestReviewCommentEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (PullRequestReviewComment)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestReviewConnection\n

    \n

    The connection type for PullRequestReview.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([PullRequestReviewEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([PullRequestReview])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestReviewContributionsByRepository\n

    \n

    This aggregates pull request reviews made by a user within one repository.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    contributions (CreatedPullRequestReviewContributionConnection!)

    The pull request review contributions.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (ContributionOrder)

    \n

    Ordering options for contributions returned from the connection.

    \n\n
    \n\n
    \n\n\n

    repository (Repository!)

    The repository in which the pull request reviews were made.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestReviewEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (PullRequestReview)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestReviewThread\n

    \n

    A threaded list of comments for a given pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    comments (PullRequestReviewCommentConnection!)

    A list of pull request comments associated with the thread.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    skip (Int)

    \n

    Skips the first n elements in the list.

    \n\n
    \n\n
    \n\n\n

    diffSide (DiffSide!)

    The side of the diff on which this thread was placed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isCollapsed (Boolean!)

    Whether or not the thread has been collapsed (outdated or resolved).

    \n\n\n\n\n\n\n\n\n\n\n\n

    isOutdated (Boolean!)

    Indicates whether this thread was outdated by newer changes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isResolved (Boolean!)

    Whether this thread has been resolved.

    \n\n\n\n\n\n\n\n\n\n\n\n

    line (Int)

    The line in the file to which this thread refers.

    \n\n\n\n\n\n\n\n\n\n\n\n

    originalLine (Int)

    The original line in the file to which this thread refers.

    \n\n\n\n\n\n\n\n\n\n\n\n

    originalStartLine (Int)

    The original start line in the file to which this thread refers (multi-line only).

    \n\n\n\n\n\n\n\n\n\n\n\n

    path (String!)

    Identifies the file path of this thread.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    Identifies the pull request associated with this thread.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository!)

    Identifies the repository associated with this thread.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resolvedBy (User)

    The user who resolved this thread.

    \n\n\n\n\n\n\n\n\n\n\n\n

    startDiffSide (DiffSide)

    The side of the diff that the first line of the thread starts on (multi-line only).

    \n\n\n\n\n\n\n\n\n\n\n\n

    startLine (Int)

    The start line in the file to which this thread refers (multi-line only).

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanReply (Boolean!)

    Indicates whether the current viewer can reply to this thread.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanResolve (Boolean!)

    Whether or not the viewer can resolve this thread.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanUnresolve (Boolean!)

    Whether or not the viewer can unresolve this thread.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestReviewThreadConnection\n

    \n

    Review comment threads for a pull request review.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([PullRequestReviewThreadEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([PullRequestReviewThread])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestReviewThreadEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (PullRequestReviewThread)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestRevisionMarker\n

    \n

    Represents the latest point in the pull request timeline for which the viewer has seen the pull request's commits.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    lastSeenCommit (Commit!)

    The last commit the viewer has seen.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    The pull request to which the marker belongs.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestTimelineConnection\n

    \n

    The connection type for PullRequestTimelineItem.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([PullRequestTimelineItemEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([PullRequestTimelineItem])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestTimelineItemEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (PullRequestTimelineItem)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestTimelineItemsConnection\n

    \n

    The connection type for PullRequestTimelineItems.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([PullRequestTimelineItemsEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    filteredCount (Int!)

    Identifies the count of items after applying before and after filters.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([PullRequestTimelineItems])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageCount (Int!)

    Identifies the count of items after applying before/after filters and first/last/skip slicing.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the timeline was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestTimelineItemsEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (PullRequestTimelineItems)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Push\n

    \n

    A Git push.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    nextSha (GitObjectID)

    The SHA after the push.

    \n\n\n\n\n\n\n\n\n\n\n\n

    permalink (URI!)

    The permalink for this push.

    \n\n\n\n\n\n\n\n\n\n\n\n

    previousSha (GitObjectID)

    The SHA before the push.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pusher (User!)

    The user who pushed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository!)

    The repository that was pushed to.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PushAllowance\n

    \n

    A team, user or app who has the ability to push to a protected branch.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (PushAllowanceActor)

    The actor that can push.

    \n\n\n\n\n\n\n\n\n\n\n\n

    branchProtectionRule (BranchProtectionRule)

    Identifies the branch protection rule associated with the allowed user or team.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PushAllowanceConnection\n

    \n

    The connection type for PushAllowance.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([PushAllowanceEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([PushAllowance])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PushAllowanceEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (PushAllowance)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RateLimit\n

    \n

    Represents the client's rate limit.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cost (Int!)

    The point cost for the current query counting against the rate limit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    limit (Int!)

    The maximum number of points the client is permitted to consume in a 60 minute window.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodeCount (Int!)

    The maximum number of nodes this query may return.

    \n\n\n\n\n\n\n\n\n\n\n\n

    remaining (Int!)

    The number of points remaining in the current rate limit window.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resetAt (DateTime!)

    The time at which the current rate limit window resets in UTC epoch seconds.

    \n\n\n\n\n\n\n\n\n\n\n\n

    used (Int!)

    The number of points used in the current rate limit window.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReactingUserConnection\n

    \n

    The connection type for User.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([ReactingUserEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([User])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReactingUserEdge\n

    \n

    Represents a user that's made a reaction.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reactedAt (DateTime!)

    The moment when the user made the reaction.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Reaction\n

    \n

    An emoji reaction to a particular piece of content.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    content (ReactionContent!)

    Identifies the emoji reaction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reactable (Reactable!)

    The reactable piece of content.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    Identifies the user who created this reaction.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReactionConnection\n

    \n

    A list of reactions that have been left on the subject.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([ReactionEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Reaction])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerHasReacted (Boolean!)

    Whether or not the authenticated user has left a reaction on the subject.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReactionEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (Reaction)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReactionGroup\n

    \n

    A group of emoji reactions to a particular piece of content.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    content (ReactionContent!)

    Identifies the emoji reaction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime)

    Identifies when the reaction was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    subject (Reactable!)

    The subject that was reacted to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    users (ReactingUserConnection!)

    Users who have reacted to the reaction subject with the emotion represented by this reaction group.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    viewerHasReacted (Boolean!)

    Whether or not the authenticated user has left a reaction on the subject.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReadyForReviewEvent\n

    \n

    Represents aready_for_reviewevent on a given pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    PullRequest referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this ready for review event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this ready for review event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Ref\n

    \n

    Represents a Git reference.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    associatedPullRequests (PullRequestConnection!)

    A list of pull requests with this ref as the head ref.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    baseRefName (String)

    \n

    The base ref name to filter the pull requests by.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    headRefName (String)

    \n

    The head ref name to filter the pull requests by.

    \n\n
    \n\n
    \n

    labels ([String!])

    \n

    A list of label names to filter the pull requests by.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (IssueOrder)

    \n

    Ordering options for pull requests returned from the connection.

    \n\n
    \n\n
    \n

    states ([PullRequestState!])

    \n

    A list of states to filter the pull requests by.

    \n\n
    \n\n
    \n\n\n

    branchProtectionRule (BranchProtectionRule)

    Branch protection rules for this ref.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The ref name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    prefix (String!)

    The ref's prefix, such as refs/heads/ or refs/tags/.

    \n\n\n\n\n\n\n\n\n\n\n\n

    refUpdateRule (RefUpdateRule)

    Branch protection rules that are viewable by non-admins.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository!)

    The repository the ref belongs to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    target (GitObject)

    The object the ref points to. Returns null when object does not exist.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RefConnection\n

    \n

    The connection type for Ref.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([RefEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Ref])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RefEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (Ref)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RefUpdateRule\n

    \n

    A ref update rules for a viewer.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    allowsDeletions (Boolean!)

    Can this branch be deleted.

    \n\n\n\n\n\n\n\n\n\n\n\n

    allowsForcePushes (Boolean!)

    Are force pushes allowed on this branch.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pattern (String!)

    Identifies the protection rule pattern.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiredApprovingReviewCount (Int)

    Number of approving reviews required to update matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiredStatusCheckContexts ([String])

    List of required status check contexts that must pass for commits to be accepted to matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiresLinearHistory (Boolean!)

    Are merge commits prohibited from being pushed to this branch.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiresSignatures (Boolean!)

    Are commits required to be signed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanPush (Boolean!)

    Can the viewer push to the branch.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReferencedEvent\n

    \n

    Represents areferencedevent on a given ReferencedSubject.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commit (Commit)

    Identifies the commit associated with thereferencedevent.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commitRepository (Repository!)

    Identifies the repository associated with thereferencedevent.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isCrossRepository (Boolean!)

    Reference originated in a different repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isDirectReference (Boolean!)

    Checks if the commit message itself references the subject. Can be false in the case of a commit comment reference.

    \n\n\n\n\n\n\n\n\n\n\n\n

    subject (ReferencedSubject!)

    Object referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Release\n

    \n

    A release contains the content for a release.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    author (User)

    The author of the release.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String)

    The description of the release.

    \n\n\n\n\n\n\n\n\n\n\n\n

    descriptionHTML (HTML)

    The description of this release rendered to HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isDraft (Boolean!)

    Whether or not the release is a draft.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isLatest (Boolean!)

    Whether or not the release is the latest releast.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isPrerelease (Boolean!)

    Whether or not the release is a prerelease.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String)

    The title of the release.

    \n\n\n\n\n\n\n\n\n\n\n\n

    publishedAt (DateTime)

    Identifies the date and time when the release was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    releaseAssets (ReleaseAssetConnection!)

    List of releases assets which are dependent on this release.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    name (String)

    \n

    A list of names to filter the assets by.

    \n\n
    \n\n
    \n\n\n

    repository (Repository!)

    The repository that the release belongs to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this issue.

    \n\n\n\n\n\n\n\n\n\n\n\n

    shortDescriptionHTML (HTML)

    A description of the release, rendered to HTML without any links in it.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    limit (Int)

    \n

    How many characters to return.

    \n

    The default value is 200.

    \n
    \n\n
    \n\n\n

    tag (Ref)

    The Git tag the release points to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    tagCommit (Commit)

    The tag commit for this release.

    \n\n\n\n\n\n\n\n\n\n\n\n

    tagName (String!)

    The name of the release's Git tag.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this issue.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReleaseAsset\n

    \n

    A release asset contains the content for a release asset.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    contentType (String!)

    The asset's content-type.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    downloadCount (Int!)

    The number of times this asset was downloaded.

    \n\n\n\n\n\n\n\n\n\n\n\n

    downloadUrl (URI!)

    Identifies the URL where you can download the release asset via the browser.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    Identifies the title of the release asset.

    \n\n\n\n\n\n\n\n\n\n\n\n

    release (Release)

    Release that the asset is associated with.

    \n\n\n\n\n\n\n\n\n\n\n\n

    size (Int!)

    The size (in bytes) of the asset.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    uploadedBy (User!)

    The user that performed the upload.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    Identifies the URL of the release asset.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReleaseAssetConnection\n

    \n

    The connection type for ReleaseAsset.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([ReleaseAssetEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([ReleaseAsset])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReleaseAssetEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (ReleaseAsset)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReleaseConnection\n

    \n

    The connection type for Release.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([ReleaseEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Release])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReleaseEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (Release)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RemovedFromProjectEvent\n

    \n

    Represents aremoved_from_projectevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    project (Project)

    Project referenced by event.

    \n\n\n\n\n
    \n

    Preview notice

    \n

    project is available under the Project event details preview. During the preview period, the API may change without notice.

    \n
    \n\n\n\n\n\n\n\n\n

    projectColumnName (String!)

    Column name referenced by this project event.

    \n\n\n\n\n
    \n

    Preview notice

    \n

    projectColumnName is available under the Project event details preview. During the preview period, the API may change without notice.

    \n
    \n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RenamedTitleEvent\n

    \n

    Represents arenamedevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    currentTitle (String!)

    Identifies the current title of the issue or pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    previousTitle (String!)

    Identifies the previous title of the issue or pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    subject (RenamedTitleSubject!)

    Subject that was renamed.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReopenedEvent\n

    \n

    Represents areopenedevent on any Closable.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    closable (Closable!)

    Object that was reopened.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepoAccessAuditEntry\n

    \n

    Audit log entry for a repo.access event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    visibility (RepoAccessAuditEntryVisibility)

    The visibility of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepoAddMemberAuditEntry\n

    \n

    Audit log entry for a repo.add_member event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    visibility (RepoAddMemberAuditEntryVisibility)

    The visibility of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepoAddTopicAuditEntry\n

    \n

    Audit log entry for a repo.add_topic event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    topic (Topic)

    The name of the topic added to the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    topicName (String)

    The name of the topic added to the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepoArchivedAuditEntry\n

    \n

    Audit log entry for a repo.archived event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    visibility (RepoArchivedAuditEntryVisibility)

    The visibility of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepoChangeMergeSettingAuditEntry\n

    \n

    Audit log entry for a repo.change_merge_setting event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isEnabled (Boolean)

    Whether the change was to enable (true) or disable (false) the merge type.

    \n\n\n\n\n\n\n\n\n\n\n\n

    mergeType (RepoChangeMergeSettingAuditEntryMergeType)

    The merge method affected by the change.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepoConfigDisableAnonymousGitAccessAuditEntry\n

    \n

    Audit log entry for a repo.config.disable_anonymous_git_access event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepoConfigDisableCollaboratorsOnlyAuditEntry\n

    \n

    Audit log entry for a repo.config.disable_collaborators_only event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepoConfigDisableContributorsOnlyAuditEntry\n

    \n

    Audit log entry for a repo.config.disable_contributors_only event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepoConfigDisableSockpuppetDisallowedAuditEntry\n

    \n

    Audit log entry for a repo.config.disable_sockpuppet_disallowed event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepoConfigEnableAnonymousGitAccessAuditEntry\n

    \n

    Audit log entry for a repo.config.enable_anonymous_git_access event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepoConfigEnableCollaboratorsOnlyAuditEntry\n

    \n

    Audit log entry for a repo.config.enable_collaborators_only event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepoConfigEnableContributorsOnlyAuditEntry\n

    \n

    Audit log entry for a repo.config.enable_contributors_only event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepoConfigEnableSockpuppetDisallowedAuditEntry\n

    \n

    Audit log entry for a repo.config.enable_sockpuppet_disallowed event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepoConfigLockAnonymousGitAccessAuditEntry\n

    \n

    Audit log entry for a repo.config.lock_anonymous_git_access event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepoConfigUnlockAnonymousGitAccessAuditEntry\n

    \n

    Audit log entry for a repo.config.unlock_anonymous_git_access event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepoCreateAuditEntry\n

    \n

    Audit log entry for a repo.create event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    forkParentName (String)

    The name of the parent repository for this forked repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    forkSourceName (String)

    The name of the root repository for this network.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    visibility (RepoCreateAuditEntryVisibility)

    The visibility of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepoDestroyAuditEntry\n

    \n

    Audit log entry for a repo.destroy event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    visibility (RepoDestroyAuditEntryVisibility)

    The visibility of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepoRemoveMemberAuditEntry\n

    \n

    Audit log entry for a repo.remove_member event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    visibility (RepoRemoveMemberAuditEntryVisibility)

    The visibility of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepoRemoveTopicAuditEntry\n

    \n

    Audit log entry for a repo.remove_topic event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    topic (Topic)

    The name of the topic added to the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    topicName (String)

    The name of the topic added to the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Repository\n

    \n

    A repository contains the content for a project.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    assignableUsers (UserConnection!)

    A list of users that can be assigned to issues in this repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    query (String)

    \n

    Filters users with query on user name and login.

    \n\n
    \n\n
    \n\n\n

    branchProtectionRules (BranchProtectionRuleConnection!)

    A list of branch protection rules for this repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    codeOfConduct (CodeOfConduct)

    Returns the code of conduct for this repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    collaborators (RepositoryCollaboratorConnection)

    A list of collaborators associated with the repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    affiliation (CollaboratorAffiliation)

    \n

    Collaborators affiliation level with a repository.

    \n\n
    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    query (String)

    \n

    Filters users with query on user name and login.

    \n\n
    \n\n
    \n\n\n

    commitComments (CommitCommentConnection!)

    A list of commit comments associated with the repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    contactLinks ([RepositoryContactLink!])

    Returns a list of contact links associated to the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    defaultBranchRef (Ref)

    The Ref associated with the repository's default branch.

    \n\n\n\n\n\n\n\n\n\n\n\n

    deleteBranchOnMerge (Boolean!)

    Whether or not branches are automatically deleted when merged in this repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    dependencyGraphManifests (DependencyGraphManifestConnection)

    A list of dependency manifests contained in the repository.

    \n\n\n\n\n
    \n

    Preview notice

    \n

    dependencyGraphManifests is available under the Access to a repositories dependency graph preview. During the preview period, the API may change without notice.

    \n
    \n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    dependenciesAfter (String)

    \n

    Cursor to paginate dependencies.

    \n\n
    \n\n
    \n

    dependenciesFirst (Int)

    \n

    Number of dependencies to fetch.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    withDependencies (Boolean)

    \n

    Flag to scope to only manifests with dependencies.

    \n\n
    \n\n
    \n\n\n

    deployKeys (DeployKeyConnection!)

    A list of deploy keys that are on this repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    deployments (DeploymentConnection!)

    Deployments associated with the repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    environments ([String!])

    \n

    Environments to list deployments for.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (DeploymentOrder)

    \n

    Ordering options for deployments returned from the connection.

    \n\n
    \n\n
    \n\n\n

    description (String)

    The description of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    descriptionHTML (HTML!)

    The description of the repository rendered to HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    diskUsage (Int)

    The number of kilobytes this repository occupies on disk.

    \n\n\n\n\n\n\n\n\n\n\n\n

    forkCount (Int!)

    Returns how many forks there are of this repository in the whole network.

    \n\n\n\n\n\n\n\n\n\n\n\n

    forks (RepositoryConnection!)

    A list of direct forked repositories.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    affiliations ([RepositoryAffiliation])

    \n

    Array of viewer's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\ncurrent viewer owns.

    \n\n
    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    isLocked (Boolean)

    \n

    If non-null, filters repositories according to whether they have been locked.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (RepositoryOrder)

    \n

    Ordering options for repositories returned from the connection.

    \n\n
    \n\n
    \n

    ownerAffiliations ([RepositoryAffiliation])

    \n

    Array of owner's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\norganization or user being viewed owns.

    \n\n
    \n\n
    \n

    privacy (RepositoryPrivacy)

    \n

    If non-null, filters repositories according to privacy.

    \n\n
    \n\n
    \n\n\n

    fundingLinks ([FundingLink!]!)

    The funding links for this repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hasIssuesEnabled (Boolean!)

    Indicates if the repository has issues feature enabled.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hasProjectsEnabled (Boolean!)

    Indicates if the repository has the Projects feature enabled.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hasWikiEnabled (Boolean!)

    Indicates if the repository has wiki feature enabled.

    \n\n\n\n\n\n\n\n\n\n\n\n

    homepageUrl (URI)

    The repository's URL.

    \n\n\n\n\n\n\n\n\n\n\n\n

    interactionAbility (RepositoryInteractionAbility)

    The interaction ability settings for this repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isArchived (Boolean!)

    Indicates if the repository is unmaintained.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isBlankIssuesEnabled (Boolean!)

    Returns true if blank issue creation is allowed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isDisabled (Boolean!)

    Returns whether or not this repository disabled.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isEmpty (Boolean!)

    Returns whether or not this repository is empty.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isFork (Boolean!)

    Identifies if the repository is a fork.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isInOrganization (Boolean!)

    Indicates if a repository is either owned by an organization, or is a private fork of an organization repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isLocked (Boolean!)

    Indicates if the repository has been locked or not.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isMirror (Boolean!)

    Identifies if the repository is a mirror.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isPrivate (Boolean!)

    Identifies if the repository is private.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isSecurityPolicyEnabled (Boolean)

    Returns true if this repository has a security policy.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isTemplate (Boolean!)

    Identifies if the repository is a template that can be used to generate new repositories.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isUserConfigurationRepository (Boolean!)

    Is this repository a user configuration repository?.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issue (Issue)

    Returns a single issue from the current repository by number.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    number (Int!)

    \n

    The number for the issue to be returned.

    \n\n
    \n\n
    \n\n\n

    issueOrPullRequest (IssueOrPullRequest)

    Returns a single issue-like object from the current repository by number.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    number (Int!)

    \n

    The number for the issue to be returned.

    \n\n
    \n\n
    \n\n\n

    issueTemplates ([IssueTemplate!])

    Returns a list of issue templates associated to the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issues (IssueConnection!)

    A list of issues that have been opened in the repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    filterBy (IssueFilters)

    \n

    Filtering options for issues returned from the connection.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    labels ([String!])

    \n

    A list of label names to filter the pull requests by.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (IssueOrder)

    \n

    Ordering options for issues returned from the connection.

    \n\n
    \n\n
    \n

    states ([IssueState!])

    \n

    A list of states to filter the issues by.

    \n\n
    \n\n
    \n\n\n

    label (Label)

    Returns a single label by name.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    name (String!)

    \n

    Label name.

    \n\n
    \n\n
    \n\n\n

    labels (LabelConnection)

    A list of labels associated with the repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (LabelOrder)

    \n

    Ordering options for labels returned from the connection.

    \n\n
    \n\n
    \n

    query (String)

    \n

    If provided, searches labels by name and description.

    \n\n
    \n\n
    \n\n\n

    languages (LanguageConnection)

    A list containing a breakdown of the language composition of the repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (LanguageOrder)

    \n

    Order for connection.

    \n\n
    \n\n
    \n\n\n

    latestRelease (Release)

    Get the latest release for the repository if one exists.

    \n\n\n\n\n\n\n\n\n\n\n\n

    licenseInfo (License)

    The license associated with the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    lockReason (RepositoryLockReason)

    The reason the repository has been locked.

    \n\n\n\n\n\n\n\n\n\n\n\n

    mentionableUsers (UserConnection!)

    A list of Users that can be mentioned in the context of the repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    query (String)

    \n

    Filters users with query on user name and login.

    \n\n
    \n\n
    \n\n\n

    mergeCommitAllowed (Boolean!)

    Whether or not PRs are merged with a merge commit on this repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    milestone (Milestone)

    Returns a single milestone from the current repository by number.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    number (Int!)

    \n

    The number for the milestone to be returned.

    \n\n
    \n\n
    \n\n\n

    milestones (MilestoneConnection)

    A list of milestones associated with the repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (MilestoneOrder)

    \n

    Ordering options for milestones.

    \n\n
    \n\n
    \n

    query (String)

    \n

    Filters milestones with a query on the title.

    \n\n
    \n\n
    \n

    states ([MilestoneState!])

    \n

    Filter by the state of the milestones.

    \n\n
    \n\n
    \n\n\n

    mirrorUrl (URI)

    The repository's original mirror URL.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nameWithOwner (String!)

    The repository's name with owner.

    \n\n\n\n\n\n\n\n\n\n\n\n

    object (GitObject)

    A Git object in the repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    expression (String)

    \n

    A Git revision expression suitable for rev-parse.

    \n\n
    \n\n
    \n

    oid (GitObjectID)

    \n

    The Git object ID.

    \n\n
    \n\n
    \n\n\n

    openGraphImageUrl (URI!)

    The image used to represent this repository in Open Graph data.

    \n\n\n\n\n\n\n\n\n\n\n\n

    owner (RepositoryOwner!)

    The User owner of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    packages (PackageConnection!)

    A list of packages under the owner.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    names ([String])

    \n

    Find packages by their names.

    \n\n
    \n\n
    \n

    orderBy (PackageOrder)

    \n

    Ordering of the returned packages.

    \n\n
    \n\n
    \n

    packageType (PackageType)

    \n

    Filter registry package by type.

    \n\n
    \n\n
    \n

    repositoryId (ID)

    \n

    Find packages in a repository by ID.

    \n\n
    \n\n
    \n\n\n

    parent (Repository)

    The repository parent, if this is a fork.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pinnedIssues (PinnedIssueConnection)

    A list of pinned issues for this repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    primaryLanguage (Language)

    The primary language of the repository's code.

    \n\n\n\n\n\n\n\n\n\n\n\n

    project (Project)

    Find project by number.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    number (Int!)

    \n

    The project number to find.

    \n\n
    \n\n
    \n\n\n

    projects (ProjectConnection!)

    A list of projects under the owner.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (ProjectOrder)

    \n

    Ordering options for projects returned from the connection.

    \n\n
    \n\n
    \n

    search (String)

    \n

    Query to search projects by, currently only searching by name.

    \n\n
    \n\n
    \n

    states ([ProjectState!])

    \n

    A list of states to filter the projects by.

    \n\n
    \n\n
    \n\n\n

    projectsResourcePath (URI!)

    The HTTP path listing the repository's projects.

    \n\n\n\n\n\n\n\n\n\n\n\n

    projectsUrl (URI!)

    The HTTP URL listing the repository's projects.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest)

    Returns a single pull request from the current repository by number.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    number (Int!)

    \n

    The number for the pull request to be returned.

    \n\n
    \n\n
    \n\n\n

    pullRequests (PullRequestConnection!)

    A list of pull requests that have been opened in the repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    baseRefName (String)

    \n

    The base ref name to filter the pull requests by.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    headRefName (String)

    \n

    The head ref name to filter the pull requests by.

    \n\n
    \n\n
    \n

    labels ([String!])

    \n

    A list of label names to filter the pull requests by.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (IssueOrder)

    \n

    Ordering options for pull requests returned from the connection.

    \n\n
    \n\n
    \n

    states ([PullRequestState!])

    \n

    A list of states to filter the pull requests by.

    \n\n
    \n\n
    \n\n\n

    pushedAt (DateTime)

    Identifies when the repository was last pushed to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    rebaseMergeAllowed (Boolean!)

    Whether or not rebase-merging is enabled on this repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ref (Ref)

    Fetch a given ref from the repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    qualifiedName (String!)

    \n

    The ref to retrieve. Fully qualified matches are checked in order\n(refs/heads/master) before falling back onto checks for short name matches (master).

    \n\n
    \n\n
    \n\n\n

    refs (RefConnection)

    Fetch a list of refs from the repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    direction (OrderDirection)

    \n

    DEPRECATED: use orderBy. The ordering direction.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (RefOrder)

    \n

    Ordering options for refs returned from the connection.

    \n\n
    \n\n
    \n

    query (String)

    \n

    Filters refs with query on name.

    \n\n
    \n\n
    \n

    refPrefix (String!)

    \n

    A ref name prefix like refs/heads/, refs/tags/, etc.

    \n\n
    \n\n
    \n\n\n

    release (Release)

    Lookup a single release given various criteria.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    tagName (String!)

    \n

    The name of the Tag the Release was created from.

    \n\n
    \n\n
    \n\n\n

    releases (ReleaseConnection!)

    List of releases which are dependent on this repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (ReleaseOrder)

    \n

    Order for connection.

    \n\n
    \n\n
    \n\n\n

    repositoryTopics (RepositoryTopicConnection!)

    A list of applied repository-topic associations for this repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    resourcePath (URI!)

    The HTTP path for this repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    securityPolicyUrl (URI)

    The security policy URL.

    \n\n\n\n\n\n\n\n\n\n\n\n

    shortDescriptionHTML (HTML!)

    A description of the repository, rendered to HTML without any links in it.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    limit (Int)

    \n

    How many characters to return.

    \n

    The default value is 200.

    \n
    \n\n
    \n\n\n

    squashMergeAllowed (Boolean!)

    Whether or not squash-merging is enabled on this repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    sshUrl (GitSSHRemote!)

    The SSH URL to clone this repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    stargazerCount (Int!)

    Returns a count of how many stargazers there are on this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    stargazers (StargazerConnection!)

    A list of users who have starred this starrable.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (StarOrder)

    \n

    Order for connection.

    \n\n
    \n\n
    \n\n\n

    submodules (SubmoduleConnection!)

    Returns a list of all submodules in this repository parsed from the\n.gitmodules file as of the default branch's HEAD commit.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    tempCloneToken (String)

    Temporary authentication token for cloning this repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    templateRepository (Repository)

    The repository from which this repository was generated, if any.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    usesCustomOpenGraphImage (Boolean!)

    Whether this repository has a custom image to use with Open Graph as opposed to being represented by the owner's avatar.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanAdminister (Boolean!)

    Indicates whether the viewer has admin permissions on this repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanCreateProjects (Boolean!)

    Can the current viewer create new projects on this owner.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanSubscribe (Boolean!)

    Check if the viewer is able to change their subscription status for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanUpdateTopics (Boolean!)

    Indicates whether the viewer can update the topics of this repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerDefaultCommitEmail (String)

    The last commit email for the viewer.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerDefaultMergeMethod (PullRequestMergeMethod!)

    The last used merge method by the viewer or the default for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerHasStarred (Boolean!)

    Returns a boolean indicating whether the viewing user has starred this starrable.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerPermission (RepositoryPermission)

    The users permission level on the repository. Will return null if authenticated as an GitHub App.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerPossibleCommitEmails ([String!])

    A list of emails this viewer can commit with.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerSubscription (SubscriptionState)

    Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

    \n\n\n\n\n\n\n\n\n\n\n\n

    vulnerabilityAlerts (RepositoryVulnerabilityAlertConnection)

    A list of vulnerability alerts that are on this repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    watchers (UserConnection!)

    A list of users watching the repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepositoryCollaboratorConnection\n

    \n

    The connection type for User.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([RepositoryCollaboratorEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([User])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepositoryCollaboratorEdge\n

    \n

    Represents a user who is a collaborator of a repository.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    permission (RepositoryPermission!)

    The permission the user has on the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    permissionSources ([PermissionSource!])

    A list of sources for the user's access to the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepositoryConnection\n

    \n

    A list of repositories owned by the subject.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([RepositoryEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Repository])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalDiskUsage (Int!)

    The total size in kilobytes of all repositories in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepositoryContactLink\n

    \n

    A repository contact link.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    about (String!)

    The contact link purpose.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The contact link name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The contact link URL.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepositoryEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (Repository)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepositoryInteractionAbility\n

    \n

    Repository interaction limit that applies to this object.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    expiresAt (DateTime)

    The time the currently active limit expires.

    \n\n\n\n\n\n\n\n\n\n\n\n

    limit (RepositoryInteractionLimit!)

    The current limit that is enabled on this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    origin (RepositoryInteractionLimitOrigin!)

    The origin of the currently active interaction limit.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepositoryInvitation\n

    \n

    An invitation for a user to be added to a repository.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    email (String)

    The email address that received the invitation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    invitee (User)

    The user who received the invitation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    inviter (User!)

    The user who created the invitation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    permalink (URI!)

    The permalink for this repository invitation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    permission (RepositoryPermission!)

    The permission granted on this repository by this invitation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (RepositoryInfo)

    The Repository the user is invited to.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepositoryInvitationConnection\n

    \n

    The connection type for RepositoryInvitation.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([RepositoryInvitationEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([RepositoryInvitation])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepositoryInvitationEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (RepositoryInvitation)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepositoryTopic\n

    \n

    A repository-topic connects a repository to a topic.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    resourcePath (URI!)

    The HTTP path for this repository-topic.

    \n\n\n\n\n\n\n\n\n\n\n\n

    topic (Topic!)

    The topic.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this repository-topic.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepositoryTopicConnection\n

    \n

    The connection type for RepositoryTopic.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([RepositoryTopicEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([RepositoryTopic])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepositoryTopicEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (RepositoryTopic)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepositoryVisibilityChangeDisableAuditEntry\n

    \n

    Audit log entry for a repository_visibility_change.disable event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseResourcePath (URI)

    The HTTP path for this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseSlug (String)

    The slug of the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseUrl (URI)

    The HTTP URL for this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepositoryVisibilityChangeEnableAuditEntry\n

    \n

    Audit log entry for a repository_visibility_change.enable event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseResourcePath (URI)

    The HTTP path for this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseSlug (String)

    The slug of the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseUrl (URI)

    The HTTP URL for this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepositoryVulnerabilityAlert\n

    \n

    A alert for a repository with an affected vulnerability.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    createdAt (DateTime!)

    When was the alert created?.

    \n\n\n\n\n\n\n\n\n\n\n\n

    dismissReason (String)

    The reason the alert was dismissed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    dismissedAt (DateTime)

    When was the alert dismissed?.

    \n\n\n\n\n\n\n\n\n\n\n\n

    dismisser (User)

    The user who dismissed the alert.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository!)

    The associated repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    securityAdvisory (SecurityAdvisory)

    The associated security advisory.

    \n\n\n\n\n\n\n\n\n\n\n\n

    securityVulnerability (SecurityVulnerability)

    The associated security vulnerability.

    \n\n\n\n\n\n\n\n\n\n\n\n

    vulnerableManifestFilename (String!)

    The vulnerable manifest filename.

    \n\n\n\n\n\n\n\n\n\n\n\n

    vulnerableManifestPath (String!)

    The vulnerable manifest path.

    \n\n\n\n\n\n\n\n\n\n\n\n

    vulnerableRequirements (String)

    The vulnerable requirements.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepositoryVulnerabilityAlertConnection\n

    \n

    The connection type for RepositoryVulnerabilityAlert.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([RepositoryVulnerabilityAlertEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([RepositoryVulnerabilityAlert])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepositoryVulnerabilityAlertEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (RepositoryVulnerabilityAlert)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RestrictedContribution\n

    \n

    Represents a private contribution a user made on GitHub.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    isRestricted (Boolean!)

    Whether this contribution is associated with a record you do not have access to. For\nexample, your own 'first issue' contribution may have been made on a repository you can no\nlonger access.

    \n\n\n\n\n\n\n\n\n\n\n\n

    occurredAt (DateTime!)

    When this contribution was made.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User!)

    The user who made this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReviewDismissalAllowance\n

    \n

    A team or user who has the ability to dismiss a review on a protected branch.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (ReviewDismissalAllowanceActor)

    The actor that can dismiss.

    \n\n\n\n\n\n\n\n\n\n\n\n

    branchProtectionRule (BranchProtectionRule)

    Identifies the branch protection rule associated with the allowed user or team.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReviewDismissalAllowanceConnection\n

    \n

    The connection type for ReviewDismissalAllowance.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([ReviewDismissalAllowanceEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([ReviewDismissalAllowance])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReviewDismissalAllowanceEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (ReviewDismissalAllowance)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReviewDismissedEvent\n

    \n

    Represents areview_dismissedevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    dismissalMessage (String)

    Identifies the optional message associated with thereview_dismissedevent.

    \n\n\n\n\n\n\n\n\n\n\n\n

    dismissalMessageHTML (String)

    Identifies the optional message associated with the event, rendered to HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    previousReviewState (PullRequestReviewState!)

    Identifies the previous state of the review with thereview_dismissedevent.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    PullRequest referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestCommit (PullRequestCommit)

    Identifies the commit which caused the review to become stale.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this review dismissed event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    review (PullRequestReview)

    Identifies the review associated with thereview_dismissedevent.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this review dismissed event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReviewRequest\n

    \n

    A request for a user to review a pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    asCodeOwner (Boolean!)

    Whether this request was created for a code owner.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    Identifies the pull request associated with this review request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requestedReviewer (RequestedReviewer)

    The reviewer that is requested.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReviewRequestConnection\n

    \n

    The connection type for ReviewRequest.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([ReviewRequestEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([ReviewRequest])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReviewRequestEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (ReviewRequest)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReviewRequestRemovedEvent\n

    \n

    Represents anreview_request_removedevent on a given pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    PullRequest referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requestedReviewer (RequestedReviewer)

    Identifies the reviewer whose review request was removed.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReviewRequestedEvent\n

    \n

    Represents anreview_requestedevent on a given pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    PullRequest referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requestedReviewer (RequestedReviewer)

    Identifies the reviewer whose review was requested.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReviewStatusHovercardContext\n

    \n

    A hovercard context with a message describing the current code review state of the pull\nrequest.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    message (String!)

    A string describing this context.

    \n\n\n\n\n\n\n\n\n\n\n\n

    octicon (String!)

    An octicon to accompany this context.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reviewDecision (PullRequestReviewDecision)

    The current status of the pull request with respect to code review.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SavedReply\n

    \n

    A Saved Reply is text a user can use to reply quickly.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String!)

    The body of the saved reply.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyHTML (HTML!)

    The saved reply body rendered to HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    title (String!)

    The title of the saved reply.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (Actor)

    The user that saved this reply.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SavedReplyConnection\n

    \n

    The connection type for SavedReply.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([SavedReplyEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([SavedReply])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SavedReplyEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (SavedReply)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SearchResultItemConnection\n

    \n

    A list of results that matched against a search query.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    codeCount (Int!)

    The number of pieces of code that matched the search query.

    \n\n\n\n\n\n\n\n\n\n\n\n

    edges ([SearchResultItemEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issueCount (Int!)

    The number of issues that matched the search query.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([SearchResultItem])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryCount (Int!)

    The number of repositories that matched the search query.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userCount (Int!)

    The number of users that matched the search query.

    \n\n\n\n\n\n\n\n\n\n\n\n

    wikiCount (Int!)

    The number of wiki pages that matched the search query.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SearchResultItemEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (SearchResultItem)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n

    textMatches ([TextMatch])

    Text matches on the result found.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SecurityAdvisory\n

    \n

    A GitHub Security Advisory.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cvss (CVSS!)

    The CVSS associated with this advisory.

    \n\n\n\n\n\n\n\n\n\n\n\n

    cwes (CWEConnection!)

    CWEs associated with this Advisory.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String!)

    This is a long plaintext description of the advisory.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ghsaId (String!)

    The GitHub Security Advisory ID.

    \n\n\n\n\n\n\n\n\n\n\n\n

    identifiers ([SecurityAdvisoryIdentifier!]!)

    A list of identifiers for this advisory.

    \n\n\n\n\n\n\n\n\n\n\n\n

    notificationsPermalink (URI)

    The permalink for the advisory's dependabot alerts page.

    \n\n\n\n\n\n\n\n\n\n\n\n

    origin (String!)

    The organization that originated the advisory.

    \n\n\n\n\n\n\n\n\n\n\n\n

    permalink (URI)

    The permalink for the advisory.

    \n\n\n\n\n\n\n\n\n\n\n\n

    publishedAt (DateTime!)

    When the advisory was published.

    \n\n\n\n\n\n\n\n\n\n\n\n

    references ([SecurityAdvisoryReference!]!)

    A list of references for this advisory.

    \n\n\n\n\n\n\n\n\n\n\n\n

    severity (SecurityAdvisorySeverity!)

    The severity of the advisory.

    \n\n\n\n\n\n\n\n\n\n\n\n

    summary (String!)

    A short plaintext summary of the advisory.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    When the advisory was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    vulnerabilities (SecurityVulnerabilityConnection!)

    Vulnerabilities associated with this Advisory.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    ecosystem (SecurityAdvisoryEcosystem)

    \n

    An ecosystem to filter vulnerabilities by.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (SecurityVulnerabilityOrder)

    \n

    Ordering options for the returned topics.

    \n\n
    \n\n
    \n

    package (String)

    \n

    A package name to filter vulnerabilities by.

    \n\n
    \n\n
    \n

    severities ([SecurityAdvisorySeverity!])

    \n

    A list of severities to filter vulnerabilities by.

    \n\n
    \n\n
    \n\n\n

    withdrawnAt (DateTime)

    When the advisory was withdrawn, if it has been withdrawn.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SecurityAdvisoryConnection\n

    \n

    The connection type for SecurityAdvisory.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([SecurityAdvisoryEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([SecurityAdvisory])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SecurityAdvisoryEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (SecurityAdvisory)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SecurityAdvisoryIdentifier\n

    \n

    A GitHub Security Advisory Identifier.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    type (String!)

    The identifier type, e.g. GHSA, CVE.

    \n\n\n\n\n\n\n\n\n\n\n\n

    value (String!)

    The identifier.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SecurityAdvisoryPackage\n

    \n

    An individual package.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    ecosystem (SecurityAdvisoryEcosystem!)

    The ecosystem the package belongs to, e.g. RUBYGEMS, NPM.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The package name.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SecurityAdvisoryPackageVersion\n

    \n

    An individual package version.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    identifier (String!)

    The package name or version.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SecurityAdvisoryReference\n

    \n

    A GitHub Security Advisory Reference.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    url (URI!)

    A publicly accessible reference.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SecurityVulnerability\n

    \n

    An individual vulnerability within an Advisory.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    advisory (SecurityAdvisory!)

    The Advisory associated with this Vulnerability.

    \n\n\n\n\n\n\n\n\n\n\n\n

    firstPatchedVersion (SecurityAdvisoryPackageVersion)

    The first version containing a fix for the vulnerability.

    \n\n\n\n\n\n\n\n\n\n\n\n

    package (SecurityAdvisoryPackage!)

    A description of the vulnerable package.

    \n\n\n\n\n\n\n\n\n\n\n\n

    severity (SecurityAdvisorySeverity!)

    The severity of the vulnerability within this package.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    When the vulnerability was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    vulnerableVersionRange (String!)

    A string that describes the vulnerable package versions.\nThis string follows a basic syntax with a few forms.

    \n
      \n
    • = 0.2.0 denotes a single vulnerable version.
    • \n
    • <= 1.0.8 denotes a version range up to and including the specified version
    • \n
    • < 0.1.11 denotes a version range up to, but excluding, the specified version
    • \n
    • >= 4.3.0, < 4.3.5 denotes a version range with a known minimum and maximum version.
    • \n
    • >= 0.0.1 denotes a version range with a known minimum, but no known maximum.
    • \n

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SecurityVulnerabilityConnection\n

    \n

    The connection type for SecurityVulnerability.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([SecurityVulnerabilityEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([SecurityVulnerability])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SecurityVulnerabilityEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (SecurityVulnerability)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SmimeSignature\n

    \n

    Represents an S/MIME signature on a Commit or Tag.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    email (String!)

    Email used to sign this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isValid (Boolean!)

    True if the signature is valid and verified by GitHub.

    \n\n\n\n\n\n\n\n\n\n\n\n

    payload (String!)

    Payload for GPG signing object. Raw ODB object without the signature header.

    \n\n\n\n\n\n\n\n\n\n\n\n

    signature (String!)

    ASCII-armored signature header from object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    signer (User)

    GitHub user corresponding to the email signing this commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    state (GitSignatureState!)

    The state of this signature. VALID if signature is valid and verified by\nGitHub, otherwise represents reason why signature is considered invalid.

    \n\n\n\n\n\n\n\n\n\n\n\n

    wasSignedByGitHub (Boolean!)

    True if the signature was made with GitHub's signing key.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SponsorableItemConnection\n

    \n

    The connection type for SponsorableItem.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([SponsorableItemEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([SponsorableItem])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SponsorableItemEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (SponsorableItem)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SponsorsGoal\n

    \n

    A goal associated with a GitHub Sponsors listing, representing a target the sponsored maintainer would like to attain.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    description (String)

    A description of the goal from the maintainer.

    \n\n\n\n\n\n\n\n\n\n\n\n

    kind (SponsorsGoalKind!)

    What the objective of this goal is.

    \n\n\n\n\n\n\n\n\n\n\n\n

    percentComplete (Int!)

    The percentage representing how complete this goal is, between 0-100.

    \n\n\n\n\n\n\n\n\n\n\n\n

    targetValue (Int!)

    What the goal amount is. Represents a dollar amount for monthly sponsorship\namount goals. Represents a count of unique sponsors for total sponsors count goals.

    \n\n\n\n\n\n\n\n\n\n\n\n

    title (String!)

    A brief summary of the kind and target value of this goal.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SponsorsListing\n

    \n

    A GitHub Sponsors listing.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    activeGoal (SponsorsGoal)

    The current goal the maintainer is trying to reach with GitHub Sponsors, if any.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    fullDescription (String!)

    The full description of the listing.

    \n\n\n\n\n\n\n\n\n\n\n\n

    fullDescriptionHTML (HTML!)

    The full description of the listing rendered to HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The listing's full name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    shortDescription (String!)

    The short description of the listing.

    \n\n\n\n\n\n\n\n\n\n\n\n

    slug (String!)

    The short name of the listing.

    \n\n\n\n\n\n\n\n\n\n\n\n

    tiers (SponsorsTierConnection)

    The published tiers for this GitHub Sponsors listing.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (SponsorsTierOrder)

    \n

    Ordering options for Sponsors tiers returned from the connection.

    \n\n
    \n\n
    \n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SponsorsTier\n

    \n

    A GitHub Sponsors tier associated with a GitHub Sponsors listing.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    adminInfo (SponsorsTierAdminInfo)

    SponsorsTier information only visible to users that can administer the associated Sponsors listing.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String!)

    The description of the tier.

    \n\n\n\n\n\n\n\n\n\n\n\n

    descriptionHTML (HTML!)

    The tier description rendered to HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    monthlyPriceInCents (Int!)

    How much this tier costs per month in cents.

    \n\n\n\n\n\n\n\n\n\n\n\n

    monthlyPriceInDollars (Int!)

    How much this tier costs per month in dollars.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The name of the tier.

    \n\n\n\n\n\n\n\n\n\n\n\n

    sponsorsListing (SponsorsListing!)

    The sponsors listing that this tier belongs to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SponsorsTierAdminInfo\n

    \n

    SponsorsTier information only visible to users that can administer the associated Sponsors listing.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    sponsorships (SponsorshipConnection!)

    The sponsorships associated with this tier.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    includePrivate (Boolean)

    \n

    Whether or not to include private sponsorships in the result set.

    \n

    The default value is false.

    \n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (SponsorshipOrder)

    \n

    Ordering options for sponsorships returned from this connection. If left\nblank, the sponsorships will be ordered based on relevancy to the viewer.

    \n\n
    \n\n
    \n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SponsorsTierConnection\n

    \n

    The connection type for SponsorsTier.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([SponsorsTierEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([SponsorsTier])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SponsorsTierEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (SponsorsTier)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Sponsorship\n

    \n

    A sponsorship relationship between a sponsor and a maintainer.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    maintainer (User!)

    The entity that is being sponsored.

    \n\n\n\n\n\n\n
    \n

    Deprecation notice

    \n

    maintainer is deprecated.

    Sponsorship.maintainer will be removed. Use Sponsorship.sponsorable instead. Removal on 2020-04-01 UTC.

    \n
    \n\n\n\n\n\n\n

    privacyLevel (SponsorshipPrivacy!)

    The privacy level for this sponsorship.

    \n\n\n\n\n\n\n\n\n\n\n\n

    sponsor (User)

    The user that is sponsoring. Returns null if the sponsorship is private or if sponsor is not a user.

    \n\n\n\n\n\n\n
    \n

    Deprecation notice

    \n

    sponsor is deprecated.

    Sponsorship.sponsor will be removed. Use Sponsorship.sponsorEntity instead. Removal on 2020-10-01 UTC.

    \n
    \n\n\n\n\n\n\n

    sponsorEntity (Sponsor)

    The user or organization that is sponsoring, if you have permission to view them.

    \n\n\n\n\n\n\n\n\n\n\n\n

    sponsorable (Sponsorable!)

    The entity that is being sponsored.

    \n\n\n\n\n\n\n\n\n\n\n\n

    tier (SponsorsTier)

    The associated sponsorship tier.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SponsorshipConnection\n

    \n

    The connection type for Sponsorship.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([SponsorshipEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Sponsorship])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SponsorshipEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (Sponsorship)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n StargazerConnection\n

    \n

    The connection type for User.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([StargazerEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([User])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n StargazerEdge\n

    \n

    Represents a user that's starred a repository.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    starredAt (DateTime!)

    Identifies when the item was starred.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n StarredRepositoryConnection\n

    \n

    The connection type for Repository.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([StarredRepositoryEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isOverLimit (Boolean!)

    Is the list of stars for this user truncated? This is true for users that have many stars.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Repository])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n StarredRepositoryEdge\n

    \n

    Represents a starred repository.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    starredAt (DateTime!)

    Identifies when the item was starred.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Status\n

    \n

    Represents a commit status.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    combinedContexts (StatusCheckRollupContextConnection!)

    A list of status contexts and check runs for this commit.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    commit (Commit)

    The commit this status is attached to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    context (StatusContext)

    Looks up an individual status context by context name.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    name (String!)

    \n

    The context name.

    \n\n
    \n\n
    \n\n\n

    contexts ([StatusContext!]!)

    The individual status contexts for this commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    state (StatusState!)

    The combined commit status.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n StatusCheckRollup\n

    \n

    Represents the rollup for both the check runs and status for a commit.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    commit (Commit)

    The commit the status and check runs are attached to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    contexts (StatusCheckRollupContextConnection!)

    A list of status contexts and check runs for this commit.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    state (StatusState!)

    The combined status for the commit.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n StatusCheckRollupContextConnection\n

    \n

    The connection type for StatusCheckRollupContext.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([StatusCheckRollupContextEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([StatusCheckRollupContext])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n StatusCheckRollupContextEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (StatusCheckRollupContext)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n StatusContext\n

    \n

    Represents an individual commit status context.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    avatarUrl (URI)

    The avatar of the OAuth application or the user that created the status.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    size (Int)

    \n

    The size of the resulting square image.

    \n

    The default value is 40.

    \n
    \n\n
    \n\n\n

    commit (Commit)

    This commit this status context is attached to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    context (String!)

    The name of this status context.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    creator (Actor)

    The actor who created this status context.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String)

    The description for this status context.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isRequired (Boolean!)

    Whether this status is required to pass before merging.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    pullRequestId (ID!)

    \n

    The pull request this status is required for.

    \n\n
    \n\n
    \n\n\n

    state (StatusState!)

    The state of this status context.

    \n\n\n\n\n\n\n\n\n\n\n\n

    targetUrl (URI)

    The URL for this status context.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Submodule\n

    \n

    A pointer to a repository at a specific revision embedded inside another repository.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    branch (String)

    The branch of the upstream submodule for tracking updates.

    \n\n\n\n\n\n\n\n\n\n\n\n

    gitUrl (URI!)

    The git URL of the submodule repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The name of the submodule in .gitmodules.

    \n\n\n\n\n\n\n\n\n\n\n\n

    path (String!)

    The path in the superproject that this submodule is located in.

    \n\n\n\n\n\n\n\n\n\n\n\n

    subprojectCommitOid (GitObjectID)

    The commit revision of the subproject repository being tracked by the submodule.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SubmoduleConnection\n

    \n

    The connection type for Submodule.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([SubmoduleEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Submodule])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SubmoduleEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (Submodule)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SubscribedEvent\n

    \n

    Represents asubscribedevent on a given Subscribable.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    subscribable (Subscribable!)

    Object referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SuggestedReviewer\n

    \n

    A suggestion to review a pull request based on a user's commit history and review comments.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    isAuthor (Boolean!)

    Is this suggestion based on past commits?.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isCommenter (Boolean!)

    Is this suggestion based on past review comments?.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reviewer (User!)

    Identifies the user suggested to review the pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Tag\n

    \n

    Represents a Git tag.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    abbreviatedOid (String!)

    An abbreviated version of the Git object ID.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commitResourcePath (URI!)

    The HTTP path for this Git object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commitUrl (URI!)

    The HTTP URL for this Git object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    message (String)

    The Git tag message.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The Git tag name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    oid (GitObjectID!)

    The Git object ID.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository!)

    The Repository the Git object belongs to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    tagger (GitActor)

    Details about the tag author.

    \n\n\n\n\n\n\n\n\n\n\n\n

    target (GitObject!)

    The Git object the tag points to.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Team\n

    \n

    A team of users in an organization.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    ancestors (TeamConnection!)

    A list of teams that are ancestors of this team.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    avatarUrl (URI)

    A URL pointing to the team's avatar.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    size (Int)

    \n

    The size in pixels of the resulting square image.

    \n

    The default value is 400.

    \n
    \n\n
    \n\n\n

    childTeams (TeamConnection!)

    List of child teams belonging to this team.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    immediateOnly (Boolean)

    \n

    Whether to list immediate child teams or all descendant child teams.

    \n

    The default value is true.

    \n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (TeamOrder)

    \n

    Order for connection.

    \n\n
    \n\n
    \n

    userLogins ([String!])

    \n

    User logins to filter by.

    \n\n
    \n\n
    \n\n\n

    combinedSlug (String!)

    The slug corresponding to the organization and team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String)

    The description of the team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    discussion (TeamDiscussion)

    Find a team discussion by its number.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    number (Int!)

    \n

    The sequence number of the discussion to find.

    \n\n
    \n\n
    \n\n\n

    discussions (TeamDiscussionConnection!)

    A list of team discussions.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    isPinned (Boolean)

    \n

    If provided, filters discussions according to whether or not they are pinned.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (TeamDiscussionOrder)

    \n

    Order for connection.

    \n\n
    \n\n
    \n\n\n

    discussionsResourcePath (URI!)

    The HTTP path for team discussions.

    \n\n\n\n\n\n\n\n\n\n\n\n

    discussionsUrl (URI!)

    The HTTP URL for team discussions.

    \n\n\n\n\n\n\n\n\n\n\n\n

    editTeamResourcePath (URI!)

    The HTTP path for editing this team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    editTeamUrl (URI!)

    The HTTP URL for editing this team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    invitations (OrganizationInvitationConnection)

    A list of pending invitations for users to this team.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    memberStatuses (UserStatusConnection!)

    Get the status messages members of this entity have set that are either public or visible only to the organization.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (UserStatusOrder)

    \n

    Ordering options for user statuses returned from the connection.

    \n\n
    \n\n
    \n\n\n

    members (TeamMemberConnection!)

    A list of users who are members of this team.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    membership (TeamMembershipType)

    \n

    Filter by membership type.

    \n

    The default value is ALL.

    \n
    \n\n
    \n

    orderBy (TeamMemberOrder)

    \n

    Order for the connection.

    \n\n
    \n\n
    \n

    query (String)

    \n

    The search string to look for.

    \n\n
    \n\n
    \n

    role (TeamMemberRole)

    \n

    Filter by team member role.

    \n\n
    \n\n
    \n\n\n

    membersResourcePath (URI!)

    The HTTP path for the team' members.

    \n\n\n\n\n\n\n\n\n\n\n\n

    membersUrl (URI!)

    The HTTP URL for the team' members.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The name of the team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    newTeamResourcePath (URI!)

    The HTTP path creating a new team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    newTeamUrl (URI!)

    The HTTP URL creating a new team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization!)

    The organization that owns this team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    parentTeam (Team)

    The parent team of the team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    privacy (TeamPrivacy!)

    The level of privacy the team has.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositories (TeamRepositoryConnection!)

    A list of repositories this team has access to.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (TeamRepositoryOrder)

    \n

    Order for the connection.

    \n\n
    \n\n
    \n

    query (String)

    \n

    The search string to look for.

    \n\n
    \n\n
    \n\n\n

    repositoriesResourcePath (URI!)

    The HTTP path for this team's repositories.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoriesUrl (URI!)

    The HTTP URL for this team's repositories.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reviewRequestDelegationAlgorithm (TeamReviewAssignmentAlgorithm)

    What algorithm is used for review assignment for this team.

    \n\n\n\n\n
    \n

    Preview notice

    \n

    reviewRequestDelegationAlgorithm is available under the Team review assignments preview. During the preview period, the API may change without notice.

    \n
    \n\n\n\n\n\n\n\n\n

    reviewRequestDelegationEnabled (Boolean!)

    True if review assignment is enabled for this team.

    \n\n\n\n\n
    \n

    Preview notice

    \n

    reviewRequestDelegationEnabled is available under the Team review assignments preview. During the preview period, the API may change without notice.

    \n
    \n\n\n\n\n\n\n\n\n

    reviewRequestDelegationMemberCount (Int)

    How many team members are required for review assignment for this team.

    \n\n\n\n\n
    \n

    Preview notice

    \n

    reviewRequestDelegationMemberCount is available under the Team review assignments preview. During the preview period, the API may change without notice.

    \n
    \n\n\n\n\n\n\n\n\n

    reviewRequestDelegationNotifyTeam (Boolean!)

    When assigning team members via delegation, whether the entire team should be notified as well.

    \n\n\n\n\n
    \n

    Preview notice

    \n

    reviewRequestDelegationNotifyTeam is available under the Team review assignments preview. During the preview period, the API may change without notice.

    \n
    \n\n\n\n\n\n\n\n\n

    slug (String!)

    The slug corresponding to the team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamsResourcePath (URI!)

    The HTTP path for this team's teams.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamsUrl (URI!)

    The HTTP URL for this team's teams.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanAdminister (Boolean!)

    Team is adminable by the viewer.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanSubscribe (Boolean!)

    Check if the viewer is able to change their subscription status for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerSubscription (SubscriptionState)

    Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamAddMemberAuditEntry\n

    \n

    Audit log entry for a team.add_member event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isLdapMapped (Boolean)

    Whether the team was mapped to an LDAP Group.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    team (Team)

    The team associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamName (String)

    The name of the team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamResourcePath (URI)

    The HTTP path for this team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamUrl (URI)

    The HTTP URL for this team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamAddRepositoryAuditEntry\n

    \n

    Audit log entry for a team.add_repository event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isLdapMapped (Boolean)

    Whether the team was mapped to an LDAP Group.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    team (Team)

    The team associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamName (String)

    The name of the team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamResourcePath (URI)

    The HTTP path for this team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamUrl (URI)

    The HTTP URL for this team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamChangeParentTeamAuditEntry\n

    \n

    Audit log entry for a team.change_parent_team event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isLdapMapped (Boolean)

    Whether the team was mapped to an LDAP Group.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    parentTeam (Team)

    The new parent team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    parentTeamName (String)

    The name of the new parent team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    parentTeamNameWas (String)

    The name of the former parent team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    parentTeamResourcePath (URI)

    The HTTP path for the parent team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    parentTeamUrl (URI)

    The HTTP URL for the parent team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    parentTeamWas (Team)

    The former parent team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    parentTeamWasResourcePath (URI)

    The HTTP path for the previous parent team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    parentTeamWasUrl (URI)

    The HTTP URL for the previous parent team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    team (Team)

    The team associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamName (String)

    The name of the team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamResourcePath (URI)

    The HTTP path for this team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamUrl (URI)

    The HTTP URL for this team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamConnection\n

    \n

    The connection type for Team.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([TeamEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Team])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamDiscussion\n

    \n

    A team discussion.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    author (Actor)

    The actor who authored the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    authorAssociation (CommentAuthorAssociation!)

    Author's association with the discussion's team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    body (String!)

    The body as Markdown.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyHTML (HTML!)

    The body rendered to HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyText (String!)

    The body rendered to text.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyVersion (String!)

    Identifies the discussion body hash.

    \n\n\n\n\n\n\n\n\n\n\n\n

    comments (TeamDiscussionCommentConnection!)

    A list of comments on this discussion.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    fromComment (Int)

    \n

    When provided, filters the connection such that results begin with the comment with this number.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (TeamDiscussionCommentOrder)

    \n

    Order for connection.

    \n\n
    \n\n
    \n\n\n

    commentsResourcePath (URI!)

    The HTTP path for discussion comments.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commentsUrl (URI!)

    The HTTP URL for discussion comments.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdViaEmail (Boolean!)

    Check if this comment was created via an email reply.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    editor (Actor)

    The actor who edited the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    includesCreatedEdit (Boolean!)

    Check if this comment was edited and includes an edit with the creation data.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isPinned (Boolean!)

    Whether or not the discussion is pinned.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isPrivate (Boolean!)

    Whether or not the discussion is only visible to team members and org admins.

    \n\n\n\n\n\n\n\n\n\n\n\n

    lastEditedAt (DateTime)

    The moment the editor made the last edit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    number (Int!)

    Identifies the discussion within its team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    publishedAt (DateTime)

    Identifies when the comment was published at.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reactionGroups ([ReactionGroup!])

    A list of reactions grouped by content left on the subject.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reactions (ReactionConnection!)

    A list of Reactions left on the Issue.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    content (ReactionContent)

    \n

    Allows filtering Reactions by emoji.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (ReactionOrder)

    \n

    Allows specifying the order in which reactions are returned.

    \n\n
    \n\n
    \n\n\n

    resourcePath (URI!)

    The HTTP path for this discussion.

    \n\n\n\n\n\n\n\n\n\n\n\n

    team (Team!)

    The team that defines the context of this discussion.

    \n\n\n\n\n\n\n\n\n\n\n\n

    title (String!)

    The title of the discussion.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this discussion.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userContentEdits (UserContentEditConnection)

    A list of edits to this content.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    viewerCanDelete (Boolean!)

    Check if the current viewer can delete this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanPin (Boolean!)

    Whether or not the current viewer can pin this discussion.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanReact (Boolean!)

    Can user react to this subject.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanSubscribe (Boolean!)

    Check if the viewer is able to change their subscription status for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanUpdate (Boolean!)

    Check if the current viewer can update this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

    Reasons why the current viewer can not update this comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerDidAuthor (Boolean!)

    Did the viewer author this comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerSubscription (SubscriptionState)

    Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamDiscussionComment\n

    \n

    A comment on a team discussion.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    author (Actor)

    The actor who authored the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    authorAssociation (CommentAuthorAssociation!)

    Author's association with the comment's team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    body (String!)

    The body as Markdown.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyHTML (HTML!)

    The body rendered to HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyText (String!)

    The body rendered to text.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyVersion (String!)

    The current version of the body content.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdViaEmail (Boolean!)

    Check if this comment was created via an email reply.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    discussion (TeamDiscussion!)

    The discussion this comment is about.

    \n\n\n\n\n\n\n\n\n\n\n\n

    editor (Actor)

    The actor who edited the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    includesCreatedEdit (Boolean!)

    Check if this comment was edited and includes an edit with the creation data.

    \n\n\n\n\n\n\n\n\n\n\n\n

    lastEditedAt (DateTime)

    The moment the editor made the last edit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    number (Int!)

    Identifies the comment number.

    \n\n\n\n\n\n\n\n\n\n\n\n

    publishedAt (DateTime)

    Identifies when the comment was published at.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reactionGroups ([ReactionGroup!])

    A list of reactions grouped by content left on the subject.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reactions (ReactionConnection!)

    A list of Reactions left on the Issue.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    content (ReactionContent)

    \n

    Allows filtering Reactions by emoji.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (ReactionOrder)

    \n

    Allows specifying the order in which reactions are returned.

    \n\n
    \n\n
    \n\n\n

    resourcePath (URI!)

    The HTTP path for this comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userContentEdits (UserContentEditConnection)

    A list of edits to this content.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    viewerCanDelete (Boolean!)

    Check if the current viewer can delete this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanReact (Boolean!)

    Can user react to this subject.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanUpdate (Boolean!)

    Check if the current viewer can update this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

    Reasons why the current viewer can not update this comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerDidAuthor (Boolean!)

    Did the viewer author this comment.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamDiscussionCommentConnection\n

    \n

    The connection type for TeamDiscussionComment.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([TeamDiscussionCommentEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([TeamDiscussionComment])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamDiscussionCommentEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (TeamDiscussionComment)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamDiscussionConnection\n

    \n

    The connection type for TeamDiscussion.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([TeamDiscussionEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([TeamDiscussion])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamDiscussionEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (TeamDiscussion)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (Team)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamMemberConnection\n

    \n

    The connection type for User.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([TeamMemberEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([User])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamMemberEdge\n

    \n

    Represents a user who is a member of a team.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    memberAccessResourcePath (URI!)

    The HTTP path to the organization's member access page.

    \n\n\n\n\n\n\n\n\n\n\n\n

    memberAccessUrl (URI!)

    The HTTP URL to the organization's member access page.

    \n\n\n\n\n\n\n\n\n\n\n\n

    role (TeamMemberRole!)

    The role the member has on the team.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamRemoveMemberAuditEntry\n

    \n

    Audit log entry for a team.remove_member event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isLdapMapped (Boolean)

    Whether the team was mapped to an LDAP Group.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    team (Team)

    The team associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamName (String)

    The name of the team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamResourcePath (URI)

    The HTTP path for this team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamUrl (URI)

    The HTTP URL for this team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamRemoveRepositoryAuditEntry\n

    \n

    Audit log entry for a team.remove_repository event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isLdapMapped (Boolean)

    Whether the team was mapped to an LDAP Group.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    team (Team)

    The team associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamName (String)

    The name of the team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamResourcePath (URI)

    The HTTP path for this team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamUrl (URI)

    The HTTP URL for this team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamRepositoryConnection\n

    \n

    The connection type for Repository.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([TeamRepositoryEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Repository])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamRepositoryEdge\n

    \n

    Represents a team repository.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    permission (RepositoryPermission!)

    The permission level the team has on the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TextMatch\n

    \n

    A text match within a search result.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    fragment (String!)

    The specific text fragment within the property matched on.

    \n\n\n\n\n\n\n\n\n\n\n\n

    highlights ([TextMatchHighlight!]!)

    Highlights within the matched fragment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    property (String!)

    The property matched on.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TextMatchHighlight\n

    \n

    Represents a single highlight in a search result match.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    beginIndice (Int!)

    The indice in the fragment where the matched text begins.

    \n\n\n\n\n\n\n\n\n\n\n\n

    endIndice (Int!)

    The indice in the fragment where the matched text ends.

    \n\n\n\n\n\n\n\n\n\n\n\n

    text (String!)

    The text matched.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Topic\n

    \n

    A topic aggregates entities that are related to a subject.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    name (String!)

    The topic's name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    relatedTopics ([Topic!]!)

    A list of related topics, including aliases of this topic, sorted with the most relevant\nfirst. Returns up to 10 Topics.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    first (Int)

    \n

    How many topics to return.

    \n

    The default value is 3.

    \n
    \n\n
    \n\n\n

    stargazerCount (Int!)

    Returns a count of how many stargazers there are on this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    stargazers (StargazerConnection!)

    A list of users who have starred this starrable.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (StarOrder)

    \n

    Order for connection.

    \n\n
    \n\n
    \n\n\n

    viewerHasStarred (Boolean!)

    Returns a boolean indicating whether the viewing user has starred this starrable.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TransferredEvent\n

    \n

    Represents atransferredevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    fromRepository (Repository)

    The repository this came from.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issue (Issue!)

    Identifies the issue associated with the event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Tree\n

    \n

    Represents a Git tree.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    abbreviatedOid (String!)

    An abbreviated version of the Git object ID.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commitResourcePath (URI!)

    The HTTP path for this Git object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commitUrl (URI!)

    The HTTP URL for this Git object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    entries ([TreeEntry!])

    A list of tree entries.

    \n\n\n\n\n\n\n\n\n\n\n\n

    oid (GitObjectID!)

    The Git object ID.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository!)

    The Repository the Git object belongs to.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TreeEntry\n

    \n

    Represents a Git tree entry.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    extension (String)

    The extension of the file.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isGenerated (Boolean!)

    Whether or not this tree entry is generated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    mode (Int!)

    Entry file mode.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    Entry file name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    object (GitObject)

    Entry file object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    oid (GitObjectID!)

    Entry file Git object ID.

    \n\n\n\n\n\n\n\n\n\n\n\n

    path (String)

    The full path of the file.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository!)

    The Repository the tree entry belongs to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    submodule (Submodule)

    If the TreeEntry is for a directory occupied by a submodule project, this returns the corresponding submodule.

    \n\n\n\n\n\n\n\n\n\n\n\n

    type (String!)

    Entry file type.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n UnassignedEvent\n

    \n

    Represents anunassignedevent on any assignable object.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    assignable (Assignable!)

    Identifies the assignable associated with the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    assignee (Assignee)

    Identifies the user or mannequin that was unassigned.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    Identifies the subject (user) who was unassigned.

    \n\n\n\n\n\n\n
    \n

    Deprecation notice

    \n

    user is deprecated.

    Assignees can now be mannequins. Use the assignee field instead. Removal on 2020-01-01 UTC.

    \n
    \n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n UnknownSignature\n

    \n

    Represents an unknown signature on a Commit or Tag.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    email (String!)

    Email used to sign this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isValid (Boolean!)

    True if the signature is valid and verified by GitHub.

    \n\n\n\n\n\n\n\n\n\n\n\n

    payload (String!)

    Payload for GPG signing object. Raw ODB object without the signature header.

    \n\n\n\n\n\n\n\n\n\n\n\n

    signature (String!)

    ASCII-armored signature header from object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    signer (User)

    GitHub user corresponding to the email signing this commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    state (GitSignatureState!)

    The state of this signature. VALID if signature is valid and verified by\nGitHub, otherwise represents reason why signature is considered invalid.

    \n\n\n\n\n\n\n\n\n\n\n\n

    wasSignedByGitHub (Boolean!)

    True if the signature was made with GitHub's signing key.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n UnlabeledEvent\n

    \n

    Represents anunlabeledevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    label (Label!)

    Identifies the label associated with theunlabeledevent.

    \n\n\n\n\n\n\n\n\n\n\n\n

    labelable (Labelable!)

    Identifies the Labelable associated with the event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n UnlockedEvent\n

    \n

    Represents anunlockedevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    lockable (Lockable!)

    Object that was unlocked.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n UnmarkedAsDuplicateEvent\n

    \n

    Represents anunmarked_as_duplicateevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    canonical (IssueOrPullRequest)

    The authoritative issue or pull request which has been duplicated by another.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    duplicate (IssueOrPullRequest)

    The issue or pull request which has been marked as a duplicate of another.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isCrossRepository (Boolean!)

    Canonical and duplicate belong to different repositories.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n UnpinnedEvent\n

    \n

    Represents anunpinnedevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issue (Issue!)

    Identifies the issue associated with the event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n UnsubscribedEvent\n

    \n

    Represents anunsubscribedevent on a given Subscribable.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    subscribable (Subscribable!)

    Object referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n User\n

    \n

    A user is an individual's account on GitHub that owns repositories and can make new content.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    anyPinnableItems (Boolean!)

    Determine if this repository owner has any items that can be pinned to their profile.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    type (PinnableItemType)

    \n

    Filter to only a particular kind of pinnable item.

    \n\n
    \n\n
    \n\n\n

    avatarUrl (URI!)

    A URL pointing to the user's public avatar.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    size (Int)

    \n

    The size of the resulting square image.

    \n\n
    \n\n
    \n\n\n

    bio (String)

    The user's public profile bio.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bioHTML (HTML!)

    The user's public profile bio as HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commitComments (CommitCommentConnection!)

    A list of commit comments made by this user.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    company (String)

    The user's public profile company.

    \n\n\n\n\n\n\n\n\n\n\n\n

    companyHTML (HTML!)

    The user's public profile company as HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    contributionsCollection (ContributionsCollection!)

    The collection of contributions this user has made to different repositories.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    from (DateTime)

    \n

    Only contributions made at this time or later will be counted. If omitted, defaults to a year ago.

    \n\n
    \n\n
    \n

    organizationID (ID)

    \n

    The ID of the organization used to filter contributions.

    \n\n
    \n\n
    \n

    to (DateTime)

    \n

    Only contributions made before and up to and including this time will be\ncounted. If omitted, defaults to the current time.

    \n\n
    \n\n
    \n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    email (String!)

    The user's publicly visible profile email.

    \n\n\n\n\n\n\n\n\n\n\n\n

    followers (FollowerConnection!)

    A list of users the given user is followed by.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    following (FollowingConnection!)

    A list of users the given user is following.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    gist (Gist)

    Find gist by repo name.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    name (String!)

    \n

    The gist name to find.

    \n\n
    \n\n
    \n\n\n

    gistComments (GistCommentConnection!)

    A list of gist comments made by this user.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    gists (GistConnection!)

    A list of the Gists the user has created.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (GistOrder)

    \n

    Ordering options for gists returned from the connection.

    \n\n
    \n\n
    \n

    privacy (GistPrivacy)

    \n

    Filters Gists according to privacy.

    \n\n
    \n\n
    \n\n\n

    hasSponsorsListing (Boolean!)

    True if this user/organization has a GitHub Sponsors listing.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hovercard (Hovercard!)

    The hovercard information for this user in a given context.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    primarySubjectId (ID)

    \n

    The ID of the subject to get the hovercard in the context of.

    \n\n
    \n\n
    \n\n\n

    interactionAbility (RepositoryInteractionAbility)

    The interaction ability settings for this user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isBountyHunter (Boolean!)

    Whether or not this user is a participant in the GitHub Security Bug Bounty.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isCampusExpert (Boolean!)

    Whether or not this user is a participant in the GitHub Campus Experts Program.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isDeveloperProgramMember (Boolean!)

    Whether or not this user is a GitHub Developer Program member.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isEmployee (Boolean!)

    Whether or not this user is a GitHub employee.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isGitHubStar (Boolean!)

    Whether or not this user is a member of the GitHub Stars Program.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isHireable (Boolean!)

    Whether or not the user has marked themselves as for hire.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isSiteAdmin (Boolean!)

    Whether or not this user is a site administrator.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isSponsoredBy (Boolean!)

    Check if the given account is sponsoring this user/organization.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    accountLogin (String!)

    \n

    The target account's login.

    \n\n
    \n\n
    \n\n\n

    isSponsoringViewer (Boolean!)

    True if the viewer is sponsored by this user/organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isViewer (Boolean!)

    Whether or not this user is the viewing user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issueComments (IssueCommentConnection!)

    A list of issue comments made by this user.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (IssueCommentOrder)

    \n

    Ordering options for issue comments returned from the connection.

    \n\n
    \n\n
    \n\n\n

    issues (IssueConnection!)

    A list of issues associated with this user.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    filterBy (IssueFilters)

    \n

    Filtering options for issues returned from the connection.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    labels ([String!])

    \n

    A list of label names to filter the pull requests by.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (IssueOrder)

    \n

    Ordering options for issues returned from the connection.

    \n\n
    \n\n
    \n

    states ([IssueState!])

    \n

    A list of states to filter the issues by.

    \n\n
    \n\n
    \n\n\n

    itemShowcase (ProfileItemShowcase!)

    Showcases a selection of repositories and gists that the profile owner has\neither curated or that have been selected automatically based on popularity.

    \n\n\n\n\n\n\n\n\n\n\n\n

    location (String)

    The user's public profile location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    login (String!)

    The username used to login.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String)

    The user's public profile name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    Find an organization by its login that the user belongs to.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    login (String!)

    \n

    The login of the organization to find.

    \n\n
    \n\n
    \n\n\n

    organizationVerifiedDomainEmails ([String!]!)

    Verified email addresses that match verified domains for a specified organization the user is a member of.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    login (String!)

    \n

    The login of the organization to match verified domains from.

    \n\n
    \n\n
    \n\n\n

    organizations (OrganizationConnection!)

    A list of organizations the user belongs to.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    packages (PackageConnection!)

    A list of packages under the owner.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    names ([String])

    \n

    Find packages by their names.

    \n\n
    \n\n
    \n

    orderBy (PackageOrder)

    \n

    Ordering of the returned packages.

    \n\n
    \n\n
    \n

    packageType (PackageType)

    \n

    Filter registry package by type.

    \n\n
    \n\n
    \n

    repositoryId (ID)

    \n

    Find packages in a repository by ID.

    \n\n
    \n\n
    \n\n\n

    pinnableItems (PinnableItemConnection!)

    A list of repositories and gists this profile owner can pin to their profile.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    types ([PinnableItemType!])

    \n

    Filter the types of pinnable items that are returned.

    \n\n
    \n\n
    \n\n\n

    pinnedItems (PinnableItemConnection!)

    A list of repositories and gists this profile owner has pinned to their profile.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    types ([PinnableItemType!])

    \n

    Filter the types of pinned items that are returned.

    \n\n
    \n\n
    \n\n\n

    pinnedItemsRemaining (Int!)

    Returns how many more items this profile owner can pin to their profile.

    \n\n\n\n\n\n\n\n\n\n\n\n

    project (Project)

    Find project by number.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    number (Int!)

    \n

    The project number to find.

    \n\n
    \n\n
    \n\n\n

    projects (ProjectConnection!)

    A list of projects under the owner.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (ProjectOrder)

    \n

    Ordering options for projects returned from the connection.

    \n\n
    \n\n
    \n

    search (String)

    \n

    Query to search projects by, currently only searching by name.

    \n\n
    \n\n
    \n

    states ([ProjectState!])

    \n

    A list of states to filter the projects by.

    \n\n
    \n\n
    \n\n\n

    projectsResourcePath (URI!)

    The HTTP path listing user's projects.

    \n\n\n\n\n\n\n\n\n\n\n\n

    projectsUrl (URI!)

    The HTTP URL listing user's projects.

    \n\n\n\n\n\n\n\n\n\n\n\n

    publicKeys (PublicKeyConnection!)

    A list of public keys associated with this user.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    pullRequests (PullRequestConnection!)

    A list of pull requests associated with this user.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    baseRefName (String)

    \n

    The base ref name to filter the pull requests by.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    headRefName (String)

    \n

    The head ref name to filter the pull requests by.

    \n\n
    \n\n
    \n

    labels ([String!])

    \n

    A list of label names to filter the pull requests by.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (IssueOrder)

    \n

    Ordering options for pull requests returned from the connection.

    \n\n
    \n\n
    \n

    states ([PullRequestState!])

    \n

    A list of states to filter the pull requests by.

    \n\n
    \n\n
    \n\n\n

    repositories (RepositoryConnection!)

    A list of repositories that the user owns.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    affiliations ([RepositoryAffiliation])

    \n

    Array of viewer's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\ncurrent viewer owns.

    \n\n
    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    isFork (Boolean)

    \n

    If non-null, filters repositories according to whether they are forks of another repository.

    \n\n
    \n\n
    \n

    isLocked (Boolean)

    \n

    If non-null, filters repositories according to whether they have been locked.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (RepositoryOrder)

    \n

    Ordering options for repositories returned from the connection.

    \n\n
    \n\n
    \n

    ownerAffiliations ([RepositoryAffiliation])

    \n

    Array of owner's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\norganization or user being viewed owns.

    \n\n
    \n\n
    \n

    privacy (RepositoryPrivacy)

    \n

    If non-null, filters repositories according to privacy.

    \n\n
    \n\n
    \n\n\n

    repositoriesContributedTo (RepositoryConnection!)

    A list of repositories that the user recently contributed to.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    contributionTypes ([RepositoryContributionType])

    \n

    If non-null, include only the specified types of contributions. The\nGitHub.com UI uses [COMMIT, ISSUE, PULL_REQUEST, REPOSITORY].

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    includeUserRepositories (Boolean)

    \n

    If true, include user repositories.

    \n\n
    \n\n
    \n

    isLocked (Boolean)

    \n

    If non-null, filters repositories according to whether they have been locked.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (RepositoryOrder)

    \n

    Ordering options for repositories returned from the connection.

    \n\n
    \n\n
    \n

    privacy (RepositoryPrivacy)

    \n

    If non-null, filters repositories according to privacy.

    \n\n
    \n\n
    \n\n\n

    repository (Repository)

    Find Repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    name (String!)

    \n

    Name of Repository to find.

    \n\n
    \n\n
    \n\n\n

    resourcePath (URI!)

    The HTTP path for this user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    savedReplies (SavedReplyConnection)

    Replies this user has saved.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (SavedReplyOrder)

    \n

    The field to order saved replies by.

    \n\n
    \n\n
    \n\n\n

    sponsorsListing (SponsorsListing)

    The GitHub Sponsors listing for this user or organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    sponsorshipForViewerAsSponsor (Sponsorship)

    The viewer's sponsorship of this entity.

    \n\n\n\n\n\n\n\n\n\n\n\n

    sponsorshipsAsMaintainer (SponsorshipConnection!)

    This object's sponsorships as the maintainer.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    includePrivate (Boolean)

    \n

    Whether or not to include private sponsorships in the result set.

    \n

    The default value is false.

    \n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (SponsorshipOrder)

    \n

    Ordering options for sponsorships returned from this connection. If left\nblank, the sponsorships will be ordered based on relevancy to the viewer.

    \n\n
    \n\n
    \n\n\n

    sponsorshipsAsSponsor (SponsorshipConnection!)

    This object's sponsorships as the sponsor.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (SponsorshipOrder)

    \n

    Ordering options for sponsorships returned from this connection. If left\nblank, the sponsorships will be ordered based on relevancy to the viewer.

    \n\n
    \n\n
    \n\n\n

    starredRepositories (StarredRepositoryConnection!)

    Repositories the user has starred.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (StarOrder)

    \n

    Order for connection.

    \n\n
    \n\n
    \n

    ownedByViewer (Boolean)

    \n

    Filters starred repositories to only return repositories owned by the viewer.

    \n\n
    \n\n
    \n\n\n

    status (UserStatus)

    The user's description of what they're currently doing.

    \n\n\n\n\n\n\n\n\n\n\n\n

    topRepositories (RepositoryConnection!)

    Repositories the user has contributed to, ordered by contribution rank, plus repositories the user has created.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (RepositoryOrder!)

    \n

    Ordering options for repositories returned from the connection.

    \n\n
    \n\n
    \n

    since (DateTime)

    \n

    How far back in time to fetch contributed repositories.

    \n\n
    \n\n
    \n\n\n

    twitterUsername (String)

    The user's Twitter username.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanChangePinnedItems (Boolean!)

    Can the viewer pin repositories and gists to the profile?.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanCreateProjects (Boolean!)

    Can the current viewer create new projects on this owner.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanFollow (Boolean!)

    Whether or not the viewer is able to follow the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanSponsor (Boolean!)

    Whether or not the viewer is able to sponsor this user/organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerIsFollowing (Boolean!)

    Whether or not this user is followed by the viewer.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerIsSponsoring (Boolean!)

    True if the viewer is sponsoring this user/organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    watching (RepositoryConnection!)

    A list of repositories the given user is watching.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    affiliations ([RepositoryAffiliation])

    \n

    Affiliation options for repositories returned from the connection. If none\nspecified, the results will include repositories for which the current\nviewer is an owner or collaborator, or member.

    \n\n
    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    isLocked (Boolean)

    \n

    If non-null, filters repositories according to whether they have been locked.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (RepositoryOrder)

    \n

    Ordering options for repositories returned from the connection.

    \n\n
    \n\n
    \n

    ownerAffiliations ([RepositoryAffiliation])

    \n

    Array of owner's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\norganization or user being viewed owns.

    \n\n
    \n\n
    \n

    privacy (RepositoryPrivacy)

    \n

    If non-null, filters repositories according to privacy.

    \n\n
    \n\n
    \n\n\n

    websiteUrl (URI)

    A URL pointing to the user's public website/blog.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n UserBlockedEvent\n

    \n

    Represents auser_blockedevent on a given user.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    blockDuration (UserBlockDuration!)

    Number of days that the user was blocked for.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    subject (User)

    The user who was blocked.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n UserConnection\n

    \n

    The connection type for User.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([UserEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([User])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n UserContentEdit\n

    \n

    An edit on user content.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    deletedAt (DateTime)

    Identifies the date and time when the object was deleted.

    \n\n\n\n\n\n\n\n\n\n\n\n

    deletedBy (Actor)

    The actor who deleted this content.

    \n\n\n\n\n\n\n\n\n\n\n\n

    diff (String)

    A summary of the changes for this edit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    editedAt (DateTime!)

    When this content was edited.

    \n\n\n\n\n\n\n\n\n\n\n\n

    editor (Actor)

    The actor who edited this content.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n UserContentEditConnection\n

    \n

    A list of edits to content.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([UserContentEditEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([UserContentEdit])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n UserContentEditEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (UserContentEdit)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n UserEdge\n

    \n

    Represents a user.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (User)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n UserEmailMetadata\n

    \n

    Email attributes from External Identity.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    primary (Boolean)

    Boolean to identify primary emails.

    \n\n\n\n\n\n\n\n\n\n\n\n

    type (String)

    Type of email.

    \n\n\n\n\n\n\n\n\n\n\n\n

    value (String!)

    Email id.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n UserStatus\n

    \n

    The user's description of what they're currently doing.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    emoji (String)

    An emoji summarizing the user's status.

    \n\n\n\n\n\n\n\n\n\n\n\n

    emojiHTML (HTML)

    The status emoji as HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    expiresAt (DateTime)

    If set, the status will not be shown after this date.

    \n\n\n\n\n\n\n\n\n\n\n\n

    id (ID!)

    ID of the object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    indicatesLimitedAvailability (Boolean!)

    Whether this status indicates the user is not fully available on GitHub.

    \n\n\n\n\n\n\n\n\n\n\n\n

    message (String)

    A brief message describing what the user is doing.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The organization whose members can see this status. If null, this status is publicly visible.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User!)

    The user who has this status.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n UserStatusConnection\n

    \n

    The connection type for UserStatus.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([UserStatusEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([UserStatus])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n UserStatusEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (UserStatus)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n VerifiableDomain\n

    \n

    A domain that can be verified for an organization or an enterprise.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    dnsHostName (URI)

    The DNS host name that should be used for verification.

    \n\n\n\n\n\n\n\n\n\n\n\n

    domain (URI!)

    The unicode encoded domain.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hasFoundHostName (Boolean!)

    Whether a TXT record for verification with the expected host name was found.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hasFoundVerificationToken (Boolean!)

    Whether a TXT record for verification with the expected verification token was found.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isRequiredForPolicyEnforcement (Boolean!)

    Whether this domain is required to exist for an organization or enterprise policy to be enforced.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isVerified (Boolean!)

    Whether or not the domain is verified.

    \n\n\n\n\n\n\n\n\n\n\n\n

    owner (VerifiableDomainOwner!)

    The owner of the domain.

    \n\n\n\n\n\n\n\n\n\n\n\n

    punycodeEncodedDomain (URI!)

    The punycode encoded domain.

    \n\n\n\n\n\n\n\n\n\n\n\n

    tokenExpirationTime (DateTime)

    The time that the current verification token will expire.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    verificationToken (String)

    The current verification token for the domain.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n VerifiableDomainConnection\n

    \n

    The connection type for VerifiableDomain.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([VerifiableDomainEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([VerifiableDomain])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n VerifiableDomainEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (VerifiableDomain)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ViewerHovercardContext\n

    \n

    A hovercard context with a message describing how the viewer is related.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    message (String!)

    A string describing this context.

    \n\n\n\n\n\n\n\n\n\n\n\n

    octicon (String!)

    An octicon to accompany this context.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewer (User!)

    Identifies the user who is related to this context.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n", "miniToc": [ { "contents": "\n ActorLocation\n ", @@ -10975,7 +10975,7 @@ ] }, "ghae": { - "html": "
    \n
    \n

    \n ActorLocation\n

    \n

    Location information for an actor.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    city (String)

    City.

    \n\n\n\n\n\n\n\n\n\n\n\n

    country (String)

    Country name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    countryCode (String)

    Country code.

    \n\n\n\n\n\n\n\n\n\n\n\n

    region (String)

    Region name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    regionCode (String)

    Region or state code.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n AddedToProjectEvent\n

    \n

    Represents aadded_to_projectevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    project (Project)

    Project referenced by event.

    \n\n\n\n\n
    \n

    Preview notice

    \n

    project is available under the Project event details preview. During the preview period, the API may change without notice.

    \n
    \n\n\n\n\n\n\n\n\n

    projectCard (ProjectCard)

    Project card referenced by this project event.

    \n\n\n\n\n
    \n

    Preview notice

    \n

    projectCard is available under the Project event details preview. During the preview period, the API may change without notice.

    \n
    \n\n\n\n\n\n\n\n\n

    projectColumnName (String!)

    Column name referenced by this project event.

    \n\n\n\n\n
    \n

    Preview notice

    \n

    projectColumnName is available under the Project event details preview. During the preview period, the API may change without notice.

    \n
    \n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n App\n

    \n

    A GitHub App.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String)

    The description of the app.

    \n\n\n\n\n\n\n\n\n\n\n\n

    logoBackgroundColor (String!)

    The hex color code, without the leading '#', for the logo background.

    \n\n\n\n\n\n\n\n\n\n\n\n

    logoUrl (URI!)

    A URL pointing to the app's logo.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    size (Int)

    \n

    The size of the resulting image.

    \n\n
    \n\n
    \n\n\n

    name (String!)

    The name of the app.

    \n\n\n\n\n\n\n\n\n\n\n\n

    slug (String!)

    A slug based on the name of the app for use in URLs.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The URL to the app's homepage.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n AssignedEvent\n

    \n

    Represents anassignedevent on any assignable object.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    assignable (Assignable!)

    Identifies the assignable associated with the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    assignee (Assignee)

    Identifies the user or mannequin that was assigned.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    Identifies the user who was assigned.

    \n\n\n\n\n\n\n
    \n

    Deprecation notice

    \n

    user is deprecated.

    Assignees can now be mannequins. Use the assignee field instead. Removal on 2020-01-01 UTC.

    \n
    \n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n AutoMergeDisabledEvent\n

    \n

    Represents aauto_merge_disabledevent on a given pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    disabler (User)

    The user who disabled auto-merge for this Pull Request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest)

    PullRequest referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reason (String)

    The reason auto-merge was disabled.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reasonCode (String)

    The reason_code relating to why auto-merge was disabled.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n AutoMergeEnabledEvent\n

    \n

    Represents aauto_merge_enabledevent on a given pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enabler (User)

    The user who enabled auto-merge for this Pull Request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest)

    PullRequest referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n AutoMergeRequest\n

    \n

    Represents an auto-merge request for a pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    authorEmail (String)

    The email address of the author of this auto-merge request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commitBody (String)

    The commit message of the auto-merge request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commitHeadline (String)

    The commit title of the auto-merge request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enabledAt (DateTime)

    When was this auto-merge request was enabled.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enabledBy (Actor)

    The actor who created the auto-merge request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    mergeMethod (PullRequestMergeMethod!)

    The merge method of the auto-merge request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    The pull request that this auto-merge request is set against.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n AutoRebaseEnabledEvent\n

    \n

    Represents aauto_rebase_enabledevent on a given pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enabler (User)

    The user who enabled auto-merge (rebase) for this Pull Request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest)

    PullRequest referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n AutoSquashEnabledEvent\n

    \n

    Represents aauto_squash_enabledevent on a given pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enabler (User)

    The user who enabled auto-merge (squash) for this Pull Request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest)

    PullRequest referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n AutomaticBaseChangeFailedEvent\n

    \n

    Represents aautomatic_base_change_failedevent on a given pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    newBase (String!)

    The new base for this PR.

    \n\n\n\n\n\n\n\n\n\n\n\n

    oldBase (String!)

    The old base for this PR.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    PullRequest referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n AutomaticBaseChangeSucceededEvent\n

    \n

    Represents aautomatic_base_change_succeededevent on a given pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    newBase (String!)

    The new base for this PR.

    \n\n\n\n\n\n\n\n\n\n\n\n

    oldBase (String!)

    The old base for this PR.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    PullRequest referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n BaseRefChangedEvent\n

    \n

    Represents abase_ref_changedevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    currentRefName (String!)

    Identifies the name of the base ref for the pull request after it was changed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    previousRefName (String!)

    Identifies the name of the base ref for the pull request before it was changed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    PullRequest referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n BaseRefDeletedEvent\n

    \n

    Represents abase_ref_deletedevent on a given pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    baseRefName (String)

    Identifies the name of the Ref associated with the base_ref_deleted event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest)

    PullRequest referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n BaseRefForcePushedEvent\n

    \n

    Represents abase_ref_force_pushedevent on a given pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    afterCommit (Commit)

    Identifies the after commit SHA for thebase_ref_force_pushedevent.

    \n\n\n\n\n\n\n\n\n\n\n\n

    beforeCommit (Commit)

    Identifies the before commit SHA for thebase_ref_force_pushedevent.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    PullRequest referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ref (Ref)

    Identifies the fully qualified ref name for thebase_ref_force_pushedevent.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Blame\n

    \n

    Represents a Git blame.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    ranges ([BlameRange!]!)

    The list of ranges from a Git blame.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n BlameRange\n

    \n

    Represents a range of information from a Git blame.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    age (Int!)

    Identifies the recency of the change, from 1 (new) to 10 (old). This is\ncalculated as a 2-quantile and determines the length of distance between the\nmedian age of all the changes in the file and the recency of the current\nrange's change.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commit (Commit!)

    Identifies the line author.

    \n\n\n\n\n\n\n\n\n\n\n\n

    endingLine (Int!)

    The ending line for the range.

    \n\n\n\n\n\n\n\n\n\n\n\n

    startingLine (Int!)

    The starting line for the range.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Blob\n

    \n

    Represents a Git blob.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    abbreviatedOid (String!)

    An abbreviated version of the Git object ID.

    \n\n\n\n\n\n\n\n\n\n\n\n

    byteSize (Int!)

    Byte size of Blob object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commitResourcePath (URI!)

    The HTTP path for this Git object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commitUrl (URI!)

    The HTTP URL for this Git object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isBinary (Boolean)

    Indicates whether the Blob is binary or text. Returns null if unable to determine the encoding.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isTruncated (Boolean!)

    Indicates whether the contents is truncated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    oid (GitObjectID!)

    The Git object ID.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository!)

    The Repository the Git object belongs to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    text (String)

    UTF8 text data or null if the Blob is binary.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Bot\n

    \n

    A special type of user which takes actions on behalf of GitHub Apps.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    avatarUrl (URI!)

    A URL pointing to the GitHub App's public avatar.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    size (Int)

    \n

    The size of the resulting square image.

    \n\n
    \n\n
    \n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    login (String!)

    The username of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this bot.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this bot.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n BranchProtectionRule\n

    \n

    A branch protection rule.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    allowsDeletions (Boolean!)

    Can this branch be deleted.

    \n\n\n\n\n\n\n\n\n\n\n\n

    allowsForcePushes (Boolean!)

    Are force pushes allowed on this branch.

    \n\n\n\n\n\n\n\n\n\n\n\n

    branchProtectionRuleConflicts (BranchProtectionRuleConflictConnection!)

    A list of conflicts matching branches protection rule and other branch protection rules.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    creator (Actor)

    The actor who created this branch protection rule.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    dismissesStaleReviews (Boolean!)

    Will new commits pushed to matching branches dismiss pull request review approvals.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isAdminEnforced (Boolean!)

    Can admins overwrite branch protection.

    \n\n\n\n\n\n\n\n\n\n\n\n

    matchingRefs (RefConnection!)

    Repository refs that are protected by this rule.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    query (String)

    \n

    Filters refs with query on name.

    \n\n
    \n\n
    \n\n\n

    pattern (String!)

    Identifies the protection rule pattern.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pushAllowances (PushAllowanceConnection!)

    A list push allowances for this branch protection rule.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    repository (Repository)

    The repository associated with this branch protection rule.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiredApprovingReviewCount (Int)

    Number of approving reviews required to update matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiredStatusCheckContexts ([String])

    List of required status check contexts that must pass for commits to be accepted to matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiresApprovingReviews (Boolean!)

    Are approving reviews required to update matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiresCodeOwnerReviews (Boolean!)

    Are reviews from code owners required to update matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiresCommitSignatures (Boolean!)

    Are commits required to be signed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiresLinearHistory (Boolean!)

    Are merge commits prohibited from being pushed to this branch.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiresStatusChecks (Boolean!)

    Are status checks required to update matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiresStrictStatusChecks (Boolean!)

    Are branches required to be up to date before merging.

    \n\n\n\n\n\n\n\n\n\n\n\n

    restrictsPushes (Boolean!)

    Is pushing to matching branches restricted.

    \n\n\n\n\n\n\n\n\n\n\n\n

    restrictsReviewDismissals (Boolean!)

    Is dismissal of pull request reviews restricted.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reviewDismissalAllowances (ReviewDismissalAllowanceConnection!)

    A list review dismissal allowances for this branch protection rule.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n BranchProtectionRuleConflict\n

    \n

    A conflict between two branch protection rules.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    branchProtectionRule (BranchProtectionRule)

    Identifies the branch protection rule.

    \n\n\n\n\n\n\n\n\n\n\n\n

    conflictingBranchProtectionRule (BranchProtectionRule)

    Identifies the conflicting branch protection rule.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ref (Ref)

    Identifies the branch ref that has conflicting rules.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n BranchProtectionRuleConflictConnection\n

    \n

    The connection type for BranchProtectionRuleConflict.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([BranchProtectionRuleConflictEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([BranchProtectionRuleConflict])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n BranchProtectionRuleConflictEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (BranchProtectionRuleConflict)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n BranchProtectionRuleConnection\n

    \n

    The connection type for BranchProtectionRule.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([BranchProtectionRuleEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([BranchProtectionRule])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n BranchProtectionRuleEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (BranchProtectionRule)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CVSS\n

    \n

    The Common Vulnerability Scoring System.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    score (Float!)

    The CVSS score associated with this advisory.

    \n\n\n\n\n\n\n\n\n\n\n\n

    vectorString (String)

    The CVSS vector string associated with this advisory.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CWE\n

    \n

    A common weakness enumeration.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cweId (String!)

    The id of the CWE.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String!)

    A detailed description of this CWE.

    \n\n\n\n\n\n\n\n\n\n\n\n

    id (ID!)

    ID of the object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The name of this CWE.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CWEConnection\n

    \n

    The connection type for CWE.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([CWEEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([CWE])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CWEEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (CWE)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CheckAnnotation\n

    \n

    A single check annotation.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    annotationLevel (CheckAnnotationLevel)

    The annotation's severity level.

    \n\n\n\n\n\n\n\n\n\n\n\n

    blobUrl (URI!)

    The path to the file that this annotation was made on.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    location (CheckAnnotationSpan!)

    The position of this annotation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    message (String!)

    The annotation's message.

    \n\n\n\n\n\n\n\n\n\n\n\n

    path (String!)

    The path that this annotation was made on.

    \n\n\n\n\n\n\n\n\n\n\n\n

    rawDetails (String)

    Additional information about the annotation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    title (String)

    The annotation's title.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CheckAnnotationConnection\n

    \n

    The connection type for CheckAnnotation.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([CheckAnnotationEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([CheckAnnotation])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CheckAnnotationEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (CheckAnnotation)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CheckAnnotationPosition\n

    \n

    A character position in a check annotation.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    column (Int)

    Column number (1 indexed).

    \n\n\n\n\n\n\n\n\n\n\n\n

    line (Int!)

    Line number (1 indexed).

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CheckAnnotationSpan\n

    \n

    An inclusive pair of positions for a check annotation.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    end (CheckAnnotationPosition!)

    End position (inclusive).

    \n\n\n\n\n\n\n\n\n\n\n\n

    start (CheckAnnotationPosition!)

    Start position (inclusive).

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CheckRun\n

    \n

    A check run.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    annotations (CheckAnnotationConnection)

    The check run's annotations.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    checkSuite (CheckSuite!)

    The check suite that this run is a part of.

    \n\n\n\n\n\n\n\n\n\n\n\n

    completedAt (DateTime)

    Identifies the date and time when the check run was completed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    conclusion (CheckConclusionState)

    The conclusion of the check run.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    detailsUrl (URI)

    The URL from which to find full details of the check run on the integrator's site.

    \n\n\n\n\n\n\n\n\n\n\n\n

    externalId (String)

    A reference for the check run on the integrator's system.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The name of the check for this check run.

    \n\n\n\n\n\n\n\n\n\n\n\n

    permalink (URI!)

    The permalink to the check run summary.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository!)

    The repository associated with this check run.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this check run.

    \n\n\n\n\n\n\n\n\n\n\n\n

    startedAt (DateTime)

    Identifies the date and time when the check run was started.

    \n\n\n\n\n\n\n\n\n\n\n\n

    status (CheckStatusState!)

    The current status of the check run.

    \n\n\n\n\n\n\n\n\n\n\n\n

    summary (String)

    A string representing the check run's summary.

    \n\n\n\n\n\n\n\n\n\n\n\n

    text (String)

    A string representing the check run's text.

    \n\n\n\n\n\n\n\n\n\n\n\n

    title (String)

    A string representing the check run.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this check run.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CheckRunConnection\n

    \n

    The connection type for CheckRun.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([CheckRunEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([CheckRun])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CheckRunEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (CheckRun)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CheckSuite\n

    \n

    A check suite.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    app (App)

    The GitHub App which created this check suite.

    \n\n\n\n\n\n\n\n\n\n\n\n

    branch (Ref)

    The name of the branch for this check suite.

    \n\n\n\n\n\n\n\n\n\n\n\n

    checkRuns (CheckRunConnection)

    The check runs associated with a check suite.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    filterBy (CheckRunFilter)

    \n

    Filters the check runs by this type.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    commit (Commit!)

    The commit for this check suite.

    \n\n\n\n\n\n\n\n\n\n\n\n

    conclusion (CheckConclusionState)

    The conclusion of this check suite.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    matchingPullRequests (PullRequestConnection)

    A list of open pull requests matching the check suite.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    baseRefName (String)

    \n

    The base ref name to filter the pull requests by.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    headRefName (String)

    \n

    The head ref name to filter the pull requests by.

    \n\n
    \n\n
    \n

    labels ([String!])

    \n

    A list of label names to filter the pull requests by.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (IssueOrder)

    \n

    Ordering options for pull requests returned from the connection.

    \n\n
    \n\n
    \n

    states ([PullRequestState!])

    \n

    A list of states to filter the pull requests by.

    \n\n
    \n\n
    \n\n\n

    push (Push)

    The push that triggered this check suite.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository!)

    The repository associated with this check suite.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this check suite.

    \n\n\n\n\n\n\n\n\n\n\n\n

    status (CheckStatusState!)

    The status of this check suite.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this check suite.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CheckSuiteConnection\n

    \n

    The connection type for CheckSuite.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([CheckSuiteEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([CheckSuite])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CheckSuiteEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (CheckSuite)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ClosedEvent\n

    \n

    Represents aclosedevent on any Closable.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    closable (Closable!)

    Object that was closed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    closer (Closer)

    Object which triggered the creation of this event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this closed event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this closed event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CodeOfConduct\n

    \n

    The Code of Conduct for a repository.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String)

    The body of the Code of Conduct.

    \n\n\n\n\n\n\n\n\n\n\n\n

    key (String!)

    The key for the Code of Conduct.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The formal name of the Code of Conduct.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI)

    The HTTP path for this Code of Conduct.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI)

    The HTTP URL for this Code of Conduct.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CommentDeletedEvent\n

    \n

    Represents acomment_deletedevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    deletedCommentAuthor (Actor)

    The user who authored the deleted comment.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Commit\n

    \n

    Represents a Git commit.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    abbreviatedOid (String!)

    An abbreviated version of the Git object ID.

    \n\n\n\n\n\n\n\n\n\n\n\n

    additions (Int!)

    The number of additions in this commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    associatedPullRequests (PullRequestConnection)

    The pull requests associated with a commit.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (PullRequestOrder)

    \n

    Ordering options for pull requests.

    \n\n
    \n\n
    \n\n\n

    author (GitActor)

    Authorship details of the commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    authoredByCommitter (Boolean!)

    Check if the committer and the author match.

    \n\n\n\n\n\n\n\n\n\n\n\n

    authoredDate (DateTime!)

    The datetime when this commit was authored.

    \n\n\n\n\n\n\n\n\n\n\n\n

    authors (GitActorConnection!)

    The list of authors for this commit based on the git author and the Co-authored-by\nmessage trailer. The git author will always be first.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    blame (Blame!)

    Fetches git blame information.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    path (String!)

    \n

    The file whose Git blame information you want.

    \n\n
    \n\n
    \n\n\n

    changedFiles (Int!)

    The number of changed files in this commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    checkSuites (CheckSuiteConnection)

    The check suites associated with a commit.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    filterBy (CheckSuiteFilter)

    \n

    Filters the check suites by this type.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    comments (CommitCommentConnection!)

    Comments made on the commit.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    commitResourcePath (URI!)

    The HTTP path for this Git object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commitUrl (URI!)

    The HTTP URL for this Git object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    committedDate (DateTime!)

    The datetime when this commit was committed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    committedViaWeb (Boolean!)

    Check if committed via GitHub web UI.

    \n\n\n\n\n\n\n\n\n\n\n\n

    committer (GitActor)

    Committer details of the commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    deletions (Int!)

    The number of deletions in this commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    deployments (DeploymentConnection)

    The deployments associated with a commit.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    environments ([String!])

    \n

    Environments to list deployments for.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (DeploymentOrder)

    \n

    Ordering options for deployments returned from the connection.

    \n\n
    \n\n
    \n\n\n

    file (TreeEntry)

    The tree entry representing the file located at the given path.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    path (String!)

    \n

    The path for the file.

    \n\n
    \n\n
    \n\n\n

    history (CommitHistoryConnection!)

    The linear commit history starting from (and including) this commit, in the same order as git log.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    author (CommitAuthor)

    \n

    If non-null, filters history to only show commits with matching authorship.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    path (String)

    \n

    If non-null, filters history to only show commits touching files under this path.

    \n\n
    \n\n
    \n

    since (GitTimestamp)

    \n

    Allows specifying a beginning time or date for fetching commits.

    \n\n
    \n\n
    \n

    until (GitTimestamp)

    \n

    Allows specifying an ending time or date for fetching commits.

    \n\n
    \n\n
    \n\n\n

    message (String!)

    The Git commit message.

    \n\n\n\n\n\n\n\n\n\n\n\n

    messageBody (String!)

    The Git commit message body.

    \n\n\n\n\n\n\n\n\n\n\n\n

    messageBodyHTML (HTML!)

    The commit message body rendered to HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    messageHeadline (String!)

    The Git commit message headline.

    \n\n\n\n\n\n\n\n\n\n\n\n

    messageHeadlineHTML (HTML!)

    The commit message headline rendered to HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    oid (GitObjectID!)

    The Git object ID.

    \n\n\n\n\n\n\n\n\n\n\n\n

    onBehalfOf (Organization)

    The organization this commit was made on behalf of.

    \n\n\n\n\n\n\n\n\n\n\n\n

    parents (CommitConnection!)

    The parents of a commit.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    pushedDate (DateTime)

    The datetime when this commit was pushed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository!)

    The Repository this commit belongs to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    signature (GitSignature)

    Commit signing information, if present.

    \n\n\n\n\n\n\n\n\n\n\n\n

    status (Status)

    Status information for this commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    statusCheckRollup (StatusCheckRollup)

    Check and Status rollup information for this commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    submodules (SubmoduleConnection!)

    Returns a list of all submodules in this repository as of this Commit parsed from the .gitmodules file.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    tarballUrl (URI!)

    Returns a URL to download a tarball archive for a repository.\nNote: For private repositories, these links are temporary and expire after five minutes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    tree (Tree!)

    Commit's root Tree.

    \n\n\n\n\n\n\n\n\n\n\n\n

    treeResourcePath (URI!)

    The HTTP path for the tree of this commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    treeUrl (URI!)

    The HTTP URL for the tree of this commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanSubscribe (Boolean!)

    Check if the viewer is able to change their subscription status for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerSubscription (SubscriptionState)

    Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

    \n\n\n\n\n\n\n\n\n\n\n\n

    zipballUrl (URI!)

    Returns a URL to download a zipball archive for a repository.\nNote: For private repositories, these links are temporary and expire after five minutes.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CommitComment\n

    \n

    Represents a comment on a given Commit.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    author (Actor)

    The actor who authored the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    authorAssociation (CommentAuthorAssociation!)

    Author's association with the subject of the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    body (String!)

    Identifies the comment body.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyHTML (HTML!)

    The body rendered to HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyText (String!)

    The body rendered to text.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commit (Commit)

    Identifies the commit associated with the comment, if the commit exists.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdViaEmail (Boolean!)

    Check if this comment was created via an email reply.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    editor (Actor)

    The actor who edited the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    includesCreatedEdit (Boolean!)

    Check if this comment was edited and includes an edit with the creation data.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isMinimized (Boolean!)

    Returns whether or not a comment has been minimized.

    \n\n\n\n\n\n\n\n\n\n\n\n

    lastEditedAt (DateTime)

    The moment the editor made the last edit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    minimizedReason (String)

    Returns why the comment was minimized.

    \n\n\n\n\n\n\n\n\n\n\n\n

    path (String)

    Identifies the file path associated with the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    position (Int)

    Identifies the line position associated with the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    publishedAt (DateTime)

    Identifies when the comment was published at.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reactionGroups ([ReactionGroup!])

    A list of reactions grouped by content left on the subject.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reactions (ReactionConnection!)

    A list of Reactions left on the Issue.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    content (ReactionContent)

    \n

    Allows filtering Reactions by emoji.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (ReactionOrder)

    \n

    Allows specifying the order in which reactions are returned.

    \n\n
    \n\n
    \n\n\n

    repository (Repository!)

    The repository associated with this node.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path permalink for this commit comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL permalink for this commit comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userContentEdits (UserContentEditConnection)

    A list of edits to this content.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    viewerCanDelete (Boolean!)

    Check if the current viewer can delete this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanMinimize (Boolean!)

    Check if the current viewer can minimize this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanReact (Boolean!)

    Can user react to this subject.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanUpdate (Boolean!)

    Check if the current viewer can update this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

    Reasons why the current viewer can not update this comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerDidAuthor (Boolean!)

    Did the viewer author this comment.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CommitCommentConnection\n

    \n

    The connection type for CommitComment.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([CommitCommentEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([CommitComment])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CommitCommentEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (CommitComment)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CommitCommentThread\n

    \n

    A thread of comments on a commit.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    comments (CommitCommentConnection!)

    The comments that exist in this thread.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    commit (Commit)

    The commit the comments were made on.

    \n\n\n\n\n\n\n\n\n\n\n\n

    path (String)

    The file the comments were made on.

    \n\n\n\n\n\n\n\n\n\n\n\n

    position (Int)

    The position in the diff for the commit that the comment was made on.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository!)

    The repository associated with this node.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CommitConnection\n

    \n

    The connection type for Commit.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([CommitEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Commit])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CommitContributionsByRepository\n

    \n

    This aggregates commits made by a user within one repository.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    contributions (CreatedCommitContributionConnection!)

    The commit contributions, each representing a day.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (CommitContributionOrder)

    \n

    Ordering options for commit contributions returned from the connection.

    \n\n
    \n\n
    \n\n\n

    repository (Repository!)

    The repository in which the commits were made.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for the user's commits to the repository in this time range.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for the user's commits to the repository in this time range.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CommitEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (Commit)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CommitHistoryConnection\n

    \n

    The connection type for Commit.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([CommitEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Commit])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ConnectedEvent\n

    \n

    Represents aconnectedevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isCrossRepository (Boolean!)

    Reference originated in a different repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    source (ReferencedSubject!)

    Issue or pull request that made the reference.

    \n\n\n\n\n\n\n\n\n\n\n\n

    subject (ReferencedSubject!)

    Issue or pull request which was connected.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ContentAttachment\n

    \n

    A content attachment.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String!)

    The body text of the content attachment. This parameter supports markdown.

    \n\n\n\n\n\n\n\n\n\n\n\n

    contentReference (ContentReference!)

    The content reference that the content attachment is attached to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int!)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    title (String!)

    The title of the content attachment.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ContentReference\n

    \n

    A content reference.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    databaseId (Int!)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reference (String!)

    The reference of the content reference.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ContributionCalendar\n

    \n

    A calendar of contributions made on GitHub by a user.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    colors ([String!]!)

    A list of hex color codes used in this calendar. The darker the color, the more contributions it represents.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isHalloween (Boolean!)

    Determine if the color set was chosen because it's currently Halloween.

    \n\n\n\n\n\n\n\n\n\n\n\n

    months ([ContributionCalendarMonth!]!)

    A list of the months of contributions in this calendar.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalContributions (Int!)

    The count of total contributions in the calendar.

    \n\n\n\n\n\n\n\n\n\n\n\n

    weeks ([ContributionCalendarWeek!]!)

    A list of the weeks of contributions in this calendar.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ContributionCalendarDay\n

    \n

    Represents a single day of contributions on GitHub by a user.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    color (String!)

    The hex color code that represents how many contributions were made on this day compared to others in the calendar.

    \n\n\n\n\n\n\n\n\n\n\n\n

    contributionCount (Int!)

    How many contributions were made by the user on this day.

    \n\n\n\n\n\n\n\n\n\n\n\n

    contributionLevel (ContributionLevel!)

    Indication of contributions, relative to other days. Can be used to indicate\nwhich color to represent this day on a calendar.

    \n\n\n\n\n\n\n\n\n\n\n\n

    date (Date!)

    The day this square represents.

    \n\n\n\n\n\n\n\n\n\n\n\n

    weekday (Int!)

    A number representing which day of the week this square represents, e.g., 1 is Monday.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ContributionCalendarMonth\n

    \n

    A month of contributions in a user's contribution graph.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    firstDay (Date!)

    The date of the first day of this month.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The name of the month.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalWeeks (Int!)

    How many weeks started in this month.

    \n\n\n\n\n\n\n\n\n\n\n\n

    year (Int!)

    The year the month occurred in.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ContributionCalendarWeek\n

    \n

    A week of contributions in a user's contribution graph.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    contributionDays ([ContributionCalendarDay!]!)

    The days of contributions in this week.

    \n\n\n\n\n\n\n\n\n\n\n\n

    firstDay (Date!)

    The date of the earliest square in this week.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ContributionsCollection\n

    \n

    A contributions collection aggregates contributions such as opened issues and commits created by a user.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    commitContributionsByRepository ([CommitContributionsByRepository!]!)

    Commit contributions made by the user, grouped by repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    maxRepositories (Int)

    \n

    How many repositories should be included.

    \n

    The default value is 25.

    \n
    \n\n
    \n\n\n

    contributionCalendar (ContributionCalendar!)

    A calendar of this user's contributions on GitHub.

    \n\n\n\n\n\n\n\n\n\n\n\n

    contributionYears ([Int!]!)

    The years the user has been making contributions with the most recent year first.

    \n\n\n\n\n\n\n\n\n\n\n\n

    doesEndInCurrentMonth (Boolean!)

    Determine if this collection's time span ends in the current month.

    \n\n\n\n\n\n\n\n\n\n\n\n

    earliestRestrictedContributionDate (Date)

    The date of the first restricted contribution the user made in this time\nperiod. Can only be non-null when the user has enabled private contribution counts.

    \n\n\n\n\n\n\n\n\n\n\n\n

    endedAt (DateTime!)

    The ending date and time of this collection.

    \n\n\n\n\n\n\n\n\n\n\n\n

    firstIssueContribution (CreatedIssueOrRestrictedContribution)

    The first issue the user opened on GitHub. This will be null if that issue was\nopened outside the collection's time range and ignoreTimeRange is false. If\nthe issue is not visible but the user has opted to show private contributions,\na RestrictedContribution will be returned.

    \n\n\n\n\n\n\n\n\n\n\n\n

    firstPullRequestContribution (CreatedPullRequestOrRestrictedContribution)

    The first pull request the user opened on GitHub. This will be null if that\npull request was opened outside the collection's time range and\nignoreTimeRange is not true. If the pull request is not visible but the user\nhas opted to show private contributions, a RestrictedContribution will be returned.

    \n\n\n\n\n\n\n\n\n\n\n\n

    firstRepositoryContribution (CreatedRepositoryOrRestrictedContribution)

    The first repository the user created on GitHub. This will be null if that\nfirst repository was created outside the collection's time range and\nignoreTimeRange is false. If the repository is not visible, then a\nRestrictedContribution is returned.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hasActivityInThePast (Boolean!)

    Does the user have any more activity in the timeline that occurred prior to the collection's time range?.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hasAnyContributions (Boolean!)

    Determine if there are any contributions in this collection.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hasAnyRestrictedContributions (Boolean!)

    Determine if the user made any contributions in this time frame whose details\nare not visible because they were made in a private repository. Can only be\ntrue if the user enabled private contribution counts.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isSingleDay (Boolean!)

    Whether or not the collector's time span is all within the same day.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issueContributions (CreatedIssueContributionConnection!)

    A list of issues the user opened.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    excludeFirst (Boolean)

    \n

    Should the user's first issue ever be excluded from the result.

    \n

    The default value is false.

    \n
    \n\n
    \n

    excludePopular (Boolean)

    \n

    Should the user's most commented issue be excluded from the result.

    \n

    The default value is false.

    \n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (ContributionOrder)

    \n

    Ordering options for contributions returned from the connection.

    \n\n
    \n\n
    \n\n\n

    issueContributionsByRepository ([IssueContributionsByRepository!]!)

    Issue contributions made by the user, grouped by repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    excludeFirst (Boolean)

    \n

    Should the user's first issue ever be excluded from the result.

    \n

    The default value is false.

    \n
    \n\n
    \n

    excludePopular (Boolean)

    \n

    Should the user's most commented issue be excluded from the result.

    \n

    The default value is false.

    \n
    \n\n
    \n

    maxRepositories (Int)

    \n

    How many repositories should be included.

    \n

    The default value is 25.

    \n
    \n\n
    \n\n\n

    joinedGitHubContribution (JoinedGitHubContribution)

    When the user signed up for GitHub. This will be null if that sign up date\nfalls outside the collection's time range and ignoreTimeRange is false.

    \n\n\n\n\n\n\n\n\n\n\n\n

    latestRestrictedContributionDate (Date)

    The date of the most recent restricted contribution the user made in this time\nperiod. Can only be non-null when the user has enabled private contribution counts.

    \n\n\n\n\n\n\n\n\n\n\n\n

    mostRecentCollectionWithActivity (ContributionsCollection)

    When this collection's time range does not include any activity from the user, use this\nto get a different collection from an earlier time range that does have activity.

    \n\n\n\n\n\n\n\n\n\n\n\n

    mostRecentCollectionWithoutActivity (ContributionsCollection)

    Returns a different contributions collection from an earlier time range than this one\nthat does not have any contributions.

    \n\n\n\n\n\n\n\n\n\n\n\n

    popularIssueContribution (CreatedIssueContribution)

    The issue the user opened on GitHub that received the most comments in the specified\ntime frame.

    \n\n\n\n\n\n\n\n\n\n\n\n

    popularPullRequestContribution (CreatedPullRequestContribution)

    The pull request the user opened on GitHub that received the most comments in the\nspecified time frame.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestContributions (CreatedPullRequestContributionConnection!)

    Pull request contributions made by the user.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    excludeFirst (Boolean)

    \n

    Should the user's first pull request ever be excluded from the result.

    \n

    The default value is false.

    \n
    \n\n
    \n

    excludePopular (Boolean)

    \n

    Should the user's most commented pull request be excluded from the result.

    \n

    The default value is false.

    \n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (ContributionOrder)

    \n

    Ordering options for contributions returned from the connection.

    \n\n
    \n\n
    \n\n\n

    pullRequestContributionsByRepository ([PullRequestContributionsByRepository!]!)

    Pull request contributions made by the user, grouped by repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    excludeFirst (Boolean)

    \n

    Should the user's first pull request ever be excluded from the result.

    \n

    The default value is false.

    \n
    \n\n
    \n

    excludePopular (Boolean)

    \n

    Should the user's most commented pull request be excluded from the result.

    \n

    The default value is false.

    \n
    \n\n
    \n

    maxRepositories (Int)

    \n

    How many repositories should be included.

    \n

    The default value is 25.

    \n
    \n\n
    \n\n\n

    pullRequestReviewContributions (CreatedPullRequestReviewContributionConnection!)

    Pull request review contributions made by the user.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (ContributionOrder)

    \n

    Ordering options for contributions returned from the connection.

    \n\n
    \n\n
    \n\n\n

    pullRequestReviewContributionsByRepository ([PullRequestReviewContributionsByRepository!]!)

    Pull request review contributions made by the user, grouped by repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    maxRepositories (Int)

    \n

    How many repositories should be included.

    \n

    The default value is 25.

    \n
    \n\n
    \n\n\n

    repositoryContributions (CreatedRepositoryContributionConnection!)

    A list of repositories owned by the user that the user created in this time range.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    excludeFirst (Boolean)

    \n

    Should the user's first repository ever be excluded from the result.

    \n

    The default value is false.

    \n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (ContributionOrder)

    \n

    Ordering options for contributions returned from the connection.

    \n\n
    \n\n
    \n\n\n

    restrictedContributionsCount (Int!)

    A count of contributions made by the user that the viewer cannot access. Only\nnon-zero when the user has chosen to share their private contribution counts.

    \n\n\n\n\n\n\n\n\n\n\n\n

    startedAt (DateTime!)

    The beginning date and time of this collection.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCommitContributions (Int!)

    How many commits were made by the user in this time span.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalIssueContributions (Int!)

    How many issues the user opened.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    excludeFirst (Boolean)

    \n

    Should the user's first issue ever be excluded from this count.

    \n

    The default value is false.

    \n
    \n\n
    \n

    excludePopular (Boolean)

    \n

    Should the user's most commented issue be excluded from this count.

    \n

    The default value is false.

    \n
    \n\n
    \n\n\n

    totalPullRequestContributions (Int!)

    How many pull requests the user opened.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    excludeFirst (Boolean)

    \n

    Should the user's first pull request ever be excluded from this count.

    \n

    The default value is false.

    \n
    \n\n
    \n

    excludePopular (Boolean)

    \n

    Should the user's most commented pull request be excluded from this count.

    \n

    The default value is false.

    \n
    \n\n
    \n\n\n

    totalPullRequestReviewContributions (Int!)

    How many pull request reviews the user left.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalRepositoriesWithContributedCommits (Int!)

    How many different repositories the user committed to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalRepositoriesWithContributedIssues (Int!)

    How many different repositories the user opened issues in.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    excludeFirst (Boolean)

    \n

    Should the user's first issue ever be excluded from this count.

    \n

    The default value is false.

    \n
    \n\n
    \n

    excludePopular (Boolean)

    \n

    Should the user's most commented issue be excluded from this count.

    \n

    The default value is false.

    \n
    \n\n
    \n\n\n

    totalRepositoriesWithContributedPullRequestReviews (Int!)

    How many different repositories the user left pull request reviews in.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalRepositoriesWithContributedPullRequests (Int!)

    How many different repositories the user opened pull requests in.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    excludeFirst (Boolean)

    \n

    Should the user's first pull request ever be excluded from this count.

    \n

    The default value is false.

    \n
    \n\n
    \n

    excludePopular (Boolean)

    \n

    Should the user's most commented pull request be excluded from this count.

    \n

    The default value is false.

    \n
    \n\n
    \n\n\n

    totalRepositoryContributions (Int!)

    How many repositories the user created.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    excludeFirst (Boolean)

    \n

    Should the user's first repository ever be excluded from this count.

    \n

    The default value is false.

    \n
    \n\n
    \n\n\n

    user (User!)

    The user who made the contributions in this collection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ConvertToDraftEvent\n

    \n

    Represents aconvert_to_draftevent on a given pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    PullRequest referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this convert to draft event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this convert to draft event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ConvertedNoteToIssueEvent\n

    \n

    Represents aconverted_note_to_issueevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    project (Project)

    Project referenced by event.

    \n\n\n\n\n
    \n

    Preview notice

    \n

    project is available under the Project event details preview. During the preview period, the API may change without notice.

    \n
    \n\n\n\n\n\n\n\n\n

    projectCard (ProjectCard)

    Project card referenced by this project event.

    \n\n\n\n\n
    \n

    Preview notice

    \n

    projectCard is available under the Project event details preview. During the preview period, the API may change without notice.

    \n
    \n\n\n\n\n\n\n\n\n

    projectColumnName (String!)

    Column name referenced by this project event.

    \n\n\n\n\n
    \n

    Preview notice

    \n

    projectColumnName is available under the Project event details preview. During the preview period, the API may change without notice.

    \n
    \n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CreatedCommitContribution\n

    \n

    Represents the contribution a user made by committing to a repository.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    commitCount (Int!)

    How many commits were made on this day to this repository by the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isRestricted (Boolean!)

    Whether this contribution is associated with a record you do not have access to. For\nexample, your own 'first issue' contribution may have been made on a repository you can no\nlonger access.

    \n\n\n\n\n\n\n\n\n\n\n\n

    occurredAt (DateTime!)

    When this contribution was made.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository!)

    The repository the user made a commit in.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User!)

    The user who made this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CreatedCommitContributionConnection\n

    \n

    The connection type for CreatedCommitContribution.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([CreatedCommitContributionEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([CreatedCommitContribution])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of commits across days and repositories in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CreatedCommitContributionEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (CreatedCommitContribution)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CreatedIssueContribution\n

    \n

    Represents the contribution a user made on GitHub by opening an issue.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    isRestricted (Boolean!)

    Whether this contribution is associated with a record you do not have access to. For\nexample, your own 'first issue' contribution may have been made on a repository you can no\nlonger access.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issue (Issue!)

    The issue that was opened.

    \n\n\n\n\n\n\n\n\n\n\n\n

    occurredAt (DateTime!)

    When this contribution was made.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User!)

    The user who made this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CreatedIssueContributionConnection\n

    \n

    The connection type for CreatedIssueContribution.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([CreatedIssueContributionEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([CreatedIssueContribution])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CreatedIssueContributionEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (CreatedIssueContribution)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CreatedPullRequestContribution\n

    \n

    Represents the contribution a user made on GitHub by opening a pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    isRestricted (Boolean!)

    Whether this contribution is associated with a record you do not have access to. For\nexample, your own 'first issue' contribution may have been made on a repository you can no\nlonger access.

    \n\n\n\n\n\n\n\n\n\n\n\n

    occurredAt (DateTime!)

    When this contribution was made.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    The pull request that was opened.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User!)

    The user who made this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CreatedPullRequestContributionConnection\n

    \n

    The connection type for CreatedPullRequestContribution.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([CreatedPullRequestContributionEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([CreatedPullRequestContribution])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CreatedPullRequestContributionEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (CreatedPullRequestContribution)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CreatedPullRequestReviewContribution\n

    \n

    Represents the contribution a user made by leaving a review on a pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    isRestricted (Boolean!)

    Whether this contribution is associated with a record you do not have access to. For\nexample, your own 'first issue' contribution may have been made on a repository you can no\nlonger access.

    \n\n\n\n\n\n\n\n\n\n\n\n

    occurredAt (DateTime!)

    When this contribution was made.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    The pull request the user reviewed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestReview (PullRequestReview!)

    The review the user left on the pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository!)

    The repository containing the pull request that the user reviewed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User!)

    The user who made this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CreatedPullRequestReviewContributionConnection\n

    \n

    The connection type for CreatedPullRequestReviewContribution.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([CreatedPullRequestReviewContributionEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([CreatedPullRequestReviewContribution])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CreatedPullRequestReviewContributionEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (CreatedPullRequestReviewContribution)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CreatedRepositoryContribution\n

    \n

    Represents the contribution a user made on GitHub by creating a repository.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    isRestricted (Boolean!)

    Whether this contribution is associated with a record you do not have access to. For\nexample, your own 'first issue' contribution may have been made on a repository you can no\nlonger access.

    \n\n\n\n\n\n\n\n\n\n\n\n

    occurredAt (DateTime!)

    When this contribution was made.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository!)

    The repository that was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User!)

    The user who made this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CreatedRepositoryContributionConnection\n

    \n

    The connection type for CreatedRepositoryContribution.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([CreatedRepositoryContributionEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([CreatedRepositoryContribution])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CreatedRepositoryContributionEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (CreatedRepositoryContribution)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CrossReferencedEvent\n

    \n

    Represents a mention made by one issue or pull request to another.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isCrossRepository (Boolean!)

    Reference originated in a different repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    referencedAt (DateTime!)

    Identifies when the reference was made.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    source (ReferencedSubject!)

    Issue or pull request that made the reference.

    \n\n\n\n\n\n\n\n\n\n\n\n

    target (ReferencedSubject!)

    Issue or pull request to which the reference was made.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    willCloseTarget (Boolean!)

    Checks if the target will be closed when the source is merged.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n DemilestonedEvent\n

    \n

    Represents ademilestonedevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    milestoneTitle (String!)

    Identifies the milestone title associated with thedemilestonedevent.

    \n\n\n\n\n\n\n\n\n\n\n\n

    subject (MilestoneItem!)

    Object referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n DeployKey\n

    \n

    A repository deploy key.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    key (String!)

    The deploy key.

    \n\n\n\n\n\n\n\n\n\n\n\n

    readOnly (Boolean!)

    Whether or not the deploy key is read only.

    \n\n\n\n\n\n\n\n\n\n\n\n

    title (String!)

    The deploy key title.

    \n\n\n\n\n\n\n\n\n\n\n\n

    verified (Boolean!)

    Whether or not the deploy key has been verified.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n DeployKeyConnection\n

    \n

    The connection type for DeployKey.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([DeployKeyEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([DeployKey])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n DeployKeyEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (DeployKey)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n DeployedEvent\n

    \n

    Represents adeployedevent on a given pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    deployment (Deployment!)

    The deployment associated with thedeployedevent.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    PullRequest referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ref (Ref)

    The ref associated with thedeployedevent.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Deployment\n

    \n

    Represents triggered deployment instance.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    commit (Commit)

    Identifies the commit sha of the deployment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commitOid (String!)

    Identifies the oid of the deployment commit, even if the commit has been deleted.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    creator (Actor!)

    Identifies the actor who triggered the deployment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String)

    The deployment description.

    \n\n\n\n\n\n\n\n\n\n\n\n

    environment (String)

    The latest environment to which this deployment was made.

    \n\n\n\n\n\n\n\n\n\n\n\n

    latestEnvironment (String)

    The latest environment to which this deployment was made.

    \n\n\n\n\n\n\n\n\n\n\n\n

    latestStatus (DeploymentStatus)

    The latest status of this deployment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    originalEnvironment (String)

    The original environment to which this deployment was made.

    \n\n\n\n\n\n\n\n\n\n\n\n

    payload (String)

    Extra information that a deployment system might need.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ref (Ref)

    Identifies the Ref of the deployment, if the deployment was created by ref.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository!)

    Identifies the repository associated with the deployment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    state (DeploymentState)

    The current state of the deployment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    statuses (DeploymentStatusConnection)

    A list of statuses associated with the deployment.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    task (String)

    The deployment task.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n DeploymentConnection\n

    \n

    The connection type for Deployment.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([DeploymentEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Deployment])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n DeploymentEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (Deployment)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n DeploymentEnvironmentChangedEvent\n

    \n

    Represents adeployment_environment_changedevent on a given pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    deploymentStatus (DeploymentStatus!)

    The deployment status that updated the deployment environment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    PullRequest referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n DeploymentStatus\n

    \n

    Describes the status of a given deployment attempt.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    creator (Actor!)

    Identifies the actor who triggered the deployment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    deployment (Deployment!)

    Identifies the deployment associated with status.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String)

    Identifies the description of the deployment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    environment (String)

    Identifies the environment of the deployment at the time of this deployment status.

    \n\n\n\n\n
    \n

    Preview notice

    \n

    environment is available under the Deployments preview. During the preview period, the API may change without notice.

    \n
    \n\n\n\n\n\n\n\n\n

    environmentUrl (URI)

    Identifies the environment URL of the deployment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    logUrl (URI)

    Identifies the log URL of the deployment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    state (DeploymentStatusState!)

    Identifies the current state of the deployment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n DeploymentStatusConnection\n

    \n

    The connection type for DeploymentStatus.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([DeploymentStatusEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([DeploymentStatus])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n DeploymentStatusEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (DeploymentStatus)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n DisconnectedEvent\n

    \n

    Represents adisconnectedevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isCrossRepository (Boolean!)

    Reference originated in a different repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    source (ReferencedSubject!)

    Issue or pull request from which the issue was disconnected.

    \n\n\n\n\n\n\n\n\n\n\n\n

    subject (ReferencedSubject!)

    Issue or pull request which was disconnected.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Enterprise\n

    \n

    An account to manage multiple organizations with consolidated policy and billing.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    avatarUrl (URI!)

    A URL pointing to the enterprise's public avatar.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    size (Int)

    \n

    The size of the resulting square image.

    \n\n
    \n\n
    \n\n\n

    billingInfo (EnterpriseBillingInfo)

    Enterprise billing information visible to enterprise billing managers.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String)

    The description of the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    descriptionHTML (HTML!)

    The description of the enterprise as HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    location (String)

    The location of the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    members (EnterpriseMemberConnection!)

    A list of users who are members of this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    deployment (EnterpriseUserDeployment)

    \n

    Only return members within the selected GitHub Enterprise deployment.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (EnterpriseMemberOrder)

    \n

    Ordering options for members returned from the connection.

    \n\n
    \n\n
    \n

    organizationLogins ([String!])

    \n

    Only return members within the organizations with these logins.

    \n\n
    \n\n
    \n

    query (String)

    \n

    The search string to look for.

    \n\n
    \n\n
    \n

    role (EnterpriseUserAccountMembershipRole)

    \n

    The role of the user in the enterprise organization or server.

    \n\n
    \n\n
    \n\n\n

    name (String!)

    The name of the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizations (OrganizationConnection!)

    A list of organizations that belong to this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (OrganizationOrder)

    \n

    Ordering options for organizations returned from the connection.

    \n\n
    \n\n
    \n

    query (String)

    \n

    The search string to look for.

    \n\n
    \n\n
    \n\n\n

    ownerInfo (EnterpriseOwnerInfo)

    Enterprise information only visible to enterprise owners.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    slug (String!)

    The URL-friendly identifier for the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userAccounts (EnterpriseUserAccountConnection!)

    A list of user accounts on this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    viewerIsAdmin (Boolean!)

    Is the current viewer an admin of this enterprise?.

    \n\n\n\n\n\n\n\n\n\n\n\n

    websiteUrl (URI)

    The URL of the enterprise website.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseAdministratorConnection\n

    \n

    The connection type for User.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([EnterpriseAdministratorEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([User])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseAdministratorEdge\n

    \n

    A User who is an administrator of an enterprise.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (User)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n

    role (EnterpriseAdministratorRole!)

    The role of the administrator.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseAdministratorInvitation\n

    \n

    An invitation for a user to become an owner or billing manager of an enterprise.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    email (String)

    The email of the person who was invited to the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterprise (Enterprise!)

    The enterprise the invitation is for.

    \n\n\n\n\n\n\n\n\n\n\n\n

    invitee (User)

    The user who was invited to the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    inviter (User)

    The user who created the invitation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    role (EnterpriseAdministratorRole!)

    The invitee's pending role in the enterprise (owner or billing_manager).

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseAdministratorInvitationConnection\n

    \n

    The connection type for EnterpriseAdministratorInvitation.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([EnterpriseAdministratorInvitationEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([EnterpriseAdministratorInvitation])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseAdministratorInvitationEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (EnterpriseAdministratorInvitation)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseBillingInfo\n

    \n

    Enterprise billing information visible to enterprise billing managers and owners.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    allLicensableUsersCount (Int!)

    The number of licenseable users/emails across the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    assetPacks (Int!)

    The number of data packs used by all organizations owned by the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    availableSeats (Int!)

    The number of available seats across all owned organizations based on the unique number of billable users.

    \n\n\n\n\n\n\n
    \n

    Deprecation notice

    \n

    availableSeats is deprecated.

    availableSeats will be replaced with totalAvailableLicenses to provide more clarity on the value being returned Use EnterpriseBillingInfo.totalAvailableLicenses instead. Removal on 2020-01-01 UTC.

    \n
    \n\n\n\n\n\n\n

    bandwidthQuota (Float!)

    The bandwidth quota in GB for all organizations owned by the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bandwidthUsage (Float!)

    The bandwidth usage in GB for all organizations owned by the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bandwidthUsagePercentage (Int!)

    The bandwidth usage as a percentage of the bandwidth quota.

    \n\n\n\n\n\n\n\n\n\n\n\n

    seats (Int!)

    The total seats across all organizations owned by the enterprise.

    \n\n\n\n\n\n\n
    \n

    Deprecation notice

    \n

    seats is deprecated.

    seats will be replaced with totalLicenses to provide more clarity on the value being returned Use EnterpriseBillingInfo.totalLicenses instead. Removal on 2020-01-01 UTC.

    \n
    \n\n\n\n\n\n\n

    storageQuota (Float!)

    The storage quota in GB for all organizations owned by the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    storageUsage (Float!)

    The storage usage in GB for all organizations owned by the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    storageUsagePercentage (Int!)

    The storage usage as a percentage of the storage quota.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalAvailableLicenses (Int!)

    The number of available licenses across all owned organizations based on the unique number of billable users.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalLicenses (Int!)

    The total number of licenses allocated.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseIdentityProvider\n

    \n

    An identity provider configured to provision identities for an enterprise.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    digestMethod (SamlDigestAlgorithm)

    The digest algorithm used to sign SAML requests for the identity provider.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterprise (Enterprise)

    The enterprise this identity provider belongs to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    externalIdentities (ExternalIdentityConnection!)

    ExternalIdentities provisioned by this identity provider.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    idpCertificate (X509Certificate)

    The x509 certificate used by the identity provider to sign assertions and responses.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issuer (String)

    The Issuer Entity ID for the SAML identity provider.

    \n\n\n\n\n\n\n\n\n\n\n\n

    recoveryCodes ([String!])

    Recovery codes that can be used by admins to access the enterprise if the identity provider is unavailable.

    \n\n\n\n\n\n\n\n\n\n\n\n

    signatureMethod (SamlSignatureAlgorithm)

    The signature algorithm used to sign SAML requests for the identity provider.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ssoUrl (URI)

    The URL endpoint for the identity provider's SAML SSO.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseMemberConnection\n

    \n

    The connection type for EnterpriseMember.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([EnterpriseMemberEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([EnterpriseMember])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseMemberEdge\n

    \n

    A User who is a member of an enterprise through one or more organizations.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isUnlicensed (Boolean!)

    Whether the user does not have a license for the enterprise.

    \n\n\n\n\n\n\n
    \n

    Deprecation notice

    \n

    isUnlicensed is deprecated.

    All members consume a license Removal on 2021-01-01 UTC.

    \n
    \n\n\n\n\n\n\n

    node (EnterpriseMember)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseOrganizationMembershipConnection\n

    \n

    The connection type for Organization.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([EnterpriseOrganizationMembershipEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Organization])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseOrganizationMembershipEdge\n

    \n

    An enterprise organization that a user is a member of.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (Organization)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n

    role (EnterpriseUserAccountMembershipRole!)

    The role of the user in the enterprise membership.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseOutsideCollaboratorConnection\n

    \n

    The connection type for User.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([EnterpriseOutsideCollaboratorEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([User])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseOutsideCollaboratorEdge\n

    \n

    A User who is an outside collaborator of an enterprise through one or more organizations.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isUnlicensed (Boolean!)

    Whether the outside collaborator does not have a license for the enterprise.

    \n\n\n\n\n\n\n
    \n

    Deprecation notice

    \n

    isUnlicensed is deprecated.

    All outside collaborators consume a license Removal on 2021-01-01 UTC.

    \n
    \n\n\n\n\n\n\n

    node (User)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositories (EnterpriseRepositoryInfoConnection!)

    The enterprise organization repositories this user is a member of.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (RepositoryOrder)

    \n

    Ordering options for repositories.

    \n\n
    \n\n
    \n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseOwnerInfo\n

    \n

    Enterprise information only visible to enterprise owners.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    admins (EnterpriseAdministratorConnection!)

    A list of all of the administrators for this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (EnterpriseMemberOrder)

    \n

    Ordering options for administrators returned from the connection.

    \n\n
    \n\n
    \n

    query (String)

    \n

    The search string to look for.

    \n\n
    \n\n
    \n

    role (EnterpriseAdministratorRole)

    \n

    The role to filter by.

    \n\n
    \n\n
    \n\n\n

    affiliatedUsersWithTwoFactorDisabled (UserConnection!)

    A list of users in the enterprise who currently have two-factor authentication disabled.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    affiliatedUsersWithTwoFactorDisabledExist (Boolean!)

    Whether or not affiliated users with two-factor authentication disabled exist in the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    allowPrivateRepositoryForkingSetting (EnterpriseEnabledDisabledSettingValue!)

    The setting value for whether private repository forking is enabled for repositories in organizations in this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    allowPrivateRepositoryForkingSettingOrganizations (OrganizationConnection!)

    A list of enterprise organizations configured with the provided private repository forking setting value.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (OrganizationOrder)

    \n

    Ordering options for organizations with this setting.

    \n\n
    \n\n
    \n

    value (Boolean!)

    \n

    The setting value to find organizations for.

    \n\n
    \n\n
    \n\n\n

    defaultRepositoryPermissionSetting (EnterpriseDefaultRepositoryPermissionSettingValue!)

    The setting value for base repository permissions for organizations in this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    defaultRepositoryPermissionSettingOrganizations (OrganizationConnection!)

    A list of enterprise organizations configured with the provided default repository permission.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (OrganizationOrder)

    \n

    Ordering options for organizations with this setting.

    \n\n
    \n\n
    \n

    value (DefaultRepositoryPermissionField!)

    \n

    The permission to find organizations for.

    \n\n
    \n\n
    \n\n\n

    ipAllowListEnabledSetting (IpAllowListEnabledSettingValue!)

    The setting value for whether the enterprise has an IP allow list enabled.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ipAllowListEntries (IpAllowListEntryConnection!)

    The IP addresses that are allowed to access resources owned by the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (IpAllowListEntryOrder)

    \n

    Ordering options for IP allow list entries returned.

    \n\n
    \n\n
    \n\n\n

    isUpdatingDefaultRepositoryPermission (Boolean!)

    Whether or not the default repository permission is currently being updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isUpdatingTwoFactorRequirement (Boolean!)

    Whether the two-factor authentication requirement is currently being enforced.

    \n\n\n\n\n\n\n\n\n\n\n\n

    membersCanChangeRepositoryVisibilitySetting (EnterpriseEnabledDisabledSettingValue!)

    The setting value for whether organization members with admin permissions on a\nrepository can change repository visibility.

    \n\n\n\n\n\n\n\n\n\n\n\n

    membersCanChangeRepositoryVisibilitySettingOrganizations (OrganizationConnection!)

    A list of enterprise organizations configured with the provided can change repository visibility setting value.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (OrganizationOrder)

    \n

    Ordering options for organizations with this setting.

    \n\n
    \n\n
    \n

    value (Boolean!)

    \n

    The setting value to find organizations for.

    \n\n
    \n\n
    \n\n\n

    membersCanCreateInternalRepositoriesSetting (Boolean)

    The setting value for whether members of organizations in the enterprise can create internal repositories.

    \n\n\n\n\n\n\n\n\n\n\n\n

    membersCanCreatePrivateRepositoriesSetting (Boolean)

    The setting value for whether members of organizations in the enterprise can create private repositories.

    \n\n\n\n\n\n\n\n\n\n\n\n

    membersCanCreatePublicRepositoriesSetting (Boolean)

    The setting value for whether members of organizations in the enterprise can create public repositories.

    \n\n\n\n\n\n\n\n\n\n\n\n

    membersCanCreateRepositoriesSetting (EnterpriseMembersCanCreateRepositoriesSettingValue)

    The setting value for whether members of organizations in the enterprise can create repositories.

    \n\n\n\n\n\n\n\n\n\n\n\n

    membersCanCreateRepositoriesSettingOrganizations (OrganizationConnection!)

    A list of enterprise organizations configured with the provided repository creation setting value.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (OrganizationOrder)

    \n

    Ordering options for organizations with this setting.

    \n\n
    \n\n
    \n

    value (OrganizationMembersCanCreateRepositoriesSettingValue!)

    \n

    The setting to find organizations for.

    \n\n
    \n\n
    \n\n\n

    membersCanDeleteIssuesSetting (EnterpriseEnabledDisabledSettingValue!)

    The setting value for whether members with admin permissions for repositories can delete issues.

    \n\n\n\n\n\n\n\n\n\n\n\n

    membersCanDeleteIssuesSettingOrganizations (OrganizationConnection!)

    A list of enterprise organizations configured with the provided members can delete issues setting value.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (OrganizationOrder)

    \n

    Ordering options for organizations with this setting.

    \n\n
    \n\n
    \n

    value (Boolean!)

    \n

    The setting value to find organizations for.

    \n\n
    \n\n
    \n\n\n

    membersCanDeleteRepositoriesSetting (EnterpriseEnabledDisabledSettingValue!)

    The setting value for whether members with admin permissions for repositories can delete or transfer repositories.

    \n\n\n\n\n\n\n\n\n\n\n\n

    membersCanDeleteRepositoriesSettingOrganizations (OrganizationConnection!)

    A list of enterprise organizations configured with the provided members can delete repositories setting value.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (OrganizationOrder)

    \n

    Ordering options for organizations with this setting.

    \n\n
    \n\n
    \n

    value (Boolean!)

    \n

    The setting value to find organizations for.

    \n\n
    \n\n
    \n\n\n

    membersCanInviteCollaboratorsSetting (EnterpriseEnabledDisabledSettingValue!)

    The setting value for whether members of organizations in the enterprise can invite outside collaborators.

    \n\n\n\n\n\n\n\n\n\n\n\n

    membersCanInviteCollaboratorsSettingOrganizations (OrganizationConnection!)

    A list of enterprise organizations configured with the provided members can invite collaborators setting value.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (OrganizationOrder)

    \n

    Ordering options for organizations with this setting.

    \n\n
    \n\n
    \n

    value (Boolean!)

    \n

    The setting value to find organizations for.

    \n\n
    \n\n
    \n\n\n

    membersCanMakePurchasesSetting (EnterpriseMembersCanMakePurchasesSettingValue!)

    Indicates whether members of this enterprise's organizations can purchase additional services for those organizations.

    \n\n\n\n\n\n\n\n\n\n\n\n

    membersCanUpdateProtectedBranchesSetting (EnterpriseEnabledDisabledSettingValue!)

    The setting value for whether members with admin permissions for repositories can update protected branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    membersCanUpdateProtectedBranchesSettingOrganizations (OrganizationConnection!)

    A list of enterprise organizations configured with the provided members can update protected branches setting value.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (OrganizationOrder)

    \n

    Ordering options for organizations with this setting.

    \n\n
    \n\n
    \n

    value (Boolean!)

    \n

    The setting value to find organizations for.

    \n\n
    \n\n
    \n\n\n

    membersCanViewDependencyInsightsSetting (EnterpriseEnabledDisabledSettingValue!)

    The setting value for whether members can view dependency insights.

    \n\n\n\n\n\n\n\n\n\n\n\n

    membersCanViewDependencyInsightsSettingOrganizations (OrganizationConnection!)

    A list of enterprise organizations configured with the provided members can view dependency insights setting value.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (OrganizationOrder)

    \n

    Ordering options for organizations with this setting.

    \n\n
    \n\n
    \n

    value (Boolean!)

    \n

    The setting value to find organizations for.

    \n\n
    \n\n
    \n\n\n

    organizationProjectsSetting (EnterpriseEnabledDisabledSettingValue!)

    The setting value for whether organization projects are enabled for organizations in this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationProjectsSettingOrganizations (OrganizationConnection!)

    A list of enterprise organizations configured with the provided organization projects setting value.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (OrganizationOrder)

    \n

    Ordering options for organizations with this setting.

    \n\n
    \n\n
    \n

    value (Boolean!)

    \n

    The setting value to find organizations for.

    \n\n
    \n\n
    \n\n\n

    outsideCollaborators (EnterpriseOutsideCollaboratorConnection!)

    A list of outside collaborators across the repositories in the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    login (String)

    \n

    The login of one specific outside collaborator.

    \n\n
    \n\n
    \n

    orderBy (EnterpriseMemberOrder)

    \n

    Ordering options for outside collaborators returned from the connection.

    \n\n
    \n\n
    \n

    query (String)

    \n

    The search string to look for.

    \n\n
    \n\n
    \n

    visibility (RepositoryVisibility)

    \n

    Only return outside collaborators on repositories with this visibility.

    \n\n
    \n\n
    \n\n\n

    pendingAdminInvitations (EnterpriseAdministratorInvitationConnection!)

    A list of pending administrator invitations for the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (EnterpriseAdministratorInvitationOrder)

    \n

    Ordering options for pending enterprise administrator invitations returned from the connection.

    \n\n
    \n\n
    \n

    query (String)

    \n

    The search string to look for.

    \n\n
    \n\n
    \n

    role (EnterpriseAdministratorRole)

    \n

    The role to filter by.

    \n\n
    \n\n
    \n\n\n

    pendingCollaboratorInvitations (RepositoryInvitationConnection!)

    A list of pending collaborator invitations across the repositories in the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (RepositoryInvitationOrder)

    \n

    Ordering options for pending repository collaborator invitations returned from the connection.

    \n\n
    \n\n
    \n

    query (String)

    \n

    The search string to look for.

    \n\n
    \n\n
    \n\n\n

    pendingCollaborators (EnterprisePendingCollaboratorConnection!)

    A list of pending collaborators across the repositories in the enterprise.

    \n\n\n\n\n\n\n
    \n

    Deprecation notice

    \n

    pendingCollaborators is deprecated.

    Repository invitations can now be associated with an email, not only an invitee. Use the pendingCollaboratorInvitations field instead. Removal on 2020-10-01 UTC.

    \n
    \n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (RepositoryInvitationOrder)

    \n

    Ordering options for pending repository collaborator invitations returned from the connection.

    \n\n
    \n\n
    \n

    query (String)

    \n

    The search string to look for.

    \n\n
    \n\n
    \n\n\n

    pendingMemberInvitations (EnterprisePendingMemberInvitationConnection!)

    A list of pending member invitations for organizations in the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    query (String)

    \n

    The search string to look for.

    \n\n
    \n\n
    \n\n\n

    repositoryProjectsSetting (EnterpriseEnabledDisabledSettingValue!)

    The setting value for whether repository projects are enabled in this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryProjectsSettingOrganizations (OrganizationConnection!)

    A list of enterprise organizations configured with the provided repository projects setting value.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (OrganizationOrder)

    \n

    Ordering options for organizations with this setting.

    \n\n
    \n\n
    \n

    value (Boolean!)

    \n

    The setting value to find organizations for.

    \n\n
    \n\n
    \n\n\n

    samlIdentityProvider (EnterpriseIdentityProvider)

    The SAML Identity Provider for the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    samlIdentityProviderSettingOrganizations (OrganizationConnection!)

    A list of enterprise organizations configured with the SAML single sign-on setting value.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (OrganizationOrder)

    \n

    Ordering options for organizations with this setting.

    \n\n
    \n\n
    \n

    value (IdentityProviderConfigurationState!)

    \n

    The setting value to find organizations for.

    \n\n
    \n\n
    \n\n\n

    teamDiscussionsSetting (EnterpriseEnabledDisabledSettingValue!)

    The setting value for whether team discussions are enabled for organizations in this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamDiscussionsSettingOrganizations (OrganizationConnection!)

    A list of enterprise organizations configured with the provided team discussions setting value.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (OrganizationOrder)

    \n

    Ordering options for organizations with this setting.

    \n\n
    \n\n
    \n

    value (Boolean!)

    \n

    The setting value to find organizations for.

    \n\n
    \n\n
    \n\n\n

    twoFactorRequiredSetting (EnterpriseEnabledSettingValue!)

    The setting value for whether the enterprise requires two-factor authentication for its organizations and users.

    \n\n\n\n\n\n\n\n\n\n\n\n

    twoFactorRequiredSettingOrganizations (OrganizationConnection!)

    A list of enterprise organizations configured with the two-factor authentication setting value.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (OrganizationOrder)

    \n

    Ordering options for organizations with this setting.

    \n\n
    \n\n
    \n

    value (Boolean!)

    \n

    The setting value to find organizations for.

    \n\n
    \n\n
    \n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterprisePendingCollaboratorConnection\n

    \n

    The connection type for User.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([EnterprisePendingCollaboratorEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([User])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterprisePendingCollaboratorEdge\n

    \n

    A user with an invitation to be a collaborator on a repository owned by an organization in an enterprise.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isUnlicensed (Boolean!)

    Whether the invited collaborator does not have a license for the enterprise.

    \n\n\n\n\n\n\n
    \n

    Deprecation notice

    \n

    isUnlicensed is deprecated.

    All pending collaborators consume a license Removal on 2021-01-01 UTC.

    \n
    \n\n\n\n\n\n\n

    node (User)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositories (EnterpriseRepositoryInfoConnection!)

    The enterprise organization repositories this user is a member of.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (RepositoryOrder)

    \n

    Ordering options for repositories.

    \n\n
    \n\n
    \n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterprisePendingMemberInvitationConnection\n

    \n

    The connection type for OrganizationInvitation.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([EnterprisePendingMemberInvitationEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([OrganizationInvitation])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalUniqueUserCount (Int!)

    Identifies the total count of unique users in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterprisePendingMemberInvitationEdge\n

    \n

    An invitation to be a member in an enterprise organization.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isUnlicensed (Boolean!)

    Whether the invitation has a license for the enterprise.

    \n\n\n\n\n\n\n
    \n

    Deprecation notice

    \n

    isUnlicensed is deprecated.

    All pending members consume a license Removal on 2020-07-01 UTC.

    \n
    \n\n\n\n\n\n\n

    node (OrganizationInvitation)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseRepositoryInfo\n

    \n

    A subset of repository information queryable from an enterprise.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    isPrivate (Boolean!)

    Identifies if the repository is private.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The repository's name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nameWithOwner (String!)

    The repository's name with owner.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseRepositoryInfoConnection\n

    \n

    The connection type for EnterpriseRepositoryInfo.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([EnterpriseRepositoryInfoEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([EnterpriseRepositoryInfo])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseRepositoryInfoEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (EnterpriseRepositoryInfo)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseServerInstallation\n

    \n

    An Enterprise Server installation.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    customerName (String!)

    The customer name to which the Enterprise Server installation belongs.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hostName (String!)

    The host name of the Enterprise Server installation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isConnected (Boolean!)

    Whether or not the installation is connected to an Enterprise Server installation via GitHub Connect.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userAccounts (EnterpriseServerUserAccountConnection!)

    User accounts on this Enterprise Server installation.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (EnterpriseServerUserAccountOrder)

    \n

    Ordering options for Enterprise Server user accounts returned from the connection.

    \n\n
    \n\n
    \n\n\n

    userAccountsUploads (EnterpriseServerUserAccountsUploadConnection!)

    User accounts uploads for the Enterprise Server installation.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (EnterpriseServerUserAccountsUploadOrder)

    \n

    Ordering options for Enterprise Server user accounts uploads returned from the connection.

    \n\n
    \n\n
    \n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseServerUserAccount\n

    \n

    A user account on an Enterprise Server installation.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    emails (EnterpriseServerUserAccountEmailConnection!)

    User emails belonging to this user account.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (EnterpriseServerUserAccountEmailOrder)

    \n

    Ordering options for Enterprise Server user account emails returned from the connection.

    \n\n
    \n\n
    \n\n\n

    enterpriseServerInstallation (EnterpriseServerInstallation!)

    The Enterprise Server installation on which this user account exists.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isSiteAdmin (Boolean!)

    Whether the user account is a site administrator on the Enterprise Server installation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    login (String!)

    The login of the user account on the Enterprise Server installation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    profileName (String)

    The profile name of the user account on the Enterprise Server installation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    remoteCreatedAt (DateTime!)

    The date and time when the user account was created on the Enterprise Server installation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    remoteUserId (Int!)

    The ID of the user account on the Enterprise Server installation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseServerUserAccountConnection\n

    \n

    The connection type for EnterpriseServerUserAccount.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([EnterpriseServerUserAccountEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([EnterpriseServerUserAccount])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseServerUserAccountEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (EnterpriseServerUserAccount)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseServerUserAccountEmail\n

    \n

    An email belonging to a user account on an Enterprise Server installation.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    email (String!)

    The email address.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isPrimary (Boolean!)

    Indicates whether this is the primary email of the associated user account.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userAccount (EnterpriseServerUserAccount!)

    The user account to which the email belongs.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseServerUserAccountEmailConnection\n

    \n

    The connection type for EnterpriseServerUserAccountEmail.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([EnterpriseServerUserAccountEmailEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([EnterpriseServerUserAccountEmail])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseServerUserAccountEmailEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (EnterpriseServerUserAccountEmail)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseServerUserAccountsUpload\n

    \n

    A user accounts upload from an Enterprise Server installation.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterprise (Enterprise!)

    The enterprise to which this upload belongs.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseServerInstallation (EnterpriseServerInstallation!)

    The Enterprise Server installation for which this upload was generated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The name of the file uploaded.

    \n\n\n\n\n\n\n\n\n\n\n\n

    syncState (EnterpriseServerUserAccountsUploadSyncState!)

    The synchronization state of the upload.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseServerUserAccountsUploadConnection\n

    \n

    The connection type for EnterpriseServerUserAccountsUpload.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([EnterpriseServerUserAccountsUploadEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([EnterpriseServerUserAccountsUpload])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseServerUserAccountsUploadEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (EnterpriseServerUserAccountsUpload)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseUserAccount\n

    \n

    An account for a user who is an admin of an enterprise or a member of an enterprise through one or more organizations.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    avatarUrl (URI!)

    A URL pointing to the enterprise user account's public avatar.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    size (Int)

    \n

    The size of the resulting square image.

    \n\n
    \n\n
    \n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterprise (Enterprise!)

    The enterprise in which this user account exists.

    \n\n\n\n\n\n\n\n\n\n\n\n

    login (String!)

    An identifier for the enterprise user account, a login or email address.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String)

    The name of the enterprise user account.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizations (EnterpriseOrganizationMembershipConnection!)

    A list of enterprise organizations this user is a member of.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (OrganizationOrder)

    \n

    Ordering options for organizations returned from the connection.

    \n\n
    \n\n
    \n

    query (String)

    \n

    The search string to look for.

    \n\n
    \n\n
    \n

    role (EnterpriseUserAccountMembershipRole)

    \n

    The role of the user in the enterprise organization.

    \n\n
    \n\n
    \n\n\n

    resourcePath (URI!)

    The HTTP path for this user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user within the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseUserAccountConnection\n

    \n

    The connection type for EnterpriseUserAccount.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([EnterpriseUserAccountEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([EnterpriseUserAccount])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseUserAccountEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (EnterpriseUserAccount)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ExternalIdentity\n

    \n

    An external identity provisioned by SAML SSO or SCIM.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    guid (String!)

    The GUID for this identity.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationInvitation (OrganizationInvitation)

    Organization invitation for this SCIM-provisioned external identity.

    \n\n\n\n\n\n\n\n\n\n\n\n

    samlIdentity (ExternalIdentitySamlAttributes)

    SAML Identity attributes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    scimIdentity (ExternalIdentityScimAttributes)

    SCIM Identity attributes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    User linked to this external identity. Will be NULL if this identity has not been claimed by an organization member.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ExternalIdentityConnection\n

    \n

    The connection type for ExternalIdentity.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([ExternalIdentityEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([ExternalIdentity])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ExternalIdentityEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (ExternalIdentity)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ExternalIdentitySamlAttributes\n

    \n

    SAML attributes for the External Identity.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    emails ([UserEmailMetadata!])

    The emails associated with the SAML identity.

    \n\n\n\n\n\n\n\n\n\n\n\n

    familyName (String)

    Family name of the SAML identity.

    \n\n\n\n\n\n\n\n\n\n\n\n

    givenName (String)

    Given name of the SAML identity.

    \n\n\n\n\n\n\n\n\n\n\n\n

    groups ([String!])

    The groups linked to this identity in IDP.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nameId (String)

    The NameID of the SAML identity.

    \n\n\n\n\n\n\n\n\n\n\n\n

    username (String)

    The userName of the SAML identity.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ExternalIdentityScimAttributes\n

    \n

    SCIM attributes for the External Identity.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    emails ([UserEmailMetadata!])

    The emails associated with the SCIM identity.

    \n\n\n\n\n\n\n\n\n\n\n\n

    familyName (String)

    Family name of the SCIM identity.

    \n\n\n\n\n\n\n\n\n\n\n\n

    givenName (String)

    Given name of the SCIM identity.

    \n\n\n\n\n\n\n\n\n\n\n\n

    groups ([String!])

    The groups linked to this identity in IDP.

    \n\n\n\n\n\n\n\n\n\n\n\n

    username (String)

    The userName of the SCIM identity.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n FollowerConnection\n

    \n

    The connection type for User.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([UserEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([User])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n FollowingConnection\n

    \n

    The connection type for User.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([UserEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([User])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n GenericHovercardContext\n

    \n

    A generic hovercard context with a message and icon.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    message (String!)

    A string describing this context.

    \n\n\n\n\n\n\n\n\n\n\n\n

    octicon (String!)

    An octicon to accompany this context.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Gist\n

    \n

    A Gist.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    comments (GistCommentConnection!)

    A list of comments associated with the gist.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String)

    The gist description.

    \n\n\n\n\n\n\n\n\n\n\n\n

    files ([GistFile])

    The files in this gist.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    limit (Int)

    \n

    The maximum number of files to return.

    \n

    The default value is 10.

    \n
    \n\n
    \n

    oid (GitObjectID)

    \n

    The oid of the files to return.

    \n\n
    \n\n
    \n\n\n

    forks (GistConnection!)

    A list of forks associated with the gist.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (GistOrder)

    \n

    Ordering options for gists returned from the connection.

    \n\n
    \n\n
    \n\n\n

    isFork (Boolean!)

    Identifies if the gist is a fork.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isPublic (Boolean!)

    Whether the gist is public or not.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The gist name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    owner (RepositoryOwner)

    The gist owner.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pushedAt (DateTime)

    Identifies when the gist was last pushed to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTML path to this resource.

    \n\n\n\n\n\n\n\n\n\n\n\n

    stargazerCount (Int!)

    Returns a count of how many stargazers there are on this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    stargazers (StargazerConnection!)

    A list of users who have starred this starrable.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (StarOrder)

    \n

    Order for connection.

    \n\n
    \n\n
    \n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this Gist.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerHasStarred (Boolean!)

    Returns a boolean indicating whether the viewing user has starred this starrable.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n GistComment\n

    \n

    Represents a comment on an Gist.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    author (Actor)

    The actor who authored the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    authorAssociation (CommentAuthorAssociation!)

    Author's association with the gist.

    \n\n\n\n\n\n\n\n\n\n\n\n

    body (String!)

    Identifies the comment body.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyHTML (HTML!)

    The body rendered to HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyText (String!)

    The body rendered to text.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdViaEmail (Boolean!)

    Check if this comment was created via an email reply.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    editor (Actor)

    The actor who edited the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    gist (Gist!)

    The associated gist.

    \n\n\n\n\n\n\n\n\n\n\n\n

    includesCreatedEdit (Boolean!)

    Check if this comment was edited and includes an edit with the creation data.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isMinimized (Boolean!)

    Returns whether or not a comment has been minimized.

    \n\n\n\n\n\n\n\n\n\n\n\n

    lastEditedAt (DateTime)

    The moment the editor made the last edit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    minimizedReason (String)

    Returns why the comment was minimized.

    \n\n\n\n\n\n\n\n\n\n\n\n

    publishedAt (DateTime)

    Identifies when the comment was published at.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userContentEdits (UserContentEditConnection)

    A list of edits to this content.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    viewerCanDelete (Boolean!)

    Check if the current viewer can delete this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanMinimize (Boolean!)

    Check if the current viewer can minimize this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanUpdate (Boolean!)

    Check if the current viewer can update this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

    Reasons why the current viewer can not update this comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerDidAuthor (Boolean!)

    Did the viewer author this comment.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n GistCommentConnection\n

    \n

    The connection type for GistComment.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([GistCommentEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([GistComment])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n GistCommentEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (GistComment)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n GistConnection\n

    \n

    The connection type for Gist.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([GistEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Gist])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n GistEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (Gist)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n GistFile\n

    \n

    A file in a gist.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    encodedName (String)

    The file name encoded to remove characters that are invalid in URL paths.

    \n\n\n\n\n\n\n\n\n\n\n\n

    encoding (String)

    The gist file encoding.

    \n\n\n\n\n\n\n\n\n\n\n\n

    extension (String)

    The file extension from the file name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isImage (Boolean!)

    Indicates if this file is an image.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isTruncated (Boolean!)

    Whether the file's contents were truncated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    language (Language)

    The programming language this file is written in.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String)

    The gist file name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    size (Int)

    The gist file size in bytes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    text (String)

    UTF8 text data or null if the file is binary.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    truncate (Int)

    \n

    Optionally truncate the returned file to this length.

    \n\n
    \n\n
    \n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n GitActor\n

    \n

    Represents an actor in a Git commit (ie. an author or committer).

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    avatarUrl (URI!)

    A URL pointing to the author's public avatar.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    size (Int)

    \n

    The size of the resulting square image.

    \n\n
    \n\n
    \n\n\n

    date (GitTimestamp)

    The timestamp of the Git action (authoring or committing).

    \n\n\n\n\n\n\n\n\n\n\n\n

    email (String)

    The email in the Git commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String)

    The name in the Git commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The GitHub user corresponding to the email field. Null if no such user exists.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n GitActorConnection\n

    \n

    The connection type for GitActor.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([GitActorEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([GitActor])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n GitActorEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (GitActor)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n GitHubMetadata\n

    \n

    Represents information about the GitHub instance.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    gitHubServicesSha (GitObjectID!)

    Returns a String that's a SHA of github-services.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isPasswordAuthenticationVerifiable (Boolean!)

    Whether or not users are verified.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n GpgSignature\n

    \n

    Represents a GPG signature on a Commit or Tag.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    email (String!)

    Email used to sign this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isValid (Boolean!)

    True if the signature is valid and verified by GitHub.

    \n\n\n\n\n\n\n\n\n\n\n\n

    keyId (String)

    Hex-encoded ID of the key that signed this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    payload (String!)

    Payload for GPG signing object. Raw ODB object without the signature header.

    \n\n\n\n\n\n\n\n\n\n\n\n

    signature (String!)

    ASCII-armored signature header from object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    signer (User)

    GitHub user corresponding to the email signing this commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    state (GitSignatureState!)

    The state of this signature. VALID if signature is valid and verified by\nGitHub, otherwise represents reason why signature is considered invalid.

    \n\n\n\n\n\n\n\n\n\n\n\n

    wasSignedByGitHub (Boolean!)

    True if the signature was made with GitHub's signing key.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n HeadRefDeletedEvent\n

    \n

    Represents ahead_ref_deletedevent on a given pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    headRef (Ref)

    Identifies the Ref associated with the head_ref_deleted event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    headRefName (String!)

    Identifies the name of the Ref associated with the head_ref_deleted event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    PullRequest referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n HeadRefForcePushedEvent\n

    \n

    Represents ahead_ref_force_pushedevent on a given pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    afterCommit (Commit)

    Identifies the after commit SHA for thehead_ref_force_pushedevent.

    \n\n\n\n\n\n\n\n\n\n\n\n

    beforeCommit (Commit)

    Identifies the before commit SHA for thehead_ref_force_pushedevent.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    PullRequest referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ref (Ref)

    Identifies the fully qualified ref name for thehead_ref_force_pushedevent.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n HeadRefRestoredEvent\n

    \n

    Represents ahead_ref_restoredevent on a given pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    PullRequest referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Hovercard\n

    \n

    Detail needed to display a hovercard for a user.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    contexts ([HovercardContext!]!)

    Each of the contexts for this hovercard.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n IpAllowListEntry\n

    \n

    An IP address or range of addresses that is allowed to access an owner's resources.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    allowListValue (String!)

    A single IP address or range of IP addresses in CIDR notation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isActive (Boolean!)

    Whether the entry is currently active.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String)

    The name of the IP allow list entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    owner (IpAllowListOwner!)

    The owner of the IP allow list entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n IpAllowListEntryConnection\n

    \n

    The connection type for IpAllowListEntry.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([IpAllowListEntryEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([IpAllowListEntry])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n IpAllowListEntryEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (IpAllowListEntry)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Issue\n

    \n

    An Issue is a place to discuss ideas, enhancements, tasks, and bugs for a project.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    activeLockReason (LockReason)

    Reason that the conversation was locked.

    \n\n\n\n\n\n\n\n\n\n\n\n

    assignees (UserConnection!)

    A list of Users assigned to this object.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    author (Actor)

    The actor who authored the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    authorAssociation (CommentAuthorAssociation!)

    Author's association with the subject of the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    body (String!)

    Identifies the body of the issue.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyHTML (HTML!)

    The body rendered to HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyResourcePath (URI!)

    The http path for this issue body.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyText (String!)

    Identifies the body of the issue rendered to text.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyUrl (URI!)

    The http URL for this issue body.

    \n\n\n\n\n\n\n\n\n\n\n\n

    closed (Boolean!)

    true if the object is closed (definition of closed may depend on type).

    \n\n\n\n\n\n\n\n\n\n\n\n

    closedAt (DateTime)

    Identifies the date and time when the object was closed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    comments (IssueCommentConnection!)

    A list of comments associated with the Issue.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (IssueCommentOrder)

    \n

    Ordering options for issue comments returned from the connection.

    \n\n
    \n\n
    \n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdViaEmail (Boolean!)

    Check if this comment was created via an email reply.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    editor (Actor)

    The actor who edited the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hovercard (Hovercard!)

    The hovercard information for this issue.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    includeNotificationContexts (Boolean)

    \n

    Whether or not to include notification contexts.

    \n

    The default value is true.

    \n
    \n\n
    \n\n\n

    includesCreatedEdit (Boolean!)

    Check if this comment was edited and includes an edit with the creation data.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isReadByViewer (Boolean)

    Is this issue read by the viewer.

    \n\n\n\n\n\n\n\n\n\n\n\n

    labels (LabelConnection)

    A list of labels associated with the object.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (LabelOrder)

    \n

    Ordering options for labels returned from the connection.

    \n\n
    \n\n
    \n\n\n

    lastEditedAt (DateTime)

    The moment the editor made the last edit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    locked (Boolean!)

    true if the object is locked.

    \n\n\n\n\n\n\n\n\n\n\n\n

    milestone (Milestone)

    Identifies the milestone associated with the issue.

    \n\n\n\n\n\n\n\n\n\n\n\n

    number (Int!)

    Identifies the issue number.

    \n\n\n\n\n\n\n\n\n\n\n\n

    participants (UserConnection!)

    A list of Users that are participating in the Issue conversation.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    projectCards (ProjectCardConnection!)

    List of project cards associated with this issue.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    archivedStates ([ProjectCardArchivedState])

    \n

    A list of archived states to filter the cards by.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    publishedAt (DateTime)

    Identifies when the comment was published at.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reactionGroups ([ReactionGroup!])

    A list of reactions grouped by content left on the subject.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reactions (ReactionConnection!)

    A list of Reactions left on the Issue.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    content (ReactionContent)

    \n

    Allows filtering Reactions by emoji.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (ReactionOrder)

    \n

    Allows specifying the order in which reactions are returned.

    \n\n
    \n\n
    \n\n\n

    repository (Repository!)

    The repository associated with this node.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this issue.

    \n\n\n\n\n\n\n\n\n\n\n\n

    state (IssueState!)

    Identifies the state of the issue.

    \n\n\n\n\n\n\n\n\n\n\n\n

    timeline (IssueTimelineConnection!)

    A list of events, comments, commits, etc. associated with the issue.

    \n\n\n\n\n\n\n
    \n

    Deprecation notice

    \n

    timeline is deprecated.

    timeline will be removed Use Issue.timelineItems instead. Removal on 2020-10-01 UTC.

    \n
    \n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    since (DateTime)

    \n

    Allows filtering timeline events by a since timestamp.

    \n\n
    \n\n
    \n\n\n

    timelineItems (IssueTimelineItemsConnection!)

    A list of events, comments, commits, etc. associated with the issue.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    itemTypes ([IssueTimelineItemsItemType!])

    \n

    Filter timeline items by type.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    since (DateTime)

    \n

    Filter timeline items by a since timestamp.

    \n\n
    \n\n
    \n

    skip (Int)

    \n

    Skips the first n elements in the list.

    \n\n
    \n\n
    \n\n\n

    title (String!)

    Identifies the issue title.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this issue.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userContentEdits (UserContentEditConnection)

    A list of edits to this content.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    viewerCanReact (Boolean!)

    Can user react to this subject.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanSubscribe (Boolean!)

    Check if the viewer is able to change their subscription status for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanUpdate (Boolean!)

    Check if the current viewer can update this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

    Reasons why the current viewer can not update this comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerDidAuthor (Boolean!)

    Did the viewer author this comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerSubscription (SubscriptionState)

    Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n IssueComment\n

    \n

    Represents a comment on an Issue.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    author (Actor)

    The actor who authored the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    authorAssociation (CommentAuthorAssociation!)

    Author's association with the subject of the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    body (String!)

    The body as Markdown.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyHTML (HTML!)

    The body rendered to HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyText (String!)

    The body rendered to text.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdViaEmail (Boolean!)

    Check if this comment was created via an email reply.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    editor (Actor)

    The actor who edited the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    includesCreatedEdit (Boolean!)

    Check if this comment was edited and includes an edit with the creation data.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isMinimized (Boolean!)

    Returns whether or not a comment has been minimized.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issue (Issue!)

    Identifies the issue associated with the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    lastEditedAt (DateTime)

    The moment the editor made the last edit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    minimizedReason (String)

    Returns why the comment was minimized.

    \n\n\n\n\n\n\n\n\n\n\n\n

    publishedAt (DateTime)

    Identifies when the comment was published at.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest)

    Returns the pull request associated with the comment, if this comment was made on a\npull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reactionGroups ([ReactionGroup!])

    A list of reactions grouped by content left on the subject.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reactions (ReactionConnection!)

    A list of Reactions left on the Issue.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    content (ReactionContent)

    \n

    Allows filtering Reactions by emoji.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (ReactionOrder)

    \n

    Allows specifying the order in which reactions are returned.

    \n\n
    \n\n
    \n\n\n

    repository (Repository!)

    The repository associated with this node.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this issue comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this issue comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userContentEdits (UserContentEditConnection)

    A list of edits to this content.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    viewerCanDelete (Boolean!)

    Check if the current viewer can delete this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanMinimize (Boolean!)

    Check if the current viewer can minimize this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanReact (Boolean!)

    Can user react to this subject.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanUpdate (Boolean!)

    Check if the current viewer can update this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

    Reasons why the current viewer can not update this comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerDidAuthor (Boolean!)

    Did the viewer author this comment.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n IssueCommentConnection\n

    \n

    The connection type for IssueComment.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([IssueCommentEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([IssueComment])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n IssueCommentEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (IssueComment)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n IssueConnection\n

    \n

    The connection type for Issue.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([IssueEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Issue])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n IssueContributionsByRepository\n

    \n

    This aggregates issues opened by a user within one repository.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    contributions (CreatedIssueContributionConnection!)

    The issue contributions.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (ContributionOrder)

    \n

    Ordering options for contributions returned from the connection.

    \n\n
    \n\n
    \n\n\n

    repository (Repository!)

    The repository in which the issues were opened.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n IssueEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (Issue)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n IssueTemplate\n

    \n

    A repository issue template.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    about (String)

    The template purpose.

    \n\n\n\n\n\n\n\n\n\n\n\n

    body (String)

    The suggested issue body.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The template name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    title (String)

    The suggested issue title.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n IssueTimelineConnection\n

    \n

    The connection type for IssueTimelineItem.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([IssueTimelineItemEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([IssueTimelineItem])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n IssueTimelineItemEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (IssueTimelineItem)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n IssueTimelineItemsConnection\n

    \n

    The connection type for IssueTimelineItems.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([IssueTimelineItemsEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    filteredCount (Int!)

    Identifies the count of items after applying before and after filters.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([IssueTimelineItems])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageCount (Int!)

    Identifies the count of items after applying before/after filters and first/last/skip slicing.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the timeline was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n IssueTimelineItemsEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (IssueTimelineItems)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n JoinedGitHubContribution\n

    \n

    Represents a user signing up for a GitHub account.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    isRestricted (Boolean!)

    Whether this contribution is associated with a record you do not have access to. For\nexample, your own 'first issue' contribution may have been made on a repository you can no\nlonger access.

    \n\n\n\n\n\n\n\n\n\n\n\n

    occurredAt (DateTime!)

    When this contribution was made.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User!)

    The user who made this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Label\n

    \n

    A label for categorizing Issues or Milestones with a given Repository.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    color (String!)

    Identifies the label color.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime)

    Identifies the date and time when the label was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String)

    A brief description of this label.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isDefault (Boolean!)

    Indicates whether or not this is a default label.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issues (IssueConnection!)

    A list of issues associated with this label.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    filterBy (IssueFilters)

    \n

    Filtering options for issues returned from the connection.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    labels ([String!])

    \n

    A list of label names to filter the pull requests by.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (IssueOrder)

    \n

    Ordering options for issues returned from the connection.

    \n\n
    \n\n
    \n

    states ([IssueState!])

    \n

    A list of states to filter the issues by.

    \n\n
    \n\n
    \n\n\n

    name (String!)

    Identifies the label name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequests (PullRequestConnection!)

    A list of pull requests associated with this label.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    baseRefName (String)

    \n

    The base ref name to filter the pull requests by.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    headRefName (String)

    \n

    The head ref name to filter the pull requests by.

    \n\n
    \n\n
    \n

    labels ([String!])

    \n

    A list of label names to filter the pull requests by.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (IssueOrder)

    \n

    Ordering options for pull requests returned from the connection.

    \n\n
    \n\n
    \n

    states ([PullRequestState!])

    \n

    A list of states to filter the pull requests by.

    \n\n
    \n\n
    \n\n\n

    repository (Repository!)

    The repository associated with this label.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this label.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime)

    Identifies the date and time when the label was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this label.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n LabelConnection\n

    \n

    The connection type for Label.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([LabelEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Label])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n LabelEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (Label)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n LabeledEvent\n

    \n

    Represents alabeledevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    label (Label!)

    Identifies the label associated with thelabeledevent.

    \n\n\n\n\n\n\n\n\n\n\n\n

    labelable (Labelable!)

    Identifies the Labelable associated with the event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Language\n

    \n

    Represents a given language found in repositories.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    color (String)

    The color defined for the current language.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The name of the current language.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n LanguageConnection\n

    \n

    A list of languages associated with the parent.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([LanguageEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Language])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalSize (Int!)

    The total size in bytes of files written in that language.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n LanguageEdge\n

    \n

    Represents the language of a repository.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    size (Int!)

    The number of bytes of code written in the language.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n License\n

    \n

    A repository's open source license.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String!)

    The full text of the license.

    \n\n\n\n\n\n\n\n\n\n\n\n

    conditions ([LicenseRule]!)

    The conditions set by the license.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String)

    A human-readable description of the license.

    \n\n\n\n\n\n\n\n\n\n\n\n

    featured (Boolean!)

    Whether the license should be featured.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hidden (Boolean!)

    Whether the license should be displayed in license pickers.

    \n\n\n\n\n\n\n\n\n\n\n\n

    implementation (String)

    Instructions on how to implement the license.

    \n\n\n\n\n\n\n\n\n\n\n\n

    key (String!)

    The lowercased SPDX ID of the license.

    \n\n\n\n\n\n\n\n\n\n\n\n

    limitations ([LicenseRule]!)

    The limitations set by the license.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The license full name specified by https://spdx.org/licenses.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nickname (String)

    Customary short name if applicable (e.g, GPLv3).

    \n\n\n\n\n\n\n\n\n\n\n\n

    permissions ([LicenseRule]!)

    The permissions set by the license.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pseudoLicense (Boolean!)

    Whether the license is a pseudo-license placeholder (e.g., other, no-license).

    \n\n\n\n\n\n\n\n\n\n\n\n

    spdxId (String)

    Short identifier specified by https://spdx.org/licenses.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI)

    URL to the license on https://choosealicense.com.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n LicenseRule\n

    \n

    Describes a License's conditions, permissions, and limitations.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    description (String!)

    A description of the rule.

    \n\n\n\n\n\n\n\n\n\n\n\n

    key (String!)

    The machine-readable rule key.

    \n\n\n\n\n\n\n\n\n\n\n\n

    label (String!)

    The human-readable rule label.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n LockedEvent\n

    \n

    Represents alockedevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    lockReason (LockReason)

    Reason that the conversation was locked (optional).

    \n\n\n\n\n\n\n\n\n\n\n\n

    lockable (Lockable!)

    Object that was locked.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Mannequin\n

    \n

    A placeholder user for attribution of imported data on GitHub.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    avatarUrl (URI!)

    A URL pointing to the GitHub App's public avatar.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    size (Int)

    \n

    The size of the resulting square image.

    \n\n
    \n\n
    \n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    email (String)

    The mannequin's email on the source instance.

    \n\n\n\n\n\n\n\n\n\n\n\n

    login (String!)

    The username of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTML path to this resource.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The URL to this resource.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n MarkedAsDuplicateEvent\n

    \n

    Represents amarked_as_duplicateevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    canonical (IssueOrPullRequest)

    The authoritative issue or pull request which has been duplicated by another.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    duplicate (IssueOrPullRequest)

    The issue or pull request which has been marked as a duplicate of another.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isCrossRepository (Boolean!)

    Canonical and duplicate belong to different repositories.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n MembersCanDeleteReposClearAuditEntry\n

    \n

    Audit log entry for a members_can_delete_repos.clear event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseResourcePath (URI)

    The HTTP path for this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseSlug (String)

    The slug of the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseUrl (URI)

    The HTTP URL for this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n MembersCanDeleteReposDisableAuditEntry\n

    \n

    Audit log entry for a members_can_delete_repos.disable event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseResourcePath (URI)

    The HTTP path for this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseSlug (String)

    The slug of the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseUrl (URI)

    The HTTP URL for this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n MembersCanDeleteReposEnableAuditEntry\n

    \n

    Audit log entry for a members_can_delete_repos.enable event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseResourcePath (URI)

    The HTTP path for this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseSlug (String)

    The slug of the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseUrl (URI)

    The HTTP URL for this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n MentionedEvent\n

    \n

    Represents amentionedevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n MergedEvent\n

    \n

    Represents amergedevent on a given pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commit (Commit)

    Identifies the commit associated with the merge event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    mergeRef (Ref)

    Identifies the Ref associated with the merge event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    mergeRefName (String!)

    Identifies the name of the Ref associated with the merge event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    PullRequest referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this merged event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this merged event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Milestone\n

    \n

    Represents a Milestone object on a given repository.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    closed (Boolean!)

    true if the object is closed (definition of closed may depend on type).

    \n\n\n\n\n\n\n\n\n\n\n\n

    closedAt (DateTime)

    Identifies the date and time when the object was closed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    creator (Actor)

    Identifies the actor who created the milestone.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String)

    Identifies the description of the milestone.

    \n\n\n\n\n\n\n\n\n\n\n\n

    dueOn (DateTime)

    Identifies the due date of the milestone.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issues (IssueConnection!)

    A list of issues associated with the milestone.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    filterBy (IssueFilters)

    \n

    Filtering options for issues returned from the connection.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    labels ([String!])

    \n

    A list of label names to filter the pull requests by.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (IssueOrder)

    \n

    Ordering options for issues returned from the connection.

    \n\n
    \n\n
    \n

    states ([IssueState!])

    \n

    A list of states to filter the issues by.

    \n\n
    \n\n
    \n\n\n

    number (Int!)

    Identifies the number of the milestone.

    \n\n\n\n\n\n\n\n\n\n\n\n

    progressPercentage (Float!)

    Identifies the percentage complete for the milestone.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequests (PullRequestConnection!)

    A list of pull requests associated with the milestone.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    baseRefName (String)

    \n

    The base ref name to filter the pull requests by.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    headRefName (String)

    \n

    The head ref name to filter the pull requests by.

    \n\n
    \n\n
    \n

    labels ([String!])

    \n

    A list of label names to filter the pull requests by.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (IssueOrder)

    \n

    Ordering options for pull requests returned from the connection.

    \n\n
    \n\n
    \n

    states ([PullRequestState!])

    \n

    A list of states to filter the pull requests by.

    \n\n
    \n\n
    \n\n\n

    repository (Repository!)

    The repository associated with this milestone.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this milestone.

    \n\n\n\n\n\n\n\n\n\n\n\n

    state (MilestoneState!)

    Identifies the state of the milestone.

    \n\n\n\n\n\n\n\n\n\n\n\n

    title (String!)

    Identifies the title of the milestone.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this milestone.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n MilestoneConnection\n

    \n

    The connection type for Milestone.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([MilestoneEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Milestone])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n MilestoneEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (Milestone)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n MilestonedEvent\n

    \n

    Represents amilestonedevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    milestoneTitle (String!)

    Identifies the milestone title associated with themilestonedevent.

    \n\n\n\n\n\n\n\n\n\n\n\n

    subject (MilestoneItem!)

    Object referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n MovedColumnsInProjectEvent\n

    \n

    Represents amoved_columns_in_projectevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    previousProjectColumnName (String!)

    Column name the issue or pull request was moved from.

    \n\n\n\n\n
    \n

    Preview notice

    \n

    previousProjectColumnName is available under the Project event details preview. During the preview period, the API may change without notice.

    \n
    \n\n\n\n\n\n\n\n\n

    project (Project)

    Project referenced by event.

    \n\n\n\n\n
    \n

    Preview notice

    \n

    project is available under the Project event details preview. During the preview period, the API may change without notice.

    \n
    \n\n\n\n\n\n\n\n\n

    projectCard (ProjectCard)

    Project card referenced by this project event.

    \n\n\n\n\n
    \n

    Preview notice

    \n

    projectCard is available under the Project event details preview. During the preview period, the API may change without notice.

    \n
    \n\n\n\n\n\n\n\n\n

    projectColumnName (String!)

    Column name the issue or pull request was moved to.

    \n\n\n\n\n
    \n

    Preview notice

    \n

    projectColumnName is available under the Project event details preview. During the preview period, the API may change without notice.

    \n
    \n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OauthApplicationCreateAuditEntry\n

    \n

    Audit log entry for a oauth_application.create event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    applicationUrl (URI)

    The application URL of the OAuth Application.

    \n\n\n\n\n\n\n\n\n\n\n\n

    callbackUrl (URI)

    The callback URL of the OAuth Application.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    oauthApplicationName (String)

    The name of the OAuth Application.

    \n\n\n\n\n\n\n\n\n\n\n\n

    oauthApplicationResourcePath (URI)

    The HTTP path for the OAuth Application.

    \n\n\n\n\n\n\n\n\n\n\n\n

    oauthApplicationUrl (URI)

    The HTTP URL for the OAuth Application.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    rateLimit (Int)

    The rate limit of the OAuth Application.

    \n\n\n\n\n\n\n\n\n\n\n\n

    state (OauthApplicationCreateAuditEntryState)

    The state of the OAuth Application.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgAddBillingManagerAuditEntry\n

    \n

    Audit log entry for a org.add_billing_manager.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    invitationEmail (String)

    The email address used to invite a billing manager for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgAddMemberAuditEntry\n

    \n

    Audit log entry for a org.add_member.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    permission (OrgAddMemberAuditEntryPermission)

    The permission level of the member added to the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgBlockUserAuditEntry\n

    \n

    Audit log entry for a org.block_user.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    blockedUser (User)

    The blocked user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    blockedUserName (String)

    The username of the blocked user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    blockedUserResourcePath (URI)

    The HTTP path for the blocked user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    blockedUserUrl (URI)

    The HTTP URL for the blocked user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgConfigDisableCollaboratorsOnlyAuditEntry\n

    \n

    Audit log entry for a org.config.disable_collaborators_only event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgConfigEnableCollaboratorsOnlyAuditEntry\n

    \n

    Audit log entry for a org.config.enable_collaborators_only event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgCreateAuditEntry\n

    \n

    Audit log entry for a org.create event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    billingPlan (OrgCreateAuditEntryBillingPlan)

    The billing plan for the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgDisableOauthAppRestrictionsAuditEntry\n

    \n

    Audit log entry for a org.disable_oauth_app_restrictions event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgDisableSamlAuditEntry\n

    \n

    Audit log entry for a org.disable_saml event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    digestMethodUrl (URI)

    The SAML provider's digest algorithm URL.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issuerUrl (URI)

    The SAML provider's issuer URL.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    signatureMethodUrl (URI)

    The SAML provider's signature algorithm URL.

    \n\n\n\n\n\n\n\n\n\n\n\n

    singleSignOnUrl (URI)

    The SAML provider's single sign-on URL.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgDisableTwoFactorRequirementAuditEntry\n

    \n

    Audit log entry for a org.disable_two_factor_requirement event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgEnableOauthAppRestrictionsAuditEntry\n

    \n

    Audit log entry for a org.enable_oauth_app_restrictions event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgEnableSamlAuditEntry\n

    \n

    Audit log entry for a org.enable_saml event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    digestMethodUrl (URI)

    The SAML provider's digest algorithm URL.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issuerUrl (URI)

    The SAML provider's issuer URL.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    signatureMethodUrl (URI)

    The SAML provider's signature algorithm URL.

    \n\n\n\n\n\n\n\n\n\n\n\n

    singleSignOnUrl (URI)

    The SAML provider's single sign-on URL.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgEnableTwoFactorRequirementAuditEntry\n

    \n

    Audit log entry for a org.enable_two_factor_requirement event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgInviteMemberAuditEntry\n

    \n

    Audit log entry for a org.invite_member event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    email (String)

    The email address of the organization invitation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationInvitation (OrganizationInvitation)

    The organization invitation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgInviteToBusinessAuditEntry\n

    \n

    Audit log entry for a org.invite_to_business event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseResourcePath (URI)

    The HTTP path for this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseSlug (String)

    The slug of the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseUrl (URI)

    The HTTP URL for this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgOauthAppAccessApprovedAuditEntry\n

    \n

    Audit log entry for a org.oauth_app_access_approved event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    oauthApplicationName (String)

    The name of the OAuth Application.

    \n\n\n\n\n\n\n\n\n\n\n\n

    oauthApplicationResourcePath (URI)

    The HTTP path for the OAuth Application.

    \n\n\n\n\n\n\n\n\n\n\n\n

    oauthApplicationUrl (URI)

    The HTTP URL for the OAuth Application.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgOauthAppAccessDeniedAuditEntry\n

    \n

    Audit log entry for a org.oauth_app_access_denied event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    oauthApplicationName (String)

    The name of the OAuth Application.

    \n\n\n\n\n\n\n\n\n\n\n\n

    oauthApplicationResourcePath (URI)

    The HTTP path for the OAuth Application.

    \n\n\n\n\n\n\n\n\n\n\n\n

    oauthApplicationUrl (URI)

    The HTTP URL for the OAuth Application.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgOauthAppAccessRequestedAuditEntry\n

    \n

    Audit log entry for a org.oauth_app_access_requested event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    oauthApplicationName (String)

    The name of the OAuth Application.

    \n\n\n\n\n\n\n\n\n\n\n\n

    oauthApplicationResourcePath (URI)

    The HTTP path for the OAuth Application.

    \n\n\n\n\n\n\n\n\n\n\n\n

    oauthApplicationUrl (URI)

    The HTTP URL for the OAuth Application.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgRemoveBillingManagerAuditEntry\n

    \n

    Audit log entry for a org.remove_billing_manager event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reason (OrgRemoveBillingManagerAuditEntryReason)

    The reason for the billing manager being removed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgRemoveMemberAuditEntry\n

    \n

    Audit log entry for a org.remove_member event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    membershipTypes ([OrgRemoveMemberAuditEntryMembershipType!])

    The types of membership the member has with the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reason (OrgRemoveMemberAuditEntryReason)

    The reason for the member being removed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgRemoveOutsideCollaboratorAuditEntry\n

    \n

    Audit log entry for a org.remove_outside_collaborator event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    membershipTypes ([OrgRemoveOutsideCollaboratorAuditEntryMembershipType!])

    The types of membership the outside collaborator has with the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reason (OrgRemoveOutsideCollaboratorAuditEntryReason)

    The reason for the outside collaborator being removed from the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgRestoreMemberAuditEntry\n

    \n

    Audit log entry for a org.restore_member event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    restoredCustomEmailRoutingsCount (Int)

    The number of custom email routings for the restored member.

    \n\n\n\n\n\n\n\n\n\n\n\n

    restoredIssueAssignmentsCount (Int)

    The number of issue assignments for the restored member.

    \n\n\n\n\n\n\n\n\n\n\n\n

    restoredMemberships ([OrgRestoreMemberAuditEntryMembership!])

    Restored organization membership objects.

    \n\n\n\n\n\n\n\n\n\n\n\n

    restoredMembershipsCount (Int)

    The number of restored memberships.

    \n\n\n\n\n\n\n\n\n\n\n\n

    restoredRepositoriesCount (Int)

    The number of repositories of the restored member.

    \n\n\n\n\n\n\n\n\n\n\n\n

    restoredRepositoryStarsCount (Int)

    The number of starred repositories for the restored member.

    \n\n\n\n\n\n\n\n\n\n\n\n

    restoredRepositoryWatchesCount (Int)

    The number of watched repositories for the restored member.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgRestoreMemberMembershipOrganizationAuditEntryData\n

    \n

    Metadata for an organization membership for org.restore_member actions.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgRestoreMemberMembershipRepositoryAuditEntryData\n

    \n

    Metadata for a repository membership for org.restore_member actions.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgRestoreMemberMembershipTeamAuditEntryData\n

    \n

    Metadata for a team membership for org.restore_member actions.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    team (Team)

    The team associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamName (String)

    The name of the team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamResourcePath (URI)

    The HTTP path for this team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamUrl (URI)

    The HTTP URL for this team.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgUnblockUserAuditEntry\n

    \n

    Audit log entry for a org.unblock_user.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    blockedUser (User)

    The user being unblocked by the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    blockedUserName (String)

    The username of the blocked user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    blockedUserResourcePath (URI)

    The HTTP path for the blocked user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    blockedUserUrl (URI)

    The HTTP URL for the blocked user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgUpdateDefaultRepositoryPermissionAuditEntry\n

    \n

    Audit log entry for a org.update_default_repository_permission.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    permission (OrgUpdateDefaultRepositoryPermissionAuditEntryPermission)

    The new default repository permission level for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    permissionWas (OrgUpdateDefaultRepositoryPermissionAuditEntryPermission)

    The former default repository permission level for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgUpdateMemberAuditEntry\n

    \n

    Audit log entry for a org.update_member event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    permission (OrgUpdateMemberAuditEntryPermission)

    The new member permission level for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    permissionWas (OrgUpdateMemberAuditEntryPermission)

    The former member permission level for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgUpdateMemberRepositoryCreationPermissionAuditEntry\n

    \n

    Audit log entry for a org.update_member_repository_creation_permission event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    canCreateRepositories (Boolean)

    Can members create repositories in the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    visibility (OrgUpdateMemberRepositoryCreationPermissionAuditEntryVisibility)

    The permission for visibility level of repositories for this organization.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgUpdateMemberRepositoryInvitationPermissionAuditEntry\n

    \n

    Audit log entry for a org.update_member_repository_invitation_permission event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    canInviteOutsideCollaboratorsToRepositories (Boolean)

    Can outside collaborators be invited to repositories in the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Organization\n

    \n

    An account on GitHub, with one or more owners, that has repositories, members and teams.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    anyPinnableItems (Boolean!)

    Determine if this repository owner has any items that can be pinned to their profile.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    type (PinnableItemType)

    \n

    Filter to only a particular kind of pinnable item.

    \n\n
    \n\n
    \n\n\n

    auditLog (OrganizationAuditEntryConnection!)

    Audit log entries of the organization.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (AuditLogOrder)

    \n

    Ordering options for the returned audit log entries.

    \n\n
    \n\n
    \n

    query (String)

    \n

    The query string to filter audit entries.

    \n\n
    \n\n
    \n\n\n

    avatarUrl (URI!)

    A URL pointing to the organization's public avatar.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    size (Int)

    \n

    The size of the resulting square image.

    \n\n
    \n\n
    \n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String)

    The organization's public profile description.

    \n\n\n\n\n\n\n\n\n\n\n\n

    descriptionHTML (String)

    The organization's public profile description rendered to HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    email (String)

    The organization's public email.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ipAllowListEnabledSetting (IpAllowListEnabledSettingValue!)

    The setting value for whether the organization has an IP allow list enabled.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ipAllowListEntries (IpAllowListEntryConnection!)

    The IP addresses that are allowed to access resources owned by the organization.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (IpAllowListEntryOrder)

    \n

    Ordering options for IP allow list entries returned.

    \n\n
    \n\n
    \n\n\n

    isVerified (Boolean!)

    Whether the organization has verified its profile email and website, always false on Enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    itemShowcase (ProfileItemShowcase!)

    Showcases a selection of repositories and gists that the profile owner has\neither curated or that have been selected automatically based on popularity.

    \n\n\n\n\n\n\n\n\n\n\n\n

    location (String)

    The organization's public profile location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    login (String!)

    The organization's login name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    memberStatuses (UserStatusConnection!)

    Get the status messages members of this entity have set that are either public or visible only to the organization.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (UserStatusOrder)

    \n

    Ordering options for user statuses returned from the connection.

    \n\n
    \n\n
    \n\n\n

    membersWithRole (OrganizationMemberConnection!)

    A list of users who are members of this organization.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    name (String)

    The organization's public profile name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    newTeamResourcePath (URI!)

    The HTTP path creating a new team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    newTeamUrl (URI!)

    The HTTP URL creating a new team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationBillingEmail (String)

    The billing email for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pendingMembers (UserConnection!)

    A list of users who have been invited to join this organization.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    pinnableItems (PinnableItemConnection!)

    A list of repositories and gists this profile owner can pin to their profile.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    types ([PinnableItemType!])

    \n

    Filter the types of pinnable items that are returned.

    \n\n
    \n\n
    \n\n\n

    pinnedItems (PinnableItemConnection!)

    A list of repositories and gists this profile owner has pinned to their profile.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    types ([PinnableItemType!])

    \n

    Filter the types of pinned items that are returned.

    \n\n
    \n\n
    \n\n\n

    pinnedItemsRemaining (Int!)

    Returns how many more items this profile owner can pin to their profile.

    \n\n\n\n\n\n\n\n\n\n\n\n

    project (Project)

    Find project by number.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    number (Int!)

    \n

    The project number to find.

    \n\n
    \n\n
    \n\n\n

    projects (ProjectConnection!)

    A list of projects under the owner.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (ProjectOrder)

    \n

    Ordering options for projects returned from the connection.

    \n\n
    \n\n
    \n

    search (String)

    \n

    Query to search projects by, currently only searching by name.

    \n\n
    \n\n
    \n

    states ([ProjectState!])

    \n

    A list of states to filter the projects by.

    \n\n
    \n\n
    \n\n\n

    projectsResourcePath (URI!)

    The HTTP path listing organization's projects.

    \n\n\n\n\n\n\n\n\n\n\n\n

    projectsUrl (URI!)

    The HTTP URL listing organization's projects.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositories (RepositoryConnection!)

    A list of repositories that the user owns.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    affiliations ([RepositoryAffiliation])

    \n

    Array of viewer's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\ncurrent viewer owns.

    \n\n
    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    isFork (Boolean)

    \n

    If non-null, filters repositories according to whether they are forks of another repository.

    \n\n
    \n\n
    \n

    isLocked (Boolean)

    \n

    If non-null, filters repositories according to whether they have been locked.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (RepositoryOrder)

    \n

    Ordering options for repositories returned from the connection.

    \n\n
    \n\n
    \n

    ownerAffiliations ([RepositoryAffiliation])

    \n

    Array of owner's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\norganization or user being viewed owns.

    \n\n
    \n\n
    \n

    privacy (RepositoryPrivacy)

    \n

    If non-null, filters repositories according to privacy.

    \n\n
    \n\n
    \n\n\n

    repository (Repository)

    Find Repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    name (String!)

    \n

    Name of Repository to find.

    \n\n
    \n\n
    \n\n\n

    requiresTwoFactorAuthentication (Boolean)

    When true the organization requires all members, billing managers, and outside\ncollaborators to enable two-factor authentication.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    samlIdentityProvider (OrganizationIdentityProvider)

    The Organization's SAML identity providers.

    \n\n\n\n\n\n\n\n\n\n\n\n

    sponsorshipsAsMaintainer (SponsorshipConnection!)

    This object's sponsorships as the maintainer.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    includePrivate (Boolean)

    \n

    Whether or not to include private sponsorships in the result set.

    \n

    The default value is false.

    \n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (SponsorshipOrder)

    \n

    Ordering options for sponsorships returned from this connection. If left\nblank, the sponsorships will be ordered based on relevancy to the viewer.

    \n\n
    \n\n
    \n\n\n

    sponsorshipsAsSponsor (SponsorshipConnection!)

    This object's sponsorships as the sponsor.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (SponsorshipOrder)

    \n

    Ordering options for sponsorships returned from this connection. If left\nblank, the sponsorships will be ordered based on relevancy to the viewer.

    \n\n
    \n\n
    \n\n\n

    team (Team)

    Find an organization's team by its slug.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    slug (String!)

    \n

    The name or slug of the team to find.

    \n\n
    \n\n
    \n\n\n

    teams (TeamConnection!)

    A list of teams in this organization.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    ldapMapped (Boolean)

    \n

    If true, filters teams that are mapped to an LDAP Group (Enterprise only).

    \n\n
    \n\n
    \n

    orderBy (TeamOrder)

    \n

    Ordering options for teams returned from the connection.

    \n\n
    \n\n
    \n

    privacy (TeamPrivacy)

    \n

    If non-null, filters teams according to privacy.

    \n\n
    \n\n
    \n

    query (String)

    \n

    If non-null, filters teams with query on team name and team slug.

    \n\n
    \n\n
    \n

    role (TeamRole)

    \n

    If non-null, filters teams according to whether the viewer is an admin or member on team.

    \n\n
    \n\n
    \n

    rootTeamsOnly (Boolean)

    \n

    If true, restrict to only root teams.

    \n

    The default value is false.

    \n
    \n\n
    \n

    userLogins ([String!])

    \n

    User logins to filter by.

    \n\n
    \n\n
    \n\n\n

    teamsResourcePath (URI!)

    The HTTP path listing organization's teams.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamsUrl (URI!)

    The HTTP URL listing organization's teams.

    \n\n\n\n\n\n\n\n\n\n\n\n

    twitterUsername (String)

    The organization's Twitter username.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanAdminister (Boolean!)

    Organization is adminable by the viewer.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanChangePinnedItems (Boolean!)

    Can the viewer pin repositories and gists to the profile?.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanCreateProjects (Boolean!)

    Can the current viewer create new projects on this owner.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanCreateRepositories (Boolean!)

    Viewer can create repositories on this organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanCreateTeams (Boolean!)

    Viewer can create teams on this organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerIsAMember (Boolean!)

    Viewer is an active member of this organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    websiteUrl (URI)

    The organization's public profile URL.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrganizationAuditEntryConnection\n

    \n

    The connection type for OrganizationAuditEntry.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([OrganizationAuditEntryEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([OrganizationAuditEntry])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrganizationAuditEntryEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (OrganizationAuditEntry)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrganizationConnection\n

    \n

    The connection type for Organization.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([OrganizationEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Organization])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrganizationEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (Organization)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrganizationIdentityProvider\n

    \n

    An Identity Provider configured to provision SAML and SCIM identities for Organizations.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    digestMethod (URI)

    The digest algorithm used to sign SAML requests for the Identity Provider.

    \n\n\n\n\n\n\n\n\n\n\n\n

    externalIdentities (ExternalIdentityConnection!)

    External Identities provisioned by this Identity Provider.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    idpCertificate (X509Certificate)

    The x509 certificate used by the Identity Provider to sign assertions and responses.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issuer (String)

    The Issuer Entity ID for the SAML Identity Provider.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    Organization this Identity Provider belongs to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    signatureMethod (URI)

    The signature algorithm used to sign SAML requests for the Identity Provider.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ssoUrl (URI)

    The URL endpoint for the Identity Provider's SAML SSO.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrganizationInvitation\n

    \n

    An Invitation for a user to an organization.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    email (String)

    The email address of the user invited to the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    invitationType (OrganizationInvitationType!)

    The type of invitation that was sent (e.g. email, user).

    \n\n\n\n\n\n\n\n\n\n\n\n

    invitee (User)

    The user who was invited to the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    inviter (User!)

    The user who created the invitation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization!)

    The organization the invite is for.

    \n\n\n\n\n\n\n\n\n\n\n\n

    role (OrganizationInvitationRole!)

    The user's pending role in the organization (e.g. member, owner).

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrganizationInvitationConnection\n

    \n

    The connection type for OrganizationInvitation.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([OrganizationInvitationEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([OrganizationInvitation])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrganizationInvitationEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (OrganizationInvitation)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrganizationMemberConnection\n

    \n

    The connection type for User.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([OrganizationMemberEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([User])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrganizationMemberEdge\n

    \n

    Represents a user within an organization.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hasTwoFactorEnabled (Boolean)

    Whether the organization member has two factor enabled or not. Returns null if information is not available to viewer.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (User)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n

    role (OrganizationMemberRole)

    The role this user has in the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrganizationTeamsHovercardContext\n

    \n

    An organization teams hovercard context.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    message (String!)

    A string describing this context.

    \n\n\n\n\n\n\n\n\n\n\n\n

    octicon (String!)

    An octicon to accompany this context.

    \n\n\n\n\n\n\n\n\n\n\n\n

    relevantTeams (TeamConnection!)

    Teams in this organization the user is a member of that are relevant.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    teamsResourcePath (URI!)

    The path for the full team list for this user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamsUrl (URI!)

    The URL for the full team list for this user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalTeamCount (Int!)

    The total number of teams the user is on in the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrganizationsHovercardContext\n

    \n

    An organization list hovercard context.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    message (String!)

    A string describing this context.

    \n\n\n\n\n\n\n\n\n\n\n\n

    octicon (String!)

    An octicon to accompany this context.

    \n\n\n\n\n\n\n\n\n\n\n\n

    relevantOrganizations (OrganizationConnection!)

    Organizations this user is a member of that are relevant.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    totalOrganizationCount (Int!)

    The total number of organizations this user is in.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PageInfo\n

    \n

    Information about pagination in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    endCursor (String)

    When paginating forwards, the cursor to continue.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hasNextPage (Boolean!)

    When paginating forwards, are there more items?.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hasPreviousPage (Boolean!)

    When paginating backwards, are there more items?.

    \n\n\n\n\n\n\n\n\n\n\n\n

    startCursor (String)

    When paginating backwards, the cursor to continue.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PermissionSource\n

    \n

    A level of permission and source for a user's access to a repository.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    organization (Organization!)

    The organization the repository belongs to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    permission (DefaultRepositoryPermissionField!)

    The level of access this source has granted to the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    source (PermissionGranter!)

    The source of this permission.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PinnableItemConnection\n

    \n

    The connection type for PinnableItem.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([PinnableItemEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([PinnableItem])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PinnableItemEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (PinnableItem)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PinnedEvent\n

    \n

    Represents apinnedevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issue (Issue!)

    Identifies the issue associated with the event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PinnedIssue\n

    \n

    A Pinned Issue is a issue pinned to a repository's index page.

    \n
    \n\n
    \n \n
    \n

    Preview notice

    \n

    PinnedIssue is available under the Pinned issues preview. During the preview period, the API may change without notice.

    \n
    \n\n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issue (Issue!)

    The issue that was pinned.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pinnedBy (Actor!)

    The actor that pinned this issue.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository!)

    The repository that this issue was pinned to.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PinnedIssueConnection\n

    \n

    The connection type for PinnedIssue.

    \n
    \n\n
    \n \n
    \n

    Preview notice

    \n

    PinnedIssueConnection is available under the Pinned issues preview. During the preview period, the API may change without notice.

    \n
    \n\n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([PinnedIssueEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([PinnedIssue])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PinnedIssueEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n
    \n

    Preview notice

    \n

    PinnedIssueEdge is available under the Pinned issues preview. During the preview period, the API may change without notice.

    \n
    \n\n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (PinnedIssue)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PrivateRepositoryForkingDisableAuditEntry\n

    \n

    Audit log entry for a private_repository_forking.disable event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseResourcePath (URI)

    The HTTP path for this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseSlug (String)

    The slug of the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseUrl (URI)

    The HTTP URL for this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PrivateRepositoryForkingEnableAuditEntry\n

    \n

    Audit log entry for a private_repository_forking.enable event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseResourcePath (URI)

    The HTTP path for this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseSlug (String)

    The slug of the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseUrl (URI)

    The HTTP URL for this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ProfileItemShowcase\n

    \n

    A curatable list of repositories relating to a repository owner, which defaults\nto showing the most popular repositories they own.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    hasPinnedItems (Boolean!)

    Whether or not the owner has pinned any repositories or gists.

    \n\n\n\n\n\n\n\n\n\n\n\n

    items (PinnableItemConnection!)

    The repositories and gists in the showcase. If the profile owner has any\npinned items, those will be returned. Otherwise, the profile owner's popular\nrepositories will be returned.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Project\n

    \n

    Projects manage issues, pull requests and notes within a project owner.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String)

    The project's description body.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyHTML (HTML!)

    The projects description body rendered to HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    closed (Boolean!)

    true if the object is closed (definition of closed may depend on type).

    \n\n\n\n\n\n\n\n\n\n\n\n

    closedAt (DateTime)

    Identifies the date and time when the object was closed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    columns (ProjectColumnConnection!)

    List of columns in the project.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    creator (Actor)

    The actor who originally created the project.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The project's name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    number (Int!)

    The project's number.

    \n\n\n\n\n\n\n\n\n\n\n\n

    owner (ProjectOwner!)

    The project's owner. Currently limited to repositories, organizations, and users.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pendingCards (ProjectCardConnection!)

    List of pending cards in this project.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    archivedStates ([ProjectCardArchivedState])

    \n

    A list of archived states to filter the cards by.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    progress (ProjectProgress!)

    Project progress details.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this project.

    \n\n\n\n\n\n\n\n\n\n\n\n

    state (ProjectState!)

    Whether the project is open or closed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this project.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanUpdate (Boolean!)

    Check if the current viewer can update this object.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ProjectCard\n

    \n

    A card in a project.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    column (ProjectColumn)

    The project column this card is associated under. A card may only belong to one\nproject column at a time. The column field will be null if the card is created\nin a pending state and has yet to be associated with a column. Once cards are\nassociated with a column, they will not become pending in the future.

    \n\n\n\n\n\n\n\n\n\n\n\n

    content (ProjectCardItem)

    The card content item.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    creator (Actor)

    The actor who created this card.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isArchived (Boolean!)

    Whether the card is archived.

    \n\n\n\n\n\n\n\n\n\n\n\n

    note (String)

    The card note.

    \n\n\n\n\n\n\n\n\n\n\n\n

    project (Project!)

    The project that contains this card.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this card.

    \n\n\n\n\n\n\n\n\n\n\n\n

    state (ProjectCardState)

    The state of ProjectCard.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this card.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ProjectCardConnection\n

    \n

    The connection type for ProjectCard.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([ProjectCardEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([ProjectCard])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ProjectCardEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (ProjectCard)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ProjectColumn\n

    \n

    A column inside a project.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cards (ProjectCardConnection!)

    List of cards in the column.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    archivedStates ([ProjectCardArchivedState])

    \n

    A list of archived states to filter the cards by.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The project column's name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    project (Project!)

    The project that contains this column.

    \n\n\n\n\n\n\n\n\n\n\n\n

    purpose (ProjectColumnPurpose)

    The semantic purpose of the column.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this project column.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this project column.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ProjectColumnConnection\n

    \n

    The connection type for ProjectColumn.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([ProjectColumnEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([ProjectColumn])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ProjectColumnEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (ProjectColumn)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ProjectConnection\n

    \n

    A list of projects associated with the owner.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([ProjectEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Project])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ProjectEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (Project)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ProjectProgress\n

    \n

    Project progress stats.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    doneCount (Int!)

    The number of done cards.

    \n\n\n\n\n\n\n\n\n\n\n\n

    donePercentage (Float!)

    The percentage of done cards.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enabled (Boolean!)

    Whether progress tracking is enabled and cards with purpose exist for this project.

    \n\n\n\n\n\n\n\n\n\n\n\n

    inProgressCount (Int!)

    The number of in-progress cards.

    \n\n\n\n\n\n\n\n\n\n\n\n

    inProgressPercentage (Float!)

    The percentage of in-progress cards.

    \n\n\n\n\n\n\n\n\n\n\n\n

    todoCount (Int!)

    The number of to do cards.

    \n\n\n\n\n\n\n\n\n\n\n\n

    todoPercentage (Float!)

    The percentage of to do cards.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PublicKey\n

    \n

    A user's public key.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    accessedAt (DateTime)

    The last time this authorization was used to perform an action. Values will be null for keys not owned by the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime)

    Identifies the date and time when the key was created. Keys created before\nMarch 5th, 2014 have inaccurate values. Values will be null for keys not owned by the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    fingerprint (String!)

    The fingerprint for this PublicKey.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isReadOnly (Boolean)

    Whether this PublicKey is read-only or not. Values will be null for keys not owned by the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    key (String!)

    The public key string.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime)

    Identifies the date and time when the key was updated. Keys created before\nMarch 5th, 2014 may have inaccurate values. Values will be null for keys not\nowned by the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PublicKeyConnection\n

    \n

    The connection type for PublicKey.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([PublicKeyEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([PublicKey])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PublicKeyEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (PublicKey)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequest\n

    \n

    A repository pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    activeLockReason (LockReason)

    Reason that the conversation was locked.

    \n\n\n\n\n\n\n\n\n\n\n\n

    additions (Int!)

    The number of additions in this pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    assignees (UserConnection!)

    A list of Users assigned to this object.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    author (Actor)

    The actor who authored the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    authorAssociation (CommentAuthorAssociation!)

    Author's association with the subject of the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    autoMergeRequest (AutoMergeRequest)

    Returns the auto-merge request object if one exists for this pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    baseRef (Ref)

    Identifies the base Ref associated with the pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    baseRefName (String!)

    Identifies the name of the base Ref associated with the pull request, even if the ref has been deleted.

    \n\n\n\n\n\n\n\n\n\n\n\n

    baseRefOid (GitObjectID!)

    Identifies the oid of the base ref associated with the pull request, even if the ref has been deleted.

    \n\n\n\n\n\n\n\n\n\n\n\n

    baseRepository (Repository)

    The repository associated with this pull request's base Ref.

    \n\n\n\n\n\n\n\n\n\n\n\n

    body (String!)

    The body as Markdown.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyHTML (HTML!)

    The body rendered to HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyText (String!)

    The body rendered to text.

    \n\n\n\n\n\n\n\n\n\n\n\n

    canBeRebased (Boolean!)

    Whether or not the pull request is rebaseable.

    \n\n\n\n\n
    \n

    Preview notice

    \n

    canBeRebased is available under the Merge info preview. During the preview period, the API may change without notice.

    \n
    \n\n\n\n\n\n\n\n\n

    changedFiles (Int!)

    The number of changed files in this pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    checksResourcePath (URI!)

    The HTTP path for the checks of this pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    checksUrl (URI!)

    The HTTP URL for the checks of this pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    closed (Boolean!)

    true if the pull request is closed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    closedAt (DateTime)

    Identifies the date and time when the object was closed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    comments (IssueCommentConnection!)

    A list of comments associated with the pull request.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (IssueCommentOrder)

    \n

    Ordering options for issue comments returned from the connection.

    \n\n
    \n\n
    \n\n\n

    commits (PullRequestCommitConnection!)

    A list of commits present in this pull request's head branch not present in the base branch.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdViaEmail (Boolean!)

    Check if this comment was created via an email reply.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    deletions (Int!)

    The number of deletions in this pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    editor (Actor)

    The actor who edited this pull request's body.

    \n\n\n\n\n\n\n\n\n\n\n\n

    files (PullRequestChangedFileConnection)

    Lists the files changed within this pull request.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    headRef (Ref)

    Identifies the head Ref associated with the pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    headRefName (String!)

    Identifies the name of the head Ref associated with the pull request, even if the ref has been deleted.

    \n\n\n\n\n\n\n\n\n\n\n\n

    headRefOid (GitObjectID!)

    Identifies the oid of the head ref associated with the pull request, even if the ref has been deleted.

    \n\n\n\n\n\n\n\n\n\n\n\n

    headRepository (Repository)

    The repository associated with this pull request's head Ref.

    \n\n\n\n\n\n\n\n\n\n\n\n

    headRepositoryOwner (RepositoryOwner)

    The owner of the repository associated with this pull request's head Ref.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hovercard (Hovercard!)

    The hovercard information for this issue.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    includeNotificationContexts (Boolean)

    \n

    Whether or not to include notification contexts.

    \n

    The default value is true.

    \n
    \n\n
    \n\n\n

    includesCreatedEdit (Boolean!)

    Check if this comment was edited and includes an edit with the creation data.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isCrossRepository (Boolean!)

    The head and base repositories are different.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isDraft (Boolean!)

    Identifies if the pull request is a draft.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isReadByViewer (Boolean)

    Is this pull request read by the viewer.

    \n\n\n\n\n\n\n\n\n\n\n\n

    labels (LabelConnection)

    A list of labels associated with the object.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (LabelOrder)

    \n

    Ordering options for labels returned from the connection.

    \n\n
    \n\n
    \n\n\n

    lastEditedAt (DateTime)

    The moment the editor made the last edit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    latestOpinionatedReviews (PullRequestReviewConnection)

    A list of latest reviews per user associated with the pull request.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    writersOnly (Boolean)

    \n

    Only return reviews from user who have write access to the repository.

    \n

    The default value is false.

    \n
    \n\n
    \n\n\n

    latestReviews (PullRequestReviewConnection)

    A list of latest reviews per user associated with the pull request that are not also pending review.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    locked (Boolean!)

    true if the pull request is locked.

    \n\n\n\n\n\n\n\n\n\n\n\n

    maintainerCanModify (Boolean!)

    Indicates whether maintainers can modify the pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    mergeCommit (Commit)

    The commit that was created when this pull request was merged.

    \n\n\n\n\n\n\n\n\n\n\n\n

    mergeStateStatus (MergeStateStatus!)

    Detailed information about the current pull request merge state status.

    \n\n\n\n\n
    \n

    Preview notice

    \n

    mergeStateStatus is available under the Merge info preview. During the preview period, the API may change without notice.

    \n
    \n\n\n\n\n\n\n\n\n

    mergeable (MergeableState!)

    Whether or not the pull request can be merged based on the existence of merge conflicts.

    \n\n\n\n\n\n\n\n\n\n\n\n

    merged (Boolean!)

    Whether or not the pull request was merged.

    \n\n\n\n\n\n\n\n\n\n\n\n

    mergedAt (DateTime)

    The date and time that the pull request was merged.

    \n\n\n\n\n\n\n\n\n\n\n\n

    mergedBy (Actor)

    The actor who merged the pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    milestone (Milestone)

    Identifies the milestone associated with the pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    number (Int!)

    Identifies the pull request number.

    \n\n\n\n\n\n\n\n\n\n\n\n

    participants (UserConnection!)

    A list of Users that are participating in the Pull Request conversation.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    permalink (URI!)

    The permalink to the pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    potentialMergeCommit (Commit)

    The commit that GitHub automatically generated to test if this pull request\ncould be merged. This field will not return a value if the pull request is\nmerged, or if the test merge commit is still being generated. See the\nmergeable field for more details on the mergeability of the pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    projectCards (ProjectCardConnection!)

    List of project cards associated with this pull request.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    archivedStates ([ProjectCardArchivedState])

    \n

    A list of archived states to filter the cards by.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    publishedAt (DateTime)

    Identifies when the comment was published at.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reactionGroups ([ReactionGroup!])

    A list of reactions grouped by content left on the subject.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reactions (ReactionConnection!)

    A list of Reactions left on the Issue.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    content (ReactionContent)

    \n

    Allows filtering Reactions by emoji.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (ReactionOrder)

    \n

    Allows specifying the order in which reactions are returned.

    \n\n
    \n\n
    \n\n\n

    repository (Repository!)

    The repository associated with this node.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    revertResourcePath (URI!)

    The HTTP path for reverting this pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    revertUrl (URI!)

    The HTTP URL for reverting this pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reviewDecision (PullRequestReviewDecision)

    The current status of this pull request with respect to code review.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reviewRequests (ReviewRequestConnection)

    A list of review requests associated with the pull request.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    reviewThreads (PullRequestReviewThreadConnection!)

    The list of all review threads for this pull request.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    reviews (PullRequestReviewConnection)

    A list of reviews associated with the pull request.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    author (String)

    \n

    Filter by author of the review.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    states ([PullRequestReviewState!])

    \n

    A list of states to filter the reviews.

    \n\n
    \n\n
    \n\n\n

    state (PullRequestState!)

    Identifies the state of the pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    suggestedReviewers ([SuggestedReviewer]!)

    A list of reviewer suggestions based on commit history and past review comments.

    \n\n\n\n\n\n\n\n\n\n\n\n

    timeline (PullRequestTimelineConnection!)

    A list of events, comments, commits, etc. associated with the pull request.

    \n\n\n\n\n\n\n
    \n

    Deprecation notice

    \n

    timeline is deprecated.

    timeline will be removed Use PullRequest.timelineItems instead. Removal on 2020-10-01 UTC.

    \n
    \n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    since (DateTime)

    \n

    Allows filtering timeline events by a since timestamp.

    \n\n
    \n\n
    \n\n\n

    timelineItems (PullRequestTimelineItemsConnection!)

    A list of events, comments, commits, etc. associated with the pull request.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    itemTypes ([PullRequestTimelineItemsItemType!])

    \n

    Filter timeline items by type.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    since (DateTime)

    \n

    Filter timeline items by a since timestamp.

    \n\n
    \n\n
    \n

    skip (Int)

    \n

    Skips the first n elements in the list.

    \n\n
    \n\n
    \n\n\n

    title (String!)

    Identifies the pull request title.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userContentEdits (UserContentEditConnection)

    A list of edits to this content.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    viewerCanApplySuggestion (Boolean!)

    Whether or not the viewer can apply suggestion.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanDeleteHeadRef (Boolean!)

    Check if the viewer can restore the deleted head ref.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanDisableAutoMerge (Boolean!)

    Whether or not the viewer can disable auto-merge.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanEnableAutoMerge (Boolean!)

    Whether or not the viewer can enable auto-merge.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanReact (Boolean!)

    Can user react to this subject.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanSubscribe (Boolean!)

    Check if the viewer is able to change their subscription status for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanUpdate (Boolean!)

    Check if the current viewer can update this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

    Reasons why the current viewer can not update this comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerDidAuthor (Boolean!)

    Did the viewer author this comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerMergeBodyText (String!)

    The merge body text for the viewer and method.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    mergeType (PullRequestMergeMethod)

    \n

    The merge method for the message.

    \n\n
    \n\n
    \n\n\n

    viewerMergeHeadlineText (String!)

    The merge headline text for the viewer and method.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    mergeType (PullRequestMergeMethod)

    \n

    The merge method for the message.

    \n\n
    \n\n
    \n\n\n

    viewerSubscription (SubscriptionState)

    Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestChangedFile\n

    \n

    A file changed in a pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    additions (Int!)

    The number of additions to the file.

    \n\n\n\n\n\n\n\n\n\n\n\n

    deletions (Int!)

    The number of deletions to the file.

    \n\n\n\n\n\n\n\n\n\n\n\n

    path (String!)

    The path of the file.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerViewedState (FileViewedState!)

    The state of the file for the viewer.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestChangedFileConnection\n

    \n

    The connection type for PullRequestChangedFile.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([PullRequestChangedFileEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([PullRequestChangedFile])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestChangedFileEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (PullRequestChangedFile)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestCommit\n

    \n

    Represents a Git commit part of a pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    commit (Commit!)

    The Git commit object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    The pull request this commit belongs to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this pull request commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this pull request commit.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestCommitCommentThread\n

    \n

    Represents a commit comment thread part of a pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    comments (CommitCommentConnection!)

    The comments that exist in this thread.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    commit (Commit!)

    The commit the comments were made on.

    \n\n\n\n\n\n\n\n\n\n\n\n

    path (String)

    The file the comments were made on.

    \n\n\n\n\n\n\n\n\n\n\n\n

    position (Int)

    The position in the diff for the commit that the comment was made on.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    The pull request this commit comment thread belongs to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository!)

    The repository associated with this node.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestCommitConnection\n

    \n

    The connection type for PullRequestCommit.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([PullRequestCommitEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([PullRequestCommit])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestCommitEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (PullRequestCommit)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestConnection\n

    \n

    The connection type for PullRequest.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([PullRequestEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([PullRequest])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestContributionsByRepository\n

    \n

    This aggregates pull requests opened by a user within one repository.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    contributions (CreatedPullRequestContributionConnection!)

    The pull request contributions.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (ContributionOrder)

    \n

    Ordering options for contributions returned from the connection.

    \n\n
    \n\n
    \n\n\n

    repository (Repository!)

    The repository in which the pull requests were opened.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (PullRequest)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestReview\n

    \n

    A review object for a given pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    author (Actor)

    The actor who authored the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    authorAssociation (CommentAuthorAssociation!)

    Author's association with the subject of the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    authorCanPushToRepository (Boolean!)

    Indicates whether the author of this review has push access to the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    body (String!)

    Identifies the pull request review body.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyHTML (HTML!)

    The body rendered to HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyText (String!)

    The body of this review rendered as plain text.

    \n\n\n\n\n\n\n\n\n\n\n\n

    comments (PullRequestReviewCommentConnection!)

    A list of review comments for the current pull request review.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    commit (Commit)

    Identifies the commit associated with this pull request review.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdViaEmail (Boolean!)

    Check if this comment was created via an email reply.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    editor (Actor)

    The actor who edited the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    includesCreatedEdit (Boolean!)

    Check if this comment was edited and includes an edit with the creation data.

    \n\n\n\n\n\n\n\n\n\n\n\n

    lastEditedAt (DateTime)

    The moment the editor made the last edit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    onBehalfOf (TeamConnection!)

    A list of teams that this review was made on behalf of.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    publishedAt (DateTime)

    Identifies when the comment was published at.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    Identifies the pull request associated with this pull request review.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reactionGroups ([ReactionGroup!])

    A list of reactions grouped by content left on the subject.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reactions (ReactionConnection!)

    A list of Reactions left on the Issue.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    content (ReactionContent)

    \n

    Allows filtering Reactions by emoji.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (ReactionOrder)

    \n

    Allows specifying the order in which reactions are returned.

    \n\n
    \n\n
    \n\n\n

    repository (Repository!)

    The repository associated with this node.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path permalink for this PullRequestReview.

    \n\n\n\n\n\n\n\n\n\n\n\n

    state (PullRequestReviewState!)

    Identifies the current state of the pull request review.

    \n\n\n\n\n\n\n\n\n\n\n\n

    submittedAt (DateTime)

    Identifies when the Pull Request Review was submitted.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL permalink for this PullRequestReview.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userContentEdits (UserContentEditConnection)

    A list of edits to this content.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    viewerCanDelete (Boolean!)

    Check if the current viewer can delete this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanReact (Boolean!)

    Can user react to this subject.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanUpdate (Boolean!)

    Check if the current viewer can update this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

    Reasons why the current viewer can not update this comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerDidAuthor (Boolean!)

    Did the viewer author this comment.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestReviewComment\n

    \n

    A review comment associated with a given repository pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    author (Actor)

    The actor who authored the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    authorAssociation (CommentAuthorAssociation!)

    Author's association with the subject of the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    body (String!)

    The comment body of this review comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyHTML (HTML!)

    The body rendered to HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyText (String!)

    The comment body of this review comment rendered as plain text.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commit (Commit)

    Identifies the commit associated with the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies when the comment was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdViaEmail (Boolean!)

    Check if this comment was created via an email reply.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    diffHunk (String!)

    The diff hunk to which the comment applies.

    \n\n\n\n\n\n\n\n\n\n\n\n

    draftedAt (DateTime!)

    Identifies when the comment was created in a draft state.

    \n\n\n\n\n\n\n\n\n\n\n\n

    editor (Actor)

    The actor who edited the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    includesCreatedEdit (Boolean!)

    Check if this comment was edited and includes an edit with the creation data.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isMinimized (Boolean!)

    Returns whether or not a comment has been minimized.

    \n\n\n\n\n\n\n\n\n\n\n\n

    lastEditedAt (DateTime)

    The moment the editor made the last edit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    minimizedReason (String)

    Returns why the comment was minimized.

    \n\n\n\n\n\n\n\n\n\n\n\n

    originalCommit (Commit)

    Identifies the original commit associated with the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    originalPosition (Int!)

    The original line index in the diff to which the comment applies.

    \n\n\n\n\n\n\n\n\n\n\n\n

    outdated (Boolean!)

    Identifies when the comment body is outdated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    path (String!)

    The path to which the comment applies.

    \n\n\n\n\n\n\n\n\n\n\n\n

    position (Int)

    The line index in the diff to which the comment applies.

    \n\n\n\n\n\n\n\n\n\n\n\n

    publishedAt (DateTime)

    Identifies when the comment was published at.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    The pull request associated with this review comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestReview (PullRequestReview)

    The pull request review associated with this review comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reactionGroups ([ReactionGroup!])

    A list of reactions grouped by content left on the subject.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reactions (ReactionConnection!)

    A list of Reactions left on the Issue.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    content (ReactionContent)

    \n

    Allows filtering Reactions by emoji.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (ReactionOrder)

    \n

    Allows specifying the order in which reactions are returned.

    \n\n
    \n\n
    \n\n\n

    replyTo (PullRequestReviewComment)

    The comment this is a reply to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository!)

    The repository associated with this node.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path permalink for this review comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    state (PullRequestReviewCommentState!)

    Identifies the state of the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies when the comment was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL permalink for this review comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userContentEdits (UserContentEditConnection)

    A list of edits to this content.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    viewerCanDelete (Boolean!)

    Check if the current viewer can delete this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanMinimize (Boolean!)

    Check if the current viewer can minimize this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanReact (Boolean!)

    Can user react to this subject.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanUpdate (Boolean!)

    Check if the current viewer can update this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

    Reasons why the current viewer can not update this comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerDidAuthor (Boolean!)

    Did the viewer author this comment.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestReviewCommentConnection\n

    \n

    The connection type for PullRequestReviewComment.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([PullRequestReviewCommentEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([PullRequestReviewComment])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestReviewCommentEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (PullRequestReviewComment)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestReviewConnection\n

    \n

    The connection type for PullRequestReview.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([PullRequestReviewEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([PullRequestReview])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestReviewContributionsByRepository\n

    \n

    This aggregates pull request reviews made by a user within one repository.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    contributions (CreatedPullRequestReviewContributionConnection!)

    The pull request review contributions.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (ContributionOrder)

    \n

    Ordering options for contributions returned from the connection.

    \n\n
    \n\n
    \n\n\n

    repository (Repository!)

    The repository in which the pull request reviews were made.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestReviewEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (PullRequestReview)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestReviewThread\n

    \n

    A threaded list of comments for a given pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    comments (PullRequestReviewCommentConnection!)

    A list of pull request comments associated with the thread.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    skip (Int)

    \n

    Skips the first n elements in the list.

    \n\n
    \n\n
    \n\n\n

    diffSide (DiffSide!)

    The side of the diff on which this thread was placed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isCollapsed (Boolean!)

    Whether or not the thread has been collapsed (outdated or resolved).

    \n\n\n\n\n\n\n\n\n\n\n\n

    isOutdated (Boolean!)

    Indicates whether this thread was outdated by newer changes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isResolved (Boolean!)

    Whether this thread has been resolved.

    \n\n\n\n\n\n\n\n\n\n\n\n

    line (Int)

    The line in the file to which this thread refers.

    \n\n\n\n\n\n\n\n\n\n\n\n

    originalLine (Int)

    The original line in the file to which this thread refers.

    \n\n\n\n\n\n\n\n\n\n\n\n

    originalStartLine (Int)

    The original start line in the file to which this thread refers (multi-line only).

    \n\n\n\n\n\n\n\n\n\n\n\n

    path (String!)

    Identifies the file path of this thread.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    Identifies the pull request associated with this thread.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository!)

    Identifies the repository associated with this thread.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resolvedBy (User)

    The user who resolved this thread.

    \n\n\n\n\n\n\n\n\n\n\n\n

    startDiffSide (DiffSide)

    The side of the diff that the first line of the thread starts on (multi-line only).

    \n\n\n\n\n\n\n\n\n\n\n\n

    startLine (Int)

    The start line in the file to which this thread refers (multi-line only).

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanReply (Boolean!)

    Indicates whether the current viewer can reply to this thread.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanResolve (Boolean!)

    Whether or not the viewer can resolve this thread.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanUnresolve (Boolean!)

    Whether or not the viewer can unresolve this thread.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestReviewThreadConnection\n

    \n

    Review comment threads for a pull request review.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([PullRequestReviewThreadEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([PullRequestReviewThread])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestReviewThreadEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (PullRequestReviewThread)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestRevisionMarker\n

    \n

    Represents the latest point in the pull request timeline for which the viewer has seen the pull request's commits.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    lastSeenCommit (Commit!)

    The last commit the viewer has seen.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    The pull request to which the marker belongs.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestTimelineConnection\n

    \n

    The connection type for PullRequestTimelineItem.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([PullRequestTimelineItemEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([PullRequestTimelineItem])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestTimelineItemEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (PullRequestTimelineItem)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestTimelineItemsConnection\n

    \n

    The connection type for PullRequestTimelineItems.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([PullRequestTimelineItemsEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    filteredCount (Int!)

    Identifies the count of items after applying before and after filters.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([PullRequestTimelineItems])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageCount (Int!)

    Identifies the count of items after applying before/after filters and first/last/skip slicing.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the timeline was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestTimelineItemsEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (PullRequestTimelineItems)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Push\n

    \n

    A Git push.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    nextSha (GitObjectID)

    The SHA after the push.

    \n\n\n\n\n\n\n\n\n\n\n\n

    permalink (URI!)

    The permalink for this push.

    \n\n\n\n\n\n\n\n\n\n\n\n

    previousSha (GitObjectID)

    The SHA before the push.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pusher (User!)

    The user who pushed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository!)

    The repository that was pushed to.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PushAllowance\n

    \n

    A team, user or app who has the ability to push to a protected branch.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (PushAllowanceActor)

    The actor that can push.

    \n\n\n\n\n\n\n\n\n\n\n\n

    branchProtectionRule (BranchProtectionRule)

    Identifies the branch protection rule associated with the allowed user or team.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PushAllowanceConnection\n

    \n

    The connection type for PushAllowance.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([PushAllowanceEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([PushAllowance])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PushAllowanceEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (PushAllowance)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RateLimit\n

    \n

    Represents the client's rate limit.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cost (Int!)

    The point cost for the current query counting against the rate limit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    limit (Int!)

    The maximum number of points the client is permitted to consume in a 60 minute window.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodeCount (Int!)

    The maximum number of nodes this query may return.

    \n\n\n\n\n\n\n\n\n\n\n\n

    remaining (Int!)

    The number of points remaining in the current rate limit window.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resetAt (DateTime!)

    The time at which the current rate limit window resets in UTC epoch seconds.

    \n\n\n\n\n\n\n\n\n\n\n\n

    used (Int!)

    The number of points used in the current rate limit window.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReactingUserConnection\n

    \n

    The connection type for User.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([ReactingUserEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([User])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReactingUserEdge\n

    \n

    Represents a user that's made a reaction.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reactedAt (DateTime!)

    The moment when the user made the reaction.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Reaction\n

    \n

    An emoji reaction to a particular piece of content.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    content (ReactionContent!)

    Identifies the emoji reaction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reactable (Reactable!)

    The reactable piece of content.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    Identifies the user who created this reaction.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReactionConnection\n

    \n

    A list of reactions that have been left on the subject.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([ReactionEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Reaction])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerHasReacted (Boolean!)

    Whether or not the authenticated user has left a reaction on the subject.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReactionEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (Reaction)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReactionGroup\n

    \n

    A group of emoji reactions to a particular piece of content.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    content (ReactionContent!)

    Identifies the emoji reaction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime)

    Identifies when the reaction was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    subject (Reactable!)

    The subject that was reacted to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    users (ReactingUserConnection!)

    Users who have reacted to the reaction subject with the emotion represented by this reaction group.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    viewerHasReacted (Boolean!)

    Whether or not the authenticated user has left a reaction on the subject.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReadyForReviewEvent\n

    \n

    Represents aready_for_reviewevent on a given pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    PullRequest referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this ready for review event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this ready for review event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Ref\n

    \n

    Represents a Git reference.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    associatedPullRequests (PullRequestConnection!)

    A list of pull requests with this ref as the head ref.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    baseRefName (String)

    \n

    The base ref name to filter the pull requests by.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    headRefName (String)

    \n

    The head ref name to filter the pull requests by.

    \n\n
    \n\n
    \n

    labels ([String!])

    \n

    A list of label names to filter the pull requests by.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (IssueOrder)

    \n

    Ordering options for pull requests returned from the connection.

    \n\n
    \n\n
    \n

    states ([PullRequestState!])

    \n

    A list of states to filter the pull requests by.

    \n\n
    \n\n
    \n\n\n

    branchProtectionRule (BranchProtectionRule)

    Branch protection rules for this ref.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The ref name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    prefix (String!)

    The ref's prefix, such as refs/heads/ or refs/tags/.

    \n\n\n\n\n\n\n\n\n\n\n\n

    refUpdateRule (RefUpdateRule)

    Branch protection rules that are viewable by non-admins.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository!)

    The repository the ref belongs to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    target (GitObject)

    The object the ref points to. Returns null when object does not exist.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RefConnection\n

    \n

    The connection type for Ref.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([RefEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Ref])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RefEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (Ref)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RefUpdateRule\n

    \n

    A ref update rules for a viewer.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    allowsDeletions (Boolean!)

    Can this branch be deleted.

    \n\n\n\n\n\n\n\n\n\n\n\n

    allowsForcePushes (Boolean!)

    Are force pushes allowed on this branch.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pattern (String!)

    Identifies the protection rule pattern.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiredApprovingReviewCount (Int)

    Number of approving reviews required to update matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiredStatusCheckContexts ([String])

    List of required status check contexts that must pass for commits to be accepted to matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiresLinearHistory (Boolean!)

    Are merge commits prohibited from being pushed to this branch.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiresSignatures (Boolean!)

    Are commits required to be signed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanPush (Boolean!)

    Can the viewer push to the branch.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReferencedEvent\n

    \n

    Represents areferencedevent on a given ReferencedSubject.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commit (Commit)

    Identifies the commit associated with thereferencedevent.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commitRepository (Repository!)

    Identifies the repository associated with thereferencedevent.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isCrossRepository (Boolean!)

    Reference originated in a different repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isDirectReference (Boolean!)

    Checks if the commit message itself references the subject. Can be false in the case of a commit comment reference.

    \n\n\n\n\n\n\n\n\n\n\n\n

    subject (ReferencedSubject!)

    Object referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Release\n

    \n

    A release contains the content for a release.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    author (User)

    The author of the release.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String)

    The description of the release.

    \n\n\n\n\n\n\n\n\n\n\n\n

    descriptionHTML (HTML)

    The description of this release rendered to HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isDraft (Boolean!)

    Whether or not the release is a draft.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isLatest (Boolean!)

    Whether or not the release is the latest releast.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isPrerelease (Boolean!)

    Whether or not the release is a prerelease.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String)

    The title of the release.

    \n\n\n\n\n\n\n\n\n\n\n\n

    publishedAt (DateTime)

    Identifies the date and time when the release was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    releaseAssets (ReleaseAssetConnection!)

    List of releases assets which are dependent on this release.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    name (String)

    \n

    A list of names to filter the assets by.

    \n\n
    \n\n
    \n\n\n

    repository (Repository!)

    The repository that the release belongs to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this issue.

    \n\n\n\n\n\n\n\n\n\n\n\n

    shortDescriptionHTML (HTML)

    A description of the release, rendered to HTML without any links in it.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    limit (Int)

    \n

    How many characters to return.

    \n

    The default value is 200.

    \n
    \n\n
    \n\n\n

    tag (Ref)

    The Git tag the release points to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    tagName (String!)

    The name of the release's Git tag.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this issue.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReleaseAsset\n

    \n

    A release asset contains the content for a release asset.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    contentType (String!)

    The asset's content-type.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    downloadCount (Int!)

    The number of times this asset was downloaded.

    \n\n\n\n\n\n\n\n\n\n\n\n

    downloadUrl (URI!)

    Identifies the URL where you can download the release asset via the browser.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    Identifies the title of the release asset.

    \n\n\n\n\n\n\n\n\n\n\n\n

    release (Release)

    Release that the asset is associated with.

    \n\n\n\n\n\n\n\n\n\n\n\n

    size (Int!)

    The size (in bytes) of the asset.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    uploadedBy (User!)

    The user that performed the upload.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    Identifies the URL of the release asset.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReleaseAssetConnection\n

    \n

    The connection type for ReleaseAsset.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([ReleaseAssetEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([ReleaseAsset])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReleaseAssetEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (ReleaseAsset)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReleaseConnection\n

    \n

    The connection type for Release.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([ReleaseEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Release])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReleaseEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (Release)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RemovedFromProjectEvent\n

    \n

    Represents aremoved_from_projectevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    project (Project)

    Project referenced by event.

    \n\n\n\n\n
    \n

    Preview notice

    \n

    project is available under the Project event details preview. During the preview period, the API may change without notice.

    \n
    \n\n\n\n\n\n\n\n\n

    projectColumnName (String!)

    Column name referenced by this project event.

    \n\n\n\n\n
    \n

    Preview notice

    \n

    projectColumnName is available under the Project event details preview. During the preview period, the API may change without notice.

    \n
    \n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RenamedTitleEvent\n

    \n

    Represents arenamedevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    currentTitle (String!)

    Identifies the current title of the issue or pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    previousTitle (String!)

    Identifies the previous title of the issue or pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    subject (RenamedTitleSubject!)

    Subject that was renamed.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReopenedEvent\n

    \n

    Represents areopenedevent on any Closable.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    closable (Closable!)

    Object that was reopened.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepoAccessAuditEntry\n

    \n

    Audit log entry for a repo.access event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    visibility (RepoAccessAuditEntryVisibility)

    The visibility of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepoAddMemberAuditEntry\n

    \n

    Audit log entry for a repo.add_member event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    visibility (RepoAddMemberAuditEntryVisibility)

    The visibility of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepoAddTopicAuditEntry\n

    \n

    Audit log entry for a repo.add_topic event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    topic (Topic)

    The name of the topic added to the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    topicName (String)

    The name of the topic added to the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepoArchivedAuditEntry\n

    \n

    Audit log entry for a repo.archived event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    visibility (RepoArchivedAuditEntryVisibility)

    The visibility of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepoChangeMergeSettingAuditEntry\n

    \n

    Audit log entry for a repo.change_merge_setting event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isEnabled (Boolean)

    Whether the change was to enable (true) or disable (false) the merge type.

    \n\n\n\n\n\n\n\n\n\n\n\n

    mergeType (RepoChangeMergeSettingAuditEntryMergeType)

    The merge method affected by the change.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepoConfigDisableAnonymousGitAccessAuditEntry\n

    \n

    Audit log entry for a repo.config.disable_anonymous_git_access event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepoConfigDisableCollaboratorsOnlyAuditEntry\n

    \n

    Audit log entry for a repo.config.disable_collaborators_only event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepoConfigDisableContributorsOnlyAuditEntry\n

    \n

    Audit log entry for a repo.config.disable_contributors_only event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepoConfigDisableSockpuppetDisallowedAuditEntry\n

    \n

    Audit log entry for a repo.config.disable_sockpuppet_disallowed event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepoConfigEnableAnonymousGitAccessAuditEntry\n

    \n

    Audit log entry for a repo.config.enable_anonymous_git_access event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepoConfigEnableCollaboratorsOnlyAuditEntry\n

    \n

    Audit log entry for a repo.config.enable_collaborators_only event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepoConfigEnableContributorsOnlyAuditEntry\n

    \n

    Audit log entry for a repo.config.enable_contributors_only event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepoConfigEnableSockpuppetDisallowedAuditEntry\n

    \n

    Audit log entry for a repo.config.enable_sockpuppet_disallowed event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepoConfigLockAnonymousGitAccessAuditEntry\n

    \n

    Audit log entry for a repo.config.lock_anonymous_git_access event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepoConfigUnlockAnonymousGitAccessAuditEntry\n

    \n

    Audit log entry for a repo.config.unlock_anonymous_git_access event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepoCreateAuditEntry\n

    \n

    Audit log entry for a repo.create event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    forkParentName (String)

    The name of the parent repository for this forked repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    forkSourceName (String)

    The name of the root repository for this network.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    visibility (RepoCreateAuditEntryVisibility)

    The visibility of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepoDestroyAuditEntry\n

    \n

    Audit log entry for a repo.destroy event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    visibility (RepoDestroyAuditEntryVisibility)

    The visibility of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepoRemoveMemberAuditEntry\n

    \n

    Audit log entry for a repo.remove_member event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    visibility (RepoRemoveMemberAuditEntryVisibility)

    The visibility of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepoRemoveTopicAuditEntry\n

    \n

    Audit log entry for a repo.remove_topic event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    topic (Topic)

    The name of the topic added to the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    topicName (String)

    The name of the topic added to the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Repository\n

    \n

    A repository contains the content for a project.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    assignableUsers (UserConnection!)

    A list of users that can be assigned to issues in this repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    query (String)

    \n

    Filters users with query on user name and login.

    \n\n
    \n\n
    \n\n\n

    branchProtectionRules (BranchProtectionRuleConnection!)

    A list of branch protection rules for this repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    codeOfConduct (CodeOfConduct)

    Returns the code of conduct for this repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    collaborators (RepositoryCollaboratorConnection)

    A list of collaborators associated with the repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    affiliation (CollaboratorAffiliation)

    \n

    Collaborators affiliation level with a repository.

    \n\n
    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    query (String)

    \n

    Filters users with query on user name and login.

    \n\n
    \n\n
    \n\n\n

    commitComments (CommitCommentConnection!)

    A list of commit comments associated with the repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    contactLinks ([RepositoryContactLink!])

    Returns a list of contact links associated to the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    defaultBranchRef (Ref)

    The Ref associated with the repository's default branch.

    \n\n\n\n\n\n\n\n\n\n\n\n

    deleteBranchOnMerge (Boolean!)

    Whether or not branches are automatically deleted when merged in this repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    deployKeys (DeployKeyConnection!)

    A list of deploy keys that are on this repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    deployments (DeploymentConnection!)

    Deployments associated with the repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    environments ([String!])

    \n

    Environments to list deployments for.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (DeploymentOrder)

    \n

    Ordering options for deployments returned from the connection.

    \n\n
    \n\n
    \n\n\n

    description (String)

    The description of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    descriptionHTML (HTML!)

    The description of the repository rendered to HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    diskUsage (Int)

    The number of kilobytes this repository occupies on disk.

    \n\n\n\n\n\n\n\n\n\n\n\n

    forkCount (Int!)

    Returns how many forks there are of this repository in the whole network.

    \n\n\n\n\n\n\n\n\n\n\n\n

    forks (RepositoryConnection!)

    A list of direct forked repositories.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    affiliations ([RepositoryAffiliation])

    \n

    Array of viewer's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\ncurrent viewer owns.

    \n\n
    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    isLocked (Boolean)

    \n

    If non-null, filters repositories according to whether they have been locked.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (RepositoryOrder)

    \n

    Ordering options for repositories returned from the connection.

    \n\n
    \n\n
    \n

    ownerAffiliations ([RepositoryAffiliation])

    \n

    Array of owner's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\norganization or user being viewed owns.

    \n\n
    \n\n
    \n

    privacy (RepositoryPrivacy)

    \n

    If non-null, filters repositories according to privacy.

    \n\n
    \n\n
    \n\n\n

    hasAnonymousAccessEnabled (Boolean!)

    Indicates if the repository has anonymous Git read access feature enabled.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hasIssuesEnabled (Boolean!)

    Indicates if the repository has issues feature enabled.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hasProjectsEnabled (Boolean!)

    Indicates if the repository has the Projects feature enabled.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hasWikiEnabled (Boolean!)

    Indicates if the repository has wiki feature enabled.

    \n\n\n\n\n\n\n\n\n\n\n\n

    homepageUrl (URI)

    The repository's URL.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isArchived (Boolean!)

    Indicates if the repository is unmaintained.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isBlankIssuesEnabled (Boolean!)

    Returns true if blank issue creation is allowed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isDisabled (Boolean!)

    Returns whether or not this repository disabled.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isEmpty (Boolean!)

    Returns whether or not this repository is empty.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isFork (Boolean!)

    Identifies if the repository is a fork.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isInOrganization (Boolean!)

    Indicates if a repository is either owned by an organization, or is a private fork of an organization repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isLocked (Boolean!)

    Indicates if the repository has been locked or not.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isMirror (Boolean!)

    Identifies if the repository is a mirror.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isPrivate (Boolean!)

    Identifies if the repository is private.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isSecurityPolicyEnabled (Boolean)

    Returns true if this repository has a security policy.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isTemplate (Boolean!)

    Identifies if the repository is a template that can be used to generate new repositories.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isUserConfigurationRepository (Boolean!)

    Is this repository a user configuration repository?.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issue (Issue)

    Returns a single issue from the current repository by number.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    number (Int!)

    \n

    The number for the issue to be returned.

    \n\n
    \n\n
    \n\n\n

    issueOrPullRequest (IssueOrPullRequest)

    Returns a single issue-like object from the current repository by number.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    number (Int!)

    \n

    The number for the issue to be returned.

    \n\n
    \n\n
    \n\n\n

    issueTemplates ([IssueTemplate!])

    Returns a list of issue templates associated to the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issues (IssueConnection!)

    A list of issues that have been opened in the repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    filterBy (IssueFilters)

    \n

    Filtering options for issues returned from the connection.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    labels ([String!])

    \n

    A list of label names to filter the pull requests by.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (IssueOrder)

    \n

    Ordering options for issues returned from the connection.

    \n\n
    \n\n
    \n

    states ([IssueState!])

    \n

    A list of states to filter the issues by.

    \n\n
    \n\n
    \n\n\n

    label (Label)

    Returns a single label by name.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    name (String!)

    \n

    Label name.

    \n\n
    \n\n
    \n\n\n

    labels (LabelConnection)

    A list of labels associated with the repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (LabelOrder)

    \n

    Ordering options for labels returned from the connection.

    \n\n
    \n\n
    \n

    query (String)

    \n

    If provided, searches labels by name and description.

    \n\n
    \n\n
    \n\n\n

    languages (LanguageConnection)

    A list containing a breakdown of the language composition of the repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (LanguageOrder)

    \n

    Order for connection.

    \n\n
    \n\n
    \n\n\n

    latestRelease (Release)

    Get the latest release for the repository if one exists.

    \n\n\n\n\n\n\n\n\n\n\n\n

    licenseInfo (License)

    The license associated with the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    lockReason (RepositoryLockReason)

    The reason the repository has been locked.

    \n\n\n\n\n\n\n\n\n\n\n\n

    mentionableUsers (UserConnection!)

    A list of Users that can be mentioned in the context of the repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    query (String)

    \n

    Filters users with query on user name and login.

    \n\n
    \n\n
    \n\n\n

    mergeCommitAllowed (Boolean!)

    Whether or not PRs are merged with a merge commit on this repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    milestone (Milestone)

    Returns a single milestone from the current repository by number.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    number (Int!)

    \n

    The number for the milestone to be returned.

    \n\n
    \n\n
    \n\n\n

    milestones (MilestoneConnection)

    A list of milestones associated with the repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (MilestoneOrder)

    \n

    Ordering options for milestones.

    \n\n
    \n\n
    \n

    query (String)

    \n

    Filters milestones with a query on the title.

    \n\n
    \n\n
    \n

    states ([MilestoneState!])

    \n

    Filter by the state of the milestones.

    \n\n
    \n\n
    \n\n\n

    mirrorUrl (URI)

    The repository's original mirror URL.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nameWithOwner (String!)

    The repository's name with owner.

    \n\n\n\n\n\n\n\n\n\n\n\n

    object (GitObject)

    A Git object in the repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    expression (String)

    \n

    A Git revision expression suitable for rev-parse.

    \n\n
    \n\n
    \n

    oid (GitObjectID)

    \n

    The Git object ID.

    \n\n
    \n\n
    \n\n\n

    openGraphImageUrl (URI!)

    The image used to represent this repository in Open Graph data.

    \n\n\n\n\n\n\n\n\n\n\n\n

    owner (RepositoryOwner!)

    The User owner of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    parent (Repository)

    The repository parent, if this is a fork.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pinnedIssues (PinnedIssueConnection)

    A list of pinned issues for this repository.

    \n\n\n\n\n
    \n

    Preview notice

    \n

    pinnedIssues is available under the Pinned issues preview. During the preview period, the API may change without notice.

    \n
    \n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    primaryLanguage (Language)

    The primary language of the repository's code.

    \n\n\n\n\n\n\n\n\n\n\n\n

    project (Project)

    Find project by number.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    number (Int!)

    \n

    The project number to find.

    \n\n
    \n\n
    \n\n\n

    projects (ProjectConnection!)

    A list of projects under the owner.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (ProjectOrder)

    \n

    Ordering options for projects returned from the connection.

    \n\n
    \n\n
    \n

    search (String)

    \n

    Query to search projects by, currently only searching by name.

    \n\n
    \n\n
    \n

    states ([ProjectState!])

    \n

    A list of states to filter the projects by.

    \n\n
    \n\n
    \n\n\n

    projectsResourcePath (URI!)

    The HTTP path listing the repository's projects.

    \n\n\n\n\n\n\n\n\n\n\n\n

    projectsUrl (URI!)

    The HTTP URL listing the repository's projects.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest)

    Returns a single pull request from the current repository by number.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    number (Int!)

    \n

    The number for the pull request to be returned.

    \n\n
    \n\n
    \n\n\n

    pullRequests (PullRequestConnection!)

    A list of pull requests that have been opened in the repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    baseRefName (String)

    \n

    The base ref name to filter the pull requests by.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    headRefName (String)

    \n

    The head ref name to filter the pull requests by.

    \n\n
    \n\n
    \n

    labels ([String!])

    \n

    A list of label names to filter the pull requests by.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (IssueOrder)

    \n

    Ordering options for pull requests returned from the connection.

    \n\n
    \n\n
    \n

    states ([PullRequestState!])

    \n

    A list of states to filter the pull requests by.

    \n\n
    \n\n
    \n\n\n

    pushedAt (DateTime)

    Identifies when the repository was last pushed to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    rebaseMergeAllowed (Boolean!)

    Whether or not rebase-merging is enabled on this repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ref (Ref)

    Fetch a given ref from the repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    qualifiedName (String!)

    \n

    The ref to retrieve. Fully qualified matches are checked in order\n(refs/heads/master) before falling back onto checks for short name matches (master).

    \n\n
    \n\n
    \n\n\n

    refs (RefConnection)

    Fetch a list of refs from the repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    direction (OrderDirection)

    \n

    DEPRECATED: use orderBy. The ordering direction.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (RefOrder)

    \n

    Ordering options for refs returned from the connection.

    \n\n
    \n\n
    \n

    query (String)

    \n

    Filters refs with query on name.

    \n\n
    \n\n
    \n

    refPrefix (String!)

    \n

    A ref name prefix like refs/heads/, refs/tags/, etc.

    \n\n
    \n\n
    \n\n\n

    release (Release)

    Lookup a single release given various criteria.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    tagName (String!)

    \n

    The name of the Tag the Release was created from.

    \n\n
    \n\n
    \n\n\n

    releases (ReleaseConnection!)

    List of releases which are dependent on this repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (ReleaseOrder)

    \n

    Order for connection.

    \n\n
    \n\n
    \n\n\n

    repositoryTopics (RepositoryTopicConnection!)

    A list of applied repository-topic associations for this repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    resourcePath (URI!)

    The HTTP path for this repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    securityPolicyUrl (URI)

    The security policy URL.

    \n\n\n\n\n\n\n\n\n\n\n\n

    shortDescriptionHTML (HTML!)

    A description of the repository, rendered to HTML without any links in it.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    limit (Int)

    \n

    How many characters to return.

    \n

    The default value is 200.

    \n
    \n\n
    \n\n\n

    squashMergeAllowed (Boolean!)

    Whether or not squash-merging is enabled on this repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    sshUrl (GitSSHRemote!)

    The SSH URL to clone this repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    stargazerCount (Int!)

    Returns a count of how many stargazers there are on this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    stargazers (StargazerConnection!)

    A list of users who have starred this starrable.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (StarOrder)

    \n

    Order for connection.

    \n\n
    \n\n
    \n\n\n

    submodules (SubmoduleConnection!)

    Returns a list of all submodules in this repository parsed from the\n.gitmodules file as of the default branch's HEAD commit.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    tempCloneToken (String)

    Temporary authentication token for cloning this repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    templateRepository (Repository)

    The repository from which this repository was generated, if any.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    usesCustomOpenGraphImage (Boolean!)

    Whether this repository has a custom image to use with Open Graph as opposed to being represented by the owner's avatar.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanAdminister (Boolean!)

    Indicates whether the viewer has admin permissions on this repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanCreateProjects (Boolean!)

    Can the current viewer create new projects on this owner.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanSubscribe (Boolean!)

    Check if the viewer is able to change their subscription status for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanUpdateTopics (Boolean!)

    Indicates whether the viewer can update the topics of this repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerDefaultCommitEmail (String)

    The last commit email for the viewer.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerDefaultMergeMethod (PullRequestMergeMethod!)

    The last used merge method by the viewer or the default for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerHasStarred (Boolean!)

    Returns a boolean indicating whether the viewing user has starred this starrable.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerPermission (RepositoryPermission)

    The users permission level on the repository. Will return null if authenticated as an GitHub App.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerPossibleCommitEmails ([String!])

    A list of emails this viewer can commit with.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerSubscription (SubscriptionState)

    Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

    \n\n\n\n\n\n\n\n\n\n\n\n

    vulnerabilityAlerts (RepositoryVulnerabilityAlertConnection)

    A list of vulnerability alerts that are on this repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    watchers (UserConnection!)

    A list of users watching the repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepositoryCollaboratorConnection\n

    \n

    The connection type for User.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([RepositoryCollaboratorEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([User])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepositoryCollaboratorEdge\n

    \n

    Represents a user who is a collaborator of a repository.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    permission (RepositoryPermission!)

    The permission the user has on the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    permissionSources ([PermissionSource!])

    A list of sources for the user's access to the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepositoryConnection\n

    \n

    A list of repositories owned by the subject.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([RepositoryEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Repository])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalDiskUsage (Int!)

    The total size in kilobytes of all repositories in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepositoryContactLink\n

    \n

    A repository contact link.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    about (String!)

    The contact link purpose.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The contact link name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The contact link URL.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepositoryEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (Repository)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepositoryInvitation\n

    \n

    An invitation for a user to be added to a repository.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    email (String)

    The email address that received the invitation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    invitee (User)

    The user who received the invitation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    inviter (User!)

    The user who created the invitation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    permalink (URI!)

    The permalink for this repository invitation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    permission (RepositoryPermission!)

    The permission granted on this repository by this invitation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (RepositoryInfo)

    The Repository the user is invited to.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepositoryInvitationConnection\n

    \n

    The connection type for RepositoryInvitation.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([RepositoryInvitationEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([RepositoryInvitation])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepositoryInvitationEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (RepositoryInvitation)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepositoryTopic\n

    \n

    A repository-topic connects a repository to a topic.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    resourcePath (URI!)

    The HTTP path for this repository-topic.

    \n\n\n\n\n\n\n\n\n\n\n\n

    topic (Topic!)

    The topic.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this repository-topic.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepositoryTopicConnection\n

    \n

    The connection type for RepositoryTopic.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([RepositoryTopicEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([RepositoryTopic])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepositoryTopicEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (RepositoryTopic)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepositoryVisibilityChangeDisableAuditEntry\n

    \n

    Audit log entry for a repository_visibility_change.disable event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseResourcePath (URI)

    The HTTP path for this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseSlug (String)

    The slug of the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseUrl (URI)

    The HTTP URL for this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepositoryVisibilityChangeEnableAuditEntry\n

    \n

    Audit log entry for a repository_visibility_change.enable event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseResourcePath (URI)

    The HTTP path for this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseSlug (String)

    The slug of the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseUrl (URI)

    The HTTP URL for this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepositoryVulnerabilityAlert\n

    \n

    A alert for a repository with an affected vulnerability.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    createdAt (DateTime!)

    When was the alert created?.

    \n\n\n\n\n\n\n\n\n\n\n\n

    dismissReason (String)

    The reason the alert was dismissed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    dismissedAt (DateTime)

    When was the alert dismissed?.

    \n\n\n\n\n\n\n\n\n\n\n\n

    dismisser (User)

    The user who dismissed the alert.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository!)

    The associated repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    securityAdvisory (SecurityAdvisory)

    The associated security advisory.

    \n\n\n\n\n\n\n\n\n\n\n\n

    securityVulnerability (SecurityVulnerability)

    The associated security vulnerability.

    \n\n\n\n\n\n\n\n\n\n\n\n

    vulnerableManifestFilename (String!)

    The vulnerable manifest filename.

    \n\n\n\n\n\n\n\n\n\n\n\n

    vulnerableManifestPath (String!)

    The vulnerable manifest path.

    \n\n\n\n\n\n\n\n\n\n\n\n

    vulnerableRequirements (String)

    The vulnerable requirements.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepositoryVulnerabilityAlertConnection\n

    \n

    The connection type for RepositoryVulnerabilityAlert.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([RepositoryVulnerabilityAlertEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([RepositoryVulnerabilityAlert])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepositoryVulnerabilityAlertEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (RepositoryVulnerabilityAlert)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RestrictedContribution\n

    \n

    Represents a private contribution a user made on GitHub.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    isRestricted (Boolean!)

    Whether this contribution is associated with a record you do not have access to. For\nexample, your own 'first issue' contribution may have been made on a repository you can no\nlonger access.

    \n\n\n\n\n\n\n\n\n\n\n\n

    occurredAt (DateTime!)

    When this contribution was made.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User!)

    The user who made this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReviewDismissalAllowance\n

    \n

    A team or user who has the ability to dismiss a review on a protected branch.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (ReviewDismissalAllowanceActor)

    The actor that can dismiss.

    \n\n\n\n\n\n\n\n\n\n\n\n

    branchProtectionRule (BranchProtectionRule)

    Identifies the branch protection rule associated with the allowed user or team.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReviewDismissalAllowanceConnection\n

    \n

    The connection type for ReviewDismissalAllowance.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([ReviewDismissalAllowanceEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([ReviewDismissalAllowance])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReviewDismissalAllowanceEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (ReviewDismissalAllowance)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReviewDismissedEvent\n

    \n

    Represents areview_dismissedevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    dismissalMessage (String)

    Identifies the optional message associated with thereview_dismissedevent.

    \n\n\n\n\n\n\n\n\n\n\n\n

    dismissalMessageHTML (String)

    Identifies the optional message associated with the event, rendered to HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    previousReviewState (PullRequestReviewState!)

    Identifies the previous state of the review with thereview_dismissedevent.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    PullRequest referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestCommit (PullRequestCommit)

    Identifies the commit which caused the review to become stale.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this review dismissed event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    review (PullRequestReview)

    Identifies the review associated with thereview_dismissedevent.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this review dismissed event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReviewRequest\n

    \n

    A request for a user to review a pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    asCodeOwner (Boolean!)

    Whether this request was created for a code owner.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    Identifies the pull request associated with this review request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requestedReviewer (RequestedReviewer)

    The reviewer that is requested.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReviewRequestConnection\n

    \n

    The connection type for ReviewRequest.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([ReviewRequestEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([ReviewRequest])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReviewRequestEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (ReviewRequest)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReviewRequestRemovedEvent\n

    \n

    Represents anreview_request_removedevent on a given pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    PullRequest referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requestedReviewer (RequestedReviewer)

    Identifies the reviewer whose review request was removed.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReviewRequestedEvent\n

    \n

    Represents anreview_requestedevent on a given pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    PullRequest referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requestedReviewer (RequestedReviewer)

    Identifies the reviewer whose review was requested.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReviewStatusHovercardContext\n

    \n

    A hovercard context with a message describing the current code review state of the pull\nrequest.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    message (String!)

    A string describing this context.

    \n\n\n\n\n\n\n\n\n\n\n\n

    octicon (String!)

    An octicon to accompany this context.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reviewDecision (PullRequestReviewDecision)

    The current status of the pull request with respect to code review.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SavedReply\n

    \n

    A Saved Reply is text a user can use to reply quickly.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String!)

    The body of the saved reply.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyHTML (HTML!)

    The saved reply body rendered to HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    title (String!)

    The title of the saved reply.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (Actor)

    The user that saved this reply.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SavedReplyConnection\n

    \n

    The connection type for SavedReply.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([SavedReplyEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([SavedReply])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SavedReplyEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (SavedReply)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SearchResultItemConnection\n

    \n

    A list of results that matched against a search query.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    codeCount (Int!)

    The number of pieces of code that matched the search query.

    \n\n\n\n\n\n\n\n\n\n\n\n

    edges ([SearchResultItemEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issueCount (Int!)

    The number of issues that matched the search query.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([SearchResultItem])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryCount (Int!)

    The number of repositories that matched the search query.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userCount (Int!)

    The number of users that matched the search query.

    \n\n\n\n\n\n\n\n\n\n\n\n

    wikiCount (Int!)

    The number of wiki pages that matched the search query.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SearchResultItemEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (SearchResultItem)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n

    textMatches ([TextMatch])

    Text matches on the result found.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SecurityAdvisory\n

    \n

    A GitHub Security Advisory.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cvss (CVSS!)

    The CVSS associated with this advisory.

    \n\n\n\n\n\n\n\n\n\n\n\n

    cwes (CWEConnection!)

    CWEs associated with this Advisory.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String!)

    This is a long plaintext description of the advisory.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ghsaId (String!)

    The GitHub Security Advisory ID.

    \n\n\n\n\n\n\n\n\n\n\n\n

    identifiers ([SecurityAdvisoryIdentifier!]!)

    A list of identifiers for this advisory.

    \n\n\n\n\n\n\n\n\n\n\n\n

    notificationsPermalink (URI)

    The permalink for the advisory's dependabot alerts page.

    \n\n\n\n\n\n\n\n\n\n\n\n

    origin (String!)

    The organization that originated the advisory.

    \n\n\n\n\n\n\n\n\n\n\n\n

    permalink (URI)

    The permalink for the advisory.

    \n\n\n\n\n\n\n\n\n\n\n\n

    publishedAt (DateTime!)

    When the advisory was published.

    \n\n\n\n\n\n\n\n\n\n\n\n

    references ([SecurityAdvisoryReference!]!)

    A list of references for this advisory.

    \n\n\n\n\n\n\n\n\n\n\n\n

    severity (SecurityAdvisorySeverity!)

    The severity of the advisory.

    \n\n\n\n\n\n\n\n\n\n\n\n

    summary (String!)

    A short plaintext summary of the advisory.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    When the advisory was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    vulnerabilities (SecurityVulnerabilityConnection!)

    Vulnerabilities associated with this Advisory.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    ecosystem (SecurityAdvisoryEcosystem)

    \n

    An ecosystem to filter vulnerabilities by.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    package (String)

    \n

    A package name to filter vulnerabilities by.

    \n\n
    \n\n
    \n

    severities ([SecurityAdvisorySeverity!])

    \n

    A list of severities to filter vulnerabilities by.

    \n\n
    \n\n
    \n\n\n

    withdrawnAt (DateTime)

    When the advisory was withdrawn, if it has been withdrawn.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SecurityAdvisoryConnection\n

    \n

    The connection type for SecurityAdvisory.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([SecurityAdvisoryEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([SecurityAdvisory])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SecurityAdvisoryEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (SecurityAdvisory)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SecurityAdvisoryIdentifier\n

    \n

    A GitHub Security Advisory Identifier.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    type (String!)

    The identifier type, e.g. GHSA, CVE.

    \n\n\n\n\n\n\n\n\n\n\n\n

    value (String!)

    The identifier.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SecurityAdvisoryPackage\n

    \n

    An individual package.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    ecosystem (SecurityAdvisoryEcosystem!)

    The ecosystem the package belongs to, e.g. RUBYGEMS, NPM.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The package name.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SecurityAdvisoryPackageVersion\n

    \n

    An individual package version.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    identifier (String!)

    The package name or version.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SecurityAdvisoryReference\n

    \n

    A GitHub Security Advisory Reference.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    url (URI!)

    A publicly accessible reference.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SecurityVulnerability\n

    \n

    An individual vulnerability within an Advisory.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    advisory (SecurityAdvisory!)

    The Advisory associated with this Vulnerability.

    \n\n\n\n\n\n\n\n\n\n\n\n

    firstPatchedVersion (SecurityAdvisoryPackageVersion)

    The first version containing a fix for the vulnerability.

    \n\n\n\n\n\n\n\n\n\n\n\n

    package (SecurityAdvisoryPackage!)

    A description of the vulnerable package.

    \n\n\n\n\n\n\n\n\n\n\n\n

    severity (SecurityAdvisorySeverity!)

    The severity of the vulnerability within this package.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    When the vulnerability was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    vulnerableVersionRange (String!)

    A string that describes the vulnerable package versions.\nThis string follows a basic syntax with a few forms.

    \n
      \n
    • = 0.2.0 denotes a single vulnerable version.
    • \n
    • <= 1.0.8 denotes a version range up to and including the specified version
    • \n
    • < 0.1.11 denotes a version range up to, but excluding, the specified version
    • \n
    • >= 4.3.0, < 4.3.5 denotes a version range with a known minimum and maximum version.
    • \n
    • >= 0.0.1 denotes a version range with a known minimum, but no known maximum.
    • \n

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SecurityVulnerabilityConnection\n

    \n

    The connection type for SecurityVulnerability.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([SecurityVulnerabilityEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([SecurityVulnerability])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SecurityVulnerabilityEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (SecurityVulnerability)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SmimeSignature\n

    \n

    Represents an S/MIME signature on a Commit or Tag.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    email (String!)

    Email used to sign this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isValid (Boolean!)

    True if the signature is valid and verified by GitHub.

    \n\n\n\n\n\n\n\n\n\n\n\n

    payload (String!)

    Payload for GPG signing object. Raw ODB object without the signature header.

    \n\n\n\n\n\n\n\n\n\n\n\n

    signature (String!)

    ASCII-armored signature header from object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    signer (User)

    GitHub user corresponding to the email signing this commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    state (GitSignatureState!)

    The state of this signature. VALID if signature is valid and verified by\nGitHub, otherwise represents reason why signature is considered invalid.

    \n\n\n\n\n\n\n\n\n\n\n\n

    wasSignedByGitHub (Boolean!)

    True if the signature was made with GitHub's signing key.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Sponsorship\n

    \n

    A sponsorship relationship between a sponsor and a maintainer.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    maintainer (User!)

    The entity that is being sponsored.

    \n\n\n\n\n\n\n
    \n

    Deprecation notice

    \n

    maintainer is deprecated.

    Sponsorship.maintainer will be removed. Use Sponsorship.sponsorable instead. Removal on 2020-04-01 UTC.

    \n
    \n\n\n\n\n\n\n

    privacyLevel (SponsorshipPrivacy!)

    The privacy level for this sponsorship.

    \n\n\n\n\n\n\n\n\n\n\n\n

    sponsor (User)

    The user that is sponsoring. Returns null if the sponsorship is private or if sponsor is not a user.

    \n\n\n\n\n\n\n
    \n

    Deprecation notice

    \n

    sponsor is deprecated.

    Sponsorship.sponsor will be removed. Use Sponsorship.sponsorEntity instead. Removal on 2020-10-01 UTC.

    \n
    \n\n\n\n\n\n\n

    sponsorEntity (Sponsor)

    The user or organization that is sponsoring, if you have permission to view them.

    \n\n\n\n\n\n\n\n\n\n\n\n

    sponsorable (Sponsorable!)

    The entity that is being sponsored.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SponsorshipConnection\n

    \n

    The connection type for Sponsorship.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([SponsorshipEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Sponsorship])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SponsorshipEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (Sponsorship)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n StargazerConnection\n

    \n

    The connection type for User.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([StargazerEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([User])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n StargazerEdge\n

    \n

    Represents a user that's starred a repository.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    starredAt (DateTime!)

    Identifies when the item was starred.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n StarredRepositoryConnection\n

    \n

    The connection type for Repository.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([StarredRepositoryEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isOverLimit (Boolean!)

    Is the list of stars for this user truncated? This is true for users that have many stars.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Repository])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n StarredRepositoryEdge\n

    \n

    Represents a starred repository.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    starredAt (DateTime!)

    Identifies when the item was starred.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Status\n

    \n

    Represents a commit status.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    combinedContexts (StatusCheckRollupContextConnection!)

    A list of status contexts and check runs for this commit.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    commit (Commit)

    The commit this status is attached to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    context (StatusContext)

    Looks up an individual status context by context name.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    name (String!)

    \n

    The context name.

    \n\n
    \n\n
    \n\n\n

    contexts ([StatusContext!]!)

    The individual status contexts for this commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    state (StatusState!)

    The combined commit status.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n StatusCheckRollup\n

    \n

    Represents the rollup for both the check runs and status for a commit.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    commit (Commit)

    The commit the status and check runs are attached to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    contexts (StatusCheckRollupContextConnection!)

    A list of status contexts and check runs for this commit.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    state (StatusState!)

    The combined status for the commit.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n StatusCheckRollupContextConnection\n

    \n

    The connection type for StatusCheckRollupContext.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([StatusCheckRollupContextEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([StatusCheckRollupContext])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n StatusCheckRollupContextEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (StatusCheckRollupContext)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n StatusContext\n

    \n

    Represents an individual commit status context.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    avatarUrl (URI)

    The avatar of the OAuth application or the user that created the status.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    size (Int)

    \n

    The size of the resulting square image.

    \n

    The default value is 40.

    \n
    \n\n
    \n\n\n

    commit (Commit)

    This commit this status context is attached to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    context (String!)

    The name of this status context.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    creator (Actor)

    The actor who created this status context.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String)

    The description for this status context.

    \n\n\n\n\n\n\n\n\n\n\n\n

    state (StatusState!)

    The state of this status context.

    \n\n\n\n\n\n\n\n\n\n\n\n

    targetUrl (URI)

    The URL for this status context.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Submodule\n

    \n

    A pointer to a repository at a specific revision embedded inside another repository.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    branch (String)

    The branch of the upstream submodule for tracking updates.

    \n\n\n\n\n\n\n\n\n\n\n\n

    gitUrl (URI!)

    The git URL of the submodule repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The name of the submodule in .gitmodules.

    \n\n\n\n\n\n\n\n\n\n\n\n

    path (String!)

    The path in the superproject that this submodule is located in.

    \n\n\n\n\n\n\n\n\n\n\n\n

    subprojectCommitOid (GitObjectID)

    The commit revision of the subproject repository being tracked by the submodule.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SubmoduleConnection\n

    \n

    The connection type for Submodule.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([SubmoduleEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Submodule])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SubmoduleEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (Submodule)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SubscribedEvent\n

    \n

    Represents asubscribedevent on a given Subscribable.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    subscribable (Subscribable!)

    Object referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SuggestedReviewer\n

    \n

    A suggestion to review a pull request based on a user's commit history and review comments.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    isAuthor (Boolean!)

    Is this suggestion based on past commits?.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isCommenter (Boolean!)

    Is this suggestion based on past review comments?.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reviewer (User!)

    Identifies the user suggested to review the pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Tag\n

    \n

    Represents a Git tag.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    abbreviatedOid (String!)

    An abbreviated version of the Git object ID.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commitResourcePath (URI!)

    The HTTP path for this Git object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commitUrl (URI!)

    The HTTP URL for this Git object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    message (String)

    The Git tag message.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The Git tag name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    oid (GitObjectID!)

    The Git object ID.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository!)

    The Repository the Git object belongs to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    tagger (GitActor)

    Details about the tag author.

    \n\n\n\n\n\n\n\n\n\n\n\n

    target (GitObject!)

    The Git object the tag points to.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Team\n

    \n

    A team of users in an organization.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    ancestors (TeamConnection!)

    A list of teams that are ancestors of this team.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    avatarUrl (URI)

    A URL pointing to the team's avatar.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    size (Int)

    \n

    The size in pixels of the resulting square image.

    \n

    The default value is 400.

    \n
    \n\n
    \n\n\n

    childTeams (TeamConnection!)

    List of child teams belonging to this team.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    immediateOnly (Boolean)

    \n

    Whether to list immediate child teams or all descendant child teams.

    \n

    The default value is true.

    \n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (TeamOrder)

    \n

    Order for connection.

    \n\n
    \n\n
    \n

    userLogins ([String!])

    \n

    User logins to filter by.

    \n\n
    \n\n
    \n\n\n

    combinedSlug (String!)

    The slug corresponding to the organization and team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String)

    The description of the team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    discussion (TeamDiscussion)

    Find a team discussion by its number.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    number (Int!)

    \n

    The sequence number of the discussion to find.

    \n\n
    \n\n
    \n\n\n

    discussions (TeamDiscussionConnection!)

    A list of team discussions.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    isPinned (Boolean)

    \n

    If provided, filters discussions according to whether or not they are pinned.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (TeamDiscussionOrder)

    \n

    Order for connection.

    \n\n
    \n\n
    \n\n\n

    discussionsResourcePath (URI!)

    The HTTP path for team discussions.

    \n\n\n\n\n\n\n\n\n\n\n\n

    discussionsUrl (URI!)

    The HTTP URL for team discussions.

    \n\n\n\n\n\n\n\n\n\n\n\n

    editTeamResourcePath (URI!)

    The HTTP path for editing this team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    editTeamUrl (URI!)

    The HTTP URL for editing this team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    invitations (OrganizationInvitationConnection)

    A list of pending invitations for users to this team.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    memberStatuses (UserStatusConnection!)

    Get the status messages members of this entity have set that are either public or visible only to the organization.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (UserStatusOrder)

    \n

    Ordering options for user statuses returned from the connection.

    \n\n
    \n\n
    \n\n\n

    members (TeamMemberConnection!)

    A list of users who are members of this team.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    membership (TeamMembershipType)

    \n

    Filter by membership type.

    \n

    The default value is ALL.

    \n
    \n\n
    \n

    orderBy (TeamMemberOrder)

    \n

    Order for the connection.

    \n\n
    \n\n
    \n

    query (String)

    \n

    The search string to look for.

    \n\n
    \n\n
    \n

    role (TeamMemberRole)

    \n

    Filter by team member role.

    \n\n
    \n\n
    \n\n\n

    membersResourcePath (URI!)

    The HTTP path for the team' members.

    \n\n\n\n\n\n\n\n\n\n\n\n

    membersUrl (URI!)

    The HTTP URL for the team' members.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The name of the team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    newTeamResourcePath (URI!)

    The HTTP path creating a new team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    newTeamUrl (URI!)

    The HTTP URL creating a new team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization!)

    The organization that owns this team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    parentTeam (Team)

    The parent team of the team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    privacy (TeamPrivacy!)

    The level of privacy the team has.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositories (TeamRepositoryConnection!)

    A list of repositories this team has access to.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (TeamRepositoryOrder)

    \n

    Order for the connection.

    \n\n
    \n\n
    \n

    query (String)

    \n

    The search string to look for.

    \n\n
    \n\n
    \n\n\n

    repositoriesResourcePath (URI!)

    The HTTP path for this team's repositories.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoriesUrl (URI!)

    The HTTP URL for this team's repositories.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reviewRequestDelegationAlgorithm (TeamReviewAssignmentAlgorithm)

    What algorithm is used for review assignment for this team.

    \n\n\n\n\n
    \n

    Preview notice

    \n

    reviewRequestDelegationAlgorithm is available under the Team review assignments preview. During the preview period, the API may change without notice.

    \n
    \n\n\n\n\n\n\n\n\n

    reviewRequestDelegationEnabled (Boolean!)

    True if review assignment is enabled for this team.

    \n\n\n\n\n
    \n

    Preview notice

    \n

    reviewRequestDelegationEnabled is available under the Team review assignments preview. During the preview period, the API may change without notice.

    \n
    \n\n\n\n\n\n\n\n\n

    reviewRequestDelegationMemberCount (Int)

    How many team members are required for review assignment for this team.

    \n\n\n\n\n
    \n

    Preview notice

    \n

    reviewRequestDelegationMemberCount is available under the Team review assignments preview. During the preview period, the API may change without notice.

    \n
    \n\n\n\n\n\n\n\n\n

    reviewRequestDelegationNotifyTeam (Boolean!)

    When assigning team members via delegation, whether the entire team should be notified as well.

    \n\n\n\n\n
    \n

    Preview notice

    \n

    reviewRequestDelegationNotifyTeam is available under the Team review assignments preview. During the preview period, the API may change without notice.

    \n
    \n\n\n\n\n\n\n\n\n

    slug (String!)

    The slug corresponding to the team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamsResourcePath (URI!)

    The HTTP path for this team's teams.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamsUrl (URI!)

    The HTTP URL for this team's teams.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanAdminister (Boolean!)

    Team is adminable by the viewer.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanSubscribe (Boolean!)

    Check if the viewer is able to change their subscription status for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerSubscription (SubscriptionState)

    Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamAddMemberAuditEntry\n

    \n

    Audit log entry for a team.add_member event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isLdapMapped (Boolean)

    Whether the team was mapped to an LDAP Group.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    team (Team)

    The team associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamName (String)

    The name of the team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamResourcePath (URI)

    The HTTP path for this team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamUrl (URI)

    The HTTP URL for this team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamAddRepositoryAuditEntry\n

    \n

    Audit log entry for a team.add_repository event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isLdapMapped (Boolean)

    Whether the team was mapped to an LDAP Group.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    team (Team)

    The team associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamName (String)

    The name of the team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamResourcePath (URI)

    The HTTP path for this team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamUrl (URI)

    The HTTP URL for this team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamChangeParentTeamAuditEntry\n

    \n

    Audit log entry for a team.change_parent_team event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isLdapMapped (Boolean)

    Whether the team was mapped to an LDAP Group.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    parentTeam (Team)

    The new parent team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    parentTeamName (String)

    The name of the new parent team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    parentTeamNameWas (String)

    The name of the former parent team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    parentTeamResourcePath (URI)

    The HTTP path for the parent team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    parentTeamUrl (URI)

    The HTTP URL for the parent team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    parentTeamWas (Team)

    The former parent team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    parentTeamWasResourcePath (URI)

    The HTTP path for the previous parent team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    parentTeamWasUrl (URI)

    The HTTP URL for the previous parent team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    team (Team)

    The team associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamName (String)

    The name of the team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamResourcePath (URI)

    The HTTP path for this team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamUrl (URI)

    The HTTP URL for this team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamConnection\n

    \n

    The connection type for Team.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([TeamEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Team])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamDiscussion\n

    \n

    A team discussion.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    author (Actor)

    The actor who authored the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    authorAssociation (CommentAuthorAssociation!)

    Author's association with the discussion's team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    body (String!)

    The body as Markdown.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyHTML (HTML!)

    The body rendered to HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyText (String!)

    The body rendered to text.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyVersion (String!)

    Identifies the discussion body hash.

    \n\n\n\n\n\n\n\n\n\n\n\n

    comments (TeamDiscussionCommentConnection!)

    A list of comments on this discussion.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    fromComment (Int)

    \n

    When provided, filters the connection such that results begin with the comment with this number.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (TeamDiscussionCommentOrder)

    \n

    Order for connection.

    \n\n
    \n\n
    \n\n\n

    commentsResourcePath (URI!)

    The HTTP path for discussion comments.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commentsUrl (URI!)

    The HTTP URL for discussion comments.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdViaEmail (Boolean!)

    Check if this comment was created via an email reply.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    editor (Actor)

    The actor who edited the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    includesCreatedEdit (Boolean!)

    Check if this comment was edited and includes an edit with the creation data.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isPinned (Boolean!)

    Whether or not the discussion is pinned.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isPrivate (Boolean!)

    Whether or not the discussion is only visible to team members and org admins.

    \n\n\n\n\n\n\n\n\n\n\n\n

    lastEditedAt (DateTime)

    The moment the editor made the last edit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    number (Int!)

    Identifies the discussion within its team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    publishedAt (DateTime)

    Identifies when the comment was published at.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reactionGroups ([ReactionGroup!])

    A list of reactions grouped by content left on the subject.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reactions (ReactionConnection!)

    A list of Reactions left on the Issue.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    content (ReactionContent)

    \n

    Allows filtering Reactions by emoji.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (ReactionOrder)

    \n

    Allows specifying the order in which reactions are returned.

    \n\n
    \n\n
    \n\n\n

    resourcePath (URI!)

    The HTTP path for this discussion.

    \n\n\n\n\n\n\n\n\n\n\n\n

    team (Team!)

    The team that defines the context of this discussion.

    \n\n\n\n\n\n\n\n\n\n\n\n

    title (String!)

    The title of the discussion.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this discussion.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userContentEdits (UserContentEditConnection)

    A list of edits to this content.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    viewerCanDelete (Boolean!)

    Check if the current viewer can delete this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanPin (Boolean!)

    Whether or not the current viewer can pin this discussion.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanReact (Boolean!)

    Can user react to this subject.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanSubscribe (Boolean!)

    Check if the viewer is able to change their subscription status for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanUpdate (Boolean!)

    Check if the current viewer can update this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

    Reasons why the current viewer can not update this comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerDidAuthor (Boolean!)

    Did the viewer author this comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerSubscription (SubscriptionState)

    Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamDiscussionComment\n

    \n

    A comment on a team discussion.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    author (Actor)

    The actor who authored the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    authorAssociation (CommentAuthorAssociation!)

    Author's association with the comment's team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    body (String!)

    The body as Markdown.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyHTML (HTML!)

    The body rendered to HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyText (String!)

    The body rendered to text.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyVersion (String!)

    The current version of the body content.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdViaEmail (Boolean!)

    Check if this comment was created via an email reply.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    discussion (TeamDiscussion!)

    The discussion this comment is about.

    \n\n\n\n\n\n\n\n\n\n\n\n

    editor (Actor)

    The actor who edited the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    includesCreatedEdit (Boolean!)

    Check if this comment was edited and includes an edit with the creation data.

    \n\n\n\n\n\n\n\n\n\n\n\n

    lastEditedAt (DateTime)

    The moment the editor made the last edit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    number (Int!)

    Identifies the comment number.

    \n\n\n\n\n\n\n\n\n\n\n\n

    publishedAt (DateTime)

    Identifies when the comment was published at.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reactionGroups ([ReactionGroup!])

    A list of reactions grouped by content left on the subject.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reactions (ReactionConnection!)

    A list of Reactions left on the Issue.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    content (ReactionContent)

    \n

    Allows filtering Reactions by emoji.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (ReactionOrder)

    \n

    Allows specifying the order in which reactions are returned.

    \n\n
    \n\n
    \n\n\n

    resourcePath (URI!)

    The HTTP path for this comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userContentEdits (UserContentEditConnection)

    A list of edits to this content.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    viewerCanDelete (Boolean!)

    Check if the current viewer can delete this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanReact (Boolean!)

    Can user react to this subject.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanUpdate (Boolean!)

    Check if the current viewer can update this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

    Reasons why the current viewer can not update this comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerDidAuthor (Boolean!)

    Did the viewer author this comment.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamDiscussionCommentConnection\n

    \n

    The connection type for TeamDiscussionComment.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([TeamDiscussionCommentEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([TeamDiscussionComment])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamDiscussionCommentEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (TeamDiscussionComment)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamDiscussionConnection\n

    \n

    The connection type for TeamDiscussion.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([TeamDiscussionEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([TeamDiscussion])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamDiscussionEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (TeamDiscussion)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (Team)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamMemberConnection\n

    \n

    The connection type for User.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([TeamMemberEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([User])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamMemberEdge\n

    \n

    Represents a user who is a member of a team.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    memberAccessResourcePath (URI!)

    The HTTP path to the organization's member access page.

    \n\n\n\n\n\n\n\n\n\n\n\n

    memberAccessUrl (URI!)

    The HTTP URL to the organization's member access page.

    \n\n\n\n\n\n\n\n\n\n\n\n

    role (TeamMemberRole!)

    The role the member has on the team.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamRemoveMemberAuditEntry\n

    \n

    Audit log entry for a team.remove_member event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isLdapMapped (Boolean)

    Whether the team was mapped to an LDAP Group.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    team (Team)

    The team associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamName (String)

    The name of the team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamResourcePath (URI)

    The HTTP path for this team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamUrl (URI)

    The HTTP URL for this team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamRemoveRepositoryAuditEntry\n

    \n

    Audit log entry for a team.remove_repository event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isLdapMapped (Boolean)

    Whether the team was mapped to an LDAP Group.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    team (Team)

    The team associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamName (String)

    The name of the team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamResourcePath (URI)

    The HTTP path for this team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamUrl (URI)

    The HTTP URL for this team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamRepositoryConnection\n

    \n

    The connection type for Repository.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([TeamRepositoryEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Repository])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamRepositoryEdge\n

    \n

    Represents a team repository.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    permission (RepositoryPermission!)

    The permission level the team has on the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TextMatch\n

    \n

    A text match within a search result.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    fragment (String!)

    The specific text fragment within the property matched on.

    \n\n\n\n\n\n\n\n\n\n\n\n

    highlights ([TextMatchHighlight!]!)

    Highlights within the matched fragment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    property (String!)

    The property matched on.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TextMatchHighlight\n

    \n

    Represents a single highlight in a search result match.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    beginIndice (Int!)

    The indice in the fragment where the matched text begins.

    \n\n\n\n\n\n\n\n\n\n\n\n

    endIndice (Int!)

    The indice in the fragment where the matched text ends.

    \n\n\n\n\n\n\n\n\n\n\n\n

    text (String!)

    The text matched.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Topic\n

    \n

    A topic aggregates entities that are related to a subject.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    name (String!)

    The topic's name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    relatedTopics ([Topic!]!)

    A list of related topics, including aliases of this topic, sorted with the most relevant\nfirst. Returns up to 10 Topics.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    first (Int)

    \n

    How many topics to return.

    \n

    The default value is 3.

    \n
    \n\n
    \n\n\n

    stargazerCount (Int!)

    Returns a count of how many stargazers there are on this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    stargazers (StargazerConnection!)

    A list of users who have starred this starrable.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (StarOrder)

    \n

    Order for connection.

    \n\n
    \n\n
    \n\n\n

    viewerHasStarred (Boolean!)

    Returns a boolean indicating whether the viewing user has starred this starrable.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TransferredEvent\n

    \n

    Represents atransferredevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    fromRepository (Repository)

    The repository this came from.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issue (Issue!)

    Identifies the issue associated with the event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Tree\n

    \n

    Represents a Git tree.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    abbreviatedOid (String!)

    An abbreviated version of the Git object ID.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commitResourcePath (URI!)

    The HTTP path for this Git object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commitUrl (URI!)

    The HTTP URL for this Git object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    entries ([TreeEntry!])

    A list of tree entries.

    \n\n\n\n\n\n\n\n\n\n\n\n

    oid (GitObjectID!)

    The Git object ID.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository!)

    The Repository the Git object belongs to.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TreeEntry\n

    \n

    Represents a Git tree entry.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    extension (String)

    The extension of the file.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isGenerated (Boolean!)

    Whether or not this tree entry is generated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    mode (Int!)

    Entry file mode.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    Entry file name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    object (GitObject)

    Entry file object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    oid (GitObjectID!)

    Entry file Git object ID.

    \n\n\n\n\n\n\n\n\n\n\n\n

    path (String)

    The full path of the file.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository!)

    The Repository the tree entry belongs to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    submodule (Submodule)

    If the TreeEntry is for a directory occupied by a submodule project, this returns the corresponding submodule.

    \n\n\n\n\n\n\n\n\n\n\n\n

    type (String!)

    Entry file type.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n UnassignedEvent\n

    \n

    Represents anunassignedevent on any assignable object.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    assignable (Assignable!)

    Identifies the assignable associated with the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    assignee (Assignee)

    Identifies the user or mannequin that was unassigned.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    Identifies the subject (user) who was unassigned.

    \n\n\n\n\n\n\n
    \n

    Deprecation notice

    \n

    user is deprecated.

    Assignees can now be mannequins. Use the assignee field instead. Removal on 2020-01-01 UTC.

    \n
    \n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n UnknownSignature\n

    \n

    Represents an unknown signature on a Commit or Tag.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    email (String!)

    Email used to sign this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isValid (Boolean!)

    True if the signature is valid and verified by GitHub.

    \n\n\n\n\n\n\n\n\n\n\n\n

    payload (String!)

    Payload for GPG signing object. Raw ODB object without the signature header.

    \n\n\n\n\n\n\n\n\n\n\n\n

    signature (String!)

    ASCII-armored signature header from object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    signer (User)

    GitHub user corresponding to the email signing this commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    state (GitSignatureState!)

    The state of this signature. VALID if signature is valid and verified by\nGitHub, otherwise represents reason why signature is considered invalid.

    \n\n\n\n\n\n\n\n\n\n\n\n

    wasSignedByGitHub (Boolean!)

    True if the signature was made with GitHub's signing key.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n UnlabeledEvent\n

    \n

    Represents anunlabeledevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    label (Label!)

    Identifies the label associated with theunlabeledevent.

    \n\n\n\n\n\n\n\n\n\n\n\n

    labelable (Labelable!)

    Identifies the Labelable associated with the event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n UnlockedEvent\n

    \n

    Represents anunlockedevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    lockable (Lockable!)

    Object that was unlocked.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n UnmarkedAsDuplicateEvent\n

    \n

    Represents anunmarked_as_duplicateevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    canonical (IssueOrPullRequest)

    The authoritative issue or pull request which has been duplicated by another.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    duplicate (IssueOrPullRequest)

    The issue or pull request which has been marked as a duplicate of another.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isCrossRepository (Boolean!)

    Canonical and duplicate belong to different repositories.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n UnpinnedEvent\n

    \n

    Represents anunpinnedevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issue (Issue!)

    Identifies the issue associated with the event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n UnsubscribedEvent\n

    \n

    Represents anunsubscribedevent on a given Subscribable.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    subscribable (Subscribable!)

    Object referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n User\n

    \n

    A user is an individual's account on GitHub that owns repositories and can make new content.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    anyPinnableItems (Boolean!)

    Determine if this repository owner has any items that can be pinned to their profile.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    type (PinnableItemType)

    \n

    Filter to only a particular kind of pinnable item.

    \n\n
    \n\n
    \n\n\n

    avatarUrl (URI!)

    A URL pointing to the user's public avatar.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    size (Int)

    \n

    The size of the resulting square image.

    \n\n
    \n\n
    \n\n\n

    bio (String)

    The user's public profile bio.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bioHTML (HTML!)

    The user's public profile bio as HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commitComments (CommitCommentConnection!)

    A list of commit comments made by this user.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    company (String)

    The user's public profile company.

    \n\n\n\n\n\n\n\n\n\n\n\n

    companyHTML (HTML!)

    The user's public profile company as HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    contributionsCollection (ContributionsCollection!)

    The collection of contributions this user has made to different repositories.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    from (DateTime)

    \n

    Only contributions made at this time or later will be counted. If omitted, defaults to a year ago.

    \n\n
    \n\n
    \n

    organizationID (ID)

    \n

    The ID of the organization used to filter contributions.

    \n\n
    \n\n
    \n

    to (DateTime)

    \n

    Only contributions made before and up to and including this time will be\ncounted. If omitted, defaults to the current time.

    \n\n
    \n\n
    \n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    email (String!)

    The user's publicly visible profile email.

    \n\n\n\n\n\n\n\n\n\n\n\n

    followers (FollowerConnection!)

    A list of users the given user is followed by.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    following (FollowingConnection!)

    A list of users the given user is following.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    gist (Gist)

    Find gist by repo name.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    name (String!)

    \n

    The gist name to find.

    \n\n
    \n\n
    \n\n\n

    gistComments (GistCommentConnection!)

    A list of gist comments made by this user.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    gists (GistConnection!)

    A list of the Gists the user has created.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (GistOrder)

    \n

    Ordering options for gists returned from the connection.

    \n\n
    \n\n
    \n

    privacy (GistPrivacy)

    \n

    Filters Gists according to privacy.

    \n\n
    \n\n
    \n\n\n

    hovercard (Hovercard!)

    The hovercard information for this user in a given context.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    primarySubjectId (ID)

    \n

    The ID of the subject to get the hovercard in the context of.

    \n\n
    \n\n
    \n\n\n

    isBountyHunter (Boolean!)

    Whether or not this user is a participant in the GitHub Security Bug Bounty.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isCampusExpert (Boolean!)

    Whether or not this user is a participant in the GitHub Campus Experts Program.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isDeveloperProgramMember (Boolean!)

    Whether or not this user is a GitHub Developer Program member.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isEmployee (Boolean!)

    Whether or not this user is a GitHub employee.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isHireable (Boolean!)

    Whether or not the user has marked themselves as for hire.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isSiteAdmin (Boolean!)

    Whether or not this user is a site administrator.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isViewer (Boolean!)

    Whether or not this user is the viewing user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issueComments (IssueCommentConnection!)

    A list of issue comments made by this user.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (IssueCommentOrder)

    \n

    Ordering options for issue comments returned from the connection.

    \n\n
    \n\n
    \n\n\n

    issues (IssueConnection!)

    A list of issues associated with this user.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    filterBy (IssueFilters)

    \n

    Filtering options for issues returned from the connection.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    labels ([String!])

    \n

    A list of label names to filter the pull requests by.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (IssueOrder)

    \n

    Ordering options for issues returned from the connection.

    \n\n
    \n\n
    \n

    states ([IssueState!])

    \n

    A list of states to filter the issues by.

    \n\n
    \n\n
    \n\n\n

    itemShowcase (ProfileItemShowcase!)

    Showcases a selection of repositories and gists that the profile owner has\neither curated or that have been selected automatically based on popularity.

    \n\n\n\n\n\n\n\n\n\n\n\n

    location (String)

    The user's public profile location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    login (String!)

    The username used to login.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String)

    The user's public profile name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    Find an organization by its login that the user belongs to.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    login (String!)

    \n

    The login of the organization to find.

    \n\n
    \n\n
    \n\n\n

    organizationVerifiedDomainEmails ([String!]!)

    Verified email addresses that match verified domains for a specified organization the user is a member of.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    login (String!)

    \n

    The login of the organization to match verified domains from.

    \n\n
    \n\n
    \n\n\n

    organizations (OrganizationConnection!)

    A list of organizations the user belongs to.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    pinnableItems (PinnableItemConnection!)

    A list of repositories and gists this profile owner can pin to their profile.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    types ([PinnableItemType!])

    \n

    Filter the types of pinnable items that are returned.

    \n\n
    \n\n
    \n\n\n

    pinnedItems (PinnableItemConnection!)

    A list of repositories and gists this profile owner has pinned to their profile.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    types ([PinnableItemType!])

    \n

    Filter the types of pinned items that are returned.

    \n\n
    \n\n
    \n\n\n

    pinnedItemsRemaining (Int!)

    Returns how many more items this profile owner can pin to their profile.

    \n\n\n\n\n\n\n\n\n\n\n\n

    project (Project)

    Find project by number.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    number (Int!)

    \n

    The project number to find.

    \n\n
    \n\n
    \n\n\n

    projects (ProjectConnection!)

    A list of projects under the owner.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (ProjectOrder)

    \n

    Ordering options for projects returned from the connection.

    \n\n
    \n\n
    \n

    search (String)

    \n

    Query to search projects by, currently only searching by name.

    \n\n
    \n\n
    \n

    states ([ProjectState!])

    \n

    A list of states to filter the projects by.

    \n\n
    \n\n
    \n\n\n

    projectsResourcePath (URI!)

    The HTTP path listing user's projects.

    \n\n\n\n\n\n\n\n\n\n\n\n

    projectsUrl (URI!)

    The HTTP URL listing user's projects.

    \n\n\n\n\n\n\n\n\n\n\n\n

    publicKeys (PublicKeyConnection!)

    A list of public keys associated with this user.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    pullRequests (PullRequestConnection!)

    A list of pull requests associated with this user.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    baseRefName (String)

    \n

    The base ref name to filter the pull requests by.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    headRefName (String)

    \n

    The head ref name to filter the pull requests by.

    \n\n
    \n\n
    \n

    labels ([String!])

    \n

    A list of label names to filter the pull requests by.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (IssueOrder)

    \n

    Ordering options for pull requests returned from the connection.

    \n\n
    \n\n
    \n

    states ([PullRequestState!])

    \n

    A list of states to filter the pull requests by.

    \n\n
    \n\n
    \n\n\n

    repositories (RepositoryConnection!)

    A list of repositories that the user owns.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    affiliations ([RepositoryAffiliation])

    \n

    Array of viewer's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\ncurrent viewer owns.

    \n\n
    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    isFork (Boolean)

    \n

    If non-null, filters repositories according to whether they are forks of another repository.

    \n\n
    \n\n
    \n

    isLocked (Boolean)

    \n

    If non-null, filters repositories according to whether they have been locked.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (RepositoryOrder)

    \n

    Ordering options for repositories returned from the connection.

    \n\n
    \n\n
    \n

    ownerAffiliations ([RepositoryAffiliation])

    \n

    Array of owner's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\norganization or user being viewed owns.

    \n\n
    \n\n
    \n

    privacy (RepositoryPrivacy)

    \n

    If non-null, filters repositories according to privacy.

    \n\n
    \n\n
    \n\n\n

    repositoriesContributedTo (RepositoryConnection!)

    A list of repositories that the user recently contributed to.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    contributionTypes ([RepositoryContributionType])

    \n

    If non-null, include only the specified types of contributions. The\nGitHub.com UI uses [COMMIT, ISSUE, PULL_REQUEST, REPOSITORY].

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    includeUserRepositories (Boolean)

    \n

    If true, include user repositories.

    \n\n
    \n\n
    \n

    isLocked (Boolean)

    \n

    If non-null, filters repositories according to whether they have been locked.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (RepositoryOrder)

    \n

    Ordering options for repositories returned from the connection.

    \n\n
    \n\n
    \n

    privacy (RepositoryPrivacy)

    \n

    If non-null, filters repositories according to privacy.

    \n\n
    \n\n
    \n\n\n

    repository (Repository)

    Find Repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    name (String!)

    \n

    Name of Repository to find.

    \n\n
    \n\n
    \n\n\n

    resourcePath (URI!)

    The HTTP path for this user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    savedReplies (SavedReplyConnection)

    Replies this user has saved.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (SavedReplyOrder)

    \n

    The field to order saved replies by.

    \n\n
    \n\n
    \n\n\n

    sponsorshipsAsMaintainer (SponsorshipConnection!)

    This object's sponsorships as the maintainer.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    includePrivate (Boolean)

    \n

    Whether or not to include private sponsorships in the result set.

    \n

    The default value is false.

    \n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (SponsorshipOrder)

    \n

    Ordering options for sponsorships returned from this connection. If left\nblank, the sponsorships will be ordered based on relevancy to the viewer.

    \n\n
    \n\n
    \n\n\n

    sponsorshipsAsSponsor (SponsorshipConnection!)

    This object's sponsorships as the sponsor.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (SponsorshipOrder)

    \n

    Ordering options for sponsorships returned from this connection. If left\nblank, the sponsorships will be ordered based on relevancy to the viewer.

    \n\n
    \n\n
    \n\n\n

    starredRepositories (StarredRepositoryConnection!)

    Repositories the user has starred.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (StarOrder)

    \n

    Order for connection.

    \n\n
    \n\n
    \n

    ownedByViewer (Boolean)

    \n

    Filters starred repositories to only return repositories owned by the viewer.

    \n\n
    \n\n
    \n\n\n

    status (UserStatus)

    The user's description of what they're currently doing.

    \n\n\n\n\n\n\n\n\n\n\n\n

    suspendedAt (DateTime)

    Identifies the date and time when the user was suspended.

    \n\n\n\n\n\n\n\n\n\n\n\n

    topRepositories (RepositoryConnection!)

    Repositories the user has contributed to, ordered by contribution rank, plus repositories the user has created.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (RepositoryOrder!)

    \n

    Ordering options for repositories returned from the connection.

    \n\n
    \n\n
    \n

    since (DateTime)

    \n

    How far back in time to fetch contributed repositories.

    \n\n
    \n\n
    \n\n\n

    twitterUsername (String)

    The user's Twitter username.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanChangePinnedItems (Boolean!)

    Can the viewer pin repositories and gists to the profile?.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanCreateProjects (Boolean!)

    Can the current viewer create new projects on this owner.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanFollow (Boolean!)

    Whether or not the viewer is able to follow the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerIsFollowing (Boolean!)

    Whether or not this user is followed by the viewer.

    \n\n\n\n\n\n\n\n\n\n\n\n

    watching (RepositoryConnection!)

    A list of repositories the given user is watching.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    affiliations ([RepositoryAffiliation])

    \n

    Affiliation options for repositories returned from the connection. If none\nspecified, the results will include repositories for which the current\nviewer is an owner or collaborator, or member.

    \n\n
    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    isLocked (Boolean)

    \n

    If non-null, filters repositories according to whether they have been locked.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (RepositoryOrder)

    \n

    Ordering options for repositories returned from the connection.

    \n\n
    \n\n
    \n

    ownerAffiliations ([RepositoryAffiliation])

    \n

    Array of owner's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\norganization or user being viewed owns.

    \n\n
    \n\n
    \n

    privacy (RepositoryPrivacy)

    \n

    If non-null, filters repositories according to privacy.

    \n\n
    \n\n
    \n\n\n

    websiteUrl (URI)

    A URL pointing to the user's public website/blog.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n UserBlockedEvent\n

    \n

    Represents auser_blockedevent on a given user.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    blockDuration (UserBlockDuration!)

    Number of days that the user was blocked for.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    subject (User)

    The user who was blocked.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n UserConnection\n

    \n

    The connection type for User.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([UserEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([User])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n UserContentEdit\n

    \n

    An edit on user content.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    deletedAt (DateTime)

    Identifies the date and time when the object was deleted.

    \n\n\n\n\n\n\n\n\n\n\n\n

    deletedBy (Actor)

    The actor who deleted this content.

    \n\n\n\n\n\n\n\n\n\n\n\n

    diff (String)

    A summary of the changes for this edit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    editedAt (DateTime!)

    When this content was edited.

    \n\n\n\n\n\n\n\n\n\n\n\n

    editor (Actor)

    The actor who edited this content.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n UserContentEditConnection\n

    \n

    A list of edits to content.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([UserContentEditEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([UserContentEdit])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n UserContentEditEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (UserContentEdit)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n UserEdge\n

    \n

    Represents a user.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (User)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n UserEmailMetadata\n

    \n

    Email attributes from External Identity.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    primary (Boolean)

    Boolean to identify primary emails.

    \n\n\n\n\n\n\n\n\n\n\n\n

    type (String)

    Type of email.

    \n\n\n\n\n\n\n\n\n\n\n\n

    value (String!)

    Email id.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n UserStatus\n

    \n

    The user's description of what they're currently doing.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    emoji (String)

    An emoji summarizing the user's status.

    \n\n\n\n\n\n\n\n\n\n\n\n

    emojiHTML (HTML)

    The status emoji as HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    expiresAt (DateTime)

    If set, the status will not be shown after this date.

    \n\n\n\n\n\n\n\n\n\n\n\n

    id (ID!)

    ID of the object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    indicatesLimitedAvailability (Boolean!)

    Whether this status indicates the user is not fully available on GitHub.

    \n\n\n\n\n\n\n\n\n\n\n\n

    message (String)

    A brief message describing what the user is doing.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The organization whose members can see this status. If null, this status is publicly visible.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User!)

    The user who has this status.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n UserStatusConnection\n

    \n

    The connection type for UserStatus.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([UserStatusEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([UserStatus])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n UserStatusEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (UserStatus)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n VerifiableDomain\n

    \n

    A domain that can be verified for an organization or an enterprise.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    dnsHostName (URI)

    The DNS host name that should be used for verification.

    \n\n\n\n\n\n\n\n\n\n\n\n

    domain (URI!)

    The unicode encoded domain.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hasFoundHostName (Boolean!)

    Whether a TXT record for verification with the expected host name was found.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hasFoundVerificationToken (Boolean!)

    Whether a TXT record for verification with the expected verification token was found.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isRequiredForPolicyEnforcement (Boolean!)

    Whether this domain is required to exist for an organization or enterprise policy to be enforced.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isVerified (Boolean!)

    Whether or not the domain is verified.

    \n\n\n\n\n\n\n\n\n\n\n\n

    owner (VerifiableDomainOwner!)

    The owner of the domain.

    \n\n\n\n\n\n\n\n\n\n\n\n

    punycodeEncodedDomain (URI!)

    The punycode encoded domain.

    \n\n\n\n\n\n\n\n\n\n\n\n

    tokenExpirationTime (DateTime)

    The time that the current verification token will expire.

    \n\n\n\n\n\n\n\n\n\n\n\n

    verificationToken (String)

    The current verification token for the domain.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ViewerHovercardContext\n

    \n

    A hovercard context with a message describing how the viewer is related.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    message (String!)

    A string describing this context.

    \n\n\n\n\n\n\n\n\n\n\n\n

    octicon (String!)

    An octicon to accompany this context.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewer (User!)

    Identifies the user who is related to this context.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n", + "html": "
    \n
    \n

    \n ActorLocation\n

    \n

    Location information for an actor.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    city (String)

    City.

    \n\n\n\n\n\n\n\n\n\n\n\n

    country (String)

    Country name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    countryCode (String)

    Country code.

    \n\n\n\n\n\n\n\n\n\n\n\n

    region (String)

    Region name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    regionCode (String)

    Region or state code.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n AddedToProjectEvent\n

    \n

    Represents aadded_to_projectevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    project (Project)

    Project referenced by event.

    \n\n\n\n\n
    \n

    Preview notice

    \n

    project is available under the Project event details preview. During the preview period, the API may change without notice.

    \n
    \n\n\n\n\n\n\n\n\n

    projectCard (ProjectCard)

    Project card referenced by this project event.

    \n\n\n\n\n
    \n

    Preview notice

    \n

    projectCard is available under the Project event details preview. During the preview period, the API may change without notice.

    \n
    \n\n\n\n\n\n\n\n\n

    projectColumnName (String!)

    Column name referenced by this project event.

    \n\n\n\n\n
    \n

    Preview notice

    \n

    projectColumnName is available under the Project event details preview. During the preview period, the API may change without notice.

    \n
    \n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n App\n

    \n

    A GitHub App.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String)

    The description of the app.

    \n\n\n\n\n\n\n\n\n\n\n\n

    logoBackgroundColor (String!)

    The hex color code, without the leading '#', for the logo background.

    \n\n\n\n\n\n\n\n\n\n\n\n

    logoUrl (URI!)

    A URL pointing to the app's logo.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    size (Int)

    \n

    The size of the resulting image.

    \n\n
    \n\n
    \n\n\n

    name (String!)

    The name of the app.

    \n\n\n\n\n\n\n\n\n\n\n\n

    slug (String!)

    A slug based on the name of the app for use in URLs.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The URL to the app's homepage.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n AssignedEvent\n

    \n

    Represents anassignedevent on any assignable object.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    assignable (Assignable!)

    Identifies the assignable associated with the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    assignee (Assignee)

    Identifies the user or mannequin that was assigned.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    Identifies the user who was assigned.

    \n\n\n\n\n\n\n
    \n

    Deprecation notice

    \n

    user is deprecated.

    Assignees can now be mannequins. Use the assignee field instead. Removal on 2020-01-01 UTC.

    \n
    \n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n AutoMergeDisabledEvent\n

    \n

    Represents aauto_merge_disabledevent on a given pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    disabler (User)

    The user who disabled auto-merge for this Pull Request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest)

    PullRequest referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reason (String)

    The reason auto-merge was disabled.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reasonCode (String)

    The reason_code relating to why auto-merge was disabled.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n AutoMergeEnabledEvent\n

    \n

    Represents aauto_merge_enabledevent on a given pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enabler (User)

    The user who enabled auto-merge for this Pull Request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest)

    PullRequest referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n AutoMergeRequest\n

    \n

    Represents an auto-merge request for a pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    authorEmail (String)

    The email address of the author of this auto-merge request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commitBody (String)

    The commit message of the auto-merge request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commitHeadline (String)

    The commit title of the auto-merge request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enabledAt (DateTime)

    When was this auto-merge request was enabled.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enabledBy (Actor)

    The actor who created the auto-merge request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    mergeMethod (PullRequestMergeMethod!)

    The merge method of the auto-merge request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    The pull request that this auto-merge request is set against.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n AutoRebaseEnabledEvent\n

    \n

    Represents aauto_rebase_enabledevent on a given pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enabler (User)

    The user who enabled auto-merge (rebase) for this Pull Request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest)

    PullRequest referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n AutoSquashEnabledEvent\n

    \n

    Represents aauto_squash_enabledevent on a given pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enabler (User)

    The user who enabled auto-merge (squash) for this Pull Request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest)

    PullRequest referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n AutomaticBaseChangeFailedEvent\n

    \n

    Represents aautomatic_base_change_failedevent on a given pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    newBase (String!)

    The new base for this PR.

    \n\n\n\n\n\n\n\n\n\n\n\n

    oldBase (String!)

    The old base for this PR.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    PullRequest referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n AutomaticBaseChangeSucceededEvent\n

    \n

    Represents aautomatic_base_change_succeededevent on a given pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    newBase (String!)

    The new base for this PR.

    \n\n\n\n\n\n\n\n\n\n\n\n

    oldBase (String!)

    The old base for this PR.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    PullRequest referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n BaseRefChangedEvent\n

    \n

    Represents abase_ref_changedevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    currentRefName (String!)

    Identifies the name of the base ref for the pull request after it was changed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    previousRefName (String!)

    Identifies the name of the base ref for the pull request before it was changed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    PullRequest referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n BaseRefDeletedEvent\n

    \n

    Represents abase_ref_deletedevent on a given pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    baseRefName (String)

    Identifies the name of the Ref associated with the base_ref_deleted event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest)

    PullRequest referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n BaseRefForcePushedEvent\n

    \n

    Represents abase_ref_force_pushedevent on a given pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    afterCommit (Commit)

    Identifies the after commit SHA for thebase_ref_force_pushedevent.

    \n\n\n\n\n\n\n\n\n\n\n\n

    beforeCommit (Commit)

    Identifies the before commit SHA for thebase_ref_force_pushedevent.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    PullRequest referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ref (Ref)

    Identifies the fully qualified ref name for thebase_ref_force_pushedevent.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Blame\n

    \n

    Represents a Git blame.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    ranges ([BlameRange!]!)

    The list of ranges from a Git blame.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n BlameRange\n

    \n

    Represents a range of information from a Git blame.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    age (Int!)

    Identifies the recency of the change, from 1 (new) to 10 (old). This is\ncalculated as a 2-quantile and determines the length of distance between the\nmedian age of all the changes in the file and the recency of the current\nrange's change.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commit (Commit!)

    Identifies the line author.

    \n\n\n\n\n\n\n\n\n\n\n\n

    endingLine (Int!)

    The ending line for the range.

    \n\n\n\n\n\n\n\n\n\n\n\n

    startingLine (Int!)

    The starting line for the range.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Blob\n

    \n

    Represents a Git blob.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    abbreviatedOid (String!)

    An abbreviated version of the Git object ID.

    \n\n\n\n\n\n\n\n\n\n\n\n

    byteSize (Int!)

    Byte size of Blob object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commitResourcePath (URI!)

    The HTTP path for this Git object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commitUrl (URI!)

    The HTTP URL for this Git object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isBinary (Boolean)

    Indicates whether the Blob is binary or text. Returns null if unable to determine the encoding.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isTruncated (Boolean!)

    Indicates whether the contents is truncated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    oid (GitObjectID!)

    The Git object ID.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository!)

    The Repository the Git object belongs to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    text (String)

    UTF8 text data or null if the Blob is binary.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Bot\n

    \n

    A special type of user which takes actions on behalf of GitHub Apps.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    avatarUrl (URI!)

    A URL pointing to the GitHub App's public avatar.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    size (Int)

    \n

    The size of the resulting square image.

    \n\n
    \n\n
    \n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    login (String!)

    The username of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this bot.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this bot.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n BranchProtectionRule\n

    \n

    A branch protection rule.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    allowsDeletions (Boolean!)

    Can this branch be deleted.

    \n\n\n\n\n\n\n\n\n\n\n\n

    allowsForcePushes (Boolean!)

    Are force pushes allowed on this branch.

    \n\n\n\n\n\n\n\n\n\n\n\n

    branchProtectionRuleConflicts (BranchProtectionRuleConflictConnection!)

    A list of conflicts matching branches protection rule and other branch protection rules.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    creator (Actor)

    The actor who created this branch protection rule.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    dismissesStaleReviews (Boolean!)

    Will new commits pushed to matching branches dismiss pull request review approvals.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isAdminEnforced (Boolean!)

    Can admins overwrite branch protection.

    \n\n\n\n\n\n\n\n\n\n\n\n

    matchingRefs (RefConnection!)

    Repository refs that are protected by this rule.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    query (String)

    \n

    Filters refs with query on name.

    \n\n
    \n\n
    \n\n\n

    pattern (String!)

    Identifies the protection rule pattern.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pushAllowances (PushAllowanceConnection!)

    A list push allowances for this branch protection rule.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    repository (Repository)

    The repository associated with this branch protection rule.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiredApprovingReviewCount (Int)

    Number of approving reviews required to update matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiredStatusCheckContexts ([String])

    List of required status check contexts that must pass for commits to be accepted to matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiresApprovingReviews (Boolean!)

    Are approving reviews required to update matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiresCodeOwnerReviews (Boolean!)

    Are reviews from code owners required to update matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiresCommitSignatures (Boolean!)

    Are commits required to be signed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiresLinearHistory (Boolean!)

    Are merge commits prohibited from being pushed to this branch.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiresStatusChecks (Boolean!)

    Are status checks required to update matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiresStrictStatusChecks (Boolean!)

    Are branches required to be up to date before merging.

    \n\n\n\n\n\n\n\n\n\n\n\n

    restrictsPushes (Boolean!)

    Is pushing to matching branches restricted.

    \n\n\n\n\n\n\n\n\n\n\n\n

    restrictsReviewDismissals (Boolean!)

    Is dismissal of pull request reviews restricted.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reviewDismissalAllowances (ReviewDismissalAllowanceConnection!)

    A list review dismissal allowances for this branch protection rule.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n BranchProtectionRuleConflict\n

    \n

    A conflict between two branch protection rules.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    branchProtectionRule (BranchProtectionRule)

    Identifies the branch protection rule.

    \n\n\n\n\n\n\n\n\n\n\n\n

    conflictingBranchProtectionRule (BranchProtectionRule)

    Identifies the conflicting branch protection rule.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ref (Ref)

    Identifies the branch ref that has conflicting rules.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n BranchProtectionRuleConflictConnection\n

    \n

    The connection type for BranchProtectionRuleConflict.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([BranchProtectionRuleConflictEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([BranchProtectionRuleConflict])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n BranchProtectionRuleConflictEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (BranchProtectionRuleConflict)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n BranchProtectionRuleConnection\n

    \n

    The connection type for BranchProtectionRule.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([BranchProtectionRuleEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([BranchProtectionRule])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n BranchProtectionRuleEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (BranchProtectionRule)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CVSS\n

    \n

    The Common Vulnerability Scoring System.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    score (Float!)

    The CVSS score associated with this advisory.

    \n\n\n\n\n\n\n\n\n\n\n\n

    vectorString (String)

    The CVSS vector string associated with this advisory.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CWE\n

    \n

    A common weakness enumeration.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cweId (String!)

    The id of the CWE.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String!)

    A detailed description of this CWE.

    \n\n\n\n\n\n\n\n\n\n\n\n

    id (ID!)

    ID of the object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The name of this CWE.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CWEConnection\n

    \n

    The connection type for CWE.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([CWEEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([CWE])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CWEEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (CWE)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CheckAnnotation\n

    \n

    A single check annotation.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    annotationLevel (CheckAnnotationLevel)

    The annotation's severity level.

    \n\n\n\n\n\n\n\n\n\n\n\n

    blobUrl (URI!)

    The path to the file that this annotation was made on.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    location (CheckAnnotationSpan!)

    The position of this annotation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    message (String!)

    The annotation's message.

    \n\n\n\n\n\n\n\n\n\n\n\n

    path (String!)

    The path that this annotation was made on.

    \n\n\n\n\n\n\n\n\n\n\n\n

    rawDetails (String)

    Additional information about the annotation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    title (String)

    The annotation's title.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CheckAnnotationConnection\n

    \n

    The connection type for CheckAnnotation.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([CheckAnnotationEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([CheckAnnotation])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CheckAnnotationEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (CheckAnnotation)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CheckAnnotationPosition\n

    \n

    A character position in a check annotation.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    column (Int)

    Column number (1 indexed).

    \n\n\n\n\n\n\n\n\n\n\n\n

    line (Int!)

    Line number (1 indexed).

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CheckAnnotationSpan\n

    \n

    An inclusive pair of positions for a check annotation.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    end (CheckAnnotationPosition!)

    End position (inclusive).

    \n\n\n\n\n\n\n\n\n\n\n\n

    start (CheckAnnotationPosition!)

    Start position (inclusive).

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CheckRun\n

    \n

    A check run.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    annotations (CheckAnnotationConnection)

    The check run's annotations.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    checkSuite (CheckSuite!)

    The check suite that this run is a part of.

    \n\n\n\n\n\n\n\n\n\n\n\n

    completedAt (DateTime)

    Identifies the date and time when the check run was completed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    conclusion (CheckConclusionState)

    The conclusion of the check run.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    detailsUrl (URI)

    The URL from which to find full details of the check run on the integrator's site.

    \n\n\n\n\n\n\n\n\n\n\n\n

    externalId (String)

    A reference for the check run on the integrator's system.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isRequired (Boolean!)

    Whether this check run is required to pass before merging.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    pullRequestId (ID!)

    \n

    The pull request this check is required for.

    \n\n
    \n\n
    \n\n\n

    name (String!)

    The name of the check for this check run.

    \n\n\n\n\n\n\n\n\n\n\n\n

    permalink (URI!)

    The permalink to the check run summary.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository!)

    The repository associated with this check run.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this check run.

    \n\n\n\n\n\n\n\n\n\n\n\n

    startedAt (DateTime)

    Identifies the date and time when the check run was started.

    \n\n\n\n\n\n\n\n\n\n\n\n

    status (CheckStatusState!)

    The current status of the check run.

    \n\n\n\n\n\n\n\n\n\n\n\n

    summary (String)

    A string representing the check run's summary.

    \n\n\n\n\n\n\n\n\n\n\n\n

    text (String)

    A string representing the check run's text.

    \n\n\n\n\n\n\n\n\n\n\n\n

    title (String)

    A string representing the check run.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this check run.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CheckRunConnection\n

    \n

    The connection type for CheckRun.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([CheckRunEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([CheckRun])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CheckRunEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (CheckRun)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CheckSuite\n

    \n

    A check suite.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    app (App)

    The GitHub App which created this check suite.

    \n\n\n\n\n\n\n\n\n\n\n\n

    branch (Ref)

    The name of the branch for this check suite.

    \n\n\n\n\n\n\n\n\n\n\n\n

    checkRuns (CheckRunConnection)

    The check runs associated with a check suite.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    filterBy (CheckRunFilter)

    \n

    Filters the check runs by this type.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    commit (Commit!)

    The commit for this check suite.

    \n\n\n\n\n\n\n\n\n\n\n\n

    conclusion (CheckConclusionState)

    The conclusion of this check suite.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    matchingPullRequests (PullRequestConnection)

    A list of open pull requests matching the check suite.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    baseRefName (String)

    \n

    The base ref name to filter the pull requests by.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    headRefName (String)

    \n

    The head ref name to filter the pull requests by.

    \n\n
    \n\n
    \n

    labels ([String!])

    \n

    A list of label names to filter the pull requests by.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (IssueOrder)

    \n

    Ordering options for pull requests returned from the connection.

    \n\n
    \n\n
    \n

    states ([PullRequestState!])

    \n

    A list of states to filter the pull requests by.

    \n\n
    \n\n
    \n\n\n

    push (Push)

    The push that triggered this check suite.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository!)

    The repository associated with this check suite.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this check suite.

    \n\n\n\n\n\n\n\n\n\n\n\n

    status (CheckStatusState!)

    The status of this check suite.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this check suite.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CheckSuiteConnection\n

    \n

    The connection type for CheckSuite.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([CheckSuiteEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([CheckSuite])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CheckSuiteEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (CheckSuite)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ClosedEvent\n

    \n

    Represents aclosedevent on any Closable.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    closable (Closable!)

    Object that was closed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    closer (Closer)

    Object which triggered the creation of this event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this closed event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this closed event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CodeOfConduct\n

    \n

    The Code of Conduct for a repository.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String)

    The body of the Code of Conduct.

    \n\n\n\n\n\n\n\n\n\n\n\n

    key (String!)

    The key for the Code of Conduct.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The formal name of the Code of Conduct.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI)

    The HTTP path for this Code of Conduct.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI)

    The HTTP URL for this Code of Conduct.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CommentDeletedEvent\n

    \n

    Represents acomment_deletedevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    deletedCommentAuthor (Actor)

    The user who authored the deleted comment.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Commit\n

    \n

    Represents a Git commit.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    abbreviatedOid (String!)

    An abbreviated version of the Git object ID.

    \n\n\n\n\n\n\n\n\n\n\n\n

    additions (Int!)

    The number of additions in this commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    associatedPullRequests (PullRequestConnection)

    The pull requests associated with a commit.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (PullRequestOrder)

    \n

    Ordering options for pull requests.

    \n\n
    \n\n
    \n\n\n

    author (GitActor)

    Authorship details of the commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    authoredByCommitter (Boolean!)

    Check if the committer and the author match.

    \n\n\n\n\n\n\n\n\n\n\n\n

    authoredDate (DateTime!)

    The datetime when this commit was authored.

    \n\n\n\n\n\n\n\n\n\n\n\n

    authors (GitActorConnection!)

    The list of authors for this commit based on the git author and the Co-authored-by\nmessage trailer. The git author will always be first.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    blame (Blame!)

    Fetches git blame information.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    path (String!)

    \n

    The file whose Git blame information you want.

    \n\n
    \n\n
    \n\n\n

    changedFiles (Int!)

    The number of changed files in this commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    checkSuites (CheckSuiteConnection)

    The check suites associated with a commit.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    filterBy (CheckSuiteFilter)

    \n

    Filters the check suites by this type.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    comments (CommitCommentConnection!)

    Comments made on the commit.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    commitResourcePath (URI!)

    The HTTP path for this Git object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commitUrl (URI!)

    The HTTP URL for this Git object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    committedDate (DateTime!)

    The datetime when this commit was committed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    committedViaWeb (Boolean!)

    Check if committed via GitHub web UI.

    \n\n\n\n\n\n\n\n\n\n\n\n

    committer (GitActor)

    Committer details of the commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    deletions (Int!)

    The number of deletions in this commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    deployments (DeploymentConnection)

    The deployments associated with a commit.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    environments ([String!])

    \n

    Environments to list deployments for.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (DeploymentOrder)

    \n

    Ordering options for deployments returned from the connection.

    \n\n
    \n\n
    \n\n\n

    file (TreeEntry)

    The tree entry representing the file located at the given path.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    path (String!)

    \n

    The path for the file.

    \n\n
    \n\n
    \n\n\n

    history (CommitHistoryConnection!)

    The linear commit history starting from (and including) this commit, in the same order as git log.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    author (CommitAuthor)

    \n

    If non-null, filters history to only show commits with matching authorship.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    path (String)

    \n

    If non-null, filters history to only show commits touching files under this path.

    \n\n
    \n\n
    \n

    since (GitTimestamp)

    \n

    Allows specifying a beginning time or date for fetching commits.

    \n\n
    \n\n
    \n

    until (GitTimestamp)

    \n

    Allows specifying an ending time or date for fetching commits.

    \n\n
    \n\n
    \n\n\n

    message (String!)

    The Git commit message.

    \n\n\n\n\n\n\n\n\n\n\n\n

    messageBody (String!)

    The Git commit message body.

    \n\n\n\n\n\n\n\n\n\n\n\n

    messageBodyHTML (HTML!)

    The commit message body rendered to HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    messageHeadline (String!)

    The Git commit message headline.

    \n\n\n\n\n\n\n\n\n\n\n\n

    messageHeadlineHTML (HTML!)

    The commit message headline rendered to HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    oid (GitObjectID!)

    The Git object ID.

    \n\n\n\n\n\n\n\n\n\n\n\n

    onBehalfOf (Organization)

    The organization this commit was made on behalf of.

    \n\n\n\n\n\n\n\n\n\n\n\n

    parents (CommitConnection!)

    The parents of a commit.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    pushedDate (DateTime)

    The datetime when this commit was pushed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository!)

    The Repository this commit belongs to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    signature (GitSignature)

    Commit signing information, if present.

    \n\n\n\n\n\n\n\n\n\n\n\n

    status (Status)

    Status information for this commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    statusCheckRollup (StatusCheckRollup)

    Check and Status rollup information for this commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    submodules (SubmoduleConnection!)

    Returns a list of all submodules in this repository as of this Commit parsed from the .gitmodules file.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    tarballUrl (URI!)

    Returns a URL to download a tarball archive for a repository.\nNote: For private repositories, these links are temporary and expire after five minutes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    tree (Tree!)

    Commit's root Tree.

    \n\n\n\n\n\n\n\n\n\n\n\n

    treeResourcePath (URI!)

    The HTTP path for the tree of this commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    treeUrl (URI!)

    The HTTP URL for the tree of this commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanSubscribe (Boolean!)

    Check if the viewer is able to change their subscription status for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerSubscription (SubscriptionState)

    Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

    \n\n\n\n\n\n\n\n\n\n\n\n

    zipballUrl (URI!)

    Returns a URL to download a zipball archive for a repository.\nNote: For private repositories, these links are temporary and expire after five minutes.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CommitComment\n

    \n

    Represents a comment on a given Commit.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    author (Actor)

    The actor who authored the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    authorAssociation (CommentAuthorAssociation!)

    Author's association with the subject of the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    body (String!)

    Identifies the comment body.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyHTML (HTML!)

    The body rendered to HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyText (String!)

    The body rendered to text.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commit (Commit)

    Identifies the commit associated with the comment, if the commit exists.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdViaEmail (Boolean!)

    Check if this comment was created via an email reply.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    editor (Actor)

    The actor who edited the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    includesCreatedEdit (Boolean!)

    Check if this comment was edited and includes an edit with the creation data.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isMinimized (Boolean!)

    Returns whether or not a comment has been minimized.

    \n\n\n\n\n\n\n\n\n\n\n\n

    lastEditedAt (DateTime)

    The moment the editor made the last edit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    minimizedReason (String)

    Returns why the comment was minimized.

    \n\n\n\n\n\n\n\n\n\n\n\n

    path (String)

    Identifies the file path associated with the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    position (Int)

    Identifies the line position associated with the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    publishedAt (DateTime)

    Identifies when the comment was published at.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reactionGroups ([ReactionGroup!])

    A list of reactions grouped by content left on the subject.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reactions (ReactionConnection!)

    A list of Reactions left on the Issue.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    content (ReactionContent)

    \n

    Allows filtering Reactions by emoji.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (ReactionOrder)

    \n

    Allows specifying the order in which reactions are returned.

    \n\n
    \n\n
    \n\n\n

    repository (Repository!)

    The repository associated with this node.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path permalink for this commit comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL permalink for this commit comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userContentEdits (UserContentEditConnection)

    A list of edits to this content.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    viewerCanDelete (Boolean!)

    Check if the current viewer can delete this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanMinimize (Boolean!)

    Check if the current viewer can minimize this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanReact (Boolean!)

    Can user react to this subject.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanUpdate (Boolean!)

    Check if the current viewer can update this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

    Reasons why the current viewer can not update this comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerDidAuthor (Boolean!)

    Did the viewer author this comment.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CommitCommentConnection\n

    \n

    The connection type for CommitComment.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([CommitCommentEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([CommitComment])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CommitCommentEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (CommitComment)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CommitCommentThread\n

    \n

    A thread of comments on a commit.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    comments (CommitCommentConnection!)

    The comments that exist in this thread.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    commit (Commit)

    The commit the comments were made on.

    \n\n\n\n\n\n\n\n\n\n\n\n

    path (String)

    The file the comments were made on.

    \n\n\n\n\n\n\n\n\n\n\n\n

    position (Int)

    The position in the diff for the commit that the comment was made on.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository!)

    The repository associated with this node.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CommitConnection\n

    \n

    The connection type for Commit.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([CommitEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Commit])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CommitContributionsByRepository\n

    \n

    This aggregates commits made by a user within one repository.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    contributions (CreatedCommitContributionConnection!)

    The commit contributions, each representing a day.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (CommitContributionOrder)

    \n

    Ordering options for commit contributions returned from the connection.

    \n\n
    \n\n
    \n\n\n

    repository (Repository!)

    The repository in which the commits were made.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for the user's commits to the repository in this time range.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for the user's commits to the repository in this time range.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CommitEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (Commit)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CommitHistoryConnection\n

    \n

    The connection type for Commit.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([CommitEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Commit])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ConnectedEvent\n

    \n

    Represents aconnectedevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isCrossRepository (Boolean!)

    Reference originated in a different repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    source (ReferencedSubject!)

    Issue or pull request that made the reference.

    \n\n\n\n\n\n\n\n\n\n\n\n

    subject (ReferencedSubject!)

    Issue or pull request which was connected.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ContentAttachment\n

    \n

    A content attachment.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String!)

    The body text of the content attachment. This parameter supports markdown.

    \n\n\n\n\n\n\n\n\n\n\n\n

    contentReference (ContentReference!)

    The content reference that the content attachment is attached to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int!)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    title (String!)

    The title of the content attachment.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ContentReference\n

    \n

    A content reference.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    databaseId (Int!)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reference (String!)

    The reference of the content reference.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ContributionCalendar\n

    \n

    A calendar of contributions made on GitHub by a user.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    colors ([String!]!)

    A list of hex color codes used in this calendar. The darker the color, the more contributions it represents.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isHalloween (Boolean!)

    Determine if the color set was chosen because it's currently Halloween.

    \n\n\n\n\n\n\n\n\n\n\n\n

    months ([ContributionCalendarMonth!]!)

    A list of the months of contributions in this calendar.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalContributions (Int!)

    The count of total contributions in the calendar.

    \n\n\n\n\n\n\n\n\n\n\n\n

    weeks ([ContributionCalendarWeek!]!)

    A list of the weeks of contributions in this calendar.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ContributionCalendarDay\n

    \n

    Represents a single day of contributions on GitHub by a user.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    color (String!)

    The hex color code that represents how many contributions were made on this day compared to others in the calendar.

    \n\n\n\n\n\n\n\n\n\n\n\n

    contributionCount (Int!)

    How many contributions were made by the user on this day.

    \n\n\n\n\n\n\n\n\n\n\n\n

    contributionLevel (ContributionLevel!)

    Indication of contributions, relative to other days. Can be used to indicate\nwhich color to represent this day on a calendar.

    \n\n\n\n\n\n\n\n\n\n\n\n

    date (Date!)

    The day this square represents.

    \n\n\n\n\n\n\n\n\n\n\n\n

    weekday (Int!)

    A number representing which day of the week this square represents, e.g., 1 is Monday.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ContributionCalendarMonth\n

    \n

    A month of contributions in a user's contribution graph.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    firstDay (Date!)

    The date of the first day of this month.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The name of the month.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalWeeks (Int!)

    How many weeks started in this month.

    \n\n\n\n\n\n\n\n\n\n\n\n

    year (Int!)

    The year the month occurred in.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ContributionCalendarWeek\n

    \n

    A week of contributions in a user's contribution graph.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    contributionDays ([ContributionCalendarDay!]!)

    The days of contributions in this week.

    \n\n\n\n\n\n\n\n\n\n\n\n

    firstDay (Date!)

    The date of the earliest square in this week.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ContributionsCollection\n

    \n

    A contributions collection aggregates contributions such as opened issues and commits created by a user.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    commitContributionsByRepository ([CommitContributionsByRepository!]!)

    Commit contributions made by the user, grouped by repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    maxRepositories (Int)

    \n

    How many repositories should be included.

    \n

    The default value is 25.

    \n
    \n\n
    \n\n\n

    contributionCalendar (ContributionCalendar!)

    A calendar of this user's contributions on GitHub.

    \n\n\n\n\n\n\n\n\n\n\n\n

    contributionYears ([Int!]!)

    The years the user has been making contributions with the most recent year first.

    \n\n\n\n\n\n\n\n\n\n\n\n

    doesEndInCurrentMonth (Boolean!)

    Determine if this collection's time span ends in the current month.

    \n\n\n\n\n\n\n\n\n\n\n\n

    earliestRestrictedContributionDate (Date)

    The date of the first restricted contribution the user made in this time\nperiod. Can only be non-null when the user has enabled private contribution counts.

    \n\n\n\n\n\n\n\n\n\n\n\n

    endedAt (DateTime!)

    The ending date and time of this collection.

    \n\n\n\n\n\n\n\n\n\n\n\n

    firstIssueContribution (CreatedIssueOrRestrictedContribution)

    The first issue the user opened on GitHub. This will be null if that issue was\nopened outside the collection's time range and ignoreTimeRange is false. If\nthe issue is not visible but the user has opted to show private contributions,\na RestrictedContribution will be returned.

    \n\n\n\n\n\n\n\n\n\n\n\n

    firstPullRequestContribution (CreatedPullRequestOrRestrictedContribution)

    The first pull request the user opened on GitHub. This will be null if that\npull request was opened outside the collection's time range and\nignoreTimeRange is not true. If the pull request is not visible but the user\nhas opted to show private contributions, a RestrictedContribution will be returned.

    \n\n\n\n\n\n\n\n\n\n\n\n

    firstRepositoryContribution (CreatedRepositoryOrRestrictedContribution)

    The first repository the user created on GitHub. This will be null if that\nfirst repository was created outside the collection's time range and\nignoreTimeRange is false. If the repository is not visible, then a\nRestrictedContribution is returned.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hasActivityInThePast (Boolean!)

    Does the user have any more activity in the timeline that occurred prior to the collection's time range?.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hasAnyContributions (Boolean!)

    Determine if there are any contributions in this collection.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hasAnyRestrictedContributions (Boolean!)

    Determine if the user made any contributions in this time frame whose details\nare not visible because they were made in a private repository. Can only be\ntrue if the user enabled private contribution counts.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isSingleDay (Boolean!)

    Whether or not the collector's time span is all within the same day.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issueContributions (CreatedIssueContributionConnection!)

    A list of issues the user opened.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    excludeFirst (Boolean)

    \n

    Should the user's first issue ever be excluded from the result.

    \n

    The default value is false.

    \n
    \n\n
    \n

    excludePopular (Boolean)

    \n

    Should the user's most commented issue be excluded from the result.

    \n

    The default value is false.

    \n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (ContributionOrder)

    \n

    Ordering options for contributions returned from the connection.

    \n\n
    \n\n
    \n\n\n

    issueContributionsByRepository ([IssueContributionsByRepository!]!)

    Issue contributions made by the user, grouped by repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    excludeFirst (Boolean)

    \n

    Should the user's first issue ever be excluded from the result.

    \n

    The default value is false.

    \n
    \n\n
    \n

    excludePopular (Boolean)

    \n

    Should the user's most commented issue be excluded from the result.

    \n

    The default value is false.

    \n
    \n\n
    \n

    maxRepositories (Int)

    \n

    How many repositories should be included.

    \n

    The default value is 25.

    \n
    \n\n
    \n\n\n

    joinedGitHubContribution (JoinedGitHubContribution)

    When the user signed up for GitHub. This will be null if that sign up date\nfalls outside the collection's time range and ignoreTimeRange is false.

    \n\n\n\n\n\n\n\n\n\n\n\n

    latestRestrictedContributionDate (Date)

    The date of the most recent restricted contribution the user made in this time\nperiod. Can only be non-null when the user has enabled private contribution counts.

    \n\n\n\n\n\n\n\n\n\n\n\n

    mostRecentCollectionWithActivity (ContributionsCollection)

    When this collection's time range does not include any activity from the user, use this\nto get a different collection from an earlier time range that does have activity.

    \n\n\n\n\n\n\n\n\n\n\n\n

    mostRecentCollectionWithoutActivity (ContributionsCollection)

    Returns a different contributions collection from an earlier time range than this one\nthat does not have any contributions.

    \n\n\n\n\n\n\n\n\n\n\n\n

    popularIssueContribution (CreatedIssueContribution)

    The issue the user opened on GitHub that received the most comments in the specified\ntime frame.

    \n\n\n\n\n\n\n\n\n\n\n\n

    popularPullRequestContribution (CreatedPullRequestContribution)

    The pull request the user opened on GitHub that received the most comments in the\nspecified time frame.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestContributions (CreatedPullRequestContributionConnection!)

    Pull request contributions made by the user.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    excludeFirst (Boolean)

    \n

    Should the user's first pull request ever be excluded from the result.

    \n

    The default value is false.

    \n
    \n\n
    \n

    excludePopular (Boolean)

    \n

    Should the user's most commented pull request be excluded from the result.

    \n

    The default value is false.

    \n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (ContributionOrder)

    \n

    Ordering options for contributions returned from the connection.

    \n\n
    \n\n
    \n\n\n

    pullRequestContributionsByRepository ([PullRequestContributionsByRepository!]!)

    Pull request contributions made by the user, grouped by repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    excludeFirst (Boolean)

    \n

    Should the user's first pull request ever be excluded from the result.

    \n

    The default value is false.

    \n
    \n\n
    \n

    excludePopular (Boolean)

    \n

    Should the user's most commented pull request be excluded from the result.

    \n

    The default value is false.

    \n
    \n\n
    \n

    maxRepositories (Int)

    \n

    How many repositories should be included.

    \n

    The default value is 25.

    \n
    \n\n
    \n\n\n

    pullRequestReviewContributions (CreatedPullRequestReviewContributionConnection!)

    Pull request review contributions made by the user.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (ContributionOrder)

    \n

    Ordering options for contributions returned from the connection.

    \n\n
    \n\n
    \n\n\n

    pullRequestReviewContributionsByRepository ([PullRequestReviewContributionsByRepository!]!)

    Pull request review contributions made by the user, grouped by repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    maxRepositories (Int)

    \n

    How many repositories should be included.

    \n

    The default value is 25.

    \n
    \n\n
    \n\n\n

    repositoryContributions (CreatedRepositoryContributionConnection!)

    A list of repositories owned by the user that the user created in this time range.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    excludeFirst (Boolean)

    \n

    Should the user's first repository ever be excluded from the result.

    \n

    The default value is false.

    \n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (ContributionOrder)

    \n

    Ordering options for contributions returned from the connection.

    \n\n
    \n\n
    \n\n\n

    restrictedContributionsCount (Int!)

    A count of contributions made by the user that the viewer cannot access. Only\nnon-zero when the user has chosen to share their private contribution counts.

    \n\n\n\n\n\n\n\n\n\n\n\n

    startedAt (DateTime!)

    The beginning date and time of this collection.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCommitContributions (Int!)

    How many commits were made by the user in this time span.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalIssueContributions (Int!)

    How many issues the user opened.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    excludeFirst (Boolean)

    \n

    Should the user's first issue ever be excluded from this count.

    \n

    The default value is false.

    \n
    \n\n
    \n

    excludePopular (Boolean)

    \n

    Should the user's most commented issue be excluded from this count.

    \n

    The default value is false.

    \n
    \n\n
    \n\n\n

    totalPullRequestContributions (Int!)

    How many pull requests the user opened.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    excludeFirst (Boolean)

    \n

    Should the user's first pull request ever be excluded from this count.

    \n

    The default value is false.

    \n
    \n\n
    \n

    excludePopular (Boolean)

    \n

    Should the user's most commented pull request be excluded from this count.

    \n

    The default value is false.

    \n
    \n\n
    \n\n\n

    totalPullRequestReviewContributions (Int!)

    How many pull request reviews the user left.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalRepositoriesWithContributedCommits (Int!)

    How many different repositories the user committed to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalRepositoriesWithContributedIssues (Int!)

    How many different repositories the user opened issues in.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    excludeFirst (Boolean)

    \n

    Should the user's first issue ever be excluded from this count.

    \n

    The default value is false.

    \n
    \n\n
    \n

    excludePopular (Boolean)

    \n

    Should the user's most commented issue be excluded from this count.

    \n

    The default value is false.

    \n
    \n\n
    \n\n\n

    totalRepositoriesWithContributedPullRequestReviews (Int!)

    How many different repositories the user left pull request reviews in.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalRepositoriesWithContributedPullRequests (Int!)

    How many different repositories the user opened pull requests in.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    excludeFirst (Boolean)

    \n

    Should the user's first pull request ever be excluded from this count.

    \n

    The default value is false.

    \n
    \n\n
    \n

    excludePopular (Boolean)

    \n

    Should the user's most commented pull request be excluded from this count.

    \n

    The default value is false.

    \n
    \n\n
    \n\n\n

    totalRepositoryContributions (Int!)

    How many repositories the user created.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    excludeFirst (Boolean)

    \n

    Should the user's first repository ever be excluded from this count.

    \n

    The default value is false.

    \n
    \n\n
    \n\n\n

    user (User!)

    The user who made the contributions in this collection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ConvertToDraftEvent\n

    \n

    Represents aconvert_to_draftevent on a given pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    PullRequest referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this convert to draft event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this convert to draft event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ConvertedNoteToIssueEvent\n

    \n

    Represents aconverted_note_to_issueevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    project (Project)

    Project referenced by event.

    \n\n\n\n\n
    \n

    Preview notice

    \n

    project is available under the Project event details preview. During the preview period, the API may change without notice.

    \n
    \n\n\n\n\n\n\n\n\n

    projectCard (ProjectCard)

    Project card referenced by this project event.

    \n\n\n\n\n
    \n

    Preview notice

    \n

    projectCard is available under the Project event details preview. During the preview period, the API may change without notice.

    \n
    \n\n\n\n\n\n\n\n\n

    projectColumnName (String!)

    Column name referenced by this project event.

    \n\n\n\n\n
    \n

    Preview notice

    \n

    projectColumnName is available under the Project event details preview. During the preview period, the API may change without notice.

    \n
    \n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CreatedCommitContribution\n

    \n

    Represents the contribution a user made by committing to a repository.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    commitCount (Int!)

    How many commits were made on this day to this repository by the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isRestricted (Boolean!)

    Whether this contribution is associated with a record you do not have access to. For\nexample, your own 'first issue' contribution may have been made on a repository you can no\nlonger access.

    \n\n\n\n\n\n\n\n\n\n\n\n

    occurredAt (DateTime!)

    When this contribution was made.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository!)

    The repository the user made a commit in.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User!)

    The user who made this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CreatedCommitContributionConnection\n

    \n

    The connection type for CreatedCommitContribution.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([CreatedCommitContributionEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([CreatedCommitContribution])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of commits across days and repositories in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CreatedCommitContributionEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (CreatedCommitContribution)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CreatedIssueContribution\n

    \n

    Represents the contribution a user made on GitHub by opening an issue.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    isRestricted (Boolean!)

    Whether this contribution is associated with a record you do not have access to. For\nexample, your own 'first issue' contribution may have been made on a repository you can no\nlonger access.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issue (Issue!)

    The issue that was opened.

    \n\n\n\n\n\n\n\n\n\n\n\n

    occurredAt (DateTime!)

    When this contribution was made.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User!)

    The user who made this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CreatedIssueContributionConnection\n

    \n

    The connection type for CreatedIssueContribution.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([CreatedIssueContributionEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([CreatedIssueContribution])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CreatedIssueContributionEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (CreatedIssueContribution)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CreatedPullRequestContribution\n

    \n

    Represents the contribution a user made on GitHub by opening a pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    isRestricted (Boolean!)

    Whether this contribution is associated with a record you do not have access to. For\nexample, your own 'first issue' contribution may have been made on a repository you can no\nlonger access.

    \n\n\n\n\n\n\n\n\n\n\n\n

    occurredAt (DateTime!)

    When this contribution was made.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    The pull request that was opened.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User!)

    The user who made this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CreatedPullRequestContributionConnection\n

    \n

    The connection type for CreatedPullRequestContribution.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([CreatedPullRequestContributionEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([CreatedPullRequestContribution])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CreatedPullRequestContributionEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (CreatedPullRequestContribution)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CreatedPullRequestReviewContribution\n

    \n

    Represents the contribution a user made by leaving a review on a pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    isRestricted (Boolean!)

    Whether this contribution is associated with a record you do not have access to. For\nexample, your own 'first issue' contribution may have been made on a repository you can no\nlonger access.

    \n\n\n\n\n\n\n\n\n\n\n\n

    occurredAt (DateTime!)

    When this contribution was made.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    The pull request the user reviewed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestReview (PullRequestReview!)

    The review the user left on the pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository!)

    The repository containing the pull request that the user reviewed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User!)

    The user who made this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CreatedPullRequestReviewContributionConnection\n

    \n

    The connection type for CreatedPullRequestReviewContribution.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([CreatedPullRequestReviewContributionEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([CreatedPullRequestReviewContribution])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CreatedPullRequestReviewContributionEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (CreatedPullRequestReviewContribution)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CreatedRepositoryContribution\n

    \n

    Represents the contribution a user made on GitHub by creating a repository.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    isRestricted (Boolean!)

    Whether this contribution is associated with a record you do not have access to. For\nexample, your own 'first issue' contribution may have been made on a repository you can no\nlonger access.

    \n\n\n\n\n\n\n\n\n\n\n\n

    occurredAt (DateTime!)

    When this contribution was made.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository!)

    The repository that was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User!)

    The user who made this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CreatedRepositoryContributionConnection\n

    \n

    The connection type for CreatedRepositoryContribution.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([CreatedRepositoryContributionEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([CreatedRepositoryContribution])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CreatedRepositoryContributionEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (CreatedRepositoryContribution)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n CrossReferencedEvent\n

    \n

    Represents a mention made by one issue or pull request to another.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isCrossRepository (Boolean!)

    Reference originated in a different repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    referencedAt (DateTime!)

    Identifies when the reference was made.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    source (ReferencedSubject!)

    Issue or pull request that made the reference.

    \n\n\n\n\n\n\n\n\n\n\n\n

    target (ReferencedSubject!)

    Issue or pull request to which the reference was made.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    willCloseTarget (Boolean!)

    Checks if the target will be closed when the source is merged.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n DemilestonedEvent\n

    \n

    Represents ademilestonedevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    milestoneTitle (String!)

    Identifies the milestone title associated with thedemilestonedevent.

    \n\n\n\n\n\n\n\n\n\n\n\n

    subject (MilestoneItem!)

    Object referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n DeployKey\n

    \n

    A repository deploy key.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    key (String!)

    The deploy key.

    \n\n\n\n\n\n\n\n\n\n\n\n

    readOnly (Boolean!)

    Whether or not the deploy key is read only.

    \n\n\n\n\n\n\n\n\n\n\n\n

    title (String!)

    The deploy key title.

    \n\n\n\n\n\n\n\n\n\n\n\n

    verified (Boolean!)

    Whether or not the deploy key has been verified.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n DeployKeyConnection\n

    \n

    The connection type for DeployKey.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([DeployKeyEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([DeployKey])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n DeployKeyEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (DeployKey)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n DeployedEvent\n

    \n

    Represents adeployedevent on a given pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    deployment (Deployment!)

    The deployment associated with thedeployedevent.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    PullRequest referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ref (Ref)

    The ref associated with thedeployedevent.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Deployment\n

    \n

    Represents triggered deployment instance.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    commit (Commit)

    Identifies the commit sha of the deployment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commitOid (String!)

    Identifies the oid of the deployment commit, even if the commit has been deleted.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    creator (Actor!)

    Identifies the actor who triggered the deployment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String)

    The deployment description.

    \n\n\n\n\n\n\n\n\n\n\n\n

    environment (String)

    The latest environment to which this deployment was made.

    \n\n\n\n\n\n\n\n\n\n\n\n

    latestEnvironment (String)

    The latest environment to which this deployment was made.

    \n\n\n\n\n\n\n\n\n\n\n\n

    latestStatus (DeploymentStatus)

    The latest status of this deployment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    originalEnvironment (String)

    The original environment to which this deployment was made.

    \n\n\n\n\n\n\n\n\n\n\n\n

    payload (String)

    Extra information that a deployment system might need.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ref (Ref)

    Identifies the Ref of the deployment, if the deployment was created by ref.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository!)

    Identifies the repository associated with the deployment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    state (DeploymentState)

    The current state of the deployment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    statuses (DeploymentStatusConnection)

    A list of statuses associated with the deployment.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    task (String)

    The deployment task.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n DeploymentConnection\n

    \n

    The connection type for Deployment.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([DeploymentEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Deployment])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n DeploymentEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (Deployment)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n DeploymentEnvironmentChangedEvent\n

    \n

    Represents adeployment_environment_changedevent on a given pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    deploymentStatus (DeploymentStatus!)

    The deployment status that updated the deployment environment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    PullRequest referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n DeploymentStatus\n

    \n

    Describes the status of a given deployment attempt.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    creator (Actor!)

    Identifies the actor who triggered the deployment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    deployment (Deployment!)

    Identifies the deployment associated with status.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String)

    Identifies the description of the deployment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    environment (String)

    Identifies the environment of the deployment at the time of this deployment status.

    \n\n\n\n\n
    \n

    Preview notice

    \n

    environment is available under the Deployments preview. During the preview period, the API may change without notice.

    \n
    \n\n\n\n\n\n\n\n\n

    environmentUrl (URI)

    Identifies the environment URL of the deployment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    logUrl (URI)

    Identifies the log URL of the deployment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    state (DeploymentStatusState!)

    Identifies the current state of the deployment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n DeploymentStatusConnection\n

    \n

    The connection type for DeploymentStatus.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([DeploymentStatusEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([DeploymentStatus])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n DeploymentStatusEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (DeploymentStatus)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n DisconnectedEvent\n

    \n

    Represents adisconnectedevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isCrossRepository (Boolean!)

    Reference originated in a different repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    source (ReferencedSubject!)

    Issue or pull request from which the issue was disconnected.

    \n\n\n\n\n\n\n\n\n\n\n\n

    subject (ReferencedSubject!)

    Issue or pull request which was disconnected.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Enterprise\n

    \n

    An account to manage multiple organizations with consolidated policy and billing.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    avatarUrl (URI!)

    A URL pointing to the enterprise's public avatar.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    size (Int)

    \n

    The size of the resulting square image.

    \n\n
    \n\n
    \n\n\n

    billingInfo (EnterpriseBillingInfo)

    Enterprise billing information visible to enterprise billing managers.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String)

    The description of the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    descriptionHTML (HTML!)

    The description of the enterprise as HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    location (String)

    The location of the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    members (EnterpriseMemberConnection!)

    A list of users who are members of this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    deployment (EnterpriseUserDeployment)

    \n

    Only return members within the selected GitHub Enterprise deployment.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (EnterpriseMemberOrder)

    \n

    Ordering options for members returned from the connection.

    \n\n
    \n\n
    \n

    organizationLogins ([String!])

    \n

    Only return members within the organizations with these logins.

    \n\n
    \n\n
    \n

    query (String)

    \n

    The search string to look for.

    \n\n
    \n\n
    \n

    role (EnterpriseUserAccountMembershipRole)

    \n

    The role of the user in the enterprise organization or server.

    \n\n
    \n\n
    \n\n\n

    name (String!)

    The name of the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizations (OrganizationConnection!)

    A list of organizations that belong to this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (OrganizationOrder)

    \n

    Ordering options for organizations returned from the connection.

    \n\n
    \n\n
    \n

    query (String)

    \n

    The search string to look for.

    \n\n
    \n\n
    \n\n\n

    ownerInfo (EnterpriseOwnerInfo)

    Enterprise information only visible to enterprise owners.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    slug (String!)

    The URL-friendly identifier for the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userAccounts (EnterpriseUserAccountConnection!)

    A list of user accounts on this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    viewerIsAdmin (Boolean!)

    Is the current viewer an admin of this enterprise?.

    \n\n\n\n\n\n\n\n\n\n\n\n

    websiteUrl (URI)

    The URL of the enterprise website.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseAdministratorConnection\n

    \n

    The connection type for User.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([EnterpriseAdministratorEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([User])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseAdministratorEdge\n

    \n

    A User who is an administrator of an enterprise.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (User)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n

    role (EnterpriseAdministratorRole!)

    The role of the administrator.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseAdministratorInvitation\n

    \n

    An invitation for a user to become an owner or billing manager of an enterprise.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    email (String)

    The email of the person who was invited to the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterprise (Enterprise!)

    The enterprise the invitation is for.

    \n\n\n\n\n\n\n\n\n\n\n\n

    invitee (User)

    The user who was invited to the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    inviter (User)

    The user who created the invitation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    role (EnterpriseAdministratorRole!)

    The invitee's pending role in the enterprise (owner or billing_manager).

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseAdministratorInvitationConnection\n

    \n

    The connection type for EnterpriseAdministratorInvitation.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([EnterpriseAdministratorInvitationEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([EnterpriseAdministratorInvitation])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseAdministratorInvitationEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (EnterpriseAdministratorInvitation)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseBillingInfo\n

    \n

    Enterprise billing information visible to enterprise billing managers and owners.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    allLicensableUsersCount (Int!)

    The number of licenseable users/emails across the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    assetPacks (Int!)

    The number of data packs used by all organizations owned by the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    availableSeats (Int!)

    The number of available seats across all owned organizations based on the unique number of billable users.

    \n\n\n\n\n\n\n
    \n

    Deprecation notice

    \n

    availableSeats is deprecated.

    availableSeats will be replaced with totalAvailableLicenses to provide more clarity on the value being returned Use EnterpriseBillingInfo.totalAvailableLicenses instead. Removal on 2020-01-01 UTC.

    \n
    \n\n\n\n\n\n\n

    bandwidthQuota (Float!)

    The bandwidth quota in GB for all organizations owned by the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bandwidthUsage (Float!)

    The bandwidth usage in GB for all organizations owned by the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bandwidthUsagePercentage (Int!)

    The bandwidth usage as a percentage of the bandwidth quota.

    \n\n\n\n\n\n\n\n\n\n\n\n

    seats (Int!)

    The total seats across all organizations owned by the enterprise.

    \n\n\n\n\n\n\n
    \n

    Deprecation notice

    \n

    seats is deprecated.

    seats will be replaced with totalLicenses to provide more clarity on the value being returned Use EnterpriseBillingInfo.totalLicenses instead. Removal on 2020-01-01 UTC.

    \n
    \n\n\n\n\n\n\n

    storageQuota (Float!)

    The storage quota in GB for all organizations owned by the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    storageUsage (Float!)

    The storage usage in GB for all organizations owned by the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    storageUsagePercentage (Int!)

    The storage usage as a percentage of the storage quota.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalAvailableLicenses (Int!)

    The number of available licenses across all owned organizations based on the unique number of billable users.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalLicenses (Int!)

    The total number of licenses allocated.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseIdentityProvider\n

    \n

    An identity provider configured to provision identities for an enterprise.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    digestMethod (SamlDigestAlgorithm)

    The digest algorithm used to sign SAML requests for the identity provider.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterprise (Enterprise)

    The enterprise this identity provider belongs to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    externalIdentities (ExternalIdentityConnection!)

    ExternalIdentities provisioned by this identity provider.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    idpCertificate (X509Certificate)

    The x509 certificate used by the identity provider to sign assertions and responses.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issuer (String)

    The Issuer Entity ID for the SAML identity provider.

    \n\n\n\n\n\n\n\n\n\n\n\n

    recoveryCodes ([String!])

    Recovery codes that can be used by admins to access the enterprise if the identity provider is unavailable.

    \n\n\n\n\n\n\n\n\n\n\n\n

    signatureMethod (SamlSignatureAlgorithm)

    The signature algorithm used to sign SAML requests for the identity provider.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ssoUrl (URI)

    The URL endpoint for the identity provider's SAML SSO.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseMemberConnection\n

    \n

    The connection type for EnterpriseMember.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([EnterpriseMemberEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([EnterpriseMember])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseMemberEdge\n

    \n

    A User who is a member of an enterprise through one or more organizations.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isUnlicensed (Boolean!)

    Whether the user does not have a license for the enterprise.

    \n\n\n\n\n\n\n
    \n

    Deprecation notice

    \n

    isUnlicensed is deprecated.

    All members consume a license Removal on 2021-01-01 UTC.

    \n
    \n\n\n\n\n\n\n

    node (EnterpriseMember)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseOrganizationMembershipConnection\n

    \n

    The connection type for Organization.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([EnterpriseOrganizationMembershipEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Organization])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseOrganizationMembershipEdge\n

    \n

    An enterprise organization that a user is a member of.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (Organization)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n

    role (EnterpriseUserAccountMembershipRole!)

    The role of the user in the enterprise membership.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseOutsideCollaboratorConnection\n

    \n

    The connection type for User.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([EnterpriseOutsideCollaboratorEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([User])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseOutsideCollaboratorEdge\n

    \n

    A User who is an outside collaborator of an enterprise through one or more organizations.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isUnlicensed (Boolean!)

    Whether the outside collaborator does not have a license for the enterprise.

    \n\n\n\n\n\n\n
    \n

    Deprecation notice

    \n

    isUnlicensed is deprecated.

    All outside collaborators consume a license Removal on 2021-01-01 UTC.

    \n
    \n\n\n\n\n\n\n

    node (User)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositories (EnterpriseRepositoryInfoConnection!)

    The enterprise organization repositories this user is a member of.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (RepositoryOrder)

    \n

    Ordering options for repositories.

    \n\n
    \n\n
    \n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseOwnerInfo\n

    \n

    Enterprise information only visible to enterprise owners.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    admins (EnterpriseAdministratorConnection!)

    A list of all of the administrators for this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (EnterpriseMemberOrder)

    \n

    Ordering options for administrators returned from the connection.

    \n\n
    \n\n
    \n

    query (String)

    \n

    The search string to look for.

    \n\n
    \n\n
    \n

    role (EnterpriseAdministratorRole)

    \n

    The role to filter by.

    \n\n
    \n\n
    \n\n\n

    affiliatedUsersWithTwoFactorDisabled (UserConnection!)

    A list of users in the enterprise who currently have two-factor authentication disabled.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    affiliatedUsersWithTwoFactorDisabledExist (Boolean!)

    Whether or not affiliated users with two-factor authentication disabled exist in the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    allowPrivateRepositoryForkingSetting (EnterpriseEnabledDisabledSettingValue!)

    The setting value for whether private repository forking is enabled for repositories in organizations in this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    allowPrivateRepositoryForkingSettingOrganizations (OrganizationConnection!)

    A list of enterprise organizations configured with the provided private repository forking setting value.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (OrganizationOrder)

    \n

    Ordering options for organizations with this setting.

    \n\n
    \n\n
    \n

    value (Boolean!)

    \n

    The setting value to find organizations for.

    \n\n
    \n\n
    \n\n\n

    defaultRepositoryPermissionSetting (EnterpriseDefaultRepositoryPermissionSettingValue!)

    The setting value for base repository permissions for organizations in this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    defaultRepositoryPermissionSettingOrganizations (OrganizationConnection!)

    A list of enterprise organizations configured with the provided default repository permission.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (OrganizationOrder)

    \n

    Ordering options for organizations with this setting.

    \n\n
    \n\n
    \n

    value (DefaultRepositoryPermissionField!)

    \n

    The permission to find organizations for.

    \n\n
    \n\n
    \n\n\n

    domains (VerifiableDomainConnection!)

    A list of domains owned by the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    isVerified (Boolean)

    \n

    Filter whether or not the domain is verified.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (VerifiableDomainOrder)

    \n

    Ordering options for verifiable domains returned.

    \n\n
    \n\n
    \n\n\n

    ipAllowListEnabledSetting (IpAllowListEnabledSettingValue!)

    The setting value for whether the enterprise has an IP allow list enabled.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ipAllowListEntries (IpAllowListEntryConnection!)

    The IP addresses that are allowed to access resources owned by the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (IpAllowListEntryOrder)

    \n

    Ordering options for IP allow list entries returned.

    \n\n
    \n\n
    \n\n\n

    isUpdatingDefaultRepositoryPermission (Boolean!)

    Whether or not the default repository permission is currently being updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isUpdatingTwoFactorRequirement (Boolean!)

    Whether the two-factor authentication requirement is currently being enforced.

    \n\n\n\n\n\n\n\n\n\n\n\n

    membersCanChangeRepositoryVisibilitySetting (EnterpriseEnabledDisabledSettingValue!)

    The setting value for whether organization members with admin permissions on a\nrepository can change repository visibility.

    \n\n\n\n\n\n\n\n\n\n\n\n

    membersCanChangeRepositoryVisibilitySettingOrganizations (OrganizationConnection!)

    A list of enterprise organizations configured with the provided can change repository visibility setting value.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (OrganizationOrder)

    \n

    Ordering options for organizations with this setting.

    \n\n
    \n\n
    \n

    value (Boolean!)

    \n

    The setting value to find organizations for.

    \n\n
    \n\n
    \n\n\n

    membersCanCreateInternalRepositoriesSetting (Boolean)

    The setting value for whether members of organizations in the enterprise can create internal repositories.

    \n\n\n\n\n\n\n\n\n\n\n\n

    membersCanCreatePrivateRepositoriesSetting (Boolean)

    The setting value for whether members of organizations in the enterprise can create private repositories.

    \n\n\n\n\n\n\n\n\n\n\n\n

    membersCanCreatePublicRepositoriesSetting (Boolean)

    The setting value for whether members of organizations in the enterprise can create public repositories.

    \n\n\n\n\n\n\n\n\n\n\n\n

    membersCanCreateRepositoriesSetting (EnterpriseMembersCanCreateRepositoriesSettingValue)

    The setting value for whether members of organizations in the enterprise can create repositories.

    \n\n\n\n\n\n\n\n\n\n\n\n

    membersCanCreateRepositoriesSettingOrganizations (OrganizationConnection!)

    A list of enterprise organizations configured with the provided repository creation setting value.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (OrganizationOrder)

    \n

    Ordering options for organizations with this setting.

    \n\n
    \n\n
    \n

    value (OrganizationMembersCanCreateRepositoriesSettingValue!)

    \n

    The setting to find organizations for.

    \n\n
    \n\n
    \n\n\n

    membersCanDeleteIssuesSetting (EnterpriseEnabledDisabledSettingValue!)

    The setting value for whether members with admin permissions for repositories can delete issues.

    \n\n\n\n\n\n\n\n\n\n\n\n

    membersCanDeleteIssuesSettingOrganizations (OrganizationConnection!)

    A list of enterprise organizations configured with the provided members can delete issues setting value.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (OrganizationOrder)

    \n

    Ordering options for organizations with this setting.

    \n\n
    \n\n
    \n

    value (Boolean!)

    \n

    The setting value to find organizations for.

    \n\n
    \n\n
    \n\n\n

    membersCanDeleteRepositoriesSetting (EnterpriseEnabledDisabledSettingValue!)

    The setting value for whether members with admin permissions for repositories can delete or transfer repositories.

    \n\n\n\n\n\n\n\n\n\n\n\n

    membersCanDeleteRepositoriesSettingOrganizations (OrganizationConnection!)

    A list of enterprise organizations configured with the provided members can delete repositories setting value.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (OrganizationOrder)

    \n

    Ordering options for organizations with this setting.

    \n\n
    \n\n
    \n

    value (Boolean!)

    \n

    The setting value to find organizations for.

    \n\n
    \n\n
    \n\n\n

    membersCanInviteCollaboratorsSetting (EnterpriseEnabledDisabledSettingValue!)

    The setting value for whether members of organizations in the enterprise can invite outside collaborators.

    \n\n\n\n\n\n\n\n\n\n\n\n

    membersCanInviteCollaboratorsSettingOrganizations (OrganizationConnection!)

    A list of enterprise organizations configured with the provided members can invite collaborators setting value.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (OrganizationOrder)

    \n

    Ordering options for organizations with this setting.

    \n\n
    \n\n
    \n

    value (Boolean!)

    \n

    The setting value to find organizations for.

    \n\n
    \n\n
    \n\n\n

    membersCanMakePurchasesSetting (EnterpriseMembersCanMakePurchasesSettingValue!)

    Indicates whether members of this enterprise's organizations can purchase additional services for those organizations.

    \n\n\n\n\n\n\n\n\n\n\n\n

    membersCanUpdateProtectedBranchesSetting (EnterpriseEnabledDisabledSettingValue!)

    The setting value for whether members with admin permissions for repositories can update protected branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    membersCanUpdateProtectedBranchesSettingOrganizations (OrganizationConnection!)

    A list of enterprise organizations configured with the provided members can update protected branches setting value.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (OrganizationOrder)

    \n

    Ordering options for organizations with this setting.

    \n\n
    \n\n
    \n

    value (Boolean!)

    \n

    The setting value to find organizations for.

    \n\n
    \n\n
    \n\n\n

    membersCanViewDependencyInsightsSetting (EnterpriseEnabledDisabledSettingValue!)

    The setting value for whether members can view dependency insights.

    \n\n\n\n\n\n\n\n\n\n\n\n

    membersCanViewDependencyInsightsSettingOrganizations (OrganizationConnection!)

    A list of enterprise organizations configured with the provided members can view dependency insights setting value.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (OrganizationOrder)

    \n

    Ordering options for organizations with this setting.

    \n\n
    \n\n
    \n

    value (Boolean!)

    \n

    The setting value to find organizations for.

    \n\n
    \n\n
    \n\n\n

    organizationProjectsSetting (EnterpriseEnabledDisabledSettingValue!)

    The setting value for whether organization projects are enabled for organizations in this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationProjectsSettingOrganizations (OrganizationConnection!)

    A list of enterprise organizations configured with the provided organization projects setting value.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (OrganizationOrder)

    \n

    Ordering options for organizations with this setting.

    \n\n
    \n\n
    \n

    value (Boolean!)

    \n

    The setting value to find organizations for.

    \n\n
    \n\n
    \n\n\n

    outsideCollaborators (EnterpriseOutsideCollaboratorConnection!)

    A list of outside collaborators across the repositories in the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    login (String)

    \n

    The login of one specific outside collaborator.

    \n\n
    \n\n
    \n

    orderBy (EnterpriseMemberOrder)

    \n

    Ordering options for outside collaborators returned from the connection.

    \n\n
    \n\n
    \n

    query (String)

    \n

    The search string to look for.

    \n\n
    \n\n
    \n

    visibility (RepositoryVisibility)

    \n

    Only return outside collaborators on repositories with this visibility.

    \n\n
    \n\n
    \n\n\n

    pendingAdminInvitations (EnterpriseAdministratorInvitationConnection!)

    A list of pending administrator invitations for the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (EnterpriseAdministratorInvitationOrder)

    \n

    Ordering options for pending enterprise administrator invitations returned from the connection.

    \n\n
    \n\n
    \n

    query (String)

    \n

    The search string to look for.

    \n\n
    \n\n
    \n

    role (EnterpriseAdministratorRole)

    \n

    The role to filter by.

    \n\n
    \n\n
    \n\n\n

    pendingCollaboratorInvitations (RepositoryInvitationConnection!)

    A list of pending collaborator invitations across the repositories in the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (RepositoryInvitationOrder)

    \n

    Ordering options for pending repository collaborator invitations returned from the connection.

    \n\n
    \n\n
    \n

    query (String)

    \n

    The search string to look for.

    \n\n
    \n\n
    \n\n\n

    pendingCollaborators (EnterprisePendingCollaboratorConnection!)

    A list of pending collaborators across the repositories in the enterprise.

    \n\n\n\n\n\n\n
    \n

    Deprecation notice

    \n

    pendingCollaborators is deprecated.

    Repository invitations can now be associated with an email, not only an invitee. Use the pendingCollaboratorInvitations field instead. Removal on 2020-10-01 UTC.

    \n
    \n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (RepositoryInvitationOrder)

    \n

    Ordering options for pending repository collaborator invitations returned from the connection.

    \n\n
    \n\n
    \n

    query (String)

    \n

    The search string to look for.

    \n\n
    \n\n
    \n\n\n

    pendingMemberInvitations (EnterprisePendingMemberInvitationConnection!)

    A list of pending member invitations for organizations in the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    query (String)

    \n

    The search string to look for.

    \n\n
    \n\n
    \n\n\n

    repositoryProjectsSetting (EnterpriseEnabledDisabledSettingValue!)

    The setting value for whether repository projects are enabled in this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryProjectsSettingOrganizations (OrganizationConnection!)

    A list of enterprise organizations configured with the provided repository projects setting value.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (OrganizationOrder)

    \n

    Ordering options for organizations with this setting.

    \n\n
    \n\n
    \n

    value (Boolean!)

    \n

    The setting value to find organizations for.

    \n\n
    \n\n
    \n\n\n

    samlIdentityProvider (EnterpriseIdentityProvider)

    The SAML Identity Provider for the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    samlIdentityProviderSettingOrganizations (OrganizationConnection!)

    A list of enterprise organizations configured with the SAML single sign-on setting value.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (OrganizationOrder)

    \n

    Ordering options for organizations with this setting.

    \n\n
    \n\n
    \n

    value (IdentityProviderConfigurationState!)

    \n

    The setting value to find organizations for.

    \n\n
    \n\n
    \n\n\n

    teamDiscussionsSetting (EnterpriseEnabledDisabledSettingValue!)

    The setting value for whether team discussions are enabled for organizations in this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamDiscussionsSettingOrganizations (OrganizationConnection!)

    A list of enterprise organizations configured with the provided team discussions setting value.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (OrganizationOrder)

    \n

    Ordering options for organizations with this setting.

    \n\n
    \n\n
    \n

    value (Boolean!)

    \n

    The setting value to find organizations for.

    \n\n
    \n\n
    \n\n\n

    twoFactorRequiredSetting (EnterpriseEnabledSettingValue!)

    The setting value for whether the enterprise requires two-factor authentication for its organizations and users.

    \n\n\n\n\n\n\n\n\n\n\n\n

    twoFactorRequiredSettingOrganizations (OrganizationConnection!)

    A list of enterprise organizations configured with the two-factor authentication setting value.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (OrganizationOrder)

    \n

    Ordering options for organizations with this setting.

    \n\n
    \n\n
    \n

    value (Boolean!)

    \n

    The setting value to find organizations for.

    \n\n
    \n\n
    \n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterprisePendingCollaboratorConnection\n

    \n

    The connection type for User.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([EnterprisePendingCollaboratorEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([User])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterprisePendingCollaboratorEdge\n

    \n

    A user with an invitation to be a collaborator on a repository owned by an organization in an enterprise.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isUnlicensed (Boolean!)

    Whether the invited collaborator does not have a license for the enterprise.

    \n\n\n\n\n\n\n
    \n

    Deprecation notice

    \n

    isUnlicensed is deprecated.

    All pending collaborators consume a license Removal on 2021-01-01 UTC.

    \n
    \n\n\n\n\n\n\n

    node (User)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositories (EnterpriseRepositoryInfoConnection!)

    The enterprise organization repositories this user is a member of.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (RepositoryOrder)

    \n

    Ordering options for repositories.

    \n\n
    \n\n
    \n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterprisePendingMemberInvitationConnection\n

    \n

    The connection type for OrganizationInvitation.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([EnterprisePendingMemberInvitationEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([OrganizationInvitation])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalUniqueUserCount (Int!)

    Identifies the total count of unique users in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterprisePendingMemberInvitationEdge\n

    \n

    An invitation to be a member in an enterprise organization.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isUnlicensed (Boolean!)

    Whether the invitation has a license for the enterprise.

    \n\n\n\n\n\n\n
    \n

    Deprecation notice

    \n

    isUnlicensed is deprecated.

    All pending members consume a license Removal on 2020-07-01 UTC.

    \n
    \n\n\n\n\n\n\n

    node (OrganizationInvitation)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseRepositoryInfo\n

    \n

    A subset of repository information queryable from an enterprise.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    isPrivate (Boolean!)

    Identifies if the repository is private.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The repository's name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nameWithOwner (String!)

    The repository's name with owner.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseRepositoryInfoConnection\n

    \n

    The connection type for EnterpriseRepositoryInfo.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([EnterpriseRepositoryInfoEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([EnterpriseRepositoryInfo])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseRepositoryInfoEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (EnterpriseRepositoryInfo)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseServerInstallation\n

    \n

    An Enterprise Server installation.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    customerName (String!)

    The customer name to which the Enterprise Server installation belongs.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hostName (String!)

    The host name of the Enterprise Server installation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isConnected (Boolean!)

    Whether or not the installation is connected to an Enterprise Server installation via GitHub Connect.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userAccounts (EnterpriseServerUserAccountConnection!)

    User accounts on this Enterprise Server installation.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (EnterpriseServerUserAccountOrder)

    \n

    Ordering options for Enterprise Server user accounts returned from the connection.

    \n\n
    \n\n
    \n\n\n

    userAccountsUploads (EnterpriseServerUserAccountsUploadConnection!)

    User accounts uploads for the Enterprise Server installation.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (EnterpriseServerUserAccountsUploadOrder)

    \n

    Ordering options for Enterprise Server user accounts uploads returned from the connection.

    \n\n
    \n\n
    \n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseServerUserAccount\n

    \n

    A user account on an Enterprise Server installation.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    emails (EnterpriseServerUserAccountEmailConnection!)

    User emails belonging to this user account.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (EnterpriseServerUserAccountEmailOrder)

    \n

    Ordering options for Enterprise Server user account emails returned from the connection.

    \n\n
    \n\n
    \n\n\n

    enterpriseServerInstallation (EnterpriseServerInstallation!)

    The Enterprise Server installation on which this user account exists.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isSiteAdmin (Boolean!)

    Whether the user account is a site administrator on the Enterprise Server installation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    login (String!)

    The login of the user account on the Enterprise Server installation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    profileName (String)

    The profile name of the user account on the Enterprise Server installation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    remoteCreatedAt (DateTime!)

    The date and time when the user account was created on the Enterprise Server installation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    remoteUserId (Int!)

    The ID of the user account on the Enterprise Server installation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseServerUserAccountConnection\n

    \n

    The connection type for EnterpriseServerUserAccount.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([EnterpriseServerUserAccountEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([EnterpriseServerUserAccount])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseServerUserAccountEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (EnterpriseServerUserAccount)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseServerUserAccountEmail\n

    \n

    An email belonging to a user account on an Enterprise Server installation.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    email (String!)

    The email address.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isPrimary (Boolean!)

    Indicates whether this is the primary email of the associated user account.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userAccount (EnterpriseServerUserAccount!)

    The user account to which the email belongs.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseServerUserAccountEmailConnection\n

    \n

    The connection type for EnterpriseServerUserAccountEmail.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([EnterpriseServerUserAccountEmailEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([EnterpriseServerUserAccountEmail])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseServerUserAccountEmailEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (EnterpriseServerUserAccountEmail)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseServerUserAccountsUpload\n

    \n

    A user accounts upload from an Enterprise Server installation.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterprise (Enterprise!)

    The enterprise to which this upload belongs.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseServerInstallation (EnterpriseServerInstallation!)

    The Enterprise Server installation for which this upload was generated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The name of the file uploaded.

    \n\n\n\n\n\n\n\n\n\n\n\n

    syncState (EnterpriseServerUserAccountsUploadSyncState!)

    The synchronization state of the upload.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseServerUserAccountsUploadConnection\n

    \n

    The connection type for EnterpriseServerUserAccountsUpload.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([EnterpriseServerUserAccountsUploadEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([EnterpriseServerUserAccountsUpload])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseServerUserAccountsUploadEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (EnterpriseServerUserAccountsUpload)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseUserAccount\n

    \n

    An account for a user who is an admin of an enterprise or a member of an enterprise through one or more organizations.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    avatarUrl (URI!)

    A URL pointing to the enterprise user account's public avatar.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    size (Int)

    \n

    The size of the resulting square image.

    \n\n
    \n\n
    \n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterprise (Enterprise!)

    The enterprise in which this user account exists.

    \n\n\n\n\n\n\n\n\n\n\n\n

    login (String!)

    An identifier for the enterprise user account, a login or email address.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String)

    The name of the enterprise user account.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizations (EnterpriseOrganizationMembershipConnection!)

    A list of enterprise organizations this user is a member of.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (OrganizationOrder)

    \n

    Ordering options for organizations returned from the connection.

    \n\n
    \n\n
    \n

    query (String)

    \n

    The search string to look for.

    \n\n
    \n\n
    \n

    role (EnterpriseUserAccountMembershipRole)

    \n

    The role of the user in the enterprise organization.

    \n\n
    \n\n
    \n\n\n

    resourcePath (URI!)

    The HTTP path for this user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user within the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseUserAccountConnection\n

    \n

    The connection type for EnterpriseUserAccount.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([EnterpriseUserAccountEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([EnterpriseUserAccount])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseUserAccountEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (EnterpriseUserAccount)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ExternalIdentity\n

    \n

    An external identity provisioned by SAML SSO or SCIM.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    guid (String!)

    The GUID for this identity.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationInvitation (OrganizationInvitation)

    Organization invitation for this SCIM-provisioned external identity.

    \n\n\n\n\n\n\n\n\n\n\n\n

    samlIdentity (ExternalIdentitySamlAttributes)

    SAML Identity attributes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    scimIdentity (ExternalIdentityScimAttributes)

    SCIM Identity attributes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    User linked to this external identity. Will be NULL if this identity has not been claimed by an organization member.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ExternalIdentityConnection\n

    \n

    The connection type for ExternalIdentity.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([ExternalIdentityEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([ExternalIdentity])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ExternalIdentityEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (ExternalIdentity)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ExternalIdentitySamlAttributes\n

    \n

    SAML attributes for the External Identity.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    emails ([UserEmailMetadata!])

    The emails associated with the SAML identity.

    \n\n\n\n\n\n\n\n\n\n\n\n

    familyName (String)

    Family name of the SAML identity.

    \n\n\n\n\n\n\n\n\n\n\n\n

    givenName (String)

    Given name of the SAML identity.

    \n\n\n\n\n\n\n\n\n\n\n\n

    groups ([String!])

    The groups linked to this identity in IDP.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nameId (String)

    The NameID of the SAML identity.

    \n\n\n\n\n\n\n\n\n\n\n\n

    username (String)

    The userName of the SAML identity.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ExternalIdentityScimAttributes\n

    \n

    SCIM attributes for the External Identity.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    emails ([UserEmailMetadata!])

    The emails associated with the SCIM identity.

    \n\n\n\n\n\n\n\n\n\n\n\n

    familyName (String)

    Family name of the SCIM identity.

    \n\n\n\n\n\n\n\n\n\n\n\n

    givenName (String)

    Given name of the SCIM identity.

    \n\n\n\n\n\n\n\n\n\n\n\n

    groups ([String!])

    The groups linked to this identity in IDP.

    \n\n\n\n\n\n\n\n\n\n\n\n

    username (String)

    The userName of the SCIM identity.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n FollowerConnection\n

    \n

    The connection type for User.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([UserEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([User])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n FollowingConnection\n

    \n

    The connection type for User.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([UserEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([User])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n GenericHovercardContext\n

    \n

    A generic hovercard context with a message and icon.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    message (String!)

    A string describing this context.

    \n\n\n\n\n\n\n\n\n\n\n\n

    octicon (String!)

    An octicon to accompany this context.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Gist\n

    \n

    A Gist.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    comments (GistCommentConnection!)

    A list of comments associated with the gist.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String)

    The gist description.

    \n\n\n\n\n\n\n\n\n\n\n\n

    files ([GistFile])

    The files in this gist.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    limit (Int)

    \n

    The maximum number of files to return.

    \n

    The default value is 10.

    \n
    \n\n
    \n

    oid (GitObjectID)

    \n

    The oid of the files to return.

    \n\n
    \n\n
    \n\n\n

    forks (GistConnection!)

    A list of forks associated with the gist.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (GistOrder)

    \n

    Ordering options for gists returned from the connection.

    \n\n
    \n\n
    \n\n\n

    isFork (Boolean!)

    Identifies if the gist is a fork.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isPublic (Boolean!)

    Whether the gist is public or not.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The gist name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    owner (RepositoryOwner)

    The gist owner.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pushedAt (DateTime)

    Identifies when the gist was last pushed to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTML path to this resource.

    \n\n\n\n\n\n\n\n\n\n\n\n

    stargazerCount (Int!)

    Returns a count of how many stargazers there are on this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    stargazers (StargazerConnection!)

    A list of users who have starred this starrable.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (StarOrder)

    \n

    Order for connection.

    \n\n
    \n\n
    \n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this Gist.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerHasStarred (Boolean!)

    Returns a boolean indicating whether the viewing user has starred this starrable.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n GistComment\n

    \n

    Represents a comment on an Gist.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    author (Actor)

    The actor who authored the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    authorAssociation (CommentAuthorAssociation!)

    Author's association with the gist.

    \n\n\n\n\n\n\n\n\n\n\n\n

    body (String!)

    Identifies the comment body.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyHTML (HTML!)

    The body rendered to HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyText (String!)

    The body rendered to text.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdViaEmail (Boolean!)

    Check if this comment was created via an email reply.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    editor (Actor)

    The actor who edited the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    gist (Gist!)

    The associated gist.

    \n\n\n\n\n\n\n\n\n\n\n\n

    includesCreatedEdit (Boolean!)

    Check if this comment was edited and includes an edit with the creation data.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isMinimized (Boolean!)

    Returns whether or not a comment has been minimized.

    \n\n\n\n\n\n\n\n\n\n\n\n

    lastEditedAt (DateTime)

    The moment the editor made the last edit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    minimizedReason (String)

    Returns why the comment was minimized.

    \n\n\n\n\n\n\n\n\n\n\n\n

    publishedAt (DateTime)

    Identifies when the comment was published at.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userContentEdits (UserContentEditConnection)

    A list of edits to this content.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    viewerCanDelete (Boolean!)

    Check if the current viewer can delete this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanMinimize (Boolean!)

    Check if the current viewer can minimize this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanUpdate (Boolean!)

    Check if the current viewer can update this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

    Reasons why the current viewer can not update this comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerDidAuthor (Boolean!)

    Did the viewer author this comment.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n GistCommentConnection\n

    \n

    The connection type for GistComment.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([GistCommentEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([GistComment])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n GistCommentEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (GistComment)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n GistConnection\n

    \n

    The connection type for Gist.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([GistEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Gist])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n GistEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (Gist)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n GistFile\n

    \n

    A file in a gist.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    encodedName (String)

    The file name encoded to remove characters that are invalid in URL paths.

    \n\n\n\n\n\n\n\n\n\n\n\n

    encoding (String)

    The gist file encoding.

    \n\n\n\n\n\n\n\n\n\n\n\n

    extension (String)

    The file extension from the file name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isImage (Boolean!)

    Indicates if this file is an image.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isTruncated (Boolean!)

    Whether the file's contents were truncated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    language (Language)

    The programming language this file is written in.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String)

    The gist file name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    size (Int)

    The gist file size in bytes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    text (String)

    UTF8 text data or null if the file is binary.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    truncate (Int)

    \n

    Optionally truncate the returned file to this length.

    \n\n
    \n\n
    \n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n GitActor\n

    \n

    Represents an actor in a Git commit (ie. an author or committer).

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    avatarUrl (URI!)

    A URL pointing to the author's public avatar.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    size (Int)

    \n

    The size of the resulting square image.

    \n\n
    \n\n
    \n\n\n

    date (GitTimestamp)

    The timestamp of the Git action (authoring or committing).

    \n\n\n\n\n\n\n\n\n\n\n\n

    email (String)

    The email in the Git commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String)

    The name in the Git commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The GitHub user corresponding to the email field. Null if no such user exists.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n GitActorConnection\n

    \n

    The connection type for GitActor.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([GitActorEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([GitActor])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n GitActorEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (GitActor)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n GitHubMetadata\n

    \n

    Represents information about the GitHub instance.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    gitHubServicesSha (GitObjectID!)

    Returns a String that's a SHA of github-services.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isPasswordAuthenticationVerifiable (Boolean!)

    Whether or not users are verified.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n GpgSignature\n

    \n

    Represents a GPG signature on a Commit or Tag.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    email (String!)

    Email used to sign this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isValid (Boolean!)

    True if the signature is valid and verified by GitHub.

    \n\n\n\n\n\n\n\n\n\n\n\n

    keyId (String)

    Hex-encoded ID of the key that signed this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    payload (String!)

    Payload for GPG signing object. Raw ODB object without the signature header.

    \n\n\n\n\n\n\n\n\n\n\n\n

    signature (String!)

    ASCII-armored signature header from object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    signer (User)

    GitHub user corresponding to the email signing this commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    state (GitSignatureState!)

    The state of this signature. VALID if signature is valid and verified by\nGitHub, otherwise represents reason why signature is considered invalid.

    \n\n\n\n\n\n\n\n\n\n\n\n

    wasSignedByGitHub (Boolean!)

    True if the signature was made with GitHub's signing key.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n HeadRefDeletedEvent\n

    \n

    Represents ahead_ref_deletedevent on a given pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    headRef (Ref)

    Identifies the Ref associated with the head_ref_deleted event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    headRefName (String!)

    Identifies the name of the Ref associated with the head_ref_deleted event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    PullRequest referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n HeadRefForcePushedEvent\n

    \n

    Represents ahead_ref_force_pushedevent on a given pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    afterCommit (Commit)

    Identifies the after commit SHA for thehead_ref_force_pushedevent.

    \n\n\n\n\n\n\n\n\n\n\n\n

    beforeCommit (Commit)

    Identifies the before commit SHA for thehead_ref_force_pushedevent.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    PullRequest referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ref (Ref)

    Identifies the fully qualified ref name for thehead_ref_force_pushedevent.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n HeadRefRestoredEvent\n

    \n

    Represents ahead_ref_restoredevent on a given pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    PullRequest referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Hovercard\n

    \n

    Detail needed to display a hovercard for a user.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    contexts ([HovercardContext!]!)

    Each of the contexts for this hovercard.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n IpAllowListEntry\n

    \n

    An IP address or range of addresses that is allowed to access an owner's resources.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    allowListValue (String!)

    A single IP address or range of IP addresses in CIDR notation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isActive (Boolean!)

    Whether the entry is currently active.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String)

    The name of the IP allow list entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    owner (IpAllowListOwner!)

    The owner of the IP allow list entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n IpAllowListEntryConnection\n

    \n

    The connection type for IpAllowListEntry.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([IpAllowListEntryEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([IpAllowListEntry])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n IpAllowListEntryEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (IpAllowListEntry)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Issue\n

    \n

    An Issue is a place to discuss ideas, enhancements, tasks, and bugs for a project.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    activeLockReason (LockReason)

    Reason that the conversation was locked.

    \n\n\n\n\n\n\n\n\n\n\n\n

    assignees (UserConnection!)

    A list of Users assigned to this object.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    author (Actor)

    The actor who authored the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    authorAssociation (CommentAuthorAssociation!)

    Author's association with the subject of the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    body (String!)

    Identifies the body of the issue.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyHTML (HTML!)

    The body rendered to HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyResourcePath (URI!)

    The http path for this issue body.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyText (String!)

    Identifies the body of the issue rendered to text.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyUrl (URI!)

    The http URL for this issue body.

    \n\n\n\n\n\n\n\n\n\n\n\n

    closed (Boolean!)

    true if the object is closed (definition of closed may depend on type).

    \n\n\n\n\n\n\n\n\n\n\n\n

    closedAt (DateTime)

    Identifies the date and time when the object was closed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    comments (IssueCommentConnection!)

    A list of comments associated with the Issue.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (IssueCommentOrder)

    \n

    Ordering options for issue comments returned from the connection.

    \n\n
    \n\n
    \n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdViaEmail (Boolean!)

    Check if this comment was created via an email reply.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    editor (Actor)

    The actor who edited the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hovercard (Hovercard!)

    The hovercard information for this issue.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    includeNotificationContexts (Boolean)

    \n

    Whether or not to include notification contexts.

    \n

    The default value is true.

    \n
    \n\n
    \n\n\n

    includesCreatedEdit (Boolean!)

    Check if this comment was edited and includes an edit with the creation data.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isPinned (Boolean)

    Indicates whether or not this issue is currently pinned to the repository issues list.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isReadByViewer (Boolean)

    Is this issue read by the viewer.

    \n\n\n\n\n\n\n\n\n\n\n\n

    labels (LabelConnection)

    A list of labels associated with the object.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (LabelOrder)

    \n

    Ordering options for labels returned from the connection.

    \n\n
    \n\n
    \n\n\n

    lastEditedAt (DateTime)

    The moment the editor made the last edit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    locked (Boolean!)

    true if the object is locked.

    \n\n\n\n\n\n\n\n\n\n\n\n

    milestone (Milestone)

    Identifies the milestone associated with the issue.

    \n\n\n\n\n\n\n\n\n\n\n\n

    number (Int!)

    Identifies the issue number.

    \n\n\n\n\n\n\n\n\n\n\n\n

    participants (UserConnection!)

    A list of Users that are participating in the Issue conversation.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    projectCards (ProjectCardConnection!)

    List of project cards associated with this issue.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    archivedStates ([ProjectCardArchivedState])

    \n

    A list of archived states to filter the cards by.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    publishedAt (DateTime)

    Identifies when the comment was published at.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reactionGroups ([ReactionGroup!])

    A list of reactions grouped by content left on the subject.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reactions (ReactionConnection!)

    A list of Reactions left on the Issue.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    content (ReactionContent)

    \n

    Allows filtering Reactions by emoji.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (ReactionOrder)

    \n

    Allows specifying the order in which reactions are returned.

    \n\n
    \n\n
    \n\n\n

    repository (Repository!)

    The repository associated with this node.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this issue.

    \n\n\n\n\n\n\n\n\n\n\n\n

    state (IssueState!)

    Identifies the state of the issue.

    \n\n\n\n\n\n\n\n\n\n\n\n

    timeline (IssueTimelineConnection!)

    A list of events, comments, commits, etc. associated with the issue.

    \n\n\n\n\n\n\n
    \n

    Deprecation notice

    \n

    timeline is deprecated.

    timeline will be removed Use Issue.timelineItems instead. Removal on 2020-10-01 UTC.

    \n
    \n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    since (DateTime)

    \n

    Allows filtering timeline events by a since timestamp.

    \n\n
    \n\n
    \n\n\n

    timelineItems (IssueTimelineItemsConnection!)

    A list of events, comments, commits, etc. associated with the issue.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    itemTypes ([IssueTimelineItemsItemType!])

    \n

    Filter timeline items by type.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    since (DateTime)

    \n

    Filter timeline items by a since timestamp.

    \n\n
    \n\n
    \n

    skip (Int)

    \n

    Skips the first n elements in the list.

    \n\n
    \n\n
    \n\n\n

    title (String!)

    Identifies the issue title.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this issue.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userContentEdits (UserContentEditConnection)

    A list of edits to this content.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    viewerCanReact (Boolean!)

    Can user react to this subject.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanSubscribe (Boolean!)

    Check if the viewer is able to change their subscription status for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanUpdate (Boolean!)

    Check if the current viewer can update this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

    Reasons why the current viewer can not update this comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerDidAuthor (Boolean!)

    Did the viewer author this comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerSubscription (SubscriptionState)

    Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n IssueComment\n

    \n

    Represents a comment on an Issue.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    author (Actor)

    The actor who authored the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    authorAssociation (CommentAuthorAssociation!)

    Author's association with the subject of the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    body (String!)

    The body as Markdown.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyHTML (HTML!)

    The body rendered to HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyText (String!)

    The body rendered to text.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdViaEmail (Boolean!)

    Check if this comment was created via an email reply.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    editor (Actor)

    The actor who edited the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    includesCreatedEdit (Boolean!)

    Check if this comment was edited and includes an edit with the creation data.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isMinimized (Boolean!)

    Returns whether or not a comment has been minimized.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issue (Issue!)

    Identifies the issue associated with the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    lastEditedAt (DateTime)

    The moment the editor made the last edit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    minimizedReason (String)

    Returns why the comment was minimized.

    \n\n\n\n\n\n\n\n\n\n\n\n

    publishedAt (DateTime)

    Identifies when the comment was published at.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest)

    Returns the pull request associated with the comment, if this comment was made on a\npull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reactionGroups ([ReactionGroup!])

    A list of reactions grouped by content left on the subject.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reactions (ReactionConnection!)

    A list of Reactions left on the Issue.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    content (ReactionContent)

    \n

    Allows filtering Reactions by emoji.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (ReactionOrder)

    \n

    Allows specifying the order in which reactions are returned.

    \n\n
    \n\n
    \n\n\n

    repository (Repository!)

    The repository associated with this node.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this issue comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this issue comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userContentEdits (UserContentEditConnection)

    A list of edits to this content.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    viewerCanDelete (Boolean!)

    Check if the current viewer can delete this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanMinimize (Boolean!)

    Check if the current viewer can minimize this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanReact (Boolean!)

    Can user react to this subject.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanUpdate (Boolean!)

    Check if the current viewer can update this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

    Reasons why the current viewer can not update this comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerDidAuthor (Boolean!)

    Did the viewer author this comment.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n IssueCommentConnection\n

    \n

    The connection type for IssueComment.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([IssueCommentEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([IssueComment])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n IssueCommentEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (IssueComment)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n IssueConnection\n

    \n

    The connection type for Issue.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([IssueEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Issue])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n IssueContributionsByRepository\n

    \n

    This aggregates issues opened by a user within one repository.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    contributions (CreatedIssueContributionConnection!)

    The issue contributions.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (ContributionOrder)

    \n

    Ordering options for contributions returned from the connection.

    \n\n
    \n\n
    \n\n\n

    repository (Repository!)

    The repository in which the issues were opened.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n IssueEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (Issue)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n IssueTemplate\n

    \n

    A repository issue template.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    about (String)

    The template purpose.

    \n\n\n\n\n\n\n\n\n\n\n\n

    body (String)

    The suggested issue body.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The template name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    title (String)

    The suggested issue title.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n IssueTimelineConnection\n

    \n

    The connection type for IssueTimelineItem.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([IssueTimelineItemEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([IssueTimelineItem])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n IssueTimelineItemEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (IssueTimelineItem)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n IssueTimelineItemsConnection\n

    \n

    The connection type for IssueTimelineItems.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([IssueTimelineItemsEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    filteredCount (Int!)

    Identifies the count of items after applying before and after filters.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([IssueTimelineItems])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageCount (Int!)

    Identifies the count of items after applying before/after filters and first/last/skip slicing.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the timeline was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n IssueTimelineItemsEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (IssueTimelineItems)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n JoinedGitHubContribution\n

    \n

    Represents a user signing up for a GitHub account.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    isRestricted (Boolean!)

    Whether this contribution is associated with a record you do not have access to. For\nexample, your own 'first issue' contribution may have been made on a repository you can no\nlonger access.

    \n\n\n\n\n\n\n\n\n\n\n\n

    occurredAt (DateTime!)

    When this contribution was made.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User!)

    The user who made this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Label\n

    \n

    A label for categorizing Issues or Milestones with a given Repository.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    color (String!)

    Identifies the label color.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime)

    Identifies the date and time when the label was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String)

    A brief description of this label.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isDefault (Boolean!)

    Indicates whether or not this is a default label.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issues (IssueConnection!)

    A list of issues associated with this label.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    filterBy (IssueFilters)

    \n

    Filtering options for issues returned from the connection.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    labels ([String!])

    \n

    A list of label names to filter the pull requests by.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (IssueOrder)

    \n

    Ordering options for issues returned from the connection.

    \n\n
    \n\n
    \n

    states ([IssueState!])

    \n

    A list of states to filter the issues by.

    \n\n
    \n\n
    \n\n\n

    name (String!)

    Identifies the label name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequests (PullRequestConnection!)

    A list of pull requests associated with this label.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    baseRefName (String)

    \n

    The base ref name to filter the pull requests by.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    headRefName (String)

    \n

    The head ref name to filter the pull requests by.

    \n\n
    \n\n
    \n

    labels ([String!])

    \n

    A list of label names to filter the pull requests by.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (IssueOrder)

    \n

    Ordering options for pull requests returned from the connection.

    \n\n
    \n\n
    \n

    states ([PullRequestState!])

    \n

    A list of states to filter the pull requests by.

    \n\n
    \n\n
    \n\n\n

    repository (Repository!)

    The repository associated with this label.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this label.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime)

    Identifies the date and time when the label was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this label.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n LabelConnection\n

    \n

    The connection type for Label.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([LabelEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Label])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n LabelEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (Label)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n LabeledEvent\n

    \n

    Represents alabeledevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    label (Label!)

    Identifies the label associated with thelabeledevent.

    \n\n\n\n\n\n\n\n\n\n\n\n

    labelable (Labelable!)

    Identifies the Labelable associated with the event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Language\n

    \n

    Represents a given language found in repositories.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    color (String)

    The color defined for the current language.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The name of the current language.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n LanguageConnection\n

    \n

    A list of languages associated with the parent.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([LanguageEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Language])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalSize (Int!)

    The total size in bytes of files written in that language.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n LanguageEdge\n

    \n

    Represents the language of a repository.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    size (Int!)

    The number of bytes of code written in the language.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n License\n

    \n

    A repository's open source license.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String!)

    The full text of the license.

    \n\n\n\n\n\n\n\n\n\n\n\n

    conditions ([LicenseRule]!)

    The conditions set by the license.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String)

    A human-readable description of the license.

    \n\n\n\n\n\n\n\n\n\n\n\n

    featured (Boolean!)

    Whether the license should be featured.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hidden (Boolean!)

    Whether the license should be displayed in license pickers.

    \n\n\n\n\n\n\n\n\n\n\n\n

    implementation (String)

    Instructions on how to implement the license.

    \n\n\n\n\n\n\n\n\n\n\n\n

    key (String!)

    The lowercased SPDX ID of the license.

    \n\n\n\n\n\n\n\n\n\n\n\n

    limitations ([LicenseRule]!)

    The limitations set by the license.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The license full name specified by https://spdx.org/licenses.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nickname (String)

    Customary short name if applicable (e.g, GPLv3).

    \n\n\n\n\n\n\n\n\n\n\n\n

    permissions ([LicenseRule]!)

    The permissions set by the license.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pseudoLicense (Boolean!)

    Whether the license is a pseudo-license placeholder (e.g., other, no-license).

    \n\n\n\n\n\n\n\n\n\n\n\n

    spdxId (String)

    Short identifier specified by https://spdx.org/licenses.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI)

    URL to the license on https://choosealicense.com.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n LicenseRule\n

    \n

    Describes a License's conditions, permissions, and limitations.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    description (String!)

    A description of the rule.

    \n\n\n\n\n\n\n\n\n\n\n\n

    key (String!)

    The machine-readable rule key.

    \n\n\n\n\n\n\n\n\n\n\n\n

    label (String!)

    The human-readable rule label.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n LockedEvent\n

    \n

    Represents alockedevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    lockReason (LockReason)

    Reason that the conversation was locked (optional).

    \n\n\n\n\n\n\n\n\n\n\n\n

    lockable (Lockable!)

    Object that was locked.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Mannequin\n

    \n

    A placeholder user for attribution of imported data on GitHub.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    avatarUrl (URI!)

    A URL pointing to the GitHub App's public avatar.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    size (Int)

    \n

    The size of the resulting square image.

    \n\n
    \n\n
    \n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    email (String)

    The mannequin's email on the source instance.

    \n\n\n\n\n\n\n\n\n\n\n\n

    login (String!)

    The username of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTML path to this resource.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The URL to this resource.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n MarkedAsDuplicateEvent\n

    \n

    Represents amarked_as_duplicateevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    canonical (IssueOrPullRequest)

    The authoritative issue or pull request which has been duplicated by another.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    duplicate (IssueOrPullRequest)

    The issue or pull request which has been marked as a duplicate of another.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isCrossRepository (Boolean!)

    Canonical and duplicate belong to different repositories.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n MembersCanDeleteReposClearAuditEntry\n

    \n

    Audit log entry for a members_can_delete_repos.clear event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseResourcePath (URI)

    The HTTP path for this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseSlug (String)

    The slug of the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseUrl (URI)

    The HTTP URL for this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n MembersCanDeleteReposDisableAuditEntry\n

    \n

    Audit log entry for a members_can_delete_repos.disable event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseResourcePath (URI)

    The HTTP path for this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseSlug (String)

    The slug of the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseUrl (URI)

    The HTTP URL for this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n MembersCanDeleteReposEnableAuditEntry\n

    \n

    Audit log entry for a members_can_delete_repos.enable event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseResourcePath (URI)

    The HTTP path for this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseSlug (String)

    The slug of the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseUrl (URI)

    The HTTP URL for this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n MentionedEvent\n

    \n

    Represents amentionedevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n MergedEvent\n

    \n

    Represents amergedevent on a given pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commit (Commit)

    Identifies the commit associated with the merge event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    mergeRef (Ref)

    Identifies the Ref associated with the merge event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    mergeRefName (String!)

    Identifies the name of the Ref associated with the merge event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    PullRequest referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this merged event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this merged event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Milestone\n

    \n

    Represents a Milestone object on a given repository.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    closed (Boolean!)

    true if the object is closed (definition of closed may depend on type).

    \n\n\n\n\n\n\n\n\n\n\n\n

    closedAt (DateTime)

    Identifies the date and time when the object was closed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    creator (Actor)

    Identifies the actor who created the milestone.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String)

    Identifies the description of the milestone.

    \n\n\n\n\n\n\n\n\n\n\n\n

    dueOn (DateTime)

    Identifies the due date of the milestone.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issues (IssueConnection!)

    A list of issues associated with the milestone.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    filterBy (IssueFilters)

    \n

    Filtering options for issues returned from the connection.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    labels ([String!])

    \n

    A list of label names to filter the pull requests by.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (IssueOrder)

    \n

    Ordering options for issues returned from the connection.

    \n\n
    \n\n
    \n

    states ([IssueState!])

    \n

    A list of states to filter the issues by.

    \n\n
    \n\n
    \n\n\n

    number (Int!)

    Identifies the number of the milestone.

    \n\n\n\n\n\n\n\n\n\n\n\n

    progressPercentage (Float!)

    Identifies the percentage complete for the milestone.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequests (PullRequestConnection!)

    A list of pull requests associated with the milestone.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    baseRefName (String)

    \n

    The base ref name to filter the pull requests by.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    headRefName (String)

    \n

    The head ref name to filter the pull requests by.

    \n\n
    \n\n
    \n

    labels ([String!])

    \n

    A list of label names to filter the pull requests by.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (IssueOrder)

    \n

    Ordering options for pull requests returned from the connection.

    \n\n
    \n\n
    \n

    states ([PullRequestState!])

    \n

    A list of states to filter the pull requests by.

    \n\n
    \n\n
    \n\n\n

    repository (Repository!)

    The repository associated with this milestone.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this milestone.

    \n\n\n\n\n\n\n\n\n\n\n\n

    state (MilestoneState!)

    Identifies the state of the milestone.

    \n\n\n\n\n\n\n\n\n\n\n\n

    title (String!)

    Identifies the title of the milestone.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this milestone.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n MilestoneConnection\n

    \n

    The connection type for Milestone.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([MilestoneEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Milestone])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n MilestoneEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (Milestone)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n MilestonedEvent\n

    \n

    Represents amilestonedevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    milestoneTitle (String!)

    Identifies the milestone title associated with themilestonedevent.

    \n\n\n\n\n\n\n\n\n\n\n\n

    subject (MilestoneItem!)

    Object referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n MovedColumnsInProjectEvent\n

    \n

    Represents amoved_columns_in_projectevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    previousProjectColumnName (String!)

    Column name the issue or pull request was moved from.

    \n\n\n\n\n
    \n

    Preview notice

    \n

    previousProjectColumnName is available under the Project event details preview. During the preview period, the API may change without notice.

    \n
    \n\n\n\n\n\n\n\n\n

    project (Project)

    Project referenced by event.

    \n\n\n\n\n
    \n

    Preview notice

    \n

    project is available under the Project event details preview. During the preview period, the API may change without notice.

    \n
    \n\n\n\n\n\n\n\n\n

    projectCard (ProjectCard)

    Project card referenced by this project event.

    \n\n\n\n\n
    \n

    Preview notice

    \n

    projectCard is available under the Project event details preview. During the preview period, the API may change without notice.

    \n
    \n\n\n\n\n\n\n\n\n

    projectColumnName (String!)

    Column name the issue or pull request was moved to.

    \n\n\n\n\n
    \n

    Preview notice

    \n

    projectColumnName is available under the Project event details preview. During the preview period, the API may change without notice.

    \n
    \n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OauthApplicationCreateAuditEntry\n

    \n

    Audit log entry for a oauth_application.create event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    applicationUrl (URI)

    The application URL of the OAuth Application.

    \n\n\n\n\n\n\n\n\n\n\n\n

    callbackUrl (URI)

    The callback URL of the OAuth Application.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    oauthApplicationName (String)

    The name of the OAuth Application.

    \n\n\n\n\n\n\n\n\n\n\n\n

    oauthApplicationResourcePath (URI)

    The HTTP path for the OAuth Application.

    \n\n\n\n\n\n\n\n\n\n\n\n

    oauthApplicationUrl (URI)

    The HTTP URL for the OAuth Application.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    rateLimit (Int)

    The rate limit of the OAuth Application.

    \n\n\n\n\n\n\n\n\n\n\n\n

    state (OauthApplicationCreateAuditEntryState)

    The state of the OAuth Application.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgAddBillingManagerAuditEntry\n

    \n

    Audit log entry for a org.add_billing_manager.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    invitationEmail (String)

    The email address used to invite a billing manager for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgAddMemberAuditEntry\n

    \n

    Audit log entry for a org.add_member.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    permission (OrgAddMemberAuditEntryPermission)

    The permission level of the member added to the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgBlockUserAuditEntry\n

    \n

    Audit log entry for a org.block_user.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    blockedUser (User)

    The blocked user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    blockedUserName (String)

    The username of the blocked user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    blockedUserResourcePath (URI)

    The HTTP path for the blocked user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    blockedUserUrl (URI)

    The HTTP URL for the blocked user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgConfigDisableCollaboratorsOnlyAuditEntry\n

    \n

    Audit log entry for a org.config.disable_collaborators_only event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgConfigEnableCollaboratorsOnlyAuditEntry\n

    \n

    Audit log entry for a org.config.enable_collaborators_only event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgCreateAuditEntry\n

    \n

    Audit log entry for a org.create event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    billingPlan (OrgCreateAuditEntryBillingPlan)

    The billing plan for the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgDisableOauthAppRestrictionsAuditEntry\n

    \n

    Audit log entry for a org.disable_oauth_app_restrictions event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgDisableSamlAuditEntry\n

    \n

    Audit log entry for a org.disable_saml event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    digestMethodUrl (URI)

    The SAML provider's digest algorithm URL.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issuerUrl (URI)

    The SAML provider's issuer URL.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    signatureMethodUrl (URI)

    The SAML provider's signature algorithm URL.

    \n\n\n\n\n\n\n\n\n\n\n\n

    singleSignOnUrl (URI)

    The SAML provider's single sign-on URL.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgDisableTwoFactorRequirementAuditEntry\n

    \n

    Audit log entry for a org.disable_two_factor_requirement event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgEnableOauthAppRestrictionsAuditEntry\n

    \n

    Audit log entry for a org.enable_oauth_app_restrictions event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgEnableSamlAuditEntry\n

    \n

    Audit log entry for a org.enable_saml event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    digestMethodUrl (URI)

    The SAML provider's digest algorithm URL.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issuerUrl (URI)

    The SAML provider's issuer URL.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    signatureMethodUrl (URI)

    The SAML provider's signature algorithm URL.

    \n\n\n\n\n\n\n\n\n\n\n\n

    singleSignOnUrl (URI)

    The SAML provider's single sign-on URL.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgEnableTwoFactorRequirementAuditEntry\n

    \n

    Audit log entry for a org.enable_two_factor_requirement event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgInviteMemberAuditEntry\n

    \n

    Audit log entry for a org.invite_member event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    email (String)

    The email address of the organization invitation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationInvitation (OrganizationInvitation)

    The organization invitation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgInviteToBusinessAuditEntry\n

    \n

    Audit log entry for a org.invite_to_business event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseResourcePath (URI)

    The HTTP path for this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseSlug (String)

    The slug of the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseUrl (URI)

    The HTTP URL for this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgOauthAppAccessApprovedAuditEntry\n

    \n

    Audit log entry for a org.oauth_app_access_approved event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    oauthApplicationName (String)

    The name of the OAuth Application.

    \n\n\n\n\n\n\n\n\n\n\n\n

    oauthApplicationResourcePath (URI)

    The HTTP path for the OAuth Application.

    \n\n\n\n\n\n\n\n\n\n\n\n

    oauthApplicationUrl (URI)

    The HTTP URL for the OAuth Application.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgOauthAppAccessDeniedAuditEntry\n

    \n

    Audit log entry for a org.oauth_app_access_denied event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    oauthApplicationName (String)

    The name of the OAuth Application.

    \n\n\n\n\n\n\n\n\n\n\n\n

    oauthApplicationResourcePath (URI)

    The HTTP path for the OAuth Application.

    \n\n\n\n\n\n\n\n\n\n\n\n

    oauthApplicationUrl (URI)

    The HTTP URL for the OAuth Application.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgOauthAppAccessRequestedAuditEntry\n

    \n

    Audit log entry for a org.oauth_app_access_requested event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    oauthApplicationName (String)

    The name of the OAuth Application.

    \n\n\n\n\n\n\n\n\n\n\n\n

    oauthApplicationResourcePath (URI)

    The HTTP path for the OAuth Application.

    \n\n\n\n\n\n\n\n\n\n\n\n

    oauthApplicationUrl (URI)

    The HTTP URL for the OAuth Application.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgRemoveBillingManagerAuditEntry\n

    \n

    Audit log entry for a org.remove_billing_manager event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reason (OrgRemoveBillingManagerAuditEntryReason)

    The reason for the billing manager being removed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgRemoveMemberAuditEntry\n

    \n

    Audit log entry for a org.remove_member event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    membershipTypes ([OrgRemoveMemberAuditEntryMembershipType!])

    The types of membership the member has with the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reason (OrgRemoveMemberAuditEntryReason)

    The reason for the member being removed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgRemoveOutsideCollaboratorAuditEntry\n

    \n

    Audit log entry for a org.remove_outside_collaborator event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    membershipTypes ([OrgRemoveOutsideCollaboratorAuditEntryMembershipType!])

    The types of membership the outside collaborator has with the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reason (OrgRemoveOutsideCollaboratorAuditEntryReason)

    The reason for the outside collaborator being removed from the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgRestoreMemberAuditEntry\n

    \n

    Audit log entry for a org.restore_member event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    restoredCustomEmailRoutingsCount (Int)

    The number of custom email routings for the restored member.

    \n\n\n\n\n\n\n\n\n\n\n\n

    restoredIssueAssignmentsCount (Int)

    The number of issue assignments for the restored member.

    \n\n\n\n\n\n\n\n\n\n\n\n

    restoredMemberships ([OrgRestoreMemberAuditEntryMembership!])

    Restored organization membership objects.

    \n\n\n\n\n\n\n\n\n\n\n\n

    restoredMembershipsCount (Int)

    The number of restored memberships.

    \n\n\n\n\n\n\n\n\n\n\n\n

    restoredRepositoriesCount (Int)

    The number of repositories of the restored member.

    \n\n\n\n\n\n\n\n\n\n\n\n

    restoredRepositoryStarsCount (Int)

    The number of starred repositories for the restored member.

    \n\n\n\n\n\n\n\n\n\n\n\n

    restoredRepositoryWatchesCount (Int)

    The number of watched repositories for the restored member.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgRestoreMemberMembershipOrganizationAuditEntryData\n

    \n

    Metadata for an organization membership for org.restore_member actions.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgRestoreMemberMembershipRepositoryAuditEntryData\n

    \n

    Metadata for a repository membership for org.restore_member actions.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgRestoreMemberMembershipTeamAuditEntryData\n

    \n

    Metadata for a team membership for org.restore_member actions.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    team (Team)

    The team associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamName (String)

    The name of the team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamResourcePath (URI)

    The HTTP path for this team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamUrl (URI)

    The HTTP URL for this team.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgUnblockUserAuditEntry\n

    \n

    Audit log entry for a org.unblock_user.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    blockedUser (User)

    The user being unblocked by the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    blockedUserName (String)

    The username of the blocked user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    blockedUserResourcePath (URI)

    The HTTP path for the blocked user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    blockedUserUrl (URI)

    The HTTP URL for the blocked user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgUpdateDefaultRepositoryPermissionAuditEntry\n

    \n

    Audit log entry for a org.update_default_repository_permission.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    permission (OrgUpdateDefaultRepositoryPermissionAuditEntryPermission)

    The new default repository permission level for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    permissionWas (OrgUpdateDefaultRepositoryPermissionAuditEntryPermission)

    The former default repository permission level for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgUpdateMemberAuditEntry\n

    \n

    Audit log entry for a org.update_member event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    permission (OrgUpdateMemberAuditEntryPermission)

    The new member permission level for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    permissionWas (OrgUpdateMemberAuditEntryPermission)

    The former member permission level for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgUpdateMemberRepositoryCreationPermissionAuditEntry\n

    \n

    Audit log entry for a org.update_member_repository_creation_permission event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    canCreateRepositories (Boolean)

    Can members create repositories in the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    visibility (OrgUpdateMemberRepositoryCreationPermissionAuditEntryVisibility)

    The permission for visibility level of repositories for this organization.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrgUpdateMemberRepositoryInvitationPermissionAuditEntry\n

    \n

    Audit log entry for a org.update_member_repository_invitation_permission event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    canInviteOutsideCollaboratorsToRepositories (Boolean)

    Can outside collaborators be invited to repositories in the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Organization\n

    \n

    An account on GitHub, with one or more owners, that has repositories, members and teams.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    anyPinnableItems (Boolean!)

    Determine if this repository owner has any items that can be pinned to their profile.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    type (PinnableItemType)

    \n

    Filter to only a particular kind of pinnable item.

    \n\n
    \n\n
    \n\n\n

    auditLog (OrganizationAuditEntryConnection!)

    Audit log entries of the organization.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (AuditLogOrder)

    \n

    Ordering options for the returned audit log entries.

    \n\n
    \n\n
    \n

    query (String)

    \n

    The query string to filter audit entries.

    \n\n
    \n\n
    \n\n\n

    avatarUrl (URI!)

    A URL pointing to the organization's public avatar.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    size (Int)

    \n

    The size of the resulting square image.

    \n\n
    \n\n
    \n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String)

    The organization's public profile description.

    \n\n\n\n\n\n\n\n\n\n\n\n

    descriptionHTML (String)

    The organization's public profile description rendered to HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    domains (VerifiableDomainConnection)

    A list of domains owned by the organization.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    isVerified (Boolean)

    \n

    Filter by if the domain is verified.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (VerifiableDomainOrder)

    \n

    Ordering options for verifiable domains returned.

    \n\n
    \n\n
    \n\n\n

    email (String)

    The organization's public email.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ipAllowListEnabledSetting (IpAllowListEnabledSettingValue!)

    The setting value for whether the organization has an IP allow list enabled.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ipAllowListEntries (IpAllowListEntryConnection!)

    The IP addresses that are allowed to access resources owned by the organization.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (IpAllowListEntryOrder)

    \n

    Ordering options for IP allow list entries returned.

    \n\n
    \n\n
    \n\n\n

    isVerified (Boolean!)

    Whether the organization has verified its profile email and website.

    \n\n\n\n\n\n\n\n\n\n\n\n

    itemShowcase (ProfileItemShowcase!)

    Showcases a selection of repositories and gists that the profile owner has\neither curated or that have been selected automatically based on popularity.

    \n\n\n\n\n\n\n\n\n\n\n\n

    location (String)

    The organization's public profile location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    login (String!)

    The organization's login name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    memberStatuses (UserStatusConnection!)

    Get the status messages members of this entity have set that are either public or visible only to the organization.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (UserStatusOrder)

    \n

    Ordering options for user statuses returned from the connection.

    \n\n
    \n\n
    \n\n\n

    membersWithRole (OrganizationMemberConnection!)

    A list of users who are members of this organization.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    name (String)

    The organization's public profile name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    newTeamResourcePath (URI!)

    The HTTP path creating a new team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    newTeamUrl (URI!)

    The HTTP URL creating a new team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    notificationDeliveryRestrictionEnabledSetting (NotificationRestrictionSettingValue!)

    Indicates if email notification delivery for this organization is restricted to verified domains.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationBillingEmail (String)

    The billing email for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pendingMembers (UserConnection!)

    A list of users who have been invited to join this organization.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    pinnableItems (PinnableItemConnection!)

    A list of repositories and gists this profile owner can pin to their profile.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    types ([PinnableItemType!])

    \n

    Filter the types of pinnable items that are returned.

    \n\n
    \n\n
    \n\n\n

    pinnedItems (PinnableItemConnection!)

    A list of repositories and gists this profile owner has pinned to their profile.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    types ([PinnableItemType!])

    \n

    Filter the types of pinned items that are returned.

    \n\n
    \n\n
    \n\n\n

    pinnedItemsRemaining (Int!)

    Returns how many more items this profile owner can pin to their profile.

    \n\n\n\n\n\n\n\n\n\n\n\n

    project (Project)

    Find project by number.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    number (Int!)

    \n

    The project number to find.

    \n\n
    \n\n
    \n\n\n

    projects (ProjectConnection!)

    A list of projects under the owner.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (ProjectOrder)

    \n

    Ordering options for projects returned from the connection.

    \n\n
    \n\n
    \n

    search (String)

    \n

    Query to search projects by, currently only searching by name.

    \n\n
    \n\n
    \n

    states ([ProjectState!])

    \n

    A list of states to filter the projects by.

    \n\n
    \n\n
    \n\n\n

    projectsResourcePath (URI!)

    The HTTP path listing organization's projects.

    \n\n\n\n\n\n\n\n\n\n\n\n

    projectsUrl (URI!)

    The HTTP URL listing organization's projects.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositories (RepositoryConnection!)

    A list of repositories that the user owns.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    affiliations ([RepositoryAffiliation])

    \n

    Array of viewer's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\ncurrent viewer owns.

    \n\n
    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    isFork (Boolean)

    \n

    If non-null, filters repositories according to whether they are forks of another repository.

    \n\n
    \n\n
    \n

    isLocked (Boolean)

    \n

    If non-null, filters repositories according to whether they have been locked.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (RepositoryOrder)

    \n

    Ordering options for repositories returned from the connection.

    \n\n
    \n\n
    \n

    ownerAffiliations ([RepositoryAffiliation])

    \n

    Array of owner's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\norganization or user being viewed owns.

    \n\n
    \n\n
    \n

    privacy (RepositoryPrivacy)

    \n

    If non-null, filters repositories according to privacy.

    \n\n
    \n\n
    \n\n\n

    repository (Repository)

    Find Repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    name (String!)

    \n

    Name of Repository to find.

    \n\n
    \n\n
    \n\n\n

    requiresTwoFactorAuthentication (Boolean)

    When true the organization requires all members, billing managers, and outside\ncollaborators to enable two-factor authentication.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    samlIdentityProvider (OrganizationIdentityProvider)

    The Organization's SAML identity providers.

    \n\n\n\n\n\n\n\n\n\n\n\n

    sponsorshipsAsMaintainer (SponsorshipConnection!)

    This object's sponsorships as the maintainer.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    includePrivate (Boolean)

    \n

    Whether or not to include private sponsorships in the result set.

    \n

    The default value is false.

    \n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (SponsorshipOrder)

    \n

    Ordering options for sponsorships returned from this connection. If left\nblank, the sponsorships will be ordered based on relevancy to the viewer.

    \n\n
    \n\n
    \n\n\n

    sponsorshipsAsSponsor (SponsorshipConnection!)

    This object's sponsorships as the sponsor.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (SponsorshipOrder)

    \n

    Ordering options for sponsorships returned from this connection. If left\nblank, the sponsorships will be ordered based on relevancy to the viewer.

    \n\n
    \n\n
    \n\n\n

    team (Team)

    Find an organization's team by its slug.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    slug (String!)

    \n

    The name or slug of the team to find.

    \n\n
    \n\n
    \n\n\n

    teams (TeamConnection!)

    A list of teams in this organization.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    ldapMapped (Boolean)

    \n

    If true, filters teams that are mapped to an LDAP Group (Enterprise only).

    \n\n
    \n\n
    \n

    orderBy (TeamOrder)

    \n

    Ordering options for teams returned from the connection.

    \n\n
    \n\n
    \n

    privacy (TeamPrivacy)

    \n

    If non-null, filters teams according to privacy.

    \n\n
    \n\n
    \n

    query (String)

    \n

    If non-null, filters teams with query on team name and team slug.

    \n\n
    \n\n
    \n

    role (TeamRole)

    \n

    If non-null, filters teams according to whether the viewer is an admin or member on team.

    \n\n
    \n\n
    \n

    rootTeamsOnly (Boolean)

    \n

    If true, restrict to only root teams.

    \n

    The default value is false.

    \n
    \n\n
    \n

    userLogins ([String!])

    \n

    User logins to filter by.

    \n\n
    \n\n
    \n\n\n

    teamsResourcePath (URI!)

    The HTTP path listing organization's teams.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamsUrl (URI!)

    The HTTP URL listing organization's teams.

    \n\n\n\n\n\n\n\n\n\n\n\n

    twitterUsername (String)

    The organization's Twitter username.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanAdminister (Boolean!)

    Organization is adminable by the viewer.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanChangePinnedItems (Boolean!)

    Can the viewer pin repositories and gists to the profile?.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanCreateProjects (Boolean!)

    Can the current viewer create new projects on this owner.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanCreateRepositories (Boolean!)

    Viewer can create repositories on this organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanCreateTeams (Boolean!)

    Viewer can create teams on this organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerIsAMember (Boolean!)

    Viewer is an active member of this organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    websiteUrl (URI)

    The organization's public profile URL.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrganizationAuditEntryConnection\n

    \n

    The connection type for OrganizationAuditEntry.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([OrganizationAuditEntryEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([OrganizationAuditEntry])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrganizationAuditEntryEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (OrganizationAuditEntry)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrganizationConnection\n

    \n

    The connection type for Organization.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([OrganizationEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Organization])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrganizationEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (Organization)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrganizationIdentityProvider\n

    \n

    An Identity Provider configured to provision SAML and SCIM identities for Organizations.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    digestMethod (URI)

    The digest algorithm used to sign SAML requests for the Identity Provider.

    \n\n\n\n\n\n\n\n\n\n\n\n

    externalIdentities (ExternalIdentityConnection!)

    External Identities provisioned by this Identity Provider.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    idpCertificate (X509Certificate)

    The x509 certificate used by the Identity Provider to sign assertions and responses.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issuer (String)

    The Issuer Entity ID for the SAML Identity Provider.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    Organization this Identity Provider belongs to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    signatureMethod (URI)

    The signature algorithm used to sign SAML requests for the Identity Provider.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ssoUrl (URI)

    The URL endpoint for the Identity Provider's SAML SSO.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrganizationInvitation\n

    \n

    An Invitation for a user to an organization.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    email (String)

    The email address of the user invited to the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    invitationType (OrganizationInvitationType!)

    The type of invitation that was sent (e.g. email, user).

    \n\n\n\n\n\n\n\n\n\n\n\n

    invitee (User)

    The user who was invited to the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    inviter (User!)

    The user who created the invitation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization!)

    The organization the invite is for.

    \n\n\n\n\n\n\n\n\n\n\n\n

    role (OrganizationInvitationRole!)

    The user's pending role in the organization (e.g. member, owner).

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrganizationInvitationConnection\n

    \n

    The connection type for OrganizationInvitation.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([OrganizationInvitationEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([OrganizationInvitation])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrganizationInvitationEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (OrganizationInvitation)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrganizationMemberConnection\n

    \n

    The connection type for User.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([OrganizationMemberEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([User])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrganizationMemberEdge\n

    \n

    Represents a user within an organization.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hasTwoFactorEnabled (Boolean)

    Whether the organization member has two factor enabled or not. Returns null if information is not available to viewer.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (User)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n

    role (OrganizationMemberRole)

    The role this user has in the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrganizationTeamsHovercardContext\n

    \n

    An organization teams hovercard context.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    message (String!)

    A string describing this context.

    \n\n\n\n\n\n\n\n\n\n\n\n

    octicon (String!)

    An octicon to accompany this context.

    \n\n\n\n\n\n\n\n\n\n\n\n

    relevantTeams (TeamConnection!)

    Teams in this organization the user is a member of that are relevant.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    teamsResourcePath (URI!)

    The path for the full team list for this user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamsUrl (URI!)

    The URL for the full team list for this user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalTeamCount (Int!)

    The total number of teams the user is on in the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n OrganizationsHovercardContext\n

    \n

    An organization list hovercard context.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    message (String!)

    A string describing this context.

    \n\n\n\n\n\n\n\n\n\n\n\n

    octicon (String!)

    An octicon to accompany this context.

    \n\n\n\n\n\n\n\n\n\n\n\n

    relevantOrganizations (OrganizationConnection!)

    Organizations this user is a member of that are relevant.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    totalOrganizationCount (Int!)

    The total number of organizations this user is in.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PageInfo\n

    \n

    Information about pagination in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    endCursor (String)

    When paginating forwards, the cursor to continue.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hasNextPage (Boolean!)

    When paginating forwards, are there more items?.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hasPreviousPage (Boolean!)

    When paginating backwards, are there more items?.

    \n\n\n\n\n\n\n\n\n\n\n\n

    startCursor (String)

    When paginating backwards, the cursor to continue.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PermissionSource\n

    \n

    A level of permission and source for a user's access to a repository.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    organization (Organization!)

    The organization the repository belongs to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    permission (DefaultRepositoryPermissionField!)

    The level of access this source has granted to the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    source (PermissionGranter!)

    The source of this permission.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PinnableItemConnection\n

    \n

    The connection type for PinnableItem.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([PinnableItemEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([PinnableItem])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PinnableItemEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (PinnableItem)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PinnedEvent\n

    \n

    Represents apinnedevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issue (Issue!)

    Identifies the issue associated with the event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PinnedIssue\n

    \n

    A Pinned Issue is a issue pinned to a repository's index page.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issue (Issue!)

    The issue that was pinned.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pinnedBy (Actor!)

    The actor that pinned this issue.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository!)

    The repository that this issue was pinned to.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PinnedIssueConnection\n

    \n

    The connection type for PinnedIssue.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([PinnedIssueEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([PinnedIssue])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PinnedIssueEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (PinnedIssue)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PrivateRepositoryForkingDisableAuditEntry\n

    \n

    Audit log entry for a private_repository_forking.disable event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseResourcePath (URI)

    The HTTP path for this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseSlug (String)

    The slug of the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseUrl (URI)

    The HTTP URL for this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PrivateRepositoryForkingEnableAuditEntry\n

    \n

    Audit log entry for a private_repository_forking.enable event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseResourcePath (URI)

    The HTTP path for this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseSlug (String)

    The slug of the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseUrl (URI)

    The HTTP URL for this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ProfileItemShowcase\n

    \n

    A curatable list of repositories relating to a repository owner, which defaults\nto showing the most popular repositories they own.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    hasPinnedItems (Boolean!)

    Whether or not the owner has pinned any repositories or gists.

    \n\n\n\n\n\n\n\n\n\n\n\n

    items (PinnableItemConnection!)

    The repositories and gists in the showcase. If the profile owner has any\npinned items, those will be returned. Otherwise, the profile owner's popular\nrepositories will be returned.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Project\n

    \n

    Projects manage issues, pull requests and notes within a project owner.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String)

    The project's description body.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyHTML (HTML!)

    The projects description body rendered to HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    closed (Boolean!)

    true if the object is closed (definition of closed may depend on type).

    \n\n\n\n\n\n\n\n\n\n\n\n

    closedAt (DateTime)

    Identifies the date and time when the object was closed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    columns (ProjectColumnConnection!)

    List of columns in the project.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    creator (Actor)

    The actor who originally created the project.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The project's name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    number (Int!)

    The project's number.

    \n\n\n\n\n\n\n\n\n\n\n\n

    owner (ProjectOwner!)

    The project's owner. Currently limited to repositories, organizations, and users.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pendingCards (ProjectCardConnection!)

    List of pending cards in this project.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    archivedStates ([ProjectCardArchivedState])

    \n

    A list of archived states to filter the cards by.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    progress (ProjectProgress!)

    Project progress details.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this project.

    \n\n\n\n\n\n\n\n\n\n\n\n

    state (ProjectState!)

    Whether the project is open or closed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this project.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanUpdate (Boolean!)

    Check if the current viewer can update this object.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ProjectCard\n

    \n

    A card in a project.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    column (ProjectColumn)

    The project column this card is associated under. A card may only belong to one\nproject column at a time. The column field will be null if the card is created\nin a pending state and has yet to be associated with a column. Once cards are\nassociated with a column, they will not become pending in the future.

    \n\n\n\n\n\n\n\n\n\n\n\n

    content (ProjectCardItem)

    The card content item.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    creator (Actor)

    The actor who created this card.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isArchived (Boolean!)

    Whether the card is archived.

    \n\n\n\n\n\n\n\n\n\n\n\n

    note (String)

    The card note.

    \n\n\n\n\n\n\n\n\n\n\n\n

    project (Project!)

    The project that contains this card.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this card.

    \n\n\n\n\n\n\n\n\n\n\n\n

    state (ProjectCardState)

    The state of ProjectCard.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this card.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ProjectCardConnection\n

    \n

    The connection type for ProjectCard.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([ProjectCardEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([ProjectCard])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ProjectCardEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (ProjectCard)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ProjectColumn\n

    \n

    A column inside a project.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cards (ProjectCardConnection!)

    List of cards in the column.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    archivedStates ([ProjectCardArchivedState])

    \n

    A list of archived states to filter the cards by.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The project column's name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    project (Project!)

    The project that contains this column.

    \n\n\n\n\n\n\n\n\n\n\n\n

    purpose (ProjectColumnPurpose)

    The semantic purpose of the column.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this project column.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this project column.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ProjectColumnConnection\n

    \n

    The connection type for ProjectColumn.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([ProjectColumnEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([ProjectColumn])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ProjectColumnEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (ProjectColumn)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ProjectConnection\n

    \n

    A list of projects associated with the owner.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([ProjectEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Project])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ProjectEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (Project)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ProjectProgress\n

    \n

    Project progress stats.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    doneCount (Int!)

    The number of done cards.

    \n\n\n\n\n\n\n\n\n\n\n\n

    donePercentage (Float!)

    The percentage of done cards.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enabled (Boolean!)

    Whether progress tracking is enabled and cards with purpose exist for this project.

    \n\n\n\n\n\n\n\n\n\n\n\n

    inProgressCount (Int!)

    The number of in-progress cards.

    \n\n\n\n\n\n\n\n\n\n\n\n

    inProgressPercentage (Float!)

    The percentage of in-progress cards.

    \n\n\n\n\n\n\n\n\n\n\n\n

    todoCount (Int!)

    The number of to do cards.

    \n\n\n\n\n\n\n\n\n\n\n\n

    todoPercentage (Float!)

    The percentage of to do cards.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PublicKey\n

    \n

    A user's public key.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    accessedAt (DateTime)

    The last time this authorization was used to perform an action. Values will be null for keys not owned by the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime)

    Identifies the date and time when the key was created. Keys created before\nMarch 5th, 2014 have inaccurate values. Values will be null for keys not owned by the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    fingerprint (String!)

    The fingerprint for this PublicKey.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isReadOnly (Boolean)

    Whether this PublicKey is read-only or not. Values will be null for keys not owned by the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    key (String!)

    The public key string.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime)

    Identifies the date and time when the key was updated. Keys created before\nMarch 5th, 2014 may have inaccurate values. Values will be null for keys not\nowned by the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PublicKeyConnection\n

    \n

    The connection type for PublicKey.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([PublicKeyEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([PublicKey])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PublicKeyEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (PublicKey)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequest\n

    \n

    A repository pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    activeLockReason (LockReason)

    Reason that the conversation was locked.

    \n\n\n\n\n\n\n\n\n\n\n\n

    additions (Int!)

    The number of additions in this pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    assignees (UserConnection!)

    A list of Users assigned to this object.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    author (Actor)

    The actor who authored the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    authorAssociation (CommentAuthorAssociation!)

    Author's association with the subject of the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    autoMergeRequest (AutoMergeRequest)

    Returns the auto-merge request object if one exists for this pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    baseRef (Ref)

    Identifies the base Ref associated with the pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    baseRefName (String!)

    Identifies the name of the base Ref associated with the pull request, even if the ref has been deleted.

    \n\n\n\n\n\n\n\n\n\n\n\n

    baseRefOid (GitObjectID!)

    Identifies the oid of the base ref associated with the pull request, even if the ref has been deleted.

    \n\n\n\n\n\n\n\n\n\n\n\n

    baseRepository (Repository)

    The repository associated with this pull request's base Ref.

    \n\n\n\n\n\n\n\n\n\n\n\n

    body (String!)

    The body as Markdown.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyHTML (HTML!)

    The body rendered to HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyText (String!)

    The body rendered to text.

    \n\n\n\n\n\n\n\n\n\n\n\n

    canBeRebased (Boolean!)

    Whether or not the pull request is rebaseable.

    \n\n\n\n\n
    \n

    Preview notice

    \n

    canBeRebased is available under the Merge info preview. During the preview period, the API may change without notice.

    \n
    \n\n\n\n\n\n\n\n\n

    changedFiles (Int!)

    The number of changed files in this pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    checksResourcePath (URI!)

    The HTTP path for the checks of this pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    checksUrl (URI!)

    The HTTP URL for the checks of this pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    closed (Boolean!)

    true if the pull request is closed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    closedAt (DateTime)

    Identifies the date and time when the object was closed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    comments (IssueCommentConnection!)

    A list of comments associated with the pull request.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (IssueCommentOrder)

    \n

    Ordering options for issue comments returned from the connection.

    \n\n
    \n\n
    \n\n\n

    commits (PullRequestCommitConnection!)

    A list of commits present in this pull request's head branch not present in the base branch.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdViaEmail (Boolean!)

    Check if this comment was created via an email reply.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    deletions (Int!)

    The number of deletions in this pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    editor (Actor)

    The actor who edited this pull request's body.

    \n\n\n\n\n\n\n\n\n\n\n\n

    files (PullRequestChangedFileConnection)

    Lists the files changed within this pull request.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    headRef (Ref)

    Identifies the head Ref associated with the pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    headRefName (String!)

    Identifies the name of the head Ref associated with the pull request, even if the ref has been deleted.

    \n\n\n\n\n\n\n\n\n\n\n\n

    headRefOid (GitObjectID!)

    Identifies the oid of the head ref associated with the pull request, even if the ref has been deleted.

    \n\n\n\n\n\n\n\n\n\n\n\n

    headRepository (Repository)

    The repository associated with this pull request's head Ref.

    \n\n\n\n\n\n\n\n\n\n\n\n

    headRepositoryOwner (RepositoryOwner)

    The owner of the repository associated with this pull request's head Ref.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hovercard (Hovercard!)

    The hovercard information for this issue.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    includeNotificationContexts (Boolean)

    \n

    Whether or not to include notification contexts.

    \n

    The default value is true.

    \n
    \n\n
    \n\n\n

    includesCreatedEdit (Boolean!)

    Check if this comment was edited and includes an edit with the creation data.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isCrossRepository (Boolean!)

    The head and base repositories are different.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isDraft (Boolean!)

    Identifies if the pull request is a draft.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isReadByViewer (Boolean)

    Is this pull request read by the viewer.

    \n\n\n\n\n\n\n\n\n\n\n\n

    labels (LabelConnection)

    A list of labels associated with the object.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (LabelOrder)

    \n

    Ordering options for labels returned from the connection.

    \n\n
    \n\n
    \n\n\n

    lastEditedAt (DateTime)

    The moment the editor made the last edit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    latestOpinionatedReviews (PullRequestReviewConnection)

    A list of latest reviews per user associated with the pull request.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    writersOnly (Boolean)

    \n

    Only return reviews from user who have write access to the repository.

    \n

    The default value is false.

    \n
    \n\n
    \n\n\n

    latestReviews (PullRequestReviewConnection)

    A list of latest reviews per user associated with the pull request that are not also pending review.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    locked (Boolean!)

    true if the pull request is locked.

    \n\n\n\n\n\n\n\n\n\n\n\n

    maintainerCanModify (Boolean!)

    Indicates whether maintainers can modify the pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    mergeCommit (Commit)

    The commit that was created when this pull request was merged.

    \n\n\n\n\n\n\n\n\n\n\n\n

    mergeStateStatus (MergeStateStatus!)

    Detailed information about the current pull request merge state status.

    \n\n\n\n\n
    \n

    Preview notice

    \n

    mergeStateStatus is available under the Merge info preview. During the preview period, the API may change without notice.

    \n
    \n\n\n\n\n\n\n\n\n

    mergeable (MergeableState!)

    Whether or not the pull request can be merged based on the existence of merge conflicts.

    \n\n\n\n\n\n\n\n\n\n\n\n

    merged (Boolean!)

    Whether or not the pull request was merged.

    \n\n\n\n\n\n\n\n\n\n\n\n

    mergedAt (DateTime)

    The date and time that the pull request was merged.

    \n\n\n\n\n\n\n\n\n\n\n\n

    mergedBy (Actor)

    The actor who merged the pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    milestone (Milestone)

    Identifies the milestone associated with the pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    number (Int!)

    Identifies the pull request number.

    \n\n\n\n\n\n\n\n\n\n\n\n

    participants (UserConnection!)

    A list of Users that are participating in the Pull Request conversation.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    permalink (URI!)

    The permalink to the pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    potentialMergeCommit (Commit)

    The commit that GitHub automatically generated to test if this pull request\ncould be merged. This field will not return a value if the pull request is\nmerged, or if the test merge commit is still being generated. See the\nmergeable field for more details on the mergeability of the pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    projectCards (ProjectCardConnection!)

    List of project cards associated with this pull request.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    archivedStates ([ProjectCardArchivedState])

    \n

    A list of archived states to filter the cards by.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    publishedAt (DateTime)

    Identifies when the comment was published at.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reactionGroups ([ReactionGroup!])

    A list of reactions grouped by content left on the subject.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reactions (ReactionConnection!)

    A list of Reactions left on the Issue.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    content (ReactionContent)

    \n

    Allows filtering Reactions by emoji.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (ReactionOrder)

    \n

    Allows specifying the order in which reactions are returned.

    \n\n
    \n\n
    \n\n\n

    repository (Repository!)

    The repository associated with this node.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    revertResourcePath (URI!)

    The HTTP path for reverting this pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    revertUrl (URI!)

    The HTTP URL for reverting this pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reviewDecision (PullRequestReviewDecision)

    The current status of this pull request with respect to code review.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reviewRequests (ReviewRequestConnection)

    A list of review requests associated with the pull request.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    reviewThreads (PullRequestReviewThreadConnection!)

    The list of all review threads for this pull request.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    reviews (PullRequestReviewConnection)

    A list of reviews associated with the pull request.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    author (String)

    \n

    Filter by author of the review.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    states ([PullRequestReviewState!])

    \n

    A list of states to filter the reviews.

    \n\n
    \n\n
    \n\n\n

    state (PullRequestState!)

    Identifies the state of the pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    suggestedReviewers ([SuggestedReviewer]!)

    A list of reviewer suggestions based on commit history and past review comments.

    \n\n\n\n\n\n\n\n\n\n\n\n

    timeline (PullRequestTimelineConnection!)

    A list of events, comments, commits, etc. associated with the pull request.

    \n\n\n\n\n\n\n
    \n

    Deprecation notice

    \n

    timeline is deprecated.

    timeline will be removed Use PullRequest.timelineItems instead. Removal on 2020-10-01 UTC.

    \n
    \n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    since (DateTime)

    \n

    Allows filtering timeline events by a since timestamp.

    \n\n
    \n\n
    \n\n\n

    timelineItems (PullRequestTimelineItemsConnection!)

    A list of events, comments, commits, etc. associated with the pull request.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    itemTypes ([PullRequestTimelineItemsItemType!])

    \n

    Filter timeline items by type.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    since (DateTime)

    \n

    Filter timeline items by a since timestamp.

    \n\n
    \n\n
    \n

    skip (Int)

    \n

    Skips the first n elements in the list.

    \n\n
    \n\n
    \n\n\n

    title (String!)

    Identifies the pull request title.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userContentEdits (UserContentEditConnection)

    A list of edits to this content.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    viewerCanApplySuggestion (Boolean!)

    Whether or not the viewer can apply suggestion.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanDeleteHeadRef (Boolean!)

    Check if the viewer can restore the deleted head ref.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanDisableAutoMerge (Boolean!)

    Whether or not the viewer can disable auto-merge.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanEnableAutoMerge (Boolean!)

    Whether or not the viewer can enable auto-merge.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanReact (Boolean!)

    Can user react to this subject.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanSubscribe (Boolean!)

    Check if the viewer is able to change their subscription status for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanUpdate (Boolean!)

    Check if the current viewer can update this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

    Reasons why the current viewer can not update this comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerDidAuthor (Boolean!)

    Did the viewer author this comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerMergeBodyText (String!)

    The merge body text for the viewer and method.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    mergeType (PullRequestMergeMethod)

    \n

    The merge method for the message.

    \n\n
    \n\n
    \n\n\n

    viewerMergeHeadlineText (String!)

    The merge headline text for the viewer and method.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    mergeType (PullRequestMergeMethod)

    \n

    The merge method for the message.

    \n\n
    \n\n
    \n\n\n

    viewerSubscription (SubscriptionState)

    Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestChangedFile\n

    \n

    A file changed in a pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    additions (Int!)

    The number of additions to the file.

    \n\n\n\n\n\n\n\n\n\n\n\n

    deletions (Int!)

    The number of deletions to the file.

    \n\n\n\n\n\n\n\n\n\n\n\n

    path (String!)

    The path of the file.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerViewedState (FileViewedState!)

    The state of the file for the viewer.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestChangedFileConnection\n

    \n

    The connection type for PullRequestChangedFile.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([PullRequestChangedFileEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([PullRequestChangedFile])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestChangedFileEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (PullRequestChangedFile)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestCommit\n

    \n

    Represents a Git commit part of a pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    commit (Commit!)

    The Git commit object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    The pull request this commit belongs to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this pull request commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this pull request commit.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestCommitCommentThread\n

    \n

    Represents a commit comment thread part of a pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    comments (CommitCommentConnection!)

    The comments that exist in this thread.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    commit (Commit!)

    The commit the comments were made on.

    \n\n\n\n\n\n\n\n\n\n\n\n

    path (String)

    The file the comments were made on.

    \n\n\n\n\n\n\n\n\n\n\n\n

    position (Int)

    The position in the diff for the commit that the comment was made on.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    The pull request this commit comment thread belongs to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository!)

    The repository associated with this node.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestCommitConnection\n

    \n

    The connection type for PullRequestCommit.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([PullRequestCommitEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([PullRequestCommit])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestCommitEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (PullRequestCommit)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestConnection\n

    \n

    The connection type for PullRequest.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([PullRequestEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([PullRequest])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestContributionsByRepository\n

    \n

    This aggregates pull requests opened by a user within one repository.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    contributions (CreatedPullRequestContributionConnection!)

    The pull request contributions.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (ContributionOrder)

    \n

    Ordering options for contributions returned from the connection.

    \n\n
    \n\n
    \n\n\n

    repository (Repository!)

    The repository in which the pull requests were opened.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (PullRequest)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestReview\n

    \n

    A review object for a given pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    author (Actor)

    The actor who authored the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    authorAssociation (CommentAuthorAssociation!)

    Author's association with the subject of the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    authorCanPushToRepository (Boolean!)

    Indicates whether the author of this review has push access to the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    body (String!)

    Identifies the pull request review body.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyHTML (HTML!)

    The body rendered to HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyText (String!)

    The body of this review rendered as plain text.

    \n\n\n\n\n\n\n\n\n\n\n\n

    comments (PullRequestReviewCommentConnection!)

    A list of review comments for the current pull request review.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    commit (Commit)

    Identifies the commit associated with this pull request review.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdViaEmail (Boolean!)

    Check if this comment was created via an email reply.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    editor (Actor)

    The actor who edited the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    includesCreatedEdit (Boolean!)

    Check if this comment was edited and includes an edit with the creation data.

    \n\n\n\n\n\n\n\n\n\n\n\n

    lastEditedAt (DateTime)

    The moment the editor made the last edit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    onBehalfOf (TeamConnection!)

    A list of teams that this review was made on behalf of.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    publishedAt (DateTime)

    Identifies when the comment was published at.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    Identifies the pull request associated with this pull request review.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reactionGroups ([ReactionGroup!])

    A list of reactions grouped by content left on the subject.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reactions (ReactionConnection!)

    A list of Reactions left on the Issue.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    content (ReactionContent)

    \n

    Allows filtering Reactions by emoji.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (ReactionOrder)

    \n

    Allows specifying the order in which reactions are returned.

    \n\n
    \n\n
    \n\n\n

    repository (Repository!)

    The repository associated with this node.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path permalink for this PullRequestReview.

    \n\n\n\n\n\n\n\n\n\n\n\n

    state (PullRequestReviewState!)

    Identifies the current state of the pull request review.

    \n\n\n\n\n\n\n\n\n\n\n\n

    submittedAt (DateTime)

    Identifies when the Pull Request Review was submitted.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL permalink for this PullRequestReview.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userContentEdits (UserContentEditConnection)

    A list of edits to this content.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    viewerCanDelete (Boolean!)

    Check if the current viewer can delete this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanReact (Boolean!)

    Can user react to this subject.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanUpdate (Boolean!)

    Check if the current viewer can update this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

    Reasons why the current viewer can not update this comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerDidAuthor (Boolean!)

    Did the viewer author this comment.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestReviewComment\n

    \n

    A review comment associated with a given repository pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    author (Actor)

    The actor who authored the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    authorAssociation (CommentAuthorAssociation!)

    Author's association with the subject of the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    body (String!)

    The comment body of this review comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyHTML (HTML!)

    The body rendered to HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyText (String!)

    The comment body of this review comment rendered as plain text.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commit (Commit)

    Identifies the commit associated with the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies when the comment was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdViaEmail (Boolean!)

    Check if this comment was created via an email reply.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    diffHunk (String!)

    The diff hunk to which the comment applies.

    \n\n\n\n\n\n\n\n\n\n\n\n

    draftedAt (DateTime!)

    Identifies when the comment was created in a draft state.

    \n\n\n\n\n\n\n\n\n\n\n\n

    editor (Actor)

    The actor who edited the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    includesCreatedEdit (Boolean!)

    Check if this comment was edited and includes an edit with the creation data.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isMinimized (Boolean!)

    Returns whether or not a comment has been minimized.

    \n\n\n\n\n\n\n\n\n\n\n\n

    lastEditedAt (DateTime)

    The moment the editor made the last edit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    minimizedReason (String)

    Returns why the comment was minimized.

    \n\n\n\n\n\n\n\n\n\n\n\n

    originalCommit (Commit)

    Identifies the original commit associated with the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    originalPosition (Int!)

    The original line index in the diff to which the comment applies.

    \n\n\n\n\n\n\n\n\n\n\n\n

    outdated (Boolean!)

    Identifies when the comment body is outdated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    path (String!)

    The path to which the comment applies.

    \n\n\n\n\n\n\n\n\n\n\n\n

    position (Int)

    The line index in the diff to which the comment applies.

    \n\n\n\n\n\n\n\n\n\n\n\n

    publishedAt (DateTime)

    Identifies when the comment was published at.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    The pull request associated with this review comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestReview (PullRequestReview)

    The pull request review associated with this review comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reactionGroups ([ReactionGroup!])

    A list of reactions grouped by content left on the subject.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reactions (ReactionConnection!)

    A list of Reactions left on the Issue.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    content (ReactionContent)

    \n

    Allows filtering Reactions by emoji.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (ReactionOrder)

    \n

    Allows specifying the order in which reactions are returned.

    \n\n
    \n\n
    \n\n\n

    replyTo (PullRequestReviewComment)

    The comment this is a reply to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository!)

    The repository associated with this node.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path permalink for this review comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    state (PullRequestReviewCommentState!)

    Identifies the state of the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies when the comment was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL permalink for this review comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userContentEdits (UserContentEditConnection)

    A list of edits to this content.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    viewerCanDelete (Boolean!)

    Check if the current viewer can delete this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanMinimize (Boolean!)

    Check if the current viewer can minimize this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanReact (Boolean!)

    Can user react to this subject.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanUpdate (Boolean!)

    Check if the current viewer can update this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

    Reasons why the current viewer can not update this comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerDidAuthor (Boolean!)

    Did the viewer author this comment.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestReviewCommentConnection\n

    \n

    The connection type for PullRequestReviewComment.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([PullRequestReviewCommentEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([PullRequestReviewComment])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestReviewCommentEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (PullRequestReviewComment)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestReviewConnection\n

    \n

    The connection type for PullRequestReview.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([PullRequestReviewEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([PullRequestReview])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestReviewContributionsByRepository\n

    \n

    This aggregates pull request reviews made by a user within one repository.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    contributions (CreatedPullRequestReviewContributionConnection!)

    The pull request review contributions.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (ContributionOrder)

    \n

    Ordering options for contributions returned from the connection.

    \n\n
    \n\n
    \n\n\n

    repository (Repository!)

    The repository in which the pull request reviews were made.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestReviewEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (PullRequestReview)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestReviewThread\n

    \n

    A threaded list of comments for a given pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    comments (PullRequestReviewCommentConnection!)

    A list of pull request comments associated with the thread.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    skip (Int)

    \n

    Skips the first n elements in the list.

    \n\n
    \n\n
    \n\n\n

    diffSide (DiffSide!)

    The side of the diff on which this thread was placed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isCollapsed (Boolean!)

    Whether or not the thread has been collapsed (outdated or resolved).

    \n\n\n\n\n\n\n\n\n\n\n\n

    isOutdated (Boolean!)

    Indicates whether this thread was outdated by newer changes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isResolved (Boolean!)

    Whether this thread has been resolved.

    \n\n\n\n\n\n\n\n\n\n\n\n

    line (Int)

    The line in the file to which this thread refers.

    \n\n\n\n\n\n\n\n\n\n\n\n

    originalLine (Int)

    The original line in the file to which this thread refers.

    \n\n\n\n\n\n\n\n\n\n\n\n

    originalStartLine (Int)

    The original start line in the file to which this thread refers (multi-line only).

    \n\n\n\n\n\n\n\n\n\n\n\n

    path (String!)

    Identifies the file path of this thread.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    Identifies the pull request associated with this thread.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository!)

    Identifies the repository associated with this thread.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resolvedBy (User)

    The user who resolved this thread.

    \n\n\n\n\n\n\n\n\n\n\n\n

    startDiffSide (DiffSide)

    The side of the diff that the first line of the thread starts on (multi-line only).

    \n\n\n\n\n\n\n\n\n\n\n\n

    startLine (Int)

    The start line in the file to which this thread refers (multi-line only).

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanReply (Boolean!)

    Indicates whether the current viewer can reply to this thread.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanResolve (Boolean!)

    Whether or not the viewer can resolve this thread.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanUnresolve (Boolean!)

    Whether or not the viewer can unresolve this thread.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestReviewThreadConnection\n

    \n

    Review comment threads for a pull request review.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([PullRequestReviewThreadEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([PullRequestReviewThread])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestReviewThreadEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (PullRequestReviewThread)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestRevisionMarker\n

    \n

    Represents the latest point in the pull request timeline for which the viewer has seen the pull request's commits.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    lastSeenCommit (Commit!)

    The last commit the viewer has seen.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    The pull request to which the marker belongs.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestTimelineConnection\n

    \n

    The connection type for PullRequestTimelineItem.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([PullRequestTimelineItemEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([PullRequestTimelineItem])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestTimelineItemEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (PullRequestTimelineItem)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestTimelineItemsConnection\n

    \n

    The connection type for PullRequestTimelineItems.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([PullRequestTimelineItemsEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    filteredCount (Int!)

    Identifies the count of items after applying before and after filters.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([PullRequestTimelineItems])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageCount (Int!)

    Identifies the count of items after applying before/after filters and first/last/skip slicing.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the timeline was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestTimelineItemsEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (PullRequestTimelineItems)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Push\n

    \n

    A Git push.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    nextSha (GitObjectID)

    The SHA after the push.

    \n\n\n\n\n\n\n\n\n\n\n\n

    permalink (URI!)

    The permalink for this push.

    \n\n\n\n\n\n\n\n\n\n\n\n

    previousSha (GitObjectID)

    The SHA before the push.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pusher (User!)

    The user who pushed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository!)

    The repository that was pushed to.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PushAllowance\n

    \n

    A team, user or app who has the ability to push to a protected branch.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (PushAllowanceActor)

    The actor that can push.

    \n\n\n\n\n\n\n\n\n\n\n\n

    branchProtectionRule (BranchProtectionRule)

    Identifies the branch protection rule associated with the allowed user or team.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PushAllowanceConnection\n

    \n

    The connection type for PushAllowance.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([PushAllowanceEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([PushAllowance])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n PushAllowanceEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (PushAllowance)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RateLimit\n

    \n

    Represents the client's rate limit.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cost (Int!)

    The point cost for the current query counting against the rate limit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    limit (Int!)

    The maximum number of points the client is permitted to consume in a 60 minute window.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodeCount (Int!)

    The maximum number of nodes this query may return.

    \n\n\n\n\n\n\n\n\n\n\n\n

    remaining (Int!)

    The number of points remaining in the current rate limit window.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resetAt (DateTime!)

    The time at which the current rate limit window resets in UTC epoch seconds.

    \n\n\n\n\n\n\n\n\n\n\n\n

    used (Int!)

    The number of points used in the current rate limit window.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReactingUserConnection\n

    \n

    The connection type for User.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([ReactingUserEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([User])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReactingUserEdge\n

    \n

    Represents a user that's made a reaction.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reactedAt (DateTime!)

    The moment when the user made the reaction.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Reaction\n

    \n

    An emoji reaction to a particular piece of content.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    content (ReactionContent!)

    Identifies the emoji reaction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reactable (Reactable!)

    The reactable piece of content.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    Identifies the user who created this reaction.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReactionConnection\n

    \n

    A list of reactions that have been left on the subject.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([ReactionEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Reaction])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerHasReacted (Boolean!)

    Whether or not the authenticated user has left a reaction on the subject.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReactionEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (Reaction)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReactionGroup\n

    \n

    A group of emoji reactions to a particular piece of content.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    content (ReactionContent!)

    Identifies the emoji reaction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime)

    Identifies when the reaction was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    subject (Reactable!)

    The subject that was reacted to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    users (ReactingUserConnection!)

    Users who have reacted to the reaction subject with the emotion represented by this reaction group.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    viewerHasReacted (Boolean!)

    Whether or not the authenticated user has left a reaction on the subject.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReadyForReviewEvent\n

    \n

    Represents aready_for_reviewevent on a given pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    PullRequest referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this ready for review event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this ready for review event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Ref\n

    \n

    Represents a Git reference.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    associatedPullRequests (PullRequestConnection!)

    A list of pull requests with this ref as the head ref.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    baseRefName (String)

    \n

    The base ref name to filter the pull requests by.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    headRefName (String)

    \n

    The head ref name to filter the pull requests by.

    \n\n
    \n\n
    \n

    labels ([String!])

    \n

    A list of label names to filter the pull requests by.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (IssueOrder)

    \n

    Ordering options for pull requests returned from the connection.

    \n\n
    \n\n
    \n

    states ([PullRequestState!])

    \n

    A list of states to filter the pull requests by.

    \n\n
    \n\n
    \n\n\n

    branchProtectionRule (BranchProtectionRule)

    Branch protection rules for this ref.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The ref name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    prefix (String!)

    The ref's prefix, such as refs/heads/ or refs/tags/.

    \n\n\n\n\n\n\n\n\n\n\n\n

    refUpdateRule (RefUpdateRule)

    Branch protection rules that are viewable by non-admins.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository!)

    The repository the ref belongs to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    target (GitObject)

    The object the ref points to. Returns null when object does not exist.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RefConnection\n

    \n

    The connection type for Ref.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([RefEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Ref])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RefEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (Ref)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RefUpdateRule\n

    \n

    A ref update rules for a viewer.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    allowsDeletions (Boolean!)

    Can this branch be deleted.

    \n\n\n\n\n\n\n\n\n\n\n\n

    allowsForcePushes (Boolean!)

    Are force pushes allowed on this branch.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pattern (String!)

    Identifies the protection rule pattern.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiredApprovingReviewCount (Int)

    Number of approving reviews required to update matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiredStatusCheckContexts ([String])

    List of required status check contexts that must pass for commits to be accepted to matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiresLinearHistory (Boolean!)

    Are merge commits prohibited from being pushed to this branch.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiresSignatures (Boolean!)

    Are commits required to be signed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanPush (Boolean!)

    Can the viewer push to the branch.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReferencedEvent\n

    \n

    Represents areferencedevent on a given ReferencedSubject.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commit (Commit)

    Identifies the commit associated with thereferencedevent.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commitRepository (Repository!)

    Identifies the repository associated with thereferencedevent.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isCrossRepository (Boolean!)

    Reference originated in a different repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isDirectReference (Boolean!)

    Checks if the commit message itself references the subject. Can be false in the case of a commit comment reference.

    \n\n\n\n\n\n\n\n\n\n\n\n

    subject (ReferencedSubject!)

    Object referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Release\n

    \n

    A release contains the content for a release.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    author (User)

    The author of the release.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String)

    The description of the release.

    \n\n\n\n\n\n\n\n\n\n\n\n

    descriptionHTML (HTML)

    The description of this release rendered to HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isDraft (Boolean!)

    Whether or not the release is a draft.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isLatest (Boolean!)

    Whether or not the release is the latest releast.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isPrerelease (Boolean!)

    Whether or not the release is a prerelease.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String)

    The title of the release.

    \n\n\n\n\n\n\n\n\n\n\n\n

    publishedAt (DateTime)

    Identifies the date and time when the release was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    releaseAssets (ReleaseAssetConnection!)

    List of releases assets which are dependent on this release.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    name (String)

    \n

    A list of names to filter the assets by.

    \n\n
    \n\n
    \n\n\n

    repository (Repository!)

    The repository that the release belongs to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this issue.

    \n\n\n\n\n\n\n\n\n\n\n\n

    shortDescriptionHTML (HTML)

    A description of the release, rendered to HTML without any links in it.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    limit (Int)

    \n

    How many characters to return.

    \n

    The default value is 200.

    \n
    \n\n
    \n\n\n

    tag (Ref)

    The Git tag the release points to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    tagCommit (Commit)

    The tag commit for this release.

    \n\n\n\n\n\n\n\n\n\n\n\n

    tagName (String!)

    The name of the release's Git tag.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this issue.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReleaseAsset\n

    \n

    A release asset contains the content for a release asset.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    contentType (String!)

    The asset's content-type.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    downloadCount (Int!)

    The number of times this asset was downloaded.

    \n\n\n\n\n\n\n\n\n\n\n\n

    downloadUrl (URI!)

    Identifies the URL where you can download the release asset via the browser.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    Identifies the title of the release asset.

    \n\n\n\n\n\n\n\n\n\n\n\n

    release (Release)

    Release that the asset is associated with.

    \n\n\n\n\n\n\n\n\n\n\n\n

    size (Int!)

    The size (in bytes) of the asset.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    uploadedBy (User!)

    The user that performed the upload.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    Identifies the URL of the release asset.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReleaseAssetConnection\n

    \n

    The connection type for ReleaseAsset.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([ReleaseAssetEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([ReleaseAsset])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReleaseAssetEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (ReleaseAsset)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReleaseConnection\n

    \n

    The connection type for Release.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([ReleaseEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Release])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReleaseEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (Release)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RemovedFromProjectEvent\n

    \n

    Represents aremoved_from_projectevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    project (Project)

    Project referenced by event.

    \n\n\n\n\n
    \n

    Preview notice

    \n

    project is available under the Project event details preview. During the preview period, the API may change without notice.

    \n
    \n\n\n\n\n\n\n\n\n

    projectColumnName (String!)

    Column name referenced by this project event.

    \n\n\n\n\n
    \n

    Preview notice

    \n

    projectColumnName is available under the Project event details preview. During the preview period, the API may change without notice.

    \n
    \n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RenamedTitleEvent\n

    \n

    Represents arenamedevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    currentTitle (String!)

    Identifies the current title of the issue or pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    previousTitle (String!)

    Identifies the previous title of the issue or pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    subject (RenamedTitleSubject!)

    Subject that was renamed.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReopenedEvent\n

    \n

    Represents areopenedevent on any Closable.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    closable (Closable!)

    Object that was reopened.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepoAccessAuditEntry\n

    \n

    Audit log entry for a repo.access event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    visibility (RepoAccessAuditEntryVisibility)

    The visibility of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepoAddMemberAuditEntry\n

    \n

    Audit log entry for a repo.add_member event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    visibility (RepoAddMemberAuditEntryVisibility)

    The visibility of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepoAddTopicAuditEntry\n

    \n

    Audit log entry for a repo.add_topic event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    topic (Topic)

    The name of the topic added to the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    topicName (String)

    The name of the topic added to the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepoArchivedAuditEntry\n

    \n

    Audit log entry for a repo.archived event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    visibility (RepoArchivedAuditEntryVisibility)

    The visibility of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepoChangeMergeSettingAuditEntry\n

    \n

    Audit log entry for a repo.change_merge_setting event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isEnabled (Boolean)

    Whether the change was to enable (true) or disable (false) the merge type.

    \n\n\n\n\n\n\n\n\n\n\n\n

    mergeType (RepoChangeMergeSettingAuditEntryMergeType)

    The merge method affected by the change.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepoConfigDisableAnonymousGitAccessAuditEntry\n

    \n

    Audit log entry for a repo.config.disable_anonymous_git_access event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepoConfigDisableCollaboratorsOnlyAuditEntry\n

    \n

    Audit log entry for a repo.config.disable_collaborators_only event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepoConfigDisableContributorsOnlyAuditEntry\n

    \n

    Audit log entry for a repo.config.disable_contributors_only event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepoConfigDisableSockpuppetDisallowedAuditEntry\n

    \n

    Audit log entry for a repo.config.disable_sockpuppet_disallowed event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepoConfigEnableAnonymousGitAccessAuditEntry\n

    \n

    Audit log entry for a repo.config.enable_anonymous_git_access event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepoConfigEnableCollaboratorsOnlyAuditEntry\n

    \n

    Audit log entry for a repo.config.enable_collaborators_only event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepoConfigEnableContributorsOnlyAuditEntry\n

    \n

    Audit log entry for a repo.config.enable_contributors_only event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepoConfigEnableSockpuppetDisallowedAuditEntry\n

    \n

    Audit log entry for a repo.config.enable_sockpuppet_disallowed event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepoConfigLockAnonymousGitAccessAuditEntry\n

    \n

    Audit log entry for a repo.config.lock_anonymous_git_access event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepoConfigUnlockAnonymousGitAccessAuditEntry\n

    \n

    Audit log entry for a repo.config.unlock_anonymous_git_access event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepoCreateAuditEntry\n

    \n

    Audit log entry for a repo.create event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    forkParentName (String)

    The name of the parent repository for this forked repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    forkSourceName (String)

    The name of the root repository for this network.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    visibility (RepoCreateAuditEntryVisibility)

    The visibility of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepoDestroyAuditEntry\n

    \n

    Audit log entry for a repo.destroy event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    visibility (RepoDestroyAuditEntryVisibility)

    The visibility of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepoRemoveMemberAuditEntry\n

    \n

    Audit log entry for a repo.remove_member event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    visibility (RepoRemoveMemberAuditEntryVisibility)

    The visibility of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepoRemoveTopicAuditEntry\n

    \n

    Audit log entry for a repo.remove_topic event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    topic (Topic)

    The name of the topic added to the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    topicName (String)

    The name of the topic added to the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Repository\n

    \n

    A repository contains the content for a project.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    assignableUsers (UserConnection!)

    A list of users that can be assigned to issues in this repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    query (String)

    \n

    Filters users with query on user name and login.

    \n\n
    \n\n
    \n\n\n

    branchProtectionRules (BranchProtectionRuleConnection!)

    A list of branch protection rules for this repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    codeOfConduct (CodeOfConduct)

    Returns the code of conduct for this repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    collaborators (RepositoryCollaboratorConnection)

    A list of collaborators associated with the repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    affiliation (CollaboratorAffiliation)

    \n

    Collaborators affiliation level with a repository.

    \n\n
    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    query (String)

    \n

    Filters users with query on user name and login.

    \n\n
    \n\n
    \n\n\n

    commitComments (CommitCommentConnection!)

    A list of commit comments associated with the repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    contactLinks ([RepositoryContactLink!])

    Returns a list of contact links associated to the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    defaultBranchRef (Ref)

    The Ref associated with the repository's default branch.

    \n\n\n\n\n\n\n\n\n\n\n\n

    deleteBranchOnMerge (Boolean!)

    Whether or not branches are automatically deleted when merged in this repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    deployKeys (DeployKeyConnection!)

    A list of deploy keys that are on this repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    deployments (DeploymentConnection!)

    Deployments associated with the repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    environments ([String!])

    \n

    Environments to list deployments for.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (DeploymentOrder)

    \n

    Ordering options for deployments returned from the connection.

    \n\n
    \n\n
    \n\n\n

    description (String)

    The description of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    descriptionHTML (HTML!)

    The description of the repository rendered to HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    diskUsage (Int)

    The number of kilobytes this repository occupies on disk.

    \n\n\n\n\n\n\n\n\n\n\n\n

    forkCount (Int!)

    Returns how many forks there are of this repository in the whole network.

    \n\n\n\n\n\n\n\n\n\n\n\n

    forks (RepositoryConnection!)

    A list of direct forked repositories.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    affiliations ([RepositoryAffiliation])

    \n

    Array of viewer's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\ncurrent viewer owns.

    \n\n
    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    isLocked (Boolean)

    \n

    If non-null, filters repositories according to whether they have been locked.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (RepositoryOrder)

    \n

    Ordering options for repositories returned from the connection.

    \n\n
    \n\n
    \n

    ownerAffiliations ([RepositoryAffiliation])

    \n

    Array of owner's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\norganization or user being viewed owns.

    \n\n
    \n\n
    \n

    privacy (RepositoryPrivacy)

    \n

    If non-null, filters repositories according to privacy.

    \n\n
    \n\n
    \n\n\n

    hasAnonymousAccessEnabled (Boolean!)

    Indicates if the repository has anonymous Git read access feature enabled.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hasIssuesEnabled (Boolean!)

    Indicates if the repository has issues feature enabled.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hasProjectsEnabled (Boolean!)

    Indicates if the repository has the Projects feature enabled.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hasWikiEnabled (Boolean!)

    Indicates if the repository has wiki feature enabled.

    \n\n\n\n\n\n\n\n\n\n\n\n

    homepageUrl (URI)

    The repository's URL.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isArchived (Boolean!)

    Indicates if the repository is unmaintained.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isBlankIssuesEnabled (Boolean!)

    Returns true if blank issue creation is allowed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isDisabled (Boolean!)

    Returns whether or not this repository disabled.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isEmpty (Boolean!)

    Returns whether or not this repository is empty.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isFork (Boolean!)

    Identifies if the repository is a fork.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isInOrganization (Boolean!)

    Indicates if a repository is either owned by an organization, or is a private fork of an organization repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isLocked (Boolean!)

    Indicates if the repository has been locked or not.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isMirror (Boolean!)

    Identifies if the repository is a mirror.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isPrivate (Boolean!)

    Identifies if the repository is private.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isSecurityPolicyEnabled (Boolean)

    Returns true if this repository has a security policy.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isTemplate (Boolean!)

    Identifies if the repository is a template that can be used to generate new repositories.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isUserConfigurationRepository (Boolean!)

    Is this repository a user configuration repository?.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issue (Issue)

    Returns a single issue from the current repository by number.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    number (Int!)

    \n

    The number for the issue to be returned.

    \n\n
    \n\n
    \n\n\n

    issueOrPullRequest (IssueOrPullRequest)

    Returns a single issue-like object from the current repository by number.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    number (Int!)

    \n

    The number for the issue to be returned.

    \n\n
    \n\n
    \n\n\n

    issueTemplates ([IssueTemplate!])

    Returns a list of issue templates associated to the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issues (IssueConnection!)

    A list of issues that have been opened in the repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    filterBy (IssueFilters)

    \n

    Filtering options for issues returned from the connection.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    labels ([String!])

    \n

    A list of label names to filter the pull requests by.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (IssueOrder)

    \n

    Ordering options for issues returned from the connection.

    \n\n
    \n\n
    \n

    states ([IssueState!])

    \n

    A list of states to filter the issues by.

    \n\n
    \n\n
    \n\n\n

    label (Label)

    Returns a single label by name.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    name (String!)

    \n

    Label name.

    \n\n
    \n\n
    \n\n\n

    labels (LabelConnection)

    A list of labels associated with the repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (LabelOrder)

    \n

    Ordering options for labels returned from the connection.

    \n\n
    \n\n
    \n

    query (String)

    \n

    If provided, searches labels by name and description.

    \n\n
    \n\n
    \n\n\n

    languages (LanguageConnection)

    A list containing a breakdown of the language composition of the repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (LanguageOrder)

    \n

    Order for connection.

    \n\n
    \n\n
    \n\n\n

    latestRelease (Release)

    Get the latest release for the repository if one exists.

    \n\n\n\n\n\n\n\n\n\n\n\n

    licenseInfo (License)

    The license associated with the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    lockReason (RepositoryLockReason)

    The reason the repository has been locked.

    \n\n\n\n\n\n\n\n\n\n\n\n

    mentionableUsers (UserConnection!)

    A list of Users that can be mentioned in the context of the repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    query (String)

    \n

    Filters users with query on user name and login.

    \n\n
    \n\n
    \n\n\n

    mergeCommitAllowed (Boolean!)

    Whether or not PRs are merged with a merge commit on this repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    milestone (Milestone)

    Returns a single milestone from the current repository by number.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    number (Int!)

    \n

    The number for the milestone to be returned.

    \n\n
    \n\n
    \n\n\n

    milestones (MilestoneConnection)

    A list of milestones associated with the repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (MilestoneOrder)

    \n

    Ordering options for milestones.

    \n\n
    \n\n
    \n

    query (String)

    \n

    Filters milestones with a query on the title.

    \n\n
    \n\n
    \n

    states ([MilestoneState!])

    \n

    Filter by the state of the milestones.

    \n\n
    \n\n
    \n\n\n

    mirrorUrl (URI)

    The repository's original mirror URL.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nameWithOwner (String!)

    The repository's name with owner.

    \n\n\n\n\n\n\n\n\n\n\n\n

    object (GitObject)

    A Git object in the repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    expression (String)

    \n

    A Git revision expression suitable for rev-parse.

    \n\n
    \n\n
    \n

    oid (GitObjectID)

    \n

    The Git object ID.

    \n\n
    \n\n
    \n\n\n

    openGraphImageUrl (URI!)

    The image used to represent this repository in Open Graph data.

    \n\n\n\n\n\n\n\n\n\n\n\n

    owner (RepositoryOwner!)

    The User owner of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    parent (Repository)

    The repository parent, if this is a fork.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pinnedIssues (PinnedIssueConnection)

    A list of pinned issues for this repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    primaryLanguage (Language)

    The primary language of the repository's code.

    \n\n\n\n\n\n\n\n\n\n\n\n

    project (Project)

    Find project by number.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    number (Int!)

    \n

    The project number to find.

    \n\n
    \n\n
    \n\n\n

    projects (ProjectConnection!)

    A list of projects under the owner.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (ProjectOrder)

    \n

    Ordering options for projects returned from the connection.

    \n\n
    \n\n
    \n

    search (String)

    \n

    Query to search projects by, currently only searching by name.

    \n\n
    \n\n
    \n

    states ([ProjectState!])

    \n

    A list of states to filter the projects by.

    \n\n
    \n\n
    \n\n\n

    projectsResourcePath (URI!)

    The HTTP path listing the repository's projects.

    \n\n\n\n\n\n\n\n\n\n\n\n

    projectsUrl (URI!)

    The HTTP URL listing the repository's projects.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest)

    Returns a single pull request from the current repository by number.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    number (Int!)

    \n

    The number for the pull request to be returned.

    \n\n
    \n\n
    \n\n\n

    pullRequests (PullRequestConnection!)

    A list of pull requests that have been opened in the repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    baseRefName (String)

    \n

    The base ref name to filter the pull requests by.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    headRefName (String)

    \n

    The head ref name to filter the pull requests by.

    \n\n
    \n\n
    \n

    labels ([String!])

    \n

    A list of label names to filter the pull requests by.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (IssueOrder)

    \n

    Ordering options for pull requests returned from the connection.

    \n\n
    \n\n
    \n

    states ([PullRequestState!])

    \n

    A list of states to filter the pull requests by.

    \n\n
    \n\n
    \n\n\n

    pushedAt (DateTime)

    Identifies when the repository was last pushed to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    rebaseMergeAllowed (Boolean!)

    Whether or not rebase-merging is enabled on this repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ref (Ref)

    Fetch a given ref from the repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    qualifiedName (String!)

    \n

    The ref to retrieve. Fully qualified matches are checked in order\n(refs/heads/master) before falling back onto checks for short name matches (master).

    \n\n
    \n\n
    \n\n\n

    refs (RefConnection)

    Fetch a list of refs from the repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    direction (OrderDirection)

    \n

    DEPRECATED: use orderBy. The ordering direction.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (RefOrder)

    \n

    Ordering options for refs returned from the connection.

    \n\n
    \n\n
    \n

    query (String)

    \n

    Filters refs with query on name.

    \n\n
    \n\n
    \n

    refPrefix (String!)

    \n

    A ref name prefix like refs/heads/, refs/tags/, etc.

    \n\n
    \n\n
    \n\n\n

    release (Release)

    Lookup a single release given various criteria.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    tagName (String!)

    \n

    The name of the Tag the Release was created from.

    \n\n
    \n\n
    \n\n\n

    releases (ReleaseConnection!)

    List of releases which are dependent on this repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (ReleaseOrder)

    \n

    Order for connection.

    \n\n
    \n\n
    \n\n\n

    repositoryTopics (RepositoryTopicConnection!)

    A list of applied repository-topic associations for this repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    resourcePath (URI!)

    The HTTP path for this repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    securityPolicyUrl (URI)

    The security policy URL.

    \n\n\n\n\n\n\n\n\n\n\n\n

    shortDescriptionHTML (HTML!)

    A description of the repository, rendered to HTML without any links in it.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    limit (Int)

    \n

    How many characters to return.

    \n

    The default value is 200.

    \n
    \n\n
    \n\n\n

    squashMergeAllowed (Boolean!)

    Whether or not squash-merging is enabled on this repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    sshUrl (GitSSHRemote!)

    The SSH URL to clone this repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    stargazerCount (Int!)

    Returns a count of how many stargazers there are on this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    stargazers (StargazerConnection!)

    A list of users who have starred this starrable.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (StarOrder)

    \n

    Order for connection.

    \n\n
    \n\n
    \n\n\n

    submodules (SubmoduleConnection!)

    Returns a list of all submodules in this repository parsed from the\n.gitmodules file as of the default branch's HEAD commit.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    tempCloneToken (String)

    Temporary authentication token for cloning this repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    templateRepository (Repository)

    The repository from which this repository was generated, if any.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    usesCustomOpenGraphImage (Boolean!)

    Whether this repository has a custom image to use with Open Graph as opposed to being represented by the owner's avatar.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanAdminister (Boolean!)

    Indicates whether the viewer has admin permissions on this repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanCreateProjects (Boolean!)

    Can the current viewer create new projects on this owner.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanSubscribe (Boolean!)

    Check if the viewer is able to change their subscription status for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanUpdateTopics (Boolean!)

    Indicates whether the viewer can update the topics of this repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerDefaultCommitEmail (String)

    The last commit email for the viewer.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerDefaultMergeMethod (PullRequestMergeMethod!)

    The last used merge method by the viewer or the default for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerHasStarred (Boolean!)

    Returns a boolean indicating whether the viewing user has starred this starrable.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerPermission (RepositoryPermission)

    The users permission level on the repository. Will return null if authenticated as an GitHub App.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerPossibleCommitEmails ([String!])

    A list of emails this viewer can commit with.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerSubscription (SubscriptionState)

    Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

    \n\n\n\n\n\n\n\n\n\n\n\n

    vulnerabilityAlerts (RepositoryVulnerabilityAlertConnection)

    A list of vulnerability alerts that are on this repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    watchers (UserConnection!)

    A list of users watching the repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepositoryCollaboratorConnection\n

    \n

    The connection type for User.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([RepositoryCollaboratorEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([User])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepositoryCollaboratorEdge\n

    \n

    Represents a user who is a collaborator of a repository.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    permission (RepositoryPermission!)

    The permission the user has on the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    permissionSources ([PermissionSource!])

    A list of sources for the user's access to the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepositoryConnection\n

    \n

    A list of repositories owned by the subject.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([RepositoryEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Repository])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalDiskUsage (Int!)

    The total size in kilobytes of all repositories in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepositoryContactLink\n

    \n

    A repository contact link.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    about (String!)

    The contact link purpose.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The contact link name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The contact link URL.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepositoryEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (Repository)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepositoryInvitation\n

    \n

    An invitation for a user to be added to a repository.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    email (String)

    The email address that received the invitation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    invitee (User)

    The user who received the invitation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    inviter (User!)

    The user who created the invitation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    permalink (URI!)

    The permalink for this repository invitation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    permission (RepositoryPermission!)

    The permission granted on this repository by this invitation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (RepositoryInfo)

    The Repository the user is invited to.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepositoryInvitationConnection\n

    \n

    The connection type for RepositoryInvitation.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([RepositoryInvitationEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([RepositoryInvitation])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepositoryInvitationEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (RepositoryInvitation)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepositoryTopic\n

    \n

    A repository-topic connects a repository to a topic.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    resourcePath (URI!)

    The HTTP path for this repository-topic.

    \n\n\n\n\n\n\n\n\n\n\n\n

    topic (Topic!)

    The topic.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this repository-topic.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepositoryTopicConnection\n

    \n

    The connection type for RepositoryTopic.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([RepositoryTopicEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([RepositoryTopic])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepositoryTopicEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (RepositoryTopic)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepositoryVisibilityChangeDisableAuditEntry\n

    \n

    Audit log entry for a repository_visibility_change.disable event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseResourcePath (URI)

    The HTTP path for this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseSlug (String)

    The slug of the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseUrl (URI)

    The HTTP URL for this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepositoryVisibilityChangeEnableAuditEntry\n

    \n

    Audit log entry for a repository_visibility_change.enable event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseResourcePath (URI)

    The HTTP path for this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseSlug (String)

    The slug of the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseUrl (URI)

    The HTTP URL for this enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepositoryVulnerabilityAlert\n

    \n

    A alert for a repository with an affected vulnerability.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    createdAt (DateTime!)

    When was the alert created?.

    \n\n\n\n\n\n\n\n\n\n\n\n

    dismissReason (String)

    The reason the alert was dismissed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    dismissedAt (DateTime)

    When was the alert dismissed?.

    \n\n\n\n\n\n\n\n\n\n\n\n

    dismisser (User)

    The user who dismissed the alert.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository!)

    The associated repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    securityAdvisory (SecurityAdvisory)

    The associated security advisory.

    \n\n\n\n\n\n\n\n\n\n\n\n

    securityVulnerability (SecurityVulnerability)

    The associated security vulnerability.

    \n\n\n\n\n\n\n\n\n\n\n\n

    vulnerableManifestFilename (String!)

    The vulnerable manifest filename.

    \n\n\n\n\n\n\n\n\n\n\n\n

    vulnerableManifestPath (String!)

    The vulnerable manifest path.

    \n\n\n\n\n\n\n\n\n\n\n\n

    vulnerableRequirements (String)

    The vulnerable requirements.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepositoryVulnerabilityAlertConnection\n

    \n

    The connection type for RepositoryVulnerabilityAlert.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([RepositoryVulnerabilityAlertEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([RepositoryVulnerabilityAlert])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RepositoryVulnerabilityAlertEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (RepositoryVulnerabilityAlert)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n RestrictedContribution\n

    \n

    Represents a private contribution a user made on GitHub.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    isRestricted (Boolean!)

    Whether this contribution is associated with a record you do not have access to. For\nexample, your own 'first issue' contribution may have been made on a repository you can no\nlonger access.

    \n\n\n\n\n\n\n\n\n\n\n\n

    occurredAt (DateTime!)

    When this contribution was made.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User!)

    The user who made this contribution.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReviewDismissalAllowance\n

    \n

    A team or user who has the ability to dismiss a review on a protected branch.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (ReviewDismissalAllowanceActor)

    The actor that can dismiss.

    \n\n\n\n\n\n\n\n\n\n\n\n

    branchProtectionRule (BranchProtectionRule)

    Identifies the branch protection rule associated with the allowed user or team.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReviewDismissalAllowanceConnection\n

    \n

    The connection type for ReviewDismissalAllowance.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([ReviewDismissalAllowanceEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([ReviewDismissalAllowance])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReviewDismissalAllowanceEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (ReviewDismissalAllowance)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReviewDismissedEvent\n

    \n

    Represents areview_dismissedevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    dismissalMessage (String)

    Identifies the optional message associated with thereview_dismissedevent.

    \n\n\n\n\n\n\n\n\n\n\n\n

    dismissalMessageHTML (String)

    Identifies the optional message associated with the event, rendered to HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    previousReviewState (PullRequestReviewState!)

    Identifies the previous state of the review with thereview_dismissedevent.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    PullRequest referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestCommit (PullRequestCommit)

    Identifies the commit which caused the review to become stale.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this review dismissed event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    review (PullRequestReview)

    Identifies the review associated with thereview_dismissedevent.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this review dismissed event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReviewRequest\n

    \n

    A request for a user to review a pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    asCodeOwner (Boolean!)

    Whether this request was created for a code owner.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    Identifies the pull request associated with this review request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requestedReviewer (RequestedReviewer)

    The reviewer that is requested.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReviewRequestConnection\n

    \n

    The connection type for ReviewRequest.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([ReviewRequestEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([ReviewRequest])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReviewRequestEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (ReviewRequest)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReviewRequestRemovedEvent\n

    \n

    Represents anreview_request_removedevent on a given pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    PullRequest referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requestedReviewer (RequestedReviewer)

    Identifies the reviewer whose review request was removed.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReviewRequestedEvent\n

    \n

    Represents anreview_requestedevent on a given pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequest (PullRequest!)

    PullRequest referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requestedReviewer (RequestedReviewer)

    Identifies the reviewer whose review was requested.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ReviewStatusHovercardContext\n

    \n

    A hovercard context with a message describing the current code review state of the pull\nrequest.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    message (String!)

    A string describing this context.

    \n\n\n\n\n\n\n\n\n\n\n\n

    octicon (String!)

    An octicon to accompany this context.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reviewDecision (PullRequestReviewDecision)

    The current status of the pull request with respect to code review.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SavedReply\n

    \n

    A Saved Reply is text a user can use to reply quickly.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String!)

    The body of the saved reply.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyHTML (HTML!)

    The saved reply body rendered to HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    title (String!)

    The title of the saved reply.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (Actor)

    The user that saved this reply.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SavedReplyConnection\n

    \n

    The connection type for SavedReply.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([SavedReplyEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([SavedReply])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SavedReplyEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (SavedReply)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SearchResultItemConnection\n

    \n

    A list of results that matched against a search query.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    codeCount (Int!)

    The number of pieces of code that matched the search query.

    \n\n\n\n\n\n\n\n\n\n\n\n

    edges ([SearchResultItemEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issueCount (Int!)

    The number of issues that matched the search query.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([SearchResultItem])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryCount (Int!)

    The number of repositories that matched the search query.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userCount (Int!)

    The number of users that matched the search query.

    \n\n\n\n\n\n\n\n\n\n\n\n

    wikiCount (Int!)

    The number of wiki pages that matched the search query.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SearchResultItemEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (SearchResultItem)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n

    textMatches ([TextMatch])

    Text matches on the result found.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SecurityAdvisory\n

    \n

    A GitHub Security Advisory.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cvss (CVSS!)

    The CVSS associated with this advisory.

    \n\n\n\n\n\n\n\n\n\n\n\n

    cwes (CWEConnection!)

    CWEs associated with this Advisory.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String!)

    This is a long plaintext description of the advisory.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ghsaId (String!)

    The GitHub Security Advisory ID.

    \n\n\n\n\n\n\n\n\n\n\n\n

    identifiers ([SecurityAdvisoryIdentifier!]!)

    A list of identifiers for this advisory.

    \n\n\n\n\n\n\n\n\n\n\n\n

    notificationsPermalink (URI)

    The permalink for the advisory's dependabot alerts page.

    \n\n\n\n\n\n\n\n\n\n\n\n

    origin (String!)

    The organization that originated the advisory.

    \n\n\n\n\n\n\n\n\n\n\n\n

    permalink (URI)

    The permalink for the advisory.

    \n\n\n\n\n\n\n\n\n\n\n\n

    publishedAt (DateTime!)

    When the advisory was published.

    \n\n\n\n\n\n\n\n\n\n\n\n

    references ([SecurityAdvisoryReference!]!)

    A list of references for this advisory.

    \n\n\n\n\n\n\n\n\n\n\n\n

    severity (SecurityAdvisorySeverity!)

    The severity of the advisory.

    \n\n\n\n\n\n\n\n\n\n\n\n

    summary (String!)

    A short plaintext summary of the advisory.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    When the advisory was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    vulnerabilities (SecurityVulnerabilityConnection!)

    Vulnerabilities associated with this Advisory.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    ecosystem (SecurityAdvisoryEcosystem)

    \n

    An ecosystem to filter vulnerabilities by.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    package (String)

    \n

    A package name to filter vulnerabilities by.

    \n\n
    \n\n
    \n

    severities ([SecurityAdvisorySeverity!])

    \n

    A list of severities to filter vulnerabilities by.

    \n\n
    \n\n
    \n\n\n

    withdrawnAt (DateTime)

    When the advisory was withdrawn, if it has been withdrawn.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SecurityAdvisoryConnection\n

    \n

    The connection type for SecurityAdvisory.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([SecurityAdvisoryEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([SecurityAdvisory])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SecurityAdvisoryEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (SecurityAdvisory)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SecurityAdvisoryIdentifier\n

    \n

    A GitHub Security Advisory Identifier.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    type (String!)

    The identifier type, e.g. GHSA, CVE.

    \n\n\n\n\n\n\n\n\n\n\n\n

    value (String!)

    The identifier.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SecurityAdvisoryPackage\n

    \n

    An individual package.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    ecosystem (SecurityAdvisoryEcosystem!)

    The ecosystem the package belongs to, e.g. RUBYGEMS, NPM.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The package name.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SecurityAdvisoryPackageVersion\n

    \n

    An individual package version.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    identifier (String!)

    The package name or version.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SecurityAdvisoryReference\n

    \n

    A GitHub Security Advisory Reference.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    url (URI!)

    A publicly accessible reference.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SecurityVulnerability\n

    \n

    An individual vulnerability within an Advisory.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    advisory (SecurityAdvisory!)

    The Advisory associated with this Vulnerability.

    \n\n\n\n\n\n\n\n\n\n\n\n

    firstPatchedVersion (SecurityAdvisoryPackageVersion)

    The first version containing a fix for the vulnerability.

    \n\n\n\n\n\n\n\n\n\n\n\n

    package (SecurityAdvisoryPackage!)

    A description of the vulnerable package.

    \n\n\n\n\n\n\n\n\n\n\n\n

    severity (SecurityAdvisorySeverity!)

    The severity of the vulnerability within this package.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    When the vulnerability was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    vulnerableVersionRange (String!)

    A string that describes the vulnerable package versions.\nThis string follows a basic syntax with a few forms.

    \n
      \n
    • = 0.2.0 denotes a single vulnerable version.
    • \n
    • <= 1.0.8 denotes a version range up to and including the specified version
    • \n
    • < 0.1.11 denotes a version range up to, but excluding, the specified version
    • \n
    • >= 4.3.0, < 4.3.5 denotes a version range with a known minimum and maximum version.
    • \n
    • >= 0.0.1 denotes a version range with a known minimum, but no known maximum.
    • \n

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SecurityVulnerabilityConnection\n

    \n

    The connection type for SecurityVulnerability.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([SecurityVulnerabilityEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([SecurityVulnerability])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SecurityVulnerabilityEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (SecurityVulnerability)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SmimeSignature\n

    \n

    Represents an S/MIME signature on a Commit or Tag.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    email (String!)

    Email used to sign this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isValid (Boolean!)

    True if the signature is valid and verified by GitHub.

    \n\n\n\n\n\n\n\n\n\n\n\n

    payload (String!)

    Payload for GPG signing object. Raw ODB object without the signature header.

    \n\n\n\n\n\n\n\n\n\n\n\n

    signature (String!)

    ASCII-armored signature header from object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    signer (User)

    GitHub user corresponding to the email signing this commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    state (GitSignatureState!)

    The state of this signature. VALID if signature is valid and verified by\nGitHub, otherwise represents reason why signature is considered invalid.

    \n\n\n\n\n\n\n\n\n\n\n\n

    wasSignedByGitHub (Boolean!)

    True if the signature was made with GitHub's signing key.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Sponsorship\n

    \n

    A sponsorship relationship between a sponsor and a maintainer.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    maintainer (User!)

    The entity that is being sponsored.

    \n\n\n\n\n\n\n
    \n

    Deprecation notice

    \n

    maintainer is deprecated.

    Sponsorship.maintainer will be removed. Use Sponsorship.sponsorable instead. Removal on 2020-04-01 UTC.

    \n
    \n\n\n\n\n\n\n

    privacyLevel (SponsorshipPrivacy!)

    The privacy level for this sponsorship.

    \n\n\n\n\n\n\n\n\n\n\n\n

    sponsor (User)

    The user that is sponsoring. Returns null if the sponsorship is private or if sponsor is not a user.

    \n\n\n\n\n\n\n
    \n

    Deprecation notice

    \n

    sponsor is deprecated.

    Sponsorship.sponsor will be removed. Use Sponsorship.sponsorEntity instead. Removal on 2020-10-01 UTC.

    \n
    \n\n\n\n\n\n\n

    sponsorEntity (Sponsor)

    The user or organization that is sponsoring, if you have permission to view them.

    \n\n\n\n\n\n\n\n\n\n\n\n

    sponsorable (Sponsorable!)

    The entity that is being sponsored.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SponsorshipConnection\n

    \n

    The connection type for Sponsorship.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([SponsorshipEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Sponsorship])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SponsorshipEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (Sponsorship)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n StargazerConnection\n

    \n

    The connection type for User.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([StargazerEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([User])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n StargazerEdge\n

    \n

    Represents a user that's starred a repository.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    starredAt (DateTime!)

    Identifies when the item was starred.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n StarredRepositoryConnection\n

    \n

    The connection type for Repository.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([StarredRepositoryEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isOverLimit (Boolean!)

    Is the list of stars for this user truncated? This is true for users that have many stars.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Repository])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n StarredRepositoryEdge\n

    \n

    Represents a starred repository.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    starredAt (DateTime!)

    Identifies when the item was starred.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Status\n

    \n

    Represents a commit status.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    combinedContexts (StatusCheckRollupContextConnection!)

    A list of status contexts and check runs for this commit.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    commit (Commit)

    The commit this status is attached to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    context (StatusContext)

    Looks up an individual status context by context name.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    name (String!)

    \n

    The context name.

    \n\n
    \n\n
    \n\n\n

    contexts ([StatusContext!]!)

    The individual status contexts for this commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    state (StatusState!)

    The combined commit status.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n StatusCheckRollup\n

    \n

    Represents the rollup for both the check runs and status for a commit.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    commit (Commit)

    The commit the status and check runs are attached to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    contexts (StatusCheckRollupContextConnection!)

    A list of status contexts and check runs for this commit.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    state (StatusState!)

    The combined status for the commit.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n StatusCheckRollupContextConnection\n

    \n

    The connection type for StatusCheckRollupContext.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([StatusCheckRollupContextEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([StatusCheckRollupContext])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n StatusCheckRollupContextEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (StatusCheckRollupContext)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n StatusContext\n

    \n

    Represents an individual commit status context.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    avatarUrl (URI)

    The avatar of the OAuth application or the user that created the status.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    size (Int)

    \n

    The size of the resulting square image.

    \n

    The default value is 40.

    \n
    \n\n
    \n\n\n

    commit (Commit)

    This commit this status context is attached to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    context (String!)

    The name of this status context.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    creator (Actor)

    The actor who created this status context.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String)

    The description for this status context.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isRequired (Boolean!)

    Whether this status is required to pass before merging.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    pullRequestId (ID!)

    \n

    The pull request this status is required for.

    \n\n
    \n\n
    \n\n\n

    state (StatusState!)

    The state of this status context.

    \n\n\n\n\n\n\n\n\n\n\n\n

    targetUrl (URI)

    The URL for this status context.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Submodule\n

    \n

    A pointer to a repository at a specific revision embedded inside another repository.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    branch (String)

    The branch of the upstream submodule for tracking updates.

    \n\n\n\n\n\n\n\n\n\n\n\n

    gitUrl (URI!)

    The git URL of the submodule repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The name of the submodule in .gitmodules.

    \n\n\n\n\n\n\n\n\n\n\n\n

    path (String!)

    The path in the superproject that this submodule is located in.

    \n\n\n\n\n\n\n\n\n\n\n\n

    subprojectCommitOid (GitObjectID)

    The commit revision of the subproject repository being tracked by the submodule.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SubmoduleConnection\n

    \n

    The connection type for Submodule.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([SubmoduleEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Submodule])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SubmoduleEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (Submodule)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SubscribedEvent\n

    \n

    Represents asubscribedevent on a given Subscribable.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    subscribable (Subscribable!)

    Object referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n SuggestedReviewer\n

    \n

    A suggestion to review a pull request based on a user's commit history and review comments.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    isAuthor (Boolean!)

    Is this suggestion based on past commits?.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isCommenter (Boolean!)

    Is this suggestion based on past review comments?.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reviewer (User!)

    Identifies the user suggested to review the pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Tag\n

    \n

    Represents a Git tag.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    abbreviatedOid (String!)

    An abbreviated version of the Git object ID.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commitResourcePath (URI!)

    The HTTP path for this Git object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commitUrl (URI!)

    The HTTP URL for this Git object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    message (String)

    The Git tag message.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The Git tag name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    oid (GitObjectID!)

    The Git object ID.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository!)

    The Repository the Git object belongs to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    tagger (GitActor)

    Details about the tag author.

    \n\n\n\n\n\n\n\n\n\n\n\n

    target (GitObject!)

    The Git object the tag points to.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Team\n

    \n

    A team of users in an organization.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    ancestors (TeamConnection!)

    A list of teams that are ancestors of this team.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    avatarUrl (URI)

    A URL pointing to the team's avatar.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    size (Int)

    \n

    The size in pixels of the resulting square image.

    \n

    The default value is 400.

    \n
    \n\n
    \n\n\n

    childTeams (TeamConnection!)

    List of child teams belonging to this team.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    immediateOnly (Boolean)

    \n

    Whether to list immediate child teams or all descendant child teams.

    \n

    The default value is true.

    \n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (TeamOrder)

    \n

    Order for connection.

    \n\n
    \n\n
    \n

    userLogins ([String!])

    \n

    User logins to filter by.

    \n\n
    \n\n
    \n\n\n

    combinedSlug (String!)

    The slug corresponding to the organization and team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String)

    The description of the team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    discussion (TeamDiscussion)

    Find a team discussion by its number.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    number (Int!)

    \n

    The sequence number of the discussion to find.

    \n\n
    \n\n
    \n\n\n

    discussions (TeamDiscussionConnection!)

    A list of team discussions.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    isPinned (Boolean)

    \n

    If provided, filters discussions according to whether or not they are pinned.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (TeamDiscussionOrder)

    \n

    Order for connection.

    \n\n
    \n\n
    \n\n\n

    discussionsResourcePath (URI!)

    The HTTP path for team discussions.

    \n\n\n\n\n\n\n\n\n\n\n\n

    discussionsUrl (URI!)

    The HTTP URL for team discussions.

    \n\n\n\n\n\n\n\n\n\n\n\n

    editTeamResourcePath (URI!)

    The HTTP path for editing this team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    editTeamUrl (URI!)

    The HTTP URL for editing this team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    invitations (OrganizationInvitationConnection)

    A list of pending invitations for users to this team.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    memberStatuses (UserStatusConnection!)

    Get the status messages members of this entity have set that are either public or visible only to the organization.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (UserStatusOrder)

    \n

    Ordering options for user statuses returned from the connection.

    \n\n
    \n\n
    \n\n\n

    members (TeamMemberConnection!)

    A list of users who are members of this team.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    membership (TeamMembershipType)

    \n

    Filter by membership type.

    \n

    The default value is ALL.

    \n
    \n\n
    \n

    orderBy (TeamMemberOrder)

    \n

    Order for the connection.

    \n\n
    \n\n
    \n

    query (String)

    \n

    The search string to look for.

    \n\n
    \n\n
    \n

    role (TeamMemberRole)

    \n

    Filter by team member role.

    \n\n
    \n\n
    \n\n\n

    membersResourcePath (URI!)

    The HTTP path for the team' members.

    \n\n\n\n\n\n\n\n\n\n\n\n

    membersUrl (URI!)

    The HTTP URL for the team' members.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The name of the team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    newTeamResourcePath (URI!)

    The HTTP path creating a new team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    newTeamUrl (URI!)

    The HTTP URL creating a new team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization!)

    The organization that owns this team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    parentTeam (Team)

    The parent team of the team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    privacy (TeamPrivacy!)

    The level of privacy the team has.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositories (TeamRepositoryConnection!)

    A list of repositories this team has access to.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (TeamRepositoryOrder)

    \n

    Order for the connection.

    \n\n
    \n\n
    \n

    query (String)

    \n

    The search string to look for.

    \n\n
    \n\n
    \n\n\n

    repositoriesResourcePath (URI!)

    The HTTP path for this team's repositories.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoriesUrl (URI!)

    The HTTP URL for this team's repositories.

    \n\n\n\n\n\n\n\n\n\n\n\n

    resourcePath (URI!)

    The HTTP path for this team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reviewRequestDelegationAlgorithm (TeamReviewAssignmentAlgorithm)

    What algorithm is used for review assignment for this team.

    \n\n\n\n\n
    \n

    Preview notice

    \n

    reviewRequestDelegationAlgorithm is available under the Team review assignments preview. During the preview period, the API may change without notice.

    \n
    \n\n\n\n\n\n\n\n\n

    reviewRequestDelegationEnabled (Boolean!)

    True if review assignment is enabled for this team.

    \n\n\n\n\n
    \n

    Preview notice

    \n

    reviewRequestDelegationEnabled is available under the Team review assignments preview. During the preview period, the API may change without notice.

    \n
    \n\n\n\n\n\n\n\n\n

    reviewRequestDelegationMemberCount (Int)

    How many team members are required for review assignment for this team.

    \n\n\n\n\n
    \n

    Preview notice

    \n

    reviewRequestDelegationMemberCount is available under the Team review assignments preview. During the preview period, the API may change without notice.

    \n
    \n\n\n\n\n\n\n\n\n

    reviewRequestDelegationNotifyTeam (Boolean!)

    When assigning team members via delegation, whether the entire team should be notified as well.

    \n\n\n\n\n
    \n

    Preview notice

    \n

    reviewRequestDelegationNotifyTeam is available under the Team review assignments preview. During the preview period, the API may change without notice.

    \n
    \n\n\n\n\n\n\n\n\n

    slug (String!)

    The slug corresponding to the team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamsResourcePath (URI!)

    The HTTP path for this team's teams.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamsUrl (URI!)

    The HTTP URL for this team's teams.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanAdminister (Boolean!)

    Team is adminable by the viewer.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanSubscribe (Boolean!)

    Check if the viewer is able to change their subscription status for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerSubscription (SubscriptionState)

    Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamAddMemberAuditEntry\n

    \n

    Audit log entry for a team.add_member event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isLdapMapped (Boolean)

    Whether the team was mapped to an LDAP Group.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    team (Team)

    The team associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamName (String)

    The name of the team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamResourcePath (URI)

    The HTTP path for this team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamUrl (URI)

    The HTTP URL for this team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamAddRepositoryAuditEntry\n

    \n

    Audit log entry for a team.add_repository event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isLdapMapped (Boolean)

    Whether the team was mapped to an LDAP Group.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    team (Team)

    The team associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamName (String)

    The name of the team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamResourcePath (URI)

    The HTTP path for this team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamUrl (URI)

    The HTTP URL for this team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamChangeParentTeamAuditEntry\n

    \n

    Audit log entry for a team.change_parent_team event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isLdapMapped (Boolean)

    Whether the team was mapped to an LDAP Group.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    parentTeam (Team)

    The new parent team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    parentTeamName (String)

    The name of the new parent team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    parentTeamNameWas (String)

    The name of the former parent team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    parentTeamResourcePath (URI)

    The HTTP path for the parent team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    parentTeamUrl (URI)

    The HTTP URL for the parent team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    parentTeamWas (Team)

    The former parent team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    parentTeamWasResourcePath (URI)

    The HTTP path for the previous parent team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    parentTeamWasUrl (URI)

    The HTTP URL for the previous parent team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    team (Team)

    The team associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamName (String)

    The name of the team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamResourcePath (URI)

    The HTTP path for this team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamUrl (URI)

    The HTTP URL for this team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamConnection\n

    \n

    The connection type for Team.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([TeamEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Team])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamDiscussion\n

    \n

    A team discussion.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    author (Actor)

    The actor who authored the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    authorAssociation (CommentAuthorAssociation!)

    Author's association with the discussion's team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    body (String!)

    The body as Markdown.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyHTML (HTML!)

    The body rendered to HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyText (String!)

    The body rendered to text.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyVersion (String!)

    Identifies the discussion body hash.

    \n\n\n\n\n\n\n\n\n\n\n\n

    comments (TeamDiscussionCommentConnection!)

    A list of comments on this discussion.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    fromComment (Int)

    \n

    When provided, filters the connection such that results begin with the comment with this number.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (TeamDiscussionCommentOrder)

    \n

    Order for connection.

    \n\n
    \n\n
    \n\n\n

    commentsResourcePath (URI!)

    The HTTP path for discussion comments.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commentsUrl (URI!)

    The HTTP URL for discussion comments.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdViaEmail (Boolean!)

    Check if this comment was created via an email reply.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    editor (Actor)

    The actor who edited the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    includesCreatedEdit (Boolean!)

    Check if this comment was edited and includes an edit with the creation data.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isPinned (Boolean!)

    Whether or not the discussion is pinned.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isPrivate (Boolean!)

    Whether or not the discussion is only visible to team members and org admins.

    \n\n\n\n\n\n\n\n\n\n\n\n

    lastEditedAt (DateTime)

    The moment the editor made the last edit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    number (Int!)

    Identifies the discussion within its team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    publishedAt (DateTime)

    Identifies when the comment was published at.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reactionGroups ([ReactionGroup!])

    A list of reactions grouped by content left on the subject.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reactions (ReactionConnection!)

    A list of Reactions left on the Issue.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    content (ReactionContent)

    \n

    Allows filtering Reactions by emoji.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (ReactionOrder)

    \n

    Allows specifying the order in which reactions are returned.

    \n\n
    \n\n
    \n\n\n

    resourcePath (URI!)

    The HTTP path for this discussion.

    \n\n\n\n\n\n\n\n\n\n\n\n

    team (Team!)

    The team that defines the context of this discussion.

    \n\n\n\n\n\n\n\n\n\n\n\n

    title (String!)

    The title of the discussion.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this discussion.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userContentEdits (UserContentEditConnection)

    A list of edits to this content.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    viewerCanDelete (Boolean!)

    Check if the current viewer can delete this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanPin (Boolean!)

    Whether or not the current viewer can pin this discussion.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanReact (Boolean!)

    Can user react to this subject.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanSubscribe (Boolean!)

    Check if the viewer is able to change their subscription status for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanUpdate (Boolean!)

    Check if the current viewer can update this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

    Reasons why the current viewer can not update this comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerDidAuthor (Boolean!)

    Did the viewer author this comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerSubscription (SubscriptionState)

    Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamDiscussionComment\n

    \n

    A comment on a team discussion.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    author (Actor)

    The actor who authored the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    authorAssociation (CommentAuthorAssociation!)

    Author's association with the comment's team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    body (String!)

    The body as Markdown.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyHTML (HTML!)

    The body rendered to HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyText (String!)

    The body rendered to text.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyVersion (String!)

    The current version of the body content.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdViaEmail (Boolean!)

    Check if this comment was created via an email reply.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    discussion (TeamDiscussion!)

    The discussion this comment is about.

    \n\n\n\n\n\n\n\n\n\n\n\n

    editor (Actor)

    The actor who edited the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    includesCreatedEdit (Boolean!)

    Check if this comment was edited and includes an edit with the creation data.

    \n\n\n\n\n\n\n\n\n\n\n\n

    lastEditedAt (DateTime)

    The moment the editor made the last edit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    number (Int!)

    Identifies the comment number.

    \n\n\n\n\n\n\n\n\n\n\n\n

    publishedAt (DateTime)

    Identifies when the comment was published at.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reactionGroups ([ReactionGroup!])

    A list of reactions grouped by content left on the subject.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reactions (ReactionConnection!)

    A list of Reactions left on the Issue.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    content (ReactionContent)

    \n

    Allows filtering Reactions by emoji.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (ReactionOrder)

    \n

    Allows specifying the order in which reactions are returned.

    \n\n
    \n\n
    \n\n\n

    resourcePath (URI!)

    The HTTP path for this comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userContentEdits (UserContentEditConnection)

    A list of edits to this content.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    viewerCanDelete (Boolean!)

    Check if the current viewer can delete this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanReact (Boolean!)

    Can user react to this subject.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanUpdate (Boolean!)

    Check if the current viewer can update this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

    Reasons why the current viewer can not update this comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerDidAuthor (Boolean!)

    Did the viewer author this comment.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamDiscussionCommentConnection\n

    \n

    The connection type for TeamDiscussionComment.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([TeamDiscussionCommentEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([TeamDiscussionComment])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamDiscussionCommentEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (TeamDiscussionComment)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamDiscussionConnection\n

    \n

    The connection type for TeamDiscussion.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([TeamDiscussionEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([TeamDiscussion])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamDiscussionEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (TeamDiscussion)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (Team)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamMemberConnection\n

    \n

    The connection type for User.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([TeamMemberEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([User])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamMemberEdge\n

    \n

    Represents a user who is a member of a team.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    memberAccessResourcePath (URI!)

    The HTTP path to the organization's member access page.

    \n\n\n\n\n\n\n\n\n\n\n\n

    memberAccessUrl (URI!)

    The HTTP URL to the organization's member access page.

    \n\n\n\n\n\n\n\n\n\n\n\n

    role (TeamMemberRole!)

    The role the member has on the team.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamRemoveMemberAuditEntry\n

    \n

    Audit log entry for a team.remove_member event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isLdapMapped (Boolean)

    Whether the team was mapped to an LDAP Group.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    team (Team)

    The team associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamName (String)

    The name of the team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamResourcePath (URI)

    The HTTP path for this team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamUrl (URI)

    The HTTP URL for this team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamRemoveRepositoryAuditEntry\n

    \n

    Audit log entry for a team.remove_repository event.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    action (String!)

    The action name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actor (AuditEntryActor)

    The user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorIp (String)

    The IP address of the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLocation (ActorLocation)

    A readable representation of the actor's location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorLogin (String)

    The username of the user who initiated the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorResourcePath (URI)

    The HTTP path for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    actorUrl (URI)

    The HTTP URL for the actor.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (PreciseDateTime!)

    The time the action was initiated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isLdapMapped (Boolean)

    Whether the team was mapped to an LDAP Group.

    \n\n\n\n\n\n\n\n\n\n\n\n

    operationType (OperationType)

    The corresponding operation type for the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The Organization associated with the Audit Entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationName (String)

    The name of the Organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationResourcePath (URI)

    The HTTP path for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationUrl (URI)

    The HTTP URL for the organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository)

    The repository associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryName (String)

    The name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryResourcePath (URI)

    The HTTP path for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryUrl (URI)

    The HTTP URL for the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    team (Team)

    The team associated with the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamName (String)

    The name of the team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamResourcePath (URI)

    The HTTP path for this team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamUrl (URI)

    The HTTP URL for this team.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    The user affected by the action.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userLogin (String)

    For actions involving two users, the actor is the initiator and the user is the affected user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userResourcePath (URI)

    The HTTP path for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userUrl (URI)

    The HTTP URL for the user.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamRepositoryConnection\n

    \n

    The connection type for Repository.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([TeamRepositoryEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([Repository])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamRepositoryEdge\n

    \n

    Represents a team repository.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    permission (RepositoryPermission!)

    The permission level the team has on the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TextMatch\n

    \n

    A text match within a search result.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    fragment (String!)

    The specific text fragment within the property matched on.

    \n\n\n\n\n\n\n\n\n\n\n\n

    highlights ([TextMatchHighlight!]!)

    Highlights within the matched fragment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    property (String!)

    The property matched on.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TextMatchHighlight\n

    \n

    Represents a single highlight in a search result match.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    beginIndice (Int!)

    The indice in the fragment where the matched text begins.

    \n\n\n\n\n\n\n\n\n\n\n\n

    endIndice (Int!)

    The indice in the fragment where the matched text ends.

    \n\n\n\n\n\n\n\n\n\n\n\n

    text (String!)

    The text matched.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Topic\n

    \n

    A topic aggregates entities that are related to a subject.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    name (String!)

    The topic's name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    relatedTopics ([Topic!]!)

    A list of related topics, including aliases of this topic, sorted with the most relevant\nfirst. Returns up to 10 Topics.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    first (Int)

    \n

    How many topics to return.

    \n

    The default value is 3.

    \n
    \n\n
    \n\n\n

    stargazerCount (Int!)

    Returns a count of how many stargazers there are on this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    stargazers (StargazerConnection!)

    A list of users who have starred this starrable.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (StarOrder)

    \n

    Order for connection.

    \n\n
    \n\n
    \n\n\n

    viewerHasStarred (Boolean!)

    Returns a boolean indicating whether the viewing user has starred this starrable.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TransferredEvent\n

    \n

    Represents atransferredevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    fromRepository (Repository)

    The repository this came from.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issue (Issue!)

    Identifies the issue associated with the event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n Tree\n

    \n

    Represents a Git tree.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    abbreviatedOid (String!)

    An abbreviated version of the Git object ID.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commitResourcePath (URI!)

    The HTTP path for this Git object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commitUrl (URI!)

    The HTTP URL for this Git object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    entries ([TreeEntry!])

    A list of tree entries.

    \n\n\n\n\n\n\n\n\n\n\n\n

    oid (GitObjectID!)

    The Git object ID.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository!)

    The Repository the Git object belongs to.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n TreeEntry\n

    \n

    Represents a Git tree entry.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    extension (String)

    The extension of the file.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isGenerated (Boolean!)

    Whether or not this tree entry is generated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    mode (Int!)

    Entry file mode.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    Entry file name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    object (GitObject)

    Entry file object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    oid (GitObjectID!)

    Entry file Git object ID.

    \n\n\n\n\n\n\n\n\n\n\n\n

    path (String)

    The full path of the file.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (Repository!)

    The Repository the tree entry belongs to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    submodule (Submodule)

    If the TreeEntry is for a directory occupied by a submodule project, this returns the corresponding submodule.

    \n\n\n\n\n\n\n\n\n\n\n\n

    type (String!)

    Entry file type.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n UnassignedEvent\n

    \n

    Represents anunassignedevent on any assignable object.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    assignable (Assignable!)

    Identifies the assignable associated with the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    assignee (Assignee)

    Identifies the user or mannequin that was unassigned.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User)

    Identifies the subject (user) who was unassigned.

    \n\n\n\n\n\n\n
    \n

    Deprecation notice

    \n

    user is deprecated.

    Assignees can now be mannequins. Use the assignee field instead. Removal on 2020-01-01 UTC.

    \n
    \n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n UnknownSignature\n

    \n

    Represents an unknown signature on a Commit or Tag.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    email (String!)

    Email used to sign this object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isValid (Boolean!)

    True if the signature is valid and verified by GitHub.

    \n\n\n\n\n\n\n\n\n\n\n\n

    payload (String!)

    Payload for GPG signing object. Raw ODB object without the signature header.

    \n\n\n\n\n\n\n\n\n\n\n\n

    signature (String!)

    ASCII-armored signature header from object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    signer (User)

    GitHub user corresponding to the email signing this commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    state (GitSignatureState!)

    The state of this signature. VALID if signature is valid and verified by\nGitHub, otherwise represents reason why signature is considered invalid.

    \n\n\n\n\n\n\n\n\n\n\n\n

    wasSignedByGitHub (Boolean!)

    True if the signature was made with GitHub's signing key.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n UnlabeledEvent\n

    \n

    Represents anunlabeledevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    label (Label!)

    Identifies the label associated with theunlabeledevent.

    \n\n\n\n\n\n\n\n\n\n\n\n

    labelable (Labelable!)

    Identifies the Labelable associated with the event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n UnlockedEvent\n

    \n

    Represents anunlockedevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    lockable (Lockable!)

    Object that was unlocked.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n UnmarkedAsDuplicateEvent\n

    \n

    Represents anunmarked_as_duplicateevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    canonical (IssueOrPullRequest)

    The authoritative issue or pull request which has been duplicated by another.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    duplicate (IssueOrPullRequest)

    The issue or pull request which has been marked as a duplicate of another.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isCrossRepository (Boolean!)

    Canonical and duplicate belong to different repositories.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n UnpinnedEvent\n

    \n

    Represents anunpinnedevent on a given issue or pull request.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issue (Issue!)

    Identifies the issue associated with the event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n UnsubscribedEvent\n

    \n

    Represents anunsubscribedevent on a given Subscribable.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    subscribable (Subscribable!)

    Object referenced by event.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n User\n

    \n

    A user is an individual's account on GitHub that owns repositories and can make new content.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    anyPinnableItems (Boolean!)

    Determine if this repository owner has any items that can be pinned to their profile.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    type (PinnableItemType)

    \n

    Filter to only a particular kind of pinnable item.

    \n\n
    \n\n
    \n\n\n

    avatarUrl (URI!)

    A URL pointing to the user's public avatar.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    size (Int)

    \n

    The size of the resulting square image.

    \n\n
    \n\n
    \n\n\n

    bio (String)

    The user's public profile bio.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bioHTML (HTML!)

    The user's public profile bio as HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commitComments (CommitCommentConnection!)

    A list of commit comments made by this user.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    company (String)

    The user's public profile company.

    \n\n\n\n\n\n\n\n\n\n\n\n

    companyHTML (HTML!)

    The user's public profile company as HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    contributionsCollection (ContributionsCollection!)

    The collection of contributions this user has made to different repositories.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    from (DateTime)

    \n

    Only contributions made at this time or later will be counted. If omitted, defaults to a year ago.

    \n\n
    \n\n
    \n

    organizationID (ID)

    \n

    The ID of the organization used to filter contributions.

    \n\n
    \n\n
    \n

    to (DateTime)

    \n

    Only contributions made before and up to and including this time will be\ncounted. If omitted, defaults to the current time.

    \n\n
    \n\n
    \n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    email (String!)

    The user's publicly visible profile email.

    \n\n\n\n\n\n\n\n\n\n\n\n

    followers (FollowerConnection!)

    A list of users the given user is followed by.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    following (FollowingConnection!)

    A list of users the given user is following.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    gist (Gist)

    Find gist by repo name.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    name (String!)

    \n

    The gist name to find.

    \n\n
    \n\n
    \n\n\n

    gistComments (GistCommentConnection!)

    A list of gist comments made by this user.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    gists (GistConnection!)

    A list of the Gists the user has created.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (GistOrder)

    \n

    Ordering options for gists returned from the connection.

    \n\n
    \n\n
    \n

    privacy (GistPrivacy)

    \n

    Filters Gists according to privacy.

    \n\n
    \n\n
    \n\n\n

    hovercard (Hovercard!)

    The hovercard information for this user in a given context.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    primarySubjectId (ID)

    \n

    The ID of the subject to get the hovercard in the context of.

    \n\n
    \n\n
    \n\n\n

    isBountyHunter (Boolean!)

    Whether or not this user is a participant in the GitHub Security Bug Bounty.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isCampusExpert (Boolean!)

    Whether or not this user is a participant in the GitHub Campus Experts Program.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isDeveloperProgramMember (Boolean!)

    Whether or not this user is a GitHub Developer Program member.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isEmployee (Boolean!)

    Whether or not this user is a GitHub employee.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isGitHubStar (Boolean!)

    Whether or not this user is a member of the GitHub Stars Program.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isHireable (Boolean!)

    Whether or not the user has marked themselves as for hire.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isSiteAdmin (Boolean!)

    Whether or not this user is a site administrator.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isViewer (Boolean!)

    Whether or not this user is the viewing user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issueComments (IssueCommentConnection!)

    A list of issue comments made by this user.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (IssueCommentOrder)

    \n

    Ordering options for issue comments returned from the connection.

    \n\n
    \n\n
    \n\n\n

    issues (IssueConnection!)

    A list of issues associated with this user.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    filterBy (IssueFilters)

    \n

    Filtering options for issues returned from the connection.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    labels ([String!])

    \n

    A list of label names to filter the pull requests by.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (IssueOrder)

    \n

    Ordering options for issues returned from the connection.

    \n\n
    \n\n
    \n

    states ([IssueState!])

    \n

    A list of states to filter the issues by.

    \n\n
    \n\n
    \n\n\n

    itemShowcase (ProfileItemShowcase!)

    Showcases a selection of repositories and gists that the profile owner has\neither curated or that have been selected automatically based on popularity.

    \n\n\n\n\n\n\n\n\n\n\n\n

    location (String)

    The user's public profile location.

    \n\n\n\n\n\n\n\n\n\n\n\n

    login (String!)

    The username used to login.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String)

    The user's public profile name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    Find an organization by its login that the user belongs to.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    login (String!)

    \n

    The login of the organization to find.

    \n\n
    \n\n
    \n\n\n

    organizationVerifiedDomainEmails ([String!]!)

    Verified email addresses that match verified domains for a specified organization the user is a member of.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    login (String!)

    \n

    The login of the organization to match verified domains from.

    \n\n
    \n\n
    \n\n\n

    organizations (OrganizationConnection!)

    A list of organizations the user belongs to.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    pinnableItems (PinnableItemConnection!)

    A list of repositories and gists this profile owner can pin to their profile.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    types ([PinnableItemType!])

    \n

    Filter the types of pinnable items that are returned.

    \n\n
    \n\n
    \n\n\n

    pinnedItems (PinnableItemConnection!)

    A list of repositories and gists this profile owner has pinned to their profile.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    types ([PinnableItemType!])

    \n

    Filter the types of pinned items that are returned.

    \n\n
    \n\n
    \n\n\n

    pinnedItemsRemaining (Int!)

    Returns how many more items this profile owner can pin to their profile.

    \n\n\n\n\n\n\n\n\n\n\n\n

    project (Project)

    Find project by number.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    number (Int!)

    \n

    The project number to find.

    \n\n
    \n\n
    \n\n\n

    projects (ProjectConnection!)

    A list of projects under the owner.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (ProjectOrder)

    \n

    Ordering options for projects returned from the connection.

    \n\n
    \n\n
    \n

    search (String)

    \n

    Query to search projects by, currently only searching by name.

    \n\n
    \n\n
    \n

    states ([ProjectState!])

    \n

    A list of states to filter the projects by.

    \n\n
    \n\n
    \n\n\n

    projectsResourcePath (URI!)

    The HTTP path listing user's projects.

    \n\n\n\n\n\n\n\n\n\n\n\n

    projectsUrl (URI!)

    The HTTP URL listing user's projects.

    \n\n\n\n\n\n\n\n\n\n\n\n

    publicKeys (PublicKeyConnection!)

    A list of public keys associated with this user.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n\n\n

    pullRequests (PullRequestConnection!)

    A list of pull requests associated with this user.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    baseRefName (String)

    \n

    The base ref name to filter the pull requests by.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    headRefName (String)

    \n

    The head ref name to filter the pull requests by.

    \n\n
    \n\n
    \n

    labels ([String!])

    \n

    A list of label names to filter the pull requests by.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (IssueOrder)

    \n

    Ordering options for pull requests returned from the connection.

    \n\n
    \n\n
    \n

    states ([PullRequestState!])

    \n

    A list of states to filter the pull requests by.

    \n\n
    \n\n
    \n\n\n

    repositories (RepositoryConnection!)

    A list of repositories that the user owns.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    affiliations ([RepositoryAffiliation])

    \n

    Array of viewer's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\ncurrent viewer owns.

    \n\n
    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    isFork (Boolean)

    \n

    If non-null, filters repositories according to whether they are forks of another repository.

    \n\n
    \n\n
    \n

    isLocked (Boolean)

    \n

    If non-null, filters repositories according to whether they have been locked.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (RepositoryOrder)

    \n

    Ordering options for repositories returned from the connection.

    \n\n
    \n\n
    \n

    ownerAffiliations ([RepositoryAffiliation])

    \n

    Array of owner's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\norganization or user being viewed owns.

    \n\n
    \n\n
    \n

    privacy (RepositoryPrivacy)

    \n

    If non-null, filters repositories according to privacy.

    \n\n
    \n\n
    \n\n\n

    repositoriesContributedTo (RepositoryConnection!)

    A list of repositories that the user recently contributed to.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    contributionTypes ([RepositoryContributionType])

    \n

    If non-null, include only the specified types of contributions. The\nGitHub.com UI uses [COMMIT, ISSUE, PULL_REQUEST, REPOSITORY].

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    includeUserRepositories (Boolean)

    \n

    If true, include user repositories.

    \n\n
    \n\n
    \n

    isLocked (Boolean)

    \n

    If non-null, filters repositories according to whether they have been locked.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (RepositoryOrder)

    \n

    Ordering options for repositories returned from the connection.

    \n\n
    \n\n
    \n

    privacy (RepositoryPrivacy)

    \n

    If non-null, filters repositories according to privacy.

    \n\n
    \n\n
    \n\n\n

    repository (Repository)

    Find Repository.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    name (String!)

    \n

    Name of Repository to find.

    \n\n
    \n\n
    \n\n\n

    resourcePath (URI!)

    The HTTP path for this user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    savedReplies (SavedReplyConnection)

    Replies this user has saved.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (SavedReplyOrder)

    \n

    The field to order saved replies by.

    \n\n
    \n\n
    \n\n\n

    sponsorshipsAsMaintainer (SponsorshipConnection!)

    This object's sponsorships as the maintainer.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    includePrivate (Boolean)

    \n

    Whether or not to include private sponsorships in the result set.

    \n

    The default value is false.

    \n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (SponsorshipOrder)

    \n

    Ordering options for sponsorships returned from this connection. If left\nblank, the sponsorships will be ordered based on relevancy to the viewer.

    \n\n
    \n\n
    \n\n\n

    sponsorshipsAsSponsor (SponsorshipConnection!)

    This object's sponsorships as the sponsor.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (SponsorshipOrder)

    \n

    Ordering options for sponsorships returned from this connection. If left\nblank, the sponsorships will be ordered based on relevancy to the viewer.

    \n\n
    \n\n
    \n\n\n

    starredRepositories (StarredRepositoryConnection!)

    Repositories the user has starred.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (StarOrder)

    \n

    Order for connection.

    \n\n
    \n\n
    \n

    ownedByViewer (Boolean)

    \n

    Filters starred repositories to only return repositories owned by the viewer.

    \n\n
    \n\n
    \n\n\n

    status (UserStatus)

    The user's description of what they're currently doing.

    \n\n\n\n\n\n\n\n\n\n\n\n

    suspendedAt (DateTime)

    Identifies the date and time when the user was suspended.

    \n\n\n\n\n\n\n\n\n\n\n\n

    topRepositories (RepositoryConnection!)

    Repositories the user has contributed to, ordered by contribution rank, plus repositories the user has created.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (RepositoryOrder!)

    \n

    Ordering options for repositories returned from the connection.

    \n\n
    \n\n
    \n

    since (DateTime)

    \n

    How far back in time to fetch contributed repositories.

    \n\n
    \n\n
    \n\n\n

    twitterUsername (String)

    The user's Twitter username.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    url (URI!)

    The HTTP URL for this user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanChangePinnedItems (Boolean!)

    Can the viewer pin repositories and gists to the profile?.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanCreateProjects (Boolean!)

    Can the current viewer create new projects on this owner.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerCanFollow (Boolean!)

    Whether or not the viewer is able to follow the user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerIsFollowing (Boolean!)

    Whether or not this user is followed by the viewer.

    \n\n\n\n\n\n\n\n\n\n\n\n

    watching (RepositoryConnection!)

    A list of repositories the given user is watching.

    \n\n\n\n\n\n\n\n\n\n\n
    \n

    Arguments

    \n\n
    \n

    affiliations ([RepositoryAffiliation])

    \n

    Affiliation options for repositories returned from the connection. If none\nspecified, the results will include repositories for which the current\nviewer is an owner or collaborator, or member.

    \n\n
    \n\n
    \n

    after (String)

    \n

    Returns the elements in the list that come after the specified cursor.

    \n\n
    \n\n
    \n

    before (String)

    \n

    Returns the elements in the list that come before the specified cursor.

    \n\n
    \n\n
    \n

    first (Int)

    \n

    Returns the first n elements from the list.

    \n\n
    \n\n
    \n

    isLocked (Boolean)

    \n

    If non-null, filters repositories according to whether they have been locked.

    \n\n
    \n\n
    \n

    last (Int)

    \n

    Returns the last n elements from the list.

    \n\n
    \n\n
    \n

    orderBy (RepositoryOrder)

    \n

    Ordering options for repositories returned from the connection.

    \n\n
    \n\n
    \n

    ownerAffiliations ([RepositoryAffiliation])

    \n

    Array of owner's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\norganization or user being viewed owns.

    \n\n
    \n\n
    \n

    privacy (RepositoryPrivacy)

    \n

    If non-null, filters repositories according to privacy.

    \n\n
    \n\n
    \n\n\n

    websiteUrl (URI)

    A URL pointing to the user's public website/blog.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n UserBlockedEvent\n

    \n

    Represents auser_blockedevent on a given user.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actor (Actor)

    Identifies the actor who performed the event.

    \n\n\n\n\n\n\n\n\n\n\n\n

    blockDuration (UserBlockDuration!)

    Number of days that the user was blocked for.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    subject (User)

    The user who was blocked.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n UserConnection\n

    \n

    The connection type for User.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([UserEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([User])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n UserContentEdit\n

    \n

    An edit on user content.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    deletedAt (DateTime)

    Identifies the date and time when the object was deleted.

    \n\n\n\n\n\n\n\n\n\n\n\n

    deletedBy (Actor)

    The actor who deleted this content.

    \n\n\n\n\n\n\n\n\n\n\n\n

    diff (String)

    A summary of the changes for this edit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    editedAt (DateTime!)

    When this content was edited.

    \n\n\n\n\n\n\n\n\n\n\n\n

    editor (Actor)

    The actor who edited this content.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n UserContentEditConnection\n

    \n

    A list of edits to content.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([UserContentEditEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([UserContentEdit])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n UserContentEditEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (UserContentEdit)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n UserEdge\n

    \n

    Represents a user.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (User)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n UserEmailMetadata\n

    \n

    Email attributes from External Identity.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    primary (Boolean)

    Boolean to identify primary emails.

    \n\n\n\n\n\n\n\n\n\n\n\n

    type (String)

    Type of email.

    \n\n\n\n\n\n\n\n\n\n\n\n

    value (String!)

    Email id.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n UserStatus\n

    \n

    The user's description of what they're currently doing.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    emoji (String)

    An emoji summarizing the user's status.

    \n\n\n\n\n\n\n\n\n\n\n\n

    emojiHTML (HTML)

    The status emoji as HTML.

    \n\n\n\n\n\n\n\n\n\n\n\n

    expiresAt (DateTime)

    If set, the status will not be shown after this date.

    \n\n\n\n\n\n\n\n\n\n\n\n

    id (ID!)

    ID of the object.

    \n\n\n\n\n\n\n\n\n\n\n\n

    indicatesLimitedAvailability (Boolean!)

    Whether this status indicates the user is not fully available on GitHub.

    \n\n\n\n\n\n\n\n\n\n\n\n

    message (String)

    A brief message describing what the user is doing.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organization (Organization)

    The organization whose members can see this status. If null, this status is publicly visible.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    user (User!)

    The user who has this status.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n UserStatusConnection\n

    \n

    The connection type for UserStatus.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([UserStatusEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([UserStatus])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n UserStatusEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (UserStatus)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n VerifiableDomain\n

    \n

    A domain that can be verified for an organization or an enterprise.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    createdAt (DateTime!)

    Identifies the date and time when the object was created.

    \n\n\n\n\n\n\n\n\n\n\n\n

    databaseId (Int)

    Identifies the primary key from the database.

    \n\n\n\n\n\n\n\n\n\n\n\n

    dnsHostName (URI)

    The DNS host name that should be used for verification.

    \n\n\n\n\n\n\n\n\n\n\n\n

    domain (URI!)

    The unicode encoded domain.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hasFoundHostName (Boolean!)

    Whether a TXT record for verification with the expected host name was found.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hasFoundVerificationToken (Boolean!)

    Whether a TXT record for verification with the expected verification token was found.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isRequiredForPolicyEnforcement (Boolean!)

    Whether this domain is required to exist for an organization or enterprise policy to be enforced.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isVerified (Boolean!)

    Whether or not the domain is verified.

    \n\n\n\n\n\n\n\n\n\n\n\n

    owner (VerifiableDomainOwner!)

    The owner of the domain.

    \n\n\n\n\n\n\n\n\n\n\n\n

    punycodeEncodedDomain (URI!)

    The punycode encoded domain.

    \n\n\n\n\n\n\n\n\n\n\n\n

    tokenExpirationTime (DateTime)

    The time that the current verification token will expire.

    \n\n\n\n\n\n\n\n\n\n\n\n

    updatedAt (DateTime!)

    Identifies the date and time when the object was last updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    verificationToken (String)

    The current verification token for the domain.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n VerifiableDomainConnection\n

    \n

    The connection type for VerifiableDomain.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    edges ([VerifiableDomainEdge])

    A list of edges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    nodes ([VerifiableDomain])

    A list of nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pageInfo (PageInfo!)

    Information to aid in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    totalCount (Int!)

    Identifies the total count of items in the connection.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n VerifiableDomainEdge\n

    \n

    An edge in a connection.

    \n
    \n\n
    \n \n\n \n\n\n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cursor (String!)

    A cursor for use in pagination.

    \n\n\n\n\n\n\n\n\n\n\n\n

    node (VerifiableDomain)

    The item at the end of the edge.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n\n
    \n
    \n

    \n ViewerHovercardContext\n

    \n

    A hovercard context with a message describing how the viewer is related.

    \n
    \n\n
    \n \n\n \n\n\n \n

    \n \n \n\n \n

    Fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    message (String!)

    A string describing this context.

    \n\n\n\n\n\n\n\n\n\n\n\n

    octicon (String!)

    An octicon to accompany this context.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewer (User!)

    Identifies the user who is related to this context.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n \n
    \n
    \n
    \n", "miniToc": [ { "contents": "\n ActorLocation\n ", @@ -13127,6 +13127,16 @@ "headingLevel": 3, "indentationLevel": 0 }, + { + "contents": "\n VerifiableDomainConnection\n ", + "headingLevel": 3, + "indentationLevel": 0 + }, + { + "contents": "\n VerifiableDomainEdge\n ", + "headingLevel": 3, + "indentationLevel": 0 + }, { "contents": "\n ViewerHovercardContext\n ", "headingLevel": 3, diff --git a/lib/graphql/static/previews.json b/lib/graphql/static/previews.json index 2cc645473a..c444768e75 100644 --- a/lib/graphql/static/previews.json +++ b/lib/graphql/static/previews.json @@ -114,24 +114,6 @@ "accept_header": "application/vnd.github.corsair-preview+json", "href": "/graphql/overview/schema-previews#create-content-attachments-preview" }, - { - "title": "Pinned issues preview", - "description": "This preview adds support for pinned issues.", - "toggled_by": "elektra-preview", - "toggled_on": [ - "Repository.pinnedIssues", - "PinnedIssue", - "PinnedIssueEdge", - "PinnedIssueConnection", - "Mutation.pinIssue", - "Mutation.unpinIssue" - ], - "owning_teams": [ - "@github/pe-pull-requests" - ], - "accept_header": "application/vnd.github.elektra-preview+json", - "href": "/graphql/overview/schema-previews#pinned-issues-preview" - }, { "title": "Labels preview", "description": "This preview adds support for adding, updating, creating and deleting labels.", @@ -1181,24 +1163,6 @@ "accept_header": "application/vnd.github.corsair-preview+json", "href": "/graphql/overview/schema-previews#create-content-attachments-preview" }, - { - "title": "Pinned issues preview", - "description": "This preview adds support for pinned issues.", - "toggled_by": "elektra-preview", - "toggled_on": [ - "Repository.pinnedIssues", - "PinnedIssue", - "PinnedIssueEdge", - "PinnedIssueConnection", - "Mutation.pinIssue", - "Mutation.unpinIssue" - ], - "owning_teams": [ - "@github/pe-pull-requests" - ], - "accept_header": "application/vnd.github.elektra-preview+json", - "href": "/graphql/overview/schema-previews#pinned-issues-preview" - }, { "title": "Labels preview", "description": "This preview adds support for adding, updating, creating and deleting labels.", diff --git a/lib/graphql/static/schema-dotcom.json b/lib/graphql/static/schema-dotcom.json index 6da45fc006..b2cc6e5570 100644 --- a/lib/graphql/static/schema-dotcom.json +++ b/lib/graphql/static/schema-dotcom.json @@ -1389,6 +1389,40 @@ } ] }, + { + "name": "approveVerifiableDomain", + "kind": "mutations", + "id": "approveverifiabledomain", + "href": "/graphql/reference/mutations#approveverifiabledomain", + "description": "

    Approve a verifiable domain for notification delivery.

    ", + "inputFields": [ + { + "name": "input", + "type": "ApproveVerifiableDomainInput!", + "id": "approveverifiabledomaininput", + "kind": "input-objects", + "href": "/graphql/reference/input-objects#approveverifiabledomaininput" + } + ], + "returnFields": [ + { + "name": "clientMutationId", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string", + "description": "

    A unique identifier for the client performing the mutation.

    " + }, + { + "name": "domain", + "type": "VerifiableDomain", + "id": "verifiabledomain", + "kind": "objects", + "href": "/graphql/reference/objects#verifiabledomain", + "description": "

    The verifiable domain that was approved.

    " + } + ] + }, { "name": "archiveRepository", "kind": "mutations", @@ -3471,25 +3505,6 @@ "id": "pinissue", "href": "/graphql/reference/mutations#pinissue", "description": "

    Pin an issue to a repository.

    ", - "isDeprecated": false, - "preview": { - "title": "Pinned issues preview", - "description": "This preview adds support for pinned issues.", - "toggled_by": "elektra-preview", - "toggled_on": [ - "Repository.pinnedIssues", - "PinnedIssue", - "PinnedIssueEdge", - "PinnedIssueConnection", - "Mutation.pinIssue", - "Mutation.unpinIssue" - ], - "owning_teams": [ - "@github/pe-pull-requests" - ], - "accept_header": "application/vnd.github.elektra-preview+json", - "href": "/graphql/overview/schema-previews#pinned-issues-preview" - }, "inputFields": [ { "name": "input", @@ -4590,25 +4605,6 @@ "id": "unpinissue", "href": "/graphql/reference/mutations#unpinissue", "description": "

    Unpin a pinned issue from a repository.

    ", - "isDeprecated": false, - "preview": { - "title": "Pinned issues preview", - "description": "This preview adds support for pinned issues.", - "toggled_by": "elektra-preview", - "toggled_on": [ - "Repository.pinnedIssues", - "PinnedIssue", - "PinnedIssueEdge", - "PinnedIssueConnection", - "Mutation.pinIssue", - "Mutation.unpinIssue" - ], - "owning_teams": [ - "@github/pe-pull-requests" - ], - "accept_header": "application/vnd.github.elektra-preview+json", - "href": "/graphql/overview/schema-previews#pinned-issues-preview" - }, "inputFields": [ { "name": "input", @@ -8344,6 +8340,26 @@ "kind": "scalars", "href": "/graphql/reference/scalars#string" }, + { + "name": "isRequired", + "description": "

    Whether this check run is required to pass before merging.

    ", + "type": "Boolean!", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean", + "arguments": [ + { + "name": "pullRequestId", + "description": "

    The pull request this check is required for.

    ", + "type": { + "name": "ID!", + "id": "id", + "kind": "scalars", + "href": "/graphql/reference/scalars#id" + } + } + ] + }, { "name": "name", "description": "

    The name of the check for this check run.

    ", @@ -20164,6 +20180,14 @@ "kind": "scalars", "href": "/graphql/reference/scalars#boolean" }, + { + "name": "isPinned", + "description": "

    Indicates whether or not this issue is currently pinned to the repository issues list.

    ", + "type": "Boolean", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + }, { "name": "isReadByViewer", "description": "

    Is this issue read by the viewer.

    ", @@ -29786,7 +29810,7 @@ }, { "name": "isVerified", - "description": "

    Whether the organization has verified its profile email and website, always false on Enterprise.

    ", + "description": "

    Whether the organization has verified its profile email and website.

    ", "type": "Boolean!", "id": "boolean", "kind": "scalars", @@ -32374,25 +32398,6 @@ "id": "pinnedissue", "href": "/graphql/reference/objects#pinnedissue", "description": "

    A Pinned Issue is a issue pinned to a repository's index page.

    ", - "isDeprecated": false, - "preview": { - "title": "Pinned issues preview", - "description": "This preview adds support for pinned issues.", - "toggled_by": "elektra-preview", - "toggled_on": [ - "Repository.pinnedIssues", - "PinnedIssue", - "PinnedIssueEdge", - "PinnedIssueConnection", - "Mutation.pinIssue", - "Mutation.unpinIssue" - ], - "owning_teams": [ - "@github/pe-pull-requests" - ], - "accept_header": "application/vnd.github.elektra-preview+json", - "href": "/graphql/overview/schema-previews#pinned-issues-preview" - }, "implements": [ { "name": "Node", @@ -32441,25 +32446,6 @@ "id": "pinnedissueconnection", "href": "/graphql/reference/objects#pinnedissueconnection", "description": "

    The connection type for PinnedIssue.

    ", - "isDeprecated": false, - "preview": { - "title": "Pinned issues preview", - "description": "This preview adds support for pinned issues.", - "toggled_by": "elektra-preview", - "toggled_on": [ - "Repository.pinnedIssues", - "PinnedIssue", - "PinnedIssueEdge", - "PinnedIssueConnection", - "Mutation.pinIssue", - "Mutation.unpinIssue" - ], - "owning_teams": [ - "@github/pe-pull-requests" - ], - "accept_header": "application/vnd.github.elektra-preview+json", - "href": "/graphql/overview/schema-previews#pinned-issues-preview" - }, "fields": [ { "name": "edges", @@ -32501,25 +32487,6 @@ "id": "pinnedissueedge", "href": "/graphql/reference/objects#pinnedissueedge", "description": "

    An edge in a connection.

    ", - "isDeprecated": false, - "preview": { - "title": "Pinned issues preview", - "description": "This preview adds support for pinned issues.", - "toggled_by": "elektra-preview", - "toggled_on": [ - "Repository.pinnedIssues", - "PinnedIssue", - "PinnedIssueEdge", - "PinnedIssueConnection", - "Mutation.pinIssue", - "Mutation.unpinIssue" - ], - "owning_teams": [ - "@github/pe-pull-requests" - ], - "accept_header": "application/vnd.github.elektra-preview+json", - "href": "/graphql/overview/schema-previews#pinned-issues-preview" - }, "fields": [ { "name": "cursor", @@ -38819,6 +38786,14 @@ "kind": "objects", "href": "/graphql/reference/objects#ref" }, + { + "name": "tagCommit", + "description": "

    The tag commit for this release.

    ", + "type": "Commit", + "id": "commit", + "kind": "objects", + "href": "/graphql/reference/objects#commit" + }, { "name": "tagName", "description": "

    The name of the release's Git tag.

    ", @@ -44693,26 +44668,7 @@ "href": "/graphql/reference/scalars#int" } } - ], - "isDeprecated": false, - "preview": { - "title": "Pinned issues preview", - "description": "This preview adds support for pinned issues.", - "toggled_by": "elektra-preview", - "toggled_on": [ - "Repository.pinnedIssues", - "PinnedIssue", - "PinnedIssueEdge", - "PinnedIssueConnection", - "Mutation.pinIssue", - "Mutation.unpinIssue" - ], - "owning_teams": [ - "@github/pe-pull-requests" - ], - "accept_header": "application/vnd.github.elektra-preview+json", - "href": "/graphql/overview/schema-previews#pinned-issues-preview" - } + ] }, { "name": "primaryLanguage", @@ -49061,6 +49017,26 @@ "kind": "scalars", "href": "/graphql/reference/scalars#string" }, + { + "name": "isRequired", + "description": "

    Whether this status is required to pass before merging.

    ", + "type": "Boolean!", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean", + "arguments": [ + { + "name": "pullRequestId", + "description": "

    The pull request this status is required for.

    ", + "type": { + "name": "ID!", + "id": "id", + "kind": "scalars", + "href": "/graphql/reference/scalars#id" + } + } + ] + }, { "name": "state", "description": "

    The state of this status context.

    ", @@ -53892,6 +53868,14 @@ "kind": "scalars", "href": "/graphql/reference/scalars#boolean" }, + { + "name": "isGitHubStar", + "description": "

    Whether or not this user is a member of the GitHub Stars Program.

    ", + "type": "Boolean!", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + }, { "name": "isHireable", "description": "

    Whether or not the user has marked themselves as for hire.

    ", @@ -55936,6 +55920,14 @@ } ], "fields": [ + { + "name": "createdAt", + "description": "

    Identifies the date and time when the object was created.

    ", + "type": "DateTime!", + "id": "datetime", + "kind": "scalars", + "href": "/graphql/reference/scalars#datetime" + }, { "name": "databaseId", "description": "

    Identifies the primary key from the database.

    ", @@ -56016,6 +56008,14 @@ "kind": "scalars", "href": "/graphql/reference/scalars#datetime" }, + { + "name": "updatedAt", + "description": "

    Identifies the date and time when the object was last updated.

    ", + "type": "DateTime!", + "id": "datetime", + "kind": "scalars", + "href": "/graphql/reference/scalars#datetime" + }, { "name": "verificationToken", "description": "

    The current verification token for the domain.

    ", @@ -62056,6 +62056,10 @@ "href": "/graphql/reference/enums#verifiabledomainorderfield", "description": "

    Properties by which verifiable domain connections can be ordered.

    ", "values": [ + { + "name": "CREATED_AT", + "description": "

    Order verifiable domains by their creation date.

    " + }, { "name": "DOMAIN", "description": "

    Order verifiable domains by the domain name.

    " @@ -64196,6 +64200,32 @@ } ] }, + { + "name": "ApproveVerifiableDomainInput", + "kind": "inputObjects", + "id": "approveverifiabledomaininput", + "href": "/graphql/reference/input-objects#approveverifiabledomaininput", + "description": "

    Autogenerated input type of ApproveVerifiableDomain.

    ", + "inputFields": [ + { + "name": "clientMutationId", + "description": "

    A unique identifier for the client performing the mutation.

    ", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "id", + "description": "

    The ID of the verifiable domain to approve.

    ", + "type": "ID!", + "id": "id", + "kind": "scalars", + "href": "/graphql/reference/scalars#id", + "isDeprecated": false + } + ] + }, { "name": "ArchiveRepositoryInput", "kind": "inputObjects", diff --git a/lib/graphql/static/schema-ghae.json b/lib/graphql/static/schema-ghae.json index 8d758e8e31..ec2fd1aadf 100644 --- a/lib/graphql/static/schema-ghae.json +++ b/lib/graphql/static/schema-ghae.json @@ -1022,6 +1022,74 @@ } ] }, + { + "name": "addVerifiableDomain", + "kind": "mutations", + "id": "addverifiabledomain", + "href": "/graphql/reference/mutations#addverifiabledomain", + "description": "

    Adds a verifiable domain to an owning account.

    ", + "inputFields": [ + { + "name": "input", + "type": "AddVerifiableDomainInput!", + "id": "addverifiabledomaininput", + "kind": "input-objects", + "href": "/graphql/reference/input-objects#addverifiabledomaininput" + } + ], + "returnFields": [ + { + "name": "clientMutationId", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string", + "description": "

    A unique identifier for the client performing the mutation.

    " + }, + { + "name": "domain", + "type": "VerifiableDomain", + "id": "verifiabledomain", + "kind": "objects", + "href": "/graphql/reference/objects#verifiabledomain", + "description": "

    The verifiable domain that was added.

    " + } + ] + }, + { + "name": "approveVerifiableDomain", + "kind": "mutations", + "id": "approveverifiabledomain", + "href": "/graphql/reference/mutations#approveverifiabledomain", + "description": "

    Approve a verifiable domain for notification delivery.

    ", + "inputFields": [ + { + "name": "input", + "type": "ApproveVerifiableDomainInput!", + "id": "approveverifiabledomaininput", + "kind": "input-objects", + "href": "/graphql/reference/input-objects#approveverifiabledomaininput" + } + ], + "returnFields": [ + { + "name": "clientMutationId", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string", + "description": "

    A unique identifier for the client performing the mutation.

    " + }, + { + "name": "domain", + "type": "VerifiableDomain", + "id": "verifiabledomain", + "kind": "objects", + "href": "/graphql/reference/objects#verifiabledomain", + "description": "

    The verifiable domain that was approved.

    " + } + ] + }, { "name": "archiveRepository", "kind": "mutations", @@ -1560,6 +1628,48 @@ } ] }, + { + "name": "createEnterpriseOrganization", + "kind": "mutations", + "id": "createenterpriseorganization", + "href": "/graphql/reference/mutations#createenterpriseorganization", + "description": "

    Creates an organization as part of an enterprise account.

    ", + "inputFields": [ + { + "name": "input", + "type": "CreateEnterpriseOrganizationInput!", + "id": "createenterpriseorganizationinput", + "kind": "input-objects", + "href": "/graphql/reference/input-objects#createenterpriseorganizationinput" + } + ], + "returnFields": [ + { + "name": "clientMutationId", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string", + "description": "

    A unique identifier for the client performing the mutation.

    " + }, + { + "name": "enterprise", + "type": "Enterprise", + "id": "enterprise", + "kind": "objects", + "href": "/graphql/reference/objects#enterprise", + "description": "

    The enterprise that owns the created organization.

    " + }, + { + "name": "organization", + "type": "Organization", + "id": "organization", + "kind": "objects", + "href": "/graphql/reference/objects#organization", + "description": "

    The organization that was created.

    " + } + ] + }, { "name": "createIpAllowListEntry", "kind": "mutations", @@ -2334,6 +2444,40 @@ } ] }, + { + "name": "deleteVerifiableDomain", + "kind": "mutations", + "id": "deleteverifiabledomain", + "href": "/graphql/reference/mutations#deleteverifiabledomain", + "description": "

    Deletes a verifiable domain.

    ", + "inputFields": [ + { + "name": "input", + "type": "DeleteVerifiableDomainInput!", + "id": "deleteverifiabledomaininput", + "kind": "input-objects", + "href": "/graphql/reference/input-objects#deleteverifiabledomaininput" + } + ], + "returnFields": [ + { + "name": "clientMutationId", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string", + "description": "

    A unique identifier for the client performing the mutation.

    " + }, + { + "name": "owner", + "type": "VerifiableDomainOwner", + "id": "verifiabledomainowner", + "kind": "unions", + "href": "/graphql/reference/unions#verifiabledomainowner", + "description": "

    The owning account from which the domain was deleted.

    " + } + ] + }, { "name": "disablePullRequestAutoMerge", "kind": "mutations", @@ -2870,25 +3014,6 @@ "id": "pinissue", "href": "/graphql/reference/mutations#pinissue", "description": "

    Pin an issue to a repository.

    ", - "isDeprecated": false, - "preview": { - "title": "Pinned issues preview", - "description": "This preview adds support for pinned issues.", - "toggled_by": "elektra-preview", - "toggled_on": [ - "Repository.pinnedIssues", - "PinnedIssue", - "PinnedIssueEdge", - "PinnedIssueConnection", - "Mutation.pinIssue", - "Mutation.unpinIssue" - ], - "owning_teams": [ - "@github/pe-pull-requests" - ], - "accept_header": "application/vnd.github.elektra-preview+json", - "href": "/graphql/overview/schema-previews#pinned-issues-preview" - }, "inputFields": [ { "name": "input", @@ -2917,6 +3042,40 @@ } ] }, + { + "name": "regenerateVerifiableDomainToken", + "kind": "mutations", + "id": "regenerateverifiabledomaintoken", + "href": "/graphql/reference/mutations#regenerateverifiabledomaintoken", + "description": "

    Regenerates a verifiable domain's verification token.

    ", + "inputFields": [ + { + "name": "input", + "type": "RegenerateVerifiableDomainTokenInput!", + "id": "regenerateverifiabledomaintokeninput", + "kind": "input-objects", + "href": "/graphql/reference/input-objects#regenerateverifiabledomaintokeninput" + } + ], + "returnFields": [ + { + "name": "clientMutationId", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string", + "description": "

    A unique identifier for the client performing the mutation.

    " + }, + { + "name": "verificationToken", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string", + "description": "

    The verification token that was generated.

    " + } + ] + }, { "name": "removeAssigneesFromAssignable", "kind": "mutations", @@ -3667,25 +3826,6 @@ "id": "unpinissue", "href": "/graphql/reference/mutations#unpinissue", "description": "

    Unpin a pinned issue from a repository.

    ", - "isDeprecated": false, - "preview": { - "title": "Pinned issues preview", - "description": "This preview adds support for pinned issues.", - "toggled_by": "elektra-preview", - "toggled_on": [ - "Repository.pinnedIssues", - "PinnedIssue", - "PinnedIssueEdge", - "PinnedIssueConnection", - "Mutation.pinIssue", - "Mutation.unpinIssue" - ], - "owning_teams": [ - "@github/pe-pull-requests" - ], - "accept_header": "application/vnd.github.elektra-preview+json", - "href": "/graphql/overview/schema-previews#pinned-issues-preview" - }, "inputFields": [ { "name": "input", @@ -4666,6 +4806,40 @@ } ] }, + { + "name": "updateNotificationRestrictionSetting", + "kind": "mutations", + "id": "updatenotificationrestrictionsetting", + "href": "/graphql/reference/mutations#updatenotificationrestrictionsetting", + "description": "

    Update the setting to restrict notifications to only verified domains available to an owner.

    ", + "inputFields": [ + { + "name": "input", + "type": "UpdateNotificationRestrictionSettingInput!", + "id": "updatenotificationrestrictionsettinginput", + "kind": "input-objects", + "href": "/graphql/reference/input-objects#updatenotificationrestrictionsettinginput" + } + ], + "returnFields": [ + { + "name": "clientMutationId", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string", + "description": "

    A unique identifier for the client performing the mutation.

    " + }, + { + "name": "owner", + "type": "VerifiableDomainOwner", + "id": "verifiabledomainowner", + "kind": "unions", + "href": "/graphql/reference/unions#verifiabledomainowner", + "description": "

    The owner on which the setting was updated.

    " + } + ] + }, { "name": "updateProject", "kind": "mutations", @@ -5184,6 +5358,40 @@ "description": "

    The updated repository.

    " } ] + }, + { + "name": "verifyVerifiableDomain", + "kind": "mutations", + "id": "verifyverifiabledomain", + "href": "/graphql/reference/mutations#verifyverifiabledomain", + "description": "

    Verify that a verifiable domain has the expected DNS record.

    ", + "inputFields": [ + { + "name": "input", + "type": "VerifyVerifiableDomainInput!", + "id": "verifyverifiabledomaininput", + "kind": "input-objects", + "href": "/graphql/reference/input-objects#verifyverifiabledomaininput" + } + ], + "returnFields": [ + { + "name": "clientMutationId", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string", + "description": "

    A unique identifier for the client performing the mutation.

    " + }, + { + "name": "domain", + "type": "VerifiableDomain", + "id": "verifiabledomain", + "kind": "objects", + "href": "/graphql/reference/objects#verifiabledomain", + "description": "

    The verifiable domain that was verified.

    " + } + ] } ], "objects": [ @@ -7319,6 +7527,26 @@ "kind": "scalars", "href": "/graphql/reference/scalars#string" }, + { + "name": "isRequired", + "description": "

    Whether this check run is required to pass before merging.

    ", + "type": "Boolean!", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean", + "arguments": [ + { + "name": "pullRequestId", + "description": "

    The pull request this check is required for.

    ", + "type": { + "name": "ID!", + "id": "id", + "kind": "scalars", + "href": "/graphql/reference/scalars#id" + } + } + ] + }, { "name": "name", "description": "

    The name of the check for this check run.

    ", @@ -13741,6 +13969,76 @@ } ] }, + { + "name": "domains", + "description": "

    A list of domains owned by the enterprise.

    ", + "type": "VerifiableDomainConnection!", + "id": "verifiabledomainconnection", + "kind": "objects", + "href": "/graphql/reference/objects#verifiabledomainconnection", + "arguments": [ + { + "name": "after", + "description": "

    Returns the elements in the list that come after the specified cursor.

    ", + "type": { + "name": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + }, + { + "name": "before", + "description": "

    Returns the elements in the list that come before the specified cursor.

    ", + "type": { + "name": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + }, + { + "name": "first", + "description": "

    Returns the first n elements from the list.

    ", + "type": { + "name": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + }, + { + "name": "isVerified", + "description": "

    Filter whether or not the domain is verified.

    ", + "type": { + "name": "Boolean", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + } + }, + { + "name": "last", + "description": "

    Returns the last n elements from the list.

    ", + "type": { + "name": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + }, + { + "name": "orderBy", + "description": "

    Ordering options for verifiable domains returned.

    ", + "type": { + "name": "VerifiableDomainOrder", + "id": "verifiabledomainorder", + "kind": "input-objects", + "href": "/graphql/reference/input-objects#verifiabledomainorder" + } + } + ] + }, { "name": "ipAllowListEnabledSetting", "description": "

    The setting value for whether the enterprise has an IP allow list enabled.

    ", @@ -18386,6 +18684,14 @@ "kind": "scalars", "href": "/graphql/reference/scalars#boolean" }, + { + "name": "isPinned", + "description": "

    Indicates whether or not this issue is currently pinned to the repository issues list.

    ", + "type": "Boolean", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + }, { "name": "isReadByViewer", "description": "

    Is this issue read by the viewer.

    ", @@ -27196,6 +27502,76 @@ "kind": "scalars", "href": "/graphql/reference/scalars#string" }, + { + "name": "domains", + "description": "

    A list of domains owned by the organization.

    ", + "type": "VerifiableDomainConnection", + "id": "verifiabledomainconnection", + "kind": "objects", + "href": "/graphql/reference/objects#verifiabledomainconnection", + "arguments": [ + { + "name": "after", + "description": "

    Returns the elements in the list that come after the specified cursor.

    ", + "type": { + "name": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + }, + { + "name": "before", + "description": "

    Returns the elements in the list that come before the specified cursor.

    ", + "type": { + "name": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + }, + { + "name": "first", + "description": "

    Returns the first n elements from the list.

    ", + "type": { + "name": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + }, + { + "name": "isVerified", + "description": "

    Filter by if the domain is verified.

    ", + "type": { + "name": "Boolean", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + } + }, + { + "name": "last", + "description": "

    Returns the last n elements from the list.

    ", + "type": { + "name": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + }, + { + "name": "orderBy", + "description": "

    Ordering options for verifiable domains returned.

    ", + "type": { + "name": "VerifiableDomainOrder", + "id": "verifiabledomainorder", + "kind": "input-objects", + "href": "/graphql/reference/input-objects#verifiabledomainorder" + } + } + ] + }, { "name": "email", "description": "

    The organization's public email.

    ", @@ -27274,7 +27650,7 @@ }, { "name": "isVerified", - "description": "

    Whether the organization has verified its profile email and website, always false on Enterprise.

    ", + "description": "

    Whether the organization has verified its profile email and website.

    ", "type": "Boolean!", "id": "boolean", "kind": "scalars", @@ -27438,6 +27814,14 @@ "kind": "scalars", "href": "/graphql/reference/scalars#uri" }, + { + "name": "notificationDeliveryRestrictionEnabledSetting", + "description": "

    Indicates if email notification delivery for this organization is restricted to verified domains.

    ", + "type": "NotificationRestrictionSettingValue!", + "id": "notificationrestrictionsettingvalue", + "kind": "enums", + "href": "/graphql/reference/enums#notificationrestrictionsettingvalue" + }, { "name": "organizationBillingEmail", "description": "

    The billing email for the organization.

    ", @@ -29112,25 +29496,6 @@ "id": "pinnedissue", "href": "/graphql/reference/objects#pinnedissue", "description": "

    A Pinned Issue is a issue pinned to a repository's index page.

    ", - "isDeprecated": false, - "preview": { - "title": "Pinned issues preview", - "description": "This preview adds support for pinned issues.", - "toggled_by": "elektra-preview", - "toggled_on": [ - "Repository.pinnedIssues", - "PinnedIssue", - "PinnedIssueEdge", - "PinnedIssueConnection", - "Mutation.pinIssue", - "Mutation.unpinIssue" - ], - "owning_teams": [ - "@github/pe-pull-requests" - ], - "accept_header": "application/vnd.github.elektra-preview+json", - "href": "/graphql/overview/schema-previews#pinned-issues-preview" - }, "implements": [ { "name": "Node", @@ -29179,25 +29544,6 @@ "id": "pinnedissueconnection", "href": "/graphql/reference/objects#pinnedissueconnection", "description": "

    The connection type for PinnedIssue.

    ", - "isDeprecated": false, - "preview": { - "title": "Pinned issues preview", - "description": "This preview adds support for pinned issues.", - "toggled_by": "elektra-preview", - "toggled_on": [ - "Repository.pinnedIssues", - "PinnedIssue", - "PinnedIssueEdge", - "PinnedIssueConnection", - "Mutation.pinIssue", - "Mutation.unpinIssue" - ], - "owning_teams": [ - "@github/pe-pull-requests" - ], - "accept_header": "application/vnd.github.elektra-preview+json", - "href": "/graphql/overview/schema-previews#pinned-issues-preview" - }, "fields": [ { "name": "edges", @@ -29239,25 +29585,6 @@ "id": "pinnedissueedge", "href": "/graphql/reference/objects#pinnedissueedge", "description": "

    An edge in a connection.

    ", - "isDeprecated": false, - "preview": { - "title": "Pinned issues preview", - "description": "This preview adds support for pinned issues.", - "toggled_by": "elektra-preview", - "toggled_on": [ - "Repository.pinnedIssues", - "PinnedIssue", - "PinnedIssueEdge", - "PinnedIssueConnection", - "Mutation.pinIssue", - "Mutation.unpinIssue" - ], - "owning_teams": [ - "@github/pe-pull-requests" - ], - "accept_header": "application/vnd.github.elektra-preview+json", - "href": "/graphql/overview/schema-previews#pinned-issues-preview" - }, "fields": [ { "name": "cursor", @@ -35557,6 +35884,14 @@ "kind": "objects", "href": "/graphql/reference/objects#ref" }, + { + "name": "tagCommit", + "description": "

    The tag commit for this release.

    ", + "type": "Commit", + "id": "commit", + "kind": "objects", + "href": "/graphql/reference/objects#commit" + }, { "name": "tagName", "description": "

    The name of the release's Git tag.

    ", @@ -41227,26 +41562,7 @@ "href": "/graphql/reference/scalars#int" } } - ], - "isDeprecated": false, - "preview": { - "title": "Pinned issues preview", - "description": "This preview adds support for pinned issues.", - "toggled_by": "elektra-preview", - "toggled_on": [ - "Repository.pinnedIssues", - "PinnedIssue", - "PinnedIssueEdge", - "PinnedIssueConnection", - "Mutation.pinIssue", - "Mutation.unpinIssue" - ], - "owning_teams": [ - "@github/pe-pull-requests" - ], - "accept_header": "application/vnd.github.elektra-preview+json", - "href": "/graphql/overview/schema-previews#pinned-issues-preview" - } + ] }, { "name": "primaryLanguage", @@ -45063,6 +45379,26 @@ "kind": "scalars", "href": "/graphql/reference/scalars#string" }, + { + "name": "isRequired", + "description": "

    Whether this status is required to pass before merging.

    ", + "type": "Boolean!", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean", + "arguments": [ + { + "name": "pullRequestId", + "description": "

    The pull request this status is required for.

    ", + "type": { + "name": "ID!", + "id": "id", + "kind": "scalars", + "href": "/graphql/reference/scalars#id" + } + } + ] + }, { "name": "state", "description": "

    The state of this status context.

    ", @@ -49873,6 +50209,14 @@ "kind": "scalars", "href": "/graphql/reference/scalars#boolean" }, + { + "name": "isGitHubStar", + "description": "

    Whether or not this user is a member of the GitHub Stars Program.

    ", + "type": "Boolean!", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + }, { "name": "isHireable", "description": "

    Whether or not the user has marked themselves as for hire.

    ", @@ -51775,6 +52119,14 @@ } ], "fields": [ + { + "name": "createdAt", + "description": "

    Identifies the date and time when the object was created.

    ", + "type": "DateTime!", + "id": "datetime", + "kind": "scalars", + "href": "/graphql/reference/scalars#datetime" + }, { "name": "databaseId", "description": "

    Identifies the primary key from the database.

    ", @@ -51855,6 +52207,14 @@ "kind": "scalars", "href": "/graphql/reference/scalars#datetime" }, + { + "name": "updatedAt", + "description": "

    Identifies the date and time when the object was last updated.

    ", + "type": "DateTime!", + "id": "datetime", + "kind": "scalars", + "href": "/graphql/reference/scalars#datetime" + }, { "name": "verificationToken", "description": "

    The current verification token for the domain.

    ", @@ -51865,6 +52225,72 @@ } ] }, + { + "name": "VerifiableDomainConnection", + "kind": "objects", + "id": "verifiabledomainconnection", + "href": "/graphql/reference/objects#verifiabledomainconnection", + "description": "

    The connection type for VerifiableDomain.

    ", + "fields": [ + { + "name": "edges", + "description": "

    A list of edges.

    ", + "type": "[VerifiableDomainEdge]", + "id": "verifiabledomainedge", + "kind": "objects", + "href": "/graphql/reference/objects#verifiabledomainedge" + }, + { + "name": "nodes", + "description": "

    A list of nodes.

    ", + "type": "[VerifiableDomain]", + "id": "verifiabledomain", + "kind": "objects", + "href": "/graphql/reference/objects#verifiabledomain" + }, + { + "name": "pageInfo", + "description": "

    Information to aid in pagination.

    ", + "type": "PageInfo!", + "id": "pageinfo", + "kind": "objects", + "href": "/graphql/reference/objects#pageinfo" + }, + { + "name": "totalCount", + "description": "

    Identifies the total count of items in the connection.

    ", + "type": "Int!", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + ] + }, + { + "name": "VerifiableDomainEdge", + "kind": "objects", + "id": "verifiabledomainedge", + "href": "/graphql/reference/objects#verifiabledomainedge", + "description": "

    An edge in a connection.

    ", + "fields": [ + { + "name": "cursor", + "description": "

    A cursor for use in pagination.

    ", + "type": "String!", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "node", + "description": "

    The item at the end of the edge.

    ", + "type": "VerifiableDomain", + "id": "verifiabledomain", + "kind": "objects", + "href": "/graphql/reference/objects#verifiabledomain" + } + ] + }, { "name": "ViewerHovercardContext", "kind": "objects", @@ -55373,6 +55799,23 @@ } ] }, + { + "name": "NotificationRestrictionSettingValue", + "kind": "enums", + "id": "notificationrestrictionsettingvalue", + "href": "/graphql/reference/enums#notificationrestrictionsettingvalue", + "description": "

    The possible values for the notification restriction setting.

    ", + "values": [ + { + "name": "DISABLED", + "description": "

    The setting is disabled for the owner.

    " + }, + { + "name": "ENABLED", + "description": "

    The setting is enabled for the owner.

    " + } + ] + }, { "name": "OauthApplicationCreateAuditEntryState", "kind": "enums", @@ -57284,6 +57727,23 @@ "description": "

    Order user statuses by when they were updated.

    " } ] + }, + { + "name": "VerifiableDomainOrderField", + "kind": "enums", + "id": "verifiabledomainorderfield", + "href": "/graphql/reference/enums#verifiabledomainorderfield", + "description": "

    Properties by which verifiable domain connections can be ordered.

    ", + "values": [ + { + "name": "CREATED_AT", + "description": "

    Order verifiable domains by their creation date.

    " + }, + { + "name": "DOMAIN", + "description": "

    Order verifiable domains by the domain name.

    " + } + ] } ], "unions": [ @@ -59301,6 +59761,66 @@ } ] }, + { + "name": "AddVerifiableDomainInput", + "kind": "inputObjects", + "id": "addverifiabledomaininput", + "href": "/graphql/reference/input-objects#addverifiabledomaininput", + "description": "

    Autogenerated input type of AddVerifiableDomain.

    ", + "inputFields": [ + { + "name": "clientMutationId", + "description": "

    A unique identifier for the client performing the mutation.

    ", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "domain", + "description": "

    The URL of the domain.

    ", + "type": "URI!", + "id": "uri", + "kind": "scalars", + "href": "/graphql/reference/scalars#uri" + }, + { + "name": "ownerId", + "description": "

    The ID of the owner to add the domain to.

    ", + "type": "ID!", + "id": "id", + "kind": "scalars", + "href": "/graphql/reference/scalars#id", + "isDeprecated": false + } + ] + }, + { + "name": "ApproveVerifiableDomainInput", + "kind": "inputObjects", + "id": "approveverifiabledomaininput", + "href": "/graphql/reference/input-objects#approveverifiabledomaininput", + "description": "

    Autogenerated input type of ApproveVerifiableDomain.

    ", + "inputFields": [ + { + "name": "clientMutationId", + "description": "

    A unique identifier for the client performing the mutation.

    ", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "id", + "description": "

    The ID of the verifiable domain to approve.

    ", + "type": "ID!", + "id": "id", + "kind": "scalars", + "href": "/graphql/reference/scalars#id", + "isDeprecated": false + } + ] + }, { "name": "ArchiveRepositoryInput", "kind": "inputObjects", @@ -60577,6 +61097,64 @@ } ] }, + { + "name": "CreateEnterpriseOrganizationInput", + "kind": "inputObjects", + "id": "createenterpriseorganizationinput", + "href": "/graphql/reference/input-objects#createenterpriseorganizationinput", + "description": "

    Autogenerated input type of CreateEnterpriseOrganization.

    ", + "inputFields": [ + { + "name": "adminLogins", + "description": "

    The logins for the administrators of the new organization.

    ", + "type": "[String!]!", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "billingEmail", + "description": "

    The email used for sending billing receipts.

    ", + "type": "String!", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "clientMutationId", + "description": "

    A unique identifier for the client performing the mutation.

    ", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "enterpriseId", + "description": "

    The ID of the enterprise owning the new organization.

    ", + "type": "ID!", + "id": "id", + "kind": "scalars", + "href": "/graphql/reference/scalars#id", + "isDeprecated": false + }, + { + "name": "login", + "description": "

    The login of the new organization.

    ", + "type": "String!", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "profileName", + "description": "

    The profile name of the new organization.

    ", + "type": "String!", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + ] + }, { "name": "CreateIpAllowListEntryInput", "kind": "inputObjects", @@ -61509,6 +62087,32 @@ } ] }, + { + "name": "DeleteVerifiableDomainInput", + "kind": "inputObjects", + "id": "deleteverifiabledomaininput", + "href": "/graphql/reference/input-objects#deleteverifiabledomaininput", + "description": "

    Autogenerated input type of DeleteVerifiableDomain.

    ", + "inputFields": [ + { + "name": "clientMutationId", + "description": "

    A unique identifier for the client performing the mutation.

    ", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "id", + "description": "

    The ID of the verifiable domain to delete.

    ", + "type": "ID!", + "id": "id", + "kind": "scalars", + "href": "/graphql/reference/scalars#id", + "isDeprecated": false + } + ] + }, { "name": "DeploymentOrder", "kind": "inputObjects", @@ -62822,6 +63426,32 @@ } ] }, + { + "name": "RegenerateVerifiableDomainTokenInput", + "kind": "inputObjects", + "id": "regenerateverifiabledomaintokeninput", + "href": "/graphql/reference/input-objects#regenerateverifiabledomaintokeninput", + "description": "

    Autogenerated input type of RegenerateVerifiableDomainToken.

    ", + "inputFields": [ + { + "name": "clientMutationId", + "description": "

    A unique identifier for the client performing the mutation.

    ", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "id", + "description": "

    The ID of the verifiable domain to regenerate the verification token of.

    ", + "type": "ID!", + "id": "id", + "kind": "scalars", + "href": "/graphql/reference/scalars#id", + "isDeprecated": false + } + ] + }, { "name": "ReleaseOrder", "kind": "inputObjects", @@ -64937,6 +65567,40 @@ } ] }, + { + "name": "UpdateNotificationRestrictionSettingInput", + "kind": "inputObjects", + "id": "updatenotificationrestrictionsettinginput", + "href": "/graphql/reference/input-objects#updatenotificationrestrictionsettinginput", + "description": "

    Autogenerated input type of UpdateNotificationRestrictionSetting.

    ", + "inputFields": [ + { + "name": "clientMutationId", + "description": "

    A unique identifier for the client performing the mutation.

    ", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "ownerId", + "description": "

    The ID of the owner on which to set the restrict notifications setting.

    ", + "type": "ID!", + "id": "id", + "kind": "scalars", + "href": "/graphql/reference/scalars#id", + "isDeprecated": false + }, + { + "name": "settingValue", + "description": "

    The value for the restrict notifications setting.

    ", + "type": "NotificationRestrictionSettingValue!", + "id": "notificationrestrictionsettingvalue", + "kind": "enums", + "href": "/graphql/reference/enums#notificationrestrictionsettingvalue" + } + ] + }, { "name": "UpdateProjectCardInput", "kind": "inputObjects", @@ -65692,6 +66356,57 @@ "href": "/graphql/reference/enums#userstatusorderfield" } ] + }, + { + "name": "VerifiableDomainOrder", + "kind": "inputObjects", + "id": "verifiabledomainorder", + "href": "/graphql/reference/input-objects#verifiabledomainorder", + "description": "

    Ordering options for verifiable domain connections.

    ", + "inputFields": [ + { + "name": "direction", + "description": "

    The ordering direction.

    ", + "type": "OrderDirection!", + "id": "orderdirection", + "kind": "enums", + "href": "/graphql/reference/enums#orderdirection" + }, + { + "name": "field", + "description": "

    The field to order verifiable domains by.

    ", + "type": "VerifiableDomainOrderField!", + "id": "verifiabledomainorderfield", + "kind": "enums", + "href": "/graphql/reference/enums#verifiabledomainorderfield" + } + ] + }, + { + "name": "VerifyVerifiableDomainInput", + "kind": "inputObjects", + "id": "verifyverifiabledomaininput", + "href": "/graphql/reference/input-objects#verifyverifiabledomaininput", + "description": "

    Autogenerated input type of VerifyVerifiableDomain.

    ", + "inputFields": [ + { + "name": "clientMutationId", + "description": "

    A unique identifier for the client performing the mutation.

    ", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "id", + "description": "

    The ID of the verifiable domain to verify.

    ", + "type": "ID!", + "id": "id", + "kind": "scalars", + "href": "/graphql/reference/scalars#id", + "isDeprecated": false + } + ] } ], "scalars": [ diff --git a/lib/liquid-tags/link.js b/lib/liquid-tags/link.js index f1a5434823..bef218a2f9 100644 --- a/lib/liquid-tags/link.js +++ b/lib/liquid-tags/link.js @@ -1,6 +1,6 @@ -const fs = require('fs') const path = require('path') const assert = require('assert') +const readFileAsync = require('../readfile-async') const findPage = require('../find-page') const { getPathWithoutLanguage, getPathWithoutVersion } = require('../path-utils') const getApplicableVersions = require('../get-applicable-versions') @@ -30,7 +30,7 @@ module.exports = (name) => ({ async getTemplate () { const pathToTemplate = path.join(__dirname, '../../includes/liquid-tags', `${name}.html`) - const template = await fs.promises.readFile(pathToTemplate, 'utf8') + const template = await readFileAsync(pathToTemplate, 'utf8') return template.replace(/\r/g, '') }, diff --git a/lib/liquid-tags/liquid-tag.js b/lib/liquid-tags/liquid-tag.js index 6e36ed632a..7076eba093 100644 --- a/lib/liquid-tags/liquid-tag.js +++ b/lib/liquid-tags/liquid-tag.js @@ -1,4 +1,4 @@ -const fs = require('fs') +const readFileAsync = require('../readfile-async') const path = require('path') const Liquid = require('liquid') const { paramCase } = require('change-case') @@ -19,7 +19,7 @@ module.exports = class LiquidTag extends Liquid.Tag { async getTemplate () { if (!this.template) { - this.template = await fs.promises.readFile(this.templatePath, 'utf8') + this.template = await readFileAsync(this.templatePath, 'utf8') this.template = this.template.replace(/\r/g, '') } diff --git a/lib/path-utils.js b/lib/path-utils.js index 83a966985f..68a6f899a9 100644 --- a/lib/path-utils.js +++ b/lib/path-utils.js @@ -90,6 +90,22 @@ function getProductStringFromPath (href) { : pathParts[1] } +function getCategoryStringFromPath (href) { + href = getPathWithoutLanguage(href) + + if (href === '/') return null + + const pathParts = href.split('/') + + if (pathParts.includes('early-access')) return null + + const productIndex = allProducts[pathParts[2]] + ? 2 + : 1 + + return pathParts[productIndex + 1] +} + // Return the corresponding object for the product segment in a path function getProductObjectFromPath (href) { const productFromPath = getProductStringFromPath(href) @@ -104,5 +120,6 @@ module.exports = { getVersionStringFromPath, getVersionObjectFromPath, getProductStringFromPath, + getCategoryStringFromPath, getProductObjectFromPath } diff --git a/lib/read-file-contents.js b/lib/read-file-contents.js index 4c80a4ab9f..4e26236ec5 100644 --- a/lib/read-file-contents.js +++ b/lib/read-file-contents.js @@ -1,4 +1,4 @@ -const fs = require('fs') +const readFileAsync = require('./readfile-async') const encodeBracketedParentheses = require('./encode-bracketed-parentheses') const fm = require('./frontmatter') @@ -6,7 +6,7 @@ const fm = require('./frontmatter') * Read only the frontmatter from file */ module.exports = async function fmfromf (filepath, languageCode) { - let fileContent = await fs.promises.readFile(filepath, 'utf8') + let fileContent = await readFileAsync(filepath, 'utf8') fileContent = encodeBracketedParentheses(fileContent) diff --git a/lib/readfile-async.js b/lib/readfile-async.js new file mode 100644 index 0000000000..5ca2117c44 --- /dev/null +++ b/lib/readfile-async.js @@ -0,0 +1,6 @@ +const fs = require('fs') +const util = require('util') + +// This is faster than using `fs.promises.readFile` for the time being +// See: https://github.com/nodejs/node/issues/37583 +module.exports = util.promisify(fs.readFile) diff --git a/lib/redirects/external-sites.json b/lib/redirects/external-sites.json index 4c8a968a04..7a38ffa7da 100644 --- a/lib/redirects/external-sites.json +++ b/lib/redirects/external-sites.json @@ -14,7 +14,7 @@ "/git-scm": "https://git-scm.com/", "/git-user-manual": "http://schacon.github.com/git/user-manual.html", "/github-status": "https://status.github.com/messages", - "/github-support": "https://support.github.com/contact", + "/github-support": "https://support.github.com", "/multiple-keys": "https://developer.github.com/guides/managing-deploy-keys", "/pro-git": "https://git-scm.com/book", "/submodules": "https://git-scm.com/book/en/Git-Tools-Submodules", diff --git a/lib/redirects/get-old-paths-from-permalink.js b/lib/redirects/get-old-paths-from-permalink.js index 1515d9c5e6..bf7055fd87 100644 --- a/lib/redirects/get-old-paths-from-permalink.js +++ b/lib/redirects/get-old-paths-from-permalink.js @@ -82,6 +82,10 @@ module.exports = function getOldPathsFromPath (currentPath, languageCode, curren oldPaths.add(oldPath .replace(`/enterprise-server@${latest}`, '/enterprise-server')) + // create old path /enterprise-server@latest from new path /enterprise-server@ + oldPaths.add(oldPath + .replace(`/enterprise-server@${latest}`, '/enterprise-server@latest')) + if (!patterns.adminProduct.test(oldPath)) { // create old path /enterprise//user/foo from new path /enterprise-server@/foo oldPaths.add(currentPath diff --git a/lib/redirects/precompile.js b/lib/redirects/precompile.js index 95291fb381..9112bb32f4 100755 --- a/lib/redirects/precompile.js +++ b/lib/redirects/precompile.js @@ -2,19 +2,19 @@ const developerRedirects = require('../redirects/static/developer') const { latest } = require('../../lib/enterprise-server-releases') const latestDevRedirects = {} -// Replace hardcoded 'latest' with real value +// Replace hardcoded 'latest' with real value in the redirected path Object.entries(developerRedirects).forEach(([oldPath, newPath]) => { latestDevRedirects[oldPath] = newPath.replace('enterprise-server@latest', `enterprise-server@${latest}`) }) // This function runs at server warmup and precompiles possible redirect routes. // It outputs them in key-value pairs within a neat Javascript object: { oldPath: newPath } -module.exports = function precompileRedirects (pageList) { +module.exports = async function precompileRedirects (pageList) { const allRedirects = Object.assign({}, latestDevRedirects) // CURRENT PAGES PERMALINKS AND FRONTMATTER // create backwards-compatible old paths for page permalinks and frontmatter redirects - pageList.forEach(page => Object.assign(allRedirects, page.buildRedirects())) + await Promise.all(pageList.map(async (page) => Object.assign(allRedirects, page.buildRedirects()))) return allRedirects } diff --git a/lib/release-notes-schema.js b/lib/release-notes-schema.js index f21a2b4fac..4f25e9d408 100644 --- a/lib/release-notes-schema.js +++ b/lib/release-notes-schema.js @@ -37,6 +37,10 @@ module.exports = { type: 'boolean', default: false }, + deprecated: { + type: 'boolean', + default: false + }, sections: { required: true, type: 'object', diff --git a/lib/render-content/renderContent.js b/lib/render-content/renderContent.js index c4bc7e1d41..b6a8193876 100644 --- a/lib/render-content/renderContent.js +++ b/lib/render-content/renderContent.js @@ -66,6 +66,10 @@ module.exports = async function renderContent ( .trim() } + if (options.cheerioObject) { + return cheerio.load(html, { xmlMode: true }) + } + if (options.encodeEntities) html = entities.encode(html) return html.trim() diff --git a/lib/rest/static/decorated/api.github.com.json b/lib/rest/static/decorated/api.github.com.json index d9b43bb1ce..05fd785efa 100644 --- a/lib/rest/static/decorated/api.github.com.json +++ b/lib/rest/static/decorated/api.github.com.json @@ -574,7 +574,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -2399,7 +2399,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -2463,7 +2463,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -2498,6 +2498,16 @@ "default": 1 }, "descriptionHTML": "

    Page number of the results to fetch.

    " + }, + { + "name": "client_id", + "in": "query", + "required": false, + "description": "The client ID of your GitHub app.", + "schema": { + "type": "string" + }, + "descriptionHTML": "

    The client ID of your GitHub app.

    " } ], "x-codeSamples": [ @@ -2701,7 +2711,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -2800,7 +2810,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "422", @@ -2888,7 +2898,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -3145,14 +3155,17 @@ "properties": { "access_token": { "type": "string", - "description": "

    The OAuth access token used to authenticate to the GitHub API.

    ", + "description": "

    Required. The OAuth access token used to authenticate to the GitHub API.

    ", "name": "access_token", "in": "body", "rawType": "string", "rawDescription": "The OAuth access token used to authenticate to the GitHub API.", "childParamsGroups": [] } - } + }, + "required": [ + "access_token" + ] }, "example": { "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a" @@ -3177,7 +3190,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "422", @@ -3189,7 +3202,7 @@ "bodyParameters": [ { "type": "string", - "description": "

    The OAuth access token used to authenticate to the GitHub API.

    ", + "description": "

    Required. The OAuth access token used to authenticate to the GitHub API.

    ", "name": "access_token", "in": "body", "rawType": "string", @@ -3244,7 +3257,7 @@ "properties": { "access_token": { "type": "string", - "description": "

    Required. The OAuth access token used to authenticate to the GitHub API.

    ", + "description": "

    Required. Required. The OAuth access token used to authenticate to the GitHub API.

    ", "example": "e72e16c7e42f292c6912e7710c838347ae178b4a", "name": "access_token", "in": "body", @@ -3273,7 +3286,7 @@ "childParamsGroups": [] }, "repositories": { - "description": "

    The list of repository IDs to scope the user-to-server access token to. repositories may not be specified if repository_ids is specified.

    ", + "description": "

    The list of repository names to scope the user-to-server access token to. repositories may not be specified if repository_ids is specified.

    ", "type": "array of strings", "items": { "type": "string", @@ -3282,11 +3295,11 @@ "name": "repositories", "in": "body", "rawType": "array", - "rawDescription": "The list of repository IDs to scope the user-to-server access token to. `repositories` may not be specified if `repository_ids` is specified.", + "rawDescription": "The list of repository names to scope the user-to-server access token to. `repositories` may not be specified if `repository_ids` is specified.", "childParamsGroups": [] }, "repository_ids": { - "description": "

    The list of repository names to scope the user-to-server access token to. repository_ids may not be specified if repositories is specified.

    ", + "description": "

    The list of repository IDs to scope the user-to-server access token to. repository_ids may not be specified if repositories is specified.

    ", "example": [ 1 ], @@ -3297,7 +3310,7 @@ "name": "repository_ids", "in": "body", "rawType": "array", - "rawDescription": "The list of repository names to scope the user-to-server access token to. `repository_ids` may not be specified if `repositories` is specified.", + "rawDescription": "The list of repository IDs to scope the user-to-server access token to. `repository_ids` may not be specified if `repositories` is specified.", "childParamsGroups": [] }, "permissions": { @@ -4104,7 +4117,10 @@ } ] } - } + }, + "required": [ + "access_token" + ] } } } @@ -4154,7 +4170,7 @@ "bodyParameters": [ { "type": "string", - "description": "

    Required. The OAuth access token used to authenticate to the GitHub API.

    ", + "description": "

    Required. Required. The OAuth access token used to authenticate to the GitHub API.

    ", "example": "e72e16c7e42f292c6912e7710c838347ae178b4a", "name": "access_token", "in": "body", @@ -4183,7 +4199,7 @@ "childParamsGroups": [] }, { - "description": "

    The list of repository IDs to scope the user-to-server access token to. repositories may not be specified if repository_ids is specified.

    ", + "description": "

    The list of repository names to scope the user-to-server access token to. repositories may not be specified if repository_ids is specified.

    ", "type": "array of strings", "items": { "type": "string", @@ -4192,11 +4208,11 @@ "name": "repositories", "in": "body", "rawType": "array", - "rawDescription": "The list of repository IDs to scope the user-to-server access token to. `repositories` may not be specified if `repository_ids` is specified.", + "rawDescription": "The list of repository names to scope the user-to-server access token to. `repositories` may not be specified if `repository_ids` is specified.", "childParamsGroups": [] }, { - "description": "

    The list of repository names to scope the user-to-server access token to. repository_ids may not be specified if repositories is specified.

    ", + "description": "

    The list of repository IDs to scope the user-to-server access token to. repository_ids may not be specified if repositories is specified.

    ", "example": [ 1 ], @@ -4207,7 +4223,7 @@ "name": "repository_ids", "in": "body", "rawType": "array", - "rawDescription": "The list of repository names to scope the user-to-server access token to. `repository_ids` may not be specified if `repositories` is specified.", + "rawDescription": "The list of repository IDs to scope the user-to-server access token to. `repository_ids` may not be specified if `repositories` is specified.", "childParamsGroups": [] }, { @@ -5236,7 +5252,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -5340,6 +5356,16 @@ "default": 1 }, "descriptionHTML": "

    Page number of the results to fetch.

    " + }, + { + "name": "client_id", + "in": "query", + "required": false, + "description": "The client ID of your GitHub app.", + "schema": { + "type": "string" + }, + "descriptionHTML": "

    The client ID of your GitHub app.

    " } ], "x-codeSamples": [ @@ -6384,7 +6410,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -6926,7 +6952,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "descriptionHTML": "

    Sets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise.

    \n

    You must authenticate using an access token with the admin:enterprise scope to use this endpoint.

    ", @@ -7131,7 +7157,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "descriptionHTML": "

    Replaces the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for enabled_organizations must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"

    \n

    You must authenticate using an access token with the admin:enterprise scope to use this endpoint.

    ", @@ -7216,7 +7242,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -7287,7 +7313,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -7468,7 +7494,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "descriptionHTML": "

    Sets the actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"

    \n

    You must authenticate using an access token with the admin:enterprise scope to use this endpoint.

    ", @@ -8043,7 +8069,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -8239,7 +8265,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "descriptionHTML": "

    Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.

    \n

    You must authenticate using an access token with the admin:enterprise scope to use this endpoint.

    ", @@ -8334,7 +8360,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -8415,7 +8441,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -8611,7 +8637,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "descriptionHTML": "

    Replaces the list of self-hosted runners that are part of an enterprise runner group.

    \n

    You must authenticate using an access token with the admin:enterprise scope to use this endpoint.

    ", @@ -8706,7 +8732,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -8787,7 +8813,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -9198,7 +9224,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -9278,6 +9304,16 @@ }, "descriptionHTML": "

    The order of audit log events. To list newest events first, specify desc. To list oldest events first, specify asc.

    \n

    The default is desc.

    " }, + { + "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.

    " + }, { "name": "per_page", "description": "Results per page (max 100).", @@ -10477,7 +10513,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -10975,7 +11011,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -11393,7 +11429,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -11467,7 +11503,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -11828,7 +11864,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -11851,6 +11887,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -12070,6 +12107,16 @@ "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": [ @@ -13747,7 +13794,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -13959,13 +14006,7 @@ "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "
    {\n  \"login\": \"github\",\n  \"id\": 1,\n  \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n  \"url\": \"https://api.github.com/orgs/github\",\n  \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n  \"events_url\": \"https://api.github.com/orgs/github/events\",\n  \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n  \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n  \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n  \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n  \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n  \"description\": \"A great organization\",\n  \"name\": \"github\",\n  \"company\": \"GitHub\",\n  \"blog\": \"https://github.com/blog\",\n  \"location\": \"San Francisco\",\n  \"email\": \"octocat@github.com\",\n  \"twitter_username\": \"github\",\n  \"is_verified\": true,\n  \"has_organization_projects\": true,\n  \"has_repository_projects\": true,\n  \"public_repos\": 2,\n  \"public_gists\": 1,\n  \"followers\": 20,\n  \"following\": 0,\n  \"html_url\": \"https://github.com/octocat\",\n  \"created_at\": \"2008-01-14T04:33:35Z\",\n  \"updated_at\": \"2014-03-03T18:58:10Z\",\n  \"type\": \"Organization\",\n  \"total_private_repos\": 100,\n  \"owned_private_repos\": 100,\n  \"private_gists\": 81,\n  \"disk_usage\": 10000,\n  \"collaborators\": 8,\n  \"billing_email\": \"mona@github.com\",\n  \"plan\": {\n    \"name\": \"Medium\",\n    \"space\": 400,\n    \"private_repos\": 20\n  },\n  \"default_repository_permission\": \"read\",\n  \"members_can_create_repositories\": true,\n  \"two_factor_requirement_enabled\": true,\n  \"members_allowed_repository_creation_type\": \"all\",\n  \"members_can_create_public_repositories\": false,\n  \"members_can_create_private_repositories\": false,\n  \"members_can_create_internal_repositories\": false,\n  \"members_can_create_pages\": true\n}\n
    " - }, - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response with GitHub plan information", - "payload": "
    {\n  \"login\": \"github\",\n  \"id\": 1,\n  \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n  \"url\": \"https://api.github.com/orgs/github\",\n  \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n  \"events_url\": \"https://api.github.com/orgs/github/events\",\n  \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n  \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n  \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n  \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n  \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n  \"description\": \"A great organization\",\n  \"name\": \"github\",\n  \"company\": \"GitHub\",\n  \"blog\": \"https://github.com/blog\",\n  \"location\": \"San Francisco\",\n  \"email\": \"octocat@github.com\",\n  \"twitter_username\": \"github\",\n  \"is_verified\": true,\n  \"has_organization_projects\": true,\n  \"has_repository_projects\": true,\n  \"public_repos\": 2,\n  \"public_gists\": 1,\n  \"followers\": 20,\n  \"following\": 0,\n  \"html_url\": \"https://github.com/octocat\",\n  \"created_at\": \"2008-01-14T04:33:35Z\",\n  \"updated_at\": \"2014-03-03T18:58:10Z\",\n  \"type\": \"Organization\",\n  \"plan\": {\n    \"name\": \"team\",\n    \"space\": 976562499,\n    \"private_repos\": 999999,\n    \"filled_seats\": 4,\n    \"seats\": 5\n  }\n}\n
    " + "payload": "
    {\n  \"login\": \"github\",\n  \"id\": 1,\n  \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n  \"url\": \"https://api.github.com/orgs/github\",\n  \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n  \"events_url\": \"https://api.github.com/orgs/github/events\",\n  \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n  \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n  \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n  \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n  \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n  \"description\": \"A great organization\",\n  \"name\": \"github\",\n  \"company\": \"GitHub\",\n  \"blog\": \"https://github.com/blog\",\n  \"location\": \"San Francisco\",\n  \"email\": \"octocat@github.com\",\n  \"twitter_username\": \"github\",\n  \"is_verified\": true,\n  \"has_organization_projects\": true,\n  \"has_repository_projects\": true,\n  \"public_repos\": 2,\n  \"public_gists\": 1,\n  \"followers\": 20,\n  \"following\": 0,\n  \"html_url\": \"https://github.com/octocat\",\n  \"created_at\": \"2008-01-14T04:33:35Z\",\n  \"updated_at\": \"2014-03-03T18:58:10Z\",\n  \"type\": \"Organization\",\n  \"total_private_repos\": 100,\n  \"owned_private_repos\": 100,\n  \"private_gists\": 81,\n  \"disk_usage\": 10000,\n  \"collaborators\": 8,\n  \"billing_email\": \"mona@github.com\",\n  \"plan\": {\n    \"name\": \"Medium\",\n    \"space\": 400,\n    \"private_repos\": 20,\n    \"filled_seats\": 4,\n    \"seats\": 5\n  },\n  \"default_repository_permission\": \"read\",\n  \"members_can_create_repositories\": true,\n  \"two_factor_requirement_enabled\": true,\n  \"members_allowed_repository_creation_type\": \"all\",\n  \"members_can_create_public_repositories\": false,\n  \"members_can_create_private_repositories\": false,\n  \"members_can_create_internal_repositories\": false,\n  \"members_can_create_pages\": true\n}\n
    " }, { "httpStatusCode": "404", @@ -14614,7 +14655,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "descriptionHTML": "

    Sets the GitHub Actions permissions policy for repositories and allowed actions in an organization.

    \n

    If the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as allowed_actions to selected actions, then you cannot override them for the organization.

    \n

    You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.

    ", @@ -14817,7 +14858,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "descriptionHTML": "

    Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"

    \n

    You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.

    ", @@ -14900,7 +14941,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -14969,7 +15010,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -15148,7 +15189,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "descriptionHTML": "

    Sets the actions that are allowed in an organization. To use this endpoint, the organization permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"

    \n

    If the organization belongs to an enterprise that has selected actions set at the enterprise level, then you cannot override any of the enterprise's allowed actions settings.

    \n

    To use the patterns_allowed setting for private repositories, the organization must belong to an enterprise. If the organization does not belong to an enterprise, then the patterns_allowed setting only applies to public repositories in the organization.

    \n

    You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.

    ", @@ -15722,7 +15763,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -15751,6 +15792,26 @@ "type": "integer" }, "descriptionHTML": "

    Unique identifier of the self-hosted runner group.

    " + }, + { + "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.

    " + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "descriptionHTML": "

    Results per page (max 100).

    " } ], "x-codeSamples": [ @@ -15896,7 +15957,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "descriptionHTML": "

    The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see \"GitHub's products.\"

    \n

    Replaces the list of repositories that have access to a self-hosted runner group configured in an organization.

    \n

    You must authenticate using an access token with the admin:org scope to use this endpoint.

    ", @@ -15989,7 +16050,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -16068,7 +16129,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -16262,7 +16323,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "descriptionHTML": "

    The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see \"GitHub's products.\"

    \n

    Replaces the list of self-hosted runners that are part of an organization runner group.

    \n

    You must authenticate using an access token with the admin:org scope to use this endpoint.

    ", @@ -16356,7 +16417,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -16436,7 +16497,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -16841,7 +16902,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -17116,6 +17177,7 @@ "encrypted_value": { "type": "string", "description": "

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an organization public key endpoint.

    ", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", "rawType": "string", @@ -17160,7 +17222,7 @@ } }, "example": { - "encrypted_value": "****************************************************************************************", + "encrypted_value": "c2VjcmV0", "key_id": "012345678912345678", "visibility": "selected", "selected_repository_ids": [ @@ -17201,6 +17263,7 @@ { "type": "string", "description": "

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an organization public key endpoint.

    ", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", "rawType": "string", @@ -17308,7 +17371,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -17337,6 +17400,26 @@ "type": "string" }, "descriptionHTML": "

    secret_name parameter

    " + }, + { + "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.

    " + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "descriptionHTML": "

    Results per page (max 100).

    " } ], "x-codeSamples": [ @@ -17477,7 +17560,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "descriptionHTML": "

    Replaces all repositories for an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the secrets organization permission to use this endpoint.

    ", @@ -17746,6 +17829,16 @@ "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": [ @@ -17995,7 +18088,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "422", @@ -18069,7 +18162,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -18195,7 +18288,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -19417,7 +19510,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -19731,7 +19824,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -20142,7 +20235,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -20481,7 +20574,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -20619,6 +20712,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -21033,7 +21127,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -21081,7 +21175,7 @@ } ], "summary": "Get organization membership for a user", - "description": "In order to get a user's membership with an organization, the authenticated user must be an organization member.", + "description": "In order to get a user's membership with an organization, the authenticated user must be an organization member. The `state` parameter in the response can be used to identify the user's membership status.", "tags": [ "orgs" ], @@ -21104,7 +21198,7 @@ "subcategoryLabel": "Members", "notes": [], "bodyParameters": [], - "descriptionHTML": "

    In order to get a user's membership with an organization, the authenticated user must be an organization member.

    ", + "descriptionHTML": "

    In order to get a user's membership with an organization, the authenticated user must be an organization member. The state parameter in the response can be used to identify the user's membership status.

    ", "responses": [ { "httpStatusCode": "200", @@ -21112,18 +21206,6 @@ "description": "Response if user has an active admin membership with organization", "payload": "
    {\n  \"url\": \"https://api.github.com/orgs/octocat/memberships/defunkt\",\n  \"state\": \"active\",\n  \"role\": \"admin\",\n  \"organization_url\": \"https://api.github.com/orgs/octocat\",\n  \"organization\": {\n    \"login\": \"github\",\n    \"id\": 1,\n    \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n    \"url\": \"https://api.github.com/orgs/github\",\n    \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n    \"events_url\": \"https://api.github.com/orgs/github/events\",\n    \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n    \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n    \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n    \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"description\": \"A great organization\"\n  },\n  \"user\": {\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
    " }, - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response if user has an active membership with organization", - "payload": "
    {\n  \"url\": \"https://api.github.com/orgs/octocat/memberships/defunkt\",\n  \"state\": \"active\",\n  \"role\": \"member\",\n  \"organization_url\": \"https://api.github.com/orgs/octocat\",\n  \"organization\": {\n    \"login\": \"github\",\n    \"id\": 1,\n    \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n    \"url\": \"https://api.github.com/orgs/github\",\n    \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n    \"events_url\": \"https://api.github.com/orgs/github/events\",\n    \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n    \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n    \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n    \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"description\": \"A great organization\"\n  },\n  \"user\": {\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
    " - }, - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response if user has a pending membership with organization", - "payload": "
    {\n  \"url\": \"https://api.github.com/orgs/invitocat/memberships/defunkt\",\n  \"state\": \"pending\",\n  \"role\": \"member\",\n  \"organization_url\": \"https://api.github.com/orgs/invitocat\",\n  \"organization\": {\n    \"login\": \"github\",\n    \"id\": 1,\n    \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n    \"url\": \"https://api.github.com/orgs/github\",\n    \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n    \"events_url\": \"https://api.github.com/orgs/github/events\",\n    \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n    \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n    \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n    \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"description\": \"A great organization\"\n  },\n  \"user\": {\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
    " - }, { "httpStatusCode": "403", "httpStatusMessage": "Forbidden", @@ -21241,13 +21323,7 @@ { "httpStatusCode": "200", "httpStatusMessage": "OK", - "description": "Response if user was previously unaffiliated with organization", - "payload": "
    {\n  \"url\": \"https://api.github.com/orgs/invitocat/memberships/defunkt\",\n  \"state\": \"pending\",\n  \"role\": \"admin\",\n  \"organization_url\": \"https://api.github.com/orgs/invitocat\",\n  \"organization\": {\n    \"login\": \"github\",\n    \"id\": 1,\n    \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n    \"url\": \"https://api.github.com/orgs/github\",\n    \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n    \"events_url\": \"https://api.github.com/orgs/github/events\",\n    \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n    \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n    \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n    \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"description\": \"A great organization\"\n  },\n  \"user\": {\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
    " - }, - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response if user already had membership with organization", + "description": "Response if user has an active admin membership with organization", "payload": "
    {\n  \"url\": \"https://api.github.com/orgs/octocat/memberships/defunkt\",\n  \"state\": \"active\",\n  \"role\": \"admin\",\n  \"organization_url\": \"https://api.github.com/orgs/octocat\",\n  \"organization\": {\n    \"login\": \"github\",\n    \"id\": 1,\n    \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n    \"url\": \"https://api.github.com/orgs/github\",\n    \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n    \"events_url\": \"https://api.github.com/orgs/github/events\",\n    \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n    \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n    \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n    \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"description\": \"A great organization\"\n  },\n  \"user\": {\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
    " }, { @@ -21325,7 +21401,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -21374,6 +21450,23 @@ "default": 1 }, "descriptionHTML": "

    Page number of the results to fetch.

    " + }, + { + "name": "exclude", + "description": "Exclude attributes from the API response to improve performance", + "in": "query", + "schema": { + "type": "array", + "items": { + "description": "Allowed values that can be passed to the exclude param.", + "enum": [ + "repositories" + ], + "example": "repositories", + "type": "string" + } + }, + "descriptionHTML": "

    Exclude attributes from the API response to improve performance

    " } ], "x-codeSamples": [ @@ -21630,6 +21723,23 @@ "type": "integer" }, "descriptionHTML": "

    migration_id parameter

    " + }, + { + "name": "exclude", + "description": "Exclude attributes from the API response to improve performance", + "in": "query", + "schema": { + "type": "array", + "items": { + "description": "Allowed values that can be passed to the exclude param.", + "enum": [ + "repositories" + ], + "example": "repositories", + "type": "string" + } + }, + "descriptionHTML": "

    Exclude attributes from the API response to improve performance

    " } ], "x-codeSamples": [ @@ -21843,7 +21953,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -21935,7 +22045,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -22204,8 +22314,6 @@ "subcategory": "outside-collaborators", "subcategoryLabel": "Outside collaborators", "notes": [], - "bodyParameters": [], - "descriptionHTML": "

    When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"Converting an organization member to an outside collaborator\".

    ", "responses": [ { "httpStatusCode": "202", @@ -22220,21 +22328,16 @@ { "httpStatusCode": "403", "httpStatusMessage": "Forbidden", - "description": "Response if user is the last owner of the organization", - "payload": "
    {\n  \"message\": \"Cannot convert the last owner to an outside collaborator\",\n  \"documentation_url\": \"https://docs.github.com/rest/reference/orgs#convert-member-to-outside-collaborator\"\n}\n
    " - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Response if user is not a member of the organization", - "payload": "
    {\n  \"message\": \"<user> is not a member of the <organization> organization.\",\n  \"documentation_url\": \"https://docs.github.com/rest/reference/orgs#convert-member-to-outside-collaborator\"\n}\n
    " + "description": "Response if user is the last owner of the organization or not a member of the organization" }, { "httpStatusCode": "404", "httpStatusMessage": "Not Found", "description": "Resource not found" } - ] + ], + "bodyParameters": [], + "descriptionHTML": "

    When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"Converting an organization member to an outside collaborator\".

    " }, { "verb": "delete", @@ -22301,7 +22404,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "422", @@ -22478,7 +22581,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "401", @@ -22540,6 +22643,16 @@ "type": "string" }, "descriptionHTML": "" + }, + { + "name": "token", + "description": "package token", + "schema": { + "type": "string" + }, + "required": false, + "in": "query", + "descriptionHTML": "

    package token

    " } ], "x-codeSamples": [ @@ -22579,7 +22692,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "401", @@ -22641,6 +22754,41 @@ "type": "string" }, "descriptionHTML": "" + }, + { + "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.

    " + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "descriptionHTML": "

    Results per page (max 100).

    " + }, + { + "name": "state", + "in": "query", + "required": false, + "description": "The state of the package, either active or deleted.", + "schema": { + "type": "string", + "enum": [ + "active", + "deleted" + ], + "default": "active" + }, + "descriptionHTML": "

    The state of the package, either active or deleted.

    " } ], "x-codeSamples": [ @@ -22660,7 +22808,7 @@ "tags": [ "packages" ], - "operationId": "packages/get-all-package-versions-for-a-package-owned-by-an-org", + "operationId": "packages/get-all-package-versions-for-package-owned-by-org", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/reference/packages#get-all-package-versions-for-a-package-owned-by-the-authenticated-user" @@ -22889,7 +23037,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "401", @@ -23000,7 +23148,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "401", @@ -23492,7 +23640,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -23566,7 +23714,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -23588,7 +23736,7 @@ }, { "name": "type", - "description": "Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`.", + "description": "Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Note: For GitHub AE, can be one of `all`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`.", "in": "query", "required": false, "schema": { @@ -23603,7 +23751,7 @@ "internal" ] }, - "descriptionHTML": "

    Specifies the types of repositories you want returned. Can be one of all, public, private, forks, sources, member, internal. Default: all. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, type can also be internal.

    " + "descriptionHTML": "

    Specifies the types of repositories you want returned. Can be one of all, public, private, forks, sources, member, internal. Note: For GitHub AE, can be one of all, private, forks, sources, member, internal. Default: all. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, type can also be internal.

    " }, { "name": "sort", @@ -23742,7 +23890,7 @@ } ], "summary": "Create an organization repository", - "description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", + "description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository", "tags": [ "repos" ], @@ -23786,17 +23934,17 @@ }, "private": { "type": "boolean", - "description": "

    Either true to create a private repository or false to create a public one.

    ", + "description": "

    Whether the repository is private.

    ", "default": false, "name": "private", "in": "body", "rawType": "boolean", - "rawDescription": "Either `true` to create a private repository or `false` to create a public one.", + "rawDescription": "Whether the repository is private.", "childParamsGroups": [] }, "visibility": { "type": "string", - "description": "

    Can be public or private. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be internal. For more information, see \"Creating an internal repository\" in the GitHub Help documentation.
    \nThe visibility parameter overrides the private parameter when you use both parameters with the nebula-preview preview header.

    ", + "description": "

    Can be public or private. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be internal. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"Creating an internal repository\" in the GitHub Help documentation.
    \nThe visibility parameter overrides the private parameter when you use both parameters with the nebula-preview preview header.

    ", "enum": [ "public", "private", @@ -23806,7 +23954,7 @@ "name": "visibility", "in": "body", "rawType": "string", - "rawDescription": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", + "rawDescription": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", "childParamsGroups": [] }, "has_issues": { @@ -23967,7 +24115,7 @@ "category": "repos", "categoryLabel": "Repos", "notes": [], - "descriptionHTML": "

    Creates a new repository in the specified organization. The authenticated user must be a member of the organization.

    \n

    OAuth scope requirements

    \n

    When using OAuth, authorizations must include:

    \n
      \n
    • public_repo scope or repo scope to create a public repository
    • \n
    • repo scope to create a private repository
    • \n
    ", + "descriptionHTML": "

    Creates a new repository in the specified organization. The authenticated user must be a member of the organization.

    \n

    OAuth scope requirements

    \n

    When using OAuth, authorizations must include:

    \n
      \n
    • public_repo scope or repo scope to create a public repository. Note: For GitHub AE, use repo scope to create an internal repository.
    • \n
    • repo scope to create a private repository
    • \n
    ", "bodyParameters": [ { "type": "string", @@ -23998,17 +24146,17 @@ }, { "type": "boolean", - "description": "

    Either true to create a private repository or false to create a public one.

    ", + "description": "

    Whether the repository is private.

    ", "default": false, "name": "private", "in": "body", "rawType": "boolean", - "rawDescription": "Either `true` to create a private repository or `false` to create a public one.", + "rawDescription": "Whether the repository is private.", "childParamsGroups": [] }, { "type": "string", - "description": "

    Can be public or private. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be internal. For more information, see \"Creating an internal repository\" in the GitHub Help documentation.
    \nThe visibility parameter overrides the private parameter when you use both parameters with the nebula-preview preview header.

    ", + "description": "

    Can be public or private. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be internal. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"Creating an internal repository\" in the GitHub Help documentation.
    \nThe visibility parameter overrides the private parameter when you use both parameters with the nebula-preview preview header.

    ", "enum": [ "public", "private", @@ -24018,7 +24166,7 @@ "name": "visibility", "in": "body", "rawType": "string", - "rawDescription": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", + "rawDescription": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", "childParamsGroups": [] }, { @@ -24186,7 +24334,7 @@ } ], "summary": "Get GitHub Actions billing for an organization", - "description": "Gets the summary of the free and paid GitHub Actions minutes used.\n\nPaid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nAccess tokens must have the `repo` or `admin:org` scope.", + "description": "Gets the summary of the free and paid GitHub Actions minutes used.\n\nPaid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nAccess tokens must have the `repo` or `admin:org` scope.", "operationId": "billing/get-github-actions-billing-org", "tags": [ "billing" @@ -24207,7 +24355,7 @@ "categoryLabel": "Billing", "notes": [], "bodyParameters": [], - "descriptionHTML": "

    Gets the summary of the free and paid GitHub Actions minutes used.

    \n

    Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"Managing billing for GitHub Actions\".

    \n

    Access tokens must have the repo or admin:org scope.

    ", + "descriptionHTML": "

    Gets the summary of the free and paid GitHub Actions minutes used.

    \n

    Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see \"Managing billing for GitHub Actions\".

    \n

    Access tokens must have the repo or admin:org scope.

    ", "responses": [ { "httpStatusCode": "200", @@ -24361,13 +24509,12 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "Page token", "in": "query", "schema": { - "type": "integer", - "default": 1 + "type": "string" }, - "descriptionHTML": "

    Page number of the results to fetch.

    " + "descriptionHTML": "

    Page token

    " } ], "x-codeSamples": [ @@ -25082,7 +25229,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -25146,6 +25293,16 @@ "default": 1 }, "descriptionHTML": "

    Page number of the results to fetch.

    " + }, + { + "name": "pinned", + "in": "query", + "required": false, + "description": "Pinned discussions only filter", + "schema": { + "type": "string" + }, + "descriptionHTML": "

    Pinned discussions only filter

    " } ], "x-codeSamples": [ @@ -25654,7 +25811,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -26216,7 +26373,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -26602,7 +26759,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -26961,7 +27118,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -27212,7 +27369,7 @@ } ], "summary": "Get team membership for a user", - "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.\n\n**Note:** The `role` for organization owners returns as `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/reference/teams#create-a-team).", + "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.\n\n**Note:**\nThe response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see see [Create a team](https://docs.github.com/rest/reference/teams#create-a-team).", "tags": [ "teams" ], @@ -27235,26 +27392,14 @@ "subcategoryLabel": "Members", "notes": [], "bodyParameters": [], - "descriptionHTML": "

    Team members will include the members of child teams.

    \n

    To get a user's membership with a team, the team must be visible to the authenticated user.

    \n

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

    \n

    Note: The role for organization owners returns as maintainer. For more information about maintainer roles, see Create a team.

    ", + "descriptionHTML": "

    Team members will include the members of child teams.

    \n

    To get a user's membership with a team, the team must be visible to the authenticated user.

    \n

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

    \n

    Note:\nThe response contains the state of the membership and the member's role.

    \n

    The role for organization owners is set to maintainer. For more information about maintainer roles, see see Create a team.

    ", "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response if user has an active membership with team", - "payload": "
    {\n  \"url\": \"https://api.github.com/teams/1/memberships/octocat\",\n  \"role\": \"member\",\n  \"state\": \"active\"\n}\n
    " - }, { "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Response if user is a team maintainer", "payload": "
    {\n  \"url\": \"https://api.github.com/teams/1/memberships/octocat\",\n  \"role\": \"maintainer\",\n  \"state\": \"active\"\n}\n
    " }, - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response if user has a pending membership with team", - "payload": "
    {\n  \"url\": \"https://api.github.com/teams/1/memberships/octocat\",\n  \"role\": \"member\",\n  \"state\": \"pending\"\n}\n
    " - }, { "httpStatusCode": "404", "httpStatusMessage": "Not Found", @@ -27374,12 +27519,6 @@ } ], "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response if user's membership with team is now active", - "payload": "
    {\n  \"url\": \"https://api.github.com/teams/1/memberships/octocat\",\n  \"role\": \"member\",\n  \"state\": \"active\"\n}\n
    " - }, { "httpStatusCode": "200", "httpStatusMessage": "OK", @@ -27394,8 +27533,7 @@ { "httpStatusCode": "422", "httpStatusMessage": "Unprocessable Entity", - "description": "Response if you attempt to add an organization to a team", - "payload": "
    {\n  \"message\": \"Cannot add an organization as a member.\",\n  \"errors\": [\n    {\n      \"code\": \"org\",\n      \"field\": \"user\",\n      \"resource\": \"TeamMember\"\n    }\n  ]\n}\n
    " + "description": "Response if you attempt to add an organization to a team" } ] }, @@ -27472,7 +27610,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -27790,7 +27928,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -27871,7 +28009,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -28169,7 +28307,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "descriptionHTML": "

    To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a 422 Unprocessable Entity status if you attempt to add a repository to a team that is not owned by the organization. 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

    Note: You can also specify a team by org_id and team_id using the route PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}.

    \n

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

    ", @@ -28272,7 +28410,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -28994,7 +29132,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -29440,7 +29578,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -30463,7 +30601,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -30586,7 +30724,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -31076,7 +31214,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -31691,7 +31829,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -31949,7 +32087,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -32376,7 +32514,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "descriptionHTML": "

    Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions in the repository.

    \n

    If the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as allowed_actions to selected actions, then you cannot override them for the repository.

    \n

    You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the administration repository permission to use this API.

    ", @@ -32597,7 +32735,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "descriptionHTML": "

    Sets the actions that are allowed in a repository. To use this endpoint, the repository permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for a repository.\"

    \n

    If the repository belongs to an organization or enterprise that has selected actions set at the organization or enterprise levels, then you cannot override any of the allowed actions settings.

    \n

    To use the patterns_allowed setting for private repositories, the repository must belong to an enterprise. If the repository does not belong to an enterprise, then the patterns_allowed setting only applies to public repositories.

    \n

    You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the administration repository permission to use this API.

    ", @@ -33087,7 +33225,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -33391,7 +33529,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -33923,7 +34061,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -34652,6 +34790,7 @@ "encrypted_value": { "type": "string", "description": "

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.

    ", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", "rawType": "string", @@ -34670,7 +34809,7 @@ } }, "example": { - "encrypted_value": "****************************************************************************************", + "encrypted_value": "c2VjcmV0", "key_id": "012345678912345678" } } @@ -34706,6 +34845,7 @@ { "type": "string", "description": "

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.

    ", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", "rawType": "string", @@ -34796,7 +34936,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -35059,7 +35199,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -35188,7 +35328,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "descriptionHTML": "

    You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace workflow_id with the workflow file name. For example, you could use main.yaml.

    \n

    You must configure your GitHub Actions workflow to run when the workflow_dispatch webhook event occurs. The inputs are configured in the workflow file. For more information about how to configure the workflow_dispatch event in the workflow file, see \"Events that trigger workflows.\"

    \n

    You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions:write permission to use this endpoint. For more information, see \"Creating a personal access token for the command line.\"

    ", @@ -35297,7 +35437,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -35798,7 +35938,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -35872,7 +36012,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -35974,12 +36114,6 @@ "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "
    [\n  {\n    \"name\": \"master\",\n    \"commit\": {\n      \"sha\": \"c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc\",\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc\"\n    },\n    \"protected\": true\n  }\n]\n
    " - }, - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "With protection", "payload": "
    [\n  {\n    \"name\": \"master\",\n    \"commit\": {\n      \"sha\": \"c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc\",\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc\"\n    },\n    \"protected\": true,\n    \"protection\": {\n      \"enabled\": true,\n      \"required_status_checks\": {\n        \"enforcement_level\": \"non_admins\",\n        \"contexts\": [\n          \"ci-test\",\n          \"linter\"\n        ]\n      }\n    },\n    \"protection_url\": \"https://api.github.com/repos/octocat/hello-world/branches/master/protection\"\n  }\n]\n
    " }, { @@ -37286,7 +37420,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -41856,7 +41990,7 @@ "name", "head_sha" ], - "anyOf": [ + "oneOf": [ { "properties": { "status": { @@ -41866,6 +42000,7 @@ } }, "required": [ + "status", "conclusion" ], "additionalProperties": true @@ -41885,7 +42020,7 @@ }, "examples": { "example-of-in-progress-conclusion": { - "summary": "Example of in_progress conclusion", + "summary": "Response for in_progress conclusion", "value": { "name": "mighty_readme", "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -41900,7 +42035,7 @@ } }, "example-of-completed-conclusion": { - "summary": "Example of completed conclusion", + "summary": "Response for completed conclusion", "value": { "name": "mighty_readme", "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -41967,12 +42102,6 @@ "notes": [], "descriptionHTML": "

    Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

    \n

    Creates a new check run for a specific commit in a repository. Your GitHub App must have the checks:write permission to create check runs.

    \n

    In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.

    ", "responses": [ - { - "httpStatusCode": "201", - "httpStatusMessage": "Created", - "description": "Response for in_progress conclusion", - "payload": "
    {\n  \"id\": 4,\n  \"head_sha\": \"ce587453ced02b1526dfb4cb910479d431683101\",\n  \"node_id\": \"MDg6Q2hlY2tSdW40\",\n  \"external_id\": \"42\",\n  \"url\": \"https://api.github.com/repos/github/hello-world/check-runs/4\",\n  \"html_url\": \"https://github.com/github/hello-world/runs/4\",\n  \"details_url\": \"https://example.com\",\n  \"status\": \"in_progress\",\n  \"conclusion\": \"neutral\",\n  \"started_at\": \"2018-05-04T01:14:52Z\",\n  \"completed_at\": null,\n  \"output\": {\n    \"title\": \"Mighty Readme Report\",\n    \"summary\": \"\",\n    \"text\": \"\",\n    \"annotations_count\": 1,\n    \"annotations_url\": \"https://api.github.com/repos/github/hello-world/check-runs/4/annotations\"\n  },\n  \"name\": \"mighty_readme\",\n  \"check_suite\": {\n    \"id\": 5\n  },\n  \"app\": {\n    \"id\": 1,\n    \"slug\": \"octoapp\",\n    \"node_id\": \"MDExOkludGVncmF0aW9uMQ==\",\n    \"owner\": {\n      \"login\": \"github\",\n      \"id\": 1,\n      \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n      \"url\": \"https://api.github.com/orgs/github\",\n      \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n      \"events_url\": \"https://api.github.com/orgs/github/events\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\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      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": true\n    },\n    \"name\": \"Octocat App\",\n    \"description\": \"\",\n    \"external_url\": \"https://example.com\",\n    \"html_url\": \"https://github.com/apps/octoapp\",\n    \"created_at\": \"2017-07-08T16:18:44-04:00\",\n    \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n    \"permissions\": {\n      \"metadata\": \"read\",\n      \"contents\": \"read\",\n      \"issues\": \"write\",\n      \"single_file\": \"write\"\n    },\n    \"events\": [\n      \"push\",\n      \"pull_request\"\n    ]\n  },\n  \"pull_requests\": [\n    {\n      \"url\": \"https://api.github.com/repos/github/hello-world/pulls/1\",\n      \"id\": 1934,\n      \"number\": 3956,\n      \"head\": {\n        \"ref\": \"say-hello\",\n        \"sha\": \"3dca65fa3e8d4b3da3f3d056c59aee1c50f41390\",\n        \"repo\": {\n          \"id\": 526,\n          \"url\": \"https://api.github.com/repos/github/hello-world\",\n          \"name\": \"hello-world\"\n        }\n      },\n      \"base\": {\n        \"ref\": \"master\",\n        \"sha\": \"e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f\",\n        \"repo\": {\n          \"id\": 526,\n          \"url\": \"https://api.github.com/repos/github/hello-world\",\n          \"name\": \"hello-world\"\n        }\n      }\n    }\n  ]\n}\n
    " - }, { "httpStatusCode": "201", "httpStatusMessage": "Created", @@ -45837,7 +45966,7 @@ "required": false, "schema": { "type": "string", - "description": "The full Git reference, formatted as `refs/heads/`." + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." }, "descriptionHTML": "

    The Git reference for the results you want to list. The ref for a branch can be formatted either as refs/heads/<branch name> or simply <branch name>. To reference a pull request use refs/pull/<number>/merge.

    " }, @@ -45851,6 +45980,7 @@ "description": "State of a code scanning alert.", "enum": [ "open", + "closed", "dismissed", "fixed" ] @@ -45871,7 +46001,7 @@ } ], "summary": "List code scanning alerts for a repository", - "description": "Lists all open code scanning alerts for the default branch (usually `main`\nor `master`). You must use an access token with the `security_events` scope to use\nthis endpoint. GitHub Apps must have the `security_events` read permission to use\nthis endpoint.\n\nThe response includes a `most_recent_instance` object.\nThis provides details of the most recent instance of this alert\nfor the the default branch or for the specified Git reference\n(if you used `ref` in the request).", + "description": "Lists all open code scanning alerts for the default branch (usually `main`\nor `master`). You must use an access token with the `security_events` scope to use\nthis endpoint. GitHub Apps must have the `security_events` read permission to use\nthis endpoint.\n\nThe response includes a `most_recent_instance` object.\nThis provides details of the most recent instance of this alert\nfor the default branch or for the specified Git reference\n(if you used `ref` in the request).", "tags": [ "code-scanning" ], @@ -45892,7 +46022,7 @@ "categoryLabel": "Code scanning", "notes": [], "bodyParameters": [], - "descriptionHTML": "

    Lists all open code scanning alerts for the default branch (usually main\nor master). You must use an access token with the security_events scope to use\nthis endpoint. GitHub Apps must have the security_events read permission to use\nthis endpoint.

    \n

    The response includes a most_recent_instance object.\nThis provides details of the most recent instance of this alert\nfor the the default branch or for the specified Git reference\n(if you used ref in the request).

    ", + "descriptionHTML": "

    Lists all open code scanning alerts for the default branch (usually main\nor master). You must use an access token with the security_events scope to use\nthis endpoint. GitHub Apps must have the security_events read permission to use\nthis endpoint.

    \n

    The response includes a most_recent_instance object.\nThis provides details of the most recent instance of this alert\nfor the default branch or for the specified Git reference\n(if you used ref in the request).

    ", "responses": [ { "httpStatusCode": "200", @@ -45903,7 +46033,7 @@ { "httpStatusCode": "403", "httpStatusMessage": "Forbidden", - "description": "Response if github advanced security is not enabled for this repository" + "description": "Response if git hub advanced security is not enabled for this repository" }, { "httpStatusCode": "404", @@ -45999,7 +46129,7 @@ { "httpStatusCode": "403", "httpStatusMessage": "Forbidden", - "description": "Response if github advanced security is not enabled for this repository" + "description": "Response if git hub advanced security is not enabled for this repository" }, { "httpStatusCode": "404", @@ -46264,7 +46394,7 @@ "required": false, "schema": { "type": "string", - "description": "The full Git reference, formatted as `refs/heads/`." + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." }, "descriptionHTML": "

    The Git reference for the results you want to list. The ref for a branch can be formatted either as refs/heads/<branch name> or simply <branch name>. To reference a pull request use refs/pull/<number>/merge.

    " } @@ -46314,7 +46444,7 @@ { "httpStatusCode": "403", "httpStatusMessage": "Forbidden", - "description": "Response if github advanced security is not enabled for this repository" + "description": "Response if git hub advanced security is not enabled for this repository" }, { "httpStatusCode": "404", @@ -46401,7 +46531,7 @@ "required": false, "schema": { "type": "string", - "description": "The full Git reference, formatted as `refs/heads/`." + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." }, "descriptionHTML": "

    The Git reference for the analyses you want to list. The ref for a branch can be formatted either as refs/heads/<branch name> or simply <branch name>. To reference a pull request use refs/pull/<number>/merge.

    " }, @@ -46463,7 +46593,7 @@ { "httpStatusCode": "403", "httpStatusMessage": "Forbidden", - "description": "Response if github advanced security is not enabled for this repository" + "description": "Response if git hub advanced security is not enabled for this repository" }, { "httpStatusCode": "404", @@ -46555,7 +46685,7 @@ { "httpStatusCode": "403", "httpStatusMessage": "Forbidden", - "description": "Response if github advanced security is not enabled for this repository" + "description": "Response if git hub advanced security is not enabled for this repository" }, { "httpStatusCode": "404", @@ -46608,7 +46738,8 @@ "description": "Allow deletion if the specified analysis is the last in a set. The parameter can be used without a value as the parameter value is not considered. If you attempt to delete the final analysis in a set without using this parameter you'll get a 400 response with the message: `Analysis is last of its type and deletion may result in the loss of historical alert data. Please specify confirm_delete.`", "required": false, "schema": { - "type": "string" + "type": "string", + "nullable": true }, "descriptionHTML": "

    Allow deletion if the specified analysis is the last in a set. The parameter can be used without a value as the parameter value is not considered. If you attempt to delete the final analysis in a set without using this parameter you'll get a 400 response with the message: Analysis is last of its type and deletion may result in the loss of historical alert data. Please specify confirm_delete.

    " } @@ -46713,7 +46844,7 @@ } ], "summary": "Upload an analysis as SARIF data", - "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint.\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64\n```\n\nSARIF upload supports a maximum of 1000 results per analysis run. Any results over this limit are ignored. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.\n\nThe `202 Accepted`, response includes an `id` value.\nYou can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload).\"", + "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint.\n\nThere are two places where you can upload code scanning results.\n - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see \"[Triaging code scanning alerts in pull requests](/github/finding-security-vulnerabilities-and-errors-in-your-code/triaging-code-scanning-alerts-in-pull-requests).\"\n - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see \"[Managing code scanning alerts for your repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository).\"\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64\n```\n\nSARIF upload supports a maximum of 1000 results per analysis run. Any results over this limit are ignored. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.\n\nThe `202 Accepted`, response includes an `id` value.\nYou can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload).\"", "operationId": "code-scanning/upload-sarif", "tags": [ "code-scanning" @@ -46742,11 +46873,11 @@ }, "ref": { "type": "string", - "description": "

    Required. The full Git reference, formatted as refs/heads/<branch name>.

    ", + "description": "

    Required. The full Git reference, formatted as refs/heads/<branch name>,\nrefs/pull/<number>/merge, or refs/pull/<number>/head.

    ", "name": "ref", "in": "body", "rawType": "string", - "rawDescription": "The full Git reference, formatted as `refs/heads/`.", + "rawDescription": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`.", "childParamsGroups": [] }, "sarif": { @@ -46808,7 +46939,7 @@ "category": "code-scanning", "categoryLabel": "Code scanning", "notes": [], - "descriptionHTML": "

    Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the security_events scope to use this endpoint. GitHub Apps must have the security_events write permission to use this endpoint.

    \n

    You must compress the SARIF-formatted analysis data that you want to upload, using gzip, and then encode it as a Base64 format string. For example:

    \n
    gzip -c analysis-data.sarif | base64\n
    \n

    SARIF upload supports a maximum of 1000 results per analysis run. Any results over this limit are ignored. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.

    \n

    The 202 Accepted, response includes an id value.\nYou can use this ID to check the status of the upload by using this for the /sarifs/{sarif_id} endpoint.\nFor more information, see \"Get information about a SARIF upload.\"

    ", + "descriptionHTML": "

    Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the security_events scope to use this endpoint. GitHub Apps must have the security_events write permission to use this endpoint.

    \n

    There are two places where you can upload code scanning results.

    \n\n

    You must compress the SARIF-formatted analysis data that you want to upload, using gzip, and then encode it as a Base64 format string. For example:

    \n
    gzip -c analysis-data.sarif | base64\n
    \n

    SARIF upload supports a maximum of 1000 results per analysis run. Any results over this limit are ignored. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.

    \n

    The 202 Accepted, response includes an id value.\nYou can use this ID to check the status of the upload by using this for the /sarifs/{sarif_id} endpoint.\nFor more information, see \"Get information about a SARIF upload.\"

    ", "bodyParameters": [ { "description": "

    Required. The SHA of the commit to which the analysis you are uploading relates.

    ", @@ -46824,11 +46955,11 @@ }, { "type": "string", - "description": "

    Required. The full Git reference, formatted as refs/heads/<branch name>.

    ", + "description": "

    Required. The full Git reference, formatted as refs/heads/<branch name>,\nrefs/pull/<number>/merge, or refs/pull/<number>/head.

    ", "name": "ref", "in": "body", "rawType": "string", - "rawDescription": "The full Git reference, formatted as `refs/heads/`.", + "rawDescription": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`.", "childParamsGroups": [] }, { @@ -46983,7 +47114,7 @@ { "httpStatusCode": "403", "httpStatusMessage": "Forbidden", - "description": "Response if github advanced security is not enabled for this repository" + "description": "Response if git hub advanced security is not enabled for this repository" }, { "httpStatusCode": "404", @@ -47422,7 +47553,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -47895,7 +48026,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -48285,7 +48416,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -48383,6 +48514,28 @@ "default": 1 }, "descriptionHTML": "

    Page number of the results to fetch.

    " + }, + { + "name": "top", + "description": "legacy parameter for pagination.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    legacy parameter for pagination.

    " + }, + { + "name": "last_sha", + "description": "legacy parameter for pagination.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    legacy parameter for pagination.

    " } ], "x-codeSamples": [ @@ -48978,16 +49131,36 @@ }, "descriptionHTML": "" }, + { + "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.

    " + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "descriptionHTML": "

    Results per page (max 100).

    " + }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    ref+ parameter

    " + "descriptionHTML": "

    ref parameter

    " } ], "x-codeSamples": [ @@ -49076,14 +49249,14 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    ref+ parameter

    " + "descriptionHTML": "

    ref parameter

    " }, { "name": "check_name", @@ -49144,6 +49317,15 @@ "default": 1 }, "descriptionHTML": "

    Page number of the results to fetch.

    " + }, + { + "name": "app_id", + "in": "query", + "required": false, + "schema": { + "type": "integer" + }, + "descriptionHTML": "" } ], "x-codeSamples": [ @@ -49217,14 +49399,14 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    ref+ parameter

    " + "descriptionHTML": "

    ref parameter

    " }, { "name": "app_id", @@ -49339,14 +49521,34 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    ref+ parameter

    " + "descriptionHTML": "

    ref parameter

    " + }, + { + "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": [ @@ -49425,14 +49627,14 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    ref+ parameter

    " + "descriptionHTML": "

    ref parameter

    " }, { "name": "per_page", @@ -49773,14 +49975,14 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    path+ parameter

    " + "descriptionHTML": "

    path parameter

    " }, { "name": "ref", @@ -49897,14 +50099,14 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    path+ parameter

    " + "descriptionHTML": "

    path parameter

    " } ], "x-codeSamples": [ @@ -50420,14 +50622,14 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    path+ parameter

    " + "descriptionHTML": "

    path parameter

    " } ], "x-codeSamples": [ @@ -50970,7 +51172,8 @@ "required": false, "schema": { "type": "string", - "default": "none" + "default": "none", + "nullable": true }, "descriptionHTML": "

    The name of the environment that was deployed to (e.g., staging or production).

    " }, @@ -51375,12 +51578,6 @@ "description": "Simple example", "payload": "
    {\n  \"url\": \"https://api.github.com/repos/octocat/example/deployments/1\",\n  \"id\": 1,\n  \"node_id\": \"MDEwOkRlcGxveW1lbnQx\",\n  \"sha\": \"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\n  \"ref\": \"topic-branch\",\n  \"task\": \"deploy\",\n  \"payload\": {},\n  \"original_environment\": \"staging\",\n  \"environment\": \"production\",\n  \"description\": \"Deploy request from hubot\",\n  \"creator\": {\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  \"created_at\": \"2012-07-20T01:19:13Z\",\n  \"updated_at\": \"2012-07-20T01:19:13Z\",\n  \"statuses_url\": \"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/example\",\n  \"transient_environment\": false,\n  \"production_environment\": true\n}\n
    " }, - { - "httpStatusCode": "201", - "httpStatusMessage": "Created", - "description": "Advanced example", - "payload": "
    {\n  \"url\": \"https://api.github.com/repos/octocat/example/deployments/1\",\n  \"id\": 1,\n  \"node_id\": \"MDEwOkRlcGxveW1lbnQx\",\n  \"sha\": \"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\n  \"ref\": \"topic-branch\",\n  \"task\": \"deploy\",\n  \"payload\": {},\n  \"original_environment\": \"staging\",\n  \"environment\": \"production\",\n  \"description\": \"Deploy request from hubot\",\n  \"creator\": {\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  \"created_at\": \"2012-07-20T01:19:13Z\",\n  \"updated_at\": \"2012-07-20T01:19:13Z\",\n  \"statuses_url\": \"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/example\",\n  \"transient_environment\": false,\n  \"production_environment\": true\n}\n
    " - }, { "httpStatusCode": "202", "httpStatusMessage": "Accepted", @@ -51390,14 +51587,7 @@ { "httpStatusCode": "409", "httpStatusMessage": "Conflict", - "description": "Merge conflict response", - "payload": "
    {\n  \"message\": \"Conflict merging master into topic-branch\"\n}\n
    " - }, - { - "httpStatusCode": "409", - "httpStatusMessage": "Conflict", - "description": "Failed commit status checks", - "payload": "
    {\n  \"message\": \"Conflict: Commit status checks failed for topic-branch.\"\n}\n
    " + "description": "Response when there is a merge conflict or the commit s status checks failed" }, { "httpStatusCode": "422", @@ -51571,7 +51761,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -52199,7 +52389,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "422", @@ -52380,86 +52570,6 @@ } ] }, - { - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}", - "serverUrl": "https://api.github.com", - "parameters": [ - { - "name": "owner", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "" - }, - { - "name": "repo", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "" - }, - { - "name": "environment_name", - "in": "path", - "required": true, - "description": "The name of the environment", - "schema": { - "type": "string" - }, - "descriptionHTML": "

    The name of the environment

    " - } - ], - "x-codeSamples": [ - { - "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/environments/ENVIRONMENT_NAME", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/environments/ENVIRONMENT_NAME
    " - }, - { - "lang": "JavaScript", - "source": "await octokit.request('POST /repos/{owner}/{repo}/environments/{environment_name}', {\n owner: 'octocat',\n repo: 'hello-world',\n environment_name: 'environment_name'\n})", - "html": "
    await octokit.request('POST /repos/{owner}/{repo}/environments/{environment_name}', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  environment_name: 'environment_name'\n})\n
    " - } - ], - "summary": "Create an environment", - "description": "Create an environment for a repository. If an environment with the specified name already exists, the existing environment will be returned.\n\nThe created environment will not have any protection rules configured. To configure protection rules for the created environment, see \"[Set protection rules for an environment](#set-protection-rules-for-an-environment)\".\n\nYou must authenticate using an access token with the repo scope to use this endpoint.", - "tags": [ - "repos" - ], - "operationId": "repos/create-an-environment", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/reference/repos#create-an-environment" - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [], - "category": "repos", - "subcategory": "environments" - }, - "slug": "create-an-environment", - "category": "repos", - "categoryLabel": "Repos", - "subcategory": "environments", - "subcategoryLabel": "Environments", - "notes": [], - "bodyParameters": [], - "descriptionHTML": "

    Create an environment for a repository. If an environment with the specified name already exists, the existing environment will be returned.

    \n

    The created environment will not have any protection rules configured. To configure protection rules for the created environment, see \"Set protection rules for an environment\".

    \n

    You must authenticate using an access token with the repo scope to use this endpoint.

    ", - "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Default response", - "payload": "
    {\n  \"id\": 161088068,\n  \"node_id\": \"MDExOkVudmlyb25tZW50MTYxMDg4MDY4\",\n  \"name\": \"staging\",\n  \"url\": \"https://api.github.com/repos/github/hello-world/environments/staging\",\n  \"html_url\": \"https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging\",\n  \"created_at\": \"2020-11-23T22:00:40Z\",\n  \"updated_at\": \"2020-11-23T22:00:40Z\",\n  \"protection_rules\": [],\n  \"deployment_branch_policy\": null\n}\n
    " - } - ] - }, { "verb": "put", "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}", @@ -52506,21 +52616,22 @@ "html": "
    await octokit.request('PUT /repos/{owner}/{repo}/environments/{environment_name}', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  environment_name: 'environment_name',\n  wait_timer: 42\n})\n
    " } ], - "summary": "Set protection rules for an environment", - "description": "Set protection rules, such as required reviewers, for an environment. For more information about environment protection rules, see \"[Environments](/actions/reference/environments#environment-protection-rules).\"\n\n**Note:** Although you can use this operation to specify that only branches that match specified name patterns can deploy to this environment, you must use the UI to set the name patterns. For more information, see \"[Environments](/actions/reference/environments#deployment-branches).\"\n\nYou must authenticate using an access token with the repo scope to use this endpoint.", + "summary": "Create or update an environment", + "description": "Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see \"[Environments](/actions/reference/environments#environment-protection-rules).\"\n\n**Note:** Although you can use this operation to specify that only branches that match specified name patterns can deploy to this environment, you must use the UI to set the name patterns. For more information, see \"[Environments](/actions/reference/environments#deployment-branches).\"\n\n**Note:** To create or update secrets for an environment, see \"[Secrets](/rest/reference/actions#secrets).\"\n\nYou must authenticate using an access token with the repo scope to use this endpoint.", "tags": [ "repos" ], - "operationId": "repos/set-environment-protection-rules", + "operationId": "repos/create-or-update-environment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reference/repos#set-protection-rules-for-an-environment" + "url": "https://docs.github.com/rest/reference/repos#create-or-update-an-environment" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", + "nullable": true, "properties": { "wait_timer": { "type": "integer", @@ -52533,8 +52644,9 @@ "childParamsGroups": [] }, "reviewers": { - "type": "array of objects", - "description": "

    The people or teams that may jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.

    ", + "type": "array of objects or null", + "nullable": true, + "description": "

    The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.

    ", "items": { "type": "object", "properties": { @@ -52567,7 +52679,7 @@ "name": "reviewers", "in": "body", "rawType": "array", - "rawDescription": "The people or teams that may jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.", + "rawDescription": "The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.", "childParamsGroups": [ { "parentName": "reviewers", @@ -52662,7 +52774,8 @@ } ] } - } + }, + "additionalProperties": false } } } @@ -52674,13 +52787,13 @@ "category": "repos", "subcategory": "environments" }, - "slug": "set-protection-rules-for-an-environment", + "slug": "create-or-update-an-environment", "category": "repos", "categoryLabel": "Repos", "subcategory": "environments", "subcategoryLabel": "Environments", "notes": [], - "descriptionHTML": "

    Set protection rules, such as required reviewers, for an environment. For more information about environment protection rules, see \"Environments.\"

    \n

    Note: Although you can use this operation to specify that only branches that match specified name patterns can deploy to this environment, you must use the UI to set the name patterns. For more information, see \"Environments.\"

    \n

    You must authenticate using an access token with the repo scope to use this endpoint.

    ", + "descriptionHTML": "

    Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see \"Environments.\"

    \n

    Note: Although you can use this operation to specify that only branches that match specified name patterns can deploy to this environment, you must use the UI to set the name patterns. For more information, see \"Environments.\"

    \n

    Note: To create or update secrets for an environment, see \"Secrets.\"

    \n

    You must authenticate using an access token with the repo scope to use this endpoint.

    ", "responses": [ { "httpStatusCode": "200", @@ -52691,7 +52804,7 @@ { "httpStatusCode": "422", "httpStatusMessage": "Unprocessable Entity", - "description": "Response when protected branches and custom branch policies in deployment branch policy are set to the same value" + "description": "Validation error when the environment name is invalid or when protected branches and custom branch policies in deployment branch policy are set to the same value" } ], "bodyParameters": [ @@ -52706,8 +52819,9 @@ "childParamsGroups": [] }, { - "type": "array of objects", - "description": "

    The people or teams that may jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.

    ", + "type": "array of objects or null", + "nullable": true, + "description": "

    The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.

    ", "items": { "type": "object", "properties": { @@ -52740,7 +52854,7 @@ "name": "reviewers", "in": "body", "rawType": "array", - "rawDescription": "The people or teams that may jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.", + "rawDescription": "The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.", "childParamsGroups": [ { "parentName": "reviewers", @@ -53038,7 +53152,8 @@ "enum": [ "newest", "oldest", - "stargazers" + "stargazers", + "watchers" ], "default": "newest" }, @@ -53063,6 +53178,28 @@ "default": 1 }, "descriptionHTML": "

    Page number of the results to fetch.

    " + }, + { + "name": "org", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    legacy query parameter for specifying the org.

    " + }, + { + "name": "organization", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    legacy query parameter for specifying the org.

    " } ], "x-codeSamples": [ @@ -53138,6 +53275,28 @@ "type": "string" }, "descriptionHTML": "" + }, + { + "name": "org", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    legacy query parameter for specifying the org.

    " + }, + { + "name": "organization", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    legacy query parameter for specifying the org.

    " } ], "x-codeSamples": [ @@ -53167,6 +53326,7 @@ "application/json": { "schema": { "type": "object", + "nullable": true, "properties": { "organization": { "type": "string", @@ -54067,14 +54227,14 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    ref+ parameter

    " + "descriptionHTML": "

    ref parameter

    " }, { "name": "per_page", @@ -54168,14 +54328,14 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    ref+ parameter

    " + "descriptionHTML": "

    ref parameter

    " } ], "x-codeSamples": [ @@ -54403,14 +54563,14 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    ref+ parameter

    " + "descriptionHTML": "

    ref parameter

    " } ], "x-codeSamples": [ @@ -54546,14 +54706,14 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    ref+ parameter

    " + "descriptionHTML": "

    ref parameter

    " } ], "x-codeSamples": [ @@ -54595,7 +54755,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "422", @@ -55457,6 +55617,7 @@ "schema": { "type": "string" }, + "x-multi-segment": true, "descriptionHTML": "" }, { @@ -56729,7 +56890,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -57070,7 +57231,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -57153,7 +57314,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -57680,7 +57841,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -58486,7 +58647,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "409", @@ -58784,7 +58945,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -59755,7 +59916,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -60140,7 +60301,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -61879,7 +62040,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "410", @@ -62087,7 +62248,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -62200,7 +62361,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -62594,7 +62755,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -63125,7 +63286,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -63686,7 +63847,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -63979,20 +64140,12 @@ { "httpStatusCode": "404", "httpStatusMessage": "Not Found", - "description": "Missing base response", - "payload": "
    {\n  \"message\": \"Base does not exist\"\n}\n
    " - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Missing head response", - "payload": "
    {\n  \"message\": \"Head does not exist\"\n}\n
    " + "description": "Response when the base or head does not exist" }, { "httpStatusCode": "409", "httpStatusMessage": "Conflict", - "description": "Merge conflict response", - "payload": "
    {\n  \"message\": \"Merge Conflict\"\n}\n
    " + "description": "Response when there is a merge conflict" }, { "httpStatusCode": "422", @@ -64663,7 +64816,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -65472,7 +65625,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "400", @@ -65617,7 +65770,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -66655,18 +66808,17 @@ }, { "name": "sort", - "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to).", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "created", - "updated" - ], - "default": "created" + "updated", + "created_at" + ] }, - "descriptionHTML": "

    One of created (when the repository was starred) or updated (when it was last pushed to).

    " + "descriptionHTML": "" }, { "name": "direction", @@ -67066,7 +67218,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -67456,7 +67608,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -70823,6 +70975,107 @@ } ] }, + { + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/readme/{dir}", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "dir", + "description": "The alternate path to look for a README file", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true, + "descriptionHTML": "

    The alternate path to look for a README file

    " + }, + { + "name": "ref", + "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    The name of the commit/branch/tag. Default: the repository’s default branch (usually master)

    " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/readme/DIR", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/readme/DIR
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /repos/{owner}/{repo}/readme/{dir}', {\n owner: 'octocat',\n repo: 'hello-world',\n dir: 'dir'\n})", + "html": "
    await octokit.request('GET /repos/{owner}/{repo}/readme/{dir}', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  dir: 'dir'\n})\n
    " + } + ], + "summary": "Get a repository README", + "description": "Gets the preferred README for a repository.\n\nREADMEs support [custom media types](https://docs.github.com/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML.", + "tags": [ + "repos" + ], + "operationId": "repos/get-readme-from-alt-path", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#get-a-repository-readme" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "contents" + }, + "slug": "get-a-repository-readme", + "category": "repos", + "categoryLabel": "Repos", + "subcategory": "contents", + "subcategoryLabel": "Contents", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

    Gets the preferred README for a repository.

    \n

    READMEs support custom media types for retrieving the raw content or rendered HTML.

    ", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
    {\n  \"type\": \"file\",\n  \"encoding\": \"base64\",\n  \"size\": 5362,\n  \"name\": \"README.md\",\n  \"path\": \"README.md\",\n  \"content\": \"encoded content ...\",\n  \"sha\": \"3d21ec53a331a6f037a91c368710b99387d012c1\",\n  \"url\": \"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\n  \"git_url\": \"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\n  \"html_url\": \"https://github.com/octokit/octokit.rb/blob/master/README.md\",\n  \"download_url\": \"https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md\",\n  \"_links\": {\n    \"git\": \"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\n    \"self\": \"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\n    \"html\": \"https://github.com/octokit/octokit.rb/blob/master/README.md\"\n  }\n}\n
    " + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + } + ] + }, { "verb": "get", "requestPath": "/repos/{owner}/{repo}/releases", @@ -71447,7 +71700,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -71548,14 +71801,14 @@ }, { "name": "tag", - "description": "tag+ parameter", + "description": "tag parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    tag+ parameter

    " + "descriptionHTML": "

    tag parameter

    " } ], "x-codeSamples": [ @@ -71975,7 +72228,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -73579,7 +73832,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -73861,6 +74114,26 @@ "type": "string" }, "descriptionHTML": "" + }, + { + "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.

    " + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "descriptionHTML": "

    Results per page (max 100).

    " } ], "x-codeSamples": [ @@ -74092,6 +74365,7 @@ "schema": { "type": "string", "enum": [ + "", "day", "week" ], @@ -74332,6 +74606,7 @@ "schema": { "type": "string", "enum": [ + "", "day", "week" ], @@ -74670,7 +74945,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -74744,7 +75019,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -74865,7 +75140,7 @@ } ], "summary": "Create a repository using a template", - "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", + "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository", "tags": [ "repos" ], @@ -74960,7 +75235,7 @@ "category": "repos", "categoryLabel": "Repos", "notes": [], - "descriptionHTML": "

    Creates a new repository using a repository template. Use the template_owner and template_repo route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the Get a repository endpoint and check that the is_template key is true.

    \n

    OAuth scope requirements

    \n

    When using OAuth, authorizations must include:

    \n
      \n
    • public_repo scope or repo scope to create a public repository
    • \n
    • repo scope to create a private repository
    • \n
    ", + "descriptionHTML": "

    Creates a new repository using a repository template. Use the template_owner and template_repo route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the Get a repository endpoint and check that the is_template key is true.

    \n

    OAuth scope requirements

    \n

    When using OAuth, authorizations must include:

    \n
      \n
    • public_repo scope or repo scope to create a public repository. Note: For GitHub AE, use repo scope to create an internal repository.
    • \n
    • repo scope to create a private repository
    • \n
    ", "bodyParameters": [ { "type": "string", @@ -75048,7 +75323,7 @@ } ], "summary": "List public repositories", - "description": "Lists all public repositories in the order that they were created.\n\nNote: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.", + "description": "Lists all public repositories in the order that they were created.\n\nNotes:\n- For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise.\n- Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.", "tags": [ "repos" ], @@ -75069,7 +75344,7 @@ "categoryLabel": "Repos", "notes": [], "bodyParameters": [], - "descriptionHTML": "

    Lists all public repositories in the order that they were created.

    \n

    Note: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of repositories.

    ", + "descriptionHTML": "

    Lists all public repositories in the order that they were created.

    \n

    Notes:

    \n
      \n
    • For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise.
    • \n
    • Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of repositories.
    • \n
    ", "responses": [ { "httpStatusCode": "200", @@ -75398,6 +75673,7 @@ "encrypted_value": { "type": "string", "description": "

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an environment public key endpoint.

    ", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", "rawType": "string", @@ -75416,7 +75692,7 @@ } }, "example": { - "encrypted_value": "****************************************************************************************", + "encrypted_value": "c2VjcmV0", "key_id": "012345678912345678" } } @@ -75452,6 +75728,7 @@ { "type": "string", "description": "

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an environment public key endpoint.

    ", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", "rawType": "string", @@ -75583,6 +75860,26 @@ "type": "integer" }, "descriptionHTML": "

    Used for pagination: the number of results to return.

    " + }, + { + "name": "filter", + "description": "filter results", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    filter results

    " + }, + { + "name": "excludedAttributes", + "description": "attributes to exclude", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    attributes to exclude

    " } ], "x-codeSamples": [ @@ -75873,6 +76170,16 @@ "type": "string" }, "descriptionHTML": "

    Identifier generated by the GitHub SCIM endpoint.

    " + }, + { + "name": "excludedAttributes", + "description": "Attributes to exclude.", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    Attributes to exclude.

    " } ], "x-codeSamples": [ @@ -76178,13 +76485,13 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/scim/v2/enterprises/ENTERPRISE/Groups/SCIM_GROUP_ID \\\n -d '{\"schemas\":[\"schemas\"],\"Operations\":[{}]}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/scim/v2/enterprises/ENTERPRISE/Groups/SCIM_GROUP_ID \\\n  -d '{\"schemas\":[\"schemas\"],\"Operations\":[{}]}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/scim/v2/enterprises/ENTERPRISE/Groups/SCIM_GROUP_ID \\\n -d '{\"schemas\":[\"schemas\"],\"Operations\":[{\"op\":\"op\",\"path\":\"path\",\"value\":\"value\"}]}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/scim/v2/enterprises/ENTERPRISE/Groups/SCIM_GROUP_ID \\\n  -d '{\"schemas\":[\"schemas\"],\"Operations\":[{\"op\":\"op\",\"path\":\"path\",\"value\":\"value\"}]}'
    " }, { "lang": "JavaScript", - "source": "await octokit.request('PATCH /scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}', {\n enterprise: 'enterprise',\n scim_group_id: 'scim_group_id',\n schemas: [\n 'schemas'\n ],\n Operations: [\n {}\n ]\n})", - "html": "
    await octokit.request('PATCH /scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}', {\n  enterprise: 'enterprise',\n  scim_group_id: 'scim_group_id',\n  schemas: [\n    'schemas'\n  ],\n  Operations: [\n    {}\n  ]\n})\n
    " + "source": "await octokit.request('PATCH /scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}', {\n enterprise: 'enterprise',\n scim_group_id: 'scim_group_id',\n schemas: [\n 'schemas'\n ],\n Operations: [\n {\n op: 'op',\n path: 'path',\n value: 'value'\n }\n ]\n})", + "html": "
    await octokit.request('PATCH /scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}', {\n  enterprise: 'enterprise',\n  scim_group_id: 'scim_group_id',\n  schemas: [\n    'schemas'\n  ],\n  Operations: [\n    {\n      op: 'op',\n      path: 'path',\n      value: 'value'\n    }\n  ]\n})\n
    " } ], "summary": "Update an attribute for a SCIM enterprise group", @@ -76218,14 +76525,110 @@ "Operations": { "type": "array of objects", "description": "

    Required. Array of SCIM operations.

    ", + "minItems": 1, "items": { - "type": "object" + "type": "object", + "properties": { + "op": { + "type": "string", + "enum": [ + "add", + "Add", + "remove", + "Remove", + "replace", + "Replace" + ], + "name": "op", + "in": "body", + "rawType": "string", + "description": "

    Required. undefined

    ", + "childParamsGroups": [] + }, + "path": { + "type": "string", + "name": "path", + "in": "body", + "rawType": "string", + "description": "

    undefined

    ", + "childParamsGroups": [] + }, + "value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object" + }, + { + "type": "array" + } + ], + "name": "value", + "in": "body", + "description": "

    undefined

    ", + "childParamsGroups": [] + } + }, + "required": [ + "op" + ] }, "name": "Operations", "in": "body", "rawType": "array", "rawDescription": "Array of [SCIM operations](https://tools.ietf.org/html/rfc7644#section-3.5.2).", - "childParamsGroups": [] + "childParamsGroups": [ + { + "parentName": "Operations", + "parentType": "items", + "id": "operations-items", + "params": [ + { + "type": "string", + "enum": [ + "add", + "Add", + "remove", + "Remove", + "replace", + "Replace" + ], + "name": "op", + "in": "body", + "rawType": "string", + "description": "

    Required. undefined

    ", + "childParamsGroups": [] + }, + { + "type": "string", + "name": "path", + "in": "body", + "rawType": "string", + "description": "

    undefined

    ", + "childParamsGroups": [] + }, + { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object" + }, + { + "type": "array" + } + ], + "name": "value", + "in": "body", + "description": "

    undefined

    ", + "childParamsGroups": [] + } + ] + } + ] } }, "required": [ @@ -76290,14 +76693,110 @@ { "type": "array of objects", "description": "

    Required. Array of SCIM operations.

    ", + "minItems": 1, "items": { - "type": "object" + "type": "object", + "properties": { + "op": { + "type": "string", + "enum": [ + "add", + "Add", + "remove", + "Remove", + "replace", + "Replace" + ], + "name": "op", + "in": "body", + "rawType": "string", + "description": "

    Required. undefined

    ", + "childParamsGroups": [] + }, + "path": { + "type": "string", + "name": "path", + "in": "body", + "rawType": "string", + "description": "

    undefined

    ", + "childParamsGroups": [] + }, + "value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object" + }, + { + "type": "array" + } + ], + "name": "value", + "in": "body", + "description": "

    undefined

    ", + "childParamsGroups": [] + } + }, + "required": [ + "op" + ] }, "name": "Operations", "in": "body", "rawType": "array", "rawDescription": "Array of [SCIM operations](https://tools.ietf.org/html/rfc7644#section-3.5.2).", - "childParamsGroups": [] + "childParamsGroups": [ + { + "parentName": "Operations", + "parentType": "items", + "id": "operations-items", + "params": [ + { + "type": "string", + "enum": [ + "add", + "Add", + "remove", + "Remove", + "replace", + "Replace" + ], + "name": "op", + "in": "body", + "rawType": "string", + "description": "

    Required. undefined

    ", + "childParamsGroups": [] + }, + { + "type": "string", + "name": "path", + "in": "body", + "rawType": "string", + "description": "

    undefined

    ", + "childParamsGroups": [] + }, + { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object" + }, + { + "type": "array" + } + ], + "name": "value", + "in": "body", + "description": "

    undefined

    ", + "childParamsGroups": [] + } + ] + } + ] } ] }, @@ -76366,7 +76865,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -76406,6 +76905,16 @@ "type": "integer" }, "descriptionHTML": "

    Used for pagination: the number of results to return.

    " + }, + { + "name": "filter", + "description": "filter results", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    filter results

    " } ], "x-codeSamples": [ @@ -77755,7 +78264,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -79565,7 +80074,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -80763,7 +81272,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -81310,7 +81819,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -81837,7 +82346,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -82693,13 +83202,11 @@ "subcategory": "members", "subcategoryLabel": "Members", "notes": [], - "bodyParameters": [], - "descriptionHTML": "

    The \"Add team member\" endpoint (described below) is deprecated.

    \n

    We recommend using the Add or update team membership for a user endpoint instead. It allows you to invite new organization members to your teams.

    \n

    Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

    \n

    To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.

    \n

    Note: When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub.\"

    \n

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

    ", "responses": [ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -82714,16 +83221,11 @@ { "httpStatusCode": "422", "httpStatusMessage": "Unprocessable Entity", - "description": "Response if you attempt to add an organization to a team", - "payload": "
    {\n  \"message\": \"Cannot add an organization as a member.\",\n  \"errors\": [\n    {\n      \"code\": \"org\",\n      \"field\": \"user\",\n      \"resource\": \"TeamMember\"\n    }\n  ]\n}\n
    " - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Response if you attempt to add a user to a team when they are not a member of at least one other team in the same organization", - "payload": "
    {\n  \"message\": \"User isn't a member of this organization. Please invite them first.\",\n  \"errors\": [\n    {\n      \"code\": \"unaffiliated\",\n      \"field\": \"user\",\n      \"resource\": \"TeamMember\"\n    }\n  ]\n}\n
    " + "description": "Response if you attempt to add an organization to a team or you attempt to add a user to a team when they are not a member of at least one other team in the same organization" } - ] + ], + "bodyParameters": [], + "descriptionHTML": "

    The \"Add team member\" endpoint (described below) is deprecated.

    \n

    We recommend using the Add or update team membership for a user endpoint instead. It allows you to invite new organization members to your teams.

    \n

    Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

    \n

    To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.

    \n

    Note: When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub.\"

    \n

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

    " }, { "verb": "delete", @@ -82791,7 +83293,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -82839,7 +83341,7 @@ } ], "summary": "Get team membership for a user (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 [Get team membership for a user](https://docs.github.com/rest/reference/teams#get-team-membership-for-a-user) endpoint.\n\nTeam members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:** The `role` for organization owners returns as `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/reference/teams#create-a-team).", + "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 [Get team membership for a user](https://docs.github.com/rest/reference/teams#get-team-membership-for-a-user) endpoint.\n\nTeam members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:**\nThe response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/reference/teams#create-a-team).", "tags": [ "teams" ], @@ -82865,26 +83367,14 @@ "subcategoryLabel": "Members", "notes": [], "bodyParameters": [], - "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 Get team membership for a user endpoint.

    \n

    Team members will include the members of child teams.

    \n

    To get a user's membership with a team, the team must be visible to the authenticated user.

    \n

    Note: The role for organization owners returns as maintainer. For more information about maintainer roles, see Create a team.

    ", + "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 Get team membership for a user endpoint.

    \n

    Team members will include the members of child teams.

    \n

    To get a user's membership with a team, the team must be visible to the authenticated user.

    \n

    Note:\nThe response contains the state of the membership and the member's role.

    \n

    The role for organization owners is set to maintainer. For more information about maintainer roles, see Create a team.

    ", "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response if user has an active membership with team", - "payload": "
    {\n  \"url\": \"https://api.github.com/teams/1/memberships/octocat\",\n  \"role\": \"member\",\n  \"state\": \"active\"\n}\n
    " - }, { "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Response if user is a team maintainer", "payload": "
    {\n  \"url\": \"https://api.github.com/teams/1/memberships/octocat\",\n  \"role\": \"maintainer\",\n  \"state\": \"active\"\n}\n
    " }, - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response if user has a pending membership with team", - "payload": "
    {\n  \"url\": \"https://api.github.com/teams/1/memberships/octocat\",\n  \"role\": \"member\",\n  \"state\": \"pending\"\n}\n
    " - }, { "httpStatusCode": "404", "httpStatusMessage": "Not Found", @@ -82997,12 +83487,6 @@ } ], "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response if user's membership with team is now active", - "payload": "
    {\n  \"url\": \"https://api.github.com/teams/1/memberships/octocat\",\n  \"role\": \"member\",\n  \"state\": \"active\"\n}\n
    " - }, { "httpStatusCode": "200", "httpStatusMessage": "OK", @@ -83022,8 +83506,7 @@ { "httpStatusCode": "422", "httpStatusMessage": "Unprocessable Entity", - "description": "Response if you attempt to add an organization to a team", - "payload": "
    {\n  \"message\": \"Cannot add an organization as a member.\",\n  \"errors\": [\n    {\n      \"code\": \"org\",\n      \"field\": \"user\",\n      \"resource\": \"TeamMember\"\n    }\n  ]\n}\n
    " + "description": "Response if you attempt to add an organization to a team" } ] }, @@ -83093,7 +83576,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -83404,7 +83887,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -83493,7 +83976,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -83788,7 +84271,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -83892,7 +84375,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -84980,7 +85463,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -85065,7 +85548,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -85531,7 +86014,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -85870,7 +86353,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -85950,7 +86433,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -86314,7 +86797,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -86605,7 +87088,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -86690,7 +87173,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -86943,7 +87426,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -86966,6 +87449,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -87481,7 +87965,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -88509,7 +88993,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -88607,7 +89091,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -88961,7 +89445,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "401", @@ -89014,6 +89498,16 @@ "type": "string" }, "descriptionHTML": "

    The name of the package.

    " + }, + { + "name": "token", + "description": "package token", + "schema": { + "type": "string" + }, + "required": false, + "in": "query", + "descriptionHTML": "

    package token

    " } ], "x-codeSamples": [ @@ -89053,7 +89547,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "401", @@ -89106,6 +89600,41 @@ "type": "string" }, "descriptionHTML": "

    The name of the package.

    " + }, + { + "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.

    " + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "descriptionHTML": "

    Results per page (max 100).

    " + }, + { + "name": "state", + "in": "query", + "required": false, + "description": "The state of the package, either active or deleted.", + "schema": { + "type": "string", + "enum": [ + "active", + "deleted" + ], + "default": "active" + }, + "descriptionHTML": "

    The state of the package, either active or deleted.

    " } ], "x-codeSamples": [ @@ -89125,7 +89654,7 @@ "tags": [ "packages" ], - "operationId": "packages/get-all-package-versions-for-a-package-owned-by-the-authenticated-user", + "operationId": "packages/get-all-package-versions-for-package-owned-by-authenticated-user", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/reference/packages#get-all-package-versions-for-a-package-owned-by-the-authenticated-user" @@ -89336,7 +89865,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "401", @@ -89438,7 +89967,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "401", @@ -89696,7 +90225,7 @@ "parameters": [ { "name": "visibility", - "description": "Can be one of `all`, `public`, or `private`.", + "description": "Can be one of `all`, `public`, or `private`. Note: For GitHub AE, can be one of `all`, `internal`, or `private`.", "in": "query", "required": false, "schema": { @@ -89708,7 +90237,7 @@ ], "default": "all" }, - "descriptionHTML": "

    Can be one of all, public, or private.

    " + "descriptionHTML": "

    Can be one of all, public, or private. Note: For GitHub AE, can be one of all, internal, or private.

    " }, { "name": "affiliation", @@ -89723,7 +90252,7 @@ }, { "name": "type", - "description": "Can be one of `all`, `owner`, `public`, `private`, `member`. Default: `all` \n \nWill cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.", + "description": "Can be one of `all`, `owner`, `public`, `private`, `member`. Note: For GitHub AE, can be one of `all`, `owner`, `internal`, `private`, `member`. Default: `all` \n \nWill cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.", "in": "query", "required": false, "schema": { @@ -89737,7 +90266,7 @@ ], "default": "all" }, - "descriptionHTML": "

    Can be one of all, owner, public, private, member. Default: all

    \n

    Will cause a 422 error if used in the same request as visibility or affiliation. Will cause a 422 error if used in the same request as visibility or affiliation.

    " + "descriptionHTML": "

    Can be one of all, owner, public, private, member. Note: For GitHub AE, can be one of all, owner, internal, private, member. Default: all

    \n

    Will cause a 422 error if used in the same request as visibility or affiliation. Will cause a 422 error if used in the same request as visibility or affiliation.

    " }, { "name": "sort", @@ -89893,7 +90422,7 @@ } ], "summary": "Create a repository for the authenticated user", - "description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", + "description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository.", "tags": [ "repos" ], @@ -89936,13 +90465,13 @@ "childParamsGroups": [] }, "private": { - "description": "

    Whether the repository is private or public.

    ", + "description": "

    Whether the repository is private.

    ", "default": false, "type": "boolean", "name": "private", "in": "body", "rawType": "boolean", - "rawDescription": "Whether the repository is private or public.", + "rawDescription": "Whether the repository is private.", "childParamsGroups": [] }, "has_issues": { @@ -90116,7 +90645,7 @@ "category": "repos", "categoryLabel": "Repos", "notes": [], - "descriptionHTML": "

    Creates a new repository for the authenticated user.

    \n

    OAuth scope requirements

    \n

    When using OAuth, authorizations must include:

    \n
      \n
    • public_repo scope or repo scope to create a public repository
    • \n
    • repo scope to create a private repository
    • \n
    ", + "descriptionHTML": "

    Creates a new repository for the authenticated user.

    \n

    OAuth scope requirements

    \n

    When using OAuth, authorizations must include:

    \n
      \n
    • public_repo scope or repo scope to create a public repository. Note: For GitHub AE, use repo scope to create an internal repository.
    • \n
    • repo scope to create a private repository.
    • \n
    ", "bodyParameters": [ { "description": "

    Required. The name of the repository.

    ", @@ -90147,13 +90676,13 @@ "childParamsGroups": [] }, { - "description": "

    Whether the repository is private or public.

    ", + "description": "

    Whether the repository is private.

    ", "default": false, "type": "boolean", "name": "private", "in": "body", "rawType": "boolean", - "rawDescription": "Whether the repository is private or public.", + "rawDescription": "Whether the repository is private.", "childParamsGroups": [] }, { @@ -90481,7 +91010,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -90562,7 +91091,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -90857,7 +91386,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -90946,7 +91475,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -92916,7 +93445,7 @@ } ], "summary": "List repositories for a user", - "description": "Lists public repositories for the specified user.", + "description": "Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user.", "tags": [ "repos" ], @@ -92944,7 +93473,7 @@ "categoryLabel": "Repos", "notes": [], "bodyParameters": [], - "descriptionHTML": "

    Lists public repositories for the specified user.

    ", + "descriptionHTML": "

    Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user.

    ", "responses": [ { "httpStatusCode": "200", @@ -92982,7 +93511,7 @@ } ], "summary": "Get GitHub Actions billing for a user", - "description": "Gets the summary of the free and paid GitHub Actions minutes used.\n\nPaid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nAccess tokens must have the `user` scope.", + "description": "Gets the summary of the free and paid GitHub Actions minutes used.\n\nPaid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nAccess tokens must have the `user` scope.", "operationId": "billing/get-github-actions-billing-user", "tags": [ "billing" @@ -93003,7 +93532,7 @@ "categoryLabel": "Billing", "notes": [], "bodyParameters": [], - "descriptionHTML": "

    Gets the summary of the free and paid GitHub Actions minutes used.

    \n

    Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"Managing billing for GitHub Actions\".

    \n

    Access tokens must have the user scope.

    ", + "descriptionHTML": "

    Gets the summary of the free and paid GitHub Actions minutes used.

    \n

    Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see \"Managing billing for GitHub Actions\".

    \n

    Access tokens must have the user scope.

    ", "responses": [ { "httpStatusCode": "200", diff --git a/lib/rest/static/decorated/ghes-2.18.json b/lib/rest/static/decorated/ghes-2.18.json index 1af1e09823..3e406e7f69 100644 --- a/lib/rest/static/decorated/ghes-2.18.json +++ b/lib/rest/static/decorated/ghes-2.18.json @@ -2,13 +2,13 @@ { "verb": "get", "requestPath": "/", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/
    " }, { "lang": "JavaScript", @@ -45,7 +45,7 @@ { "verb": "get", "requestPath": "/admin/hooks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -82,8 +82,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n https://api.github.com/admin/hooks", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  https://api.github.com/admin/hooks
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/hooks", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/hooks
    " }, { "lang": "JavaScript", @@ -135,7 +135,7 @@ { "verb": "post", "requestPath": "/admin/hooks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -152,8 +152,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n https://api.github.com/admin/hooks \\\n -d '{\"name\":\"name\",\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  https://api.github.com/admin/hooks \\\n  -d '{\"name\":\"name\",\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/hooks \\\n -d '{\"name\":\"name\",\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/hooks \\\n  -d '{\"name\":\"name\",\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'
    " }, { "lang": "JavaScript", @@ -483,7 +483,7 @@ { "verb": "get", "requestPath": "/admin/hooks/{hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -509,8 +509,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n https://api.github.com/admin/hooks/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  https://api.github.com/admin/hooks/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/hooks/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/hooks/42
    " }, { "lang": "JavaScript", @@ -562,7 +562,7 @@ { "verb": "patch", "requestPath": "/admin/hooks/{hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -588,8 +588,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n https://api.github.com/admin/hooks/42 \\\n -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  https://api.github.com/admin/hooks/42 \\\n  -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/hooks/42 \\\n -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/hooks/42 \\\n  -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'
    " }, { "lang": "JavaScript", @@ -893,7 +893,7 @@ { "verb": "delete", "requestPath": "/admin/hooks/{hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -919,8 +919,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n https://api.github.com/admin/hooks/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  https://api.github.com/admin/hooks/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/hooks/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/hooks/42
    " }, { "lang": "JavaScript", @@ -962,7 +962,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -971,7 +971,7 @@ { "verb": "post", "requestPath": "/admin/hooks/{hook_id}/pings", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -997,8 +997,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n https://api.github.com/admin/hooks/42/pings", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  https://api.github.com/admin/hooks/42/pings
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/hooks/42/pings", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/hooks/42/pings
    " }, { "lang": "JavaScript", @@ -1040,7 +1040,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -1049,7 +1049,7 @@ { "verb": "get", "requestPath": "/admin/keys", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -1070,13 +1070,53 @@ "default": 1 }, "descriptionHTML": "

    Page number of the results to fetch.

    " + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + }, + "descriptionHTML": "

    One of asc (ascending) or desc (descending).

    " + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "accessed" + ], + "default": "created" + }, + "descriptionHTML": "" + }, + { + "name": "since", + "description": "Only show public keys accessed after the given time.", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    Only show public keys accessed after the given time.

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/keys", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/keys
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/keys", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/keys
    " }, { "lang": "JavaScript", @@ -1121,7 +1161,7 @@ { "verb": "delete", "requestPath": "/admin/keys/{key_ids}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "key_ids", @@ -1136,8 +1176,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/keys/KEY_IDS", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/keys/KEY_IDS
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/keys/KEY_IDS", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/keys/KEY_IDS
    " }, { "lang": "JavaScript", @@ -1172,7 +1212,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -1181,7 +1221,7 @@ { "verb": "patch", "requestPath": "/admin/ldap/teams/{team_id}/mapping", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -1196,8 +1236,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/ldap/teams/42/mapping \\\n -d '{\"ldap_dn\":\"ldap_dn\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/ldap/teams/42/mapping \\\n  -d '{\"ldap_dn\":\"ldap_dn\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/ldap/teams/42/mapping \\\n -d '{\"ldap_dn\":\"ldap_dn\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/ldap/teams/42/mapping \\\n  -d '{\"ldap_dn\":\"ldap_dn\"}'
    " }, { "lang": "JavaScript", @@ -1282,7 +1322,7 @@ { "verb": "post", "requestPath": "/admin/ldap/teams/{team_id}/sync", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -1297,8 +1337,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/ldap/teams/42/sync", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/ldap/teams/42/sync
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/ldap/teams/42/sync", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/ldap/teams/42/sync
    " }, { "lang": "JavaScript", @@ -1343,7 +1383,7 @@ { "verb": "patch", "requestPath": "/admin/ldap/users/{username}/mapping", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -1358,8 +1398,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/ldap/users/USERNAME/mapping \\\n -d '{\"ldap_dn\":\"ldap_dn\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/ldap/users/USERNAME/mapping \\\n  -d '{\"ldap_dn\":\"ldap_dn\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/ldap/users/USERNAME/mapping \\\n -d '{\"ldap_dn\":\"ldap_dn\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/ldap/users/USERNAME/mapping \\\n  -d '{\"ldap_dn\":\"ldap_dn\"}'
    " }, { "lang": "JavaScript", @@ -1437,7 +1477,7 @@ { "verb": "post", "requestPath": "/admin/ldap/users/{username}/sync", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -1452,8 +1492,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/ldap/users/USERNAME/sync", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/ldap/users/USERNAME/sync
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/ldap/users/USERNAME/sync", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/ldap/users/USERNAME/sync
    " }, { "lang": "JavaScript", @@ -1498,13 +1538,13 @@ { "verb": "post", "requestPath": "/admin/organizations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/organizations \\\n -d '{\"login\":\"login\",\"admin\":\"admin\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/organizations \\\n  -d '{\"login\":\"login\",\"admin\":\"admin\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/organizations \\\n -d '{\"login\":\"login\",\"admin\":\"admin\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/organizations \\\n  -d '{\"login\":\"login\",\"admin\":\"admin\"}'
    " }, { "lang": "JavaScript", @@ -1624,7 +1664,7 @@ { "verb": "patch", "requestPath": "/admin/organizations/{org}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -1639,8 +1679,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/organizations/ORG \\\n -d '{\"login\":\"login\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/organizations/ORG \\\n  -d '{\"login\":\"login\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/organizations/ORG \\\n -d '{\"login\":\"login\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/organizations/ORG \\\n  -d '{\"login\":\"login\"}'
    " }, { "lang": "JavaScript", @@ -1721,7 +1761,7 @@ { "verb": "get", "requestPath": "/admin/pre-receive-environments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -1742,13 +1782,43 @@ "default": 1 }, "descriptionHTML": "

    Page number of the results to fetch.

    " + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + }, + "descriptionHTML": "

    One of asc (ascending) or desc (descending).

    " + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + }, + "descriptionHTML": "" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-environments", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/admin/pre-receive-environments
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/pre-receive-environments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/pre-receive-environments
    " }, { "lang": "JavaScript", @@ -1800,13 +1870,13 @@ { "verb": "post", "requestPath": "/admin/pre-receive-environments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-environments \\\n -d '{\"name\":\"name\",\"image_url\":\"image_url\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/admin/pre-receive-environments \\\n  -d '{\"name\":\"name\",\"image_url\":\"image_url\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/pre-receive-environments \\\n -d '{\"name\":\"name\",\"image_url\":\"image_url\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/pre-receive-environments \\\n  -d '{\"name\":\"name\",\"image_url\":\"image_url\"}'
    " }, { "lang": "JavaScript", @@ -1914,7 +1984,7 @@ { "verb": "get", "requestPath": "/admin/pre-receive-environments/{pre_receive_environment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "pre_receive_environment_id", @@ -1929,8 +1999,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-environments/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/admin/pre-receive-environments/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/pre-receive-environments/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/pre-receive-environments/42
    " }, { "lang": "JavaScript", @@ -1982,7 +2052,7 @@ { "verb": "patch", "requestPath": "/admin/pre-receive-environments/{pre_receive_environment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "pre_receive_environment_id", @@ -1997,8 +2067,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-environments/42 \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/admin/pre-receive-environments/42 \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/pre-receive-environments/42 \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/pre-receive-environments/42 \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -2104,7 +2174,7 @@ { "verb": "delete", "requestPath": "/admin/pre-receive-environments/{pre_receive_environment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "pre_receive_environment_id", @@ -2119,8 +2189,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-environments/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/admin/pre-receive-environments/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/pre-receive-environments/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/pre-receive-environments/42
    " }, { "lang": "JavaScript", @@ -2164,7 +2234,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "422", @@ -2177,7 +2247,7 @@ { "verb": "post", "requestPath": "/admin/pre-receive-environments/{pre_receive_environment_id}/downloads", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "pre_receive_environment_id", @@ -2192,8 +2262,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-environments/42/downloads", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/admin/pre-receive-environments/42/downloads
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/pre-receive-environments/42/downloads", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/pre-receive-environments/42/downloads
    " }, { "lang": "JavaScript", @@ -2251,7 +2321,7 @@ { "verb": "get", "requestPath": "/admin/pre-receive-environments/{pre_receive_environment_id}/downloads/latest", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "pre_receive_environment_id", @@ -2266,8 +2336,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-environments/42/downloads/latest", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/admin/pre-receive-environments/42/downloads/latest
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/pre-receive-environments/42/downloads/latest", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/pre-receive-environments/42/downloads/latest
    " }, { "lang": "JavaScript", @@ -2319,7 +2389,7 @@ { "verb": "get", "requestPath": "/admin/pre-receive-hooks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -2340,13 +2410,44 @@ "default": 1 }, "descriptionHTML": "

    Page number of the results to fetch.

    " + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + }, + "descriptionHTML": "

    One of asc (ascending) or desc (descending).

    " + }, + { + "name": "sort", + "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to) or `name`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + }, + "descriptionHTML": "

    One of created (when the repository was starred) or updated (when it was last pushed to) or name.

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-hooks", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/admin/pre-receive-hooks
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/pre-receive-hooks", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/pre-receive-hooks
    " }, { "lang": "JavaScript", @@ -2398,13 +2499,13 @@ { "verb": "post", "requestPath": "/admin/pre-receive-hooks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-hooks \\\n -d '{\"name\":\"name\",\"script\":\"script\",\"script_repository\":{},\"environment\":{}}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/admin/pre-receive-hooks \\\n  -d '{\"name\":\"name\",\"script\":\"script\",\"script_repository\":{},\"environment\":{}}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/pre-receive-hooks \\\n -d '{\"name\":\"name\",\"script\":\"script\",\"script_repository\":{},\"environment\":{}}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/pre-receive-hooks \\\n  -d '{\"name\":\"name\",\"script\":\"script\",\"script_repository\":{},\"environment\":{}}'
    " }, { "lang": "JavaScript", @@ -2602,7 +2703,7 @@ { "verb": "get", "requestPath": "/admin/pre-receive-hooks/{pre_receive_hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "pre_receive_hook_id", @@ -2617,8 +2718,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-hooks/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/admin/pre-receive-hooks/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/pre-receive-hooks/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/pre-receive-hooks/42
    " }, { "lang": "JavaScript", @@ -2670,7 +2771,7 @@ { "verb": "patch", "requestPath": "/admin/pre-receive-hooks/{pre_receive_hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "pre_receive_hook_id", @@ -2685,8 +2786,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-hooks/42 \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/admin/pre-receive-hooks/42 \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/pre-receive-hooks/42 \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/pre-receive-hooks/42 \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -2873,7 +2974,7 @@ { "verb": "delete", "requestPath": "/admin/pre-receive-hooks/{pre_receive_hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "pre_receive_hook_id", @@ -2888,8 +2989,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-hooks/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/admin/pre-receive-hooks/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/pre-receive-hooks/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/pre-receive-hooks/42
    " }, { "lang": "JavaScript", @@ -2931,7 +3032,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -2940,7 +3041,7 @@ { "verb": "get", "requestPath": "/admin/tokens", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -2966,8 +3067,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/tokens", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/tokens
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/tokens", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/tokens
    " }, { "lang": "JavaScript", @@ -3012,7 +3113,7 @@ { "verb": "delete", "requestPath": "/admin/tokens/{token_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "token_id", @@ -3027,8 +3128,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/tokens/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/tokens/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/tokens/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/tokens/42
    " }, { "lang": "JavaScript", @@ -3063,7 +3164,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -3072,13 +3173,13 @@ { "verb": "post", "requestPath": "/admin/users", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/users \\\n -d '{\"login\":\"login\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/users \\\n  -d '{\"login\":\"login\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/users \\\n -d '{\"login\":\"login\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/users \\\n  -d '{\"login\":\"login\"}'
    " }, { "lang": "JavaScript", @@ -3178,7 +3279,7 @@ { "verb": "patch", "requestPath": "/admin/users/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -3193,8 +3294,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/users/USERNAME \\\n -d '{\"login\":\"login\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/users/USERNAME \\\n  -d '{\"login\":\"login\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/users/USERNAME \\\n -d '{\"login\":\"login\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/users/USERNAME \\\n  -d '{\"login\":\"login\"}'
    " }, { "lang": "JavaScript", @@ -3275,7 +3376,7 @@ { "verb": "delete", "requestPath": "/admin/users/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -3290,8 +3391,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/users/USERNAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/users/USERNAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/users/USERNAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/users/USERNAME
    " }, { "lang": "JavaScript", @@ -3326,7 +3427,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -3335,7 +3436,7 @@ { "verb": "post", "requestPath": "/admin/users/{username}/authorizations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -3350,8 +3451,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/users/USERNAME/authorizations \\\n -d '{\"scopes\":[\"scopes\"]}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/users/USERNAME/authorizations \\\n  -d '{\"scopes\":[\"scopes\"]}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/users/USERNAME/authorizations \\\n -d '{\"scopes\":[\"scopes\"]}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/users/USERNAME/authorizations \\\n  -d '{\"scopes\":[\"scopes\"]}'
    " }, { "lang": "JavaScript", @@ -3432,7 +3533,7 @@ { "verb": "delete", "requestPath": "/admin/users/{username}/authorizations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -3447,8 +3548,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/users/USERNAME/authorizations", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/users/USERNAME/authorizations
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/users/USERNAME/authorizations", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/users/USERNAME/authorizations
    " }, { "lang": "JavaScript", @@ -3483,7 +3584,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -3492,13 +3593,13 @@ { "verb": "get", "requestPath": "/app", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/app", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  https://api.github.com/app
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n http(s)://{hostname}/api/v3/app", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  http(s)://{hostname}/api/v3/app
    " }, { "lang": "JavaScript", @@ -3547,7 +3648,7 @@ { "verb": "post", "requestPath": "/app-manifests/{code}/conversions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "code", @@ -3562,8 +3663,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/app-manifests/CODE/conversions", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/app-manifests/CODE/conversions
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/app-manifests/CODE/conversions", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/app-manifests/CODE/conversions
    " }, { "lang": "JavaScript", @@ -3616,7 +3717,7 @@ { "verb": "get", "requestPath": "/app/installations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -3653,8 +3754,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/app/installations", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  https://api.github.com/app/installations
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n http(s)://{hostname}/api/v3/app/installations", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  http(s)://{hostname}/api/v3/app/installations
    " }, { "lang": "JavaScript", @@ -3703,7 +3804,7 @@ { "verb": "get", "requestPath": "/app/installations/{installation_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -3730,8 +3831,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/app/installations/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  https://api.github.com/app/installations/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n http(s)://{hostname}/api/v3/app/installations/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  http(s)://{hostname}/api/v3/app/installations/42
    " }, { "lang": "JavaScript", @@ -3790,7 +3891,7 @@ { "verb": "delete", "requestPath": "/app/installations/{installation_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -3817,8 +3918,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.gambit-preview+json\" \\\n https://api.github.com/app/installations/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.gambit-preview+json\" \\\n  https://api.github.com/app/installations/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.gambit-preview+json\" \\\n http(s)://{hostname}/api/v3/app/installations/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.gambit-preview+json\" \\\n  http(s)://{hostname}/api/v3/app/installations/42
    " }, { "lang": "JavaScript", @@ -3863,7 +3964,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -3877,7 +3978,7 @@ { "verb": "post", "requestPath": "/app/installations/{installation_id}/access_tokens", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -3904,8 +4005,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/app/installations/42/access_tokens \\\n -d '{\"repositories\":[\"repositories\"]}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  https://api.github.com/app/installations/42/access_tokens \\\n  -d '{\"repositories\":[\"repositories\"]}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n http(s)://{hostname}/api/v3/app/installations/42/access_tokens \\\n -d '{\"repositories\":[\"repositories\"]}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  http(s)://{hostname}/api/v3/app/installations/42/access_tokens \\\n  -d '{\"repositories\":[\"repositories\"]}'
    " }, { "lang": "JavaScript", @@ -5655,7 +5756,7 @@ { "verb": "get", "requestPath": "/applications/grants", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -5676,13 +5777,23 @@ "default": 1 }, "descriptionHTML": "

    Page number of the results to fetch.

    " + }, + { + "name": "client_id", + "in": "query", + "required": false, + "description": "The client ID of your GitHub app.", + "schema": { + "type": "string" + }, + "descriptionHTML": "

    The client ID of your GitHub app.

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/grants", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/applications/grants
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/applications/grants", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/applications/grants
    " }, { "lang": "JavaScript", @@ -5748,7 +5859,7 @@ { "verb": "get", "requestPath": "/applications/grants/{grant_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "grant_id", @@ -5764,8 +5875,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/grants/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/applications/grants/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/applications/grants/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/applications/grants/42
    " }, { "lang": "JavaScript", @@ -5826,7 +5937,7 @@ { "verb": "delete", "requestPath": "/applications/grants/{grant_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "grant_id", @@ -5842,8 +5953,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/grants/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/applications/grants/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/applications/grants/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/applications/grants/42
    " }, { "lang": "JavaScript", @@ -5879,7 +5990,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -5903,7 +6014,7 @@ { "verb": "delete", "requestPath": "/applications/{client_id}/grants/{access_token}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "client_id", @@ -5928,8 +6039,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/CLIENT_ID/grants/ACCESS_TOKEN", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/applications/CLIENT_ID/grants/ACCESS_TOKEN
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/applications/CLIENT_ID/grants/ACCESS_TOKEN", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/applications/CLIENT_ID/grants/ACCESS_TOKEN
    " }, { "lang": "JavaScript", @@ -5962,7 +6073,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -5971,7 +6082,7 @@ { "verb": "get", "requestPath": "/applications/{client_id}/tokens/{access_token}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "client_id", @@ -5996,8 +6107,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/CLIENT_ID/tokens/ACCESS_TOKEN", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/applications/CLIENT_ID/tokens/ACCESS_TOKEN
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/applications/CLIENT_ID/tokens/ACCESS_TOKEN", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/applications/CLIENT_ID/tokens/ACCESS_TOKEN
    " }, { "lang": "JavaScript", @@ -6040,7 +6151,7 @@ { "verb": "post", "requestPath": "/applications/{client_id}/tokens/{access_token}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "client_id", @@ -6065,8 +6176,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/CLIENT_ID/tokens/ACCESS_TOKEN", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/applications/CLIENT_ID/tokens/ACCESS_TOKEN
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/applications/CLIENT_ID/tokens/ACCESS_TOKEN", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/applications/CLIENT_ID/tokens/ACCESS_TOKEN
    " }, { "lang": "JavaScript", @@ -6109,7 +6220,7 @@ { "verb": "delete", "requestPath": "/applications/{client_id}/tokens/{access_token}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "client_id", @@ -6134,8 +6245,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/CLIENT_ID/tokens/ACCESS_TOKEN", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/applications/CLIENT_ID/tokens/ACCESS_TOKEN
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/applications/CLIENT_ID/tokens/ACCESS_TOKEN", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/applications/CLIENT_ID/tokens/ACCESS_TOKEN
    " }, { "lang": "JavaScript", @@ -6168,7 +6279,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -6177,7 +6288,7 @@ { "verb": "get", "requestPath": "/apps/{app_slug}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "app_slug", @@ -6192,8 +6303,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/apps/APP_SLUG", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  https://api.github.com/apps/APP_SLUG
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n http(s)://{hostname}/api/v3/apps/APP_SLUG", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  http(s)://{hostname}/api/v3/apps/APP_SLUG
    " }, { "lang": "JavaScript", @@ -6257,7 +6368,7 @@ { "verb": "get", "requestPath": "/authorizations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -6278,13 +6389,23 @@ "default": 1 }, "descriptionHTML": "

    Page number of the results to fetch.

    " + }, + { + "name": "client_id", + "in": "query", + "required": false, + "description": "The client ID of your GitHub app.", + "schema": { + "type": "string" + }, + "descriptionHTML": "

    The client ID of your GitHub app.

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/authorizations", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/authorizations
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/authorizations", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/authorizations
    " }, { "lang": "JavaScript", @@ -6350,13 +6471,13 @@ { "verb": "post", "requestPath": "/authorizations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/authorizations \\\n -d '{\"scopes\":[\"scopes\"]}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/authorizations \\\n  -d '{\"scopes\":[\"scopes\"]}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/authorizations \\\n -d '{\"scopes\":[\"scopes\"]}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/authorizations \\\n  -d '{\"scopes\":[\"scopes\"]}'
    " }, { "lang": "JavaScript", @@ -6569,7 +6690,7 @@ { "verb": "put", "requestPath": "/authorizations/clients/{client_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "client_id", @@ -6585,8 +6706,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/authorizations/clients/CLIENT_ID \\\n -d '{\"client_secret\":\"client_secret\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/authorizations/clients/CLIENT_ID \\\n  -d '{\"client_secret\":\"client_secret\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/authorizations/clients/CLIENT_ID \\\n -d '{\"client_secret\":\"client_secret\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/authorizations/clients/CLIENT_ID \\\n  -d '{\"client_secret\":\"client_secret\"}'
    " }, { "lang": "JavaScript", @@ -6783,7 +6904,7 @@ { "verb": "put", "requestPath": "/authorizations/clients/{client_id}/{fingerprint}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "client_id", @@ -6808,8 +6929,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/authorizations/clients/CLIENT_ID/FINGERPRINT \\\n -d '{\"client_secret\":\"client_secret\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/authorizations/clients/CLIENT_ID/FINGERPRINT \\\n  -d '{\"client_secret\":\"client_secret\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/authorizations/clients/CLIENT_ID/FINGERPRINT \\\n -d '{\"client_secret\":\"client_secret\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/authorizations/clients/CLIENT_ID/FINGERPRINT \\\n  -d '{\"client_secret\":\"client_secret\"}'
    " }, { "lang": "JavaScript", @@ -6973,7 +7094,7 @@ { "verb": "get", "requestPath": "/authorizations/{authorization_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "authorization_id", @@ -6989,8 +7110,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/authorizations/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/authorizations/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/authorizations/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/authorizations/42
    " }, { "lang": "JavaScript", @@ -7051,7 +7172,7 @@ { "verb": "patch", "requestPath": "/authorizations/{authorization_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "authorization_id", @@ -7067,8 +7188,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/authorizations/42 \\\n -d '{\"scopes\":[\"scopes\"]}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/authorizations/42 \\\n  -d '{\"scopes\":[\"scopes\"]}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/authorizations/42 \\\n -d '{\"scopes\":[\"scopes\"]}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/authorizations/42 \\\n  -d '{\"scopes\":[\"scopes\"]}'
    " }, { "lang": "JavaScript", @@ -7269,7 +7390,7 @@ { "verb": "delete", "requestPath": "/authorizations/{authorization_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "authorization_id", @@ -7285,8 +7406,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/authorizations/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/authorizations/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/authorizations/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/authorizations/42
    " }, { "lang": "JavaScript", @@ -7322,7 +7443,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -7346,13 +7467,13 @@ { "verb": "get", "requestPath": "/codes_of_conduct", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.scarlet-witch-preview+json\" \\\n https://api.github.com/codes_of_conduct", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.scarlet-witch-preview+json\" \\\n  https://api.github.com/codes_of_conduct
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.scarlet-witch-preview+json\" \\\n http(s)://{hostname}/api/v3/codes_of_conduct", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.scarlet-witch-preview+json\" \\\n  http(s)://{hostname}/api/v3/codes_of_conduct
    " }, { "lang": "JavaScript", @@ -7412,7 +7533,7 @@ { "verb": "get", "requestPath": "/codes_of_conduct/{key}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "key", @@ -7427,8 +7548,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.scarlet-witch-preview+json\" \\\n https://api.github.com/codes_of_conduct/KEY", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.scarlet-witch-preview+json\" \\\n  https://api.github.com/codes_of_conduct/KEY
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.scarlet-witch-preview+json\" \\\n http(s)://{hostname}/api/v3/codes_of_conduct/KEY", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.scarlet-witch-preview+json\" \\\n  http(s)://{hostname}/api/v3/codes_of_conduct/KEY
    " }, { "lang": "JavaScript", @@ -7493,7 +7614,7 @@ { "verb": "post", "requestPath": "/content_references/{content_reference_id}/attachments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "content_reference_id", @@ -7508,8 +7629,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n https://api.github.com/content_references/42/attachments \\\n -d '{\"title\":\"title\",\"body\":\"body\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n  https://api.github.com/content_references/42/attachments \\\n  -d '{\"title\":\"title\",\"body\":\"body\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n http(s)://{hostname}/api/v3/content_references/42/attachments \\\n -d '{\"title\":\"title\",\"body\":\"body\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n  http(s)://{hostname}/api/v3/content_references/42/attachments \\\n  -d '{\"title\":\"title\",\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -7651,13 +7772,13 @@ { "verb": "get", "requestPath": "/emojis", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/emojis", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/emojis
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/emojis", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/emojis
    " }, { "lang": "JavaScript", @@ -7704,13 +7825,13 @@ { "verb": "get", "requestPath": "/enterprise/settings/license", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprise/settings/license", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprise/settings/license
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/enterprise/settings/license", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/enterprise/settings/license
    " }, { "lang": "JavaScript", @@ -7755,7 +7876,7 @@ { "verb": "get", "requestPath": "/enterprise/stats/{type}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "type", @@ -7770,8 +7891,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprise/stats/TYPE", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprise/stats/TYPE
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/enterprise/stats/TYPE", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/enterprise/stats/TYPE
    " }, { "lang": "JavaScript", @@ -7816,7 +7937,7 @@ { "verb": "get", "requestPath": "/events", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -7842,8 +7963,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/events", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/events
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/events", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/events
    " }, { "lang": "JavaScript", @@ -7902,13 +8023,13 @@ { "verb": "get", "requestPath": "/feeds", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/feeds", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/feeds
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/feeds", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/feeds
    " }, { "lang": "JavaScript", @@ -7953,7 +8074,7 @@ { "verb": "get", "requestPath": "/gists", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "since", @@ -7989,8 +8110,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists
    " }, { "lang": "JavaScript", @@ -8043,13 +8164,13 @@ { "verb": "post", "requestPath": "/gists", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists \\\n -d '{\"files\":{}}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists \\\n  -d '{\"files\":{}}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists \\\n -d '{\"files\":{}}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists \\\n  -d '{\"files\":{}}'
    " }, { "lang": "JavaScript", @@ -8247,7 +8368,7 @@ { "verb": "get", "requestPath": "/gists/public", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "since", @@ -8283,8 +8404,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/public", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/public
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/public", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/public
    " }, { "lang": "JavaScript", @@ -8342,7 +8463,7 @@ { "verb": "get", "requestPath": "/gists/starred", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "since", @@ -8378,8 +8499,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/starred", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/starred
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/starred", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/starred
    " }, { "lang": "JavaScript", @@ -8437,7 +8558,7 @@ { "verb": "get", "requestPath": "/gists/{gist_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -8453,8 +8574,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID
    " }, { "lang": "JavaScript", @@ -8512,7 +8633,7 @@ { "verb": "patch", "requestPath": "/gists/{gist_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -8528,8 +8649,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID \\\n -d '{\"description\":\"description\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID \\\n  -d '{\"description\":\"description\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID \\\n -d '{\"description\":\"description\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID \\\n  -d '{\"description\":\"description\"}'
    " }, { "lang": "JavaScript", @@ -8719,7 +8840,7 @@ { "verb": "delete", "requestPath": "/gists/{gist_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -8735,8 +8856,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID
    " }, { "lang": "JavaScript", @@ -8769,7 +8890,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -8793,7 +8914,7 @@ { "verb": "get", "requestPath": "/gists/{gist_id}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -8829,8 +8950,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/comments", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/comments
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID/comments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID/comments
    " }, { "lang": "JavaScript", @@ -8890,7 +9011,7 @@ { "verb": "post", "requestPath": "/gists/{gist_id}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -8906,8 +9027,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/comments \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/comments \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID/comments \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID/comments \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -9004,7 +9125,7 @@ { "verb": "get", "requestPath": "/gists/{gist_id}/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -9030,8 +9151,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/comments/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/comments/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID/comments/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID/comments/42
    " }, { "lang": "JavaScript", @@ -9091,7 +9212,7 @@ { "verb": "patch", "requestPath": "/gists/{gist_id}/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -9117,8 +9238,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/comments/42 \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/comments/42 \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID/comments/42 \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID/comments/42 \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -9205,7 +9326,7 @@ { "verb": "delete", "requestPath": "/gists/{gist_id}/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -9231,8 +9352,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/comments/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/comments/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID/comments/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID/comments/42
    " }, { "lang": "JavaScript", @@ -9267,7 +9388,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -9291,7 +9412,7 @@ { "verb": "get", "requestPath": "/gists/{gist_id}/commits", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -9327,8 +9448,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/commits", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/commits
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID/commits", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID/commits
    " }, { "lang": "JavaScript", @@ -9386,7 +9507,7 @@ { "verb": "get", "requestPath": "/gists/{gist_id}/forks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -9422,8 +9543,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/forks", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/forks
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID/forks", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID/forks
    " }, { "lang": "JavaScript", @@ -9481,7 +9602,7 @@ { "verb": "post", "requestPath": "/gists/{gist_id}/forks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -9497,8 +9618,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/forks", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/forks
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID/forks", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID/forks
    " }, { "lang": "JavaScript", @@ -9561,7 +9682,7 @@ { "verb": "get", "requestPath": "/gists/{gist_id}/star", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -9577,8 +9698,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/star", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/star
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID/star", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID/star
    " }, { "lang": "JavaScript", @@ -9635,7 +9756,7 @@ { "verb": "put", "requestPath": "/gists/{gist_id}/star", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -9651,8 +9772,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/star", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/star
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID/star", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID/star
    " }, { "lang": "JavaScript", @@ -9685,7 +9806,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -9709,7 +9830,7 @@ { "verb": "delete", "requestPath": "/gists/{gist_id}/star", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -9725,8 +9846,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/star", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/star
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID/star", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID/star
    " }, { "lang": "JavaScript", @@ -9759,7 +9880,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -9783,7 +9904,7 @@ { "verb": "get", "requestPath": "/gists/{gist_id}/{sha}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -9808,8 +9929,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/SHA", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/SHA
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID/SHA", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID/SHA
    " }, { "lang": "JavaScript", @@ -9867,13 +9988,13 @@ { "verb": "get", "requestPath": "/gitignore/templates", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gitignore/templates", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gitignore/templates
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gitignore/templates", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gitignore/templates
    " }, { "lang": "JavaScript", @@ -9921,7 +10042,7 @@ { "verb": "get", "requestPath": "/gitignore/templates/{name}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "name", @@ -9936,8 +10057,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gitignore/templates/NAME", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gitignore/templates/NAME
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gitignore/templates/NAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gitignore/templates/NAME
    " }, { "lang": "JavaScript", @@ -9985,7 +10106,7 @@ { "verb": "get", "requestPath": "/installation/repositories", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -10022,8 +10143,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/installation/repositories", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  https://api.github.com/installation/repositories
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n http(s)://{hostname}/api/v3/installation/repositories", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  http(s)://{hostname}/api/v3/installation/repositories
    " }, { "lang": "JavaScript", @@ -10096,7 +10217,7 @@ { "verb": "get", "requestPath": "/issues", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "filter", @@ -10110,6 +10231,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -10243,8 +10365,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/issues", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/issues
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/issues", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/issues
    " }, { "lang": "JavaScript", @@ -10308,7 +10430,7 @@ { "verb": "get", "requestPath": "/licenses", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "featured", @@ -10328,13 +10450,23 @@ "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/licenses", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/licenses
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/licenses", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/licenses
    " }, { "lang": "JavaScript", @@ -10382,7 +10514,7 @@ { "verb": "get", "requestPath": "/licenses/{license}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "license", @@ -10397,8 +10529,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/licenses/LICENSE", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/licenses/LICENSE
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/licenses/LICENSE", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/licenses/LICENSE
    " }, { "lang": "JavaScript", @@ -10456,13 +10588,13 @@ { "verb": "post", "requestPath": "/markdown", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/markdown \\\n -d '{\"text\":\"text\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/markdown \\\n  -d '{\"text\":\"text\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/markdown \\\n -d '{\"text\":\"text\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/markdown \\\n  -d '{\"text\":\"text\"}'
    " }, { "lang": "JavaScript", @@ -10590,13 +10722,13 @@ { "verb": "post", "requestPath": "/markdown/raw", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/markdown/raw", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/markdown/raw
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/markdown/raw", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/markdown/raw
    " }, { "lang": "JavaScript", @@ -10657,13 +10789,13 @@ { "verb": "get", "requestPath": "/meta", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/meta", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/meta
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/meta", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/meta
    " }, { "lang": "JavaScript", @@ -10711,7 +10843,7 @@ { "verb": "get", "requestPath": "/networks/{owner}/{repo}/events", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -10755,8 +10887,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/networks/octocat/hello-world/events", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/networks/octocat/hello-world/events
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/networks/octocat/hello-world/events", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/networks/octocat/hello-world/events
    " }, { "lang": "JavaScript", @@ -10820,7 +10952,7 @@ { "verb": "get", "requestPath": "/notifications", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "all", @@ -10888,8 +11020,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/notifications", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/notifications
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/notifications", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/notifications
    " }, { "lang": "JavaScript", @@ -10954,13 +11086,13 @@ { "verb": "put", "requestPath": "/notifications", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/notifications \\\n -d '{\"last_read_at\":\"last_read_at\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/notifications \\\n  -d '{\"last_read_at\":\"last_read_at\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/notifications \\\n -d '{\"last_read_at\":\"last_read_at\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/notifications \\\n  -d '{\"last_read_at\":\"last_read_at\"}'
    " }, { "lang": "JavaScript", @@ -11074,7 +11206,7 @@ { "verb": "get", "requestPath": "/notifications/threads/{thread_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "thread_id", @@ -11090,8 +11222,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/notifications/threads/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/notifications/threads/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/notifications/threads/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/notifications/threads/42
    " }, { "lang": "JavaScript", @@ -11151,7 +11283,7 @@ { "verb": "patch", "requestPath": "/notifications/threads/{thread_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "thread_id", @@ -11167,8 +11299,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/notifications/threads/42", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/notifications/threads/42
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/notifications/threads/42", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/notifications/threads/42
    " }, { "lang": "JavaScript", @@ -11222,7 +11354,7 @@ { "verb": "get", "requestPath": "/notifications/threads/{thread_id}/subscription", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "thread_id", @@ -11238,8 +11370,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/notifications/threads/42/subscription", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/notifications/threads/42/subscription
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/notifications/threads/42/subscription", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/notifications/threads/42/subscription
    " }, { "lang": "JavaScript", @@ -11299,7 +11431,7 @@ { "verb": "put", "requestPath": "/notifications/threads/{thread_id}/subscription", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "thread_id", @@ -11315,8 +11447,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/notifications/threads/42/subscription \\\n -d '{\"ignored\":true}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/notifications/threads/42/subscription \\\n  -d '{\"ignored\":true}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/notifications/threads/42/subscription \\\n -d '{\"ignored\":true}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/notifications/threads/42/subscription \\\n  -d '{\"ignored\":true}'
    " }, { "lang": "JavaScript", @@ -11408,7 +11540,7 @@ { "verb": "delete", "requestPath": "/notifications/threads/{thread_id}/subscription", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "thread_id", @@ -11424,8 +11556,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/notifications/threads/42/subscription", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/notifications/threads/42/subscription
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/notifications/threads/42/subscription", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/notifications/threads/42/subscription
    " }, { "lang": "JavaScript", @@ -11460,7 +11592,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -11484,7 +11616,7 @@ { "verb": "get", "requestPath": "/octocat", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "s", @@ -11500,8 +11632,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/octocat", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/octocat
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/octocat", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/octocat
    " }, { "lang": "JavaScript", @@ -11538,7 +11670,7 @@ { "verb": "get", "requestPath": "/organizations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "since", @@ -11564,8 +11696,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/organizations", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/organizations
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/organizations", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/organizations
    " }, { "lang": "JavaScript", @@ -11613,7 +11745,7 @@ { "verb": "get", "requestPath": "/orgs/{org}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -11628,8 +11760,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG
    " }, { "lang": "JavaScript", @@ -11672,13 +11804,7 @@ "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "
    {\n  \"login\": \"github\",\n  \"id\": 1,\n  \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n  \"url\": \"https://api.github.com/orgs/github\",\n  \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n  \"events_url\": \"https://api.github.com/orgs/github/events\",\n  \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n  \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n  \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n  \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n  \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n  \"description\": \"A great organization\",\n  \"name\": \"github\",\n  \"company\": \"GitHub\",\n  \"blog\": \"https://github.com/blog\",\n  \"location\": \"San Francisco\",\n  \"email\": \"octocat@github.com\",\n  \"twitter_username\": \"github\",\n  \"is_verified\": true,\n  \"has_organization_projects\": true,\n  \"has_repository_projects\": true,\n  \"public_repos\": 2,\n  \"public_gists\": 1,\n  \"followers\": 20,\n  \"following\": 0,\n  \"html_url\": \"https://github.com/octocat\",\n  \"created_at\": \"2008-01-14T04:33:35Z\",\n  \"updated_at\": \"2014-03-03T18:58:10Z\",\n  \"type\": \"Organization\",\n  \"total_private_repos\": 100,\n  \"owned_private_repos\": 100,\n  \"private_gists\": 81,\n  \"disk_usage\": 10000,\n  \"collaborators\": 8,\n  \"billing_email\": \"mona@github.com\",\n  \"plan\": {\n    \"name\": \"Medium\",\n    \"space\": 400,\n    \"private_repos\": 20\n  },\n  \"default_repository_permission\": \"read\",\n  \"members_can_create_repositories\": true,\n  \"two_factor_requirement_enabled\": true,\n  \"members_allowed_repository_creation_type\": \"all\",\n  \"members_can_create_public_repositories\": false,\n  \"members_can_create_private_repositories\": false,\n  \"members_can_create_internal_repositories\": false,\n  \"members_can_create_pages\": true\n}\n
    " - }, - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response with GitHub plan information", - "payload": "
    {\n  \"login\": \"github\",\n  \"id\": 1,\n  \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n  \"url\": \"https://api.github.com/orgs/github\",\n  \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n  \"events_url\": \"https://api.github.com/orgs/github/events\",\n  \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n  \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n  \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n  \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n  \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n  \"description\": \"A great organization\",\n  \"name\": \"github\",\n  \"company\": \"GitHub\",\n  \"blog\": \"https://github.com/blog\",\n  \"location\": \"San Francisco\",\n  \"email\": \"octocat@github.com\",\n  \"twitter_username\": \"github\",\n  \"is_verified\": true,\n  \"has_organization_projects\": true,\n  \"has_repository_projects\": true,\n  \"public_repos\": 2,\n  \"public_gists\": 1,\n  \"followers\": 20,\n  \"following\": 0,\n  \"html_url\": \"https://github.com/octocat\",\n  \"created_at\": \"2008-01-14T04:33:35Z\",\n  \"updated_at\": \"2014-03-03T18:58:10Z\",\n  \"type\": \"Organization\",\n  \"plan\": {\n    \"name\": \"team\",\n    \"space\": 976562499,\n    \"private_repos\": 999999,\n    \"filled_seats\": 4,\n    \"seats\": 5\n  }\n}\n
    " + "payload": "
    {\n  \"login\": \"github\",\n  \"id\": 1,\n  \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n  \"url\": \"https://api.github.com/orgs/github\",\n  \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n  \"events_url\": \"https://api.github.com/orgs/github/events\",\n  \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n  \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n  \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n  \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n  \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n  \"description\": \"A great organization\",\n  \"name\": \"github\",\n  \"company\": \"GitHub\",\n  \"blog\": \"https://github.com/blog\",\n  \"location\": \"San Francisco\",\n  \"email\": \"octocat@github.com\",\n  \"twitter_username\": \"github\",\n  \"is_verified\": true,\n  \"has_organization_projects\": true,\n  \"has_repository_projects\": true,\n  \"public_repos\": 2,\n  \"public_gists\": 1,\n  \"followers\": 20,\n  \"following\": 0,\n  \"html_url\": \"https://github.com/octocat\",\n  \"created_at\": \"2008-01-14T04:33:35Z\",\n  \"updated_at\": \"2014-03-03T18:58:10Z\",\n  \"type\": \"Organization\",\n  \"total_private_repos\": 100,\n  \"owned_private_repos\": 100,\n  \"private_gists\": 81,\n  \"disk_usage\": 10000,\n  \"collaborators\": 8,\n  \"billing_email\": \"mona@github.com\",\n  \"plan\": {\n    \"name\": \"Medium\",\n    \"space\": 400,\n    \"private_repos\": 20,\n    \"filled_seats\": 4,\n    \"seats\": 5\n  },\n  \"default_repository_permission\": \"read\",\n  \"members_can_create_repositories\": true,\n  \"two_factor_requirement_enabled\": true,\n  \"members_allowed_repository_creation_type\": \"all\",\n  \"members_can_create_public_repositories\": false,\n  \"members_can_create_private_repositories\": false,\n  \"members_can_create_internal_repositories\": false,\n  \"members_can_create_pages\": true\n}\n
    " }, { "httpStatusCode": "404", @@ -11690,7 +11816,7 @@ { "verb": "patch", "requestPath": "/orgs/{org}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -11705,8 +11831,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG \\\n -d '{\"billing_email\":\"billing_email\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG \\\n  -d '{\"billing_email\":\"billing_email\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG \\\n -d '{\"billing_email\":\"billing_email\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG \\\n  -d '{\"billing_email\":\"billing_email\"}'
    " }, { "lang": "JavaScript", @@ -12109,7 +12235,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/events", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -12144,8 +12270,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/events", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/events
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/events", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/events
    " }, { "lang": "JavaScript", @@ -12189,7 +12315,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/hooks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -12224,8 +12350,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/hooks", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/hooks
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/hooks", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/hooks
    " }, { "lang": "JavaScript", @@ -12275,7 +12401,7 @@ { "verb": "post", "requestPath": "/orgs/{org}/hooks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -12290,8 +12416,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/hooks \\\n -d '{\"name\":\"name\",\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"username\":\"username\",\"password\":\"password\"}}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/hooks \\\n  -d '{\"name\":\"name\",\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"username\":\"username\",\"password\":\"password\"}}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/hooks \\\n -d '{\"name\":\"name\",\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"username\":\"username\",\"password\":\"password\"}}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/hooks \\\n  -d '{\"name\":\"name\",\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"username\":\"username\",\"password\":\"password\"}}'
    " }, { "lang": "JavaScript", @@ -12722,7 +12848,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/hooks/{hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -12746,8 +12872,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/hooks/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/hooks/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/hooks/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/hooks/42
    " }, { "lang": "JavaScript", @@ -12797,7 +12923,7 @@ { "verb": "patch", "requestPath": "/orgs/{org}/hooks/{hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -12821,8 +12947,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/hooks/42 \\\n -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/hooks/42 \\\n  -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/hooks/42 \\\n -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/hooks/42 \\\n  -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'
    " }, { "lang": "JavaScript", @@ -13171,7 +13297,7 @@ { "verb": "delete", "requestPath": "/orgs/{org}/hooks/{hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -13195,8 +13321,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/hooks/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/hooks/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/hooks/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/hooks/42
    " }, { "lang": "JavaScript", @@ -13231,7 +13357,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -13245,7 +13371,7 @@ { "verb": "post", "requestPath": "/orgs/{org}/hooks/{hook_id}/pings", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -13269,8 +13395,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/hooks/42/pings", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/hooks/42/pings
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/hooks/42/pings", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/hooks/42/pings
    " }, { "lang": "JavaScript", @@ -13305,7 +13431,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -13319,7 +13445,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/installation", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -13345,8 +13471,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/orgs/ORG/installation", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  https://api.github.com/orgs/ORG/installation
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/installation", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/installation
    " }, { "lang": "JavaScript", @@ -13395,7 +13521,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/issues", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -13418,6 +13544,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -13515,8 +13642,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/issues", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/issues
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/issues", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/issues
    " }, { "lang": "JavaScript", @@ -13570,7 +13697,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/members", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -13636,8 +13763,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/members", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/members
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/members", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/members
    " }, { "lang": "JavaScript", @@ -13692,7 +13819,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/members/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -13716,8 +13843,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/members/USERNAME", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/members/USERNAME
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/members/USERNAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/members/USERNAME
    " }, { "lang": "JavaScript", @@ -13771,7 +13898,7 @@ { "verb": "delete", "requestPath": "/orgs/{org}/members/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -13795,8 +13922,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/members/USERNAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/members/USERNAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/members/USERNAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/members/USERNAME
    " }, { "lang": "JavaScript", @@ -13831,7 +13958,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -13845,7 +13972,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/memberships/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -13869,8 +13996,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/memberships/USERNAME", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/memberships/USERNAME
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/memberships/USERNAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/memberships/USERNAME
    " }, { "lang": "JavaScript", @@ -13879,7 +14006,7 @@ } ], "summary": "Get organization membership for a user", - "description": "In order to get a user's membership with an organization, the authenticated user must be an organization member.", + "description": "In order to get a user's membership with an organization, the authenticated user must be an organization member. The `state` parameter in the response can be used to identify the user's membership status.", "tags": [ "orgs" ], @@ -13902,7 +14029,7 @@ "subcategoryLabel": "Members", "notes": [], "bodyParameters": [], - "descriptionHTML": "

    In order to get a user's membership with an organization, the authenticated user must be an organization member.

    ", + "descriptionHTML": "

    In order to get a user's membership with an organization, the authenticated user must be an organization member. The state parameter in the response can be used to identify the user's membership status.

    ", "responses": [ { "httpStatusCode": "200", @@ -13910,18 +14037,6 @@ "description": "Response if user has an active admin membership with organization", "payload": "
    {\n  \"url\": \"https://api.github.com/orgs/octocat/memberships/defunkt\",\n  \"state\": \"active\",\n  \"role\": \"admin\",\n  \"organization_url\": \"https://api.github.com/orgs/octocat\",\n  \"organization\": {\n    \"login\": \"github\",\n    \"id\": 1,\n    \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n    \"url\": \"https://api.github.com/orgs/github\",\n    \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n    \"events_url\": \"https://api.github.com/orgs/github/events\",\n    \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n    \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n    \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n    \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"description\": \"A great organization\"\n  },\n  \"user\": {\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
    " }, - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response if user has an active membership with organization", - "payload": "
    {\n  \"url\": \"https://api.github.com/orgs/octocat/memberships/defunkt\",\n  \"state\": \"active\",\n  \"role\": \"member\",\n  \"organization_url\": \"https://api.github.com/orgs/octocat\",\n  \"organization\": {\n    \"login\": \"github\",\n    \"id\": 1,\n    \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n    \"url\": \"https://api.github.com/orgs/github\",\n    \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n    \"events_url\": \"https://api.github.com/orgs/github/events\",\n    \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n    \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n    \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n    \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"description\": \"A great organization\"\n  },\n  \"user\": {\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
    " - }, - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response if user has a pending membership with organization", - "payload": "
    {\n  \"url\": \"https://api.github.com/orgs/invitocat/memberships/defunkt\",\n  \"state\": \"pending\",\n  \"role\": \"member\",\n  \"organization_url\": \"https://api.github.com/orgs/invitocat\",\n  \"organization\": {\n    \"login\": \"github\",\n    \"id\": 1,\n    \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n    \"url\": \"https://api.github.com/orgs/github\",\n    \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n    \"events_url\": \"https://api.github.com/orgs/github/events\",\n    \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n    \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n    \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n    \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"description\": \"A great organization\"\n  },\n  \"user\": {\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
    " - }, { "httpStatusCode": "403", "httpStatusMessage": "Forbidden", @@ -13937,7 +14052,7 @@ { "verb": "put", "requestPath": "/orgs/{org}/memberships/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -13961,8 +14076,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/memberships/USERNAME \\\n -d '{\"role\":\"role\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/memberships/USERNAME \\\n  -d '{\"role\":\"role\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/memberships/USERNAME \\\n -d '{\"role\":\"role\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/memberships/USERNAME \\\n  -d '{\"role\":\"role\"}'
    " }, { "lang": "JavaScript", @@ -14039,13 +14154,7 @@ { "httpStatusCode": "200", "httpStatusMessage": "OK", - "description": "Response if user was previously unaffiliated with organization", - "payload": "
    {\n  \"url\": \"https://api.github.com/orgs/invitocat/memberships/defunkt\",\n  \"state\": \"pending\",\n  \"role\": \"admin\",\n  \"organization_url\": \"https://api.github.com/orgs/invitocat\",\n  \"organization\": {\n    \"login\": \"github\",\n    \"id\": 1,\n    \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n    \"url\": \"https://api.github.com/orgs/github\",\n    \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n    \"events_url\": \"https://api.github.com/orgs/github/events\",\n    \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n    \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n    \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n    \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"description\": \"A great organization\"\n  },\n  \"user\": {\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
    " - }, - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response if user already had membership with organization", + "description": "Response if user has an active admin membership with organization", "payload": "
    {\n  \"url\": \"https://api.github.com/orgs/octocat/memberships/defunkt\",\n  \"state\": \"active\",\n  \"role\": \"admin\",\n  \"organization_url\": \"https://api.github.com/orgs/octocat\",\n  \"organization\": {\n    \"login\": \"github\",\n    \"id\": 1,\n    \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n    \"url\": \"https://api.github.com/orgs/github\",\n    \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n    \"events_url\": \"https://api.github.com/orgs/github/events\",\n    \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n    \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n    \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n    \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"description\": \"A great organization\"\n  },\n  \"user\": {\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
    " }, { @@ -14063,7 +14172,7 @@ { "verb": "delete", "requestPath": "/orgs/{org}/memberships/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -14087,8 +14196,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/memberships/USERNAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/memberships/USERNAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/memberships/USERNAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/memberships/USERNAME
    " }, { "lang": "JavaScript", @@ -14123,7 +14232,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -14142,7 +14251,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/outside_collaborators", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -14192,8 +14301,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/outside_collaborators", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/outside_collaborators
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/outside_collaborators", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/outside_collaborators
    " }, { "lang": "JavaScript", @@ -14238,7 +14347,7 @@ { "verb": "put", "requestPath": "/orgs/{org}/outside_collaborators/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -14262,8 +14371,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/outside_collaborators/USERNAME", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/outside_collaborators/USERNAME
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/outside_collaborators/USERNAME", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/outside_collaborators/USERNAME
    " }, { "lang": "JavaScript", @@ -14294,8 +14403,6 @@ "subcategory": "outside-collaborators", "subcategoryLabel": "Outside collaborators", "notes": [], - "bodyParameters": [], - "descriptionHTML": "

    When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"Converting an organization member to an outside collaborator\".

    ", "responses": [ { "httpStatusCode": "202", @@ -14310,26 +14417,21 @@ { "httpStatusCode": "403", "httpStatusMessage": "Forbidden", - "description": "Response if user is the last owner of the organization", - "payload": "
    {\n  \"message\": \"Cannot convert the last owner to an outside collaborator\",\n  \"documentation_url\": \"https://docs.github.com/enterprise-server@2.18/rest/reference/orgs#convert-member-to-outside-collaborator\"\n}\n
    " - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Response if user is not a member of the organization", - "payload": "
    {\n  \"message\": \"<user> is not a member of the <organization> organization.\",\n  \"documentation_url\": \"https://docs.github.com/enterprise-server@2.18/rest/reference/orgs#convert-member-to-outside-collaborator\"\n}\n
    " + "description": "Response if user is the last owner of the organization or not a member of the organization" }, { "httpStatusCode": "404", "httpStatusMessage": "Not Found", "description": "Resource not found" } - ] + ], + "bodyParameters": [], + "descriptionHTML": "

    When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"Converting an organization member to an outside collaborator\".

    " }, { "verb": "delete", "requestPath": "/orgs/{org}/outside_collaborators/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -14353,8 +14455,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/outside_collaborators/USERNAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/outside_collaborators/USERNAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/outside_collaborators/USERNAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/outside_collaborators/USERNAME
    " }, { "lang": "JavaScript", @@ -14391,7 +14493,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "422", @@ -14404,7 +14506,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/pre-receive-hooks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -14434,13 +14536,44 @@ "default": 1 }, "descriptionHTML": "

    Page number of the results to fetch.

    " + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + }, + "descriptionHTML": "

    One of asc (ascending) or desc (descending).

    " + }, + { + "name": "sort", + "description": "The sort order for the response collection.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + }, + "descriptionHTML": "

    The sort order for the response collection.

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/orgs/ORG/pre-receive-hooks", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/orgs/ORG/pre-receive-hooks
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/pre-receive-hooks", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/pre-receive-hooks
    " }, { "lang": "JavaScript", @@ -14492,7 +14625,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -14516,8 +14649,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/orgs/ORG/pre-receive-hooks/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/orgs/ORG/pre-receive-hooks/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/pre-receive-hooks/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/pre-receive-hooks/42
    " }, { "lang": "JavaScript", @@ -14569,7 +14702,7 @@ { "verb": "patch", "requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -14593,8 +14726,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/orgs/ORG/pre-receive-hooks/42 \\\n -d '{\"enforcement\":\"enforcement\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/orgs/ORG/pre-receive-hooks/42 \\\n  -d '{\"enforcement\":\"enforcement\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/pre-receive-hooks/42 \\\n -d '{\"enforcement\":\"enforcement\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/pre-receive-hooks/42 \\\n  -d '{\"enforcement\":\"enforcement\"}'
    " }, { "lang": "JavaScript", @@ -14698,7 +14831,7 @@ { "verb": "delete", "requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -14722,8 +14855,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/orgs/ORG/pre-receive-hooks/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/orgs/ORG/pre-receive-hooks/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/pre-receive-hooks/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/pre-receive-hooks/42
    " }, { "lang": "JavaScript", @@ -14775,7 +14908,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/projects", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -14826,8 +14959,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/orgs/ORG/projects", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/orgs/ORG/projects
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/projects", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/projects
    " }, { "lang": "JavaScript", @@ -14882,7 +15015,7 @@ { "verb": "post", "requestPath": "/orgs/{org}/projects", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -14897,8 +15030,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/orgs/ORG/projects \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/orgs/ORG/projects \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/projects \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/projects \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -15028,7 +15161,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/public_members", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -15063,8 +15196,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/public_members", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/public_members
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/public_members", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/public_members
    " }, { "lang": "JavaScript", @@ -15109,7 +15242,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/public_members/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -15133,8 +15266,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/public_members/USERNAME", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/public_members/USERNAME
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/public_members/USERNAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/public_members/USERNAME
    " }, { "lang": "JavaScript", @@ -15183,7 +15316,7 @@ { "verb": "put", "requestPath": "/orgs/{org}/public_members/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -15207,8 +15340,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/public_members/USERNAME", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/public_members/USERNAME
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/public_members/USERNAME", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/public_members/USERNAME
    " }, { "lang": "JavaScript", @@ -15243,7 +15376,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -15257,7 +15390,7 @@ { "verb": "delete", "requestPath": "/orgs/{org}/public_members/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -15281,8 +15414,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/public_members/USERNAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/public_members/USERNAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/public_members/USERNAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/public_members/USERNAME
    " }, { "lang": "JavaScript", @@ -15317,7 +15450,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -15326,7 +15459,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/repos", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -15339,7 +15472,7 @@ }, { "name": "type", - "description": "Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`.", + "description": "Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Note: For GitHub AE, can be one of `all`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`.", "in": "query", "required": false, "schema": { @@ -15354,7 +15487,7 @@ "internal" ] }, - "descriptionHTML": "

    Specifies the types of repositories you want returned. Can be one of all, public, private, forks, sources, member, internal. Default: all. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, type can also be internal.

    " + "descriptionHTML": "

    Specifies the types of repositories you want returned. Can be one of all, public, private, forks, sources, member, internal. Note: For GitHub AE, can be one of all, private, forks, sources, member, internal. Default: all. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, type can also be internal.

    " }, { "name": "sort", @@ -15411,8 +15544,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/repos", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/repos
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/repos", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/repos
    " }, { "lang": "JavaScript", @@ -15468,7 +15601,7 @@ { "verb": "post", "requestPath": "/orgs/{org}/repos", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -15483,8 +15616,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/repos \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/repos \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/repos \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/repos \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -15493,7 +15626,7 @@ } ], "summary": "Create an organization repository", - "description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", + "description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository", "tags": [ "repos" ], @@ -15537,17 +15670,17 @@ }, "private": { "type": "boolean", - "description": "

    Either true to create a private repository or false to create a public one.

    ", + "description": "

    Whether the repository is private.

    ", "default": false, "name": "private", "in": "body", "rawType": "boolean", - "rawDescription": "Either `true` to create a private repository or `false` to create a public one.", + "rawDescription": "Whether the repository is private.", "childParamsGroups": [] }, "visibility": { "type": "string", - "description": "

    Can be public or private. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be internal. For more information, see \"Creating an internal repository\" in the GitHub Help documentation.
    \nThe visibility parameter overrides the private parameter when you use both parameters with the nebula-preview preview header.

    ", + "description": "

    Can be public or private. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be internal. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"Creating an internal repository\" in the GitHub Help documentation.
    \nThe visibility parameter overrides the private parameter when you use both parameters with the nebula-preview preview header.

    ", "enum": [ "public", "private", @@ -15557,7 +15690,7 @@ "name": "visibility", "in": "body", "rawType": "string", - "rawDescription": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", + "rawDescription": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", "childParamsGroups": [] }, "has_issues": { @@ -15718,7 +15851,7 @@ "category": "repos", "categoryLabel": "Repos", "notes": [], - "descriptionHTML": "

    Creates a new repository in the specified organization. The authenticated user must be a member of the organization.

    \n

    OAuth scope requirements

    \n

    When using OAuth, authorizations must include:

    \n
      \n
    • public_repo scope or repo scope to create a public repository
    • \n
    • repo scope to create a private repository
    • \n
    ", + "descriptionHTML": "

    Creates a new repository in the specified organization. The authenticated user must be a member of the organization.

    \n

    OAuth scope requirements

    \n

    When using OAuth, authorizations must include:

    \n
      \n
    • public_repo scope or repo scope to create a public repository. Note: For GitHub AE, use repo scope to create an internal repository.
    • \n
    • repo scope to create a private repository
    • \n
    ", "bodyParameters": [ { "type": "string", @@ -15749,17 +15882,17 @@ }, { "type": "boolean", - "description": "

    Either true to create a private repository or false to create a public one.

    ", + "description": "

    Whether the repository is private.

    ", "default": false, "name": "private", "in": "body", "rawType": "boolean", - "rawDescription": "Either `true` to create a private repository or `false` to create a public one.", + "rawDescription": "Whether the repository is private.", "childParamsGroups": [] }, { "type": "string", - "description": "

    Can be public or private. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be internal. For more information, see \"Creating an internal repository\" in the GitHub Help documentation.
    \nThe visibility parameter overrides the private parameter when you use both parameters with the nebula-preview preview header.

    ", + "description": "

    Can be public or private. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be internal. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"Creating an internal repository\" in the GitHub Help documentation.
    \nThe visibility parameter overrides the private parameter when you use both parameters with the nebula-preview preview header.

    ", "enum": [ "public", "private", @@ -15769,7 +15902,7 @@ "name": "visibility", "in": "body", "rawType": "string", - "rawDescription": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", + "rawDescription": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", "childParamsGroups": [] }, { @@ -15912,7 +16045,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/teams", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -15947,8 +16080,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams
    " }, { "lang": "JavaScript", @@ -15996,7 +16129,7 @@ { "verb": "post", "requestPath": "/orgs/{org}/teams", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -16011,8 +16144,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -16244,7 +16377,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -16269,8 +16402,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG
    " }, { "lang": "JavaScript", @@ -16318,7 +16451,7 @@ { "verb": "get", "requestPath": "/projects/columns/cards/{card_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "card_id", @@ -16334,8 +16467,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/cards/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/cards/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/columns/cards/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/columns/cards/42
    " }, { "lang": "JavaScript", @@ -16407,7 +16540,7 @@ { "verb": "patch", "requestPath": "/projects/columns/cards/{card_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "card_id", @@ -16423,8 +16556,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/cards/42 \\\n -d '{\"note\":\"note\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/cards/42 \\\n  -d '{\"note\":\"note\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/columns/cards/42 \\\n -d '{\"note\":\"note\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/columns/cards/42 \\\n  -d '{\"note\":\"note\"}'
    " }, { "lang": "JavaScript", @@ -16555,7 +16688,7 @@ { "verb": "delete", "requestPath": "/projects/columns/cards/{card_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "card_id", @@ -16571,8 +16704,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/cards/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/cards/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/columns/cards/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/columns/cards/42
    " }, { "lang": "JavaScript", @@ -16614,7 +16747,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -16643,7 +16776,7 @@ { "verb": "post", "requestPath": "/projects/columns/cards/{card_id}/moves", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "card_id", @@ -16659,8 +16792,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/cards/42/moves \\\n -d '{\"position\":\"position\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/cards/42/moves \\\n  -d '{\"position\":\"position\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/columns/cards/42/moves \\\n -d '{\"position\":\"position\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/columns/cards/42/moves \\\n  -d '{\"position\":\"position\"}'
    " }, { "lang": "JavaScript", @@ -16793,7 +16926,7 @@ { "verb": "get", "requestPath": "/projects/columns/{column_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "column_id", @@ -16809,8 +16942,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/columns/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/columns/42
    " }, { "lang": "JavaScript", @@ -16882,7 +17015,7 @@ { "verb": "patch", "requestPath": "/projects/columns/{column_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "column_id", @@ -16898,8 +17031,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/42 \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/42 \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/columns/42 \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/columns/42 \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -17001,7 +17134,7 @@ { "verb": "delete", "requestPath": "/projects/columns/{column_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "column_id", @@ -17017,8 +17150,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/columns/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/columns/42
    " }, { "lang": "JavaScript", @@ -17060,7 +17193,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -17084,7 +17217,7 @@ { "verb": "get", "requestPath": "/projects/columns/{column_id}/cards", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "column_id", @@ -17136,8 +17269,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/42/cards", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/42/cards
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/columns/42/cards", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/columns/42/cards
    " }, { "lang": "JavaScript", @@ -17204,7 +17337,7 @@ { "verb": "post", "requestPath": "/projects/columns/{column_id}/cards", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "column_id", @@ -17220,8 +17353,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/42/cards \\\n -d '{\"note\":\"note\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/42/cards \\\n  -d '{\"note\":\"note\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/columns/42/cards \\\n -d '{\"note\":\"note\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/columns/42/cards \\\n  -d '{\"note\":\"note\"}'
    " }, { "lang": "JavaScript", @@ -17341,7 +17474,7 @@ { "verb": "post", "requestPath": "/projects/columns/{column_id}/moves", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "column_id", @@ -17357,8 +17490,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/42/moves \\\n -d '{\"position\":\"position\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/42/moves \\\n  -d '{\"position\":\"position\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/columns/42/moves \\\n -d '{\"position\":\"position\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/columns/42/moves \\\n  -d '{\"position\":\"position\"}'
    " }, { "lang": "JavaScript", @@ -17466,7 +17599,7 @@ { "verb": "get", "requestPath": "/projects/{project_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "project_id", @@ -17481,8 +17614,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/42
    " }, { "lang": "JavaScript", @@ -17547,7 +17680,7 @@ { "verb": "patch", "requestPath": "/projects/{project_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "project_id", @@ -17562,8 +17695,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42 \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/42 \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/42 \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/42 \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -17765,7 +17898,7 @@ { "verb": "delete", "requestPath": "/projects/{project_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "project_id", @@ -17780,8 +17913,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/42
    " }, { "lang": "JavaScript", @@ -17855,7 +17988,7 @@ { "verb": "get", "requestPath": "/projects/{project_id}/collaborators", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "project_id", @@ -17906,8 +18039,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42/collaborators", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/42/collaborators
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/42/collaborators", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/42/collaborators
    " }, { "lang": "JavaScript", @@ -17989,7 +18122,7 @@ { "verb": "put", "requestPath": "/projects/{project_id}/collaborators/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "project_id", @@ -18013,8 +18146,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42/collaborators/USERNAME \\\n -d '{\"permission\":\"permission\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/42/collaborators/USERNAME \\\n  -d '{\"permission\":\"permission\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/42/collaborators/USERNAME \\\n -d '{\"permission\":\"permission\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/42/collaborators/USERNAME \\\n  -d '{\"permission\":\"permission\"}'
    " }, { "lang": "JavaScript", @@ -18083,7 +18216,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -18139,7 +18272,7 @@ { "verb": "delete", "requestPath": "/projects/{project_id}/collaborators/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "project_id", @@ -18163,8 +18296,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42/collaborators/USERNAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/42/collaborators/USERNAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/42/collaborators/USERNAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/42/collaborators/USERNAME
    " }, { "lang": "JavaScript", @@ -18206,7 +18339,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -18245,7 +18378,7 @@ { "verb": "get", "requestPath": "/projects/{project_id}/collaborators/{username}/permission", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "project_id", @@ -18269,8 +18402,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42/collaborators/USERNAME/permission", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/42/collaborators/USERNAME/permission
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/42/collaborators/USERNAME/permission", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/42/collaborators/USERNAME/permission
    " }, { "lang": "JavaScript", @@ -18352,7 +18485,7 @@ { "verb": "get", "requestPath": "/projects/{project_id}/columns", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "project_id", @@ -18387,8 +18520,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42/columns", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/42/columns
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/42/columns", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/42/columns
    " }, { "lang": "JavaScript", @@ -18455,7 +18588,7 @@ { "verb": "post", "requestPath": "/projects/{project_id}/columns", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "project_id", @@ -18470,8 +18603,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42/columns \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/42/columns \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/42/columns \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/42/columns \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -18578,13 +18711,13 @@ { "verb": "get", "requestPath": "/rate_limit", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/rate_limit", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/rate_limit
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/rate_limit", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/rate_limit
    " }, { "lang": "JavaScript", @@ -18637,7 +18770,7 @@ { "verb": "delete", "requestPath": "/reactions/{reaction_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -18663,8 +18796,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.echo-preview+json\" \\\n https://api.github.com/reactions/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.echo-preview+json\" \\\n  https://api.github.com/reactions/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.echo-preview+json\" \\\n http(s)://{hostname}/api/v3/reactions/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.echo-preview+json\" \\\n  http(s)://{hostname}/api/v3/reactions/42
    " }, { "lang": "JavaScript", @@ -18710,7 +18843,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -18719,7 +18852,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -18743,8 +18876,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world
    " }, { "lang": "JavaScript", @@ -18821,7 +18954,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -18845,8 +18978,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -19240,7 +19373,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -19264,8 +19397,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world
    " }, { "lang": "JavaScript", @@ -19300,7 +19433,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -19318,7 +19451,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/assignees", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -19362,8 +19495,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/assignees", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/assignees
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/assignees", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/assignees
    " }, { "lang": "JavaScript", @@ -19413,7 +19546,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/assignees/{assignee}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -19446,8 +19579,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/assignees/ASSIGNEE", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/assignees/ASSIGNEE
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/assignees/ASSIGNEE", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/assignees/ASSIGNEE
    " }, { "lang": "JavaScript", @@ -19496,7 +19629,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -19550,8 +19683,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches
    " }, { "lang": "JavaScript", @@ -19589,12 +19722,6 @@ "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "
    [\n  {\n    \"name\": \"master\",\n    \"commit\": {\n      \"sha\": \"c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc\",\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc\"\n    },\n    \"protected\": true\n  }\n]\n
    " - }, - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "With protection", "payload": "
    [\n  {\n    \"name\": \"master\",\n    \"commit\": {\n      \"sha\": \"c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc\",\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc\"\n    },\n    \"protected\": true,\n    \"protection\": {\n      \"enabled\": true,\n      \"required_status_checks\": {\n        \"enforcement_level\": \"non_admins\",\n        \"contexts\": [\n          \"ci-test\",\n          \"linter\"\n        ]\n      }\n    },\n    \"protection_url\": \"https://api.github.com/repos/octocat/hello-world/branches/master/protection\"\n  }\n]\n
    " }, { @@ -19607,7 +19734,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -19642,8 +19769,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH
    " }, { "lang": "JavaScript", @@ -19698,7 +19825,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -19733,8 +19860,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection
    " }, { "lang": "JavaScript", @@ -19791,7 +19918,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -19826,8 +19953,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection \\\n -d '{\"required_status_checks\":{\"strict\":true,\"contexts\":[\"contexts\"]},\"enforce_admins\":true,\"required_pull_request_reviews\":{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":42},\"restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"],\"apps\":[\"apps\"]}}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection \\\n  -d '{\"required_status_checks\":{\"strict\":true,\"contexts\":[\"contexts\"]},\"enforce_admins\":true,\"required_pull_request_reviews\":{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":42},\"restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"],\"apps\":[\"apps\"]}}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection \\\n -d '{\"required_status_checks\":{\"strict\":true,\"contexts\":[\"contexts\"]},\"enforce_admins\":true,\"required_pull_request_reviews\":{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":42},\"restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"],\"apps\":[\"apps\"]}}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection \\\n  -d '{\"required_status_checks\":{\"strict\":true,\"contexts\":[\"contexts\"]},\"enforce_admins\":true,\"required_pull_request_reviews\":{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":42},\"restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"],\"apps\":[\"apps\"]}}'
    " }, { "lang": "JavaScript", @@ -20830,7 +20957,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -20865,8 +20992,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection
    " }, { "lang": "JavaScript", @@ -20901,7 +21028,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -20915,7 +21042,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -20950,8 +21077,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins
    " }, { "lang": "JavaScript", @@ -20996,7 +21123,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -21031,8 +21158,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins
    " }, { "lang": "JavaScript", @@ -21077,7 +21204,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -21112,8 +21239,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins
    " }, { "lang": "JavaScript", @@ -21162,7 +21289,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -21197,8 +21324,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews
    " }, { "lang": "JavaScript", @@ -21249,7 +21376,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -21284,8 +21411,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews \\\n -d '{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]}}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews \\\n  -d '{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]}}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews \\\n -d '{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]}}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews \\\n  -d '{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]}}'
    " }, { "lang": "JavaScript", @@ -21555,7 +21682,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -21590,8 +21717,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews
    " }, { "lang": "JavaScript", @@ -21640,7 +21767,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -21675,8 +21802,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures
    " }, { "lang": "JavaScript", @@ -21733,7 +21860,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -21768,8 +21895,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures
    " }, { "lang": "JavaScript", @@ -21826,7 +21953,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -21861,8 +21988,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures
    " }, { "lang": "JavaScript", @@ -21918,7 +22045,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -21953,8 +22080,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks
    " }, { "lang": "JavaScript", @@ -22004,7 +22131,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -22039,8 +22166,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks \\\n -d '{\"strict\":true}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks \\\n  -d '{\"strict\":true}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks \\\n -d '{\"strict\":true}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks \\\n  -d '{\"strict\":true}'
    " }, { "lang": "JavaScript", @@ -22155,7 +22282,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -22190,8 +22317,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks
    " }, { "lang": "JavaScript", @@ -22235,7 +22362,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -22270,8 +22397,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts
    " }, { "lang": "JavaScript", @@ -22321,7 +22448,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -22356,8 +22483,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n  -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n  -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'
    " }, { "lang": "JavaScript", @@ -22462,7 +22589,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -22497,8 +22624,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n  -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n  -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'
    " }, { "lang": "JavaScript", @@ -22598,7 +22725,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -22633,8 +22760,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n  -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n  -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'
    " }, { "lang": "JavaScript", @@ -22734,7 +22861,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -22769,8 +22896,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions
    " }, { "lang": "JavaScript", @@ -22820,7 +22947,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -22855,8 +22982,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions
    " }, { "lang": "JavaScript", @@ -22900,7 +23027,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -22935,8 +23062,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams
    " }, { "lang": "JavaScript", @@ -22986,7 +23113,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -23021,8 +23148,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n -d '{\"teams\":{\"teams\":[\"teams\"]}}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n  -d '{\"teams\":{\"teams\":[\"teams\"]}}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n -d '{\"teams\":{\"teams\":[\"teams\"]}}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n  -d '{\"teams\":{\"teams\":[\"teams\"]}}'
    " }, { "lang": "JavaScript", @@ -23117,7 +23244,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -23152,8 +23279,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n -d '{\"teams\":{\"teams\":[\"teams\"]}}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n  -d '{\"teams\":{\"teams\":[\"teams\"]}}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n -d '{\"teams\":{\"teams\":[\"teams\"]}}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n  -d '{\"teams\":{\"teams\":[\"teams\"]}}'
    " }, { "lang": "JavaScript", @@ -23248,7 +23375,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -23283,8 +23410,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n -d '{\"teams\":{\"teams\":[\"teams\"]}}'", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n  -d '{\"teams\":{\"teams\":[\"teams\"]}}'
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n -d '{\"teams\":{\"teams\":[\"teams\"]}}'", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n  -d '{\"teams\":{\"teams\":[\"teams\"]}}'
    " }, { "lang": "JavaScript", @@ -23379,7 +23506,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -23414,8 +23541,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users
    " }, { "lang": "JavaScript", @@ -23465,7 +23592,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -23500,8 +23627,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n -d '{\"users\":{\"users\":[\"users\"]}}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n  -d '{\"users\":{\"users\":[\"users\"]}}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n -d '{\"users\":{\"users\":[\"users\"]}}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n  -d '{\"users\":{\"users\":[\"users\"]}}'
    " }, { "lang": "JavaScript", @@ -23596,7 +23723,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -23631,8 +23758,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n -d '{\"users\":{\"users\":[\"users\"]}}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n  -d '{\"users\":{\"users\":[\"users\"]}}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n -d '{\"users\":{\"users\":[\"users\"]}}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n  -d '{\"users\":{\"users\":[\"users\"]}}'
    " }, { "lang": "JavaScript", @@ -23727,7 +23854,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -23762,8 +23889,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n -d '{\"users\":{\"users\":[\"users\"]}}'", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n  -d '{\"users\":{\"users\":[\"users\"]}}'
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n -d '{\"users\":{\"users\":[\"users\"]}}'", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n  -d '{\"users\":{\"users\":[\"users\"]}}'
    " }, { "lang": "JavaScript", @@ -23858,7 +23985,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/check-runs", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -23882,8 +24009,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-runs \\\n -d '{\"name\":\"name\",\"head_sha\":\"head_sha\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/check-runs \\\n  -d '{\"name\":\"name\",\"head_sha\":\"head_sha\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-runs \\\n -d '{\"name\":\"name\",\"head_sha\":\"head_sha\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-runs \\\n  -d '{\"name\":\"name\",\"head_sha\":\"head_sha\"}'
    " }, { "lang": "JavaScript", @@ -24860,7 +24987,7 @@ "name", "head_sha" ], - "anyOf": [ + "oneOf": [ { "properties": { "status": { @@ -24870,6 +24997,7 @@ } }, "required": [ + "status", "conclusion" ], "additionalProperties": true @@ -24889,7 +25017,7 @@ }, "examples": { "example-of-in-progress-conclusion": { - "summary": "Example of in_progress conclusion", + "summary": "Response for in_progress conclusion", "value": { "name": "mighty_readme", "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -24904,7 +25032,7 @@ } }, "example-of-completed-conclusion": { - "summary": "Example of completed conclusion", + "summary": "Response for completed conclusion", "value": { "name": "mighty_readme", "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -24978,12 +25106,6 @@ "notes": [], "descriptionHTML": "

    Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

    \n

    Creates a new check run for a specific commit in a repository. Your GitHub App must have the checks:write permission to create check runs.

    \n

    In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.

    ", "responses": [ - { - "httpStatusCode": "201", - "httpStatusMessage": "Created", - "description": "Response for in_progress conclusion", - "payload": "
    {\n  \"id\": 4,\n  \"head_sha\": \"ce587453ced02b1526dfb4cb910479d431683101\",\n  \"node_id\": \"MDg6Q2hlY2tSdW40\",\n  \"external_id\": \"42\",\n  \"url\": \"https://api.github.com/repos/github/hello-world/check-runs/4\",\n  \"html_url\": \"https://github.com/github/hello-world/runs/4\",\n  \"details_url\": \"https://example.com\",\n  \"status\": \"in_progress\",\n  \"conclusion\": \"neutral\",\n  \"started_at\": \"2018-05-04T01:14:52Z\",\n  \"completed_at\": null,\n  \"output\": {\n    \"title\": \"Mighty Readme Report\",\n    \"summary\": \"\",\n    \"text\": \"\",\n    \"annotations_count\": 1,\n    \"annotations_url\": \"https://api.github.com/repos/github/hello-world/check-runs/4/annotations\"\n  },\n  \"name\": \"mighty_readme\",\n  \"check_suite\": {\n    \"id\": 5\n  },\n  \"app\": {\n    \"id\": 1,\n    \"slug\": \"octoapp\",\n    \"node_id\": \"MDExOkludGVncmF0aW9uMQ==\",\n    \"owner\": {\n      \"login\": \"github\",\n      \"id\": 1,\n      \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n      \"url\": \"https://api.github.com/orgs/github\",\n      \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n      \"events_url\": \"https://api.github.com/orgs/github/events\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\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      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": true\n    },\n    \"name\": \"Octocat App\",\n    \"description\": \"\",\n    \"external_url\": \"https://example.com\",\n    \"html_url\": \"https://github.com/apps/octoapp\",\n    \"created_at\": \"2017-07-08T16:18:44-04:00\",\n    \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n    \"permissions\": {\n      \"metadata\": \"read\",\n      \"contents\": \"read\",\n      \"issues\": \"write\",\n      \"single_file\": \"write\"\n    },\n    \"events\": [\n      \"push\",\n      \"pull_request\"\n    ]\n  },\n  \"pull_requests\": [\n    {\n      \"url\": \"https://api.github.com/repos/github/hello-world/pulls/1\",\n      \"id\": 1934,\n      \"number\": 3956,\n      \"head\": {\n        \"ref\": \"say-hello\",\n        \"sha\": \"3dca65fa3e8d4b3da3f3d056c59aee1c50f41390\",\n        \"repo\": {\n          \"id\": 526,\n          \"url\": \"https://api.github.com/repos/github/hello-world\",\n          \"name\": \"hello-world\"\n        }\n      },\n      \"base\": {\n        \"ref\": \"master\",\n        \"sha\": \"e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f\",\n        \"repo\": {\n          \"id\": 526,\n          \"url\": \"https://api.github.com/repos/github/hello-world\",\n          \"name\": \"hello-world\"\n        }\n      }\n    }\n  ]\n}\n
    " - }, { "httpStatusCode": "201", "httpStatusMessage": "Created", @@ -25945,7 +26067,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/check-runs/{check_run_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -25979,8 +26101,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-runs/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/check-runs/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-runs/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-runs/42
    " }, { "lang": "JavaScript", @@ -26032,7 +26154,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/check-runs/{check_run_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -26066,8 +26188,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-runs/42 \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/check-runs/42 \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-runs/42 \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-runs/42 \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -28069,7 +28191,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/check-runs/{check_run_id}/annotations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -28123,8 +28245,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-runs/42/annotations", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/check-runs/42/annotations
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-runs/42/annotations", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-runs/42/annotations
    " }, { "lang": "JavaScript", @@ -28176,7 +28298,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/check-suites", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -28200,8 +28322,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-suites \\\n -d '{\"head_sha\":\"head_sha\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/check-suites \\\n  -d '{\"head_sha\":\"head_sha\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-suites \\\n -d '{\"head_sha\":\"head_sha\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-suites \\\n  -d '{\"head_sha\":\"head_sha\"}'
    " }, { "lang": "JavaScript", @@ -28289,7 +28411,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/check-suites/preferences", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -28313,8 +28435,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-suites/preferences \\\n -d '{\"auto_trigger_checks\":[{\"app_id\":42,\"setting\":true}]}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/check-suites/preferences \\\n  -d '{\"auto_trigger_checks\":[{\"app_id\":42,\"setting\":true}]}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-suites/preferences \\\n -d '{\"auto_trigger_checks\":[{\"app_id\":42,\"setting\":true}]}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-suites/preferences \\\n  -d '{\"auto_trigger_checks\":[{\"app_id\":42,\"setting\":true}]}'
    " }, { "lang": "JavaScript", @@ -28514,7 +28636,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/check-suites/{check_suite_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -28548,8 +28670,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-suites/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/check-suites/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-suites/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-suites/42
    " }, { "lang": "JavaScript", @@ -28601,7 +28723,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -28695,8 +28817,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-suites/42/check-runs", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/check-suites/42/check-runs
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-suites/42/check-runs", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-suites/42/check-runs
    " }, { "lang": "JavaScript", @@ -28748,7 +28870,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -28782,8 +28904,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-suites/42/rerequest", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/check-suites/42/rerequest
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-suites/42/rerequest", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-suites/42/rerequest
    " }, { "lang": "JavaScript", @@ -28834,7 +28956,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/collaborators", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -28894,8 +29016,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/collaborators", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/collaborators
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/collaborators", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/collaborators
    " }, { "lang": "JavaScript", @@ -28945,7 +29067,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -28978,8 +29100,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/collaborators/USERNAME", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/collaborators/USERNAME
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/collaborators/USERNAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/collaborators/USERNAME
    " }, { "lang": "JavaScript", @@ -29028,7 +29150,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -29061,8 +29183,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/collaborators/USERNAME \\\n -d '{\"permission\":\"permission\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/collaborators/USERNAME \\\n  -d '{\"permission\":\"permission\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/collaborators/USERNAME \\\n -d '{\"permission\":\"permission\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/collaborators/USERNAME \\\n  -d '{\"permission\":\"permission\"}'
    " }, { "lang": "JavaScript", @@ -29187,7 +29309,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -29220,8 +29342,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/collaborators/USERNAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/collaborators/USERNAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/collaborators/USERNAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/collaborators/USERNAME
    " }, { "lang": "JavaScript", @@ -29256,7 +29378,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -29265,7 +29387,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/collaborators/{username}/permission", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -29298,8 +29420,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/collaborators/USERNAME/permission", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/collaborators/USERNAME/permission
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/collaborators/USERNAME/permission", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/collaborators/USERNAME/permission
    " }, { "lang": "JavaScript", @@ -29349,7 +29471,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -29393,8 +29515,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/comments", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/comments
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/comments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/comments
    " }, { "lang": "JavaScript", @@ -29446,7 +29568,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -29480,8 +29602,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/comments/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/comments/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/comments/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/comments/42
    " }, { "lang": "JavaScript", @@ -29538,7 +29660,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -29572,8 +29694,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/comments/42 \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/comments/42 \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/comments/42 \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/comments/42 \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -29659,7 +29781,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -29693,8 +29815,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/comments/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/comments/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/comments/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/comments/42
    " }, { "lang": "JavaScript", @@ -29729,7 +29851,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -29743,7 +29865,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -29817,8 +29939,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/comments/42/reactions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/comments/42/reactions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/comments/42/reactions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/comments/42/reactions
    " }, { "lang": "JavaScript", @@ -29878,7 +30000,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -29912,8 +30034,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/comments/42/reactions \\\n -d '{\"content\":\"content\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/comments/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/comments/42/reactions \\\n -d '{\"content\":\"content\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/comments/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " }, { "lang": "JavaScript", @@ -30035,7 +30157,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/commits", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -30124,13 +30246,35 @@ "default": 1 }, "descriptionHTML": "

    Page number of the results to fetch.

    " + }, + { + "name": "top", + "description": "legacy parameter for pagination.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    legacy parameter for pagination.

    " + }, + { + "name": "last_sha", + "description": "legacy parameter for pagination.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    legacy parameter for pagination.

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/commits
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits
    " }, { "lang": "JavaScript", @@ -30195,7 +30339,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -30230,8 +30374,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.groot-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits/COMMIT_SHA/branches-where-head", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.groot-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/commits/COMMIT_SHA/branches-where-head
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.groot-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/COMMIT_SHA/branches-where-head", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.groot-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/COMMIT_SHA/branches-where-head
    " }, { "lang": "JavaScript", @@ -30293,7 +30437,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -30348,8 +30492,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits/COMMIT_SHA/comments", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/commits/COMMIT_SHA/comments
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/COMMIT_SHA/comments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/COMMIT_SHA/comments
    " }, { "lang": "JavaScript", @@ -30401,7 +30545,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -30436,8 +30580,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits/COMMIT_SHA/comments \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/commits/COMMIT_SHA/comments \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/COMMIT_SHA/comments \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/COMMIT_SHA/comments \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -30586,7 +30730,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/pulls", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -30641,8 +30785,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.groot-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits/COMMIT_SHA/pulls", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.groot-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/commits/COMMIT_SHA/pulls
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.groot-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/COMMIT_SHA/pulls", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.groot-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/COMMIT_SHA/pulls
    " }, { "lang": "JavaScript", @@ -30699,7 +30843,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/commits/{ref}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -30719,23 +30863,43 @@ }, "descriptionHTML": "" }, + { + "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.

    " + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "descriptionHTML": "

    Results per page (max 100).

    " + }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    ref+ parameter

    " + "descriptionHTML": "

    ref parameter

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits/REF", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/commits/REF
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/REF", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/REF
    " }, { "lang": "JavaScript", @@ -30795,7 +30959,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/commits/{ref}/check-runs", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -30817,14 +30981,14 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    ref+ parameter

    " + "descriptionHTML": "

    ref parameter

    " }, { "name": "check_name", @@ -30885,13 +31049,22 @@ "default": 1 }, "descriptionHTML": "

    Page number of the results to fetch.

    " + }, + { + "name": "app_id", + "in": "query", + "required": false, + "schema": { + "type": "integer" + }, + "descriptionHTML": "" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits/REF/check-runs", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/commits/REF/check-runs
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/REF/check-runs", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/REF/check-runs
    " }, { "lang": "JavaScript", @@ -30943,7 +31116,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/commits/{ref}/check-suites", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -30965,14 +31138,14 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    ref+ parameter

    " + "descriptionHTML": "

    ref parameter

    " }, { "name": "app_id", @@ -31019,8 +31192,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits/REF/check-suites", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/commits/REF/check-suites
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/REF/check-suites", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/REF/check-suites
    " }, { "lang": "JavaScript", @@ -31072,7 +31245,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/commits/{ref}/status", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -31094,21 +31267,41 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    ref+ parameter

    " + "descriptionHTML": "

    ref parameter

    " + }, + { + "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/repos/octocat/hello-world/commits/REF/status", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/commits/REF/status
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/REF/status", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/REF/status
    " }, { "lang": "JavaScript", @@ -31158,7 +31351,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/commits/{ref}/statuses", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -31180,14 +31373,14 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    ref+ parameter

    " + "descriptionHTML": "

    ref parameter

    " }, { "name": "per_page", @@ -31213,8 +31406,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits/REF/statuses", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/commits/REF/statuses
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/REF/statuses", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/REF/statuses
    " }, { "lang": "JavaScript", @@ -31264,7 +31457,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/compare/{base}...{head}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -31306,8 +31499,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/compare/BASE...HEAD", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/compare/BASE...HEAD
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/compare/BASE...HEAD", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/compare/BASE...HEAD
    " }, { "lang": "JavaScript", @@ -31362,7 +31555,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/contents/{path}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -31384,14 +31577,14 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    path+ parameter

    " + "descriptionHTML": "

    path parameter

    " }, { "name": "ref", @@ -31407,8 +31600,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/contents/PATH", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/contents/PATH
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/contents/PATH", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/contents/PATH
    " }, { "lang": "JavaScript", @@ -31486,7 +31679,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/contents/{path}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -31508,21 +31701,21 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    path+ parameter

    " + "descriptionHTML": "

    path parameter

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/contents/PATH \\\n -d '{\"message\":\"message\",\"content\":\"content\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/contents/PATH \\\n  -d '{\"message\":\"message\",\"content\":\"content\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/contents/PATH \\\n -d '{\"message\":\"message\",\"content\":\"content\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/contents/PATH \\\n  -d '{\"message\":\"message\",\"content\":\"content\"}'
    " }, { "lang": "JavaScript", @@ -32009,7 +32202,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/contents/{path}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -32031,21 +32224,21 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    path+ parameter

    " + "descriptionHTML": "

    path parameter

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/contents/PATH \\\n -d '{\"message\":\"message\",\"sha\":\"sha\"}'", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/contents/PATH \\\n  -d '{\"message\":\"message\",\"sha\":\"sha\"}'
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/contents/PATH \\\n -d '{\"message\":\"message\",\"sha\":\"sha\"}'", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/contents/PATH \\\n  -d '{\"message\":\"message\",\"sha\":\"sha\"}'
    " }, { "lang": "JavaScript", @@ -32408,7 +32601,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/contributors", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -32462,8 +32655,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/contributors", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/contributors
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/contributors", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/contributors
    " }, { "lang": "JavaScript", @@ -32521,7 +32714,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/deployments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -32581,7 +32774,8 @@ "required": false, "schema": { "type": "string", - "default": "none" + "default": "none", + "nullable": true }, "descriptionHTML": "

    The name of the environment that was deployed to (e.g., staging or production).

    " }, @@ -32609,8 +32803,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/deployments", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/deployments
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/deployments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/deployments
    " }, { "lang": "JavaScript", @@ -32662,7 +32856,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/deployments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -32686,8 +32880,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/deployments \\\n -d '{\"ref\":\"ref\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/deployments \\\n  -d '{\"ref\":\"ref\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/deployments \\\n -d '{\"ref\":\"ref\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/deployments \\\n  -d '{\"ref\":\"ref\"}'
    " }, { "lang": "JavaScript", @@ -32986,12 +33180,6 @@ "description": "Simple example", "payload": "
    {\n  \"url\": \"https://api.github.com/repos/octocat/example/deployments/1\",\n  \"id\": 1,\n  \"node_id\": \"MDEwOkRlcGxveW1lbnQx\",\n  \"sha\": \"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\n  \"ref\": \"topic-branch\",\n  \"task\": \"deploy\",\n  \"payload\": {},\n  \"original_environment\": \"staging\",\n  \"environment\": \"production\",\n  \"description\": \"Deploy request from hubot\",\n  \"creator\": {\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  \"created_at\": \"2012-07-20T01:19:13Z\",\n  \"updated_at\": \"2012-07-20T01:19:13Z\",\n  \"statuses_url\": \"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/example\",\n  \"transient_environment\": false,\n  \"production_environment\": true\n}\n
    " }, - { - "httpStatusCode": "201", - "httpStatusMessage": "Created", - "description": "Advanced example", - "payload": "
    {\n  \"url\": \"https://api.github.com/repos/octocat/example/deployments/1\",\n  \"id\": 1,\n  \"node_id\": \"MDEwOkRlcGxveW1lbnQx\",\n  \"sha\": \"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\n  \"ref\": \"topic-branch\",\n  \"task\": \"deploy\",\n  \"payload\": {},\n  \"original_environment\": \"staging\",\n  \"environment\": \"production\",\n  \"description\": \"Deploy request from hubot\",\n  \"creator\": {\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  \"created_at\": \"2012-07-20T01:19:13Z\",\n  \"updated_at\": \"2012-07-20T01:19:13Z\",\n  \"statuses_url\": \"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/example\",\n  \"transient_environment\": false,\n  \"production_environment\": true\n}\n
    " - }, { "httpStatusCode": "202", "httpStatusMessage": "Accepted", @@ -33001,14 +33189,7 @@ { "httpStatusCode": "409", "httpStatusMessage": "Conflict", - "description": "Merge conflict response", - "payload": "
    {\n  \"message\": \"Conflict merging master into topic-branch\"\n}\n
    " - }, - { - "httpStatusCode": "409", - "httpStatusMessage": "Conflict", - "description": "Failed commit status checks", - "payload": "
    {\n  \"message\": \"Conflict: Commit status checks failed for topic-branch.\"\n}\n
    " + "description": "Response when there is a merge conflict or the commit s status checks failed" }, { "httpStatusCode": "422", @@ -33020,7 +33201,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -33054,8 +33235,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/deployments/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/deployments/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/deployments/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/deployments/42
    " }, { "lang": "JavaScript", @@ -33118,7 +33299,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -33172,8 +33353,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/deployments/42/statuses", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/deployments/42/statuses
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/deployments/42/statuses", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/deployments/42/statuses
    " }, { "lang": "JavaScript", @@ -33236,7 +33417,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -33270,8 +33451,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/deployments/42/statuses \\\n -d '{\"state\":\"state\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/deployments/42/statuses \\\n  -d '{\"state\":\"state\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/deployments/42/statuses \\\n -d '{\"state\":\"state\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/deployments/42/statuses \\\n  -d '{\"state\":\"state\"}'
    " }, { "lang": "JavaScript", @@ -33517,7 +33698,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -33560,8 +33741,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/deployments/42/statuses/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/deployments/42/statuses/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/deployments/42/statuses/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/deployments/42/statuses/42
    " }, { "lang": "JavaScript", @@ -33635,7 +33816,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/events", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -33679,8 +33860,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/events", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/events
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/events", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/events
    " }, { "lang": "JavaScript", @@ -33724,7 +33905,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/forks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -33754,7 +33935,8 @@ "enum": [ "newest", "oldest", - "stargazers" + "stargazers", + "watchers" ], "default": "newest" }, @@ -33779,13 +33961,35 @@ "default": 1 }, "descriptionHTML": "

    Page number of the results to fetch.

    " + }, + { + "name": "org", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    legacy query parameter for specifying the org.

    " + }, + { + "name": "organization", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    legacy query parameter for specifying the org.

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/forks", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/forks
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/forks", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/forks
    " }, { "lang": "JavaScript", @@ -33835,7 +34039,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/forks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -33854,13 +34058,35 @@ "type": "string" }, "descriptionHTML": "" + }, + { + "name": "org", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    legacy query parameter for specifying the org.

    " + }, + { + "name": "organization", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    legacy query parameter for specifying the org.

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/forks \\\n -d '{\"organization\":\"organization\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/forks \\\n  -d '{\"organization\":\"organization\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/forks \\\n -d '{\"organization\":\"organization\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/forks \\\n  -d '{\"organization\":\"organization\"}'
    " }, { "lang": "JavaScript", @@ -33883,6 +34109,7 @@ "application/json": { "schema": { "type": "object", + "nullable": true, "properties": { "organization": { "type": "string", @@ -33955,7 +34182,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/git/blobs", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -33979,8 +34206,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/blobs \\\n -d '{\"content\":\"content\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/blobs \\\n  -d '{\"content\":\"content\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/blobs \\\n -d '{\"content\":\"content\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/blobs \\\n  -d '{\"content\":\"content\"}'
    " }, { "lang": "JavaScript", @@ -34102,7 +34329,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/git/blobs/{file_sha}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -34135,8 +34362,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/blobs/FILE_SHA", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/blobs/FILE_SHA
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/blobs/FILE_SHA", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/blobs/FILE_SHA
    " }, { "lang": "JavaScript", @@ -34196,7 +34423,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/git/commits", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -34220,8 +34447,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/commits \\\n -d '{\"message\":\"message\",\"tree\":\"tree\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/commits \\\n  -d '{\"message\":\"message\",\"tree\":\"tree\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/commits \\\n -d '{\"message\":\"message\",\"tree\":\"tree\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/commits \\\n  -d '{\"message\":\"message\",\"tree\":\"tree\"}'
    " }, { "lang": "JavaScript", @@ -34675,7 +34902,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/git/commits/{commit_sha}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -34710,8 +34937,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/commits/COMMIT_SHA", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/commits/COMMIT_SHA
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/commits/COMMIT_SHA", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/commits/COMMIT_SHA
    " }, { "lang": "JavaScript", @@ -34761,7 +34988,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/git/refs", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -34785,8 +35012,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/refs \\\n -d '{\"ref\":\"ref\",\"sha\":\"sha\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/refs \\\n  -d '{\"ref\":\"ref\",\"sha\":\"sha\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/refs \\\n -d '{\"ref\":\"ref\",\"sha\":\"sha\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/refs \\\n  -d '{\"ref\":\"ref\",\"sha\":\"sha\"}'
    " }, { "lang": "JavaScript", @@ -34910,7 +35137,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/git/refs/{namespace}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -34954,8 +35181,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/refs/", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/refs/
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/refs/", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/refs/
    " }, { "lang": "JavaScript", @@ -34999,7 +35226,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/git/refs/{ref}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -35021,21 +35248,21 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    ref+ parameter

    " + "descriptionHTML": "

    ref parameter

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/refs/REF \\\n -d '{\"sha\":\"sha\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/refs/REF \\\n  -d '{\"sha\":\"sha\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/refs/REF \\\n -d '{\"sha\":\"sha\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/refs/REF \\\n  -d '{\"sha\":\"sha\"}'
    " }, { "lang": "JavaScript", @@ -35142,7 +35369,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/git/refs/{ref}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -35164,21 +35391,21 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    ref+ parameter

    " + "descriptionHTML": "

    ref parameter

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/refs/REF", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/refs/REF
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/refs/REF", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/refs/REF
    " }, { "lang": "JavaScript", @@ -35213,7 +35440,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "422", @@ -35227,7 +35454,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/git/tags", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -35251,8 +35478,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/tags \\\n -d '{\"tag\":\"tag\",\"message\":\"message\",\"object\":\"object\",\"type\":\"type\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/tags \\\n  -d '{\"tag\":\"tag\",\"message\":\"message\",\"object\":\"object\",\"type\":\"type\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/tags \\\n -d '{\"tag\":\"tag\",\"message\":\"message\",\"object\":\"object\",\"type\":\"type\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/tags \\\n  -d '{\"tag\":\"tag\",\"message\":\"message\",\"object\":\"object\",\"type\":\"type\"}'
    " }, { "lang": "JavaScript", @@ -35559,7 +35786,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/git/tags/{tag_sha}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -35592,8 +35819,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/tags/TAG_SHA", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/tags/TAG_SHA
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/tags/TAG_SHA", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/tags/TAG_SHA
    " }, { "lang": "JavaScript", @@ -35643,7 +35870,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/git/trees", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -35667,8 +35894,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/trees \\\n -d '{\"tree\":[{\"path\":\"path\",\"mode\":\"mode\",\"type\":\"type\",\"sha\":\"sha\",\"content\":\"content\"}]}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/trees \\\n  -d '{\"tree\":[{\"path\":\"path\",\"mode\":\"mode\",\"type\":\"type\",\"sha\":\"sha\",\"content\":\"content\"}]}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/trees \\\n -d '{\"tree\":[{\"path\":\"path\",\"mode\":\"mode\",\"type\":\"type\",\"sha\":\"sha\",\"content\":\"content\"}]}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/trees \\\n  -d '{\"tree\":[{\"path\":\"path\",\"mode\":\"mode\",\"type\":\"type\",\"sha\":\"sha\",\"content\":\"content\"}]}'
    " }, { "lang": "JavaScript", @@ -36048,7 +36275,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/git/trees/{tree_sha}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -36075,6 +36302,7 @@ "schema": { "type": "string" }, + "x-multi-segment": true, "descriptionHTML": "" }, { @@ -36091,8 +36319,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/trees/TREE_SHA", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/trees/TREE_SHA
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/trees/TREE_SHA", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/trees/TREE_SHA
    " }, { "lang": "JavaScript", @@ -36153,7 +36381,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/hooks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -36197,8 +36425,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/hooks", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/hooks
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks
    " }, { "lang": "JavaScript", @@ -36248,7 +36476,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/hooks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -36272,8 +36500,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/hooks \\\n -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"token\":\"token\",\"digest\":\"digest\"}}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/hooks \\\n  -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"token\":\"token\",\"digest\":\"digest\"}}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks \\\n -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"token\":\"token\",\"digest\":\"digest\"}}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks \\\n  -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"token\":\"token\",\"digest\":\"digest\"}}'
    " }, { "lang": "JavaScript", @@ -36709,7 +36937,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -36742,8 +36970,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/hooks/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/hooks/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks/42
    " }, { "lang": "JavaScript", @@ -36793,7 +37021,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -36826,8 +37054,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/hooks/42 \\\n -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"address\":\"address\",\"room\":\"room\"}}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/hooks/42 \\\n  -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"address\":\"address\",\"room\":\"room\"}}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks/42 \\\n -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"address\":\"address\",\"room\":\"room\"}}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks/42 \\\n  -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"address\":\"address\",\"room\":\"room\"}}'
    " }, { "lang": "JavaScript", @@ -37278,7 +37506,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -37311,8 +37539,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/hooks/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/hooks/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks/42
    " }, { "lang": "JavaScript", @@ -37347,7 +37575,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -37361,7 +37589,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}/pings", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -37394,8 +37622,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/hooks/42/pings", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/hooks/42/pings
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks/42/pings", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks/42/pings
    " }, { "lang": "JavaScript", @@ -37430,7 +37658,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -37444,7 +37672,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}/tests", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -37477,8 +37705,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/hooks/42/tests", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/hooks/42/tests
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks/42/tests", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks/42/tests
    " }, { "lang": "JavaScript", @@ -37513,7 +37741,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -37527,7 +37755,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/installation", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -37562,8 +37790,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/installation", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/installation
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/installation", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/installation
    " }, { "lang": "JavaScript", @@ -37622,7 +37850,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/invitations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -37666,8 +37894,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/invitations", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/invitations
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/invitations", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/invitations
    " }, { "lang": "JavaScript", @@ -37712,7 +37940,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/invitations/{invitation_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -37746,8 +37974,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/invitations/42 \\\n -d '{\"permissions\":\"permissions\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/invitations/42 \\\n  -d '{\"permissions\":\"permissions\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/invitations/42 \\\n -d '{\"permissions\":\"permissions\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/invitations/42 \\\n  -d '{\"permissions\":\"permissions\"}'
    " }, { "lang": "JavaScript", @@ -37836,7 +38064,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/invitations/{invitation_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -37870,8 +38098,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/invitations/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/invitations/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/invitations/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/invitations/42
    " }, { "lang": "JavaScript", @@ -37906,7 +38134,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -37915,7 +38143,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -38066,8 +38294,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues
    " }, { "lang": "JavaScript", @@ -38131,7 +38359,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/issues", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -38155,8 +38383,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues \\\n -d '{\"title\":\"title\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues \\\n  -d '{\"title\":\"title\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues \\\n -d '{\"title\":\"title\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues \\\n  -d '{\"title\":\"title\"}'
    " }, { "lang": "JavaScript", @@ -38447,7 +38675,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -38530,8 +38758,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/comments", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/comments
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/comments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/comments
    " }, { "lang": "JavaScript", @@ -38593,7 +38821,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -38627,8 +38855,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/comments/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/comments/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/comments/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/comments/42
    " }, { "lang": "JavaScript", @@ -38685,7 +38913,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -38719,8 +38947,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/comments/42 \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/comments/42 \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/comments/42 \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/comments/42 \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -38806,7 +39034,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -38840,8 +39068,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/comments/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/comments/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/comments/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/comments/42
    " }, { "lang": "JavaScript", @@ -38876,7 +39104,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -38885,7 +39113,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -38959,8 +39187,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/comments/42/reactions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/comments/42/reactions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/comments/42/reactions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/comments/42/reactions
    " }, { "lang": "JavaScript", @@ -39020,7 +39248,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -39054,8 +39282,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/comments/42/reactions \\\n -d '{\"content\":\"content\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/comments/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/comments/42/reactions \\\n -d '{\"content\":\"content\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/comments/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " }, { "lang": "JavaScript", @@ -39177,7 +39405,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/events", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -39221,8 +39449,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/events", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/events
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/events", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/events
    " }, { "lang": "JavaScript", @@ -39285,7 +39513,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/events/{event_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -39318,8 +39546,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/events/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/events/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/events/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/events/42
    " }, { "lang": "JavaScript", @@ -39398,7 +39626,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -39432,8 +39660,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42
    " }, { "lang": "JavaScript", @@ -39503,7 +39731,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -39537,8 +39765,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42 \\\n -d '{\"title\":\"title\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42 \\\n  -d '{\"title\":\"title\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42 \\\n -d '{\"title\":\"title\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42 \\\n  -d '{\"title\":\"title\"}'
    " }, { "lang": "JavaScript", @@ -39863,7 +40091,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/assignees", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -39897,8 +40125,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/assignees \\\n -d '{\"assignees\":[\"assignees\"]}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/assignees \\\n  -d '{\"assignees\":[\"assignees\"]}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/assignees \\\n -d '{\"assignees\":[\"assignees\"]}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/assignees \\\n  -d '{\"assignees\":[\"assignees\"]}'
    " }, { "lang": "JavaScript", @@ -39985,7 +40213,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/assignees", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -40019,8 +40247,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/assignees \\\n -d '{\"assignees\":[\"assignees\"]}'", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/assignees \\\n  -d '{\"assignees\":[\"assignees\"]}'
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/assignees \\\n -d '{\"assignees\":[\"assignees\"]}'", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/assignees \\\n  -d '{\"assignees\":[\"assignees\"]}'
    " }, { "lang": "JavaScript", @@ -40107,7 +40335,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -40171,8 +40399,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/comments", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/comments
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/comments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/comments
    " }, { "lang": "JavaScript", @@ -40234,7 +40462,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -40268,8 +40496,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/comments \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/comments \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/comments \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/comments \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -40371,7 +40599,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/events", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -40425,8 +40653,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/events", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/events
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/events", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/events
    " }, { "lang": "JavaScript", @@ -40489,7 +40717,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -40543,8 +40771,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/labels", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/labels
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/labels", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/labels
    " }, { "lang": "JavaScript", @@ -40594,7 +40822,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -40628,8 +40856,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/labels \\\n -d '{\"labels\":[\"labels\"]}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/labels \\\n  -d '{\"labels\":[\"labels\"]}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/labels \\\n -d '{\"labels\":[\"labels\"]}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/labels \\\n  -d '{\"labels\":[\"labels\"]}'
    " }, { "lang": "JavaScript", @@ -40729,7 +40957,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -40763,8 +40991,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/labels \\\n -d '{\"labels\":[\"labels\"]}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/labels \\\n  -d '{\"labels\":[\"labels\"]}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/labels \\\n -d '{\"labels\":[\"labels\"]}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/labels \\\n  -d '{\"labels\":[\"labels\"]}'
    " }, { "lang": "JavaScript", @@ -40861,7 +41089,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -40895,8 +41123,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/labels", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/labels
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/labels", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/labels
    " }, { "lang": "JavaScript", @@ -40931,7 +41159,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "410", @@ -40945,7 +41173,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels/{name}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -40988,8 +41216,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/labels/NAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/labels/NAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/labels/NAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/labels/NAME
    " }, { "lang": "JavaScript", @@ -41044,7 +41272,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/lock", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -41078,8 +41306,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/lock \\\n -d '{\"lock_reason\":\"lock_reason\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/lock \\\n  -d '{\"lock_reason\":\"lock_reason\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/lock \\\n -d '{\"lock_reason\":\"lock_reason\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/lock \\\n  -d '{\"lock_reason\":\"lock_reason\"}'
    " }, { "lang": "JavaScript", @@ -41145,7 +41373,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -41190,7 +41418,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/lock", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -41224,8 +41452,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/lock", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/lock
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/lock", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/lock
    " }, { "lang": "JavaScript", @@ -41258,7 +41486,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -41277,7 +41505,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -41351,8 +41579,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/reactions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/reactions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/reactions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/reactions
    " }, { "lang": "JavaScript", @@ -41417,7 +41645,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -41451,8 +41679,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/reactions \\\n -d '{\"content\":\"content\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/reactions \\\n -d '{\"content\":\"content\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " }, { "lang": "JavaScript", @@ -41568,7 +41796,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/timeline", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -41622,8 +41850,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.mockingbird-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/timeline", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.mockingbird-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/timeline
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.mockingbird-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/timeline", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.mockingbird-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/timeline
    " }, { "lang": "JavaScript", @@ -41696,7 +41924,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/keys", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -41740,8 +41968,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/keys", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/keys
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/keys", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/keys
    " }, { "lang": "JavaScript", @@ -41786,7 +42014,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/keys", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -41810,8 +42038,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/keys \\\n -d '{\"key\":\"key\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/keys \\\n  -d '{\"key\":\"key\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/keys \\\n -d '{\"key\":\"key\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/keys \\\n  -d '{\"key\":\"key\"}'
    " }, { "lang": "JavaScript", @@ -41935,7 +42163,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/keys/{key_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -41969,8 +42197,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/keys/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/keys/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/keys/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/keys/42
    " }, { "lang": "JavaScript", @@ -42020,7 +42248,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/keys/{key_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -42054,8 +42282,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/keys/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/keys/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/keys/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/keys/42
    " }, { "lang": "JavaScript", @@ -42090,7 +42318,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -42099,7 +42327,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/labels", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -42143,8 +42371,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/labels", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/labels
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/labels", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/labels
    " }, { "lang": "JavaScript", @@ -42194,7 +42422,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/labels", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -42218,8 +42446,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/labels \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/labels \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/labels \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/labels \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -42348,7 +42576,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/labels/{name}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -42381,8 +42609,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/labels/NAME", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/labels/NAME
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/labels/NAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/labels/NAME
    " }, { "lang": "JavaScript", @@ -42432,7 +42660,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/labels/{name}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -42465,8 +42693,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/labels/NAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/labels/NAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/labels/NAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/labels/NAME
    " }, { "lang": "JavaScript", @@ -42501,7 +42729,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -42510,7 +42738,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/languages", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -42534,8 +42762,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/languages", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/languages
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/languages", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/languages
    " }, { "lang": "JavaScript", @@ -42578,7 +42806,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/license", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -42602,8 +42830,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/license", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/license
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/license", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/license
    " }, { "lang": "JavaScript", @@ -42646,7 +42874,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/merges", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -42670,8 +42898,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/merges \\\n -d '{\"base\":\"base\",\"head\":\"head\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/merges \\\n  -d '{\"base\":\"base\",\"head\":\"head\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/merges \\\n -d '{\"base\":\"base\",\"head\":\"head\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/merges \\\n  -d '{\"base\":\"base\",\"head\":\"head\"}'
    " }, { "lang": "JavaScript", @@ -42794,20 +43022,12 @@ { "httpStatusCode": "404", "httpStatusMessage": "Not Found", - "description": "Missing base response", - "payload": "
    {\n  \"message\": \"Base does not exist\"\n}\n
    " - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Missing head response", - "payload": "
    {\n  \"message\": \"Head does not exist\"\n}\n
    " + "description": "Response when the base or head does not exist" }, { "httpStatusCode": "409", "httpStatusMessage": "Conflict", - "description": "Merge conflict response", - "payload": "
    {\n  \"message\": \"Merge Conflict\"\n}\n
    " + "description": "Response when there is a merge conflict" }, { "httpStatusCode": "422", @@ -42819,7 +43039,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/milestones", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -42909,8 +43129,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/milestones", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/milestones
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/milestones", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/milestones
    " }, { "lang": "JavaScript", @@ -42960,7 +43180,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/milestones", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -42984,8 +43204,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/milestones \\\n -d '{\"title\":\"title\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/milestones \\\n  -d '{\"title\":\"title\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/milestones \\\n -d '{\"title\":\"title\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/milestones \\\n  -d '{\"title\":\"title\"}'
    " }, { "lang": "JavaScript", @@ -43143,7 +43363,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/milestones/{milestone_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -43177,8 +43397,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/milestones/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/milestones/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/milestones/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/milestones/42
    " }, { "lang": "JavaScript", @@ -43228,7 +43448,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/milestones/{milestone_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -43262,8 +43482,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/milestones/42 \\\n -d '{\"title\":\"title\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/milestones/42 \\\n  -d '{\"title\":\"title\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/milestones/42 \\\n -d '{\"title\":\"title\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/milestones/42 \\\n  -d '{\"title\":\"title\"}'
    " }, { "lang": "JavaScript", @@ -43408,7 +43628,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/milestones/{milestone_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -43442,8 +43662,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/milestones/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/milestones/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/milestones/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/milestones/42
    " }, { "lang": "JavaScript", @@ -43478,7 +43698,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -43492,7 +43712,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/milestones/{milestone_number}/labels", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -43546,8 +43766,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/milestones/42/labels", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/milestones/42/labels
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/milestones/42/labels", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/milestones/42/labels
    " }, { "lang": "JavaScript", @@ -43592,7 +43812,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/notifications", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -43678,8 +43898,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/notifications", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/notifications
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/notifications", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/notifications
    " }, { "lang": "JavaScript", @@ -43724,7 +43944,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/notifications", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -43748,8 +43968,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/notifications \\\n -d '{\"last_read_at\":\"last_read_at\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/notifications \\\n  -d '{\"last_read_at\":\"last_read_at\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/notifications \\\n -d '{\"last_read_at\":\"last_read_at\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/notifications \\\n  -d '{\"last_read_at\":\"last_read_at\"}'
    " }, { "lang": "JavaScript", @@ -43823,7 +44043,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pages", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -43847,8 +44067,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pages
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages
    " }, { "lang": "JavaScript", @@ -43898,7 +44118,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/pages", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -43922,8 +44142,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages \\\n -d '{\"source\":{\"branch\":\"branch\",\"path\":\"path\"}}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pages \\\n  -d '{\"source\":{\"branch\":\"branch\",\"path\":\"path\"}}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages \\\n -d '{\"source\":{\"branch\":\"branch\",\"path\":\"path\"}}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages \\\n  -d '{\"source\":{\"branch\":\"branch\",\"path\":\"path\"}}'
    " }, { "lang": "JavaScript", @@ -44170,7 +44390,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/pages", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -44194,8 +44414,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages \\\n -d '{\"public\":true}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pages \\\n  -d '{\"public\":true}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages \\\n -d '{\"public\":true}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages \\\n  -d '{\"public\":true}'
    " }, { "lang": "JavaScript", @@ -44307,7 +44527,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "400", @@ -44383,7 +44603,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/pages", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -44407,8 +44627,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pages
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages
    " }, { "lang": "JavaScript", @@ -44450,7 +44670,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -44474,7 +44694,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pages/builds", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -44518,8 +44738,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages/builds", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pages/builds
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages/builds", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages/builds
    " }, { "lang": "JavaScript", @@ -44564,7 +44784,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/pages/builds", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -44588,8 +44808,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages/builds", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pages/builds
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages/builds", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages/builds
    " }, { "lang": "JavaScript", @@ -44634,7 +44854,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pages/builds/latest", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -44658,8 +44878,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages/builds/latest", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pages/builds/latest
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages/builds/latest", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages/builds/latest
    " }, { "lang": "JavaScript", @@ -44704,7 +44924,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pages/builds/{build_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -44737,8 +44957,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages/builds/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pages/builds/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages/builds/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages/builds/42
    " }, { "lang": "JavaScript", @@ -44783,7 +45003,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -44822,13 +45042,43 @@ "default": 1 }, "descriptionHTML": "

    Page number of the results to fetch.

    " + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + }, + "descriptionHTML": "

    One of asc (ascending) or desc (descending).

    " + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + }, + "descriptionHTML": "" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pre-receive-hooks", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pre-receive-hooks
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pre-receive-hooks", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pre-receive-hooks
    " }, { "lang": "JavaScript", @@ -44880,7 +45130,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -44913,8 +45163,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pre-receive-hooks/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pre-receive-hooks/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pre-receive-hooks/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pre-receive-hooks/42
    " }, { "lang": "JavaScript", @@ -44966,7 +45216,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -44999,8 +45249,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pre-receive-hooks/42 \\\n -d '{\"enforcement\":\"enforcement\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pre-receive-hooks/42 \\\n  -d '{\"enforcement\":\"enforcement\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pre-receive-hooks/42 \\\n -d '{\"enforcement\":\"enforcement\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pre-receive-hooks/42 \\\n  -d '{\"enforcement\":\"enforcement\"}'
    " }, { "lang": "JavaScript", @@ -45085,7 +45335,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -45118,8 +45368,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pre-receive-hooks/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pre-receive-hooks/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pre-receive-hooks/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pre-receive-hooks/42
    " }, { "lang": "JavaScript", @@ -45171,7 +45421,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/projects", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -45231,8 +45481,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/projects", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/projects
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/projects", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/projects
    " }, { "lang": "JavaScript", @@ -45307,7 +45557,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/projects", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -45331,8 +45581,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/projects \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/projects \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/projects \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/projects \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -45462,7 +45712,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -45573,8 +45823,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls
    " }, { "lang": "JavaScript", @@ -45639,7 +45889,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/pulls", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -45663,8 +45913,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls \\\n -d '{\"head\":\"head\",\"base\":\"base\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls \\\n  -d '{\"head\":\"head\",\"base\":\"base\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls \\\n -d '{\"head\":\"head\",\"base\":\"base\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls \\\n  -d '{\"head\":\"head\",\"base\":\"base\"}'
    " }, { "lang": "JavaScript", @@ -45878,7 +46128,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -45900,18 +46150,17 @@ }, { "name": "sort", - "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to).", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "created", - "updated" - ], - "default": "created" + "updated", + "created_at" + ] }, - "descriptionHTML": "

    One of created (when the repository was starred) or updated (when it was last pushed to).

    " + "descriptionHTML": "" }, { "name": "direction", @@ -45961,8 +46210,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/comments", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/comments
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/comments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/comments
    " }, { "lang": "JavaScript", @@ -46020,7 +46269,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -46054,8 +46303,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/comments/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/comments/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/comments/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/comments/42
    " }, { "lang": "JavaScript", @@ -46118,7 +46367,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -46152,8 +46401,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/comments/42 \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/comments/42 \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/comments/42 \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/comments/42 \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -46241,7 +46490,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -46275,8 +46524,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/comments/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/comments/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/comments/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/comments/42
    " }, { "lang": "JavaScript", @@ -46311,7 +46560,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -46325,7 +46574,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -46399,8 +46648,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/comments/42/reactions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/comments/42/reactions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/comments/42/reactions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/comments/42/reactions
    " }, { "lang": "JavaScript", @@ -46460,7 +46709,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -46494,8 +46743,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/comments/42/reactions \\\n -d '{\"content\":\"content\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/comments/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/comments/42/reactions \\\n -d '{\"content\":\"content\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/comments/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " }, { "lang": "JavaScript", @@ -46617,7 +46866,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -46650,8 +46899,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42
    " }, { "lang": "JavaScript", @@ -46709,7 +46958,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -46742,8 +46991,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42 \\\n -d '{\"title\":\"title\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42 \\\n  -d '{\"title\":\"title\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42 \\\n -d '{\"title\":\"title\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42 \\\n  -d '{\"title\":\"title\"}'
    " }, { "lang": "JavaScript", @@ -46924,7 +47173,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -47016,8 +47265,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/comments", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/comments
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/comments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/comments
    " }, { "lang": "JavaScript", @@ -47075,7 +47324,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -47108,8 +47357,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/comments \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/comments \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/comments \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/comments \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -47209,7 +47458,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -47252,8 +47501,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/comments/42/replies \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/comments/42/replies \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/comments/42/replies \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/comments/42/replies \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -47340,7 +47589,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/commits", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -47393,8 +47642,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/commits", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/commits
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/commits", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/commits
    " }, { "lang": "JavaScript", @@ -47437,7 +47686,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/files", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -47490,8 +47739,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/files", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/files
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/files", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/files
    " }, { "lang": "JavaScript", @@ -47544,7 +47793,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/merge", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -47577,8 +47826,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/merge", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/merge
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/merge", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/merge
    " }, { "lang": "JavaScript", @@ -47625,7 +47874,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/merge", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -47658,8 +47907,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/merge \\\n -d '{\"commit_title\":\"commit_title\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/merge \\\n  -d '{\"commit_title\":\"commit_title\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/merge \\\n -d '{\"commit_title\":\"commit_title\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/merge \\\n  -d '{\"commit_title\":\"commit_title\"}'
    " }, { "lang": "JavaScript", @@ -47824,7 +48073,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -47877,8 +48126,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/requested_reviewers", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/requested_reviewers
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/requested_reviewers", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/requested_reviewers
    " }, { "lang": "JavaScript", @@ -47923,7 +48172,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -47956,8 +48205,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/requested_reviewers \\\n -d '{\"reviewers\":[\"reviewers\"]}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/requested_reviewers \\\n  -d '{\"reviewers\":[\"reviewers\"]}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/requested_reviewers \\\n -d '{\"reviewers\":[\"reviewers\"]}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/requested_reviewers \\\n  -d '{\"reviewers\":[\"reviewers\"]}'
    " }, { "lang": "JavaScript", @@ -48094,7 +48343,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -48127,8 +48376,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/requested_reviewers \\\n -d '{\"reviewers\":[\"reviewers\"]}'", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/requested_reviewers \\\n  -d '{\"reviewers\":[\"reviewers\"]}'
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/requested_reviewers \\\n -d '{\"reviewers\":[\"reviewers\"]}'", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/requested_reviewers \\\n  -d '{\"reviewers\":[\"reviewers\"]}'
    " }, { "lang": "JavaScript", @@ -48250,7 +48499,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -48303,8 +48552,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/reviews
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews
    " }, { "lang": "JavaScript", @@ -48349,7 +48598,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -48382,8 +48631,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews \\\n -d '{\"commit_id\":\"commit_id\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/reviews \\\n  -d '{\"commit_id\":\"commit_id\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews \\\n -d '{\"commit_id\":\"commit_id\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews \\\n  -d '{\"commit_id\":\"commit_id\"}'
    " }, { "lang": "JavaScript", @@ -48831,7 +49080,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -48874,8 +49123,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews/42
    " }, { "lang": "JavaScript", @@ -48925,7 +49174,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -48968,8 +49217,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42 \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42 \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews/42 \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews/42 \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -49055,7 +49304,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -49098,8 +49347,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews/42
    " }, { "lang": "JavaScript", @@ -49154,7 +49403,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -49217,8 +49466,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42/comments", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42/comments
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews/42/comments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews/42/comments
    " }, { "lang": "JavaScript", @@ -49268,7 +49517,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -49311,8 +49560,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42/dismissals \\\n -d '{\"message\":\"message\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42/dismissals \\\n  -d '{\"message\":\"message\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews/42/dismissals \\\n -d '{\"message\":\"message\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews/42/dismissals \\\n  -d '{\"message\":\"message\"}'
    " }, { "lang": "JavaScript", @@ -49418,7 +49667,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -49461,8 +49710,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42/events \\\n -d '{\"event\":\"event\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42/events \\\n  -d '{\"event\":\"event\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews/42/events \\\n -d '{\"event\":\"event\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews/42/events \\\n  -d '{\"event\":\"event\"}'
    " }, { "lang": "JavaScript", @@ -49583,7 +49832,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/update-branch", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -49616,8 +49865,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.lydian-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/update-branch \\\n -d '{\"expected_head_sha\":\"expected_head_sha\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.lydian-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/update-branch \\\n  -d '{\"expected_head_sha\":\"expected_head_sha\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.lydian-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/update-branch \\\n -d '{\"expected_head_sha\":\"expected_head_sha\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.lydian-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/update-branch \\\n  -d '{\"expected_head_sha\":\"expected_head_sha\"}'
    " }, { "lang": "JavaScript", @@ -49716,7 +49965,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/readme", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -49750,8 +49999,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/readme", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/readme
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/readme", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/readme
    " }, { "lang": "JavaScript", @@ -49803,10 +50052,111 @@ } ] }, + { + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/readme/{dir}", + "serverUrl": "http(s)://{hostname}/api/v3", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "dir", + "description": "The alternate path to look for a README file", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true, + "descriptionHTML": "

    The alternate path to look for a README file

    " + }, + { + "name": "ref", + "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    The name of the commit/branch/tag. Default: the repository’s default branch (usually master)

    " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/readme/DIR", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/readme/DIR
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /repos/{owner}/{repo}/readme/{dir}', {\n owner: 'octocat',\n repo: 'hello-world',\n dir: 'dir'\n})", + "html": "
    await octokit.request('GET /repos/{owner}/{repo}/readme/{dir}', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  dir: 'dir'\n})\n
    " + } + ], + "summary": "Get a repository README", + "description": "Gets the preferred README for a repository.\n\nREADMEs support [custom media types](https://docs.github.com/enterprise-server@2.18/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML.", + "tags": [ + "repos" + ], + "operationId": "repos/get-readme-from-alt-path", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#get-a-repository-readme" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "contents" + }, + "slug": "get-a-repository-readme", + "category": "repos", + "categoryLabel": "Repos", + "subcategory": "contents", + "subcategoryLabel": "Contents", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

    Gets the preferred README for a repository.

    \n

    READMEs support custom media types for retrieving the raw content or rendered HTML.

    ", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
    {\n  \"type\": \"file\",\n  \"encoding\": \"base64\",\n  \"size\": 5362,\n  \"name\": \"README.md\",\n  \"path\": \"README.md\",\n  \"content\": \"encoded content ...\",\n  \"sha\": \"3d21ec53a331a6f037a91c368710b99387d012c1\",\n  \"url\": \"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\n  \"git_url\": \"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\n  \"html_url\": \"https://github.com/octokit/octokit.rb/blob/master/README.md\",\n  \"download_url\": \"https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md\",\n  \"_links\": {\n    \"git\": \"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\n    \"self\": \"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\n    \"html\": \"https://github.com/octokit/octokit.rb/blob/master/README.md\"\n  }\n}\n
    " + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + } + ] + }, { "verb": "get", "requestPath": "/repos/{owner}/{repo}/releases", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -49850,8 +50200,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases
    " }, { "lang": "JavaScript", @@ -49901,7 +50251,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/releases", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -49925,8 +50275,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases \\\n -d '{\"tag_name\":\"tag_name\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases \\\n  -d '{\"tag_name\":\"tag_name\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases \\\n -d '{\"tag_name\":\"tag_name\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases \\\n  -d '{\"tag_name\":\"tag_name\"}'
    " }, { "lang": "JavaScript", @@ -50112,7 +50462,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/releases/assets/{asset_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -50146,8 +50496,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/assets/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases/assets/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/assets/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/assets/42
    " }, { "lang": "JavaScript", @@ -50207,7 +50557,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/releases/assets/{asset_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -50241,8 +50591,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/assets/42 \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases/assets/42 \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/assets/42 \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/assets/42 \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -50357,7 +50707,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/releases/assets/{asset_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -50391,8 +50741,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/assets/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases/assets/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/assets/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/assets/42
    " }, { "lang": "JavaScript", @@ -50427,7 +50777,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -50436,7 +50786,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/releases/latest", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -50460,8 +50810,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/latest", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases/latest
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/latest", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/latest
    " }, { "lang": "JavaScript", @@ -50506,7 +50856,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/releases/tags/{tag}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -50528,21 +50878,21 @@ }, { "name": "tag", - "description": "tag+ parameter", + "description": "tag parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    tag+ parameter

    " + "descriptionHTML": "

    tag parameter

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/tags/TAG", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases/tags/TAG
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/tags/TAG", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/tags/TAG
    " }, { "lang": "JavaScript", @@ -50592,7 +50942,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/releases/{release_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -50626,8 +50976,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/42
    " }, { "lang": "JavaScript", @@ -50677,7 +51027,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/releases/{release_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -50711,8 +51061,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/42 \\\n -d '{\"tag_name\":\"tag_name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases/42 \\\n  -d '{\"tag_name\":\"tag_name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/42 \\\n -d '{\"tag_name\":\"tag_name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/42 \\\n  -d '{\"tag_name\":\"tag_name\"}'
    " }, { "lang": "JavaScript", @@ -50885,7 +51235,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/releases/{release_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -50919,8 +51269,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/42
    " }, { "lang": "JavaScript", @@ -50955,7 +51305,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -50964,7 +51314,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/releases/{release_id}/assets", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -51018,8 +51368,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/42/assets", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases/42/assets
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/42/assets", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/42/assets
    " }, { "lang": "JavaScript", @@ -51064,7 +51414,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/releases/{release_id}/assets", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -51114,8 +51464,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/42/assets", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases/42/assets
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/42/assets", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/42/assets
    " }, { "lang": "JavaScript", @@ -51181,7 +51531,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/stargazers", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -51225,8 +51575,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/stargazers", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/stargazers
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/stargazers", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/stargazers
    " }, { "lang": "JavaScript", @@ -51276,7 +51626,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/stats/code_frequency", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -51300,8 +51650,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/stats/code_frequency", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/stats/code_frequency
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/stats/code_frequency", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/stats/code_frequency
    " }, { "lang": "JavaScript", @@ -51346,7 +51696,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/stats/commit_activity", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -51370,8 +51720,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/stats/commit_activity", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/stats/commit_activity
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/stats/commit_activity", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/stats/commit_activity
    " }, { "lang": "JavaScript", @@ -51416,7 +51766,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/stats/contributors", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -51440,8 +51790,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/stats/contributors", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/stats/contributors
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/stats/contributors", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/stats/contributors
    " }, { "lang": "JavaScript", @@ -51486,7 +51836,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/stats/participation", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -51510,8 +51860,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/stats/participation", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/stats/participation
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/stats/participation", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/stats/participation
    " }, { "lang": "JavaScript", @@ -51561,7 +51911,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/stats/punch_card", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -51585,8 +51935,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/stats/punch_card", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/stats/punch_card
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/stats/punch_card", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/stats/punch_card
    " }, { "lang": "JavaScript", @@ -51631,7 +51981,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/statuses/{sha}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -51665,8 +52015,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/statuses/SHA \\\n -d '{\"state\":\"state\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/statuses/SHA \\\n  -d '{\"state\":\"state\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/statuses/SHA \\\n -d '{\"state\":\"state\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/statuses/SHA \\\n  -d '{\"state\":\"state\"}'
    " }, { "lang": "JavaScript", @@ -51818,7 +52168,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/subscribers", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -51862,8 +52212,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/subscribers", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/subscribers
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/subscribers", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/subscribers
    " }, { "lang": "JavaScript", @@ -51908,7 +52258,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/subscription", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -51932,8 +52282,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/subscription", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/subscription
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/subscription", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/subscription
    " }, { "lang": "JavaScript", @@ -51988,7 +52338,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/subscription", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -52012,8 +52362,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/subscription \\\n -d '{\"subscribed\":true}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/subscription \\\n  -d '{\"subscribed\":true}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/subscription \\\n -d '{\"subscribed\":true}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/subscription \\\n  -d '{\"subscribed\":true}'
    " }, { "lang": "JavaScript", @@ -52106,7 +52456,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/subscription", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -52130,8 +52480,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/subscription", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/subscription
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/subscription", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/subscription
    " }, { "lang": "JavaScript", @@ -52166,7 +52516,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -52175,7 +52525,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/tags", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -52219,8 +52569,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/tags", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/tags
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/tags", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/tags
    " }, { "lang": "JavaScript", @@ -52263,7 +52613,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/tarball/{ref}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -52296,8 +52646,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/tarball/REF", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/tarball/REF
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/tarball/REF", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/tarball/REF
    " }, { "lang": "JavaScript", @@ -52341,7 +52691,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/teams", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -52385,8 +52735,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/teams", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/teams
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/teams", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/teams
    " }, { "lang": "JavaScript", @@ -52429,7 +52779,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/topics", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -52448,13 +52798,33 @@ "type": "string" }, "descriptionHTML": "" + }, + { + "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.

    " + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "descriptionHTML": "

    Results per page (max 100).

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/topics", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/topics
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/topics", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/topics
    " }, { "lang": "JavaScript", @@ -52514,7 +52884,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/topics", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -52538,8 +52908,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/topics \\\n -d '{\"names\":[\"names\"]}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/topics \\\n  -d '{\"names\":[\"names\"]}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/topics \\\n -d '{\"names\":[\"names\"]}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/topics \\\n  -d '{\"names\":[\"names\"]}'
    " }, { "lang": "JavaScript", @@ -52651,7 +53021,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/transfer", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -52675,8 +53045,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/transfer \\\n -d '{\"new_owner\":\"new_owner\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/transfer \\\n  -d '{\"new_owner\":\"new_owner\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/transfer \\\n -d '{\"new_owner\":\"new_owner\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/transfer \\\n  -d '{\"new_owner\":\"new_owner\"}'
    " }, { "lang": "JavaScript", @@ -52783,7 +53153,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/vulnerability-alerts", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -52807,8 +53177,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/vulnerability-alerts", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/vulnerability-alerts
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/vulnerability-alerts", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/vulnerability-alerts
    " }, { "lang": "JavaScript", @@ -52848,7 +53218,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -52857,7 +53227,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/vulnerability-alerts", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -52881,8 +53251,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/vulnerability-alerts", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/vulnerability-alerts
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/vulnerability-alerts", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/vulnerability-alerts
    " }, { "lang": "JavaScript", @@ -52922,7 +53292,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -52931,7 +53301,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/zipball/{ref}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -52964,8 +53334,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/zipball/REF", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/zipball/REF
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/zipball/REF", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/zipball/REF
    " }, { "lang": "JavaScript", @@ -53009,7 +53379,7 @@ { "verb": "post", "requestPath": "/repos/{template_owner}/{template_repo}/generate", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "template_owner", @@ -53033,8 +53403,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.baptiste-preview+json\" \\\n https://api.github.com/repos/TEMPLATE_OWNER/TEMPLATE_REPO/generate \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.baptiste-preview+json\" \\\n  https://api.github.com/repos/TEMPLATE_OWNER/TEMPLATE_REPO/generate \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.baptiste-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/TEMPLATE_OWNER/TEMPLATE_REPO/generate \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.baptiste-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/TEMPLATE_OWNER/TEMPLATE_REPO/generate \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -53043,7 +53413,7 @@ } ], "summary": "Create a repository using a template", - "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@2.18/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", + "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@2.18/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository", "tags": [ "repos" ], @@ -53138,7 +53508,7 @@ "category": "repos", "categoryLabel": "Repos", "notes": [], - "descriptionHTML": "

    Creates a new repository using a repository template. Use the template_owner and template_repo route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the Get a repository endpoint and check that the is_template key is true.

    \n

    OAuth scope requirements

    \n

    When using OAuth, authorizations must include:

    \n
      \n
    • public_repo scope or repo scope to create a public repository
    • \n
    • repo scope to create a private repository
    • \n
    ", + "descriptionHTML": "

    Creates a new repository using a repository template. Use the template_owner and template_repo route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the Get a repository endpoint and check that the is_template key is true.

    \n

    OAuth scope requirements

    \n

    When using OAuth, authorizations must include:

    \n
      \n
    • public_repo scope or repo scope to create a public repository. Note: For GitHub AE, use repo scope to create an internal repository.
    • \n
    • repo scope to create a private repository
    • \n
    ", "bodyParameters": [ { "type": "string", @@ -53200,7 +53570,7 @@ { "verb": "get", "requestPath": "/repositories", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "since", @@ -53214,7 +53584,7 @@ }, { "name": "visibility", - "description": "Specifies the types of repositories to return. Can be one of `all` or `public`. Default: `public`.", + "description": "Specifies the types of repositories to return. Can be one of `all` or `public`. Default: `public`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise.", "in": "query", "required": false, "schema": { @@ -53226,14 +53596,14 @@ "public" ] }, - "descriptionHTML": "

    Specifies the types of repositories to return. Can be one of all or public. Default: public.

    " + "descriptionHTML": "

    Specifies the types of repositories to return. Can be one of all or public. Default: public. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise.

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repositories", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repositories
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repositories", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repositories
    " }, { "lang": "JavaScript", @@ -53242,7 +53612,7 @@ } ], "summary": "List public repositories", - "description": "Lists all public repositories in the order that they were created.\n\nNote: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.", + "description": "Lists all public repositories in the order that they were created.\n\nNotes:\n- For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise.\n- Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.", "tags": [ "repos" ], @@ -53263,7 +53633,7 @@ "categoryLabel": "Repos", "notes": [], "bodyParameters": [], - "descriptionHTML": "

    Lists all public repositories in the order that they were created.

    \n

    Note: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of repositories.

    ", + "descriptionHTML": "

    Lists all public repositories in the order that they were created.

    \n

    Notes:

    \n
      \n
    • For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise.
    • \n
    • Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of repositories.
    • \n
    ", "responses": [ { "httpStatusCode": "200", @@ -53286,7 +53656,7 @@ { "verb": "get", "requestPath": "/search/code", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "q", @@ -53350,8 +53720,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/search/code", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/search/code
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/search/code", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/search/code
    " }, { "lang": "JavaScript", @@ -53414,7 +53784,7 @@ { "verb": "get", "requestPath": "/search/commits", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "q", @@ -53479,8 +53849,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.cloak-preview+json\" \\\n https://api.github.com/search/commits", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.cloak-preview+json\" \\\n  https://api.github.com/search/commits
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.cloak-preview+json\" \\\n http(s)://{hostname}/api/v3/search/commits", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.cloak-preview+json\" \\\n  http(s)://{hostname}/api/v3/search/commits
    " }, { "lang": "JavaScript", @@ -53540,7 +53910,7 @@ { "verb": "get", "requestPath": "/search/issues", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "q", @@ -53614,8 +53984,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/search/issues", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/search/issues
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/search/issues", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/search/issues
    " }, { "lang": "JavaScript", @@ -53678,7 +54048,7 @@ { "verb": "get", "requestPath": "/search/labels", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "repository_id", @@ -53733,8 +54103,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/search/labels", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/search/labels
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/search/labels", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/search/labels
    " }, { "lang": "JavaScript", @@ -53797,7 +54167,7 @@ { "verb": "get", "requestPath": "/search/repositories", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "q", @@ -53864,8 +54234,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/search/repositories", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/search/repositories
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/search/repositories", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/search/repositories
    " }, { "lang": "JavaScript", @@ -53930,7 +54300,7 @@ { "verb": "get", "requestPath": "/search/topics", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "q", @@ -53946,8 +54316,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n https://api.github.com/search/topics", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n  https://api.github.com/search/topics
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n http(s)://{hostname}/api/v3/search/topics", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n  http(s)://{hostname}/api/v3/search/topics
    " }, { "lang": "JavaScript", @@ -54007,7 +54377,7 @@ { "verb": "get", "requestPath": "/search/users", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "q", @@ -54073,8 +54443,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/search/users", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/search/users
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/search/users", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/search/users
    " }, { "lang": "JavaScript", @@ -54132,13 +54502,13 @@ { "verb": "get", "requestPath": "/setup/api/configcheck", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/configcheck", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/setup/api/configcheck
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/setup/api/configcheck", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/setup/api/configcheck
    " }, { "lang": "JavaScript", @@ -54183,13 +54553,13 @@ { "verb": "post", "requestPath": "/setup/api/configure", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/configure", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/setup/api/configure
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/setup/api/configure", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/setup/api/configure
    " }, { "lang": "JavaScript", @@ -54233,13 +54603,13 @@ { "verb": "get", "requestPath": "/setup/api/maintenance", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/maintenance", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/setup/api/maintenance
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/setup/api/maintenance", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/setup/api/maintenance
    " }, { "lang": "JavaScript", @@ -54284,13 +54654,13 @@ { "verb": "post", "requestPath": "/setup/api/maintenance", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/maintenance \\\n -d '{\"maintenance\":\"maintenance\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/setup/api/maintenance \\\n  -d '{\"maintenance\":\"maintenance\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/setup/api/maintenance \\\n -d '{\"maintenance\":\"maintenance\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/setup/api/maintenance \\\n  -d '{\"maintenance\":\"maintenance\"}'
    " }, { "lang": "JavaScript", @@ -54368,13 +54738,13 @@ { "verb": "get", "requestPath": "/setup/api/settings", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/settings", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/setup/api/settings
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/setup/api/settings", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/setup/api/settings
    " }, { "lang": "JavaScript", @@ -54419,13 +54789,13 @@ { "verb": "put", "requestPath": "/setup/api/settings", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/settings \\\n -d '{\"settings\":\"settings\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/setup/api/settings \\\n  -d '{\"settings\":\"settings\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/setup/api/settings \\\n -d '{\"settings\":\"settings\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/setup/api/settings \\\n  -d '{\"settings\":\"settings\"}'
    " }, { "lang": "JavaScript", @@ -54483,7 +54853,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "descriptionHTML": "

    For a list of the available settings, see the Get settings endpoint.

    ", @@ -54502,13 +54872,13 @@ { "verb": "get", "requestPath": "/setup/api/settings/authorized-keys", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/settings/authorized-keys", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/setup/api/settings/authorized-keys
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/setup/api/settings/authorized-keys", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/setup/api/settings/authorized-keys
    " }, { "lang": "JavaScript", @@ -54553,13 +54923,13 @@ { "verb": "post", "requestPath": "/setup/api/settings/authorized-keys", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/settings/authorized-keys \\\n -d '{\"authorized_key\":\"authorized_key\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/setup/api/settings/authorized-keys \\\n  -d '{\"authorized_key\":\"authorized_key\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/setup/api/settings/authorized-keys \\\n -d '{\"authorized_key\":\"authorized_key\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/setup/api/settings/authorized-keys \\\n  -d '{\"authorized_key\":\"authorized_key\"}'
    " }, { "lang": "JavaScript", @@ -54637,13 +55007,13 @@ { "verb": "delete", "requestPath": "/setup/api/settings/authorized-keys", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/settings/authorized-keys \\\n -d '{\"authorized_key\":\"authorized_key\"}'", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/setup/api/settings/authorized-keys \\\n  -d '{\"authorized_key\":\"authorized_key\"}'
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/setup/api/settings/authorized-keys \\\n -d '{\"authorized_key\":\"authorized_key\"}'", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/setup/api/settings/authorized-keys \\\n  -d '{\"authorized_key\":\"authorized_key\"}'
    " }, { "lang": "JavaScript", @@ -54721,13 +55091,13 @@ { "verb": "post", "requestPath": "/setup/api/start", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/start \\\n -d '{\"license\":\"license\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/setup/api/start \\\n  -d '{\"license\":\"license\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/setup/api/start \\\n -d '{\"license\":\"license\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/setup/api/start \\\n  -d '{\"license\":\"license\"}'
    " }, { "lang": "JavaScript", @@ -54840,13 +55210,13 @@ { "verb": "post", "requestPath": "/setup/api/upgrade", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/upgrade \\\n -d '{\"license\":\"license\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/setup/api/upgrade \\\n  -d '{\"license\":\"license\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/setup/api/upgrade \\\n -d '{\"license\":\"license\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/setup/api/upgrade \\\n  -d '{\"license\":\"license\"}'
    " }, { "lang": "JavaScript", @@ -54920,7 +55290,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -54935,8 +55305,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42
    " }, { "lang": "JavaScript", @@ -54986,7 +55356,7 @@ { "verb": "patch", "requestPath": "/teams/{team_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -55001,8 +55371,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42 \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42 \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42 \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42 \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -55181,7 +55551,7 @@ { "verb": "delete", "requestPath": "/teams/{team_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -55196,8 +55566,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42
    " }, { "lang": "JavaScript", @@ -55237,7 +55607,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -55246,7 +55616,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/discussions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -55307,8 +55677,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.echo-preview+json\" \\\n https://api.github.com/teams/42/discussions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.echo-preview+json\" \\\n  https://api.github.com/teams/42/discussions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.echo-preview+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.echo-preview+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions
    " }, { "lang": "JavaScript", @@ -55366,7 +55736,7 @@ { "verb": "post", "requestPath": "/teams/{team_id}/discussions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -55392,8 +55762,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.echo-preview+json\" \\\n https://api.github.com/teams/42/discussions \\\n -d '{\"title\":\"title\",\"body\":\"body\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.echo-preview+json\" \\\n  https://api.github.com/teams/42/discussions \\\n  -d '{\"title\":\"title\",\"body\":\"body\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.echo-preview+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions \\\n -d '{\"title\":\"title\",\"body\":\"body\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.echo-preview+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions \\\n  -d '{\"title\":\"title\",\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -55528,7 +55898,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/discussions/{discussion_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -55563,8 +55933,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.echo-preview+json\" \\\n https://api.github.com/teams/42/discussions/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.echo-preview+json\" \\\n  https://api.github.com/teams/42/discussions/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.echo-preview+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.echo-preview+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions/42
    " }, { "lang": "JavaScript", @@ -55622,7 +55992,7 @@ { "verb": "patch", "requestPath": "/teams/{team_id}/discussions/{discussion_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -55657,8 +56027,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.echo-preview+json\" \\\n https://api.github.com/teams/42/discussions/42 \\\n -d '{\"title\":\"title\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.echo-preview+json\" \\\n  https://api.github.com/teams/42/discussions/42 \\\n  -d '{\"title\":\"title\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.echo-preview+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions/42 \\\n -d '{\"title\":\"title\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.echo-preview+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions/42 \\\n  -d '{\"title\":\"title\"}'
    " }, { "lang": "JavaScript", @@ -55767,7 +56137,7 @@ { "verb": "delete", "requestPath": "/teams/{team_id}/discussions/{discussion_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -55802,8 +56172,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.echo-preview+json\" \\\n https://api.github.com/teams/42/discussions/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.echo-preview+json\" \\\n  https://api.github.com/teams/42/discussions/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.echo-preview+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.echo-preview+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions/42
    " }, { "lang": "JavaScript", @@ -55845,7 +56215,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -55854,7 +56224,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -55924,8 +56294,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.echo-preview+json\" \\\n https://api.github.com/teams/42/discussions/42/comments", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.echo-preview+json\" \\\n  https://api.github.com/teams/42/discussions/42/comments
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.echo-preview+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions/42/comments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.echo-preview+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions/42/comments
    " }, { "lang": "JavaScript", @@ -55983,7 +56353,7 @@ { "verb": "post", "requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -56018,8 +56388,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.echo-preview+json\" \\\n https://api.github.com/teams/42/discussions/42/comments \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.echo-preview+json\" \\\n  https://api.github.com/teams/42/discussions/42/comments \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.echo-preview+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions/42/comments \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.echo-preview+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions/42/comments \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -56114,7 +56484,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -56158,8 +56528,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.echo-preview+json\" \\\n https://api.github.com/teams/42/discussions/42/comments/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.echo-preview+json\" \\\n  https://api.github.com/teams/42/discussions/42/comments/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.echo-preview+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions/42/comments/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.echo-preview+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions/42/comments/42
    " }, { "lang": "JavaScript", @@ -56217,7 +56587,7 @@ { "verb": "patch", "requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -56261,8 +56631,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.echo-preview+json\" \\\n https://api.github.com/teams/42/discussions/42/comments/42 \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.echo-preview+json\" \\\n  https://api.github.com/teams/42/discussions/42/comments/42 \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.echo-preview+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions/42/comments/42 \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.echo-preview+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions/42/comments/42 \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -56356,7 +56726,7 @@ { "verb": "delete", "requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -56400,8 +56770,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.echo-preview+json\" \\\n https://api.github.com/teams/42/discussions/42/comments/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.echo-preview+json\" \\\n  https://api.github.com/teams/42/discussions/42/comments/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.echo-preview+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions/42/comments/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.echo-preview+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions/42/comments/42
    " }, { "lang": "JavaScript", @@ -56443,7 +56813,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -56452,7 +56822,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -56536,8 +56906,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.echo-preview+json\" \\\n https://api.github.com/teams/42/discussions/42/comments/42/reactions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.echo-preview+json\" \\\n  https://api.github.com/teams/42/discussions/42/comments/42/reactions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.echo-preview+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions/42/comments/42/reactions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.echo-preview+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions/42/comments/42/reactions
    " }, { "lang": "JavaScript", @@ -56593,7 +56963,7 @@ { "verb": "post", "requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -56637,8 +57007,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.echo-preview+json\" \\\n https://api.github.com/teams/42/discussions/42/comments/42/reactions \\\n -d '{\"content\":\"content\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.echo-preview+json\" \\\n  https://api.github.com/teams/42/discussions/42/comments/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.echo-preview+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions/42/comments/42/reactions \\\n -d '{\"content\":\"content\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.echo-preview+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions/42/comments/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " }, { "lang": "JavaScript", @@ -56750,7 +57120,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/discussions/{discussion_number}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -56825,8 +57195,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.echo-preview+json\" \\\n https://api.github.com/teams/42/discussions/42/reactions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.echo-preview+json\" \\\n  https://api.github.com/teams/42/discussions/42/reactions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.echo-preview+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions/42/reactions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.echo-preview+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions/42/reactions
    " }, { "lang": "JavaScript", @@ -56882,7 +57252,7 @@ { "verb": "post", "requestPath": "/teams/{team_id}/discussions/{discussion_number}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -56917,8 +57287,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.echo-preview+json\" \\\n https://api.github.com/teams/42/discussions/42/reactions \\\n -d '{\"content\":\"content\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.echo-preview+json\" \\\n  https://api.github.com/teams/42/discussions/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.echo-preview+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions/42/reactions \\\n -d '{\"content\":\"content\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.echo-preview+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " }, { "lang": "JavaScript", @@ -57030,7 +57400,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/members", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -57081,8 +57451,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/members", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/members
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/members", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/members
    " }, { "lang": "JavaScript", @@ -57134,7 +57504,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/members/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -57158,8 +57528,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/members/USERNAME", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/members/USERNAME
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/members/USERNAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/members/USERNAME
    " }, { "lang": "JavaScript", @@ -57211,7 +57581,7 @@ { "verb": "put", "requestPath": "/teams/{team_id}/members/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -57235,8 +57605,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/members/USERNAME", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/members/USERNAME
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/members/USERNAME", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/members/USERNAME
    " }, { "lang": "JavaScript", @@ -57270,13 +57640,11 @@ "subcategory": "members", "subcategoryLabel": "Members", "notes": [], - "bodyParameters": [], - "descriptionHTML": "

    The \"Add team member\" endpoint (described below) is deprecated.

    \n

    We recommend using the Add or update team membership for a user endpoint instead. It allows you to invite new organization members to your teams.

    \n

    Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

    \n

    To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.

    \n

    Note: When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"

    \n

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

    ", "responses": [ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -57291,21 +57659,16 @@ { "httpStatusCode": "422", "httpStatusMessage": "Unprocessable Entity", - "description": "Response if you attempt to add an organization to a team", - "payload": "
    {\n  \"message\": \"Cannot add an organization as a member.\",\n  \"errors\": [\n    {\n      \"code\": \"org\",\n      \"field\": \"user\",\n      \"resource\": \"TeamMember\"\n    }\n  ]\n}\n
    " - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Response if you attempt to add a user to a team when they are not a member of at least one other team in the same organization", - "payload": "
    {\n  \"message\": \"User isn't a member of this organization. Please invite them first.\",\n  \"errors\": [\n    {\n      \"code\": \"unaffiliated\",\n      \"field\": \"user\",\n      \"resource\": \"TeamMember\"\n    }\n  ]\n}\n
    " + "description": "Response if you attempt to add an organization to a team or you attempt to add a user to a team when they are not a member of at least one other team in the same organization" } - ] + ], + "bodyParameters": [], + "descriptionHTML": "

    The \"Add team member\" endpoint (described below) is deprecated.

    \n

    We recommend using the Add or update team membership for a user endpoint instead. It allows you to invite new organization members to your teams.

    \n

    Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

    \n

    To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.

    \n

    Note: When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"

    \n

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

    " }, { "verb": "delete", "requestPath": "/teams/{team_id}/members/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -57329,8 +57692,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/members/USERNAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/members/USERNAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/members/USERNAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/members/USERNAME
    " }, { "lang": "JavaScript", @@ -57368,7 +57731,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -57382,7 +57745,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/memberships/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -57406,8 +57769,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/memberships/USERNAME", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/memberships/USERNAME
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/memberships/USERNAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/memberships/USERNAME
    " }, { "lang": "JavaScript", @@ -57416,7 +57779,7 @@ } ], "summary": "Get team membership for a user", - "description": "If you pass the `hellcat-preview` media type, team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:** The `role` for organization owners returns as `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@2.18/rest/reference/teams#create-a-team).", + "description": "If you pass the `hellcat-preview` media type, team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:**\nThe response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@2.18/rest/reference/teams#create-a-team).", "operationId": "teams/get-membership-for-user", "tags": [ "teams" @@ -57446,32 +57809,20 @@ "subcategoryLabel": "Members", "notes": [], "bodyParameters": [], - "descriptionHTML": "

    If you pass the hellcat-preview media type, team members will include the members of child teams.

    \n

    To get a user's membership with a team, the team must be visible to the authenticated user.

    \n

    Note: The role for organization owners returns as maintainer. For more information about maintainer roles, see Create a team.

    ", + "descriptionHTML": "

    If you pass the hellcat-preview media type, team members will include the members of child teams.

    \n

    To get a user's membership with a team, the team must be visible to the authenticated user.

    \n

    Note:\nThe response contains the state of the membership and the member's role.

    \n

    The role for organization owners is set to maintainer. For more information about maintainer roles, see Create a team.

    ", "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response if user has an active membership with team", - "payload": "
    {\n  \"url\": \"https://api.github.com/teams/1/memberships/octocat\",\n  \"role\": \"member\",\n  \"state\": \"active\"\n}\n
    " - }, { "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Response if user is a team maintainer", "payload": "
    {\n  \"url\": \"https://api.github.com/teams/1/memberships/octocat\",\n  \"role\": \"maintainer\",\n  \"state\": \"active\"\n}\n
    " - }, - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response if user has a pending membership with team", - "payload": "
    {\n  \"url\": \"https://api.github.com/teams/1/memberships/octocat\",\n  \"role\": \"member\",\n  \"state\": \"pending\"\n}\n
    " } ] }, { "verb": "put", "requestPath": "/teams/{team_id}/memberships/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -57495,8 +57846,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/memberships/USERNAME \\\n -d '{\"role\":\"role\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/memberships/USERNAME \\\n  -d '{\"role\":\"role\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/memberships/USERNAME \\\n -d '{\"role\":\"role\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/memberships/USERNAME \\\n  -d '{\"role\":\"role\"}'
    " }, { "lang": "JavaScript", @@ -57570,12 +57921,6 @@ } ], "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response if user's membership with team is now active", - "payload": "
    {\n  \"url\": \"https://api.github.com/teams/1/memberships/octocat\",\n  \"role\": \"member\",\n  \"state\": \"active\"\n}\n
    " - }, { "httpStatusCode": "200", "httpStatusMessage": "OK", @@ -57585,15 +57930,14 @@ { "httpStatusCode": "422", "httpStatusMessage": "Unprocessable Entity", - "description": "Response if you attempt to add an organization to a team", - "payload": "
    {\n  \"message\": \"Cannot add an organization as a member.\",\n  \"errors\": [\n    {\n      \"code\": \"org\",\n      \"field\": \"user\",\n      \"resource\": \"TeamMember\"\n    }\n  ]\n}\n
    " + "description": "Response if you attempt to add an organization to a team" } ] }, { "verb": "delete", "requestPath": "/teams/{team_id}/memberships/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -57617,8 +57961,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/memberships/USERNAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/memberships/USERNAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/memberships/USERNAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/memberships/USERNAME
    " }, { "lang": "JavaScript", @@ -57653,7 +57997,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -57662,7 +58006,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/projects", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -57708,8 +58052,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/teams/42/projects", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/teams/42/projects
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/teams/42/projects", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/projects
    " }, { "lang": "JavaScript", @@ -57765,7 +58109,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/projects/{project_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -57800,8 +58144,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/teams/42/projects/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/teams/42/projects/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/teams/42/projects/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/projects/42
    " }, { "lang": "JavaScript", @@ -57862,7 +58206,7 @@ { "verb": "put", "requestPath": "/teams/{team_id}/projects/{project_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -57897,8 +58241,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/teams/42/projects/42 \\\n -d '{\"permission\":\"permission\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/teams/42/projects/42 \\\n  -d '{\"permission\":\"permission\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/teams/42/projects/42 \\\n -d '{\"permission\":\"permission\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/projects/42 \\\n  -d '{\"permission\":\"permission\"}'
    " }, { "lang": "JavaScript", @@ -57987,7 +58331,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -58000,7 +58344,7 @@ { "verb": "delete", "requestPath": "/teams/{team_id}/projects/{project_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -58024,8 +58368,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/projects/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/projects/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/projects/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/projects/42
    " }, { "lang": "JavaScript", @@ -58058,7 +58402,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -58067,7 +58411,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/repos", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -58102,8 +58446,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/repos", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/repos
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/repos", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/repos
    " }, { "lang": "JavaScript", @@ -58153,7 +58497,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/repos/{owner}/{repo}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -58186,8 +58530,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/repos/octocat/hello-world", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/repos/octocat/hello-world
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/repos/octocat/hello-world", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/repos/octocat/hello-world
    " }, { "lang": "JavaScript", @@ -58246,7 +58590,7 @@ { "verb": "put", "requestPath": "/teams/{team_id}/repos/{owner}/{repo}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -58279,8 +58623,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/repos/octocat/hello-world \\\n -d '{\"permission\":\"permission\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/repos/octocat/hello-world \\\n  -d '{\"permission\":\"permission\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/repos/octocat/hello-world \\\n -d '{\"permission\":\"permission\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/repos/octocat/hello-world \\\n  -d '{\"permission\":\"permission\"}'
    " }, { "lang": "JavaScript", @@ -58345,7 +58689,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "descriptionHTML": "

    To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a 422 Unprocessable Entity status if you attempt to add a repository to a team that is not owned by the 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.\"

    ", @@ -58369,7 +58713,7 @@ { "verb": "delete", "requestPath": "/teams/{team_id}/repos/{owner}/{repo}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -58402,8 +58746,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/repos/octocat/hello-world", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/repos/octocat/hello-world
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/repos/octocat/hello-world", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/repos/octocat/hello-world
    " }, { "lang": "JavaScript", @@ -58436,7 +58780,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -58445,7 +58789,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/teams", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -58480,8 +58824,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/teams", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/teams
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/teams", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/teams
    " }, { "lang": "JavaScript", @@ -58531,13 +58875,13 @@ { "verb": "get", "requestPath": "/user", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user
    " }, { "lang": "JavaScript", @@ -58601,13 +58945,13 @@ { "verb": "patch", "requestPath": "/user", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -58845,7 +59189,7 @@ { "verb": "get", "requestPath": "/user/emails", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -58871,8 +59215,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/emails", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/emails
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/emails", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/emails
    " }, { "lang": "JavaScript", @@ -58937,13 +59281,13 @@ { "verb": "post", "requestPath": "/user/emails", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/emails \\\n -d '{\"emails\":[\"octocat@github.com\"]}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/emails \\\n  -d '{\"emails\":[\"octocat@github.com\"]}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/emails \\\n -d '{\"emails\":[\"octocat@github.com\"]}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/emails \\\n  -d '{\"emails\":[\"octocat@github.com\"]}'
    " }, { "lang": "JavaScript", @@ -59058,13 +59402,13 @@ { "verb": "delete", "requestPath": "/user/emails", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/emails \\\n -d '{\"emails\":[\"octocat@github.com\"]}'", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/emails \\\n  -d '{\"emails\":[\"octocat@github.com\"]}'
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/emails \\\n -d '{\"emails\":[\"octocat@github.com\"]}'", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/emails \\\n  -d '{\"emails\":[\"octocat@github.com\"]}'
    " }, { "lang": "JavaScript", @@ -59144,7 +59488,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -59178,7 +59522,7 @@ { "verb": "get", "requestPath": "/user/followers", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -59204,8 +59548,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/followers", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/followers
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/followers", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/followers
    " }, { "lang": "JavaScript", @@ -59265,7 +59609,7 @@ { "verb": "get", "requestPath": "/user/following", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -59291,8 +59635,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/following", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/following
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/following", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/following
    " }, { "lang": "JavaScript", @@ -59352,7 +59696,7 @@ { "verb": "get", "requestPath": "/user/following/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -59367,8 +59711,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/following/USERNAME", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/following/USERNAME
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/following/USERNAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/following/USERNAME
    " }, { "lang": "JavaScript", @@ -59432,7 +59776,7 @@ { "verb": "put", "requestPath": "/user/following/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -59447,8 +59791,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/following/USERNAME", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/following/USERNAME
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/following/USERNAME", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/following/USERNAME
    " }, { "lang": "JavaScript", @@ -59483,7 +59827,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -59512,7 +59856,7 @@ { "verb": "delete", "requestPath": "/user/following/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -59527,8 +59871,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/following/USERNAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/following/USERNAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/following/USERNAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/following/USERNAME
    " }, { "lang": "JavaScript", @@ -59563,7 +59907,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -59592,7 +59936,7 @@ { "verb": "get", "requestPath": "/user/gpg_keys", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -59618,8 +59962,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/gpg_keys", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/gpg_keys
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/gpg_keys", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/gpg_keys
    " }, { "lang": "JavaScript", @@ -59684,13 +60028,13 @@ { "verb": "post", "requestPath": "/user/gpg_keys", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/gpg_keys \\\n -d '{\"armored_public_key\":\"armored_public_key\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/gpg_keys \\\n  -d '{\"armored_public_key\":\"armored_public_key\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/gpg_keys \\\n -d '{\"armored_public_key\":\"armored_public_key\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/gpg_keys \\\n  -d '{\"armored_public_key\":\"armored_public_key\"}'
    " }, { "lang": "JavaScript", @@ -59793,7 +60137,7 @@ { "verb": "get", "requestPath": "/user/gpg_keys/{gpg_key_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gpg_key_id", @@ -59809,8 +60153,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/gpg_keys/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/gpg_keys/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/gpg_keys/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/gpg_keys/42
    " }, { "lang": "JavaScript", @@ -59875,7 +60219,7 @@ { "verb": "delete", "requestPath": "/user/gpg_keys/{gpg_key_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gpg_key_id", @@ -59891,8 +60235,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/gpg_keys/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/gpg_keys/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/gpg_keys/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/gpg_keys/42
    " }, { "lang": "JavaScript", @@ -59927,7 +60271,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -59961,7 +60305,7 @@ { "verb": "get", "requestPath": "/user/installations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -59998,8 +60342,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/user/installations", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  https://api.github.com/user/installations
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n http(s)://{hostname}/api/v3/user/installations", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  http(s)://{hostname}/api/v3/user/installations
    " }, { "lang": "JavaScript", @@ -60071,7 +60415,7 @@ { "verb": "get", "requestPath": "/user/installations/{installation_id}/repositories", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -60118,8 +60462,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/user/installations/42/repositories", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  https://api.github.com/user/installations/42/repositories
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n http(s)://{hostname}/api/v3/user/installations/42/repositories", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  http(s)://{hostname}/api/v3/user/installations/42/repositories
    " }, { "lang": "JavaScript", @@ -60192,7 +60536,7 @@ { "verb": "put", "requestPath": "/user/installations/{installation_id}/repositories/{repository_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "installation_id", @@ -60217,8 +60561,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/user/installations/42/repositories/42", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  https://api.github.com/user/installations/42/repositories/42
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n http(s)://{hostname}/api/v3/user/installations/42/repositories/42", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  http(s)://{hostname}/api/v3/user/installations/42/repositories/42
    " }, { "lang": "JavaScript", @@ -60260,7 +60604,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -60284,7 +60628,7 @@ { "verb": "delete", "requestPath": "/user/installations/{installation_id}/repositories/{repository_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "installation_id", @@ -60309,8 +60653,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/user/installations/42/repositories/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  https://api.github.com/user/installations/42/repositories/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n http(s)://{hostname}/api/v3/user/installations/42/repositories/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  http(s)://{hostname}/api/v3/user/installations/42/repositories/42
    " }, { "lang": "JavaScript", @@ -60352,7 +60696,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -60376,7 +60720,7 @@ { "verb": "get", "requestPath": "/user/issues", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "filter", @@ -60390,6 +60734,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -60487,8 +60832,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/issues", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/issues
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/issues", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/issues
    " }, { "lang": "JavaScript", @@ -60547,7 +60892,7 @@ { "verb": "get", "requestPath": "/user/keys", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -60573,8 +60918,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/keys", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/keys
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/keys", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/keys
    " }, { "lang": "JavaScript", @@ -60639,13 +60984,13 @@ { "verb": "post", "requestPath": "/user/keys", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/keys \\\n -d '{\"key\":\"key\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/keys \\\n  -d '{\"key\":\"key\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/keys \\\n -d '{\"key\":\"key\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/keys \\\n  -d '{\"key\":\"key\"}'
    " }, { "lang": "JavaScript", @@ -60770,7 +61115,7 @@ { "verb": "get", "requestPath": "/user/keys/{key_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "key_id", @@ -60786,8 +61131,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/keys/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/keys/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/keys/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/keys/42
    " }, { "lang": "JavaScript", @@ -60852,7 +61197,7 @@ { "verb": "delete", "requestPath": "/user/keys/{key_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "key_id", @@ -60868,8 +61213,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/keys/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/keys/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/keys/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/keys/42
    " }, { "lang": "JavaScript", @@ -60904,7 +61249,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -60933,7 +61278,7 @@ { "verb": "get", "requestPath": "/user/memberships/orgs", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "state", @@ -60973,8 +61318,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/memberships/orgs", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/memberships/orgs
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/memberships/orgs", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/memberships/orgs
    " }, { "lang": "JavaScript", @@ -61039,7 +61384,7 @@ { "verb": "get", "requestPath": "/user/memberships/orgs/{org}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -61054,8 +61399,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/memberships/orgs/ORG", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/memberships/orgs/ORG
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/memberships/orgs/ORG", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/memberships/orgs/ORG
    " }, { "lang": "JavaScript", @@ -61110,7 +61455,7 @@ { "verb": "patch", "requestPath": "/user/memberships/orgs/{org}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -61125,8 +61470,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/memberships/orgs/ORG \\\n -d '{\"state\":\"state\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/memberships/orgs/ORG \\\n  -d '{\"state\":\"state\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/memberships/orgs/ORG \\\n -d '{\"state\":\"state\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/memberships/orgs/ORG \\\n  -d '{\"state\":\"state\"}'
    " }, { "lang": "JavaScript", @@ -61228,7 +61573,7 @@ { "verb": "get", "requestPath": "/user/orgs", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -61254,8 +61599,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/orgs", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/orgs
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/orgs", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/orgs
    " }, { "lang": "JavaScript", @@ -61313,13 +61658,13 @@ { "verb": "post", "requestPath": "/user/projects", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/user/projects \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/user/projects \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/user/projects \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/user/projects \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -61451,7 +61796,7 @@ { "verb": "get", "requestPath": "/user/public_emails", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -61477,8 +61822,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/public_emails", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/public_emails
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/public_emails", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/public_emails
    " }, { "lang": "JavaScript", @@ -61543,11 +61888,11 @@ { "verb": "get", "requestPath": "/user/repos", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "visibility", - "description": "Can be one of `all`, `public`, or `private`.", + "description": "Can be one of `all`, `public`, or `private`. Note: For GitHub AE, can be one of `all`, `internal`, or `private`.", "in": "query", "required": false, "schema": { @@ -61559,7 +61904,7 @@ ], "default": "all" }, - "descriptionHTML": "

    Can be one of all, public, or private.

    " + "descriptionHTML": "

    Can be one of all, public, or private. Note: For GitHub AE, can be one of all, internal, or private.

    " }, { "name": "affiliation", @@ -61574,7 +61919,7 @@ }, { "name": "type", - "description": "Can be one of `all`, `owner`, `public`, `private`, `member`. Default: `all` \n \nWill cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.", + "description": "Can be one of `all`, `owner`, `public`, `private`, `member`. Note: For GitHub AE, can be one of `all`, `owner`, `internal`, `private`, `member`. Default: `all` \n \nWill cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.", "in": "query", "required": false, "schema": { @@ -61588,7 +61933,7 @@ ], "default": "all" }, - "descriptionHTML": "

    Can be one of all, owner, public, private, member. Default: all

    \n

    Will cause a 422 error if used in the same request as visibility or affiliation. Will cause a 422 error if used in the same request as visibility or affiliation.

    " + "descriptionHTML": "

    Can be one of all, owner, public, private, member. Note: For GitHub AE, can be one of all, owner, internal, private, member. Default: all

    \n

    Will cause a 422 error if used in the same request as visibility or affiliation. Will cause a 422 error if used in the same request as visibility or affiliation.

    " }, { "name": "sort", @@ -61665,8 +62010,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/repos", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/repos
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/repos", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/repos
    " }, { "lang": "JavaScript", @@ -61729,13 +62074,13 @@ { "verb": "post", "requestPath": "/user/repos", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/repos \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/repos \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/repos \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/repos \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -61744,7 +62089,7 @@ } ], "summary": "Create a repository for the authenticated user", - "description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", + "description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository.", "tags": [ "repos" ], @@ -61787,13 +62132,13 @@ "childParamsGroups": [] }, "private": { - "description": "

    Whether the repository is private or public.

    ", + "description": "

    Whether the repository is private.

    ", "default": false, "type": "boolean", "name": "private", "in": "body", "rawType": "boolean", - "rawDescription": "Whether the repository is private or public.", + "rawDescription": "Whether the repository is private.", "childParamsGroups": [] }, "has_issues": { @@ -61967,7 +62312,7 @@ "category": "repos", "categoryLabel": "Repos", "notes": [], - "descriptionHTML": "

    Creates a new repository for the authenticated user.

    \n

    OAuth scope requirements

    \n

    When using OAuth, authorizations must include:

    \n
      \n
    • public_repo scope or repo scope to create a public repository
    • \n
    • repo scope to create a private repository
    • \n
    ", + "descriptionHTML": "

    Creates a new repository for the authenticated user.

    \n

    OAuth scope requirements

    \n

    When using OAuth, authorizations must include:

    \n
      \n
    • public_repo scope or repo scope to create a public repository. Note: For GitHub AE, use repo scope to create an internal repository.
    • \n
    • repo scope to create a private repository.
    • \n
    ", "bodyParameters": [ { "description": "

    Required. The name of the repository.

    ", @@ -61998,13 +62343,13 @@ "childParamsGroups": [] }, { - "description": "

    Whether the repository is private or public.

    ", + "description": "

    Whether the repository is private.

    ", "default": false, "type": "boolean", "name": "private", "in": "body", "rawType": "boolean", - "rawDescription": "Whether the repository is private or public.", + "rawDescription": "Whether the repository is private.", "childParamsGroups": [] }, { @@ -62188,7 +62533,7 @@ { "verb": "get", "requestPath": "/user/repository_invitations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -62214,8 +62559,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/repository_invitations", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/repository_invitations
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/repository_invitations", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/repository_invitations
    " }, { "lang": "JavaScript", @@ -62280,7 +62625,7 @@ { "verb": "patch", "requestPath": "/user/repository_invitations/{invitation_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "invitation_id", @@ -62296,8 +62641,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/repository_invitations/42", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/repository_invitations/42
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/repository_invitations/42", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/repository_invitations/42
    " }, { "lang": "JavaScript", @@ -62332,7 +62677,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -62361,7 +62706,7 @@ { "verb": "delete", "requestPath": "/user/repository_invitations/{invitation_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "invitation_id", @@ -62377,8 +62722,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/repository_invitations/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/repository_invitations/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/repository_invitations/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/repository_invitations/42
    " }, { "lang": "JavaScript", @@ -62413,7 +62758,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -62442,7 +62787,7 @@ { "verb": "get", "requestPath": "/user/starred", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "sort", @@ -62498,8 +62843,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/starred", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/starred
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/starred", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/starred
    " }, { "lang": "JavaScript", @@ -62559,7 +62904,7 @@ { "verb": "get", "requestPath": "/user/starred/{owner}/{repo}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -62583,8 +62928,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/starred/octocat/hello-world", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/starred/octocat/hello-world
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/starred/octocat/hello-world", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/starred/octocat/hello-world
    " }, { "lang": "JavaScript", @@ -62648,7 +62993,7 @@ { "verb": "put", "requestPath": "/user/starred/{owner}/{repo}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -62672,8 +63017,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/starred/octocat/hello-world", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/starred/octocat/hello-world
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/starred/octocat/hello-world", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/starred/octocat/hello-world
    " }, { "lang": "JavaScript", @@ -62708,7 +63053,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -62737,7 +63082,7 @@ { "verb": "delete", "requestPath": "/user/starred/{owner}/{repo}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -62761,8 +63106,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/starred/octocat/hello-world", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/starred/octocat/hello-world
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/starred/octocat/hello-world", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/starred/octocat/hello-world
    " }, { "lang": "JavaScript", @@ -62797,7 +63142,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -62826,7 +63171,7 @@ { "verb": "get", "requestPath": "/user/subscriptions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -62852,8 +63197,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/subscriptions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/subscriptions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/subscriptions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/subscriptions
    " }, { "lang": "JavaScript", @@ -62913,7 +63258,7 @@ { "verb": "get", "requestPath": "/user/teams", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -62939,8 +63284,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/teams", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/teams
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/teams", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/teams
    " }, { "lang": "JavaScript", @@ -62998,7 +63343,7 @@ { "verb": "get", "requestPath": "/users", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "since", @@ -63024,8 +63369,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users
    " }, { "lang": "JavaScript", @@ -63073,7 +63418,7 @@ { "verb": "get", "requestPath": "/users/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -63088,8 +63433,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME
    " }, { "lang": "JavaScript", @@ -63143,7 +63488,7 @@ { "verb": "get", "requestPath": "/users/{username}/events", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -63178,8 +63523,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/events", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/events
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/events", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/events
    " }, { "lang": "JavaScript", @@ -63223,7 +63568,7 @@ { "verb": "get", "requestPath": "/users/{username}/events/orgs/{org}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -63267,8 +63612,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/events/orgs/ORG", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/events/orgs/ORG
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/events/orgs/ORG", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/events/orgs/ORG
    " }, { "lang": "JavaScript", @@ -63312,7 +63657,7 @@ { "verb": "get", "requestPath": "/users/{username}/events/public", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -63347,8 +63692,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/events/public", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/events/public
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/events/public", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/events/public
    " }, { "lang": "JavaScript", @@ -63392,7 +63737,7 @@ { "verb": "get", "requestPath": "/users/{username}/followers", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -63427,8 +63772,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/followers", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/followers
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/followers", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/followers
    " }, { "lang": "JavaScript", @@ -63473,7 +63818,7 @@ { "verb": "get", "requestPath": "/users/{username}/following", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -63508,8 +63853,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/following", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/following
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/following", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/following
    " }, { "lang": "JavaScript", @@ -63554,7 +63899,7 @@ { "verb": "get", "requestPath": "/users/{username}/following/{target_user}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -63578,8 +63923,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/following/TARGET_USER", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/following/TARGET_USER
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/following/TARGET_USER", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/following/TARGET_USER
    " }, { "lang": "JavaScript", @@ -63628,7 +63973,7 @@ { "verb": "get", "requestPath": "/users/{username}/gists", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -63673,8 +64018,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/gists", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/gists
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/gists", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/gists
    " }, { "lang": "JavaScript", @@ -63722,7 +64067,7 @@ { "verb": "get", "requestPath": "/users/{username}/gpg_keys", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -63757,8 +64102,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/gpg_keys", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/gpg_keys
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/gpg_keys", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/gpg_keys
    " }, { "lang": "JavaScript", @@ -63803,7 +64148,7 @@ { "verb": "get", "requestPath": "/users/{username}/hovercard", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -63844,8 +64189,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/hovercard", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/hovercard
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/hovercard", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/hovercard
    " }, { "lang": "JavaScript", @@ -63898,7 +64243,7 @@ { "verb": "get", "requestPath": "/users/{username}/installation", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -63924,8 +64269,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/users/USERNAME/installation", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  https://api.github.com/users/USERNAME/installation
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/installation", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/installation
    " }, { "lang": "JavaScript", @@ -63974,7 +64319,7 @@ { "verb": "get", "requestPath": "/users/{username}/keys", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -64009,8 +64354,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/keys", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/keys
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/keys", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/keys
    " }, { "lang": "JavaScript", @@ -64055,7 +64400,7 @@ { "verb": "get", "requestPath": "/users/{username}/orgs", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -64090,8 +64435,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/orgs", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/orgs
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/orgs", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/orgs
    " }, { "lang": "JavaScript", @@ -64134,7 +64479,7 @@ { "verb": "get", "requestPath": "/users/{username}/projects", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -64185,8 +64530,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/users/USERNAME/projects", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/users/USERNAME/projects
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/projects", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/projects
    " }, { "lang": "JavaScript", @@ -64246,7 +64591,7 @@ { "verb": "get", "requestPath": "/users/{username}/received_events", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -64281,8 +64626,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/received_events", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/received_events
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/received_events", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/received_events
    " }, { "lang": "JavaScript", @@ -64326,7 +64671,7 @@ { "verb": "get", "requestPath": "/users/{username}/received_events/public", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -64361,8 +64706,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/received_events/public", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/received_events/public
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/received_events/public", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/received_events/public
    " }, { "lang": "JavaScript", @@ -64406,7 +64751,7 @@ { "verb": "get", "requestPath": "/users/{username}/repos", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -64488,8 +64833,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/repos", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/repos
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/repos", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/repos
    " }, { "lang": "JavaScript", @@ -64498,7 +64843,7 @@ } ], "summary": "List repositories for a user", - "description": "Lists public repositories for the specified user.", + "description": "Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user.", "tags": [ "repos" ], @@ -64526,7 +64871,7 @@ "categoryLabel": "Repos", "notes": [], "bodyParameters": [], - "descriptionHTML": "

    Lists public repositories for the specified user.

    ", + "descriptionHTML": "

    Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user.

    ", "responses": [ { "httpStatusCode": "200", @@ -64539,7 +64884,7 @@ { "verb": "put", "requestPath": "/users/{username}/site_admin", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -64554,8 +64899,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/site_admin", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/site_admin
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/site_admin", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/site_admin
    " }, { "lang": "JavaScript", @@ -64590,7 +64935,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -64599,7 +64944,7 @@ { "verb": "delete", "requestPath": "/users/{username}/site_admin", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -64614,8 +64959,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/site_admin", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/site_admin
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/site_admin", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/site_admin
    " }, { "lang": "JavaScript", @@ -64650,7 +64995,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -64659,7 +65004,7 @@ { "verb": "get", "requestPath": "/users/{username}/starred", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -64724,8 +65069,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/starred", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/starred
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/starred", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/starred
    " }, { "lang": "JavaScript", @@ -64770,7 +65115,7 @@ { "verb": "get", "requestPath": "/users/{username}/subscriptions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -64805,8 +65150,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/subscriptions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/subscriptions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/subscriptions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/subscriptions
    " }, { "lang": "JavaScript", @@ -64851,7 +65196,7 @@ { "verb": "put", "requestPath": "/users/{username}/suspended", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -64866,8 +65211,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/suspended \\\n -d '{\"reason\":\"reason\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/suspended \\\n  -d '{\"reason\":\"reason\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/suspended \\\n -d '{\"reason\":\"reason\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/suspended \\\n  -d '{\"reason\":\"reason\"}'
    " }, { "lang": "JavaScript", @@ -64922,7 +65267,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "descriptionHTML": "

    If your GitHub instance uses LDAP Sync with Active Directory LDAP servers, Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a 403 response.

    \n

    You can suspend any user account except your own.

    \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.\"

    ", @@ -64941,7 +65286,7 @@ { "verb": "delete", "requestPath": "/users/{username}/suspended", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -64956,8 +65301,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/suspended \\\n -d '{\"reason\":\"reason\"}'", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/suspended \\\n  -d '{\"reason\":\"reason\"}'
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/suspended \\\n -d '{\"reason\":\"reason\"}'", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/suspended \\\n  -d '{\"reason\":\"reason\"}'
    " }, { "lang": "JavaScript", @@ -65012,7 +65357,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "descriptionHTML": "

    If your GitHub instance uses LDAP Sync with Active Directory LDAP servers, this API is disabled and will return a 403 response. Active Directory LDAP-authenticated users cannot be unsuspended using the API.

    ", @@ -65031,13 +65376,13 @@ { "verb": "get", "requestPath": "/zen", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/zen", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/zen
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/zen", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/zen
    " }, { "lang": "JavaScript", diff --git a/lib/rest/static/decorated/ghes-2.19.json b/lib/rest/static/decorated/ghes-2.19.json index 99b430b10d..ff2f95996a 100644 --- a/lib/rest/static/decorated/ghes-2.19.json +++ b/lib/rest/static/decorated/ghes-2.19.json @@ -2,13 +2,13 @@ { "verb": "get", "requestPath": "/", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/
    " }, { "lang": "JavaScript", @@ -45,7 +45,7 @@ { "verb": "get", "requestPath": "/admin/hooks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -82,8 +82,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n https://api.github.com/admin/hooks", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  https://api.github.com/admin/hooks
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/hooks", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/hooks
    " }, { "lang": "JavaScript", @@ -135,7 +135,7 @@ { "verb": "post", "requestPath": "/admin/hooks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -152,8 +152,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n https://api.github.com/admin/hooks \\\n -d '{\"name\":\"name\",\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  https://api.github.com/admin/hooks \\\n  -d '{\"name\":\"name\",\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/hooks \\\n -d '{\"name\":\"name\",\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/hooks \\\n  -d '{\"name\":\"name\",\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'
    " }, { "lang": "JavaScript", @@ -483,7 +483,7 @@ { "verb": "get", "requestPath": "/admin/hooks/{hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -509,8 +509,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n https://api.github.com/admin/hooks/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  https://api.github.com/admin/hooks/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/hooks/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/hooks/42
    " }, { "lang": "JavaScript", @@ -562,7 +562,7 @@ { "verb": "patch", "requestPath": "/admin/hooks/{hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -588,8 +588,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n https://api.github.com/admin/hooks/42 \\\n -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  https://api.github.com/admin/hooks/42 \\\n  -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/hooks/42 \\\n -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/hooks/42 \\\n  -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'
    " }, { "lang": "JavaScript", @@ -893,7 +893,7 @@ { "verb": "delete", "requestPath": "/admin/hooks/{hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -919,8 +919,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n https://api.github.com/admin/hooks/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  https://api.github.com/admin/hooks/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/hooks/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/hooks/42
    " }, { "lang": "JavaScript", @@ -962,7 +962,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -971,7 +971,7 @@ { "verb": "post", "requestPath": "/admin/hooks/{hook_id}/pings", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -997,8 +997,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n https://api.github.com/admin/hooks/42/pings", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  https://api.github.com/admin/hooks/42/pings
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/hooks/42/pings", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/hooks/42/pings
    " }, { "lang": "JavaScript", @@ -1040,7 +1040,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -1049,7 +1049,7 @@ { "verb": "get", "requestPath": "/admin/keys", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -1070,13 +1070,53 @@ "default": 1 }, "descriptionHTML": "

    Page number of the results to fetch.

    " + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + }, + "descriptionHTML": "

    One of asc (ascending) or desc (descending).

    " + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "accessed" + ], + "default": "created" + }, + "descriptionHTML": "" + }, + { + "name": "since", + "description": "Only show public keys accessed after the given time.", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    Only show public keys accessed after the given time.

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/keys", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/keys
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/keys", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/keys
    " }, { "lang": "JavaScript", @@ -1121,7 +1161,7 @@ { "verb": "delete", "requestPath": "/admin/keys/{key_ids}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "key_ids", @@ -1136,8 +1176,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/keys/KEY_IDS", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/keys/KEY_IDS
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/keys/KEY_IDS", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/keys/KEY_IDS
    " }, { "lang": "JavaScript", @@ -1172,7 +1212,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -1181,7 +1221,7 @@ { "verb": "patch", "requestPath": "/admin/ldap/teams/{team_id}/mapping", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -1196,8 +1236,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/ldap/teams/42/mapping \\\n -d '{\"ldap_dn\":\"ldap_dn\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/ldap/teams/42/mapping \\\n  -d '{\"ldap_dn\":\"ldap_dn\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/ldap/teams/42/mapping \\\n -d '{\"ldap_dn\":\"ldap_dn\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/ldap/teams/42/mapping \\\n  -d '{\"ldap_dn\":\"ldap_dn\"}'
    " }, { "lang": "JavaScript", @@ -1282,7 +1322,7 @@ { "verb": "post", "requestPath": "/admin/ldap/teams/{team_id}/sync", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -1297,8 +1337,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/ldap/teams/42/sync", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/ldap/teams/42/sync
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/ldap/teams/42/sync", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/ldap/teams/42/sync
    " }, { "lang": "JavaScript", @@ -1343,7 +1383,7 @@ { "verb": "patch", "requestPath": "/admin/ldap/users/{username}/mapping", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -1358,8 +1398,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/ldap/users/USERNAME/mapping \\\n -d '{\"ldap_dn\":\"ldap_dn\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/ldap/users/USERNAME/mapping \\\n  -d '{\"ldap_dn\":\"ldap_dn\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/ldap/users/USERNAME/mapping \\\n -d '{\"ldap_dn\":\"ldap_dn\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/ldap/users/USERNAME/mapping \\\n  -d '{\"ldap_dn\":\"ldap_dn\"}'
    " }, { "lang": "JavaScript", @@ -1437,7 +1477,7 @@ { "verb": "post", "requestPath": "/admin/ldap/users/{username}/sync", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -1452,8 +1492,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/ldap/users/USERNAME/sync", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/ldap/users/USERNAME/sync
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/ldap/users/USERNAME/sync", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/ldap/users/USERNAME/sync
    " }, { "lang": "JavaScript", @@ -1498,13 +1538,13 @@ { "verb": "post", "requestPath": "/admin/organizations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/organizations \\\n -d '{\"login\":\"login\",\"admin\":\"admin\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/organizations \\\n  -d '{\"login\":\"login\",\"admin\":\"admin\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/organizations \\\n -d '{\"login\":\"login\",\"admin\":\"admin\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/organizations \\\n  -d '{\"login\":\"login\",\"admin\":\"admin\"}'
    " }, { "lang": "JavaScript", @@ -1624,7 +1664,7 @@ { "verb": "patch", "requestPath": "/admin/organizations/{org}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -1639,8 +1679,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/organizations/ORG \\\n -d '{\"login\":\"login\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/organizations/ORG \\\n  -d '{\"login\":\"login\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/organizations/ORG \\\n -d '{\"login\":\"login\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/organizations/ORG \\\n  -d '{\"login\":\"login\"}'
    " }, { "lang": "JavaScript", @@ -1721,7 +1761,7 @@ { "verb": "get", "requestPath": "/admin/pre-receive-environments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -1742,13 +1782,43 @@ "default": 1 }, "descriptionHTML": "

    Page number of the results to fetch.

    " + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + }, + "descriptionHTML": "

    One of asc (ascending) or desc (descending).

    " + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + }, + "descriptionHTML": "" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-environments", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/admin/pre-receive-environments
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/pre-receive-environments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/pre-receive-environments
    " }, { "lang": "JavaScript", @@ -1800,13 +1870,13 @@ { "verb": "post", "requestPath": "/admin/pre-receive-environments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-environments \\\n -d '{\"name\":\"name\",\"image_url\":\"image_url\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/admin/pre-receive-environments \\\n  -d '{\"name\":\"name\",\"image_url\":\"image_url\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/pre-receive-environments \\\n -d '{\"name\":\"name\",\"image_url\":\"image_url\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/pre-receive-environments \\\n  -d '{\"name\":\"name\",\"image_url\":\"image_url\"}'
    " }, { "lang": "JavaScript", @@ -1914,7 +1984,7 @@ { "verb": "get", "requestPath": "/admin/pre-receive-environments/{pre_receive_environment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "pre_receive_environment_id", @@ -1929,8 +1999,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-environments/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/admin/pre-receive-environments/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/pre-receive-environments/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/pre-receive-environments/42
    " }, { "lang": "JavaScript", @@ -1982,7 +2052,7 @@ { "verb": "patch", "requestPath": "/admin/pre-receive-environments/{pre_receive_environment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "pre_receive_environment_id", @@ -1997,8 +2067,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-environments/42 \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/admin/pre-receive-environments/42 \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/pre-receive-environments/42 \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/pre-receive-environments/42 \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -2104,7 +2174,7 @@ { "verb": "delete", "requestPath": "/admin/pre-receive-environments/{pre_receive_environment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "pre_receive_environment_id", @@ -2119,8 +2189,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-environments/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/admin/pre-receive-environments/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/pre-receive-environments/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/pre-receive-environments/42
    " }, { "lang": "JavaScript", @@ -2164,7 +2234,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "422", @@ -2177,7 +2247,7 @@ { "verb": "post", "requestPath": "/admin/pre-receive-environments/{pre_receive_environment_id}/downloads", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "pre_receive_environment_id", @@ -2192,8 +2262,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-environments/42/downloads", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/admin/pre-receive-environments/42/downloads
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/pre-receive-environments/42/downloads", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/pre-receive-environments/42/downloads
    " }, { "lang": "JavaScript", @@ -2251,7 +2321,7 @@ { "verb": "get", "requestPath": "/admin/pre-receive-environments/{pre_receive_environment_id}/downloads/latest", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "pre_receive_environment_id", @@ -2266,8 +2336,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-environments/42/downloads/latest", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/admin/pre-receive-environments/42/downloads/latest
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/pre-receive-environments/42/downloads/latest", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/pre-receive-environments/42/downloads/latest
    " }, { "lang": "JavaScript", @@ -2319,7 +2389,7 @@ { "verb": "get", "requestPath": "/admin/pre-receive-hooks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -2340,13 +2410,44 @@ "default": 1 }, "descriptionHTML": "

    Page number of the results to fetch.

    " + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + }, + "descriptionHTML": "

    One of asc (ascending) or desc (descending).

    " + }, + { + "name": "sort", + "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to) or `name`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + }, + "descriptionHTML": "

    One of created (when the repository was starred) or updated (when it was last pushed to) or name.

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-hooks", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/admin/pre-receive-hooks
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/pre-receive-hooks", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/pre-receive-hooks
    " }, { "lang": "JavaScript", @@ -2398,13 +2499,13 @@ { "verb": "post", "requestPath": "/admin/pre-receive-hooks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-hooks \\\n -d '{\"name\":\"name\",\"script\":\"script\",\"script_repository\":{},\"environment\":{}}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/admin/pre-receive-hooks \\\n  -d '{\"name\":\"name\",\"script\":\"script\",\"script_repository\":{},\"environment\":{}}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/pre-receive-hooks \\\n -d '{\"name\":\"name\",\"script\":\"script\",\"script_repository\":{},\"environment\":{}}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/pre-receive-hooks \\\n  -d '{\"name\":\"name\",\"script\":\"script\",\"script_repository\":{},\"environment\":{}}'
    " }, { "lang": "JavaScript", @@ -2602,7 +2703,7 @@ { "verb": "get", "requestPath": "/admin/pre-receive-hooks/{pre_receive_hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "pre_receive_hook_id", @@ -2617,8 +2718,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-hooks/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/admin/pre-receive-hooks/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/pre-receive-hooks/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/pre-receive-hooks/42
    " }, { "lang": "JavaScript", @@ -2670,7 +2771,7 @@ { "verb": "patch", "requestPath": "/admin/pre-receive-hooks/{pre_receive_hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "pre_receive_hook_id", @@ -2685,8 +2786,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-hooks/42 \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/admin/pre-receive-hooks/42 \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/pre-receive-hooks/42 \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/pre-receive-hooks/42 \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -2873,7 +2974,7 @@ { "verb": "delete", "requestPath": "/admin/pre-receive-hooks/{pre_receive_hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "pre_receive_hook_id", @@ -2888,8 +2989,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-hooks/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/admin/pre-receive-hooks/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/pre-receive-hooks/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/pre-receive-hooks/42
    " }, { "lang": "JavaScript", @@ -2931,7 +3032,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -2940,7 +3041,7 @@ { "verb": "get", "requestPath": "/admin/tokens", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -2966,8 +3067,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/tokens", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/tokens
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/tokens", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/tokens
    " }, { "lang": "JavaScript", @@ -3012,7 +3113,7 @@ { "verb": "delete", "requestPath": "/admin/tokens/{token_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "token_id", @@ -3027,8 +3128,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/tokens/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/tokens/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/tokens/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/tokens/42
    " }, { "lang": "JavaScript", @@ -3063,7 +3164,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -3072,13 +3173,13 @@ { "verb": "post", "requestPath": "/admin/users", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/users \\\n -d '{\"login\":\"login\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/users \\\n  -d '{\"login\":\"login\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/users \\\n -d '{\"login\":\"login\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/users \\\n  -d '{\"login\":\"login\"}'
    " }, { "lang": "JavaScript", @@ -3178,7 +3279,7 @@ { "verb": "patch", "requestPath": "/admin/users/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -3193,8 +3294,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/users/USERNAME \\\n -d '{\"login\":\"login\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/users/USERNAME \\\n  -d '{\"login\":\"login\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/users/USERNAME \\\n -d '{\"login\":\"login\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/users/USERNAME \\\n  -d '{\"login\":\"login\"}'
    " }, { "lang": "JavaScript", @@ -3275,7 +3376,7 @@ { "verb": "delete", "requestPath": "/admin/users/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -3290,8 +3391,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/users/USERNAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/users/USERNAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/users/USERNAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/users/USERNAME
    " }, { "lang": "JavaScript", @@ -3326,7 +3427,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -3335,7 +3436,7 @@ { "verb": "post", "requestPath": "/admin/users/{username}/authorizations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -3350,8 +3451,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/users/USERNAME/authorizations \\\n -d '{\"scopes\":[\"scopes\"]}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/users/USERNAME/authorizations \\\n  -d '{\"scopes\":[\"scopes\"]}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/users/USERNAME/authorizations \\\n -d '{\"scopes\":[\"scopes\"]}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/users/USERNAME/authorizations \\\n  -d '{\"scopes\":[\"scopes\"]}'
    " }, { "lang": "JavaScript", @@ -3432,7 +3533,7 @@ { "verb": "delete", "requestPath": "/admin/users/{username}/authorizations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -3447,8 +3548,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/users/USERNAME/authorizations", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/users/USERNAME/authorizations
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/users/USERNAME/authorizations", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/users/USERNAME/authorizations
    " }, { "lang": "JavaScript", @@ -3483,7 +3584,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -3492,13 +3593,13 @@ { "verb": "get", "requestPath": "/app", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/app", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  https://api.github.com/app
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n http(s)://{hostname}/api/v3/app", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  http(s)://{hostname}/api/v3/app
    " }, { "lang": "JavaScript", @@ -3547,7 +3648,7 @@ { "verb": "post", "requestPath": "/app-manifests/{code}/conversions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "code", @@ -3562,8 +3663,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/app-manifests/CODE/conversions", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/app-manifests/CODE/conversions
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/app-manifests/CODE/conversions", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/app-manifests/CODE/conversions
    " }, { "lang": "JavaScript", @@ -3616,7 +3717,7 @@ { "verb": "get", "requestPath": "/app/installations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -3653,8 +3754,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/app/installations", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  https://api.github.com/app/installations
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n http(s)://{hostname}/api/v3/app/installations", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  http(s)://{hostname}/api/v3/app/installations
    " }, { "lang": "JavaScript", @@ -3703,7 +3804,7 @@ { "verb": "get", "requestPath": "/app/installations/{installation_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -3730,8 +3831,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/app/installations/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  https://api.github.com/app/installations/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n http(s)://{hostname}/api/v3/app/installations/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  http(s)://{hostname}/api/v3/app/installations/42
    " }, { "lang": "JavaScript", @@ -3790,7 +3891,7 @@ { "verb": "delete", "requestPath": "/app/installations/{installation_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -3817,8 +3918,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.gambit-preview+json\" \\\n https://api.github.com/app/installations/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.gambit-preview+json\" \\\n  https://api.github.com/app/installations/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.gambit-preview+json\" \\\n http(s)://{hostname}/api/v3/app/installations/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.gambit-preview+json\" \\\n  http(s)://{hostname}/api/v3/app/installations/42
    " }, { "lang": "JavaScript", @@ -3863,7 +3964,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -3877,7 +3978,7 @@ { "verb": "post", "requestPath": "/app/installations/{installation_id}/access_tokens", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -3904,8 +4005,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/app/installations/42/access_tokens \\\n -d '{\"repositories\":[\"repositories\"]}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  https://api.github.com/app/installations/42/access_tokens \\\n  -d '{\"repositories\":[\"repositories\"]}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n http(s)://{hostname}/api/v3/app/installations/42/access_tokens \\\n -d '{\"repositories\":[\"repositories\"]}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  http(s)://{hostname}/api/v3/app/installations/42/access_tokens \\\n  -d '{\"repositories\":[\"repositories\"]}'
    " }, { "lang": "JavaScript", @@ -5655,7 +5756,7 @@ { "verb": "get", "requestPath": "/applications/grants", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -5676,13 +5777,23 @@ "default": 1 }, "descriptionHTML": "

    Page number of the results to fetch.

    " + }, + { + "name": "client_id", + "in": "query", + "required": false, + "description": "The client ID of your GitHub app.", + "schema": { + "type": "string" + }, + "descriptionHTML": "

    The client ID of your GitHub app.

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/grants", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/applications/grants
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/applications/grants", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/applications/grants
    " }, { "lang": "JavaScript", @@ -5748,7 +5859,7 @@ { "verb": "get", "requestPath": "/applications/grants/{grant_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "grant_id", @@ -5764,8 +5875,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/grants/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/applications/grants/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/applications/grants/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/applications/grants/42
    " }, { "lang": "JavaScript", @@ -5826,7 +5937,7 @@ { "verb": "delete", "requestPath": "/applications/grants/{grant_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "grant_id", @@ -5842,8 +5953,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/grants/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/applications/grants/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/applications/grants/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/applications/grants/42
    " }, { "lang": "JavaScript", @@ -5879,7 +5990,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -5903,7 +6014,7 @@ { "verb": "delete", "requestPath": "/applications/{client_id}/grants/{access_token}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "client_id", @@ -5928,8 +6039,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/CLIENT_ID/grants/ACCESS_TOKEN", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/applications/CLIENT_ID/grants/ACCESS_TOKEN
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/applications/CLIENT_ID/grants/ACCESS_TOKEN", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/applications/CLIENT_ID/grants/ACCESS_TOKEN
    " }, { "lang": "JavaScript", @@ -5962,7 +6073,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -5971,7 +6082,7 @@ { "verb": "get", "requestPath": "/applications/{client_id}/tokens/{access_token}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "client_id", @@ -5996,8 +6107,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/CLIENT_ID/tokens/ACCESS_TOKEN", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/applications/CLIENT_ID/tokens/ACCESS_TOKEN
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/applications/CLIENT_ID/tokens/ACCESS_TOKEN", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/applications/CLIENT_ID/tokens/ACCESS_TOKEN
    " }, { "lang": "JavaScript", @@ -6040,7 +6151,7 @@ { "verb": "post", "requestPath": "/applications/{client_id}/tokens/{access_token}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "client_id", @@ -6065,8 +6176,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/CLIENT_ID/tokens/ACCESS_TOKEN", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/applications/CLIENT_ID/tokens/ACCESS_TOKEN
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/applications/CLIENT_ID/tokens/ACCESS_TOKEN", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/applications/CLIENT_ID/tokens/ACCESS_TOKEN
    " }, { "lang": "JavaScript", @@ -6109,7 +6220,7 @@ { "verb": "delete", "requestPath": "/applications/{client_id}/tokens/{access_token}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "client_id", @@ -6134,8 +6245,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/CLIENT_ID/tokens/ACCESS_TOKEN", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/applications/CLIENT_ID/tokens/ACCESS_TOKEN
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/applications/CLIENT_ID/tokens/ACCESS_TOKEN", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/applications/CLIENT_ID/tokens/ACCESS_TOKEN
    " }, { "lang": "JavaScript", @@ -6168,7 +6279,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -6177,7 +6288,7 @@ { "verb": "get", "requestPath": "/apps/{app_slug}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "app_slug", @@ -6192,8 +6303,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/apps/APP_SLUG", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  https://api.github.com/apps/APP_SLUG
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n http(s)://{hostname}/api/v3/apps/APP_SLUG", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  http(s)://{hostname}/api/v3/apps/APP_SLUG
    " }, { "lang": "JavaScript", @@ -6257,7 +6368,7 @@ { "verb": "get", "requestPath": "/authorizations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -6278,13 +6389,23 @@ "default": 1 }, "descriptionHTML": "

    Page number of the results to fetch.

    " + }, + { + "name": "client_id", + "in": "query", + "required": false, + "description": "The client ID of your GitHub app.", + "schema": { + "type": "string" + }, + "descriptionHTML": "

    The client ID of your GitHub app.

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/authorizations", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/authorizations
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/authorizations", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/authorizations
    " }, { "lang": "JavaScript", @@ -6350,13 +6471,13 @@ { "verb": "post", "requestPath": "/authorizations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/authorizations \\\n -d '{\"scopes\":[\"scopes\"]}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/authorizations \\\n  -d '{\"scopes\":[\"scopes\"]}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/authorizations \\\n -d '{\"scopes\":[\"scopes\"]}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/authorizations \\\n  -d '{\"scopes\":[\"scopes\"]}'
    " }, { "lang": "JavaScript", @@ -6569,7 +6690,7 @@ { "verb": "put", "requestPath": "/authorizations/clients/{client_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "client_id", @@ -6585,8 +6706,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/authorizations/clients/CLIENT_ID \\\n -d '{\"client_secret\":\"client_secret\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/authorizations/clients/CLIENT_ID \\\n  -d '{\"client_secret\":\"client_secret\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/authorizations/clients/CLIENT_ID \\\n -d '{\"client_secret\":\"client_secret\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/authorizations/clients/CLIENT_ID \\\n  -d '{\"client_secret\":\"client_secret\"}'
    " }, { "lang": "JavaScript", @@ -6783,7 +6904,7 @@ { "verb": "put", "requestPath": "/authorizations/clients/{client_id}/{fingerprint}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "client_id", @@ -6808,8 +6929,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/authorizations/clients/CLIENT_ID/FINGERPRINT \\\n -d '{\"client_secret\":\"client_secret\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/authorizations/clients/CLIENT_ID/FINGERPRINT \\\n  -d '{\"client_secret\":\"client_secret\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/authorizations/clients/CLIENT_ID/FINGERPRINT \\\n -d '{\"client_secret\":\"client_secret\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/authorizations/clients/CLIENT_ID/FINGERPRINT \\\n  -d '{\"client_secret\":\"client_secret\"}'
    " }, { "lang": "JavaScript", @@ -6973,7 +7094,7 @@ { "verb": "get", "requestPath": "/authorizations/{authorization_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "authorization_id", @@ -6989,8 +7110,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/authorizations/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/authorizations/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/authorizations/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/authorizations/42
    " }, { "lang": "JavaScript", @@ -7051,7 +7172,7 @@ { "verb": "patch", "requestPath": "/authorizations/{authorization_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "authorization_id", @@ -7067,8 +7188,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/authorizations/42 \\\n -d '{\"scopes\":[\"scopes\"]}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/authorizations/42 \\\n  -d '{\"scopes\":[\"scopes\"]}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/authorizations/42 \\\n -d '{\"scopes\":[\"scopes\"]}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/authorizations/42 \\\n  -d '{\"scopes\":[\"scopes\"]}'
    " }, { "lang": "JavaScript", @@ -7269,7 +7390,7 @@ { "verb": "delete", "requestPath": "/authorizations/{authorization_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "authorization_id", @@ -7285,8 +7406,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/authorizations/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/authorizations/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/authorizations/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/authorizations/42
    " }, { "lang": "JavaScript", @@ -7322,7 +7443,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -7346,13 +7467,13 @@ { "verb": "get", "requestPath": "/codes_of_conduct", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.scarlet-witch-preview+json\" \\\n https://api.github.com/codes_of_conduct", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.scarlet-witch-preview+json\" \\\n  https://api.github.com/codes_of_conduct
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.scarlet-witch-preview+json\" \\\n http(s)://{hostname}/api/v3/codes_of_conduct", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.scarlet-witch-preview+json\" \\\n  http(s)://{hostname}/api/v3/codes_of_conduct
    " }, { "lang": "JavaScript", @@ -7412,7 +7533,7 @@ { "verb": "get", "requestPath": "/codes_of_conduct/{key}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "key", @@ -7427,8 +7548,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.scarlet-witch-preview+json\" \\\n https://api.github.com/codes_of_conduct/KEY", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.scarlet-witch-preview+json\" \\\n  https://api.github.com/codes_of_conduct/KEY
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.scarlet-witch-preview+json\" \\\n http(s)://{hostname}/api/v3/codes_of_conduct/KEY", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.scarlet-witch-preview+json\" \\\n  http(s)://{hostname}/api/v3/codes_of_conduct/KEY
    " }, { "lang": "JavaScript", @@ -7493,7 +7614,7 @@ { "verb": "post", "requestPath": "/content_references/{content_reference_id}/attachments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "content_reference_id", @@ -7508,8 +7629,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n https://api.github.com/content_references/42/attachments \\\n -d '{\"title\":\"title\",\"body\":\"body\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n  https://api.github.com/content_references/42/attachments \\\n  -d '{\"title\":\"title\",\"body\":\"body\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n http(s)://{hostname}/api/v3/content_references/42/attachments \\\n -d '{\"title\":\"title\",\"body\":\"body\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n  http(s)://{hostname}/api/v3/content_references/42/attachments \\\n  -d '{\"title\":\"title\",\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -7651,13 +7772,13 @@ { "verb": "get", "requestPath": "/emojis", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/emojis", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/emojis
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/emojis", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/emojis
    " }, { "lang": "JavaScript", @@ -7704,13 +7825,13 @@ { "verb": "get", "requestPath": "/enterprise/settings/license", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprise/settings/license", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprise/settings/license
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/enterprise/settings/license", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/enterprise/settings/license
    " }, { "lang": "JavaScript", @@ -7755,7 +7876,7 @@ { "verb": "get", "requestPath": "/enterprise/stats/{type}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "type", @@ -7770,8 +7891,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprise/stats/TYPE", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprise/stats/TYPE
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/enterprise/stats/TYPE", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/enterprise/stats/TYPE
    " }, { "lang": "JavaScript", @@ -7816,7 +7937,7 @@ { "verb": "get", "requestPath": "/events", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -7842,8 +7963,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/events", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/events
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/events", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/events
    " }, { "lang": "JavaScript", @@ -7902,13 +8023,13 @@ { "verb": "get", "requestPath": "/feeds", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/feeds", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/feeds
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/feeds", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/feeds
    " }, { "lang": "JavaScript", @@ -7953,7 +8074,7 @@ { "verb": "get", "requestPath": "/gists", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "since", @@ -7989,8 +8110,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists
    " }, { "lang": "JavaScript", @@ -8043,13 +8164,13 @@ { "verb": "post", "requestPath": "/gists", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists \\\n -d '{\"files\":{}}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists \\\n  -d '{\"files\":{}}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists \\\n -d '{\"files\":{}}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists \\\n  -d '{\"files\":{}}'
    " }, { "lang": "JavaScript", @@ -8247,7 +8368,7 @@ { "verb": "get", "requestPath": "/gists/public", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "since", @@ -8283,8 +8404,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/public", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/public
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/public", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/public
    " }, { "lang": "JavaScript", @@ -8342,7 +8463,7 @@ { "verb": "get", "requestPath": "/gists/starred", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "since", @@ -8378,8 +8499,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/starred", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/starred
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/starred", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/starred
    " }, { "lang": "JavaScript", @@ -8437,7 +8558,7 @@ { "verb": "get", "requestPath": "/gists/{gist_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -8453,8 +8574,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID
    " }, { "lang": "JavaScript", @@ -8512,7 +8633,7 @@ { "verb": "patch", "requestPath": "/gists/{gist_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -8528,8 +8649,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID \\\n -d '{\"description\":\"description\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID \\\n  -d '{\"description\":\"description\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID \\\n -d '{\"description\":\"description\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID \\\n  -d '{\"description\":\"description\"}'
    " }, { "lang": "JavaScript", @@ -8719,7 +8840,7 @@ { "verb": "delete", "requestPath": "/gists/{gist_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -8735,8 +8856,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID
    " }, { "lang": "JavaScript", @@ -8769,7 +8890,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -8793,7 +8914,7 @@ { "verb": "get", "requestPath": "/gists/{gist_id}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -8829,8 +8950,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/comments", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/comments
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID/comments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID/comments
    " }, { "lang": "JavaScript", @@ -8890,7 +9011,7 @@ { "verb": "post", "requestPath": "/gists/{gist_id}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -8906,8 +9027,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/comments \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/comments \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID/comments \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID/comments \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -9004,7 +9125,7 @@ { "verb": "get", "requestPath": "/gists/{gist_id}/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -9030,8 +9151,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/comments/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/comments/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID/comments/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID/comments/42
    " }, { "lang": "JavaScript", @@ -9091,7 +9212,7 @@ { "verb": "patch", "requestPath": "/gists/{gist_id}/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -9117,8 +9238,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/comments/42 \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/comments/42 \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID/comments/42 \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID/comments/42 \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -9205,7 +9326,7 @@ { "verb": "delete", "requestPath": "/gists/{gist_id}/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -9231,8 +9352,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/comments/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/comments/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID/comments/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID/comments/42
    " }, { "lang": "JavaScript", @@ -9267,7 +9388,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -9291,7 +9412,7 @@ { "verb": "get", "requestPath": "/gists/{gist_id}/commits", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -9327,8 +9448,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/commits", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/commits
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID/commits", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID/commits
    " }, { "lang": "JavaScript", @@ -9386,7 +9507,7 @@ { "verb": "get", "requestPath": "/gists/{gist_id}/forks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -9422,8 +9543,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/forks", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/forks
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID/forks", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID/forks
    " }, { "lang": "JavaScript", @@ -9481,7 +9602,7 @@ { "verb": "post", "requestPath": "/gists/{gist_id}/forks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -9497,8 +9618,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/forks", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/forks
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID/forks", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID/forks
    " }, { "lang": "JavaScript", @@ -9561,7 +9682,7 @@ { "verb": "get", "requestPath": "/gists/{gist_id}/star", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -9577,8 +9698,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/star", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/star
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID/star", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID/star
    " }, { "lang": "JavaScript", @@ -9635,7 +9756,7 @@ { "verb": "put", "requestPath": "/gists/{gist_id}/star", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -9651,8 +9772,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/star", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/star
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID/star", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID/star
    " }, { "lang": "JavaScript", @@ -9685,7 +9806,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -9709,7 +9830,7 @@ { "verb": "delete", "requestPath": "/gists/{gist_id}/star", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -9725,8 +9846,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/star", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/star
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID/star", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID/star
    " }, { "lang": "JavaScript", @@ -9759,7 +9880,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -9783,7 +9904,7 @@ { "verb": "get", "requestPath": "/gists/{gist_id}/{sha}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -9808,8 +9929,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/SHA", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/SHA
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID/SHA", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID/SHA
    " }, { "lang": "JavaScript", @@ -9867,13 +9988,13 @@ { "verb": "get", "requestPath": "/gitignore/templates", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gitignore/templates", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gitignore/templates
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gitignore/templates", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gitignore/templates
    " }, { "lang": "JavaScript", @@ -9921,7 +10042,7 @@ { "verb": "get", "requestPath": "/gitignore/templates/{name}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "name", @@ -9936,8 +10057,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gitignore/templates/NAME", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gitignore/templates/NAME
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gitignore/templates/NAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gitignore/templates/NAME
    " }, { "lang": "JavaScript", @@ -9985,7 +10106,7 @@ { "verb": "get", "requestPath": "/installation/repositories", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -10022,8 +10143,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/installation/repositories", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  https://api.github.com/installation/repositories
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n http(s)://{hostname}/api/v3/installation/repositories", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  http(s)://{hostname}/api/v3/installation/repositories
    " }, { "lang": "JavaScript", @@ -10096,7 +10217,7 @@ { "verb": "get", "requestPath": "/issues", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "filter", @@ -10110,6 +10231,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -10243,8 +10365,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/issues", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/issues
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/issues", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/issues
    " }, { "lang": "JavaScript", @@ -10308,7 +10430,7 @@ { "verb": "get", "requestPath": "/licenses", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "featured", @@ -10328,13 +10450,23 @@ "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/licenses", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/licenses
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/licenses", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/licenses
    " }, { "lang": "JavaScript", @@ -10382,7 +10514,7 @@ { "verb": "get", "requestPath": "/licenses/{license}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "license", @@ -10397,8 +10529,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/licenses/LICENSE", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/licenses/LICENSE
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/licenses/LICENSE", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/licenses/LICENSE
    " }, { "lang": "JavaScript", @@ -10456,13 +10588,13 @@ { "verb": "post", "requestPath": "/markdown", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/markdown \\\n -d '{\"text\":\"text\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/markdown \\\n  -d '{\"text\":\"text\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/markdown \\\n -d '{\"text\":\"text\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/markdown \\\n  -d '{\"text\":\"text\"}'
    " }, { "lang": "JavaScript", @@ -10590,13 +10722,13 @@ { "verb": "post", "requestPath": "/markdown/raw", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/markdown/raw", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/markdown/raw
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/markdown/raw", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/markdown/raw
    " }, { "lang": "JavaScript", @@ -10657,13 +10789,13 @@ { "verb": "get", "requestPath": "/meta", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/meta", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/meta
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/meta", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/meta
    " }, { "lang": "JavaScript", @@ -10711,7 +10843,7 @@ { "verb": "get", "requestPath": "/networks/{owner}/{repo}/events", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -10755,8 +10887,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/networks/octocat/hello-world/events", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/networks/octocat/hello-world/events
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/networks/octocat/hello-world/events", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/networks/octocat/hello-world/events
    " }, { "lang": "JavaScript", @@ -10820,7 +10952,7 @@ { "verb": "get", "requestPath": "/notifications", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "all", @@ -10888,8 +11020,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/notifications", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/notifications
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/notifications", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/notifications
    " }, { "lang": "JavaScript", @@ -10954,13 +11086,13 @@ { "verb": "put", "requestPath": "/notifications", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/notifications \\\n -d '{\"last_read_at\":\"last_read_at\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/notifications \\\n  -d '{\"last_read_at\":\"last_read_at\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/notifications \\\n -d '{\"last_read_at\":\"last_read_at\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/notifications \\\n  -d '{\"last_read_at\":\"last_read_at\"}'
    " }, { "lang": "JavaScript", @@ -11074,7 +11206,7 @@ { "verb": "get", "requestPath": "/notifications/threads/{thread_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "thread_id", @@ -11090,8 +11222,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/notifications/threads/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/notifications/threads/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/notifications/threads/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/notifications/threads/42
    " }, { "lang": "JavaScript", @@ -11151,7 +11283,7 @@ { "verb": "patch", "requestPath": "/notifications/threads/{thread_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "thread_id", @@ -11167,8 +11299,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/notifications/threads/42", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/notifications/threads/42
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/notifications/threads/42", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/notifications/threads/42
    " }, { "lang": "JavaScript", @@ -11222,7 +11354,7 @@ { "verb": "get", "requestPath": "/notifications/threads/{thread_id}/subscription", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "thread_id", @@ -11238,8 +11370,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/notifications/threads/42/subscription", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/notifications/threads/42/subscription
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/notifications/threads/42/subscription", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/notifications/threads/42/subscription
    " }, { "lang": "JavaScript", @@ -11299,7 +11431,7 @@ { "verb": "put", "requestPath": "/notifications/threads/{thread_id}/subscription", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "thread_id", @@ -11315,8 +11447,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/notifications/threads/42/subscription \\\n -d '{\"ignored\":true}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/notifications/threads/42/subscription \\\n  -d '{\"ignored\":true}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/notifications/threads/42/subscription \\\n -d '{\"ignored\":true}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/notifications/threads/42/subscription \\\n  -d '{\"ignored\":true}'
    " }, { "lang": "JavaScript", @@ -11408,7 +11540,7 @@ { "verb": "delete", "requestPath": "/notifications/threads/{thread_id}/subscription", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "thread_id", @@ -11424,8 +11556,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/notifications/threads/42/subscription", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/notifications/threads/42/subscription
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/notifications/threads/42/subscription", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/notifications/threads/42/subscription
    " }, { "lang": "JavaScript", @@ -11460,7 +11592,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -11484,7 +11616,7 @@ { "verb": "get", "requestPath": "/octocat", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "s", @@ -11500,8 +11632,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/octocat", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/octocat
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/octocat", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/octocat
    " }, { "lang": "JavaScript", @@ -11538,7 +11670,7 @@ { "verb": "get", "requestPath": "/organizations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "since", @@ -11564,8 +11696,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/organizations", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/organizations
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/organizations", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/organizations
    " }, { "lang": "JavaScript", @@ -11613,7 +11745,7 @@ { "verb": "get", "requestPath": "/orgs/{org}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -11628,8 +11760,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG
    " }, { "lang": "JavaScript", @@ -11672,13 +11804,7 @@ "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "
    {\n  \"login\": \"github\",\n  \"id\": 1,\n  \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n  \"url\": \"https://api.github.com/orgs/github\",\n  \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n  \"events_url\": \"https://api.github.com/orgs/github/events\",\n  \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n  \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n  \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n  \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n  \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n  \"description\": \"A great organization\",\n  \"name\": \"github\",\n  \"company\": \"GitHub\",\n  \"blog\": \"https://github.com/blog\",\n  \"location\": \"San Francisco\",\n  \"email\": \"octocat@github.com\",\n  \"twitter_username\": \"github\",\n  \"is_verified\": true,\n  \"has_organization_projects\": true,\n  \"has_repository_projects\": true,\n  \"public_repos\": 2,\n  \"public_gists\": 1,\n  \"followers\": 20,\n  \"following\": 0,\n  \"html_url\": \"https://github.com/octocat\",\n  \"created_at\": \"2008-01-14T04:33:35Z\",\n  \"updated_at\": \"2014-03-03T18:58:10Z\",\n  \"type\": \"Organization\",\n  \"total_private_repos\": 100,\n  \"owned_private_repos\": 100,\n  \"private_gists\": 81,\n  \"disk_usage\": 10000,\n  \"collaborators\": 8,\n  \"billing_email\": \"mona@github.com\",\n  \"plan\": {\n    \"name\": \"Medium\",\n    \"space\": 400,\n    \"private_repos\": 20\n  },\n  \"default_repository_permission\": \"read\",\n  \"members_can_create_repositories\": true,\n  \"two_factor_requirement_enabled\": true,\n  \"members_allowed_repository_creation_type\": \"all\",\n  \"members_can_create_public_repositories\": false,\n  \"members_can_create_private_repositories\": false,\n  \"members_can_create_internal_repositories\": false,\n  \"members_can_create_pages\": true\n}\n
    " - }, - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response with GitHub plan information", - "payload": "
    {\n  \"login\": \"github\",\n  \"id\": 1,\n  \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n  \"url\": \"https://api.github.com/orgs/github\",\n  \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n  \"events_url\": \"https://api.github.com/orgs/github/events\",\n  \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n  \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n  \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n  \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n  \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n  \"description\": \"A great organization\",\n  \"name\": \"github\",\n  \"company\": \"GitHub\",\n  \"blog\": \"https://github.com/blog\",\n  \"location\": \"San Francisco\",\n  \"email\": \"octocat@github.com\",\n  \"twitter_username\": \"github\",\n  \"is_verified\": true,\n  \"has_organization_projects\": true,\n  \"has_repository_projects\": true,\n  \"public_repos\": 2,\n  \"public_gists\": 1,\n  \"followers\": 20,\n  \"following\": 0,\n  \"html_url\": \"https://github.com/octocat\",\n  \"created_at\": \"2008-01-14T04:33:35Z\",\n  \"updated_at\": \"2014-03-03T18:58:10Z\",\n  \"type\": \"Organization\",\n  \"plan\": {\n    \"name\": \"team\",\n    \"space\": 976562499,\n    \"private_repos\": 999999,\n    \"filled_seats\": 4,\n    \"seats\": 5\n  }\n}\n
    " + "payload": "
    {\n  \"login\": \"github\",\n  \"id\": 1,\n  \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n  \"url\": \"https://api.github.com/orgs/github\",\n  \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n  \"events_url\": \"https://api.github.com/orgs/github/events\",\n  \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n  \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n  \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n  \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n  \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n  \"description\": \"A great organization\",\n  \"name\": \"github\",\n  \"company\": \"GitHub\",\n  \"blog\": \"https://github.com/blog\",\n  \"location\": \"San Francisco\",\n  \"email\": \"octocat@github.com\",\n  \"twitter_username\": \"github\",\n  \"is_verified\": true,\n  \"has_organization_projects\": true,\n  \"has_repository_projects\": true,\n  \"public_repos\": 2,\n  \"public_gists\": 1,\n  \"followers\": 20,\n  \"following\": 0,\n  \"html_url\": \"https://github.com/octocat\",\n  \"created_at\": \"2008-01-14T04:33:35Z\",\n  \"updated_at\": \"2014-03-03T18:58:10Z\",\n  \"type\": \"Organization\",\n  \"total_private_repos\": 100,\n  \"owned_private_repos\": 100,\n  \"private_gists\": 81,\n  \"disk_usage\": 10000,\n  \"collaborators\": 8,\n  \"billing_email\": \"mona@github.com\",\n  \"plan\": {\n    \"name\": \"Medium\",\n    \"space\": 400,\n    \"private_repos\": 20,\n    \"filled_seats\": 4,\n    \"seats\": 5\n  },\n  \"default_repository_permission\": \"read\",\n  \"members_can_create_repositories\": true,\n  \"two_factor_requirement_enabled\": true,\n  \"members_allowed_repository_creation_type\": \"all\",\n  \"members_can_create_public_repositories\": false,\n  \"members_can_create_private_repositories\": false,\n  \"members_can_create_internal_repositories\": false,\n  \"members_can_create_pages\": true\n}\n
    " }, { "httpStatusCode": "404", @@ -11690,7 +11816,7 @@ { "verb": "patch", "requestPath": "/orgs/{org}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -11705,8 +11831,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG \\\n -d '{\"billing_email\":\"billing_email\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG \\\n  -d '{\"billing_email\":\"billing_email\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG \\\n -d '{\"billing_email\":\"billing_email\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG \\\n  -d '{\"billing_email\":\"billing_email\"}'
    " }, { "lang": "JavaScript", @@ -12109,7 +12235,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/events", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -12144,8 +12270,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/events", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/events
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/events", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/events
    " }, { "lang": "JavaScript", @@ -12189,7 +12315,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/hooks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -12224,8 +12350,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/hooks", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/hooks
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/hooks", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/hooks
    " }, { "lang": "JavaScript", @@ -12275,7 +12401,7 @@ { "verb": "post", "requestPath": "/orgs/{org}/hooks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -12290,8 +12416,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/hooks \\\n -d '{\"name\":\"name\",\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"username\":\"username\",\"password\":\"password\"}}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/hooks \\\n  -d '{\"name\":\"name\",\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"username\":\"username\",\"password\":\"password\"}}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/hooks \\\n -d '{\"name\":\"name\",\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"username\":\"username\",\"password\":\"password\"}}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/hooks \\\n  -d '{\"name\":\"name\",\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"username\":\"username\",\"password\":\"password\"}}'
    " }, { "lang": "JavaScript", @@ -12722,7 +12848,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/hooks/{hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -12746,8 +12872,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/hooks/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/hooks/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/hooks/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/hooks/42
    " }, { "lang": "JavaScript", @@ -12797,7 +12923,7 @@ { "verb": "patch", "requestPath": "/orgs/{org}/hooks/{hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -12821,8 +12947,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/hooks/42 \\\n -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/hooks/42 \\\n  -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/hooks/42 \\\n -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/hooks/42 \\\n  -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'
    " }, { "lang": "JavaScript", @@ -13171,7 +13297,7 @@ { "verb": "delete", "requestPath": "/orgs/{org}/hooks/{hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -13195,8 +13321,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/hooks/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/hooks/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/hooks/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/hooks/42
    " }, { "lang": "JavaScript", @@ -13231,7 +13357,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -13245,7 +13371,7 @@ { "verb": "post", "requestPath": "/orgs/{org}/hooks/{hook_id}/pings", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -13269,8 +13395,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/hooks/42/pings", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/hooks/42/pings
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/hooks/42/pings", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/hooks/42/pings
    " }, { "lang": "JavaScript", @@ -13305,7 +13431,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -13319,7 +13445,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/installation", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -13345,8 +13471,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/orgs/ORG/installation", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  https://api.github.com/orgs/ORG/installation
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/installation", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/installation
    " }, { "lang": "JavaScript", @@ -13395,7 +13521,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/installations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -13441,8 +13567,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/orgs/ORG/installations", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  https://api.github.com/orgs/ORG/installations
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/installations", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/installations
    " }, { "lang": "JavaScript", @@ -13491,7 +13617,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/issues", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -13514,6 +13640,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -13611,8 +13738,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/issues", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/issues
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/issues", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/issues
    " }, { "lang": "JavaScript", @@ -13666,7 +13793,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/members", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -13732,8 +13859,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/members", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/members
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/members", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/members
    " }, { "lang": "JavaScript", @@ -13788,7 +13915,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/members/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -13812,8 +13939,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/members/USERNAME", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/members/USERNAME
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/members/USERNAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/members/USERNAME
    " }, { "lang": "JavaScript", @@ -13867,7 +13994,7 @@ { "verb": "delete", "requestPath": "/orgs/{org}/members/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -13891,8 +14018,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/members/USERNAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/members/USERNAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/members/USERNAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/members/USERNAME
    " }, { "lang": "JavaScript", @@ -13927,7 +14054,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -13941,7 +14068,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/memberships/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -13965,8 +14092,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/memberships/USERNAME", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/memberships/USERNAME
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/memberships/USERNAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/memberships/USERNAME
    " }, { "lang": "JavaScript", @@ -13975,7 +14102,7 @@ } ], "summary": "Get organization membership for a user", - "description": "In order to get a user's membership with an organization, the authenticated user must be an organization member.", + "description": "In order to get a user's membership with an organization, the authenticated user must be an organization member. The `state` parameter in the response can be used to identify the user's membership status.", "tags": [ "orgs" ], @@ -13998,7 +14125,7 @@ "subcategoryLabel": "Members", "notes": [], "bodyParameters": [], - "descriptionHTML": "

    In order to get a user's membership with an organization, the authenticated user must be an organization member.

    ", + "descriptionHTML": "

    In order to get a user's membership with an organization, the authenticated user must be an organization member. The state parameter in the response can be used to identify the user's membership status.

    ", "responses": [ { "httpStatusCode": "200", @@ -14006,18 +14133,6 @@ "description": "Response if user has an active admin membership with organization", "payload": "
    {\n  \"url\": \"https://api.github.com/orgs/octocat/memberships/defunkt\",\n  \"state\": \"active\",\n  \"role\": \"admin\",\n  \"organization_url\": \"https://api.github.com/orgs/octocat\",\n  \"organization\": {\n    \"login\": \"github\",\n    \"id\": 1,\n    \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n    \"url\": \"https://api.github.com/orgs/github\",\n    \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n    \"events_url\": \"https://api.github.com/orgs/github/events\",\n    \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n    \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n    \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n    \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"description\": \"A great organization\"\n  },\n  \"user\": {\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
    " }, - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response if user has an active membership with organization", - "payload": "
    {\n  \"url\": \"https://api.github.com/orgs/octocat/memberships/defunkt\",\n  \"state\": \"active\",\n  \"role\": \"member\",\n  \"organization_url\": \"https://api.github.com/orgs/octocat\",\n  \"organization\": {\n    \"login\": \"github\",\n    \"id\": 1,\n    \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n    \"url\": \"https://api.github.com/orgs/github\",\n    \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n    \"events_url\": \"https://api.github.com/orgs/github/events\",\n    \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n    \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n    \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n    \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"description\": \"A great organization\"\n  },\n  \"user\": {\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
    " - }, - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response if user has a pending membership with organization", - "payload": "
    {\n  \"url\": \"https://api.github.com/orgs/invitocat/memberships/defunkt\",\n  \"state\": \"pending\",\n  \"role\": \"member\",\n  \"organization_url\": \"https://api.github.com/orgs/invitocat\",\n  \"organization\": {\n    \"login\": \"github\",\n    \"id\": 1,\n    \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n    \"url\": \"https://api.github.com/orgs/github\",\n    \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n    \"events_url\": \"https://api.github.com/orgs/github/events\",\n    \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n    \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n    \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n    \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"description\": \"A great organization\"\n  },\n  \"user\": {\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
    " - }, { "httpStatusCode": "403", "httpStatusMessage": "Forbidden", @@ -14033,7 +14148,7 @@ { "verb": "put", "requestPath": "/orgs/{org}/memberships/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -14057,8 +14172,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/memberships/USERNAME \\\n -d '{\"role\":\"role\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/memberships/USERNAME \\\n  -d '{\"role\":\"role\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/memberships/USERNAME \\\n -d '{\"role\":\"role\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/memberships/USERNAME \\\n  -d '{\"role\":\"role\"}'
    " }, { "lang": "JavaScript", @@ -14135,13 +14250,7 @@ { "httpStatusCode": "200", "httpStatusMessage": "OK", - "description": "Response if user was previously unaffiliated with organization", - "payload": "
    {\n  \"url\": \"https://api.github.com/orgs/invitocat/memberships/defunkt\",\n  \"state\": \"pending\",\n  \"role\": \"admin\",\n  \"organization_url\": \"https://api.github.com/orgs/invitocat\",\n  \"organization\": {\n    \"login\": \"github\",\n    \"id\": 1,\n    \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n    \"url\": \"https://api.github.com/orgs/github\",\n    \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n    \"events_url\": \"https://api.github.com/orgs/github/events\",\n    \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n    \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n    \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n    \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"description\": \"A great organization\"\n  },\n  \"user\": {\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
    " - }, - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response if user already had membership with organization", + "description": "Response if user has an active admin membership with organization", "payload": "
    {\n  \"url\": \"https://api.github.com/orgs/octocat/memberships/defunkt\",\n  \"state\": \"active\",\n  \"role\": \"admin\",\n  \"organization_url\": \"https://api.github.com/orgs/octocat\",\n  \"organization\": {\n    \"login\": \"github\",\n    \"id\": 1,\n    \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n    \"url\": \"https://api.github.com/orgs/github\",\n    \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n    \"events_url\": \"https://api.github.com/orgs/github/events\",\n    \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n    \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n    \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n    \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"description\": \"A great organization\"\n  },\n  \"user\": {\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
    " }, { @@ -14159,7 +14268,7 @@ { "verb": "delete", "requestPath": "/orgs/{org}/memberships/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -14183,8 +14292,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/memberships/USERNAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/memberships/USERNAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/memberships/USERNAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/memberships/USERNAME
    " }, { "lang": "JavaScript", @@ -14219,7 +14328,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -14238,7 +14347,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/outside_collaborators", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -14288,8 +14397,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/outside_collaborators", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/outside_collaborators
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/outside_collaborators", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/outside_collaborators
    " }, { "lang": "JavaScript", @@ -14334,7 +14443,7 @@ { "verb": "put", "requestPath": "/orgs/{org}/outside_collaborators/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -14358,8 +14467,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/outside_collaborators/USERNAME", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/outside_collaborators/USERNAME
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/outside_collaborators/USERNAME", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/outside_collaborators/USERNAME
    " }, { "lang": "JavaScript", @@ -14390,8 +14499,6 @@ "subcategory": "outside-collaborators", "subcategoryLabel": "Outside collaborators", "notes": [], - "bodyParameters": [], - "descriptionHTML": "

    When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"Converting an organization member to an outside collaborator\".

    ", "responses": [ { "httpStatusCode": "202", @@ -14406,26 +14513,21 @@ { "httpStatusCode": "403", "httpStatusMessage": "Forbidden", - "description": "Response if user is the last owner of the organization", - "payload": "
    {\n  \"message\": \"Cannot convert the last owner to an outside collaborator\",\n  \"documentation_url\": \"https://docs.github.com/enterprise-server@2.19/rest/reference/orgs#convert-member-to-outside-collaborator\"\n}\n
    " - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Response if user is not a member of the organization", - "payload": "
    {\n  \"message\": \"<user> is not a member of the <organization> organization.\",\n  \"documentation_url\": \"https://docs.github.com/enterprise-server@2.19/rest/reference/orgs#convert-member-to-outside-collaborator\"\n}\n
    " + "description": "Response if user is the last owner of the organization or not a member of the organization" }, { "httpStatusCode": "404", "httpStatusMessage": "Not Found", "description": "Resource not found" } - ] + ], + "bodyParameters": [], + "descriptionHTML": "

    When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"Converting an organization member to an outside collaborator\".

    " }, { "verb": "delete", "requestPath": "/orgs/{org}/outside_collaborators/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -14449,8 +14551,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/outside_collaborators/USERNAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/outside_collaborators/USERNAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/outside_collaborators/USERNAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/outside_collaborators/USERNAME
    " }, { "lang": "JavaScript", @@ -14487,7 +14589,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "422", @@ -14500,7 +14602,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/pre-receive-hooks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -14530,13 +14632,44 @@ "default": 1 }, "descriptionHTML": "

    Page number of the results to fetch.

    " + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + }, + "descriptionHTML": "

    One of asc (ascending) or desc (descending).

    " + }, + { + "name": "sort", + "description": "The sort order for the response collection.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + }, + "descriptionHTML": "

    The sort order for the response collection.

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/orgs/ORG/pre-receive-hooks", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/orgs/ORG/pre-receive-hooks
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/pre-receive-hooks", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/pre-receive-hooks
    " }, { "lang": "JavaScript", @@ -14588,7 +14721,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -14612,8 +14745,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/orgs/ORG/pre-receive-hooks/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/orgs/ORG/pre-receive-hooks/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/pre-receive-hooks/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/pre-receive-hooks/42
    " }, { "lang": "JavaScript", @@ -14665,7 +14798,7 @@ { "verb": "patch", "requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -14689,8 +14822,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/orgs/ORG/pre-receive-hooks/42 \\\n -d '{\"enforcement\":\"enforcement\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/orgs/ORG/pre-receive-hooks/42 \\\n  -d '{\"enforcement\":\"enforcement\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/pre-receive-hooks/42 \\\n -d '{\"enforcement\":\"enforcement\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/pre-receive-hooks/42 \\\n  -d '{\"enforcement\":\"enforcement\"}'
    " }, { "lang": "JavaScript", @@ -14794,7 +14927,7 @@ { "verb": "delete", "requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -14818,8 +14951,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/orgs/ORG/pre-receive-hooks/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/orgs/ORG/pre-receive-hooks/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/pre-receive-hooks/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/pre-receive-hooks/42
    " }, { "lang": "JavaScript", @@ -14871,7 +15004,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/projects", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -14922,8 +15055,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/orgs/ORG/projects", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/orgs/ORG/projects
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/projects", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/projects
    " }, { "lang": "JavaScript", @@ -14978,7 +15111,7 @@ { "verb": "post", "requestPath": "/orgs/{org}/projects", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -14993,8 +15126,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/orgs/ORG/projects \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/orgs/ORG/projects \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/projects \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/projects \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -15124,7 +15257,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/public_members", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -15159,8 +15292,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/public_members", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/public_members
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/public_members", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/public_members
    " }, { "lang": "JavaScript", @@ -15205,7 +15338,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/public_members/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -15229,8 +15362,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/public_members/USERNAME", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/public_members/USERNAME
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/public_members/USERNAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/public_members/USERNAME
    " }, { "lang": "JavaScript", @@ -15279,7 +15412,7 @@ { "verb": "put", "requestPath": "/orgs/{org}/public_members/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -15303,8 +15436,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/public_members/USERNAME", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/public_members/USERNAME
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/public_members/USERNAME", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/public_members/USERNAME
    " }, { "lang": "JavaScript", @@ -15339,7 +15472,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -15353,7 +15486,7 @@ { "verb": "delete", "requestPath": "/orgs/{org}/public_members/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -15377,8 +15510,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/public_members/USERNAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/public_members/USERNAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/public_members/USERNAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/public_members/USERNAME
    " }, { "lang": "JavaScript", @@ -15413,7 +15546,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -15422,7 +15555,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/repos", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -15435,7 +15568,7 @@ }, { "name": "type", - "description": "Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`.", + "description": "Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Note: For GitHub AE, can be one of `all`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`.", "in": "query", "required": false, "schema": { @@ -15450,7 +15583,7 @@ "internal" ] }, - "descriptionHTML": "

    Specifies the types of repositories you want returned. Can be one of all, public, private, forks, sources, member, internal. Default: all. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, type can also be internal.

    " + "descriptionHTML": "

    Specifies the types of repositories you want returned. Can be one of all, public, private, forks, sources, member, internal. Note: For GitHub AE, can be one of all, private, forks, sources, member, internal. Default: all. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, type can also be internal.

    " }, { "name": "sort", @@ -15507,8 +15640,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/repos", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/repos
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/repos", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/repos
    " }, { "lang": "JavaScript", @@ -15564,7 +15697,7 @@ { "verb": "post", "requestPath": "/orgs/{org}/repos", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -15579,8 +15712,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/repos \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/repos \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/repos \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/repos \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -15589,7 +15722,7 @@ } ], "summary": "Create an organization repository", - "description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.19/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", + "description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.19/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository", "tags": [ "repos" ], @@ -15633,17 +15766,17 @@ }, "private": { "type": "boolean", - "description": "

    Either true to create a private repository or false to create a public one.

    ", + "description": "

    Whether the repository is private.

    ", "default": false, "name": "private", "in": "body", "rawType": "boolean", - "rawDescription": "Either `true` to create a private repository or `false` to create a public one.", + "rawDescription": "Whether the repository is private.", "childParamsGroups": [] }, "visibility": { "type": "string", - "description": "

    Can be public or private. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be internal. For more information, see \"Creating an internal repository\" in the GitHub Help documentation.
    \nThe visibility parameter overrides the private parameter when you use both parameters with the nebula-preview preview header.

    ", + "description": "

    Can be public or private. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be internal. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"Creating an internal repository\" in the GitHub Help documentation.
    \nThe visibility parameter overrides the private parameter when you use both parameters with the nebula-preview preview header.

    ", "enum": [ "public", "private", @@ -15653,7 +15786,7 @@ "name": "visibility", "in": "body", "rawType": "string", - "rawDescription": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", + "rawDescription": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", "childParamsGroups": [] }, "has_issues": { @@ -15814,7 +15947,7 @@ "category": "repos", "categoryLabel": "Repos", "notes": [], - "descriptionHTML": "

    Creates a new repository in the specified organization. The authenticated user must be a member of the organization.

    \n

    OAuth scope requirements

    \n

    When using OAuth, authorizations must include:

    \n
      \n
    • public_repo scope or repo scope to create a public repository
    • \n
    • repo scope to create a private repository
    • \n
    ", + "descriptionHTML": "

    Creates a new repository in the specified organization. The authenticated user must be a member of the organization.

    \n

    OAuth scope requirements

    \n

    When using OAuth, authorizations must include:

    \n
      \n
    • public_repo scope or repo scope to create a public repository. Note: For GitHub AE, use repo scope to create an internal repository.
    • \n
    • repo scope to create a private repository
    • \n
    ", "bodyParameters": [ { "type": "string", @@ -15845,17 +15978,17 @@ }, { "type": "boolean", - "description": "

    Either true to create a private repository or false to create a public one.

    ", + "description": "

    Whether the repository is private.

    ", "default": false, "name": "private", "in": "body", "rawType": "boolean", - "rawDescription": "Either `true` to create a private repository or `false` to create a public one.", + "rawDescription": "Whether the repository is private.", "childParamsGroups": [] }, { "type": "string", - "description": "

    Can be public or private. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be internal. For more information, see \"Creating an internal repository\" in the GitHub Help documentation.
    \nThe visibility parameter overrides the private parameter when you use both parameters with the nebula-preview preview header.

    ", + "description": "

    Can be public or private. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be internal. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"Creating an internal repository\" in the GitHub Help documentation.
    \nThe visibility parameter overrides the private parameter when you use both parameters with the nebula-preview preview header.

    ", "enum": [ "public", "private", @@ -15865,7 +15998,7 @@ "name": "visibility", "in": "body", "rawType": "string", - "rawDescription": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", + "rawDescription": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", "childParamsGroups": [] }, { @@ -16008,7 +16141,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/teams", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -16043,8 +16176,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams
    " }, { "lang": "JavaScript", @@ -16092,7 +16225,7 @@ { "verb": "post", "requestPath": "/orgs/{org}/teams", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -16107,8 +16240,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -16340,7 +16473,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -16365,8 +16498,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG
    " }, { "lang": "JavaScript", @@ -16414,7 +16547,7 @@ { "verb": "get", "requestPath": "/projects/columns/cards/{card_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "card_id", @@ -16430,8 +16563,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/cards/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/cards/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/columns/cards/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/columns/cards/42
    " }, { "lang": "JavaScript", @@ -16503,7 +16636,7 @@ { "verb": "patch", "requestPath": "/projects/columns/cards/{card_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "card_id", @@ -16519,8 +16652,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/cards/42 \\\n -d '{\"note\":\"note\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/cards/42 \\\n  -d '{\"note\":\"note\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/columns/cards/42 \\\n -d '{\"note\":\"note\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/columns/cards/42 \\\n  -d '{\"note\":\"note\"}'
    " }, { "lang": "JavaScript", @@ -16651,7 +16784,7 @@ { "verb": "delete", "requestPath": "/projects/columns/cards/{card_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "card_id", @@ -16667,8 +16800,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/cards/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/cards/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/columns/cards/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/columns/cards/42
    " }, { "lang": "JavaScript", @@ -16710,7 +16843,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -16739,7 +16872,7 @@ { "verb": "post", "requestPath": "/projects/columns/cards/{card_id}/moves", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "card_id", @@ -16755,8 +16888,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/cards/42/moves \\\n -d '{\"position\":\"position\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/cards/42/moves \\\n  -d '{\"position\":\"position\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/columns/cards/42/moves \\\n -d '{\"position\":\"position\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/columns/cards/42/moves \\\n  -d '{\"position\":\"position\"}'
    " }, { "lang": "JavaScript", @@ -16889,7 +17022,7 @@ { "verb": "get", "requestPath": "/projects/columns/{column_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "column_id", @@ -16905,8 +17038,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/columns/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/columns/42
    " }, { "lang": "JavaScript", @@ -16978,7 +17111,7 @@ { "verb": "patch", "requestPath": "/projects/columns/{column_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "column_id", @@ -16994,8 +17127,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/42 \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/42 \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/columns/42 \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/columns/42 \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -17097,7 +17230,7 @@ { "verb": "delete", "requestPath": "/projects/columns/{column_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "column_id", @@ -17113,8 +17246,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/columns/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/columns/42
    " }, { "lang": "JavaScript", @@ -17156,7 +17289,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -17180,7 +17313,7 @@ { "verb": "get", "requestPath": "/projects/columns/{column_id}/cards", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "column_id", @@ -17232,8 +17365,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/42/cards", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/42/cards
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/columns/42/cards", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/columns/42/cards
    " }, { "lang": "JavaScript", @@ -17300,7 +17433,7 @@ { "verb": "post", "requestPath": "/projects/columns/{column_id}/cards", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "column_id", @@ -17316,8 +17449,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/42/cards \\\n -d '{\"note\":\"note\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/42/cards \\\n  -d '{\"note\":\"note\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/columns/42/cards \\\n -d '{\"note\":\"note\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/columns/42/cards \\\n  -d '{\"note\":\"note\"}'
    " }, { "lang": "JavaScript", @@ -17437,7 +17570,7 @@ { "verb": "post", "requestPath": "/projects/columns/{column_id}/moves", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "column_id", @@ -17453,8 +17586,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/42/moves \\\n -d '{\"position\":\"position\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/42/moves \\\n  -d '{\"position\":\"position\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/columns/42/moves \\\n -d '{\"position\":\"position\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/columns/42/moves \\\n  -d '{\"position\":\"position\"}'
    " }, { "lang": "JavaScript", @@ -17562,7 +17695,7 @@ { "verb": "get", "requestPath": "/projects/{project_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "project_id", @@ -17577,8 +17710,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/42
    " }, { "lang": "JavaScript", @@ -17643,7 +17776,7 @@ { "verb": "patch", "requestPath": "/projects/{project_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "project_id", @@ -17658,8 +17791,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42 \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/42 \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/42 \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/42 \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -17861,7 +17994,7 @@ { "verb": "delete", "requestPath": "/projects/{project_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "project_id", @@ -17876,8 +18009,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/42
    " }, { "lang": "JavaScript", @@ -17951,7 +18084,7 @@ { "verb": "get", "requestPath": "/projects/{project_id}/collaborators", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "project_id", @@ -18002,8 +18135,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42/collaborators", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/42/collaborators
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/42/collaborators", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/42/collaborators
    " }, { "lang": "JavaScript", @@ -18085,7 +18218,7 @@ { "verb": "put", "requestPath": "/projects/{project_id}/collaborators/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "project_id", @@ -18109,8 +18242,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42/collaborators/USERNAME \\\n -d '{\"permission\":\"permission\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/42/collaborators/USERNAME \\\n  -d '{\"permission\":\"permission\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/42/collaborators/USERNAME \\\n -d '{\"permission\":\"permission\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/42/collaborators/USERNAME \\\n  -d '{\"permission\":\"permission\"}'
    " }, { "lang": "JavaScript", @@ -18179,7 +18312,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -18235,7 +18368,7 @@ { "verb": "delete", "requestPath": "/projects/{project_id}/collaborators/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "project_id", @@ -18259,8 +18392,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42/collaborators/USERNAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/42/collaborators/USERNAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/42/collaborators/USERNAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/42/collaborators/USERNAME
    " }, { "lang": "JavaScript", @@ -18302,7 +18435,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -18341,7 +18474,7 @@ { "verb": "get", "requestPath": "/projects/{project_id}/collaborators/{username}/permission", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "project_id", @@ -18365,8 +18498,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42/collaborators/USERNAME/permission", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/42/collaborators/USERNAME/permission
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/42/collaborators/USERNAME/permission", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/42/collaborators/USERNAME/permission
    " }, { "lang": "JavaScript", @@ -18448,7 +18581,7 @@ { "verb": "get", "requestPath": "/projects/{project_id}/columns", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "project_id", @@ -18483,8 +18616,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42/columns", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/42/columns
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/42/columns", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/42/columns
    " }, { "lang": "JavaScript", @@ -18551,7 +18684,7 @@ { "verb": "post", "requestPath": "/projects/{project_id}/columns", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "project_id", @@ -18566,8 +18699,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42/columns \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/42/columns \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/42/columns \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/42/columns \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -18674,13 +18807,13 @@ { "verb": "get", "requestPath": "/rate_limit", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/rate_limit", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/rate_limit
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/rate_limit", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/rate_limit
    " }, { "lang": "JavaScript", @@ -18733,7 +18866,7 @@ { "verb": "delete", "requestPath": "/reactions/{reaction_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -18759,8 +18892,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/reactions/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/reactions/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/reactions/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/reactions/42
    " }, { "lang": "JavaScript", @@ -18798,7 +18931,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -18807,7 +18940,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -18831,8 +18964,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world
    " }, { "lang": "JavaScript", @@ -18909,7 +19042,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -18933,8 +19066,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -19328,7 +19461,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -19352,8 +19485,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world
    " }, { "lang": "JavaScript", @@ -19388,7 +19521,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -19406,7 +19539,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/assignees", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -19450,8 +19583,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/assignees", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/assignees
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/assignees", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/assignees
    " }, { "lang": "JavaScript", @@ -19501,7 +19634,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/assignees/{assignee}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -19534,8 +19667,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/assignees/ASSIGNEE", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/assignees/ASSIGNEE
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/assignees/ASSIGNEE", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/assignees/ASSIGNEE
    " }, { "lang": "JavaScript", @@ -19584,7 +19717,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -19638,8 +19771,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches
    " }, { "lang": "JavaScript", @@ -19677,12 +19810,6 @@ "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "
    [\n  {\n    \"name\": \"master\",\n    \"commit\": {\n      \"sha\": \"c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc\",\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc\"\n    },\n    \"protected\": true\n  }\n]\n
    " - }, - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "With protection", "payload": "
    [\n  {\n    \"name\": \"master\",\n    \"commit\": {\n      \"sha\": \"c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc\",\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc\"\n    },\n    \"protected\": true,\n    \"protection\": {\n      \"enabled\": true,\n      \"required_status_checks\": {\n        \"enforcement_level\": \"non_admins\",\n        \"contexts\": [\n          \"ci-test\",\n          \"linter\"\n        ]\n      }\n    },\n    \"protection_url\": \"https://api.github.com/repos/octocat/hello-world/branches/master/protection\"\n  }\n]\n
    " }, { @@ -19695,7 +19822,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -19730,8 +19857,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH
    " }, { "lang": "JavaScript", @@ -19786,7 +19913,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -19821,8 +19948,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection
    " }, { "lang": "JavaScript", @@ -19879,7 +20006,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -19914,8 +20041,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection \\\n -d '{\"required_status_checks\":{\"strict\":true,\"contexts\":[\"contexts\"]},\"enforce_admins\":true,\"required_pull_request_reviews\":{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":42},\"restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"],\"apps\":[\"apps\"]}}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection \\\n  -d '{\"required_status_checks\":{\"strict\":true,\"contexts\":[\"contexts\"]},\"enforce_admins\":true,\"required_pull_request_reviews\":{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":42},\"restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"],\"apps\":[\"apps\"]}}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection \\\n -d '{\"required_status_checks\":{\"strict\":true,\"contexts\":[\"contexts\"]},\"enforce_admins\":true,\"required_pull_request_reviews\":{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":42},\"restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"],\"apps\":[\"apps\"]}}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection \\\n  -d '{\"required_status_checks\":{\"strict\":true,\"contexts\":[\"contexts\"]},\"enforce_admins\":true,\"required_pull_request_reviews\":{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":42},\"restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"],\"apps\":[\"apps\"]}}'
    " }, { "lang": "JavaScript", @@ -20918,7 +21045,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -20953,8 +21080,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection
    " }, { "lang": "JavaScript", @@ -20989,7 +21116,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -21003,7 +21130,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -21038,8 +21165,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins
    " }, { "lang": "JavaScript", @@ -21084,7 +21211,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -21119,8 +21246,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins
    " }, { "lang": "JavaScript", @@ -21165,7 +21292,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -21200,8 +21327,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins
    " }, { "lang": "JavaScript", @@ -21250,7 +21377,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -21285,8 +21412,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews
    " }, { "lang": "JavaScript", @@ -21337,7 +21464,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -21372,8 +21499,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews \\\n -d '{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]}}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews \\\n  -d '{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]}}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews \\\n -d '{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]}}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews \\\n  -d '{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]}}'
    " }, { "lang": "JavaScript", @@ -21643,7 +21770,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -21678,8 +21805,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews
    " }, { "lang": "JavaScript", @@ -21728,7 +21855,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -21763,8 +21890,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures
    " }, { "lang": "JavaScript", @@ -21821,7 +21948,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -21856,8 +21983,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures
    " }, { "lang": "JavaScript", @@ -21914,7 +22041,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -21949,8 +22076,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures
    " }, { "lang": "JavaScript", @@ -22006,7 +22133,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -22041,8 +22168,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks
    " }, { "lang": "JavaScript", @@ -22092,7 +22219,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -22127,8 +22254,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks \\\n -d '{\"strict\":true}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks \\\n  -d '{\"strict\":true}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks \\\n -d '{\"strict\":true}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks \\\n  -d '{\"strict\":true}'
    " }, { "lang": "JavaScript", @@ -22243,7 +22370,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -22278,8 +22405,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks
    " }, { "lang": "JavaScript", @@ -22323,7 +22450,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -22358,8 +22485,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts
    " }, { "lang": "JavaScript", @@ -22409,7 +22536,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -22444,8 +22571,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n  -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n  -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'
    " }, { "lang": "JavaScript", @@ -22550,7 +22677,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -22585,8 +22712,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n  -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n  -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'
    " }, { "lang": "JavaScript", @@ -22686,7 +22813,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -22721,8 +22848,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n  -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n  -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'
    " }, { "lang": "JavaScript", @@ -22822,7 +22949,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -22857,8 +22984,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions
    " }, { "lang": "JavaScript", @@ -22908,7 +23035,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -22943,8 +23070,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions
    " }, { "lang": "JavaScript", @@ -22988,7 +23115,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -23023,8 +23150,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps
    " }, { "lang": "JavaScript", @@ -23074,7 +23201,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -23109,8 +23236,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps \\\n -d '{\"apps\":{\"apps\":[\"apps\"]}}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps \\\n  -d '{\"apps\":{\"apps\":[\"apps\"]}}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps \\\n -d '{\"apps\":{\"apps\":[\"apps\"]}}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps \\\n  -d '{\"apps\":{\"apps\":[\"apps\"]}}'
    " }, { "lang": "JavaScript", @@ -23205,7 +23332,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -23240,8 +23367,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps \\\n -d '{\"apps\":{\"apps\":[\"apps\"]}}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps \\\n  -d '{\"apps\":{\"apps\":[\"apps\"]}}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps \\\n -d '{\"apps\":{\"apps\":[\"apps\"]}}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps \\\n  -d '{\"apps\":{\"apps\":[\"apps\"]}}'
    " }, { "lang": "JavaScript", @@ -23336,7 +23463,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -23371,8 +23498,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps \\\n -d '{\"apps\":{\"apps\":[\"apps\"]}}'", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps \\\n  -d '{\"apps\":{\"apps\":[\"apps\"]}}'
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps \\\n -d '{\"apps\":{\"apps\":[\"apps\"]}}'", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps \\\n  -d '{\"apps\":{\"apps\":[\"apps\"]}}'
    " }, { "lang": "JavaScript", @@ -23467,7 +23594,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -23502,8 +23629,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams
    " }, { "lang": "JavaScript", @@ -23553,7 +23680,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -23588,8 +23715,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n -d '{\"teams\":{\"teams\":[\"teams\"]}}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n  -d '{\"teams\":{\"teams\":[\"teams\"]}}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n -d '{\"teams\":{\"teams\":[\"teams\"]}}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n  -d '{\"teams\":{\"teams\":[\"teams\"]}}'
    " }, { "lang": "JavaScript", @@ -23684,7 +23811,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -23719,8 +23846,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n -d '{\"teams\":{\"teams\":[\"teams\"]}}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n  -d '{\"teams\":{\"teams\":[\"teams\"]}}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n -d '{\"teams\":{\"teams\":[\"teams\"]}}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n  -d '{\"teams\":{\"teams\":[\"teams\"]}}'
    " }, { "lang": "JavaScript", @@ -23815,7 +23942,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -23850,8 +23977,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n -d '{\"teams\":{\"teams\":[\"teams\"]}}'", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n  -d '{\"teams\":{\"teams\":[\"teams\"]}}'
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n -d '{\"teams\":{\"teams\":[\"teams\"]}}'", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n  -d '{\"teams\":{\"teams\":[\"teams\"]}}'
    " }, { "lang": "JavaScript", @@ -23946,7 +24073,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -23981,8 +24108,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users
    " }, { "lang": "JavaScript", @@ -24032,7 +24159,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -24067,8 +24194,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n -d '{\"users\":{\"users\":[\"users\"]}}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n  -d '{\"users\":{\"users\":[\"users\"]}}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n -d '{\"users\":{\"users\":[\"users\"]}}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n  -d '{\"users\":{\"users\":[\"users\"]}}'
    " }, { "lang": "JavaScript", @@ -24163,7 +24290,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -24198,8 +24325,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n -d '{\"users\":{\"users\":[\"users\"]}}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n  -d '{\"users\":{\"users\":[\"users\"]}}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n -d '{\"users\":{\"users\":[\"users\"]}}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n  -d '{\"users\":{\"users\":[\"users\"]}}'
    " }, { "lang": "JavaScript", @@ -24294,7 +24421,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -24329,8 +24456,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n -d '{\"users\":{\"users\":[\"users\"]}}'", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n  -d '{\"users\":{\"users\":[\"users\"]}}'
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n -d '{\"users\":{\"users\":[\"users\"]}}'", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n  -d '{\"users\":{\"users\":[\"users\"]}}'
    " }, { "lang": "JavaScript", @@ -24425,7 +24552,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/check-runs", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -24449,8 +24576,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-runs \\\n -d '{\"name\":\"name\",\"head_sha\":\"head_sha\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/check-runs \\\n  -d '{\"name\":\"name\",\"head_sha\":\"head_sha\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-runs \\\n -d '{\"name\":\"name\",\"head_sha\":\"head_sha\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-runs \\\n  -d '{\"name\":\"name\",\"head_sha\":\"head_sha\"}'
    " }, { "lang": "JavaScript", @@ -25427,7 +25554,7 @@ "name", "head_sha" ], - "anyOf": [ + "oneOf": [ { "properties": { "status": { @@ -25437,6 +25564,7 @@ } }, "required": [ + "status", "conclusion" ], "additionalProperties": true @@ -25456,7 +25584,7 @@ }, "examples": { "example-of-in-progress-conclusion": { - "summary": "Example of in_progress conclusion", + "summary": "Response for in_progress conclusion", "value": { "name": "mighty_readme", "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -25471,7 +25599,7 @@ } }, "example-of-completed-conclusion": { - "summary": "Example of completed conclusion", + "summary": "Response for completed conclusion", "value": { "name": "mighty_readme", "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -25545,12 +25673,6 @@ "notes": [], "descriptionHTML": "

    Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

    \n

    Creates a new check run for a specific commit in a repository. Your GitHub App must have the checks:write permission to create check runs.

    \n

    In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.

    ", "responses": [ - { - "httpStatusCode": "201", - "httpStatusMessage": "Created", - "description": "Response for in_progress conclusion", - "payload": "
    {\n  \"id\": 4,\n  \"head_sha\": \"ce587453ced02b1526dfb4cb910479d431683101\",\n  \"node_id\": \"MDg6Q2hlY2tSdW40\",\n  \"external_id\": \"42\",\n  \"url\": \"https://api.github.com/repos/github/hello-world/check-runs/4\",\n  \"html_url\": \"https://github.com/github/hello-world/runs/4\",\n  \"details_url\": \"https://example.com\",\n  \"status\": \"in_progress\",\n  \"conclusion\": \"neutral\",\n  \"started_at\": \"2018-05-04T01:14:52Z\",\n  \"completed_at\": null,\n  \"output\": {\n    \"title\": \"Mighty Readme Report\",\n    \"summary\": \"\",\n    \"text\": \"\",\n    \"annotations_count\": 1,\n    \"annotations_url\": \"https://api.github.com/repos/github/hello-world/check-runs/4/annotations\"\n  },\n  \"name\": \"mighty_readme\",\n  \"check_suite\": {\n    \"id\": 5\n  },\n  \"app\": {\n    \"id\": 1,\n    \"slug\": \"octoapp\",\n    \"node_id\": \"MDExOkludGVncmF0aW9uMQ==\",\n    \"owner\": {\n      \"login\": \"github\",\n      \"id\": 1,\n      \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n      \"url\": \"https://api.github.com/orgs/github\",\n      \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n      \"events_url\": \"https://api.github.com/orgs/github/events\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\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      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": true\n    },\n    \"name\": \"Octocat App\",\n    \"description\": \"\",\n    \"external_url\": \"https://example.com\",\n    \"html_url\": \"https://github.com/apps/octoapp\",\n    \"created_at\": \"2017-07-08T16:18:44-04:00\",\n    \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n    \"permissions\": {\n      \"metadata\": \"read\",\n      \"contents\": \"read\",\n      \"issues\": \"write\",\n      \"single_file\": \"write\"\n    },\n    \"events\": [\n      \"push\",\n      \"pull_request\"\n    ]\n  },\n  \"pull_requests\": [\n    {\n      \"url\": \"https://api.github.com/repos/github/hello-world/pulls/1\",\n      \"id\": 1934,\n      \"number\": 3956,\n      \"head\": {\n        \"ref\": \"say-hello\",\n        \"sha\": \"3dca65fa3e8d4b3da3f3d056c59aee1c50f41390\",\n        \"repo\": {\n          \"id\": 526,\n          \"url\": \"https://api.github.com/repos/github/hello-world\",\n          \"name\": \"hello-world\"\n        }\n      },\n      \"base\": {\n        \"ref\": \"master\",\n        \"sha\": \"e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f\",\n        \"repo\": {\n          \"id\": 526,\n          \"url\": \"https://api.github.com/repos/github/hello-world\",\n          \"name\": \"hello-world\"\n        }\n      }\n    }\n  ]\n}\n
    " - }, { "httpStatusCode": "201", "httpStatusMessage": "Created", @@ -26512,7 +26634,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/check-runs/{check_run_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -26546,8 +26668,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-runs/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/check-runs/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-runs/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-runs/42
    " }, { "lang": "JavaScript", @@ -26599,7 +26721,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/check-runs/{check_run_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -26633,8 +26755,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-runs/42 \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/check-runs/42 \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-runs/42 \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-runs/42 \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -28636,7 +28758,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/check-runs/{check_run_id}/annotations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -28690,8 +28812,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-runs/42/annotations", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/check-runs/42/annotations
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-runs/42/annotations", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-runs/42/annotations
    " }, { "lang": "JavaScript", @@ -28743,7 +28865,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/check-suites", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -28767,8 +28889,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-suites \\\n -d '{\"head_sha\":\"head_sha\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/check-suites \\\n  -d '{\"head_sha\":\"head_sha\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-suites \\\n -d '{\"head_sha\":\"head_sha\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-suites \\\n  -d '{\"head_sha\":\"head_sha\"}'
    " }, { "lang": "JavaScript", @@ -28856,7 +28978,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/check-suites/preferences", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -28880,8 +29002,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-suites/preferences \\\n -d '{\"auto_trigger_checks\":[{\"app_id\":42,\"setting\":true}]}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/check-suites/preferences \\\n  -d '{\"auto_trigger_checks\":[{\"app_id\":42,\"setting\":true}]}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-suites/preferences \\\n -d '{\"auto_trigger_checks\":[{\"app_id\":42,\"setting\":true}]}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-suites/preferences \\\n  -d '{\"auto_trigger_checks\":[{\"app_id\":42,\"setting\":true}]}'
    " }, { "lang": "JavaScript", @@ -29081,7 +29203,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/check-suites/{check_suite_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -29115,8 +29237,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-suites/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/check-suites/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-suites/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-suites/42
    " }, { "lang": "JavaScript", @@ -29168,7 +29290,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -29262,8 +29384,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-suites/42/check-runs", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/check-suites/42/check-runs
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-suites/42/check-runs", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-suites/42/check-runs
    " }, { "lang": "JavaScript", @@ -29315,7 +29437,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -29349,8 +29471,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-suites/42/rerequest", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/check-suites/42/rerequest
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-suites/42/rerequest", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-suites/42/rerequest
    " }, { "lang": "JavaScript", @@ -29401,7 +29523,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/collaborators", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -29461,8 +29583,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/collaborators", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/collaborators
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/collaborators", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/collaborators
    " }, { "lang": "JavaScript", @@ -29512,7 +29634,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -29545,8 +29667,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/collaborators/USERNAME", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/collaborators/USERNAME
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/collaborators/USERNAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/collaborators/USERNAME
    " }, { "lang": "JavaScript", @@ -29595,7 +29717,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -29628,8 +29750,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/collaborators/USERNAME \\\n -d '{\"permission\":\"permission\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/collaborators/USERNAME \\\n  -d '{\"permission\":\"permission\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/collaborators/USERNAME \\\n -d '{\"permission\":\"permission\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/collaborators/USERNAME \\\n  -d '{\"permission\":\"permission\"}'
    " }, { "lang": "JavaScript", @@ -29754,7 +29876,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -29787,8 +29909,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/collaborators/USERNAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/collaborators/USERNAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/collaborators/USERNAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/collaborators/USERNAME
    " }, { "lang": "JavaScript", @@ -29823,7 +29945,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -29832,7 +29954,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/collaborators/{username}/permission", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -29865,8 +29987,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/collaborators/USERNAME/permission", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/collaborators/USERNAME/permission
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/collaborators/USERNAME/permission", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/collaborators/USERNAME/permission
    " }, { "lang": "JavaScript", @@ -29916,7 +30038,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -29960,8 +30082,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/comments", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/comments
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/comments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/comments
    " }, { "lang": "JavaScript", @@ -30013,7 +30135,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -30047,8 +30169,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/comments/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/comments/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/comments/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/comments/42
    " }, { "lang": "JavaScript", @@ -30105,7 +30227,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -30139,8 +30261,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/comments/42 \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/comments/42 \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/comments/42 \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/comments/42 \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -30226,7 +30348,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -30260,8 +30382,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/comments/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/comments/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/comments/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/comments/42
    " }, { "lang": "JavaScript", @@ -30296,7 +30418,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -30310,7 +30432,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -30384,8 +30506,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/comments/42/reactions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/comments/42/reactions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/comments/42/reactions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/comments/42/reactions
    " }, { "lang": "JavaScript", @@ -30445,7 +30567,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -30479,8 +30601,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/comments/42/reactions \\\n -d '{\"content\":\"content\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/comments/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/comments/42/reactions \\\n -d '{\"content\":\"content\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/comments/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " }, { "lang": "JavaScript", @@ -30602,7 +30724,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/commits", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -30691,13 +30813,35 @@ "default": 1 }, "descriptionHTML": "

    Page number of the results to fetch.

    " + }, + { + "name": "top", + "description": "legacy parameter for pagination.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    legacy parameter for pagination.

    " + }, + { + "name": "last_sha", + "description": "legacy parameter for pagination.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    legacy parameter for pagination.

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/commits
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits
    " }, { "lang": "JavaScript", @@ -30762,7 +30906,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -30797,8 +30941,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.groot-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits/COMMIT_SHA/branches-where-head", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.groot-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/commits/COMMIT_SHA/branches-where-head
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.groot-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/COMMIT_SHA/branches-where-head", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.groot-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/COMMIT_SHA/branches-where-head
    " }, { "lang": "JavaScript", @@ -30860,7 +31004,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -30915,8 +31059,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits/COMMIT_SHA/comments", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/commits/COMMIT_SHA/comments
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/COMMIT_SHA/comments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/COMMIT_SHA/comments
    " }, { "lang": "JavaScript", @@ -30968,7 +31112,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -31003,8 +31147,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits/COMMIT_SHA/comments \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/commits/COMMIT_SHA/comments \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/COMMIT_SHA/comments \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/COMMIT_SHA/comments \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -31153,7 +31297,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/pulls", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -31208,8 +31352,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.groot-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits/COMMIT_SHA/pulls", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.groot-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/commits/COMMIT_SHA/pulls
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.groot-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/COMMIT_SHA/pulls", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.groot-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/COMMIT_SHA/pulls
    " }, { "lang": "JavaScript", @@ -31266,7 +31410,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/commits/{ref}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -31286,23 +31430,43 @@ }, "descriptionHTML": "" }, + { + "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.

    " + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "descriptionHTML": "

    Results per page (max 100).

    " + }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    ref+ parameter

    " + "descriptionHTML": "

    ref parameter

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits/REF", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/commits/REF
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/REF", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/REF
    " }, { "lang": "JavaScript", @@ -31362,7 +31526,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/commits/{ref}/check-runs", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -31384,14 +31548,14 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    ref+ parameter

    " + "descriptionHTML": "

    ref parameter

    " }, { "name": "check_name", @@ -31452,13 +31616,22 @@ "default": 1 }, "descriptionHTML": "

    Page number of the results to fetch.

    " + }, + { + "name": "app_id", + "in": "query", + "required": false, + "schema": { + "type": "integer" + }, + "descriptionHTML": "" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits/REF/check-runs", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/commits/REF/check-runs
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/REF/check-runs", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/REF/check-runs
    " }, { "lang": "JavaScript", @@ -31510,7 +31683,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/commits/{ref}/check-suites", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -31532,14 +31705,14 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    ref+ parameter

    " + "descriptionHTML": "

    ref parameter

    " }, { "name": "app_id", @@ -31586,8 +31759,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits/REF/check-suites", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/commits/REF/check-suites
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/REF/check-suites", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/REF/check-suites
    " }, { "lang": "JavaScript", @@ -31639,7 +31812,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/commits/{ref}/status", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -31661,21 +31834,41 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    ref+ parameter

    " + "descriptionHTML": "

    ref parameter

    " + }, + { + "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/repos/octocat/hello-world/commits/REF/status", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/commits/REF/status
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/REF/status", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/REF/status
    " }, { "lang": "JavaScript", @@ -31725,7 +31918,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/commits/{ref}/statuses", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -31747,14 +31940,14 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    ref+ parameter

    " + "descriptionHTML": "

    ref parameter

    " }, { "name": "per_page", @@ -31780,8 +31973,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits/REF/statuses", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/commits/REF/statuses
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/REF/statuses", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/REF/statuses
    " }, { "lang": "JavaScript", @@ -31831,7 +32024,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/compare/{base}...{head}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -31873,8 +32066,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/compare/BASE...HEAD", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/compare/BASE...HEAD
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/compare/BASE...HEAD", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/compare/BASE...HEAD
    " }, { "lang": "JavaScript", @@ -31929,7 +32122,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/contents/{path}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -31951,14 +32144,14 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    path+ parameter

    " + "descriptionHTML": "

    path parameter

    " }, { "name": "ref", @@ -31974,8 +32167,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/contents/PATH", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/contents/PATH
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/contents/PATH", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/contents/PATH
    " }, { "lang": "JavaScript", @@ -32053,7 +32246,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/contents/{path}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -32075,21 +32268,21 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    path+ parameter

    " + "descriptionHTML": "

    path parameter

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/contents/PATH \\\n -d '{\"message\":\"message\",\"content\":\"content\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/contents/PATH \\\n  -d '{\"message\":\"message\",\"content\":\"content\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/contents/PATH \\\n -d '{\"message\":\"message\",\"content\":\"content\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/contents/PATH \\\n  -d '{\"message\":\"message\",\"content\":\"content\"}'
    " }, { "lang": "JavaScript", @@ -32576,7 +32769,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/contents/{path}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -32598,21 +32791,21 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    path+ parameter

    " + "descriptionHTML": "

    path parameter

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/contents/PATH \\\n -d '{\"message\":\"message\",\"sha\":\"sha\"}'", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/contents/PATH \\\n  -d '{\"message\":\"message\",\"sha\":\"sha\"}'
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/contents/PATH \\\n -d '{\"message\":\"message\",\"sha\":\"sha\"}'", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/contents/PATH \\\n  -d '{\"message\":\"message\",\"sha\":\"sha\"}'
    " }, { "lang": "JavaScript", @@ -32975,7 +33168,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/contributors", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -33029,8 +33222,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/contributors", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/contributors
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/contributors", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/contributors
    " }, { "lang": "JavaScript", @@ -33088,7 +33281,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/deployments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -33148,7 +33341,8 @@ "required": false, "schema": { "type": "string", - "default": "none" + "default": "none", + "nullable": true }, "descriptionHTML": "

    The name of the environment that was deployed to (e.g., staging or production).

    " }, @@ -33176,8 +33370,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/deployments", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/deployments
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/deployments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/deployments
    " }, { "lang": "JavaScript", @@ -33229,7 +33423,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/deployments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -33253,8 +33447,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/deployments \\\n -d '{\"ref\":\"ref\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/deployments \\\n  -d '{\"ref\":\"ref\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/deployments \\\n -d '{\"ref\":\"ref\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/deployments \\\n  -d '{\"ref\":\"ref\"}'
    " }, { "lang": "JavaScript", @@ -33553,12 +33747,6 @@ "description": "Simple example", "payload": "
    {\n  \"url\": \"https://api.github.com/repos/octocat/example/deployments/1\",\n  \"id\": 1,\n  \"node_id\": \"MDEwOkRlcGxveW1lbnQx\",\n  \"sha\": \"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\n  \"ref\": \"topic-branch\",\n  \"task\": \"deploy\",\n  \"payload\": {},\n  \"original_environment\": \"staging\",\n  \"environment\": \"production\",\n  \"description\": \"Deploy request from hubot\",\n  \"creator\": {\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  \"created_at\": \"2012-07-20T01:19:13Z\",\n  \"updated_at\": \"2012-07-20T01:19:13Z\",\n  \"statuses_url\": \"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/example\",\n  \"transient_environment\": false,\n  \"production_environment\": true\n}\n
    " }, - { - "httpStatusCode": "201", - "httpStatusMessage": "Created", - "description": "Advanced example", - "payload": "
    {\n  \"url\": \"https://api.github.com/repos/octocat/example/deployments/1\",\n  \"id\": 1,\n  \"node_id\": \"MDEwOkRlcGxveW1lbnQx\",\n  \"sha\": \"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\n  \"ref\": \"topic-branch\",\n  \"task\": \"deploy\",\n  \"payload\": {},\n  \"original_environment\": \"staging\",\n  \"environment\": \"production\",\n  \"description\": \"Deploy request from hubot\",\n  \"creator\": {\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  \"created_at\": \"2012-07-20T01:19:13Z\",\n  \"updated_at\": \"2012-07-20T01:19:13Z\",\n  \"statuses_url\": \"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/example\",\n  \"transient_environment\": false,\n  \"production_environment\": true\n}\n
    " - }, { "httpStatusCode": "202", "httpStatusMessage": "Accepted", @@ -33568,14 +33756,7 @@ { "httpStatusCode": "409", "httpStatusMessage": "Conflict", - "description": "Merge conflict response", - "payload": "
    {\n  \"message\": \"Conflict merging master into topic-branch\"\n}\n
    " - }, - { - "httpStatusCode": "409", - "httpStatusMessage": "Conflict", - "description": "Failed commit status checks", - "payload": "
    {\n  \"message\": \"Conflict: Commit status checks failed for topic-branch.\"\n}\n
    " + "description": "Response when there is a merge conflict or the commit s status checks failed" }, { "httpStatusCode": "422", @@ -33587,7 +33768,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -33621,8 +33802,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/deployments/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/deployments/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/deployments/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/deployments/42
    " }, { "lang": "JavaScript", @@ -33685,7 +33866,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -33739,8 +33920,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/deployments/42/statuses", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/deployments/42/statuses
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/deployments/42/statuses", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/deployments/42/statuses
    " }, { "lang": "JavaScript", @@ -33803,7 +33984,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -33837,8 +34018,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/deployments/42/statuses \\\n -d '{\"state\":\"state\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/deployments/42/statuses \\\n  -d '{\"state\":\"state\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/deployments/42/statuses \\\n -d '{\"state\":\"state\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/deployments/42/statuses \\\n  -d '{\"state\":\"state\"}'
    " }, { "lang": "JavaScript", @@ -34084,7 +34265,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -34127,8 +34308,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/deployments/42/statuses/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/deployments/42/statuses/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/deployments/42/statuses/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/deployments/42/statuses/42
    " }, { "lang": "JavaScript", @@ -34202,7 +34383,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/events", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -34246,8 +34427,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/events", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/events
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/events", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/events
    " }, { "lang": "JavaScript", @@ -34291,7 +34472,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/forks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -34321,7 +34502,8 @@ "enum": [ "newest", "oldest", - "stargazers" + "stargazers", + "watchers" ], "default": "newest" }, @@ -34346,13 +34528,35 @@ "default": 1 }, "descriptionHTML": "

    Page number of the results to fetch.

    " + }, + { + "name": "org", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    legacy query parameter for specifying the org.

    " + }, + { + "name": "organization", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    legacy query parameter for specifying the org.

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/forks", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/forks
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/forks", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/forks
    " }, { "lang": "JavaScript", @@ -34402,7 +34606,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/forks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -34421,13 +34625,35 @@ "type": "string" }, "descriptionHTML": "" + }, + { + "name": "org", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    legacy query parameter for specifying the org.

    " + }, + { + "name": "organization", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    legacy query parameter for specifying the org.

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/forks \\\n -d '{\"organization\":\"organization\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/forks \\\n  -d '{\"organization\":\"organization\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/forks \\\n -d '{\"organization\":\"organization\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/forks \\\n  -d '{\"organization\":\"organization\"}'
    " }, { "lang": "JavaScript", @@ -34450,6 +34676,7 @@ "application/json": { "schema": { "type": "object", + "nullable": true, "properties": { "organization": { "type": "string", @@ -34522,7 +34749,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/git/blobs", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -34546,8 +34773,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/blobs \\\n -d '{\"content\":\"content\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/blobs \\\n  -d '{\"content\":\"content\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/blobs \\\n -d '{\"content\":\"content\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/blobs \\\n  -d '{\"content\":\"content\"}'
    " }, { "lang": "JavaScript", @@ -34669,7 +34896,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/git/blobs/{file_sha}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -34702,8 +34929,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/blobs/FILE_SHA", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/blobs/FILE_SHA
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/blobs/FILE_SHA", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/blobs/FILE_SHA
    " }, { "lang": "JavaScript", @@ -34763,7 +34990,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/git/commits", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -34787,8 +35014,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/commits \\\n -d '{\"message\":\"message\",\"tree\":\"tree\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/commits \\\n  -d '{\"message\":\"message\",\"tree\":\"tree\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/commits \\\n -d '{\"message\":\"message\",\"tree\":\"tree\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/commits \\\n  -d '{\"message\":\"message\",\"tree\":\"tree\"}'
    " }, { "lang": "JavaScript", @@ -35242,7 +35469,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/git/commits/{commit_sha}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -35277,8 +35504,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/commits/COMMIT_SHA", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/commits/COMMIT_SHA
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/commits/COMMIT_SHA", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/commits/COMMIT_SHA
    " }, { "lang": "JavaScript", @@ -35328,7 +35555,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/git/matching-refs/{ref}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -35350,14 +35577,14 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    ref+ parameter

    " + "descriptionHTML": "

    ref parameter

    " }, { "name": "per_page", @@ -35383,8 +35610,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/matching-refs/REF", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/matching-refs/REF
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/matching-refs/REF", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/matching-refs/REF
    " }, { "lang": "JavaScript", @@ -35429,7 +35656,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/git/ref/{ref}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -35451,21 +35678,21 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    ref+ parameter

    " + "descriptionHTML": "

    ref parameter

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/ref/REF", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/ref/REF
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/ref/REF", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/ref/REF
    " }, { "lang": "JavaScript", @@ -35515,7 +35742,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/git/refs", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -35539,8 +35766,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/refs \\\n -d '{\"ref\":\"ref\",\"sha\":\"sha\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/refs \\\n  -d '{\"ref\":\"ref\",\"sha\":\"sha\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/refs \\\n -d '{\"ref\":\"ref\",\"sha\":\"sha\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/refs \\\n  -d '{\"ref\":\"ref\",\"sha\":\"sha\"}'
    " }, { "lang": "JavaScript", @@ -35664,7 +35891,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/git/refs/{ref}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -35686,21 +35913,21 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    ref+ parameter

    " + "descriptionHTML": "

    ref parameter

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/refs/REF \\\n -d '{\"sha\":\"sha\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/refs/REF \\\n  -d '{\"sha\":\"sha\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/refs/REF \\\n -d '{\"sha\":\"sha\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/refs/REF \\\n  -d '{\"sha\":\"sha\"}'
    " }, { "lang": "JavaScript", @@ -35807,7 +36034,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/git/refs/{ref}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -35829,21 +36056,21 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    ref+ parameter

    " + "descriptionHTML": "

    ref parameter

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/refs/REF", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/refs/REF
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/refs/REF", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/refs/REF
    " }, { "lang": "JavaScript", @@ -35878,7 +36105,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "422", @@ -35892,7 +36119,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/git/tags", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -35916,8 +36143,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/tags \\\n -d '{\"tag\":\"tag\",\"message\":\"message\",\"object\":\"object\",\"type\":\"type\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/tags \\\n  -d '{\"tag\":\"tag\",\"message\":\"message\",\"object\":\"object\",\"type\":\"type\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/tags \\\n -d '{\"tag\":\"tag\",\"message\":\"message\",\"object\":\"object\",\"type\":\"type\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/tags \\\n  -d '{\"tag\":\"tag\",\"message\":\"message\",\"object\":\"object\",\"type\":\"type\"}'
    " }, { "lang": "JavaScript", @@ -36224,7 +36451,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/git/tags/{tag_sha}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -36257,8 +36484,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/tags/TAG_SHA", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/tags/TAG_SHA
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/tags/TAG_SHA", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/tags/TAG_SHA
    " }, { "lang": "JavaScript", @@ -36308,7 +36535,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/git/trees", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -36332,8 +36559,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/trees \\\n -d '{\"tree\":[{\"path\":\"path\",\"mode\":\"mode\",\"type\":\"type\",\"sha\":\"sha\",\"content\":\"content\"}]}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/trees \\\n  -d '{\"tree\":[{\"path\":\"path\",\"mode\":\"mode\",\"type\":\"type\",\"sha\":\"sha\",\"content\":\"content\"}]}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/trees \\\n -d '{\"tree\":[{\"path\":\"path\",\"mode\":\"mode\",\"type\":\"type\",\"sha\":\"sha\",\"content\":\"content\"}]}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/trees \\\n  -d '{\"tree\":[{\"path\":\"path\",\"mode\":\"mode\",\"type\":\"type\",\"sha\":\"sha\",\"content\":\"content\"}]}'
    " }, { "lang": "JavaScript", @@ -36713,7 +36940,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/git/trees/{tree_sha}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -36740,6 +36967,7 @@ "schema": { "type": "string" }, + "x-multi-segment": true, "descriptionHTML": "" }, { @@ -36756,8 +36984,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/trees/TREE_SHA", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/trees/TREE_SHA
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/trees/TREE_SHA", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/trees/TREE_SHA
    " }, { "lang": "JavaScript", @@ -36818,7 +37046,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/hooks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -36862,8 +37090,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/hooks", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/hooks
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks
    " }, { "lang": "JavaScript", @@ -36913,7 +37141,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/hooks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -36937,8 +37165,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/hooks \\\n -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"token\":\"token\",\"digest\":\"digest\"}}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/hooks \\\n  -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"token\":\"token\",\"digest\":\"digest\"}}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks \\\n -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"token\":\"token\",\"digest\":\"digest\"}}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks \\\n  -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"token\":\"token\",\"digest\":\"digest\"}}'
    " }, { "lang": "JavaScript", @@ -37374,7 +37602,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -37407,8 +37635,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/hooks/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/hooks/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks/42
    " }, { "lang": "JavaScript", @@ -37458,7 +37686,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -37491,8 +37719,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/hooks/42 \\\n -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"address\":\"address\",\"room\":\"room\"}}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/hooks/42 \\\n  -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"address\":\"address\",\"room\":\"room\"}}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks/42 \\\n -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"address\":\"address\",\"room\":\"room\"}}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks/42 \\\n  -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"address\":\"address\",\"room\":\"room\"}}'
    " }, { "lang": "JavaScript", @@ -37943,7 +38171,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -37976,8 +38204,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/hooks/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/hooks/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks/42
    " }, { "lang": "JavaScript", @@ -38012,7 +38240,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -38026,7 +38254,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}/pings", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -38059,8 +38287,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/hooks/42/pings", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/hooks/42/pings
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks/42/pings", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks/42/pings
    " }, { "lang": "JavaScript", @@ -38095,7 +38323,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -38109,7 +38337,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}/tests", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -38142,8 +38370,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/hooks/42/tests", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/hooks/42/tests
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks/42/tests", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks/42/tests
    " }, { "lang": "JavaScript", @@ -38178,7 +38406,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -38192,7 +38420,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/installation", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -38227,8 +38455,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/installation", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/installation
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/installation", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/installation
    " }, { "lang": "JavaScript", @@ -38287,7 +38515,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/invitations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -38331,8 +38559,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/invitations", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/invitations
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/invitations", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/invitations
    " }, { "lang": "JavaScript", @@ -38377,7 +38605,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/invitations/{invitation_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -38411,8 +38639,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/invitations/42 \\\n -d '{\"permissions\":\"permissions\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/invitations/42 \\\n  -d '{\"permissions\":\"permissions\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/invitations/42 \\\n -d '{\"permissions\":\"permissions\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/invitations/42 \\\n  -d '{\"permissions\":\"permissions\"}'
    " }, { "lang": "JavaScript", @@ -38501,7 +38729,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/invitations/{invitation_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -38535,8 +38763,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/invitations/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/invitations/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/invitations/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/invitations/42
    " }, { "lang": "JavaScript", @@ -38571,7 +38799,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -38580,7 +38808,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -38731,8 +38959,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues
    " }, { "lang": "JavaScript", @@ -38796,7 +39024,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/issues", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -38820,8 +39048,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues \\\n -d '{\"title\":\"title\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues \\\n  -d '{\"title\":\"title\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues \\\n -d '{\"title\":\"title\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues \\\n  -d '{\"title\":\"title\"}'
    " }, { "lang": "JavaScript", @@ -39112,7 +39340,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -39195,8 +39423,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/comments", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/comments
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/comments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/comments
    " }, { "lang": "JavaScript", @@ -39258,7 +39486,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -39292,8 +39520,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/comments/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/comments/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/comments/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/comments/42
    " }, { "lang": "JavaScript", @@ -39350,7 +39578,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -39384,8 +39612,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/comments/42 \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/comments/42 \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/comments/42 \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/comments/42 \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -39471,7 +39699,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -39505,8 +39733,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/comments/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/comments/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/comments/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/comments/42
    " }, { "lang": "JavaScript", @@ -39541,7 +39769,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -39550,7 +39778,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -39624,8 +39852,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/comments/42/reactions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/comments/42/reactions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/comments/42/reactions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/comments/42/reactions
    " }, { "lang": "JavaScript", @@ -39685,7 +39913,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -39719,8 +39947,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/comments/42/reactions \\\n -d '{\"content\":\"content\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/comments/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/comments/42/reactions \\\n -d '{\"content\":\"content\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/comments/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " }, { "lang": "JavaScript", @@ -39842,7 +40070,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/events", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -39886,8 +40114,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/events", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/events
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/events", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/events
    " }, { "lang": "JavaScript", @@ -39950,7 +40178,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/events/{event_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -39983,8 +40211,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/events/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/events/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/events/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/events/42
    " }, { "lang": "JavaScript", @@ -40063,7 +40291,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -40097,8 +40325,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42
    " }, { "lang": "JavaScript", @@ -40168,7 +40396,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -40202,8 +40430,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42 \\\n -d '{\"title\":\"title\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42 \\\n  -d '{\"title\":\"title\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42 \\\n -d '{\"title\":\"title\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42 \\\n  -d '{\"title\":\"title\"}'
    " }, { "lang": "JavaScript", @@ -40528,7 +40756,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/assignees", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -40562,8 +40790,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/assignees \\\n -d '{\"assignees\":[\"assignees\"]}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/assignees \\\n  -d '{\"assignees\":[\"assignees\"]}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/assignees \\\n -d '{\"assignees\":[\"assignees\"]}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/assignees \\\n  -d '{\"assignees\":[\"assignees\"]}'
    " }, { "lang": "JavaScript", @@ -40650,7 +40878,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/assignees", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -40684,8 +40912,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/assignees \\\n -d '{\"assignees\":[\"assignees\"]}'", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/assignees \\\n  -d '{\"assignees\":[\"assignees\"]}'
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/assignees \\\n -d '{\"assignees\":[\"assignees\"]}'", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/assignees \\\n  -d '{\"assignees\":[\"assignees\"]}'
    " }, { "lang": "JavaScript", @@ -40772,7 +41000,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -40836,8 +41064,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/comments", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/comments
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/comments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/comments
    " }, { "lang": "JavaScript", @@ -40899,7 +41127,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -40933,8 +41161,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/comments \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/comments \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/comments \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/comments \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -41036,7 +41264,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/events", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -41090,8 +41318,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/events", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/events
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/events", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/events
    " }, { "lang": "JavaScript", @@ -41154,7 +41382,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -41208,8 +41436,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/labels", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/labels
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/labels", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/labels
    " }, { "lang": "JavaScript", @@ -41259,7 +41487,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -41293,8 +41521,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/labels \\\n -d '{\"labels\":[\"labels\"]}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/labels \\\n  -d '{\"labels\":[\"labels\"]}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/labels \\\n -d '{\"labels\":[\"labels\"]}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/labels \\\n  -d '{\"labels\":[\"labels\"]}'
    " }, { "lang": "JavaScript", @@ -41394,7 +41622,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -41428,8 +41656,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/labels \\\n -d '{\"labels\":[\"labels\"]}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/labels \\\n  -d '{\"labels\":[\"labels\"]}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/labels \\\n -d '{\"labels\":[\"labels\"]}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/labels \\\n  -d '{\"labels\":[\"labels\"]}'
    " }, { "lang": "JavaScript", @@ -41526,7 +41754,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -41560,8 +41788,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/labels", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/labels
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/labels", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/labels
    " }, { "lang": "JavaScript", @@ -41596,7 +41824,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "410", @@ -41610,7 +41838,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels/{name}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -41653,8 +41881,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/labels/NAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/labels/NAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/labels/NAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/labels/NAME
    " }, { "lang": "JavaScript", @@ -41709,7 +41937,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/lock", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -41743,8 +41971,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/lock \\\n -d '{\"lock_reason\":\"lock_reason\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/lock \\\n  -d '{\"lock_reason\":\"lock_reason\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/lock \\\n -d '{\"lock_reason\":\"lock_reason\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/lock \\\n  -d '{\"lock_reason\":\"lock_reason\"}'
    " }, { "lang": "JavaScript", @@ -41810,7 +42038,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -41855,7 +42083,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/lock", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -41889,8 +42117,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/lock", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/lock
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/lock", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/lock
    " }, { "lang": "JavaScript", @@ -41923,7 +42151,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -41942,7 +42170,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -42016,8 +42244,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/reactions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/reactions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/reactions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/reactions
    " }, { "lang": "JavaScript", @@ -42082,7 +42310,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -42116,8 +42344,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/reactions \\\n -d '{\"content\":\"content\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/reactions \\\n -d '{\"content\":\"content\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " }, { "lang": "JavaScript", @@ -42233,7 +42461,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/timeline", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -42287,8 +42515,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.mockingbird-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/timeline", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.mockingbird-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/timeline
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.mockingbird-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/timeline", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.mockingbird-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/timeline
    " }, { "lang": "JavaScript", @@ -42361,7 +42589,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/keys", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -42405,8 +42633,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/keys", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/keys
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/keys", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/keys
    " }, { "lang": "JavaScript", @@ -42451,7 +42679,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/keys", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -42475,8 +42703,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/keys \\\n -d '{\"key\":\"key\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/keys \\\n  -d '{\"key\":\"key\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/keys \\\n -d '{\"key\":\"key\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/keys \\\n  -d '{\"key\":\"key\"}'
    " }, { "lang": "JavaScript", @@ -42600,7 +42828,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/keys/{key_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -42634,8 +42862,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/keys/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/keys/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/keys/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/keys/42
    " }, { "lang": "JavaScript", @@ -42685,7 +42913,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/keys/{key_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -42719,8 +42947,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/keys/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/keys/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/keys/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/keys/42
    " }, { "lang": "JavaScript", @@ -42755,7 +42983,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -42764,7 +42992,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/labels", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -42808,8 +43036,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/labels", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/labels
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/labels", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/labels
    " }, { "lang": "JavaScript", @@ -42859,7 +43087,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/labels", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -42883,8 +43111,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/labels \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/labels \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/labels \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/labels \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -43013,7 +43241,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/labels/{name}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -43046,8 +43274,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/labels/NAME", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/labels/NAME
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/labels/NAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/labels/NAME
    " }, { "lang": "JavaScript", @@ -43097,7 +43325,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/labels/{name}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -43130,8 +43358,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/labels/NAME \\\n -d '{\"new_name\":\"new_name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/labels/NAME \\\n  -d '{\"new_name\":\"new_name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/labels/NAME \\\n -d '{\"new_name\":\"new_name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/labels/NAME \\\n  -d '{\"new_name\":\"new_name\"}'
    " }, { "lang": "JavaScript", @@ -43247,7 +43475,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/labels/{name}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -43280,8 +43508,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/labels/NAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/labels/NAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/labels/NAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/labels/NAME
    " }, { "lang": "JavaScript", @@ -43316,7 +43544,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -43325,7 +43553,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/languages", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -43349,8 +43577,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/languages", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/languages
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/languages", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/languages
    " }, { "lang": "JavaScript", @@ -43393,7 +43621,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/license", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -43417,8 +43645,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/license", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/license
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/license", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/license
    " }, { "lang": "JavaScript", @@ -43461,7 +43689,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/merges", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -43485,8 +43713,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/merges \\\n -d '{\"base\":\"base\",\"head\":\"head\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/merges \\\n  -d '{\"base\":\"base\",\"head\":\"head\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/merges \\\n -d '{\"base\":\"base\",\"head\":\"head\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/merges \\\n  -d '{\"base\":\"base\",\"head\":\"head\"}'
    " }, { "lang": "JavaScript", @@ -43609,20 +43837,12 @@ { "httpStatusCode": "404", "httpStatusMessage": "Not Found", - "description": "Missing base response", - "payload": "
    {\n  \"message\": \"Base does not exist\"\n}\n
    " - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Missing head response", - "payload": "
    {\n  \"message\": \"Head does not exist\"\n}\n
    " + "description": "Response when the base or head does not exist" }, { "httpStatusCode": "409", "httpStatusMessage": "Conflict", - "description": "Merge conflict response", - "payload": "
    {\n  \"message\": \"Merge Conflict\"\n}\n
    " + "description": "Response when there is a merge conflict" }, { "httpStatusCode": "422", @@ -43634,7 +43854,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/milestones", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -43724,8 +43944,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/milestones", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/milestones
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/milestones", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/milestones
    " }, { "lang": "JavaScript", @@ -43775,7 +43995,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/milestones", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -43799,8 +44019,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/milestones \\\n -d '{\"title\":\"title\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/milestones \\\n  -d '{\"title\":\"title\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/milestones \\\n -d '{\"title\":\"title\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/milestones \\\n  -d '{\"title\":\"title\"}'
    " }, { "lang": "JavaScript", @@ -43958,7 +44178,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/milestones/{milestone_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -43992,8 +44212,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/milestones/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/milestones/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/milestones/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/milestones/42
    " }, { "lang": "JavaScript", @@ -44043,7 +44263,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/milestones/{milestone_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -44077,8 +44297,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/milestones/42 \\\n -d '{\"title\":\"title\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/milestones/42 \\\n  -d '{\"title\":\"title\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/milestones/42 \\\n -d '{\"title\":\"title\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/milestones/42 \\\n  -d '{\"title\":\"title\"}'
    " }, { "lang": "JavaScript", @@ -44223,7 +44443,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/milestones/{milestone_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -44257,8 +44477,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/milestones/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/milestones/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/milestones/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/milestones/42
    " }, { "lang": "JavaScript", @@ -44293,7 +44513,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -44307,7 +44527,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/milestones/{milestone_number}/labels", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -44361,8 +44581,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/milestones/42/labels", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/milestones/42/labels
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/milestones/42/labels", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/milestones/42/labels
    " }, { "lang": "JavaScript", @@ -44407,7 +44627,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/notifications", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -44493,8 +44713,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/notifications", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/notifications
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/notifications", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/notifications
    " }, { "lang": "JavaScript", @@ -44539,7 +44759,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/notifications", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -44563,8 +44783,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/notifications \\\n -d '{\"last_read_at\":\"last_read_at\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/notifications \\\n  -d '{\"last_read_at\":\"last_read_at\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/notifications \\\n -d '{\"last_read_at\":\"last_read_at\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/notifications \\\n  -d '{\"last_read_at\":\"last_read_at\"}'
    " }, { "lang": "JavaScript", @@ -44638,7 +44858,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pages", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -44662,8 +44882,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pages
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages
    " }, { "lang": "JavaScript", @@ -44713,7 +44933,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/pages", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -44737,8 +44957,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages \\\n -d '{\"source\":{\"branch\":\"branch\",\"path\":\"path\"}}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pages \\\n  -d '{\"source\":{\"branch\":\"branch\",\"path\":\"path\"}}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages \\\n -d '{\"source\":{\"branch\":\"branch\",\"path\":\"path\"}}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages \\\n  -d '{\"source\":{\"branch\":\"branch\",\"path\":\"path\"}}'
    " }, { "lang": "JavaScript", @@ -44979,7 +45199,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/pages", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -45003,8 +45223,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages \\\n -d '{\"public\":true}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pages \\\n  -d '{\"public\":true}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages \\\n -d '{\"public\":true}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages \\\n  -d '{\"public\":true}'
    " }, { "lang": "JavaScript", @@ -45109,7 +45329,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "400", @@ -45185,7 +45405,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/pages", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -45209,8 +45429,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pages
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages
    " }, { "lang": "JavaScript", @@ -45252,7 +45472,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -45276,7 +45496,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pages/builds", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -45320,8 +45540,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages/builds", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pages/builds
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages/builds", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages/builds
    " }, { "lang": "JavaScript", @@ -45366,7 +45586,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/pages/builds", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -45390,8 +45610,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages/builds", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pages/builds
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages/builds", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages/builds
    " }, { "lang": "JavaScript", @@ -45436,7 +45656,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pages/builds/latest", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -45460,8 +45680,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages/builds/latest", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pages/builds/latest
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages/builds/latest", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages/builds/latest
    " }, { "lang": "JavaScript", @@ -45506,7 +45726,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pages/builds/{build_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -45539,8 +45759,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages/builds/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pages/builds/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages/builds/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages/builds/42
    " }, { "lang": "JavaScript", @@ -45585,7 +45805,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -45624,13 +45844,43 @@ "default": 1 }, "descriptionHTML": "

    Page number of the results to fetch.

    " + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + }, + "descriptionHTML": "

    One of asc (ascending) or desc (descending).

    " + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + }, + "descriptionHTML": "" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pre-receive-hooks", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pre-receive-hooks
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pre-receive-hooks", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pre-receive-hooks
    " }, { "lang": "JavaScript", @@ -45682,7 +45932,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -45715,8 +45965,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pre-receive-hooks/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pre-receive-hooks/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pre-receive-hooks/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pre-receive-hooks/42
    " }, { "lang": "JavaScript", @@ -45768,7 +46018,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -45801,8 +46051,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pre-receive-hooks/42 \\\n -d '{\"enforcement\":\"enforcement\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pre-receive-hooks/42 \\\n  -d '{\"enforcement\":\"enforcement\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pre-receive-hooks/42 \\\n -d '{\"enforcement\":\"enforcement\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pre-receive-hooks/42 \\\n  -d '{\"enforcement\":\"enforcement\"}'
    " }, { "lang": "JavaScript", @@ -45887,7 +46137,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -45920,8 +46170,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pre-receive-hooks/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pre-receive-hooks/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pre-receive-hooks/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pre-receive-hooks/42
    " }, { "lang": "JavaScript", @@ -45973,7 +46223,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/projects", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -46033,8 +46283,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/projects", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/projects
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/projects", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/projects
    " }, { "lang": "JavaScript", @@ -46109,7 +46359,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/projects", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -46133,8 +46383,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/projects \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/projects \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/projects \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/projects \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -46264,7 +46514,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -46375,8 +46625,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls
    " }, { "lang": "JavaScript", @@ -46441,7 +46691,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/pulls", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -46465,8 +46715,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls \\\n -d '{\"head\":\"head\",\"base\":\"base\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls \\\n  -d '{\"head\":\"head\",\"base\":\"base\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls \\\n -d '{\"head\":\"head\",\"base\":\"base\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls \\\n  -d '{\"head\":\"head\",\"base\":\"base\"}'
    " }, { "lang": "JavaScript", @@ -46680,7 +46930,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -46702,18 +46952,17 @@ }, { "name": "sort", - "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to).", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "created", - "updated" - ], - "default": "created" + "updated", + "created_at" + ] }, - "descriptionHTML": "

    One of created (when the repository was starred) or updated (when it was last pushed to).

    " + "descriptionHTML": "" }, { "name": "direction", @@ -46763,8 +47012,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/comments", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/comments
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/comments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/comments
    " }, { "lang": "JavaScript", @@ -46822,7 +47071,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -46856,8 +47105,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/comments/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/comments/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/comments/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/comments/42
    " }, { "lang": "JavaScript", @@ -46920,7 +47169,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -46954,8 +47203,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/comments/42 \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/comments/42 \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/comments/42 \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/comments/42 \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -47043,7 +47292,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -47077,8 +47326,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/comments/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/comments/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/comments/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/comments/42
    " }, { "lang": "JavaScript", @@ -47113,7 +47362,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -47127,7 +47376,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -47201,8 +47450,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/comments/42/reactions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/comments/42/reactions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/comments/42/reactions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/comments/42/reactions
    " }, { "lang": "JavaScript", @@ -47262,7 +47511,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -47296,8 +47545,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/comments/42/reactions \\\n -d '{\"content\":\"content\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/comments/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/comments/42/reactions \\\n -d '{\"content\":\"content\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/comments/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " }, { "lang": "JavaScript", @@ -47419,7 +47668,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -47452,8 +47701,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42
    " }, { "lang": "JavaScript", @@ -47511,7 +47760,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -47544,8 +47793,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42 \\\n -d '{\"title\":\"title\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42 \\\n  -d '{\"title\":\"title\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42 \\\n -d '{\"title\":\"title\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42 \\\n  -d '{\"title\":\"title\"}'
    " }, { "lang": "JavaScript", @@ -47726,7 +47975,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -47818,8 +48067,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/comments", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/comments
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/comments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/comments
    " }, { "lang": "JavaScript", @@ -47877,7 +48126,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -47910,8 +48159,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/comments \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/comments \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/comments \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/comments \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -48011,7 +48260,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -48054,8 +48303,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/comments/42/replies \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/comments/42/replies \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/comments/42/replies \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/comments/42/replies \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -48142,7 +48391,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/commits", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -48195,8 +48444,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/commits", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/commits
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/commits", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/commits
    " }, { "lang": "JavaScript", @@ -48239,7 +48488,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/files", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -48292,8 +48541,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/files", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/files
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/files", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/files
    " }, { "lang": "JavaScript", @@ -48346,7 +48595,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/merge", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -48379,8 +48628,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/merge", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/merge
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/merge", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/merge
    " }, { "lang": "JavaScript", @@ -48427,7 +48676,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/merge", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -48460,8 +48709,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/merge \\\n -d '{\"commit_title\":\"commit_title\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/merge \\\n  -d '{\"commit_title\":\"commit_title\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/merge \\\n -d '{\"commit_title\":\"commit_title\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/merge \\\n  -d '{\"commit_title\":\"commit_title\"}'
    " }, { "lang": "JavaScript", @@ -48626,7 +48875,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -48679,8 +48928,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/requested_reviewers", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/requested_reviewers
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/requested_reviewers", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/requested_reviewers
    " }, { "lang": "JavaScript", @@ -48725,7 +48974,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -48758,8 +49007,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/requested_reviewers \\\n -d '{\"reviewers\":[\"reviewers\"]}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/requested_reviewers \\\n  -d '{\"reviewers\":[\"reviewers\"]}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/requested_reviewers \\\n -d '{\"reviewers\":[\"reviewers\"]}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/requested_reviewers \\\n  -d '{\"reviewers\":[\"reviewers\"]}'
    " }, { "lang": "JavaScript", @@ -48896,7 +49145,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -48929,8 +49178,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/requested_reviewers \\\n -d '{\"reviewers\":[\"reviewers\"]}'", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/requested_reviewers \\\n  -d '{\"reviewers\":[\"reviewers\"]}'
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/requested_reviewers \\\n -d '{\"reviewers\":[\"reviewers\"]}'", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/requested_reviewers \\\n  -d '{\"reviewers\":[\"reviewers\"]}'
    " }, { "lang": "JavaScript", @@ -49052,7 +49301,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -49105,8 +49354,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/reviews
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews
    " }, { "lang": "JavaScript", @@ -49151,7 +49400,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -49184,8 +49433,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews \\\n -d '{\"commit_id\":\"commit_id\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/reviews \\\n  -d '{\"commit_id\":\"commit_id\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews \\\n -d '{\"commit_id\":\"commit_id\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews \\\n  -d '{\"commit_id\":\"commit_id\"}'
    " }, { "lang": "JavaScript", @@ -49633,7 +49882,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -49676,8 +49925,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews/42
    " }, { "lang": "JavaScript", @@ -49727,7 +49976,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -49770,8 +50019,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42 \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42 \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews/42 \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews/42 \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -49857,7 +50106,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -49900,8 +50149,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews/42
    " }, { "lang": "JavaScript", @@ -49956,7 +50205,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -50019,8 +50268,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42/comments", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42/comments
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews/42/comments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews/42/comments
    " }, { "lang": "JavaScript", @@ -50070,7 +50319,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -50113,8 +50362,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42/dismissals \\\n -d '{\"message\":\"message\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42/dismissals \\\n  -d '{\"message\":\"message\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews/42/dismissals \\\n -d '{\"message\":\"message\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews/42/dismissals \\\n  -d '{\"message\":\"message\"}'
    " }, { "lang": "JavaScript", @@ -50220,7 +50469,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -50263,8 +50512,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42/events \\\n -d '{\"event\":\"event\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42/events \\\n  -d '{\"event\":\"event\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews/42/events \\\n -d '{\"event\":\"event\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews/42/events \\\n  -d '{\"event\":\"event\"}'
    " }, { "lang": "JavaScript", @@ -50385,7 +50634,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/update-branch", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -50418,8 +50667,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.lydian-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/update-branch \\\n -d '{\"expected_head_sha\":\"expected_head_sha\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.lydian-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/update-branch \\\n  -d '{\"expected_head_sha\":\"expected_head_sha\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.lydian-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/update-branch \\\n -d '{\"expected_head_sha\":\"expected_head_sha\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.lydian-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/update-branch \\\n  -d '{\"expected_head_sha\":\"expected_head_sha\"}'
    " }, { "lang": "JavaScript", @@ -50518,7 +50767,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/readme", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -50552,8 +50801,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/readme", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/readme
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/readme", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/readme
    " }, { "lang": "JavaScript", @@ -50605,10 +50854,111 @@ } ] }, + { + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/readme/{dir}", + "serverUrl": "http(s)://{hostname}/api/v3", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "dir", + "description": "The alternate path to look for a README file", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true, + "descriptionHTML": "

    The alternate path to look for a README file

    " + }, + { + "name": "ref", + "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    The name of the commit/branch/tag. Default: the repository’s default branch (usually master)

    " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/readme/DIR", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/readme/DIR
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /repos/{owner}/{repo}/readme/{dir}', {\n owner: 'octocat',\n repo: 'hello-world',\n dir: 'dir'\n})", + "html": "
    await octokit.request('GET /repos/{owner}/{repo}/readme/{dir}', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  dir: 'dir'\n})\n
    " + } + ], + "summary": "Get a repository README", + "description": "Gets the preferred README for a repository.\n\nREADMEs support [custom media types](https://docs.github.com/enterprise-server@2.19/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML.", + "tags": [ + "repos" + ], + "operationId": "repos/get-readme-from-alt-path", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#get-a-repository-readme" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "contents" + }, + "slug": "get-a-repository-readme", + "category": "repos", + "categoryLabel": "Repos", + "subcategory": "contents", + "subcategoryLabel": "Contents", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

    Gets the preferred README for a repository.

    \n

    READMEs support custom media types for retrieving the raw content or rendered HTML.

    ", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
    {\n  \"type\": \"file\",\n  \"encoding\": \"base64\",\n  \"size\": 5362,\n  \"name\": \"README.md\",\n  \"path\": \"README.md\",\n  \"content\": \"encoded content ...\",\n  \"sha\": \"3d21ec53a331a6f037a91c368710b99387d012c1\",\n  \"url\": \"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\n  \"git_url\": \"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\n  \"html_url\": \"https://github.com/octokit/octokit.rb/blob/master/README.md\",\n  \"download_url\": \"https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md\",\n  \"_links\": {\n    \"git\": \"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\n    \"self\": \"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\n    \"html\": \"https://github.com/octokit/octokit.rb/blob/master/README.md\"\n  }\n}\n
    " + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + } + ] + }, { "verb": "get", "requestPath": "/repos/{owner}/{repo}/releases", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -50652,8 +51002,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases
    " }, { "lang": "JavaScript", @@ -50703,7 +51053,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/releases", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -50727,8 +51077,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases \\\n -d '{\"tag_name\":\"tag_name\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases \\\n  -d '{\"tag_name\":\"tag_name\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases \\\n -d '{\"tag_name\":\"tag_name\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases \\\n  -d '{\"tag_name\":\"tag_name\"}'
    " }, { "lang": "JavaScript", @@ -50914,7 +51264,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/releases/assets/{asset_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -50948,8 +51298,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/assets/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases/assets/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/assets/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/assets/42
    " }, { "lang": "JavaScript", @@ -51009,7 +51359,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/releases/assets/{asset_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -51043,8 +51393,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/assets/42 \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases/assets/42 \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/assets/42 \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/assets/42 \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -51159,7 +51509,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/releases/assets/{asset_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -51193,8 +51543,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/assets/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases/assets/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/assets/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/assets/42
    " }, { "lang": "JavaScript", @@ -51229,7 +51579,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -51238,7 +51588,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/releases/latest", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -51262,8 +51612,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/latest", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases/latest
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/latest", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/latest
    " }, { "lang": "JavaScript", @@ -51308,7 +51658,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/releases/tags/{tag}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -51330,21 +51680,21 @@ }, { "name": "tag", - "description": "tag+ parameter", + "description": "tag parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    tag+ parameter

    " + "descriptionHTML": "

    tag parameter

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/tags/TAG", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases/tags/TAG
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/tags/TAG", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/tags/TAG
    " }, { "lang": "JavaScript", @@ -51394,7 +51744,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/releases/{release_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -51428,8 +51778,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/42
    " }, { "lang": "JavaScript", @@ -51479,7 +51829,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/releases/{release_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -51513,8 +51863,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/42 \\\n -d '{\"tag_name\":\"tag_name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases/42 \\\n  -d '{\"tag_name\":\"tag_name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/42 \\\n -d '{\"tag_name\":\"tag_name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/42 \\\n  -d '{\"tag_name\":\"tag_name\"}'
    " }, { "lang": "JavaScript", @@ -51687,7 +52037,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/releases/{release_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -51721,8 +52071,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/42
    " }, { "lang": "JavaScript", @@ -51757,7 +52107,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -51766,7 +52116,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/releases/{release_id}/assets", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -51820,8 +52170,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/42/assets", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases/42/assets
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/42/assets", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/42/assets
    " }, { "lang": "JavaScript", @@ -51866,7 +52216,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/releases/{release_id}/assets", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -51916,8 +52266,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/42/assets", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases/42/assets
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/42/assets", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/42/assets
    " }, { "lang": "JavaScript", @@ -51983,7 +52333,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/stargazers", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -52027,8 +52377,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/stargazers", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/stargazers
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/stargazers", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/stargazers
    " }, { "lang": "JavaScript", @@ -52078,7 +52428,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/stats/code_frequency", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -52102,8 +52452,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/stats/code_frequency", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/stats/code_frequency
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/stats/code_frequency", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/stats/code_frequency
    " }, { "lang": "JavaScript", @@ -52148,7 +52498,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/stats/commit_activity", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -52172,8 +52522,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/stats/commit_activity", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/stats/commit_activity
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/stats/commit_activity", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/stats/commit_activity
    " }, { "lang": "JavaScript", @@ -52218,7 +52568,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/stats/contributors", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -52242,8 +52592,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/stats/contributors", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/stats/contributors
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/stats/contributors", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/stats/contributors
    " }, { "lang": "JavaScript", @@ -52288,7 +52638,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/stats/participation", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -52312,8 +52662,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/stats/participation", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/stats/participation
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/stats/participation", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/stats/participation
    " }, { "lang": "JavaScript", @@ -52363,7 +52713,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/stats/punch_card", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -52387,8 +52737,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/stats/punch_card", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/stats/punch_card
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/stats/punch_card", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/stats/punch_card
    " }, { "lang": "JavaScript", @@ -52433,7 +52783,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/statuses/{sha}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -52467,8 +52817,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/statuses/SHA \\\n -d '{\"state\":\"state\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/statuses/SHA \\\n  -d '{\"state\":\"state\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/statuses/SHA \\\n -d '{\"state\":\"state\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/statuses/SHA \\\n  -d '{\"state\":\"state\"}'
    " }, { "lang": "JavaScript", @@ -52620,7 +52970,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/subscribers", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -52664,8 +53014,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/subscribers", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/subscribers
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/subscribers", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/subscribers
    " }, { "lang": "JavaScript", @@ -52710,7 +53060,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/subscription", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -52734,8 +53084,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/subscription", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/subscription
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/subscription", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/subscription
    " }, { "lang": "JavaScript", @@ -52790,7 +53140,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/subscription", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -52814,8 +53164,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/subscription \\\n -d '{\"subscribed\":true}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/subscription \\\n  -d '{\"subscribed\":true}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/subscription \\\n -d '{\"subscribed\":true}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/subscription \\\n  -d '{\"subscribed\":true}'
    " }, { "lang": "JavaScript", @@ -52908,7 +53258,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/subscription", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -52932,8 +53282,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/subscription", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/subscription
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/subscription", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/subscription
    " }, { "lang": "JavaScript", @@ -52968,7 +53318,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -52977,7 +53327,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/tags", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -53021,8 +53371,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/tags", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/tags
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/tags", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/tags
    " }, { "lang": "JavaScript", @@ -53065,7 +53415,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/tarball/{ref}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -53098,8 +53448,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/tarball/REF", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/tarball/REF
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/tarball/REF", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/tarball/REF
    " }, { "lang": "JavaScript", @@ -53143,7 +53493,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/teams", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -53187,8 +53537,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/teams", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/teams
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/teams", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/teams
    " }, { "lang": "JavaScript", @@ -53231,7 +53581,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/topics", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -53250,13 +53600,33 @@ "type": "string" }, "descriptionHTML": "" + }, + { + "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.

    " + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "descriptionHTML": "

    Results per page (max 100).

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/topics", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/topics
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/topics", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/topics
    " }, { "lang": "JavaScript", @@ -53316,7 +53686,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/topics", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -53340,8 +53710,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/topics \\\n -d '{\"names\":[\"names\"]}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/topics \\\n  -d '{\"names\":[\"names\"]}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/topics \\\n -d '{\"names\":[\"names\"]}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/topics \\\n  -d '{\"names\":[\"names\"]}'
    " }, { "lang": "JavaScript", @@ -53453,7 +53823,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/transfer", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -53477,8 +53847,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/transfer \\\n -d '{\"new_owner\":\"new_owner\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/transfer \\\n  -d '{\"new_owner\":\"new_owner\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/transfer \\\n -d '{\"new_owner\":\"new_owner\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/transfer \\\n  -d '{\"new_owner\":\"new_owner\"}'
    " }, { "lang": "JavaScript", @@ -53585,7 +53955,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/vulnerability-alerts", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -53609,8 +53979,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/vulnerability-alerts", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/vulnerability-alerts
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/vulnerability-alerts", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/vulnerability-alerts
    " }, { "lang": "JavaScript", @@ -53650,7 +54020,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -53659,7 +54029,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/vulnerability-alerts", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -53683,8 +54053,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/vulnerability-alerts", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/vulnerability-alerts
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/vulnerability-alerts", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/vulnerability-alerts
    " }, { "lang": "JavaScript", @@ -53724,7 +54094,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -53733,7 +54103,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/zipball/{ref}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -53766,8 +54136,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/zipball/REF", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/zipball/REF
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/zipball/REF", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/zipball/REF
    " }, { "lang": "JavaScript", @@ -53811,7 +54181,7 @@ { "verb": "post", "requestPath": "/repos/{template_owner}/{template_repo}/generate", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "template_owner", @@ -53835,8 +54205,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.baptiste-preview+json\" \\\n https://api.github.com/repos/TEMPLATE_OWNER/TEMPLATE_REPO/generate \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.baptiste-preview+json\" \\\n  https://api.github.com/repos/TEMPLATE_OWNER/TEMPLATE_REPO/generate \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.baptiste-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/TEMPLATE_OWNER/TEMPLATE_REPO/generate \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.baptiste-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/TEMPLATE_OWNER/TEMPLATE_REPO/generate \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -53845,7 +54215,7 @@ } ], "summary": "Create a repository using a template", - "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@2.19/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.19/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", + "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@2.19/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.19/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository", "tags": [ "repos" ], @@ -53940,7 +54310,7 @@ "category": "repos", "categoryLabel": "Repos", "notes": [], - "descriptionHTML": "

    Creates a new repository using a repository template. Use the template_owner and template_repo route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the Get a repository endpoint and check that the is_template key is true.

    \n

    OAuth scope requirements

    \n

    When using OAuth, authorizations must include:

    \n
      \n
    • public_repo scope or repo scope to create a public repository
    • \n
    • repo scope to create a private repository
    • \n
    ", + "descriptionHTML": "

    Creates a new repository using a repository template. Use the template_owner and template_repo route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the Get a repository endpoint and check that the is_template key is true.

    \n

    OAuth scope requirements

    \n

    When using OAuth, authorizations must include:

    \n
      \n
    • public_repo scope or repo scope to create a public repository. Note: For GitHub AE, use repo scope to create an internal repository.
    • \n
    • repo scope to create a private repository
    • \n
    ", "bodyParameters": [ { "type": "string", @@ -54002,7 +54372,7 @@ { "verb": "get", "requestPath": "/repositories", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "since", @@ -54016,7 +54386,7 @@ }, { "name": "visibility", - "description": "Specifies the types of repositories to return. Can be one of `all` or `public`. Default: `public`.", + "description": "Specifies the types of repositories to return. Can be one of `all` or `public`. Default: `public`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise.", "in": "query", "required": false, "schema": { @@ -54028,14 +54398,14 @@ "public" ] }, - "descriptionHTML": "

    Specifies the types of repositories to return. Can be one of all or public. Default: public.

    " + "descriptionHTML": "

    Specifies the types of repositories to return. Can be one of all or public. Default: public. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise.

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repositories", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repositories
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repositories", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repositories
    " }, { "lang": "JavaScript", @@ -54044,7 +54414,7 @@ } ], "summary": "List public repositories", - "description": "Lists all public repositories in the order that they were created.\n\nNote: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@2.19/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.", + "description": "Lists all public repositories in the order that they were created.\n\nNotes:\n- For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise.\n- Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@2.19/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.", "tags": [ "repos" ], @@ -54065,7 +54435,7 @@ "categoryLabel": "Repos", "notes": [], "bodyParameters": [], - "descriptionHTML": "

    Lists all public repositories in the order that they were created.

    \n

    Note: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of repositories.

    ", + "descriptionHTML": "

    Lists all public repositories in the order that they were created.

    \n

    Notes:

    \n
      \n
    • For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise.
    • \n
    • Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of repositories.
    • \n
    ", "responses": [ { "httpStatusCode": "200", @@ -54088,7 +54458,7 @@ { "verb": "get", "requestPath": "/search/code", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "q", @@ -54152,8 +54522,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/search/code", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/search/code
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/search/code", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/search/code
    " }, { "lang": "JavaScript", @@ -54216,7 +54586,7 @@ { "verb": "get", "requestPath": "/search/commits", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "q", @@ -54281,8 +54651,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.cloak-preview+json\" \\\n https://api.github.com/search/commits", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.cloak-preview+json\" \\\n  https://api.github.com/search/commits
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.cloak-preview+json\" \\\n http(s)://{hostname}/api/v3/search/commits", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.cloak-preview+json\" \\\n  http(s)://{hostname}/api/v3/search/commits
    " }, { "lang": "JavaScript", @@ -54342,7 +54712,7 @@ { "verb": "get", "requestPath": "/search/issues", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "q", @@ -54416,8 +54786,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/search/issues", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/search/issues
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/search/issues", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/search/issues
    " }, { "lang": "JavaScript", @@ -54480,7 +54850,7 @@ { "verb": "get", "requestPath": "/search/labels", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "repository_id", @@ -54535,8 +54905,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/search/labels", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/search/labels
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/search/labels", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/search/labels
    " }, { "lang": "JavaScript", @@ -54599,7 +54969,7 @@ { "verb": "get", "requestPath": "/search/repositories", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "q", @@ -54666,8 +55036,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/search/repositories", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/search/repositories
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/search/repositories", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/search/repositories
    " }, { "lang": "JavaScript", @@ -54732,7 +55102,7 @@ { "verb": "get", "requestPath": "/search/topics", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "q", @@ -54748,8 +55118,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n https://api.github.com/search/topics", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n  https://api.github.com/search/topics
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n http(s)://{hostname}/api/v3/search/topics", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n  http(s)://{hostname}/api/v3/search/topics
    " }, { "lang": "JavaScript", @@ -54809,7 +55179,7 @@ { "verb": "get", "requestPath": "/search/users", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "q", @@ -54875,8 +55245,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/search/users", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/search/users
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/search/users", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/search/users
    " }, { "lang": "JavaScript", @@ -54934,13 +55304,13 @@ { "verb": "get", "requestPath": "/setup/api/configcheck", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/configcheck", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/setup/api/configcheck
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/setup/api/configcheck", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/setup/api/configcheck
    " }, { "lang": "JavaScript", @@ -54985,13 +55355,13 @@ { "verb": "post", "requestPath": "/setup/api/configure", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/configure", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/setup/api/configure
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/setup/api/configure", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/setup/api/configure
    " }, { "lang": "JavaScript", @@ -55035,13 +55405,13 @@ { "verb": "get", "requestPath": "/setup/api/maintenance", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/maintenance", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/setup/api/maintenance
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/setup/api/maintenance", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/setup/api/maintenance
    " }, { "lang": "JavaScript", @@ -55086,13 +55456,13 @@ { "verb": "post", "requestPath": "/setup/api/maintenance", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/maintenance \\\n -d '{\"maintenance\":\"maintenance\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/setup/api/maintenance \\\n  -d '{\"maintenance\":\"maintenance\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/setup/api/maintenance \\\n -d '{\"maintenance\":\"maintenance\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/setup/api/maintenance \\\n  -d '{\"maintenance\":\"maintenance\"}'
    " }, { "lang": "JavaScript", @@ -55170,13 +55540,13 @@ { "verb": "get", "requestPath": "/setup/api/settings", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/settings", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/setup/api/settings
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/setup/api/settings", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/setup/api/settings
    " }, { "lang": "JavaScript", @@ -55221,13 +55591,13 @@ { "verb": "put", "requestPath": "/setup/api/settings", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/settings \\\n -d '{\"settings\":\"settings\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/setup/api/settings \\\n  -d '{\"settings\":\"settings\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/setup/api/settings \\\n -d '{\"settings\":\"settings\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/setup/api/settings \\\n  -d '{\"settings\":\"settings\"}'
    " }, { "lang": "JavaScript", @@ -55285,7 +55655,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "descriptionHTML": "

    For a list of the available settings, see the Get settings endpoint.

    ", @@ -55304,13 +55674,13 @@ { "verb": "get", "requestPath": "/setup/api/settings/authorized-keys", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/settings/authorized-keys", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/setup/api/settings/authorized-keys
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/setup/api/settings/authorized-keys", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/setup/api/settings/authorized-keys
    " }, { "lang": "JavaScript", @@ -55355,13 +55725,13 @@ { "verb": "post", "requestPath": "/setup/api/settings/authorized-keys", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/settings/authorized-keys \\\n -d '{\"authorized_key\":\"authorized_key\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/setup/api/settings/authorized-keys \\\n  -d '{\"authorized_key\":\"authorized_key\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/setup/api/settings/authorized-keys \\\n -d '{\"authorized_key\":\"authorized_key\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/setup/api/settings/authorized-keys \\\n  -d '{\"authorized_key\":\"authorized_key\"}'
    " }, { "lang": "JavaScript", @@ -55439,13 +55809,13 @@ { "verb": "delete", "requestPath": "/setup/api/settings/authorized-keys", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/settings/authorized-keys \\\n -d '{\"authorized_key\":\"authorized_key\"}'", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/setup/api/settings/authorized-keys \\\n  -d '{\"authorized_key\":\"authorized_key\"}'
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/setup/api/settings/authorized-keys \\\n -d '{\"authorized_key\":\"authorized_key\"}'", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/setup/api/settings/authorized-keys \\\n  -d '{\"authorized_key\":\"authorized_key\"}'
    " }, { "lang": "JavaScript", @@ -55523,13 +55893,13 @@ { "verb": "post", "requestPath": "/setup/api/start", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/start \\\n -d '{\"license\":\"license\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/setup/api/start \\\n  -d '{\"license\":\"license\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/setup/api/start \\\n -d '{\"license\":\"license\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/setup/api/start \\\n  -d '{\"license\":\"license\"}'
    " }, { "lang": "JavaScript", @@ -55642,13 +56012,13 @@ { "verb": "post", "requestPath": "/setup/api/upgrade", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/upgrade \\\n -d '{\"license\":\"license\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/setup/api/upgrade \\\n  -d '{\"license\":\"license\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/setup/api/upgrade \\\n -d '{\"license\":\"license\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/setup/api/upgrade \\\n  -d '{\"license\":\"license\"}'
    " }, { "lang": "JavaScript", @@ -55722,7 +56092,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -55737,8 +56107,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42
    " }, { "lang": "JavaScript", @@ -55788,7 +56158,7 @@ { "verb": "patch", "requestPath": "/teams/{team_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -55803,8 +56173,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42 \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42 \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42 \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42 \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -55983,7 +56353,7 @@ { "verb": "delete", "requestPath": "/teams/{team_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -55998,8 +56368,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42
    " }, { "lang": "JavaScript", @@ -56039,7 +56409,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -56048,7 +56418,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/discussions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -56098,8 +56468,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/discussions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions
    " }, { "lang": "JavaScript", @@ -56150,7 +56520,7 @@ { "verb": "post", "requestPath": "/teams/{team_id}/discussions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -56165,8 +56535,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions \\\n -d '{\"title\":\"title\",\"body\":\"body\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/discussions \\\n  -d '{\"title\":\"title\",\"body\":\"body\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions \\\n -d '{\"title\":\"title\",\"body\":\"body\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions \\\n  -d '{\"title\":\"title\",\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -56294,7 +56664,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/discussions/{discussion_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -56318,8 +56688,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/discussions/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions/42
    " }, { "lang": "JavaScript", @@ -56370,7 +56740,7 @@ { "verb": "patch", "requestPath": "/teams/{team_id}/discussions/{discussion_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -56394,8 +56764,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions/42 \\\n -d '{\"title\":\"title\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/discussions/42 \\\n  -d '{\"title\":\"title\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions/42 \\\n -d '{\"title\":\"title\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions/42 \\\n  -d '{\"title\":\"title\"}'
    " }, { "lang": "JavaScript", @@ -56497,7 +56867,7 @@ { "verb": "delete", "requestPath": "/teams/{team_id}/discussions/{discussion_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -56521,8 +56891,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/discussions/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions/42
    " }, { "lang": "JavaScript", @@ -56557,7 +56927,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -56566,7 +56936,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -56625,8 +56995,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions/42/comments", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/discussions/42/comments
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions/42/comments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions/42/comments
    " }, { "lang": "JavaScript", @@ -56677,7 +57047,7 @@ { "verb": "post", "requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -56701,8 +57071,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions/42/comments \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/discussions/42/comments \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions/42/comments \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions/42/comments \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -56790,7 +57160,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -56823,8 +57193,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions/42/comments/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/discussions/42/comments/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions/42/comments/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions/42/comments/42
    " }, { "lang": "JavaScript", @@ -56875,7 +57245,7 @@ { "verb": "patch", "requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -56908,8 +57278,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions/42/comments/42 \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/discussions/42/comments/42 \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions/42/comments/42 \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions/42/comments/42 \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -56996,7 +57366,7 @@ { "verb": "delete", "requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -57029,8 +57399,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions/42/comments/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/discussions/42/comments/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions/42/comments/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions/42/comments/42
    " }, { "lang": "JavaScript", @@ -57065,7 +57435,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -57074,7 +57444,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -57158,8 +57528,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions/42/comments/42/reactions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/discussions/42/comments/42/reactions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions/42/comments/42/reactions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions/42/comments/42/reactions
    " }, { "lang": "JavaScript", @@ -57207,7 +57577,7 @@ { "verb": "post", "requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -57251,8 +57621,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions/42/comments/42/reactions \\\n -d '{\"content\":\"content\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/discussions/42/comments/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions/42/comments/42/reactions \\\n -d '{\"content\":\"content\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions/42/comments/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " }, { "lang": "JavaScript", @@ -57356,7 +57726,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/discussions/{discussion_number}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -57431,8 +57801,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions/42/reactions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/discussions/42/reactions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions/42/reactions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions/42/reactions
    " }, { "lang": "JavaScript", @@ -57480,7 +57850,7 @@ { "verb": "post", "requestPath": "/teams/{team_id}/discussions/{discussion_number}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -57515,8 +57885,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions/42/reactions \\\n -d '{\"content\":\"content\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/discussions/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions/42/reactions \\\n -d '{\"content\":\"content\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " }, { "lang": "JavaScript", @@ -57620,7 +57990,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/members", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -57671,8 +58041,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/members", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/members
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/members", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/members
    " }, { "lang": "JavaScript", @@ -57724,7 +58094,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/members/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -57748,8 +58118,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/members/USERNAME", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/members/USERNAME
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/members/USERNAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/members/USERNAME
    " }, { "lang": "JavaScript", @@ -57801,7 +58171,7 @@ { "verb": "put", "requestPath": "/teams/{team_id}/members/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -57825,8 +58195,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/members/USERNAME", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/members/USERNAME
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/members/USERNAME", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/members/USERNAME
    " }, { "lang": "JavaScript", @@ -57860,13 +58230,11 @@ "subcategory": "members", "subcategoryLabel": "Members", "notes": [], - "bodyParameters": [], - "descriptionHTML": "

    The \"Add team member\" endpoint (described below) is deprecated.

    \n

    We recommend using the Add or update team membership for a user endpoint instead. It allows you to invite new organization members to your teams.

    \n

    Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

    \n

    To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.

    \n

    Note: When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"

    \n

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

    ", "responses": [ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -57881,21 +58249,16 @@ { "httpStatusCode": "422", "httpStatusMessage": "Unprocessable Entity", - "description": "Response if you attempt to add an organization to a team", - "payload": "
    {\n  \"message\": \"Cannot add an organization as a member.\",\n  \"errors\": [\n    {\n      \"code\": \"org\",\n      \"field\": \"user\",\n      \"resource\": \"TeamMember\"\n    }\n  ]\n}\n
    " - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Response if you attempt to add a user to a team when they are not a member of at least one other team in the same organization", - "payload": "
    {\n  \"message\": \"User isn't a member of this organization. Please invite them first.\",\n  \"errors\": [\n    {\n      \"code\": \"unaffiliated\",\n      \"field\": \"user\",\n      \"resource\": \"TeamMember\"\n    }\n  ]\n}\n
    " + "description": "Response if you attempt to add an organization to a team or you attempt to add a user to a team when they are not a member of at least one other team in the same organization" } - ] + ], + "bodyParameters": [], + "descriptionHTML": "

    The \"Add team member\" endpoint (described below) is deprecated.

    \n

    We recommend using the Add or update team membership for a user endpoint instead. It allows you to invite new organization members to your teams.

    \n

    Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

    \n

    To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.

    \n

    Note: When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"

    \n

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

    " }, { "verb": "delete", "requestPath": "/teams/{team_id}/members/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -57919,8 +58282,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/members/USERNAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/members/USERNAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/members/USERNAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/members/USERNAME
    " }, { "lang": "JavaScript", @@ -57958,7 +58321,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -57972,7 +58335,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/memberships/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -57996,8 +58359,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/memberships/USERNAME", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/memberships/USERNAME
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/memberships/USERNAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/memberships/USERNAME
    " }, { "lang": "JavaScript", @@ -58006,7 +58369,7 @@ } ], "summary": "Get team membership for a user", - "description": "If you pass the `hellcat-preview` media type, team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:** The `role` for organization owners returns as `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@2.19/rest/reference/teams#create-a-team).", + "description": "If you pass the `hellcat-preview` media type, team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:**\nThe response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@2.19/rest/reference/teams#create-a-team).", "operationId": "teams/get-membership-for-user", "tags": [ "teams" @@ -58036,32 +58399,20 @@ "subcategoryLabel": "Members", "notes": [], "bodyParameters": [], - "descriptionHTML": "

    If you pass the hellcat-preview media type, team members will include the members of child teams.

    \n

    To get a user's membership with a team, the team must be visible to the authenticated user.

    \n

    Note: The role for organization owners returns as maintainer. For more information about maintainer roles, see Create a team.

    ", + "descriptionHTML": "

    If you pass the hellcat-preview media type, team members will include the members of child teams.

    \n

    To get a user's membership with a team, the team must be visible to the authenticated user.

    \n

    Note:\nThe response contains the state of the membership and the member's role.

    \n

    The role for organization owners is set to maintainer. For more information about maintainer roles, see Create a team.

    ", "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response if user has an active membership with team", - "payload": "
    {\n  \"url\": \"https://api.github.com/teams/1/memberships/octocat\",\n  \"role\": \"member\",\n  \"state\": \"active\"\n}\n
    " - }, { "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Response if user is a team maintainer", "payload": "
    {\n  \"url\": \"https://api.github.com/teams/1/memberships/octocat\",\n  \"role\": \"maintainer\",\n  \"state\": \"active\"\n}\n
    " - }, - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response if user has a pending membership with team", - "payload": "
    {\n  \"url\": \"https://api.github.com/teams/1/memberships/octocat\",\n  \"role\": \"member\",\n  \"state\": \"pending\"\n}\n
    " } ] }, { "verb": "put", "requestPath": "/teams/{team_id}/memberships/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -58085,8 +58436,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/memberships/USERNAME \\\n -d '{\"role\":\"role\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/memberships/USERNAME \\\n  -d '{\"role\":\"role\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/memberships/USERNAME \\\n -d '{\"role\":\"role\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/memberships/USERNAME \\\n  -d '{\"role\":\"role\"}'
    " }, { "lang": "JavaScript", @@ -58160,12 +58511,6 @@ } ], "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response if user's membership with team is now active", - "payload": "
    {\n  \"url\": \"https://api.github.com/teams/1/memberships/octocat\",\n  \"role\": \"member\",\n  \"state\": \"active\"\n}\n
    " - }, { "httpStatusCode": "200", "httpStatusMessage": "OK", @@ -58175,15 +58520,14 @@ { "httpStatusCode": "422", "httpStatusMessage": "Unprocessable Entity", - "description": "Response if you attempt to add an organization to a team", - "payload": "
    {\n  \"message\": \"Cannot add an organization as a member.\",\n  \"errors\": [\n    {\n      \"code\": \"org\",\n      \"field\": \"user\",\n      \"resource\": \"TeamMember\"\n    }\n  ]\n}\n
    " + "description": "Response if you attempt to add an organization to a team" } ] }, { "verb": "delete", "requestPath": "/teams/{team_id}/memberships/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -58207,8 +58551,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/memberships/USERNAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/memberships/USERNAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/memberships/USERNAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/memberships/USERNAME
    " }, { "lang": "JavaScript", @@ -58243,7 +58587,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -58252,7 +58596,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/projects", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -58298,8 +58642,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/teams/42/projects", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/teams/42/projects
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/teams/42/projects", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/projects
    " }, { "lang": "JavaScript", @@ -58355,7 +58699,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/projects/{project_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -58390,8 +58734,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/teams/42/projects/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/teams/42/projects/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/teams/42/projects/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/projects/42
    " }, { "lang": "JavaScript", @@ -58452,7 +58796,7 @@ { "verb": "put", "requestPath": "/teams/{team_id}/projects/{project_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -58487,8 +58831,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/teams/42/projects/42 \\\n -d '{\"permission\":\"permission\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/teams/42/projects/42 \\\n  -d '{\"permission\":\"permission\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/teams/42/projects/42 \\\n -d '{\"permission\":\"permission\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/projects/42 \\\n  -d '{\"permission\":\"permission\"}'
    " }, { "lang": "JavaScript", @@ -58577,7 +58921,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -58590,7 +58934,7 @@ { "verb": "delete", "requestPath": "/teams/{team_id}/projects/{project_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -58614,8 +58958,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/projects/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/projects/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/projects/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/projects/42
    " }, { "lang": "JavaScript", @@ -58648,7 +58992,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -58657,7 +59001,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/repos", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -58692,8 +59036,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/repos", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/repos
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/repos", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/repos
    " }, { "lang": "JavaScript", @@ -58743,7 +59087,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/repos/{owner}/{repo}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -58776,8 +59120,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/repos/octocat/hello-world", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/repos/octocat/hello-world
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/repos/octocat/hello-world", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/repos/octocat/hello-world
    " }, { "lang": "JavaScript", @@ -58836,7 +59180,7 @@ { "verb": "put", "requestPath": "/teams/{team_id}/repos/{owner}/{repo}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -58869,8 +59213,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/repos/octocat/hello-world \\\n -d '{\"permission\":\"permission\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/repos/octocat/hello-world \\\n  -d '{\"permission\":\"permission\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/repos/octocat/hello-world \\\n -d '{\"permission\":\"permission\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/repos/octocat/hello-world \\\n  -d '{\"permission\":\"permission\"}'
    " }, { "lang": "JavaScript", @@ -58935,7 +59279,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "descriptionHTML": "

    To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a 422 Unprocessable Entity status if you attempt to add a repository to a team that is not owned by the 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.\"

    ", @@ -58959,7 +59303,7 @@ { "verb": "delete", "requestPath": "/teams/{team_id}/repos/{owner}/{repo}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -58992,8 +59336,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/repos/octocat/hello-world", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/repos/octocat/hello-world
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/repos/octocat/hello-world", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/repos/octocat/hello-world
    " }, { "lang": "JavaScript", @@ -59026,7 +59370,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -59035,7 +59379,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/teams", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -59070,8 +59414,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/teams", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/teams
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/teams", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/teams
    " }, { "lang": "JavaScript", @@ -59121,13 +59465,13 @@ { "verb": "get", "requestPath": "/user", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user
    " }, { "lang": "JavaScript", @@ -59191,13 +59535,13 @@ { "verb": "patch", "requestPath": "/user", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -59435,7 +59779,7 @@ { "verb": "get", "requestPath": "/user/emails", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -59461,8 +59805,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/emails", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/emails
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/emails", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/emails
    " }, { "lang": "JavaScript", @@ -59527,13 +59871,13 @@ { "verb": "post", "requestPath": "/user/emails", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/emails \\\n -d '{\"emails\":[\"octocat@github.com\"]}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/emails \\\n  -d '{\"emails\":[\"octocat@github.com\"]}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/emails \\\n -d '{\"emails\":[\"octocat@github.com\"]}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/emails \\\n  -d '{\"emails\":[\"octocat@github.com\"]}'
    " }, { "lang": "JavaScript", @@ -59648,13 +59992,13 @@ { "verb": "delete", "requestPath": "/user/emails", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/emails \\\n -d '{\"emails\":[\"octocat@github.com\"]}'", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/emails \\\n  -d '{\"emails\":[\"octocat@github.com\"]}'
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/emails \\\n -d '{\"emails\":[\"octocat@github.com\"]}'", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/emails \\\n  -d '{\"emails\":[\"octocat@github.com\"]}'
    " }, { "lang": "JavaScript", @@ -59734,7 +60078,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -59768,7 +60112,7 @@ { "verb": "get", "requestPath": "/user/followers", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -59794,8 +60138,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/followers", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/followers
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/followers", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/followers
    " }, { "lang": "JavaScript", @@ -59855,7 +60199,7 @@ { "verb": "get", "requestPath": "/user/following", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -59881,8 +60225,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/following", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/following
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/following", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/following
    " }, { "lang": "JavaScript", @@ -59942,7 +60286,7 @@ { "verb": "get", "requestPath": "/user/following/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -59957,8 +60301,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/following/USERNAME", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/following/USERNAME
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/following/USERNAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/following/USERNAME
    " }, { "lang": "JavaScript", @@ -60022,7 +60366,7 @@ { "verb": "put", "requestPath": "/user/following/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -60037,8 +60381,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/following/USERNAME", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/following/USERNAME
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/following/USERNAME", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/following/USERNAME
    " }, { "lang": "JavaScript", @@ -60073,7 +60417,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -60102,7 +60446,7 @@ { "verb": "delete", "requestPath": "/user/following/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -60117,8 +60461,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/following/USERNAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/following/USERNAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/following/USERNAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/following/USERNAME
    " }, { "lang": "JavaScript", @@ -60153,7 +60497,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -60182,7 +60526,7 @@ { "verb": "get", "requestPath": "/user/gpg_keys", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -60208,8 +60552,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/gpg_keys", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/gpg_keys
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/gpg_keys", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/gpg_keys
    " }, { "lang": "JavaScript", @@ -60274,13 +60618,13 @@ { "verb": "post", "requestPath": "/user/gpg_keys", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/gpg_keys \\\n -d '{\"armored_public_key\":\"armored_public_key\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/gpg_keys \\\n  -d '{\"armored_public_key\":\"armored_public_key\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/gpg_keys \\\n -d '{\"armored_public_key\":\"armored_public_key\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/gpg_keys \\\n  -d '{\"armored_public_key\":\"armored_public_key\"}'
    " }, { "lang": "JavaScript", @@ -60383,7 +60727,7 @@ { "verb": "get", "requestPath": "/user/gpg_keys/{gpg_key_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gpg_key_id", @@ -60399,8 +60743,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/gpg_keys/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/gpg_keys/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/gpg_keys/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/gpg_keys/42
    " }, { "lang": "JavaScript", @@ -60465,7 +60809,7 @@ { "verb": "delete", "requestPath": "/user/gpg_keys/{gpg_key_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gpg_key_id", @@ -60481,8 +60825,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/gpg_keys/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/gpg_keys/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/gpg_keys/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/gpg_keys/42
    " }, { "lang": "JavaScript", @@ -60517,7 +60861,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -60551,7 +60895,7 @@ { "verb": "get", "requestPath": "/user/installations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -60588,8 +60932,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/user/installations", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  https://api.github.com/user/installations
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n http(s)://{hostname}/api/v3/user/installations", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  http(s)://{hostname}/api/v3/user/installations
    " }, { "lang": "JavaScript", @@ -60661,7 +61005,7 @@ { "verb": "get", "requestPath": "/user/installations/{installation_id}/repositories", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -60708,8 +61052,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/user/installations/42/repositories", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  https://api.github.com/user/installations/42/repositories
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n http(s)://{hostname}/api/v3/user/installations/42/repositories", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  http(s)://{hostname}/api/v3/user/installations/42/repositories
    " }, { "lang": "JavaScript", @@ -60782,7 +61126,7 @@ { "verb": "put", "requestPath": "/user/installations/{installation_id}/repositories/{repository_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "installation_id", @@ -60807,8 +61151,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/user/installations/42/repositories/42", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  https://api.github.com/user/installations/42/repositories/42
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n http(s)://{hostname}/api/v3/user/installations/42/repositories/42", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  http(s)://{hostname}/api/v3/user/installations/42/repositories/42
    " }, { "lang": "JavaScript", @@ -60850,7 +61194,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -60874,7 +61218,7 @@ { "verb": "delete", "requestPath": "/user/installations/{installation_id}/repositories/{repository_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "installation_id", @@ -60899,8 +61243,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/user/installations/42/repositories/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  https://api.github.com/user/installations/42/repositories/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n http(s)://{hostname}/api/v3/user/installations/42/repositories/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  http(s)://{hostname}/api/v3/user/installations/42/repositories/42
    " }, { "lang": "JavaScript", @@ -60942,7 +61286,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -60966,7 +61310,7 @@ { "verb": "get", "requestPath": "/user/issues", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "filter", @@ -60980,6 +61324,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -61077,8 +61422,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/issues", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/issues
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/issues", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/issues
    " }, { "lang": "JavaScript", @@ -61137,7 +61482,7 @@ { "verb": "get", "requestPath": "/user/keys", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -61163,8 +61508,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/keys", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/keys
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/keys", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/keys
    " }, { "lang": "JavaScript", @@ -61229,13 +61574,13 @@ { "verb": "post", "requestPath": "/user/keys", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/keys \\\n -d '{\"key\":\"key\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/keys \\\n  -d '{\"key\":\"key\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/keys \\\n -d '{\"key\":\"key\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/keys \\\n  -d '{\"key\":\"key\"}'
    " }, { "lang": "JavaScript", @@ -61360,7 +61705,7 @@ { "verb": "get", "requestPath": "/user/keys/{key_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "key_id", @@ -61376,8 +61721,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/keys/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/keys/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/keys/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/keys/42
    " }, { "lang": "JavaScript", @@ -61442,7 +61787,7 @@ { "verb": "delete", "requestPath": "/user/keys/{key_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "key_id", @@ -61458,8 +61803,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/keys/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/keys/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/keys/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/keys/42
    " }, { "lang": "JavaScript", @@ -61494,7 +61839,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -61523,7 +61868,7 @@ { "verb": "get", "requestPath": "/user/memberships/orgs", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "state", @@ -61563,8 +61908,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/memberships/orgs", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/memberships/orgs
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/memberships/orgs", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/memberships/orgs
    " }, { "lang": "JavaScript", @@ -61629,7 +61974,7 @@ { "verb": "get", "requestPath": "/user/memberships/orgs/{org}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -61644,8 +61989,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/memberships/orgs/ORG", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/memberships/orgs/ORG
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/memberships/orgs/ORG", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/memberships/orgs/ORG
    " }, { "lang": "JavaScript", @@ -61700,7 +62045,7 @@ { "verb": "patch", "requestPath": "/user/memberships/orgs/{org}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -61715,8 +62060,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/memberships/orgs/ORG \\\n -d '{\"state\":\"state\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/memberships/orgs/ORG \\\n  -d '{\"state\":\"state\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/memberships/orgs/ORG \\\n -d '{\"state\":\"state\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/memberships/orgs/ORG \\\n  -d '{\"state\":\"state\"}'
    " }, { "lang": "JavaScript", @@ -61818,7 +62163,7 @@ { "verb": "get", "requestPath": "/user/orgs", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -61844,8 +62189,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/orgs", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/orgs
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/orgs", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/orgs
    " }, { "lang": "JavaScript", @@ -61903,13 +62248,13 @@ { "verb": "post", "requestPath": "/user/projects", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/user/projects \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/user/projects \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/user/projects \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/user/projects \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -62041,7 +62386,7 @@ { "verb": "get", "requestPath": "/user/public_emails", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -62067,8 +62412,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/public_emails", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/public_emails
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/public_emails", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/public_emails
    " }, { "lang": "JavaScript", @@ -62133,11 +62478,11 @@ { "verb": "get", "requestPath": "/user/repos", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "visibility", - "description": "Can be one of `all`, `public`, or `private`.", + "description": "Can be one of `all`, `public`, or `private`. Note: For GitHub AE, can be one of `all`, `internal`, or `private`.", "in": "query", "required": false, "schema": { @@ -62149,7 +62494,7 @@ ], "default": "all" }, - "descriptionHTML": "

    Can be one of all, public, or private.

    " + "descriptionHTML": "

    Can be one of all, public, or private. Note: For GitHub AE, can be one of all, internal, or private.

    " }, { "name": "affiliation", @@ -62164,7 +62509,7 @@ }, { "name": "type", - "description": "Can be one of `all`, `owner`, `public`, `private`, `member`. Default: `all` \n \nWill cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.", + "description": "Can be one of `all`, `owner`, `public`, `private`, `member`. Note: For GitHub AE, can be one of `all`, `owner`, `internal`, `private`, `member`. Default: `all` \n \nWill cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.", "in": "query", "required": false, "schema": { @@ -62178,7 +62523,7 @@ ], "default": "all" }, - "descriptionHTML": "

    Can be one of all, owner, public, private, member. Default: all

    \n

    Will cause a 422 error if used in the same request as visibility or affiliation. Will cause a 422 error if used in the same request as visibility or affiliation.

    " + "descriptionHTML": "

    Can be one of all, owner, public, private, member. Note: For GitHub AE, can be one of all, owner, internal, private, member. Default: all

    \n

    Will cause a 422 error if used in the same request as visibility or affiliation. Will cause a 422 error if used in the same request as visibility or affiliation.

    " }, { "name": "sort", @@ -62255,8 +62600,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/repos", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/repos
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/repos", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/repos
    " }, { "lang": "JavaScript", @@ -62319,13 +62664,13 @@ { "verb": "post", "requestPath": "/user/repos", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/repos \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/repos \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/repos \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/repos \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -62334,7 +62679,7 @@ } ], "summary": "Create a repository for the authenticated user", - "description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.19/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", + "description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.19/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository.", "tags": [ "repos" ], @@ -62377,13 +62722,13 @@ "childParamsGroups": [] }, "private": { - "description": "

    Whether the repository is private or public.

    ", + "description": "

    Whether the repository is private.

    ", "default": false, "type": "boolean", "name": "private", "in": "body", "rawType": "boolean", - "rawDescription": "Whether the repository is private or public.", + "rawDescription": "Whether the repository is private.", "childParamsGroups": [] }, "has_issues": { @@ -62557,7 +62902,7 @@ "category": "repos", "categoryLabel": "Repos", "notes": [], - "descriptionHTML": "

    Creates a new repository for the authenticated user.

    \n

    OAuth scope requirements

    \n

    When using OAuth, authorizations must include:

    \n
      \n
    • public_repo scope or repo scope to create a public repository
    • \n
    • repo scope to create a private repository
    • \n
    ", + "descriptionHTML": "

    Creates a new repository for the authenticated user.

    \n

    OAuth scope requirements

    \n

    When using OAuth, authorizations must include:

    \n
      \n
    • public_repo scope or repo scope to create a public repository. Note: For GitHub AE, use repo scope to create an internal repository.
    • \n
    • repo scope to create a private repository.
    • \n
    ", "bodyParameters": [ { "description": "

    Required. The name of the repository.

    ", @@ -62588,13 +62933,13 @@ "childParamsGroups": [] }, { - "description": "

    Whether the repository is private or public.

    ", + "description": "

    Whether the repository is private.

    ", "default": false, "type": "boolean", "name": "private", "in": "body", "rawType": "boolean", - "rawDescription": "Whether the repository is private or public.", + "rawDescription": "Whether the repository is private.", "childParamsGroups": [] }, { @@ -62778,7 +63123,7 @@ { "verb": "get", "requestPath": "/user/repository_invitations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -62804,8 +63149,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/repository_invitations", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/repository_invitations
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/repository_invitations", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/repository_invitations
    " }, { "lang": "JavaScript", @@ -62870,7 +63215,7 @@ { "verb": "patch", "requestPath": "/user/repository_invitations/{invitation_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "invitation_id", @@ -62886,8 +63231,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/repository_invitations/42", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/repository_invitations/42
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/repository_invitations/42", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/repository_invitations/42
    " }, { "lang": "JavaScript", @@ -62922,7 +63267,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -62951,7 +63296,7 @@ { "verb": "delete", "requestPath": "/user/repository_invitations/{invitation_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "invitation_id", @@ -62967,8 +63312,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/repository_invitations/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/repository_invitations/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/repository_invitations/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/repository_invitations/42
    " }, { "lang": "JavaScript", @@ -63003,7 +63348,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -63032,7 +63377,7 @@ { "verb": "get", "requestPath": "/user/starred", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "sort", @@ -63088,8 +63433,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/starred", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/starred
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/starred", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/starred
    " }, { "lang": "JavaScript", @@ -63149,7 +63494,7 @@ { "verb": "get", "requestPath": "/user/starred/{owner}/{repo}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -63173,8 +63518,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/starred/octocat/hello-world", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/starred/octocat/hello-world
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/starred/octocat/hello-world", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/starred/octocat/hello-world
    " }, { "lang": "JavaScript", @@ -63238,7 +63583,7 @@ { "verb": "put", "requestPath": "/user/starred/{owner}/{repo}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -63262,8 +63607,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/starred/octocat/hello-world", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/starred/octocat/hello-world
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/starred/octocat/hello-world", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/starred/octocat/hello-world
    " }, { "lang": "JavaScript", @@ -63298,7 +63643,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -63327,7 +63672,7 @@ { "verb": "delete", "requestPath": "/user/starred/{owner}/{repo}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -63351,8 +63696,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/starred/octocat/hello-world", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/starred/octocat/hello-world
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/starred/octocat/hello-world", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/starred/octocat/hello-world
    " }, { "lang": "JavaScript", @@ -63387,7 +63732,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -63416,7 +63761,7 @@ { "verb": "get", "requestPath": "/user/subscriptions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -63442,8 +63787,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/subscriptions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/subscriptions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/subscriptions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/subscriptions
    " }, { "lang": "JavaScript", @@ -63503,7 +63848,7 @@ { "verb": "get", "requestPath": "/user/teams", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -63529,8 +63874,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/teams", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/teams
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/teams", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/teams
    " }, { "lang": "JavaScript", @@ -63588,7 +63933,7 @@ { "verb": "get", "requestPath": "/users", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "since", @@ -63614,8 +63959,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users
    " }, { "lang": "JavaScript", @@ -63663,7 +64008,7 @@ { "verb": "get", "requestPath": "/users/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -63678,8 +64023,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME
    " }, { "lang": "JavaScript", @@ -63733,7 +64078,7 @@ { "verb": "get", "requestPath": "/users/{username}/events", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -63768,8 +64113,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/events", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/events
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/events", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/events
    " }, { "lang": "JavaScript", @@ -63813,7 +64158,7 @@ { "verb": "get", "requestPath": "/users/{username}/events/orgs/{org}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -63857,8 +64202,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/events/orgs/ORG", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/events/orgs/ORG
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/events/orgs/ORG", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/events/orgs/ORG
    " }, { "lang": "JavaScript", @@ -63902,7 +64247,7 @@ { "verb": "get", "requestPath": "/users/{username}/events/public", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -63937,8 +64282,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/events/public", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/events/public
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/events/public", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/events/public
    " }, { "lang": "JavaScript", @@ -63982,7 +64327,7 @@ { "verb": "get", "requestPath": "/users/{username}/followers", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -64017,8 +64362,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/followers", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/followers
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/followers", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/followers
    " }, { "lang": "JavaScript", @@ -64063,7 +64408,7 @@ { "verb": "get", "requestPath": "/users/{username}/following", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -64098,8 +64443,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/following", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/following
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/following", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/following
    " }, { "lang": "JavaScript", @@ -64144,7 +64489,7 @@ { "verb": "get", "requestPath": "/users/{username}/following/{target_user}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -64168,8 +64513,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/following/TARGET_USER", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/following/TARGET_USER
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/following/TARGET_USER", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/following/TARGET_USER
    " }, { "lang": "JavaScript", @@ -64218,7 +64563,7 @@ { "verb": "get", "requestPath": "/users/{username}/gists", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -64263,8 +64608,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/gists", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/gists
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/gists", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/gists
    " }, { "lang": "JavaScript", @@ -64312,7 +64657,7 @@ { "verb": "get", "requestPath": "/users/{username}/gpg_keys", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -64347,8 +64692,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/gpg_keys", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/gpg_keys
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/gpg_keys", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/gpg_keys
    " }, { "lang": "JavaScript", @@ -64393,7 +64738,7 @@ { "verb": "get", "requestPath": "/users/{username}/hovercard", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -64434,8 +64779,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/hovercard", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/hovercard
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/hovercard", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/hovercard
    " }, { "lang": "JavaScript", @@ -64488,7 +64833,7 @@ { "verb": "get", "requestPath": "/users/{username}/installation", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -64514,8 +64859,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/users/USERNAME/installation", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  https://api.github.com/users/USERNAME/installation
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/installation", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/installation
    " }, { "lang": "JavaScript", @@ -64564,7 +64909,7 @@ { "verb": "get", "requestPath": "/users/{username}/keys", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -64599,8 +64944,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/keys", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/keys
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/keys", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/keys
    " }, { "lang": "JavaScript", @@ -64645,7 +64990,7 @@ { "verb": "get", "requestPath": "/users/{username}/orgs", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -64680,8 +65025,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/orgs", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/orgs
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/orgs", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/orgs
    " }, { "lang": "JavaScript", @@ -64724,7 +65069,7 @@ { "verb": "get", "requestPath": "/users/{username}/projects", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -64775,8 +65120,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/users/USERNAME/projects", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/users/USERNAME/projects
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/projects", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/projects
    " }, { "lang": "JavaScript", @@ -64836,7 +65181,7 @@ { "verb": "get", "requestPath": "/users/{username}/received_events", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -64871,8 +65216,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/received_events", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/received_events
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/received_events", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/received_events
    " }, { "lang": "JavaScript", @@ -64916,7 +65261,7 @@ { "verb": "get", "requestPath": "/users/{username}/received_events/public", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -64951,8 +65296,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/received_events/public", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/received_events/public
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/received_events/public", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/received_events/public
    " }, { "lang": "JavaScript", @@ -64996,7 +65341,7 @@ { "verb": "get", "requestPath": "/users/{username}/repos", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -65078,8 +65423,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/repos", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/repos
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/repos", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/repos
    " }, { "lang": "JavaScript", @@ -65088,7 +65433,7 @@ } ], "summary": "List repositories for a user", - "description": "Lists public repositories for the specified user.", + "description": "Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user.", "tags": [ "repos" ], @@ -65116,7 +65461,7 @@ "categoryLabel": "Repos", "notes": [], "bodyParameters": [], - "descriptionHTML": "

    Lists public repositories for the specified user.

    ", + "descriptionHTML": "

    Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user.

    ", "responses": [ { "httpStatusCode": "200", @@ -65129,7 +65474,7 @@ { "verb": "put", "requestPath": "/users/{username}/site_admin", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -65144,8 +65489,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/site_admin", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/site_admin
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/site_admin", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/site_admin
    " }, { "lang": "JavaScript", @@ -65180,7 +65525,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -65189,7 +65534,7 @@ { "verb": "delete", "requestPath": "/users/{username}/site_admin", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -65204,8 +65549,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/site_admin", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/site_admin
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/site_admin", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/site_admin
    " }, { "lang": "JavaScript", @@ -65240,7 +65585,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -65249,7 +65594,7 @@ { "verb": "get", "requestPath": "/users/{username}/starred", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -65314,8 +65659,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/starred", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/starred
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/starred", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/starred
    " }, { "lang": "JavaScript", @@ -65360,7 +65705,7 @@ { "verb": "get", "requestPath": "/users/{username}/subscriptions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -65395,8 +65740,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/subscriptions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/subscriptions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/subscriptions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/subscriptions
    " }, { "lang": "JavaScript", @@ -65441,7 +65786,7 @@ { "verb": "put", "requestPath": "/users/{username}/suspended", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -65456,8 +65801,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/suspended \\\n -d '{\"reason\":\"reason\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/suspended \\\n  -d '{\"reason\":\"reason\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/suspended \\\n -d '{\"reason\":\"reason\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/suspended \\\n  -d '{\"reason\":\"reason\"}'
    " }, { "lang": "JavaScript", @@ -65512,7 +65857,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "descriptionHTML": "

    If your GitHub instance uses LDAP Sync with Active Directory LDAP servers, Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a 403 response.

    \n

    You can suspend any user account except your own.

    \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.\"

    ", @@ -65531,7 +65876,7 @@ { "verb": "delete", "requestPath": "/users/{username}/suspended", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -65546,8 +65891,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/suspended \\\n -d '{\"reason\":\"reason\"}'", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/suspended \\\n  -d '{\"reason\":\"reason\"}'
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/suspended \\\n -d '{\"reason\":\"reason\"}'", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/suspended \\\n  -d '{\"reason\":\"reason\"}'
    " }, { "lang": "JavaScript", @@ -65602,7 +65947,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "descriptionHTML": "

    If your GitHub instance uses LDAP Sync with Active Directory LDAP servers, this API is disabled and will return a 403 response. Active Directory LDAP-authenticated users cannot be unsuspended using the API.

    ", @@ -65621,13 +65966,13 @@ { "verb": "get", "requestPath": "/zen", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/zen", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/zen
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/zen", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/zen
    " }, { "lang": "JavaScript", diff --git a/lib/rest/static/decorated/ghes-2.20.json b/lib/rest/static/decorated/ghes-2.20.json index aa9d494403..f1d1f2bbd9 100644 --- a/lib/rest/static/decorated/ghes-2.20.json +++ b/lib/rest/static/decorated/ghes-2.20.json @@ -2,13 +2,13 @@ { "verb": "get", "requestPath": "/", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/
    " }, { "lang": "JavaScript", @@ -45,7 +45,7 @@ { "verb": "get", "requestPath": "/admin/hooks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -82,8 +82,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n https://api.github.com/admin/hooks", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  https://api.github.com/admin/hooks
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/hooks", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/hooks
    " }, { "lang": "JavaScript", @@ -135,7 +135,7 @@ { "verb": "post", "requestPath": "/admin/hooks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -152,8 +152,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n https://api.github.com/admin/hooks \\\n -d '{\"name\":\"name\",\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  https://api.github.com/admin/hooks \\\n  -d '{\"name\":\"name\",\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/hooks \\\n -d '{\"name\":\"name\",\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/hooks \\\n  -d '{\"name\":\"name\",\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'
    " }, { "lang": "JavaScript", @@ -483,7 +483,7 @@ { "verb": "get", "requestPath": "/admin/hooks/{hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -509,8 +509,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n https://api.github.com/admin/hooks/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  https://api.github.com/admin/hooks/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/hooks/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/hooks/42
    " }, { "lang": "JavaScript", @@ -562,7 +562,7 @@ { "verb": "patch", "requestPath": "/admin/hooks/{hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -588,8 +588,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n https://api.github.com/admin/hooks/42 \\\n -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  https://api.github.com/admin/hooks/42 \\\n  -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/hooks/42 \\\n -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/hooks/42 \\\n  -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'
    " }, { "lang": "JavaScript", @@ -893,7 +893,7 @@ { "verb": "delete", "requestPath": "/admin/hooks/{hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -919,8 +919,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n https://api.github.com/admin/hooks/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  https://api.github.com/admin/hooks/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/hooks/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/hooks/42
    " }, { "lang": "JavaScript", @@ -962,7 +962,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -971,7 +971,7 @@ { "verb": "post", "requestPath": "/admin/hooks/{hook_id}/pings", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -997,8 +997,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n https://api.github.com/admin/hooks/42/pings", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  https://api.github.com/admin/hooks/42/pings
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/hooks/42/pings", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/hooks/42/pings
    " }, { "lang": "JavaScript", @@ -1040,7 +1040,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -1049,7 +1049,7 @@ { "verb": "get", "requestPath": "/admin/keys", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -1070,13 +1070,53 @@ "default": 1 }, "descriptionHTML": "

    Page number of the results to fetch.

    " + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + }, + "descriptionHTML": "

    One of asc (ascending) or desc (descending).

    " + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "accessed" + ], + "default": "created" + }, + "descriptionHTML": "" + }, + { + "name": "since", + "description": "Only show public keys accessed after the given time.", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    Only show public keys accessed after the given time.

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/keys", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/keys
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/keys", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/keys
    " }, { "lang": "JavaScript", @@ -1121,7 +1161,7 @@ { "verb": "delete", "requestPath": "/admin/keys/{key_ids}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "key_ids", @@ -1136,8 +1176,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/keys/KEY_IDS", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/keys/KEY_IDS
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/keys/KEY_IDS", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/keys/KEY_IDS
    " }, { "lang": "JavaScript", @@ -1172,7 +1212,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -1181,7 +1221,7 @@ { "verb": "patch", "requestPath": "/admin/ldap/teams/{team_id}/mapping", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -1196,8 +1236,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/ldap/teams/42/mapping \\\n -d '{\"ldap_dn\":\"ldap_dn\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/ldap/teams/42/mapping \\\n  -d '{\"ldap_dn\":\"ldap_dn\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/ldap/teams/42/mapping \\\n -d '{\"ldap_dn\":\"ldap_dn\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/ldap/teams/42/mapping \\\n  -d '{\"ldap_dn\":\"ldap_dn\"}'
    " }, { "lang": "JavaScript", @@ -1275,7 +1315,7 @@ { "verb": "post", "requestPath": "/admin/ldap/teams/{team_id}/sync", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -1290,8 +1330,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/ldap/teams/42/sync", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/ldap/teams/42/sync
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/ldap/teams/42/sync", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/ldap/teams/42/sync
    " }, { "lang": "JavaScript", @@ -1336,7 +1376,7 @@ { "verb": "patch", "requestPath": "/admin/ldap/users/{username}/mapping", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -1351,8 +1391,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/ldap/users/USERNAME/mapping \\\n -d '{\"ldap_dn\":\"ldap_dn\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/ldap/users/USERNAME/mapping \\\n  -d '{\"ldap_dn\":\"ldap_dn\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/ldap/users/USERNAME/mapping \\\n -d '{\"ldap_dn\":\"ldap_dn\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/ldap/users/USERNAME/mapping \\\n  -d '{\"ldap_dn\":\"ldap_dn\"}'
    " }, { "lang": "JavaScript", @@ -1430,7 +1470,7 @@ { "verb": "post", "requestPath": "/admin/ldap/users/{username}/sync", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -1445,8 +1485,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/ldap/users/USERNAME/sync", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/ldap/users/USERNAME/sync
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/ldap/users/USERNAME/sync", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/ldap/users/USERNAME/sync
    " }, { "lang": "JavaScript", @@ -1491,13 +1531,13 @@ { "verb": "post", "requestPath": "/admin/organizations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/organizations \\\n -d '{\"login\":\"login\",\"admin\":\"admin\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/organizations \\\n  -d '{\"login\":\"login\",\"admin\":\"admin\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/organizations \\\n -d '{\"login\":\"login\",\"admin\":\"admin\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/organizations \\\n  -d '{\"login\":\"login\",\"admin\":\"admin\"}'
    " }, { "lang": "JavaScript", @@ -1617,7 +1657,7 @@ { "verb": "patch", "requestPath": "/admin/organizations/{org}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -1632,8 +1672,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/organizations/ORG \\\n -d '{\"login\":\"login\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/organizations/ORG \\\n  -d '{\"login\":\"login\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/organizations/ORG \\\n -d '{\"login\":\"login\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/organizations/ORG \\\n  -d '{\"login\":\"login\"}'
    " }, { "lang": "JavaScript", @@ -1714,7 +1754,7 @@ { "verb": "get", "requestPath": "/admin/pre-receive-environments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -1735,13 +1775,43 @@ "default": 1 }, "descriptionHTML": "

    Page number of the results to fetch.

    " + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + }, + "descriptionHTML": "

    One of asc (ascending) or desc (descending).

    " + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + }, + "descriptionHTML": "" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-environments", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/admin/pre-receive-environments
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/pre-receive-environments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/pre-receive-environments
    " }, { "lang": "JavaScript", @@ -1793,13 +1863,13 @@ { "verb": "post", "requestPath": "/admin/pre-receive-environments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-environments \\\n -d '{\"name\":\"name\",\"image_url\":\"image_url\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/admin/pre-receive-environments \\\n  -d '{\"name\":\"name\",\"image_url\":\"image_url\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/pre-receive-environments \\\n -d '{\"name\":\"name\",\"image_url\":\"image_url\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/pre-receive-environments \\\n  -d '{\"name\":\"name\",\"image_url\":\"image_url\"}'
    " }, { "lang": "JavaScript", @@ -1907,7 +1977,7 @@ { "verb": "get", "requestPath": "/admin/pre-receive-environments/{pre_receive_environment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "pre_receive_environment_id", @@ -1922,8 +1992,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-environments/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/admin/pre-receive-environments/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/pre-receive-environments/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/pre-receive-environments/42
    " }, { "lang": "JavaScript", @@ -1975,7 +2045,7 @@ { "verb": "patch", "requestPath": "/admin/pre-receive-environments/{pre_receive_environment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "pre_receive_environment_id", @@ -1990,8 +2060,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-environments/42 \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/admin/pre-receive-environments/42 \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/pre-receive-environments/42 \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/pre-receive-environments/42 \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -2097,7 +2167,7 @@ { "verb": "delete", "requestPath": "/admin/pre-receive-environments/{pre_receive_environment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "pre_receive_environment_id", @@ -2112,8 +2182,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-environments/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/admin/pre-receive-environments/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/pre-receive-environments/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/pre-receive-environments/42
    " }, { "lang": "JavaScript", @@ -2157,7 +2227,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "422", @@ -2170,7 +2240,7 @@ { "verb": "post", "requestPath": "/admin/pre-receive-environments/{pre_receive_environment_id}/downloads", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "pre_receive_environment_id", @@ -2185,8 +2255,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-environments/42/downloads", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/admin/pre-receive-environments/42/downloads
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/pre-receive-environments/42/downloads", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/pre-receive-environments/42/downloads
    " }, { "lang": "JavaScript", @@ -2244,7 +2314,7 @@ { "verb": "get", "requestPath": "/admin/pre-receive-environments/{pre_receive_environment_id}/downloads/latest", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "pre_receive_environment_id", @@ -2259,8 +2329,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-environments/42/downloads/latest", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/admin/pre-receive-environments/42/downloads/latest
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/pre-receive-environments/42/downloads/latest", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/pre-receive-environments/42/downloads/latest
    " }, { "lang": "JavaScript", @@ -2312,7 +2382,7 @@ { "verb": "get", "requestPath": "/admin/pre-receive-hooks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -2333,13 +2403,44 @@ "default": 1 }, "descriptionHTML": "

    Page number of the results to fetch.

    " + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + }, + "descriptionHTML": "

    One of asc (ascending) or desc (descending).

    " + }, + { + "name": "sort", + "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to) or `name`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + }, + "descriptionHTML": "

    One of created (when the repository was starred) or updated (when it was last pushed to) or name.

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-hooks", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/admin/pre-receive-hooks
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/pre-receive-hooks", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/pre-receive-hooks
    " }, { "lang": "JavaScript", @@ -2391,13 +2492,13 @@ { "verb": "post", "requestPath": "/admin/pre-receive-hooks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-hooks \\\n -d '{\"name\":\"name\",\"script\":\"script\",\"script_repository\":{},\"environment\":{}}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/admin/pre-receive-hooks \\\n  -d '{\"name\":\"name\",\"script\":\"script\",\"script_repository\":{},\"environment\":{}}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/pre-receive-hooks \\\n -d '{\"name\":\"name\",\"script\":\"script\",\"script_repository\":{},\"environment\":{}}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/pre-receive-hooks \\\n  -d '{\"name\":\"name\",\"script\":\"script\",\"script_repository\":{},\"environment\":{}}'
    " }, { "lang": "JavaScript", @@ -2595,7 +2696,7 @@ { "verb": "get", "requestPath": "/admin/pre-receive-hooks/{pre_receive_hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "pre_receive_hook_id", @@ -2610,8 +2711,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-hooks/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/admin/pre-receive-hooks/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/pre-receive-hooks/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/pre-receive-hooks/42
    " }, { "lang": "JavaScript", @@ -2663,7 +2764,7 @@ { "verb": "patch", "requestPath": "/admin/pre-receive-hooks/{pre_receive_hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "pre_receive_hook_id", @@ -2678,8 +2779,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-hooks/42 \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/admin/pre-receive-hooks/42 \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/pre-receive-hooks/42 \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/pre-receive-hooks/42 \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -2866,7 +2967,7 @@ { "verb": "delete", "requestPath": "/admin/pre-receive-hooks/{pre_receive_hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "pre_receive_hook_id", @@ -2881,8 +2982,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-hooks/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/admin/pre-receive-hooks/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/pre-receive-hooks/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/pre-receive-hooks/42
    " }, { "lang": "JavaScript", @@ -2924,7 +3025,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -2933,7 +3034,7 @@ { "verb": "get", "requestPath": "/admin/tokens", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -2959,8 +3060,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/tokens", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/tokens
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/tokens", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/tokens
    " }, { "lang": "JavaScript", @@ -3005,7 +3106,7 @@ { "verb": "delete", "requestPath": "/admin/tokens/{token_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "token_id", @@ -3020,8 +3121,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/tokens/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/tokens/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/tokens/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/tokens/42
    " }, { "lang": "JavaScript", @@ -3056,7 +3157,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -3065,13 +3166,13 @@ { "verb": "post", "requestPath": "/admin/users", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/users \\\n -d '{\"login\":\"login\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/users \\\n  -d '{\"login\":\"login\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/users \\\n -d '{\"login\":\"login\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/users \\\n  -d '{\"login\":\"login\"}'
    " }, { "lang": "JavaScript", @@ -3171,7 +3272,7 @@ { "verb": "patch", "requestPath": "/admin/users/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -3186,8 +3287,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/users/USERNAME \\\n -d '{\"login\":\"login\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/users/USERNAME \\\n  -d '{\"login\":\"login\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/users/USERNAME \\\n -d '{\"login\":\"login\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/users/USERNAME \\\n  -d '{\"login\":\"login\"}'
    " }, { "lang": "JavaScript", @@ -3268,7 +3369,7 @@ { "verb": "delete", "requestPath": "/admin/users/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -3283,8 +3384,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/users/USERNAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/users/USERNAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/users/USERNAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/users/USERNAME
    " }, { "lang": "JavaScript", @@ -3319,7 +3420,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -3328,7 +3429,7 @@ { "verb": "post", "requestPath": "/admin/users/{username}/authorizations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -3343,8 +3444,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/users/USERNAME/authorizations \\\n -d '{\"scopes\":[\"scopes\"]}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/users/USERNAME/authorizations \\\n  -d '{\"scopes\":[\"scopes\"]}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/users/USERNAME/authorizations \\\n -d '{\"scopes\":[\"scopes\"]}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/users/USERNAME/authorizations \\\n  -d '{\"scopes\":[\"scopes\"]}'
    " }, { "lang": "JavaScript", @@ -3425,7 +3526,7 @@ { "verb": "delete", "requestPath": "/admin/users/{username}/authorizations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -3440,8 +3541,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/users/USERNAME/authorizations", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/users/USERNAME/authorizations
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/users/USERNAME/authorizations", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/users/USERNAME/authorizations
    " }, { "lang": "JavaScript", @@ -3476,7 +3577,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -3485,13 +3586,13 @@ { "verb": "get", "requestPath": "/app", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/app", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  https://api.github.com/app
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n http(s)://{hostname}/api/v3/app", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  http(s)://{hostname}/api/v3/app
    " }, { "lang": "JavaScript", @@ -3540,7 +3641,7 @@ { "verb": "post", "requestPath": "/app-manifests/{code}/conversions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "code", @@ -3555,8 +3656,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/app-manifests/CODE/conversions", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/app-manifests/CODE/conversions
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/app-manifests/CODE/conversions", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/app-manifests/CODE/conversions
    " }, { "lang": "JavaScript", @@ -3609,7 +3710,7 @@ { "verb": "get", "requestPath": "/app/installations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -3646,8 +3747,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/app/installations", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  https://api.github.com/app/installations
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n http(s)://{hostname}/api/v3/app/installations", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  http(s)://{hostname}/api/v3/app/installations
    " }, { "lang": "JavaScript", @@ -3696,7 +3797,7 @@ { "verb": "get", "requestPath": "/app/installations/{installation_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -3723,8 +3824,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/app/installations/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  https://api.github.com/app/installations/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n http(s)://{hostname}/api/v3/app/installations/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  http(s)://{hostname}/api/v3/app/installations/42
    " }, { "lang": "JavaScript", @@ -3783,7 +3884,7 @@ { "verb": "delete", "requestPath": "/app/installations/{installation_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -3810,8 +3911,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.gambit-preview+json\" \\\n https://api.github.com/app/installations/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.gambit-preview+json\" \\\n  https://api.github.com/app/installations/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.gambit-preview+json\" \\\n http(s)://{hostname}/api/v3/app/installations/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.gambit-preview+json\" \\\n  http(s)://{hostname}/api/v3/app/installations/42
    " }, { "lang": "JavaScript", @@ -3856,7 +3957,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -3870,7 +3971,7 @@ { "verb": "post", "requestPath": "/app/installations/{installation_id}/access_tokens", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -3897,8 +3998,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/app/installations/42/access_tokens \\\n -d '{\"repositories\":[\"repositories\"]}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  https://api.github.com/app/installations/42/access_tokens \\\n  -d '{\"repositories\":[\"repositories\"]}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n http(s)://{hostname}/api/v3/app/installations/42/access_tokens \\\n -d '{\"repositories\":[\"repositories\"]}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  http(s)://{hostname}/api/v3/app/installations/42/access_tokens \\\n  -d '{\"repositories\":[\"repositories\"]}'
    " }, { "lang": "JavaScript", @@ -5648,7 +5749,7 @@ { "verb": "get", "requestPath": "/applications/grants", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -5669,13 +5770,23 @@ "default": 1 }, "descriptionHTML": "

    Page number of the results to fetch.

    " + }, + { + "name": "client_id", + "in": "query", + "required": false, + "description": "The client ID of your GitHub app.", + "schema": { + "type": "string" + }, + "descriptionHTML": "

    The client ID of your GitHub app.

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/grants", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/applications/grants
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/applications/grants", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/applications/grants
    " }, { "lang": "JavaScript", @@ -5741,7 +5852,7 @@ { "verb": "get", "requestPath": "/applications/grants/{grant_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "grant_id", @@ -5757,8 +5868,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/grants/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/applications/grants/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/applications/grants/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/applications/grants/42
    " }, { "lang": "JavaScript", @@ -5819,7 +5930,7 @@ { "verb": "delete", "requestPath": "/applications/grants/{grant_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "grant_id", @@ -5835,8 +5946,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/grants/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/applications/grants/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/applications/grants/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/applications/grants/42
    " }, { "lang": "JavaScript", @@ -5872,7 +5983,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -5896,7 +6007,7 @@ { "verb": "delete", "requestPath": "/applications/{client_id}/grant", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "client_id", @@ -5912,8 +6023,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/CLIENT_ID/grant \\\n -d '{\"access_token\":\"access_token\"}'", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/applications/CLIENT_ID/grant \\\n  -d '{\"access_token\":\"access_token\"}'
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/applications/CLIENT_ID/grant \\\n -d '{\"access_token\":\"access_token\"}'", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/applications/CLIENT_ID/grant \\\n  -d '{\"access_token\":\"access_token\"}'
    " }, { "lang": "JavaScript", @@ -5971,7 +6082,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "422", @@ -5995,7 +6106,7 @@ { "verb": "delete", "requestPath": "/applications/{client_id}/grants/{access_token}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "client_id", @@ -6020,8 +6131,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/CLIENT_ID/grants/ACCESS_TOKEN", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/applications/CLIENT_ID/grants/ACCESS_TOKEN
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/applications/CLIENT_ID/grants/ACCESS_TOKEN", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/applications/CLIENT_ID/grants/ACCESS_TOKEN
    " }, { "lang": "JavaScript", @@ -6059,7 +6170,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -6068,7 +6179,7 @@ { "verb": "post", "requestPath": "/applications/{client_id}/token", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "client_id", @@ -6084,8 +6195,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/CLIENT_ID/token \\\n -d '{\"access_token\":\"access_token\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/applications/CLIENT_ID/token \\\n  -d '{\"access_token\":\"access_token\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/applications/CLIENT_ID/token \\\n -d '{\"access_token\":\"access_token\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/applications/CLIENT_ID/token \\\n  -d '{\"access_token\":\"access_token\"}'
    " }, { "lang": "JavaScript", @@ -6173,7 +6284,7 @@ { "verb": "patch", "requestPath": "/applications/{client_id}/token", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "client_id", @@ -6189,8 +6300,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/CLIENT_ID/token \\\n -d '{\"access_token\":\"access_token\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/applications/CLIENT_ID/token \\\n  -d '{\"access_token\":\"access_token\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/applications/CLIENT_ID/token \\\n -d '{\"access_token\":\"access_token\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/applications/CLIENT_ID/token \\\n  -d '{\"access_token\":\"access_token\"}'
    " }, { "lang": "JavaScript", @@ -6273,7 +6384,7 @@ { "verb": "delete", "requestPath": "/applications/{client_id}/token", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "client_id", @@ -6289,8 +6400,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/CLIENT_ID/token \\\n -d '{\"access_token\":\"access_token\"}'", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/applications/CLIENT_ID/token \\\n  -d '{\"access_token\":\"access_token\"}'
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/applications/CLIENT_ID/token \\\n -d '{\"access_token\":\"access_token\"}'", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/applications/CLIENT_ID/token \\\n  -d '{\"access_token\":\"access_token\"}'
    " }, { "lang": "JavaScript", @@ -6316,14 +6427,17 @@ "properties": { "access_token": { "type": "string", - "description": "

    The OAuth access token used to authenticate to the GitHub API.

    ", + "description": "

    Required. The OAuth access token used to authenticate to the GitHub API.

    ", "name": "access_token", "in": "body", "rawType": "string", "rawDescription": "The OAuth access token used to authenticate to the GitHub API.", "childParamsGroups": [] } - } + }, + "required": [ + "access_token" + ] }, "example": { "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a" @@ -6348,7 +6462,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "422", @@ -6360,7 +6474,7 @@ "bodyParameters": [ { "type": "string", - "description": "

    The OAuth access token used to authenticate to the GitHub API.

    ", + "description": "

    Required. The OAuth access token used to authenticate to the GitHub API.

    ", "name": "access_token", "in": "body", "rawType": "string", @@ -6372,7 +6486,7 @@ { "verb": "get", "requestPath": "/applications/{client_id}/tokens/{access_token}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "client_id", @@ -6397,8 +6511,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/CLIENT_ID/tokens/ACCESS_TOKEN", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/applications/CLIENT_ID/tokens/ACCESS_TOKEN
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/applications/CLIENT_ID/tokens/ACCESS_TOKEN", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/applications/CLIENT_ID/tokens/ACCESS_TOKEN
    " }, { "lang": "JavaScript", @@ -6451,7 +6565,7 @@ { "verb": "post", "requestPath": "/applications/{client_id}/tokens/{access_token}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "client_id", @@ -6476,8 +6590,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/CLIENT_ID/tokens/ACCESS_TOKEN", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/applications/CLIENT_ID/tokens/ACCESS_TOKEN
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/applications/CLIENT_ID/tokens/ACCESS_TOKEN", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/applications/CLIENT_ID/tokens/ACCESS_TOKEN
    " }, { "lang": "JavaScript", @@ -6525,7 +6639,7 @@ { "verb": "delete", "requestPath": "/applications/{client_id}/tokens/{access_token}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "client_id", @@ -6550,8 +6664,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/CLIENT_ID/tokens/ACCESS_TOKEN", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/applications/CLIENT_ID/tokens/ACCESS_TOKEN
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/applications/CLIENT_ID/tokens/ACCESS_TOKEN", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/applications/CLIENT_ID/tokens/ACCESS_TOKEN
    " }, { "lang": "JavaScript", @@ -6589,7 +6703,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -6598,7 +6712,7 @@ { "verb": "get", "requestPath": "/apps/{app_slug}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "app_slug", @@ -6613,8 +6727,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/apps/APP_SLUG", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  https://api.github.com/apps/APP_SLUG
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n http(s)://{hostname}/api/v3/apps/APP_SLUG", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  http(s)://{hostname}/api/v3/apps/APP_SLUG
    " }, { "lang": "JavaScript", @@ -6678,7 +6792,7 @@ { "verb": "get", "requestPath": "/authorizations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -6699,13 +6813,23 @@ "default": 1 }, "descriptionHTML": "

    Page number of the results to fetch.

    " + }, + { + "name": "client_id", + "in": "query", + "required": false, + "description": "The client ID of your GitHub app.", + "schema": { + "type": "string" + }, + "descriptionHTML": "

    The client ID of your GitHub app.

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/authorizations", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/authorizations
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/authorizations", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/authorizations
    " }, { "lang": "JavaScript", @@ -6771,13 +6895,13 @@ { "verb": "post", "requestPath": "/authorizations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/authorizations \\\n -d '{\"scopes\":[\"scopes\"]}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/authorizations \\\n  -d '{\"scopes\":[\"scopes\"]}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/authorizations \\\n -d '{\"scopes\":[\"scopes\"]}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/authorizations \\\n  -d '{\"scopes\":[\"scopes\"]}'
    " }, { "lang": "JavaScript", @@ -6990,7 +7114,7 @@ { "verb": "put", "requestPath": "/authorizations/clients/{client_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "client_id", @@ -7006,8 +7130,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/authorizations/clients/CLIENT_ID \\\n -d '{\"client_secret\":\"client_secret\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/authorizations/clients/CLIENT_ID \\\n  -d '{\"client_secret\":\"client_secret\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/authorizations/clients/CLIENT_ID \\\n -d '{\"client_secret\":\"client_secret\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/authorizations/clients/CLIENT_ID \\\n  -d '{\"client_secret\":\"client_secret\"}'
    " }, { "lang": "JavaScript", @@ -7204,7 +7328,7 @@ { "verb": "put", "requestPath": "/authorizations/clients/{client_id}/{fingerprint}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "client_id", @@ -7229,8 +7353,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/authorizations/clients/CLIENT_ID/FINGERPRINT \\\n -d '{\"client_secret\":\"client_secret\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/authorizations/clients/CLIENT_ID/FINGERPRINT \\\n  -d '{\"client_secret\":\"client_secret\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/authorizations/clients/CLIENT_ID/FINGERPRINT \\\n -d '{\"client_secret\":\"client_secret\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/authorizations/clients/CLIENT_ID/FINGERPRINT \\\n  -d '{\"client_secret\":\"client_secret\"}'
    " }, { "lang": "JavaScript", @@ -7394,7 +7518,7 @@ { "verb": "get", "requestPath": "/authorizations/{authorization_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "authorization_id", @@ -7410,8 +7534,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/authorizations/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/authorizations/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/authorizations/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/authorizations/42
    " }, { "lang": "JavaScript", @@ -7472,7 +7596,7 @@ { "verb": "patch", "requestPath": "/authorizations/{authorization_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "authorization_id", @@ -7488,8 +7612,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/authorizations/42 \\\n -d '{\"scopes\":[\"scopes\"]}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/authorizations/42 \\\n  -d '{\"scopes\":[\"scopes\"]}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/authorizations/42 \\\n -d '{\"scopes\":[\"scopes\"]}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/authorizations/42 \\\n  -d '{\"scopes\":[\"scopes\"]}'
    " }, { "lang": "JavaScript", @@ -7690,7 +7814,7 @@ { "verb": "delete", "requestPath": "/authorizations/{authorization_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "authorization_id", @@ -7706,8 +7830,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/authorizations/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/authorizations/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/authorizations/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/authorizations/42
    " }, { "lang": "JavaScript", @@ -7743,7 +7867,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -7767,13 +7891,13 @@ { "verb": "get", "requestPath": "/codes_of_conduct", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.scarlet-witch-preview+json\" \\\n https://api.github.com/codes_of_conduct", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.scarlet-witch-preview+json\" \\\n  https://api.github.com/codes_of_conduct
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.scarlet-witch-preview+json\" \\\n http(s)://{hostname}/api/v3/codes_of_conduct", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.scarlet-witch-preview+json\" \\\n  http(s)://{hostname}/api/v3/codes_of_conduct
    " }, { "lang": "JavaScript", @@ -7833,7 +7957,7 @@ { "verb": "get", "requestPath": "/codes_of_conduct/{key}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "key", @@ -7848,8 +7972,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.scarlet-witch-preview+json\" \\\n https://api.github.com/codes_of_conduct/KEY", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.scarlet-witch-preview+json\" \\\n  https://api.github.com/codes_of_conduct/KEY
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.scarlet-witch-preview+json\" \\\n http(s)://{hostname}/api/v3/codes_of_conduct/KEY", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.scarlet-witch-preview+json\" \\\n  http(s)://{hostname}/api/v3/codes_of_conduct/KEY
    " }, { "lang": "JavaScript", @@ -7914,7 +8038,7 @@ { "verb": "post", "requestPath": "/content_references/{content_reference_id}/attachments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "content_reference_id", @@ -7929,8 +8053,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n https://api.github.com/content_references/42/attachments \\\n -d '{\"title\":\"title\",\"body\":\"body\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n  https://api.github.com/content_references/42/attachments \\\n  -d '{\"title\":\"title\",\"body\":\"body\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n http(s)://{hostname}/api/v3/content_references/42/attachments \\\n -d '{\"title\":\"title\",\"body\":\"body\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n  http(s)://{hostname}/api/v3/content_references/42/attachments \\\n  -d '{\"title\":\"title\",\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -8072,13 +8196,13 @@ { "verb": "get", "requestPath": "/emojis", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/emojis", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/emojis
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/emojis", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/emojis
    " }, { "lang": "JavaScript", @@ -8125,13 +8249,13 @@ { "verb": "get", "requestPath": "/enterprise/settings/license", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprise/settings/license", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprise/settings/license
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/enterprise/settings/license", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/enterprise/settings/license
    " }, { "lang": "JavaScript", @@ -8176,7 +8300,7 @@ { "verb": "get", "requestPath": "/enterprise/stats/{type}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "type", @@ -8191,8 +8315,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprise/stats/TYPE", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprise/stats/TYPE
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/enterprise/stats/TYPE", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/enterprise/stats/TYPE
    " }, { "lang": "JavaScript", @@ -8237,7 +8361,7 @@ { "verb": "get", "requestPath": "/events", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -8263,8 +8387,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/events", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/events
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/events", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/events
    " }, { "lang": "JavaScript", @@ -8323,13 +8447,13 @@ { "verb": "get", "requestPath": "/feeds", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/feeds", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/feeds
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/feeds", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/feeds
    " }, { "lang": "JavaScript", @@ -8374,7 +8498,7 @@ { "verb": "get", "requestPath": "/gists", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "since", @@ -8410,8 +8534,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists
    " }, { "lang": "JavaScript", @@ -8464,13 +8588,13 @@ { "verb": "post", "requestPath": "/gists", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists \\\n -d '{\"files\":{}}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists \\\n  -d '{\"files\":{}}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists \\\n -d '{\"files\":{}}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists \\\n  -d '{\"files\":{}}'
    " }, { "lang": "JavaScript", @@ -8668,7 +8792,7 @@ { "verb": "get", "requestPath": "/gists/public", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "since", @@ -8704,8 +8828,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/public", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/public
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/public", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/public
    " }, { "lang": "JavaScript", @@ -8763,7 +8887,7 @@ { "verb": "get", "requestPath": "/gists/starred", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "since", @@ -8799,8 +8923,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/starred", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/starred
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/starred", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/starred
    " }, { "lang": "JavaScript", @@ -8858,7 +8982,7 @@ { "verb": "get", "requestPath": "/gists/{gist_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -8874,8 +8998,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID
    " }, { "lang": "JavaScript", @@ -8933,7 +9057,7 @@ { "verb": "patch", "requestPath": "/gists/{gist_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -8949,8 +9073,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID \\\n -d '{\"description\":\"description\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID \\\n  -d '{\"description\":\"description\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID \\\n -d '{\"description\":\"description\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID \\\n  -d '{\"description\":\"description\"}'
    " }, { "lang": "JavaScript", @@ -9140,7 +9264,7 @@ { "verb": "delete", "requestPath": "/gists/{gist_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -9156,8 +9280,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID
    " }, { "lang": "JavaScript", @@ -9190,7 +9314,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -9214,7 +9338,7 @@ { "verb": "get", "requestPath": "/gists/{gist_id}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -9250,8 +9374,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/comments", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/comments
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID/comments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID/comments
    " }, { "lang": "JavaScript", @@ -9311,7 +9435,7 @@ { "verb": "post", "requestPath": "/gists/{gist_id}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -9327,8 +9451,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/comments \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/comments \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID/comments \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID/comments \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -9425,7 +9549,7 @@ { "verb": "get", "requestPath": "/gists/{gist_id}/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -9451,8 +9575,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/comments/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/comments/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID/comments/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID/comments/42
    " }, { "lang": "JavaScript", @@ -9512,7 +9636,7 @@ { "verb": "patch", "requestPath": "/gists/{gist_id}/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -9538,8 +9662,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/comments/42 \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/comments/42 \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID/comments/42 \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID/comments/42 \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -9626,7 +9750,7 @@ { "verb": "delete", "requestPath": "/gists/{gist_id}/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -9652,8 +9776,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/comments/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/comments/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID/comments/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID/comments/42
    " }, { "lang": "JavaScript", @@ -9688,7 +9812,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -9712,7 +9836,7 @@ { "verb": "get", "requestPath": "/gists/{gist_id}/commits", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -9748,8 +9872,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/commits", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/commits
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID/commits", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID/commits
    " }, { "lang": "JavaScript", @@ -9807,7 +9931,7 @@ { "verb": "get", "requestPath": "/gists/{gist_id}/forks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -9843,8 +9967,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/forks", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/forks
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID/forks", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID/forks
    " }, { "lang": "JavaScript", @@ -9902,7 +10026,7 @@ { "verb": "post", "requestPath": "/gists/{gist_id}/forks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -9918,8 +10042,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/forks", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/forks
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID/forks", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID/forks
    " }, { "lang": "JavaScript", @@ -9982,7 +10106,7 @@ { "verb": "get", "requestPath": "/gists/{gist_id}/star", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -9998,8 +10122,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/star", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/star
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID/star", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID/star
    " }, { "lang": "JavaScript", @@ -10056,7 +10180,7 @@ { "verb": "put", "requestPath": "/gists/{gist_id}/star", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -10072,8 +10196,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/star", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/star
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID/star", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID/star
    " }, { "lang": "JavaScript", @@ -10106,7 +10230,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -10130,7 +10254,7 @@ { "verb": "delete", "requestPath": "/gists/{gist_id}/star", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -10146,8 +10270,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/star", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/star
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID/star", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID/star
    " }, { "lang": "JavaScript", @@ -10180,7 +10304,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -10204,7 +10328,7 @@ { "verb": "get", "requestPath": "/gists/{gist_id}/{sha}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -10229,8 +10353,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/SHA", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/SHA
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID/SHA", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID/SHA
    " }, { "lang": "JavaScript", @@ -10288,13 +10412,13 @@ { "verb": "get", "requestPath": "/gitignore/templates", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gitignore/templates", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gitignore/templates
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gitignore/templates", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gitignore/templates
    " }, { "lang": "JavaScript", @@ -10342,7 +10466,7 @@ { "verb": "get", "requestPath": "/gitignore/templates/{name}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "name", @@ -10357,8 +10481,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gitignore/templates/NAME", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gitignore/templates/NAME
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gitignore/templates/NAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gitignore/templates/NAME
    " }, { "lang": "JavaScript", @@ -10406,7 +10530,7 @@ { "verb": "get", "requestPath": "/installation/repositories", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -10443,8 +10567,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/installation/repositories", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  https://api.github.com/installation/repositories
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n http(s)://{hostname}/api/v3/installation/repositories", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  http(s)://{hostname}/api/v3/installation/repositories
    " }, { "lang": "JavaScript", @@ -10517,13 +10641,13 @@ { "verb": "delete", "requestPath": "/installation/token", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/installation/token", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/installation/token
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/installation/token", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/installation/token
    " }, { "lang": "JavaScript", @@ -10558,7 +10682,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -10567,7 +10691,7 @@ { "verb": "get", "requestPath": "/issues", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "filter", @@ -10581,6 +10705,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -10714,8 +10839,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/issues", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/issues
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/issues", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/issues
    " }, { "lang": "JavaScript", @@ -10779,7 +10904,7 @@ { "verb": "get", "requestPath": "/licenses", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "featured", @@ -10799,13 +10924,23 @@ "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/licenses", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/licenses
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/licenses", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/licenses
    " }, { "lang": "JavaScript", @@ -10853,7 +10988,7 @@ { "verb": "get", "requestPath": "/licenses/{license}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "license", @@ -10868,8 +11003,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/licenses/LICENSE", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/licenses/LICENSE
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/licenses/LICENSE", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/licenses/LICENSE
    " }, { "lang": "JavaScript", @@ -10927,13 +11062,13 @@ { "verb": "post", "requestPath": "/markdown", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/markdown \\\n -d '{\"text\":\"text\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/markdown \\\n  -d '{\"text\":\"text\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/markdown \\\n -d '{\"text\":\"text\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/markdown \\\n  -d '{\"text\":\"text\"}'
    " }, { "lang": "JavaScript", @@ -11061,13 +11196,13 @@ { "verb": "post", "requestPath": "/markdown/raw", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/markdown/raw", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/markdown/raw
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/markdown/raw", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/markdown/raw
    " }, { "lang": "JavaScript", @@ -11128,13 +11263,13 @@ { "verb": "get", "requestPath": "/meta", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/meta", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/meta
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/meta", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/meta
    " }, { "lang": "JavaScript", @@ -11182,7 +11317,7 @@ { "verb": "get", "requestPath": "/networks/{owner}/{repo}/events", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -11226,8 +11361,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/networks/octocat/hello-world/events", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/networks/octocat/hello-world/events
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/networks/octocat/hello-world/events", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/networks/octocat/hello-world/events
    " }, { "lang": "JavaScript", @@ -11291,7 +11426,7 @@ { "verb": "get", "requestPath": "/notifications", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "all", @@ -11359,8 +11494,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/notifications", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/notifications
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/notifications", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/notifications
    " }, { "lang": "JavaScript", @@ -11425,13 +11560,13 @@ { "verb": "put", "requestPath": "/notifications", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/notifications \\\n -d '{\"last_read_at\":\"last_read_at\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/notifications \\\n  -d '{\"last_read_at\":\"last_read_at\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/notifications \\\n -d '{\"last_read_at\":\"last_read_at\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/notifications \\\n  -d '{\"last_read_at\":\"last_read_at\"}'
    " }, { "lang": "JavaScript", @@ -11545,7 +11680,7 @@ { "verb": "get", "requestPath": "/notifications/threads/{thread_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "thread_id", @@ -11561,8 +11696,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/notifications/threads/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/notifications/threads/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/notifications/threads/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/notifications/threads/42
    " }, { "lang": "JavaScript", @@ -11622,7 +11757,7 @@ { "verb": "patch", "requestPath": "/notifications/threads/{thread_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "thread_id", @@ -11638,8 +11773,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/notifications/threads/42", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/notifications/threads/42
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/notifications/threads/42", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/notifications/threads/42
    " }, { "lang": "JavaScript", @@ -11693,7 +11828,7 @@ { "verb": "get", "requestPath": "/notifications/threads/{thread_id}/subscription", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "thread_id", @@ -11709,8 +11844,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/notifications/threads/42/subscription", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/notifications/threads/42/subscription
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/notifications/threads/42/subscription", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/notifications/threads/42/subscription
    " }, { "lang": "JavaScript", @@ -11770,7 +11905,7 @@ { "verb": "put", "requestPath": "/notifications/threads/{thread_id}/subscription", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "thread_id", @@ -11786,8 +11921,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/notifications/threads/42/subscription \\\n -d '{\"ignored\":true}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/notifications/threads/42/subscription \\\n  -d '{\"ignored\":true}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/notifications/threads/42/subscription \\\n -d '{\"ignored\":true}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/notifications/threads/42/subscription \\\n  -d '{\"ignored\":true}'
    " }, { "lang": "JavaScript", @@ -11879,7 +12014,7 @@ { "verb": "delete", "requestPath": "/notifications/threads/{thread_id}/subscription", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "thread_id", @@ -11895,8 +12030,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/notifications/threads/42/subscription", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/notifications/threads/42/subscription
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/notifications/threads/42/subscription", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/notifications/threads/42/subscription
    " }, { "lang": "JavaScript", @@ -11931,7 +12066,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -11955,7 +12090,7 @@ { "verb": "get", "requestPath": "/octocat", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "s", @@ -11971,8 +12106,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/octocat", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/octocat
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/octocat", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/octocat
    " }, { "lang": "JavaScript", @@ -12009,7 +12144,7 @@ { "verb": "get", "requestPath": "/organizations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "since", @@ -12035,8 +12170,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/organizations", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/organizations
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/organizations", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/organizations
    " }, { "lang": "JavaScript", @@ -12084,7 +12219,7 @@ { "verb": "get", "requestPath": "/orgs/{org}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -12099,8 +12234,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG
    " }, { "lang": "JavaScript", @@ -12143,13 +12278,7 @@ "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "
    {\n  \"login\": \"github\",\n  \"id\": 1,\n  \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n  \"url\": \"https://api.github.com/orgs/github\",\n  \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n  \"events_url\": \"https://api.github.com/orgs/github/events\",\n  \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n  \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n  \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n  \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n  \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n  \"description\": \"A great organization\",\n  \"name\": \"github\",\n  \"company\": \"GitHub\",\n  \"blog\": \"https://github.com/blog\",\n  \"location\": \"San Francisco\",\n  \"email\": \"octocat@github.com\",\n  \"twitter_username\": \"github\",\n  \"is_verified\": true,\n  \"has_organization_projects\": true,\n  \"has_repository_projects\": true,\n  \"public_repos\": 2,\n  \"public_gists\": 1,\n  \"followers\": 20,\n  \"following\": 0,\n  \"html_url\": \"https://github.com/octocat\",\n  \"created_at\": \"2008-01-14T04:33:35Z\",\n  \"updated_at\": \"2014-03-03T18:58:10Z\",\n  \"type\": \"Organization\",\n  \"total_private_repos\": 100,\n  \"owned_private_repos\": 100,\n  \"private_gists\": 81,\n  \"disk_usage\": 10000,\n  \"collaborators\": 8,\n  \"billing_email\": \"mona@github.com\",\n  \"plan\": {\n    \"name\": \"Medium\",\n    \"space\": 400,\n    \"private_repos\": 20\n  },\n  \"default_repository_permission\": \"read\",\n  \"members_can_create_repositories\": true,\n  \"two_factor_requirement_enabled\": true,\n  \"members_allowed_repository_creation_type\": \"all\",\n  \"members_can_create_public_repositories\": false,\n  \"members_can_create_private_repositories\": false,\n  \"members_can_create_internal_repositories\": false,\n  \"members_can_create_pages\": true\n}\n
    " - }, - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response with GitHub plan information", - "payload": "
    {\n  \"login\": \"github\",\n  \"id\": 1,\n  \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n  \"url\": \"https://api.github.com/orgs/github\",\n  \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n  \"events_url\": \"https://api.github.com/orgs/github/events\",\n  \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n  \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n  \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n  \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n  \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n  \"description\": \"A great organization\",\n  \"name\": \"github\",\n  \"company\": \"GitHub\",\n  \"blog\": \"https://github.com/blog\",\n  \"location\": \"San Francisco\",\n  \"email\": \"octocat@github.com\",\n  \"twitter_username\": \"github\",\n  \"is_verified\": true,\n  \"has_organization_projects\": true,\n  \"has_repository_projects\": true,\n  \"public_repos\": 2,\n  \"public_gists\": 1,\n  \"followers\": 20,\n  \"following\": 0,\n  \"html_url\": \"https://github.com/octocat\",\n  \"created_at\": \"2008-01-14T04:33:35Z\",\n  \"updated_at\": \"2014-03-03T18:58:10Z\",\n  \"type\": \"Organization\",\n  \"plan\": {\n    \"name\": \"team\",\n    \"space\": 976562499,\n    \"private_repos\": 999999,\n    \"filled_seats\": 4,\n    \"seats\": 5\n  }\n}\n
    " + "payload": "
    {\n  \"login\": \"github\",\n  \"id\": 1,\n  \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n  \"url\": \"https://api.github.com/orgs/github\",\n  \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n  \"events_url\": \"https://api.github.com/orgs/github/events\",\n  \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n  \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n  \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n  \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n  \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n  \"description\": \"A great organization\",\n  \"name\": \"github\",\n  \"company\": \"GitHub\",\n  \"blog\": \"https://github.com/blog\",\n  \"location\": \"San Francisco\",\n  \"email\": \"octocat@github.com\",\n  \"twitter_username\": \"github\",\n  \"is_verified\": true,\n  \"has_organization_projects\": true,\n  \"has_repository_projects\": true,\n  \"public_repos\": 2,\n  \"public_gists\": 1,\n  \"followers\": 20,\n  \"following\": 0,\n  \"html_url\": \"https://github.com/octocat\",\n  \"created_at\": \"2008-01-14T04:33:35Z\",\n  \"updated_at\": \"2014-03-03T18:58:10Z\",\n  \"type\": \"Organization\",\n  \"total_private_repos\": 100,\n  \"owned_private_repos\": 100,\n  \"private_gists\": 81,\n  \"disk_usage\": 10000,\n  \"collaborators\": 8,\n  \"billing_email\": \"mona@github.com\",\n  \"plan\": {\n    \"name\": \"Medium\",\n    \"space\": 400,\n    \"private_repos\": 20,\n    \"filled_seats\": 4,\n    \"seats\": 5\n  },\n  \"default_repository_permission\": \"read\",\n  \"members_can_create_repositories\": true,\n  \"two_factor_requirement_enabled\": true,\n  \"members_allowed_repository_creation_type\": \"all\",\n  \"members_can_create_public_repositories\": false,\n  \"members_can_create_private_repositories\": false,\n  \"members_can_create_internal_repositories\": false,\n  \"members_can_create_pages\": true\n}\n
    " }, { "httpStatusCode": "404", @@ -12161,7 +12290,7 @@ { "verb": "patch", "requestPath": "/orgs/{org}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -12176,8 +12305,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG \\\n -d '{\"billing_email\":\"billing_email\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG \\\n  -d '{\"billing_email\":\"billing_email\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG \\\n -d '{\"billing_email\":\"billing_email\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG \\\n  -d '{\"billing_email\":\"billing_email\"}'
    " }, { "lang": "JavaScript", @@ -12580,7 +12709,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/events", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -12615,8 +12744,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/events", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/events
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/events", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/events
    " }, { "lang": "JavaScript", @@ -12660,7 +12789,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/hooks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -12695,8 +12824,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/hooks", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/hooks
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/hooks", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/hooks
    " }, { "lang": "JavaScript", @@ -12746,7 +12875,7 @@ { "verb": "post", "requestPath": "/orgs/{org}/hooks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -12761,8 +12890,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/hooks \\\n -d '{\"name\":\"name\",\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"username\":\"username\",\"password\":\"password\"}}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/hooks \\\n  -d '{\"name\":\"name\",\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"username\":\"username\",\"password\":\"password\"}}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/hooks \\\n -d '{\"name\":\"name\",\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"username\":\"username\",\"password\":\"password\"}}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/hooks \\\n  -d '{\"name\":\"name\",\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"username\":\"username\",\"password\":\"password\"}}'
    " }, { "lang": "JavaScript", @@ -13193,7 +13322,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/hooks/{hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -13217,8 +13346,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/hooks/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/hooks/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/hooks/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/hooks/42
    " }, { "lang": "JavaScript", @@ -13268,7 +13397,7 @@ { "verb": "patch", "requestPath": "/orgs/{org}/hooks/{hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -13292,8 +13421,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/hooks/42 \\\n -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/hooks/42 \\\n  -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/hooks/42 \\\n -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/hooks/42 \\\n  -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'
    " }, { "lang": "JavaScript", @@ -13642,7 +13771,7 @@ { "verb": "delete", "requestPath": "/orgs/{org}/hooks/{hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -13666,8 +13795,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/hooks/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/hooks/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/hooks/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/hooks/42
    " }, { "lang": "JavaScript", @@ -13702,7 +13831,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -13716,7 +13845,7 @@ { "verb": "post", "requestPath": "/orgs/{org}/hooks/{hook_id}/pings", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -13740,8 +13869,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/hooks/42/pings", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/hooks/42/pings
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/hooks/42/pings", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/hooks/42/pings
    " }, { "lang": "JavaScript", @@ -13776,7 +13905,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -13790,7 +13919,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/installation", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -13816,8 +13945,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/orgs/ORG/installation", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  https://api.github.com/orgs/ORG/installation
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/installation", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/installation
    " }, { "lang": "JavaScript", @@ -13866,7 +13995,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/installations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -13912,8 +14041,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/orgs/ORG/installations", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  https://api.github.com/orgs/ORG/installations
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/installations", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/installations
    " }, { "lang": "JavaScript", @@ -13962,7 +14091,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/issues", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -13985,6 +14114,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -14082,8 +14212,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/issues", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/issues
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/issues", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/issues
    " }, { "lang": "JavaScript", @@ -14137,7 +14267,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/members", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -14203,8 +14333,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/members", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/members
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/members", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/members
    " }, { "lang": "JavaScript", @@ -14259,7 +14389,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/members/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -14283,8 +14413,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/members/USERNAME", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/members/USERNAME
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/members/USERNAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/members/USERNAME
    " }, { "lang": "JavaScript", @@ -14338,7 +14468,7 @@ { "verb": "delete", "requestPath": "/orgs/{org}/members/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -14362,8 +14492,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/members/USERNAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/members/USERNAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/members/USERNAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/members/USERNAME
    " }, { "lang": "JavaScript", @@ -14398,7 +14528,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -14412,7 +14542,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/memberships/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -14436,8 +14566,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/memberships/USERNAME", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/memberships/USERNAME
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/memberships/USERNAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/memberships/USERNAME
    " }, { "lang": "JavaScript", @@ -14446,7 +14576,7 @@ } ], "summary": "Get organization membership for a user", - "description": "In order to get a user's membership with an organization, the authenticated user must be an organization member.", + "description": "In order to get a user's membership with an organization, the authenticated user must be an organization member. The `state` parameter in the response can be used to identify the user's membership status.", "tags": [ "orgs" ], @@ -14469,7 +14599,7 @@ "subcategoryLabel": "Members", "notes": [], "bodyParameters": [], - "descriptionHTML": "

    In order to get a user's membership with an organization, the authenticated user must be an organization member.

    ", + "descriptionHTML": "

    In order to get a user's membership with an organization, the authenticated user must be an organization member. The state parameter in the response can be used to identify the user's membership status.

    ", "responses": [ { "httpStatusCode": "200", @@ -14477,18 +14607,6 @@ "description": "Response if user has an active admin membership with organization", "payload": "
    {\n  \"url\": \"https://api.github.com/orgs/octocat/memberships/defunkt\",\n  \"state\": \"active\",\n  \"role\": \"admin\",\n  \"organization_url\": \"https://api.github.com/orgs/octocat\",\n  \"organization\": {\n    \"login\": \"github\",\n    \"id\": 1,\n    \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n    \"url\": \"https://api.github.com/orgs/github\",\n    \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n    \"events_url\": \"https://api.github.com/orgs/github/events\",\n    \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n    \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n    \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n    \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"description\": \"A great organization\"\n  },\n  \"user\": {\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
    " }, - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response if user has an active membership with organization", - "payload": "
    {\n  \"url\": \"https://api.github.com/orgs/octocat/memberships/defunkt\",\n  \"state\": \"active\",\n  \"role\": \"member\",\n  \"organization_url\": \"https://api.github.com/orgs/octocat\",\n  \"organization\": {\n    \"login\": \"github\",\n    \"id\": 1,\n    \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n    \"url\": \"https://api.github.com/orgs/github\",\n    \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n    \"events_url\": \"https://api.github.com/orgs/github/events\",\n    \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n    \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n    \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n    \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"description\": \"A great organization\"\n  },\n  \"user\": {\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
    " - }, - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response if user has a pending membership with organization", - "payload": "
    {\n  \"url\": \"https://api.github.com/orgs/invitocat/memberships/defunkt\",\n  \"state\": \"pending\",\n  \"role\": \"member\",\n  \"organization_url\": \"https://api.github.com/orgs/invitocat\",\n  \"organization\": {\n    \"login\": \"github\",\n    \"id\": 1,\n    \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n    \"url\": \"https://api.github.com/orgs/github\",\n    \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n    \"events_url\": \"https://api.github.com/orgs/github/events\",\n    \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n    \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n    \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n    \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"description\": \"A great organization\"\n  },\n  \"user\": {\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
    " - }, { "httpStatusCode": "403", "httpStatusMessage": "Forbidden", @@ -14504,7 +14622,7 @@ { "verb": "put", "requestPath": "/orgs/{org}/memberships/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -14528,8 +14646,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/memberships/USERNAME \\\n -d '{\"role\":\"role\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/memberships/USERNAME \\\n  -d '{\"role\":\"role\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/memberships/USERNAME \\\n -d '{\"role\":\"role\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/memberships/USERNAME \\\n  -d '{\"role\":\"role\"}'
    " }, { "lang": "JavaScript", @@ -14606,13 +14724,7 @@ { "httpStatusCode": "200", "httpStatusMessage": "OK", - "description": "Response if user was previously unaffiliated with organization", - "payload": "
    {\n  \"url\": \"https://api.github.com/orgs/invitocat/memberships/defunkt\",\n  \"state\": \"pending\",\n  \"role\": \"admin\",\n  \"organization_url\": \"https://api.github.com/orgs/invitocat\",\n  \"organization\": {\n    \"login\": \"github\",\n    \"id\": 1,\n    \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n    \"url\": \"https://api.github.com/orgs/github\",\n    \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n    \"events_url\": \"https://api.github.com/orgs/github/events\",\n    \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n    \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n    \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n    \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"description\": \"A great organization\"\n  },\n  \"user\": {\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
    " - }, - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response if user already had membership with organization", + "description": "Response if user has an active admin membership with organization", "payload": "
    {\n  \"url\": \"https://api.github.com/orgs/octocat/memberships/defunkt\",\n  \"state\": \"active\",\n  \"role\": \"admin\",\n  \"organization_url\": \"https://api.github.com/orgs/octocat\",\n  \"organization\": {\n    \"login\": \"github\",\n    \"id\": 1,\n    \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n    \"url\": \"https://api.github.com/orgs/github\",\n    \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n    \"events_url\": \"https://api.github.com/orgs/github/events\",\n    \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n    \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n    \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n    \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"description\": \"A great organization\"\n  },\n  \"user\": {\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
    " }, { @@ -14630,7 +14742,7 @@ { "verb": "delete", "requestPath": "/orgs/{org}/memberships/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -14654,8 +14766,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/memberships/USERNAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/memberships/USERNAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/memberships/USERNAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/memberships/USERNAME
    " }, { "lang": "JavaScript", @@ -14690,7 +14802,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -14709,7 +14821,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/outside_collaborators", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -14759,8 +14871,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/outside_collaborators", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/outside_collaborators
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/outside_collaborators", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/outside_collaborators
    " }, { "lang": "JavaScript", @@ -14805,7 +14917,7 @@ { "verb": "put", "requestPath": "/orgs/{org}/outside_collaborators/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -14829,8 +14941,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/outside_collaborators/USERNAME", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/outside_collaborators/USERNAME
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/outside_collaborators/USERNAME", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/outside_collaborators/USERNAME
    " }, { "lang": "JavaScript", @@ -14861,8 +14973,6 @@ "subcategory": "outside-collaborators", "subcategoryLabel": "Outside collaborators", "notes": [], - "bodyParameters": [], - "descriptionHTML": "

    When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"Converting an organization member to an outside collaborator\".

    ", "responses": [ { "httpStatusCode": "202", @@ -14877,26 +14987,21 @@ { "httpStatusCode": "403", "httpStatusMessage": "Forbidden", - "description": "Response if user is the last owner of the organization", - "payload": "
    {\n  \"message\": \"Cannot convert the last owner to an outside collaborator\",\n  \"documentation_url\": \"https://docs.github.com/enterprise-server@2.20/rest/reference/orgs#convert-member-to-outside-collaborator\"\n}\n
    " - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Response if user is not a member of the organization", - "payload": "
    {\n  \"message\": \"<user> is not a member of the <organization> organization.\",\n  \"documentation_url\": \"https://docs.github.com/enterprise-server@2.20/rest/reference/orgs#convert-member-to-outside-collaborator\"\n}\n
    " + "description": "Response if user is the last owner of the organization or not a member of the organization" }, { "httpStatusCode": "404", "httpStatusMessage": "Not Found", "description": "Resource not found" } - ] + ], + "bodyParameters": [], + "descriptionHTML": "

    When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"Converting an organization member to an outside collaborator\".

    " }, { "verb": "delete", "requestPath": "/orgs/{org}/outside_collaborators/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -14920,8 +15025,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/outside_collaborators/USERNAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/outside_collaborators/USERNAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/outside_collaborators/USERNAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/outside_collaborators/USERNAME
    " }, { "lang": "JavaScript", @@ -14958,7 +15063,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "422", @@ -14971,7 +15076,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/pre-receive-hooks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -15001,13 +15106,44 @@ "default": 1 }, "descriptionHTML": "

    Page number of the results to fetch.

    " + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + }, + "descriptionHTML": "

    One of asc (ascending) or desc (descending).

    " + }, + { + "name": "sort", + "description": "The sort order for the response collection.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + }, + "descriptionHTML": "

    The sort order for the response collection.

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/orgs/ORG/pre-receive-hooks", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/orgs/ORG/pre-receive-hooks
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/pre-receive-hooks", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/pre-receive-hooks
    " }, { "lang": "JavaScript", @@ -15059,7 +15195,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -15083,8 +15219,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/orgs/ORG/pre-receive-hooks/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/orgs/ORG/pre-receive-hooks/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/pre-receive-hooks/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/pre-receive-hooks/42
    " }, { "lang": "JavaScript", @@ -15136,7 +15272,7 @@ { "verb": "patch", "requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -15160,8 +15296,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/orgs/ORG/pre-receive-hooks/42 \\\n -d '{\"enforcement\":\"enforcement\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/orgs/ORG/pre-receive-hooks/42 \\\n  -d '{\"enforcement\":\"enforcement\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/pre-receive-hooks/42 \\\n -d '{\"enforcement\":\"enforcement\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/pre-receive-hooks/42 \\\n  -d '{\"enforcement\":\"enforcement\"}'
    " }, { "lang": "JavaScript", @@ -15265,7 +15401,7 @@ { "verb": "delete", "requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -15289,8 +15425,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/orgs/ORG/pre-receive-hooks/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/orgs/ORG/pre-receive-hooks/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/pre-receive-hooks/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/pre-receive-hooks/42
    " }, { "lang": "JavaScript", @@ -15342,7 +15478,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/projects", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -15393,8 +15529,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/orgs/ORG/projects", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/orgs/ORG/projects
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/projects", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/projects
    " }, { "lang": "JavaScript", @@ -15449,7 +15585,7 @@ { "verb": "post", "requestPath": "/orgs/{org}/projects", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -15464,8 +15600,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/orgs/ORG/projects \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/orgs/ORG/projects \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/projects \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/projects \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -15595,7 +15731,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/public_members", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -15630,8 +15766,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/public_members", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/public_members
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/public_members", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/public_members
    " }, { "lang": "JavaScript", @@ -15676,7 +15812,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/public_members/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -15700,8 +15836,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/public_members/USERNAME", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/public_members/USERNAME
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/public_members/USERNAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/public_members/USERNAME
    " }, { "lang": "JavaScript", @@ -15750,7 +15886,7 @@ { "verb": "put", "requestPath": "/orgs/{org}/public_members/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -15774,8 +15910,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/public_members/USERNAME", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/public_members/USERNAME
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/public_members/USERNAME", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/public_members/USERNAME
    " }, { "lang": "JavaScript", @@ -15810,7 +15946,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -15824,7 +15960,7 @@ { "verb": "delete", "requestPath": "/orgs/{org}/public_members/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -15848,8 +15984,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/public_members/USERNAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/public_members/USERNAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/public_members/USERNAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/public_members/USERNAME
    " }, { "lang": "JavaScript", @@ -15884,7 +16020,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -15893,7 +16029,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/repos", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -15906,7 +16042,7 @@ }, { "name": "type", - "description": "Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`.", + "description": "Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Note: For GitHub AE, can be one of `all`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`.", "in": "query", "required": false, "schema": { @@ -15921,7 +16057,7 @@ "internal" ] }, - "descriptionHTML": "

    Specifies the types of repositories you want returned. Can be one of all, public, private, forks, sources, member, internal. Default: all. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, type can also be internal.

    " + "descriptionHTML": "

    Specifies the types of repositories you want returned. Can be one of all, public, private, forks, sources, member, internal. Note: For GitHub AE, can be one of all, private, forks, sources, member, internal. Default: all. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, type can also be internal.

    " }, { "name": "sort", @@ -15978,8 +16114,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/repos", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/repos
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/repos", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/repos
    " }, { "lang": "JavaScript", @@ -16035,7 +16171,7 @@ { "verb": "post", "requestPath": "/orgs/{org}/repos", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -16050,8 +16186,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/repos \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/repos \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/repos \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/repos \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -16060,7 +16196,7 @@ } ], "summary": "Create an organization repository", - "description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.20/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", + "description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.20/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository", "tags": [ "repos" ], @@ -16104,17 +16240,17 @@ }, "private": { "type": "boolean", - "description": "

    Either true to create a private repository or false to create a public one.

    ", + "description": "

    Whether the repository is private.

    ", "default": false, "name": "private", "in": "body", "rawType": "boolean", - "rawDescription": "Either `true` to create a private repository or `false` to create a public one.", + "rawDescription": "Whether the repository is private.", "childParamsGroups": [] }, "visibility": { "type": "string", - "description": "

    Can be public or private. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be internal. For more information, see \"Creating an internal repository\" in the GitHub Help documentation.
    \nThe visibility parameter overrides the private parameter when you use both parameters with the nebula-preview preview header.

    ", + "description": "

    Can be public or private. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be internal. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"Creating an internal repository\" in the GitHub Help documentation.
    \nThe visibility parameter overrides the private parameter when you use both parameters with the nebula-preview preview header.

    ", "enum": [ "public", "private", @@ -16124,7 +16260,7 @@ "name": "visibility", "in": "body", "rawType": "string", - "rawDescription": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", + "rawDescription": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", "childParamsGroups": [] }, "has_issues": { @@ -16285,7 +16421,7 @@ "category": "repos", "categoryLabel": "Repos", "notes": [], - "descriptionHTML": "

    Creates a new repository in the specified organization. The authenticated user must be a member of the organization.

    \n

    OAuth scope requirements

    \n

    When using OAuth, authorizations must include:

    \n
      \n
    • public_repo scope or repo scope to create a public repository
    • \n
    • repo scope to create a private repository
    • \n
    ", + "descriptionHTML": "

    Creates a new repository in the specified organization. The authenticated user must be a member of the organization.

    \n

    OAuth scope requirements

    \n

    When using OAuth, authorizations must include:

    \n
      \n
    • public_repo scope or repo scope to create a public repository. Note: For GitHub AE, use repo scope to create an internal repository.
    • \n
    • repo scope to create a private repository
    • \n
    ", "bodyParameters": [ { "type": "string", @@ -16316,17 +16452,17 @@ }, { "type": "boolean", - "description": "

    Either true to create a private repository or false to create a public one.

    ", + "description": "

    Whether the repository is private.

    ", "default": false, "name": "private", "in": "body", "rawType": "boolean", - "rawDescription": "Either `true` to create a private repository or `false` to create a public one.", + "rawDescription": "Whether the repository is private.", "childParamsGroups": [] }, { "type": "string", - "description": "

    Can be public or private. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be internal. For more information, see \"Creating an internal repository\" in the GitHub Help documentation.
    \nThe visibility parameter overrides the private parameter when you use both parameters with the nebula-preview preview header.

    ", + "description": "

    Can be public or private. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be internal. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"Creating an internal repository\" in the GitHub Help documentation.
    \nThe visibility parameter overrides the private parameter when you use both parameters with the nebula-preview preview header.

    ", "enum": [ "public", "private", @@ -16336,7 +16472,7 @@ "name": "visibility", "in": "body", "rawType": "string", - "rawDescription": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", + "rawDescription": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", "childParamsGroups": [] }, { @@ -16479,7 +16615,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/teams", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -16514,8 +16650,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams
    " }, { "lang": "JavaScript", @@ -16563,7 +16699,7 @@ { "verb": "post", "requestPath": "/orgs/{org}/teams", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -16578,8 +16714,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -16811,7 +16947,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -16836,8 +16972,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG
    " }, { "lang": "JavaScript", @@ -16885,7 +17021,7 @@ { "verb": "get", "requestPath": "/projects/columns/cards/{card_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "card_id", @@ -16901,8 +17037,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/cards/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/cards/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/columns/cards/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/columns/cards/42
    " }, { "lang": "JavaScript", @@ -16974,7 +17110,7 @@ { "verb": "patch", "requestPath": "/projects/columns/cards/{card_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "card_id", @@ -16990,8 +17126,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/cards/42 \\\n -d '{\"note\":\"note\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/cards/42 \\\n  -d '{\"note\":\"note\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/columns/cards/42 \\\n -d '{\"note\":\"note\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/columns/cards/42 \\\n  -d '{\"note\":\"note\"}'
    " }, { "lang": "JavaScript", @@ -17122,7 +17258,7 @@ { "verb": "delete", "requestPath": "/projects/columns/cards/{card_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "card_id", @@ -17138,8 +17274,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/cards/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/cards/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/columns/cards/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/columns/cards/42
    " }, { "lang": "JavaScript", @@ -17181,7 +17317,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -17210,7 +17346,7 @@ { "verb": "post", "requestPath": "/projects/columns/cards/{card_id}/moves", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "card_id", @@ -17226,8 +17362,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/cards/42/moves \\\n -d '{\"position\":\"position\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/cards/42/moves \\\n  -d '{\"position\":\"position\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/columns/cards/42/moves \\\n -d '{\"position\":\"position\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/columns/cards/42/moves \\\n  -d '{\"position\":\"position\"}'
    " }, { "lang": "JavaScript", @@ -17360,7 +17496,7 @@ { "verb": "get", "requestPath": "/projects/columns/{column_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "column_id", @@ -17376,8 +17512,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/columns/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/columns/42
    " }, { "lang": "JavaScript", @@ -17449,7 +17585,7 @@ { "verb": "patch", "requestPath": "/projects/columns/{column_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "column_id", @@ -17465,8 +17601,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/42 \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/42 \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/columns/42 \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/columns/42 \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -17568,7 +17704,7 @@ { "verb": "delete", "requestPath": "/projects/columns/{column_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "column_id", @@ -17584,8 +17720,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/columns/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/columns/42
    " }, { "lang": "JavaScript", @@ -17627,7 +17763,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -17651,7 +17787,7 @@ { "verb": "get", "requestPath": "/projects/columns/{column_id}/cards", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "column_id", @@ -17703,8 +17839,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/42/cards", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/42/cards
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/columns/42/cards", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/columns/42/cards
    " }, { "lang": "JavaScript", @@ -17771,7 +17907,7 @@ { "verb": "post", "requestPath": "/projects/columns/{column_id}/cards", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "column_id", @@ -17787,8 +17923,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/42/cards \\\n -d '{\"note\":\"note\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/42/cards \\\n  -d '{\"note\":\"note\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/columns/42/cards \\\n -d '{\"note\":\"note\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/columns/42/cards \\\n  -d '{\"note\":\"note\"}'
    " }, { "lang": "JavaScript", @@ -17908,7 +18044,7 @@ { "verb": "post", "requestPath": "/projects/columns/{column_id}/moves", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "column_id", @@ -17924,8 +18060,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/42/moves \\\n -d '{\"position\":\"position\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/42/moves \\\n  -d '{\"position\":\"position\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/columns/42/moves \\\n -d '{\"position\":\"position\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/columns/42/moves \\\n  -d '{\"position\":\"position\"}'
    " }, { "lang": "JavaScript", @@ -18033,7 +18169,7 @@ { "verb": "get", "requestPath": "/projects/{project_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "project_id", @@ -18048,8 +18184,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/42
    " }, { "lang": "JavaScript", @@ -18114,7 +18250,7 @@ { "verb": "patch", "requestPath": "/projects/{project_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "project_id", @@ -18129,8 +18265,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42 \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/42 \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/42 \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/42 \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -18332,7 +18468,7 @@ { "verb": "delete", "requestPath": "/projects/{project_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "project_id", @@ -18347,8 +18483,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/42
    " }, { "lang": "JavaScript", @@ -18422,7 +18558,7 @@ { "verb": "get", "requestPath": "/projects/{project_id}/collaborators", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "project_id", @@ -18473,8 +18609,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42/collaborators", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/42/collaborators
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/42/collaborators", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/42/collaborators
    " }, { "lang": "JavaScript", @@ -18556,7 +18692,7 @@ { "verb": "put", "requestPath": "/projects/{project_id}/collaborators/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "project_id", @@ -18580,8 +18716,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42/collaborators/USERNAME \\\n -d '{\"permission\":\"permission\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/42/collaborators/USERNAME \\\n  -d '{\"permission\":\"permission\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/42/collaborators/USERNAME \\\n -d '{\"permission\":\"permission\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/42/collaborators/USERNAME \\\n  -d '{\"permission\":\"permission\"}'
    " }, { "lang": "JavaScript", @@ -18650,7 +18786,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -18706,7 +18842,7 @@ { "verb": "delete", "requestPath": "/projects/{project_id}/collaborators/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "project_id", @@ -18730,8 +18866,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42/collaborators/USERNAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/42/collaborators/USERNAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/42/collaborators/USERNAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/42/collaborators/USERNAME
    " }, { "lang": "JavaScript", @@ -18773,7 +18909,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -18812,7 +18948,7 @@ { "verb": "get", "requestPath": "/projects/{project_id}/collaborators/{username}/permission", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "project_id", @@ -18836,8 +18972,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42/collaborators/USERNAME/permission", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/42/collaborators/USERNAME/permission
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/42/collaborators/USERNAME/permission", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/42/collaborators/USERNAME/permission
    " }, { "lang": "JavaScript", @@ -18919,7 +19055,7 @@ { "verb": "get", "requestPath": "/projects/{project_id}/columns", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "project_id", @@ -18954,8 +19090,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42/columns", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/42/columns
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/42/columns", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/42/columns
    " }, { "lang": "JavaScript", @@ -19022,7 +19158,7 @@ { "verb": "post", "requestPath": "/projects/{project_id}/columns", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "project_id", @@ -19037,8 +19173,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42/columns \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/42/columns \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/42/columns \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/42/columns \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -19145,13 +19281,13 @@ { "verb": "get", "requestPath": "/rate_limit", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/rate_limit", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/rate_limit
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/rate_limit", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/rate_limit
    " }, { "lang": "JavaScript", @@ -19204,7 +19340,7 @@ { "verb": "delete", "requestPath": "/reactions/{reaction_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -19230,8 +19366,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/reactions/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/reactions/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/reactions/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/reactions/42
    " }, { "lang": "JavaScript", @@ -19269,7 +19405,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -19278,7 +19414,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -19302,8 +19438,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world
    " }, { "lang": "JavaScript", @@ -19380,7 +19516,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -19404,8 +19540,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -19799,7 +19935,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -19823,8 +19959,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world
    " }, { "lang": "JavaScript", @@ -19859,7 +19995,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -19877,7 +20013,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/assignees", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -19921,8 +20057,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/assignees", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/assignees
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/assignees", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/assignees
    " }, { "lang": "JavaScript", @@ -19972,7 +20108,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/assignees/{assignee}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -20005,8 +20141,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/assignees/ASSIGNEE", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/assignees/ASSIGNEE
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/assignees/ASSIGNEE", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/assignees/ASSIGNEE
    " }, { "lang": "JavaScript", @@ -20055,7 +20191,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -20109,8 +20245,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches
    " }, { "lang": "JavaScript", @@ -20148,12 +20284,6 @@ "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "
    [\n  {\n    \"name\": \"master\",\n    \"commit\": {\n      \"sha\": \"c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc\",\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc\"\n    },\n    \"protected\": true\n  }\n]\n
    " - }, - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "With protection", "payload": "
    [\n  {\n    \"name\": \"master\",\n    \"commit\": {\n      \"sha\": \"c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc\",\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc\"\n    },\n    \"protected\": true,\n    \"protection\": {\n      \"enabled\": true,\n      \"required_status_checks\": {\n        \"enforcement_level\": \"non_admins\",\n        \"contexts\": [\n          \"ci-test\",\n          \"linter\"\n        ]\n      }\n    },\n    \"protection_url\": \"https://api.github.com/repos/octocat/hello-world/branches/master/protection\"\n  }\n]\n
    " }, { @@ -20166,7 +20296,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -20201,8 +20331,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH
    " }, { "lang": "JavaScript", @@ -20257,7 +20387,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -20292,8 +20422,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection
    " }, { "lang": "JavaScript", @@ -20350,7 +20480,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -20385,8 +20515,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection \\\n -d '{\"required_status_checks\":{\"strict\":true,\"contexts\":[\"contexts\"]},\"enforce_admins\":true,\"required_pull_request_reviews\":{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":42},\"restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"],\"apps\":[\"apps\"]}}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection \\\n  -d '{\"required_status_checks\":{\"strict\":true,\"contexts\":[\"contexts\"]},\"enforce_admins\":true,\"required_pull_request_reviews\":{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":42},\"restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"],\"apps\":[\"apps\"]}}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection \\\n -d '{\"required_status_checks\":{\"strict\":true,\"contexts\":[\"contexts\"]},\"enforce_admins\":true,\"required_pull_request_reviews\":{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":42},\"restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"],\"apps\":[\"apps\"]}}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection \\\n  -d '{\"required_status_checks\":{\"strict\":true,\"contexts\":[\"contexts\"]},\"enforce_admins\":true,\"required_pull_request_reviews\":{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":42},\"restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"],\"apps\":[\"apps\"]}}'
    " }, { "lang": "JavaScript", @@ -21389,7 +21519,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -21424,8 +21554,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection
    " }, { "lang": "JavaScript", @@ -21460,7 +21590,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -21474,7 +21604,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -21509,8 +21639,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins
    " }, { "lang": "JavaScript", @@ -21555,7 +21685,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -21590,8 +21720,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins
    " }, { "lang": "JavaScript", @@ -21636,7 +21766,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -21671,8 +21801,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins
    " }, { "lang": "JavaScript", @@ -21721,7 +21851,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -21756,8 +21886,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews
    " }, { "lang": "JavaScript", @@ -21808,7 +21938,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -21843,8 +21973,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews \\\n -d '{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]}}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews \\\n  -d '{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]}}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews \\\n -d '{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]}}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews \\\n  -d '{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]}}'
    " }, { "lang": "JavaScript", @@ -22114,7 +22244,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -22149,8 +22279,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews
    " }, { "lang": "JavaScript", @@ -22199,7 +22329,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -22234,8 +22364,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures
    " }, { "lang": "JavaScript", @@ -22292,7 +22422,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -22327,8 +22457,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures
    " }, { "lang": "JavaScript", @@ -22385,7 +22515,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -22420,8 +22550,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures
    " }, { "lang": "JavaScript", @@ -22477,7 +22607,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -22512,8 +22642,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks
    " }, { "lang": "JavaScript", @@ -22563,7 +22693,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -22598,8 +22728,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks \\\n -d '{\"strict\":true}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks \\\n  -d '{\"strict\":true}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks \\\n -d '{\"strict\":true}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks \\\n  -d '{\"strict\":true}'
    " }, { "lang": "JavaScript", @@ -22714,7 +22844,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -22749,8 +22879,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks
    " }, { "lang": "JavaScript", @@ -22794,7 +22924,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -22829,8 +22959,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts
    " }, { "lang": "JavaScript", @@ -22880,7 +23010,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -22915,8 +23045,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n  -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n  -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'
    " }, { "lang": "JavaScript", @@ -23021,7 +23151,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -23056,8 +23186,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n  -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n  -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'
    " }, { "lang": "JavaScript", @@ -23157,7 +23287,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -23192,8 +23322,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n  -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n  -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'
    " }, { "lang": "JavaScript", @@ -23293,7 +23423,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -23328,8 +23458,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions
    " }, { "lang": "JavaScript", @@ -23379,7 +23509,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -23414,8 +23544,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions
    " }, { "lang": "JavaScript", @@ -23459,7 +23589,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -23494,8 +23624,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps
    " }, { "lang": "JavaScript", @@ -23545,7 +23675,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -23580,8 +23710,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps \\\n -d '{\"apps\":{\"apps\":[\"apps\"]}}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps \\\n  -d '{\"apps\":{\"apps\":[\"apps\"]}}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps \\\n -d '{\"apps\":{\"apps\":[\"apps\"]}}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps \\\n  -d '{\"apps\":{\"apps\":[\"apps\"]}}'
    " }, { "lang": "JavaScript", @@ -23676,7 +23806,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -23711,8 +23841,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps \\\n -d '{\"apps\":{\"apps\":[\"apps\"]}}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps \\\n  -d '{\"apps\":{\"apps\":[\"apps\"]}}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps \\\n -d '{\"apps\":{\"apps\":[\"apps\"]}}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps \\\n  -d '{\"apps\":{\"apps\":[\"apps\"]}}'
    " }, { "lang": "JavaScript", @@ -23807,7 +23937,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -23842,8 +23972,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps \\\n -d '{\"apps\":{\"apps\":[\"apps\"]}}'", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps \\\n  -d '{\"apps\":{\"apps\":[\"apps\"]}}'
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps \\\n -d '{\"apps\":{\"apps\":[\"apps\"]}}'", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps \\\n  -d '{\"apps\":{\"apps\":[\"apps\"]}}'
    " }, { "lang": "JavaScript", @@ -23938,7 +24068,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -23973,8 +24103,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams
    " }, { "lang": "JavaScript", @@ -24024,7 +24154,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -24059,8 +24189,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n -d '{\"teams\":{\"teams\":[\"teams\"]}}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n  -d '{\"teams\":{\"teams\":[\"teams\"]}}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n -d '{\"teams\":{\"teams\":[\"teams\"]}}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n  -d '{\"teams\":{\"teams\":[\"teams\"]}}'
    " }, { "lang": "JavaScript", @@ -24155,7 +24285,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -24190,8 +24320,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n -d '{\"teams\":{\"teams\":[\"teams\"]}}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n  -d '{\"teams\":{\"teams\":[\"teams\"]}}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n -d '{\"teams\":{\"teams\":[\"teams\"]}}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n  -d '{\"teams\":{\"teams\":[\"teams\"]}}'
    " }, { "lang": "JavaScript", @@ -24286,7 +24416,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -24321,8 +24451,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n -d '{\"teams\":{\"teams\":[\"teams\"]}}'", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n  -d '{\"teams\":{\"teams\":[\"teams\"]}}'
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n -d '{\"teams\":{\"teams\":[\"teams\"]}}'", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n  -d '{\"teams\":{\"teams\":[\"teams\"]}}'
    " }, { "lang": "JavaScript", @@ -24417,7 +24547,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -24452,8 +24582,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users
    " }, { "lang": "JavaScript", @@ -24503,7 +24633,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -24538,8 +24668,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n -d '{\"users\":{\"users\":[\"users\"]}}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n  -d '{\"users\":{\"users\":[\"users\"]}}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n -d '{\"users\":{\"users\":[\"users\"]}}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n  -d '{\"users\":{\"users\":[\"users\"]}}'
    " }, { "lang": "JavaScript", @@ -24634,7 +24764,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -24669,8 +24799,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n -d '{\"users\":{\"users\":[\"users\"]}}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n  -d '{\"users\":{\"users\":[\"users\"]}}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n -d '{\"users\":{\"users\":[\"users\"]}}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n  -d '{\"users\":{\"users\":[\"users\"]}}'
    " }, { "lang": "JavaScript", @@ -24765,7 +24895,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -24800,8 +24930,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n -d '{\"users\":{\"users\":[\"users\"]}}'", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n  -d '{\"users\":{\"users\":[\"users\"]}}'
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n -d '{\"users\":{\"users\":[\"users\"]}}'", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n  -d '{\"users\":{\"users\":[\"users\"]}}'
    " }, { "lang": "JavaScript", @@ -24896,7 +25026,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/check-runs", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -24920,8 +25050,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-runs \\\n -d '{\"name\":\"name\",\"head_sha\":\"head_sha\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/check-runs \\\n  -d '{\"name\":\"name\",\"head_sha\":\"head_sha\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-runs \\\n -d '{\"name\":\"name\",\"head_sha\":\"head_sha\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-runs \\\n  -d '{\"name\":\"name\",\"head_sha\":\"head_sha\"}'
    " }, { "lang": "JavaScript", @@ -25898,7 +26028,7 @@ "name", "head_sha" ], - "anyOf": [ + "oneOf": [ { "properties": { "status": { @@ -25908,6 +26038,7 @@ } }, "required": [ + "status", "conclusion" ], "additionalProperties": true @@ -25927,7 +26058,7 @@ }, "examples": { "example-of-in-progress-conclusion": { - "summary": "Example of in_progress conclusion", + "summary": "Response for in_progress conclusion", "value": { "name": "mighty_readme", "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -25942,7 +26073,7 @@ } }, "example-of-completed-conclusion": { - "summary": "Example of completed conclusion", + "summary": "Response for completed conclusion", "value": { "name": "mighty_readme", "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -26016,12 +26147,6 @@ "notes": [], "descriptionHTML": "

    Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

    \n

    Creates a new check run for a specific commit in a repository. Your GitHub App must have the checks:write permission to create check runs.

    \n

    In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.

    ", "responses": [ - { - "httpStatusCode": "201", - "httpStatusMessage": "Created", - "description": "Response for in_progress conclusion", - "payload": "
    {\n  \"id\": 4,\n  \"head_sha\": \"ce587453ced02b1526dfb4cb910479d431683101\",\n  \"node_id\": \"MDg6Q2hlY2tSdW40\",\n  \"external_id\": \"42\",\n  \"url\": \"https://api.github.com/repos/github/hello-world/check-runs/4\",\n  \"html_url\": \"https://github.com/github/hello-world/runs/4\",\n  \"details_url\": \"https://example.com\",\n  \"status\": \"in_progress\",\n  \"conclusion\": \"neutral\",\n  \"started_at\": \"2018-05-04T01:14:52Z\",\n  \"completed_at\": null,\n  \"output\": {\n    \"title\": \"Mighty Readme Report\",\n    \"summary\": \"\",\n    \"text\": \"\",\n    \"annotations_count\": 1,\n    \"annotations_url\": \"https://api.github.com/repos/github/hello-world/check-runs/4/annotations\"\n  },\n  \"name\": \"mighty_readme\",\n  \"check_suite\": {\n    \"id\": 5\n  },\n  \"app\": {\n    \"id\": 1,\n    \"slug\": \"octoapp\",\n    \"node_id\": \"MDExOkludGVncmF0aW9uMQ==\",\n    \"owner\": {\n      \"login\": \"github\",\n      \"id\": 1,\n      \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n      \"url\": \"https://api.github.com/orgs/github\",\n      \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n      \"events_url\": \"https://api.github.com/orgs/github/events\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\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      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": true\n    },\n    \"name\": \"Octocat App\",\n    \"description\": \"\",\n    \"external_url\": \"https://example.com\",\n    \"html_url\": \"https://github.com/apps/octoapp\",\n    \"created_at\": \"2017-07-08T16:18:44-04:00\",\n    \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n    \"permissions\": {\n      \"metadata\": \"read\",\n      \"contents\": \"read\",\n      \"issues\": \"write\",\n      \"single_file\": \"write\"\n    },\n    \"events\": [\n      \"push\",\n      \"pull_request\"\n    ]\n  },\n  \"pull_requests\": [\n    {\n      \"url\": \"https://api.github.com/repos/github/hello-world/pulls/1\",\n      \"id\": 1934,\n      \"number\": 3956,\n      \"head\": {\n        \"ref\": \"say-hello\",\n        \"sha\": \"3dca65fa3e8d4b3da3f3d056c59aee1c50f41390\",\n        \"repo\": {\n          \"id\": 526,\n          \"url\": \"https://api.github.com/repos/github/hello-world\",\n          \"name\": \"hello-world\"\n        }\n      },\n      \"base\": {\n        \"ref\": \"master\",\n        \"sha\": \"e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f\",\n        \"repo\": {\n          \"id\": 526,\n          \"url\": \"https://api.github.com/repos/github/hello-world\",\n          \"name\": \"hello-world\"\n        }\n      }\n    }\n  ]\n}\n
    " - }, { "httpStatusCode": "201", "httpStatusMessage": "Created", @@ -26983,7 +27108,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/check-runs/{check_run_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -27017,8 +27142,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-runs/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/check-runs/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-runs/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-runs/42
    " }, { "lang": "JavaScript", @@ -27070,7 +27195,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/check-runs/{check_run_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -27104,8 +27229,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-runs/42 \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/check-runs/42 \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-runs/42 \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-runs/42 \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -29107,7 +29232,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/check-runs/{check_run_id}/annotations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -29161,8 +29286,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-runs/42/annotations", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/check-runs/42/annotations
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-runs/42/annotations", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-runs/42/annotations
    " }, { "lang": "JavaScript", @@ -29214,7 +29339,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/check-suites", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -29238,8 +29363,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-suites \\\n -d '{\"head_sha\":\"head_sha\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/check-suites \\\n  -d '{\"head_sha\":\"head_sha\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-suites \\\n -d '{\"head_sha\":\"head_sha\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-suites \\\n  -d '{\"head_sha\":\"head_sha\"}'
    " }, { "lang": "JavaScript", @@ -29327,7 +29452,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/check-suites/preferences", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -29351,8 +29476,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-suites/preferences \\\n -d '{\"auto_trigger_checks\":[{\"app_id\":42,\"setting\":true}]}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/check-suites/preferences \\\n  -d '{\"auto_trigger_checks\":[{\"app_id\":42,\"setting\":true}]}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-suites/preferences \\\n -d '{\"auto_trigger_checks\":[{\"app_id\":42,\"setting\":true}]}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-suites/preferences \\\n  -d '{\"auto_trigger_checks\":[{\"app_id\":42,\"setting\":true}]}'
    " }, { "lang": "JavaScript", @@ -29552,7 +29677,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/check-suites/{check_suite_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -29586,8 +29711,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-suites/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/check-suites/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-suites/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-suites/42
    " }, { "lang": "JavaScript", @@ -29639,7 +29764,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -29733,8 +29858,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-suites/42/check-runs", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/check-suites/42/check-runs
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-suites/42/check-runs", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-suites/42/check-runs
    " }, { "lang": "JavaScript", @@ -29786,7 +29911,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -29820,8 +29945,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-suites/42/rerequest", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/check-suites/42/rerequest
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-suites/42/rerequest", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-suites/42/rerequest
    " }, { "lang": "JavaScript", @@ -29872,7 +29997,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/collaborators", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -29932,8 +30057,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/collaborators", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/collaborators
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/collaborators", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/collaborators
    " }, { "lang": "JavaScript", @@ -29983,7 +30108,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -30016,8 +30141,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/collaborators/USERNAME", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/collaborators/USERNAME
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/collaborators/USERNAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/collaborators/USERNAME
    " }, { "lang": "JavaScript", @@ -30066,7 +30191,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -30099,8 +30224,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/collaborators/USERNAME \\\n -d '{\"permission\":\"permission\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/collaborators/USERNAME \\\n  -d '{\"permission\":\"permission\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/collaborators/USERNAME \\\n -d '{\"permission\":\"permission\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/collaborators/USERNAME \\\n  -d '{\"permission\":\"permission\"}'
    " }, { "lang": "JavaScript", @@ -30225,7 +30350,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -30258,8 +30383,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/collaborators/USERNAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/collaborators/USERNAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/collaborators/USERNAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/collaborators/USERNAME
    " }, { "lang": "JavaScript", @@ -30294,7 +30419,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -30303,7 +30428,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/collaborators/{username}/permission", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -30336,8 +30461,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/collaborators/USERNAME/permission", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/collaborators/USERNAME/permission
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/collaborators/USERNAME/permission", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/collaborators/USERNAME/permission
    " }, { "lang": "JavaScript", @@ -30387,7 +30512,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -30431,8 +30556,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/comments", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/comments
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/comments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/comments
    " }, { "lang": "JavaScript", @@ -30484,7 +30609,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -30518,8 +30643,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/comments/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/comments/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/comments/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/comments/42
    " }, { "lang": "JavaScript", @@ -30576,7 +30701,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -30610,8 +30735,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/comments/42 \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/comments/42 \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/comments/42 \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/comments/42 \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -30697,7 +30822,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -30731,8 +30856,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/comments/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/comments/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/comments/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/comments/42
    " }, { "lang": "JavaScript", @@ -30767,7 +30892,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -30781,7 +30906,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -30855,8 +30980,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/comments/42/reactions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/comments/42/reactions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/comments/42/reactions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/comments/42/reactions
    " }, { "lang": "JavaScript", @@ -30916,7 +31041,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -30950,8 +31075,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/comments/42/reactions \\\n -d '{\"content\":\"content\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/comments/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/comments/42/reactions \\\n -d '{\"content\":\"content\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/comments/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " }, { "lang": "JavaScript", @@ -31073,7 +31198,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/commits", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -31162,13 +31287,35 @@ "default": 1 }, "descriptionHTML": "

    Page number of the results to fetch.

    " + }, + { + "name": "top", + "description": "legacy parameter for pagination.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    legacy parameter for pagination.

    " + }, + { + "name": "last_sha", + "description": "legacy parameter for pagination.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    legacy parameter for pagination.

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/commits
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits
    " }, { "lang": "JavaScript", @@ -31233,7 +31380,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -31268,8 +31415,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.groot-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits/COMMIT_SHA/branches-where-head", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.groot-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/commits/COMMIT_SHA/branches-where-head
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.groot-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/COMMIT_SHA/branches-where-head", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.groot-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/COMMIT_SHA/branches-where-head
    " }, { "lang": "JavaScript", @@ -31331,7 +31478,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -31386,8 +31533,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits/COMMIT_SHA/comments", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/commits/COMMIT_SHA/comments
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/COMMIT_SHA/comments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/COMMIT_SHA/comments
    " }, { "lang": "JavaScript", @@ -31439,7 +31586,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -31474,8 +31621,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits/COMMIT_SHA/comments \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/commits/COMMIT_SHA/comments \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/COMMIT_SHA/comments \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/COMMIT_SHA/comments \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -31624,7 +31771,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/pulls", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -31679,8 +31826,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.groot-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits/COMMIT_SHA/pulls", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.groot-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/commits/COMMIT_SHA/pulls
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.groot-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/COMMIT_SHA/pulls", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.groot-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/COMMIT_SHA/pulls
    " }, { "lang": "JavaScript", @@ -31737,7 +31884,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/commits/{ref}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -31757,23 +31904,43 @@ }, "descriptionHTML": "" }, + { + "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.

    " + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "descriptionHTML": "

    Results per page (max 100).

    " + }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    ref+ parameter

    " + "descriptionHTML": "

    ref parameter

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits/REF", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/commits/REF
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/REF", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/REF
    " }, { "lang": "JavaScript", @@ -31833,7 +32000,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/commits/{ref}/check-runs", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -31855,14 +32022,14 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    ref+ parameter

    " + "descriptionHTML": "

    ref parameter

    " }, { "name": "check_name", @@ -31923,13 +32090,22 @@ "default": 1 }, "descriptionHTML": "

    Page number of the results to fetch.

    " + }, + { + "name": "app_id", + "in": "query", + "required": false, + "schema": { + "type": "integer" + }, + "descriptionHTML": "" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits/REF/check-runs", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/commits/REF/check-runs
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/REF/check-runs", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/REF/check-runs
    " }, { "lang": "JavaScript", @@ -31981,7 +32157,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/commits/{ref}/check-suites", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -32003,14 +32179,14 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    ref+ parameter

    " + "descriptionHTML": "

    ref parameter

    " }, { "name": "app_id", @@ -32057,8 +32233,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits/REF/check-suites", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/commits/REF/check-suites
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/REF/check-suites", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/REF/check-suites
    " }, { "lang": "JavaScript", @@ -32110,7 +32286,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/commits/{ref}/status", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -32132,21 +32308,41 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    ref+ parameter

    " + "descriptionHTML": "

    ref parameter

    " + }, + { + "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/repos/octocat/hello-world/commits/REF/status", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/commits/REF/status
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/REF/status", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/REF/status
    " }, { "lang": "JavaScript", @@ -32196,7 +32392,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/commits/{ref}/statuses", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -32218,14 +32414,14 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    ref+ parameter

    " + "descriptionHTML": "

    ref parameter

    " }, { "name": "per_page", @@ -32251,8 +32447,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits/REF/statuses", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/commits/REF/statuses
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/REF/statuses", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/REF/statuses
    " }, { "lang": "JavaScript", @@ -32302,7 +32498,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/compare/{base}...{head}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -32344,8 +32540,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/compare/BASE...HEAD", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/compare/BASE...HEAD
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/compare/BASE...HEAD", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/compare/BASE...HEAD
    " }, { "lang": "JavaScript", @@ -32400,7 +32596,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/contents/{path}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -32422,14 +32618,14 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    path+ parameter

    " + "descriptionHTML": "

    path parameter

    " }, { "name": "ref", @@ -32445,8 +32641,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/contents/PATH", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/contents/PATH
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/contents/PATH", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/contents/PATH
    " }, { "lang": "JavaScript", @@ -32524,7 +32720,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/contents/{path}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -32546,21 +32742,21 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    path+ parameter

    " + "descriptionHTML": "

    path parameter

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/contents/PATH \\\n -d '{\"message\":\"message\",\"content\":\"content\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/contents/PATH \\\n  -d '{\"message\":\"message\",\"content\":\"content\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/contents/PATH \\\n -d '{\"message\":\"message\",\"content\":\"content\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/contents/PATH \\\n  -d '{\"message\":\"message\",\"content\":\"content\"}'
    " }, { "lang": "JavaScript", @@ -33047,7 +33243,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/contents/{path}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -33069,21 +33265,21 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    path+ parameter

    " + "descriptionHTML": "

    path parameter

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/contents/PATH \\\n -d '{\"message\":\"message\",\"sha\":\"sha\"}'", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/contents/PATH \\\n  -d '{\"message\":\"message\",\"sha\":\"sha\"}'
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/contents/PATH \\\n -d '{\"message\":\"message\",\"sha\":\"sha\"}'", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/contents/PATH \\\n  -d '{\"message\":\"message\",\"sha\":\"sha\"}'
    " }, { "lang": "JavaScript", @@ -33446,7 +33642,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/contributors", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -33500,8 +33696,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/contributors", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/contributors
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/contributors", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/contributors
    " }, { "lang": "JavaScript", @@ -33559,7 +33755,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/deployments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -33619,7 +33815,8 @@ "required": false, "schema": { "type": "string", - "default": "none" + "default": "none", + "nullable": true }, "descriptionHTML": "

    The name of the environment that was deployed to (e.g., staging or production).

    " }, @@ -33647,8 +33844,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/deployments", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/deployments
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/deployments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/deployments
    " }, { "lang": "JavaScript", @@ -33700,7 +33897,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/deployments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -33724,8 +33921,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/deployments \\\n -d '{\"ref\":\"ref\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/deployments \\\n  -d '{\"ref\":\"ref\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/deployments \\\n -d '{\"ref\":\"ref\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/deployments \\\n  -d '{\"ref\":\"ref\"}'
    " }, { "lang": "JavaScript", @@ -34024,12 +34221,6 @@ "description": "Simple example", "payload": "
    {\n  \"url\": \"https://api.github.com/repos/octocat/example/deployments/1\",\n  \"id\": 1,\n  \"node_id\": \"MDEwOkRlcGxveW1lbnQx\",\n  \"sha\": \"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\n  \"ref\": \"topic-branch\",\n  \"task\": \"deploy\",\n  \"payload\": {},\n  \"original_environment\": \"staging\",\n  \"environment\": \"production\",\n  \"description\": \"Deploy request from hubot\",\n  \"creator\": {\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  \"created_at\": \"2012-07-20T01:19:13Z\",\n  \"updated_at\": \"2012-07-20T01:19:13Z\",\n  \"statuses_url\": \"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/example\",\n  \"transient_environment\": false,\n  \"production_environment\": true\n}\n
    " }, - { - "httpStatusCode": "201", - "httpStatusMessage": "Created", - "description": "Advanced example", - "payload": "
    {\n  \"url\": \"https://api.github.com/repos/octocat/example/deployments/1\",\n  \"id\": 1,\n  \"node_id\": \"MDEwOkRlcGxveW1lbnQx\",\n  \"sha\": \"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\n  \"ref\": \"topic-branch\",\n  \"task\": \"deploy\",\n  \"payload\": {},\n  \"original_environment\": \"staging\",\n  \"environment\": \"production\",\n  \"description\": \"Deploy request from hubot\",\n  \"creator\": {\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  \"created_at\": \"2012-07-20T01:19:13Z\",\n  \"updated_at\": \"2012-07-20T01:19:13Z\",\n  \"statuses_url\": \"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/example\",\n  \"transient_environment\": false,\n  \"production_environment\": true\n}\n
    " - }, { "httpStatusCode": "202", "httpStatusMessage": "Accepted", @@ -34039,14 +34230,7 @@ { "httpStatusCode": "409", "httpStatusMessage": "Conflict", - "description": "Merge conflict response", - "payload": "
    {\n  \"message\": \"Conflict merging master into topic-branch\"\n}\n
    " - }, - { - "httpStatusCode": "409", - "httpStatusMessage": "Conflict", - "description": "Failed commit status checks", - "payload": "
    {\n  \"message\": \"Conflict: Commit status checks failed for topic-branch.\"\n}\n
    " + "description": "Response when there is a merge conflict or the commit s status checks failed" }, { "httpStatusCode": "422", @@ -34058,7 +34242,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -34092,8 +34276,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/deployments/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/deployments/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/deployments/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/deployments/42
    " }, { "lang": "JavaScript", @@ -34156,7 +34340,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -34210,8 +34394,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/deployments/42/statuses", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/deployments/42/statuses
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/deployments/42/statuses", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/deployments/42/statuses
    " }, { "lang": "JavaScript", @@ -34274,7 +34458,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -34308,8 +34492,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/deployments/42/statuses \\\n -d '{\"state\":\"state\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/deployments/42/statuses \\\n  -d '{\"state\":\"state\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/deployments/42/statuses \\\n -d '{\"state\":\"state\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/deployments/42/statuses \\\n  -d '{\"state\":\"state\"}'
    " }, { "lang": "JavaScript", @@ -34555,7 +34739,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -34598,8 +34782,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/deployments/42/statuses/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/deployments/42/statuses/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/deployments/42/statuses/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/deployments/42/statuses/42
    " }, { "lang": "JavaScript", @@ -34673,7 +34857,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/events", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -34717,8 +34901,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/events", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/events
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/events", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/events
    " }, { "lang": "JavaScript", @@ -34762,7 +34946,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/forks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -34792,7 +34976,8 @@ "enum": [ "newest", "oldest", - "stargazers" + "stargazers", + "watchers" ], "default": "newest" }, @@ -34817,13 +35002,35 @@ "default": 1 }, "descriptionHTML": "

    Page number of the results to fetch.

    " + }, + { + "name": "org", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    legacy query parameter for specifying the org.

    " + }, + { + "name": "organization", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    legacy query parameter for specifying the org.

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/forks", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/forks
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/forks", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/forks
    " }, { "lang": "JavaScript", @@ -34873,7 +35080,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/forks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -34892,13 +35099,35 @@ "type": "string" }, "descriptionHTML": "" + }, + { + "name": "org", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    legacy query parameter for specifying the org.

    " + }, + { + "name": "organization", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    legacy query parameter for specifying the org.

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/forks \\\n -d '{\"organization\":\"organization\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/forks \\\n  -d '{\"organization\":\"organization\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/forks \\\n -d '{\"organization\":\"organization\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/forks \\\n  -d '{\"organization\":\"organization\"}'
    " }, { "lang": "JavaScript", @@ -34921,6 +35150,7 @@ "application/json": { "schema": { "type": "object", + "nullable": true, "properties": { "organization": { "type": "string", @@ -34993,7 +35223,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/git/blobs", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -35017,8 +35247,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/blobs \\\n -d '{\"content\":\"content\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/blobs \\\n  -d '{\"content\":\"content\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/blobs \\\n -d '{\"content\":\"content\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/blobs \\\n  -d '{\"content\":\"content\"}'
    " }, { "lang": "JavaScript", @@ -35140,7 +35370,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/git/blobs/{file_sha}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -35173,8 +35403,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/blobs/FILE_SHA", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/blobs/FILE_SHA
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/blobs/FILE_SHA", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/blobs/FILE_SHA
    " }, { "lang": "JavaScript", @@ -35234,7 +35464,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/git/commits", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -35258,8 +35488,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/commits \\\n -d '{\"message\":\"message\",\"tree\":\"tree\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/commits \\\n  -d '{\"message\":\"message\",\"tree\":\"tree\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/commits \\\n -d '{\"message\":\"message\",\"tree\":\"tree\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/commits \\\n  -d '{\"message\":\"message\",\"tree\":\"tree\"}'
    " }, { "lang": "JavaScript", @@ -35713,7 +35943,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/git/commits/{commit_sha}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -35748,8 +35978,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/commits/COMMIT_SHA", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/commits/COMMIT_SHA
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/commits/COMMIT_SHA", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/commits/COMMIT_SHA
    " }, { "lang": "JavaScript", @@ -35799,7 +36029,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/git/matching-refs/{ref}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -35821,14 +36051,14 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    ref+ parameter

    " + "descriptionHTML": "

    ref parameter

    " }, { "name": "per_page", @@ -35854,8 +36084,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/matching-refs/REF", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/matching-refs/REF
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/matching-refs/REF", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/matching-refs/REF
    " }, { "lang": "JavaScript", @@ -35900,7 +36130,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/git/ref/{ref}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -35922,21 +36152,21 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    ref+ parameter

    " + "descriptionHTML": "

    ref parameter

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/ref/REF", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/ref/REF
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/ref/REF", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/ref/REF
    " }, { "lang": "JavaScript", @@ -35986,7 +36216,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/git/refs", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -36010,8 +36240,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/refs \\\n -d '{\"ref\":\"ref\",\"sha\":\"sha\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/refs \\\n  -d '{\"ref\":\"ref\",\"sha\":\"sha\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/refs \\\n -d '{\"ref\":\"ref\",\"sha\":\"sha\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/refs \\\n  -d '{\"ref\":\"ref\",\"sha\":\"sha\"}'
    " }, { "lang": "JavaScript", @@ -36135,7 +36365,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/git/refs/{ref}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -36157,21 +36387,21 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    ref+ parameter

    " + "descriptionHTML": "

    ref parameter

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/refs/REF \\\n -d '{\"sha\":\"sha\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/refs/REF \\\n  -d '{\"sha\":\"sha\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/refs/REF \\\n -d '{\"sha\":\"sha\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/refs/REF \\\n  -d '{\"sha\":\"sha\"}'
    " }, { "lang": "JavaScript", @@ -36278,7 +36508,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/git/refs/{ref}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -36300,21 +36530,21 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    ref+ parameter

    " + "descriptionHTML": "

    ref parameter

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/refs/REF", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/refs/REF
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/refs/REF", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/refs/REF
    " }, { "lang": "JavaScript", @@ -36349,7 +36579,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "422", @@ -36363,7 +36593,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/git/tags", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -36387,8 +36617,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/tags \\\n -d '{\"tag\":\"tag\",\"message\":\"message\",\"object\":\"object\",\"type\":\"type\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/tags \\\n  -d '{\"tag\":\"tag\",\"message\":\"message\",\"object\":\"object\",\"type\":\"type\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/tags \\\n -d '{\"tag\":\"tag\",\"message\":\"message\",\"object\":\"object\",\"type\":\"type\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/tags \\\n  -d '{\"tag\":\"tag\",\"message\":\"message\",\"object\":\"object\",\"type\":\"type\"}'
    " }, { "lang": "JavaScript", @@ -36695,7 +36925,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/git/tags/{tag_sha}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -36728,8 +36958,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/tags/TAG_SHA", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/tags/TAG_SHA
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/tags/TAG_SHA", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/tags/TAG_SHA
    " }, { "lang": "JavaScript", @@ -36779,7 +37009,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/git/trees", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -36803,8 +37033,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/trees \\\n -d '{\"tree\":[{\"path\":\"path\",\"mode\":\"mode\",\"type\":\"type\",\"sha\":\"sha\",\"content\":\"content\"}]}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/trees \\\n  -d '{\"tree\":[{\"path\":\"path\",\"mode\":\"mode\",\"type\":\"type\",\"sha\":\"sha\",\"content\":\"content\"}]}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/trees \\\n -d '{\"tree\":[{\"path\":\"path\",\"mode\":\"mode\",\"type\":\"type\",\"sha\":\"sha\",\"content\":\"content\"}]}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/trees \\\n  -d '{\"tree\":[{\"path\":\"path\",\"mode\":\"mode\",\"type\":\"type\",\"sha\":\"sha\",\"content\":\"content\"}]}'
    " }, { "lang": "JavaScript", @@ -37184,7 +37414,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/git/trees/{tree_sha}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -37211,6 +37441,7 @@ "schema": { "type": "string" }, + "x-multi-segment": true, "descriptionHTML": "" }, { @@ -37227,8 +37458,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/trees/TREE_SHA", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/trees/TREE_SHA
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/trees/TREE_SHA", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/trees/TREE_SHA
    " }, { "lang": "JavaScript", @@ -37289,7 +37520,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/hooks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -37333,8 +37564,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/hooks", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/hooks
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks
    " }, { "lang": "JavaScript", @@ -37384,7 +37615,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/hooks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -37408,8 +37639,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/hooks \\\n -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"token\":\"token\",\"digest\":\"digest\"}}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/hooks \\\n  -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"token\":\"token\",\"digest\":\"digest\"}}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks \\\n -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"token\":\"token\",\"digest\":\"digest\"}}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks \\\n  -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"token\":\"token\",\"digest\":\"digest\"}}'
    " }, { "lang": "JavaScript", @@ -37845,7 +38076,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -37878,8 +38109,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/hooks/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/hooks/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks/42
    " }, { "lang": "JavaScript", @@ -37929,7 +38160,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -37962,8 +38193,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/hooks/42 \\\n -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"address\":\"address\",\"room\":\"room\"}}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/hooks/42 \\\n  -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"address\":\"address\",\"room\":\"room\"}}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks/42 \\\n -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"address\":\"address\",\"room\":\"room\"}}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks/42 \\\n  -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"address\":\"address\",\"room\":\"room\"}}'
    " }, { "lang": "JavaScript", @@ -38414,7 +38645,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -38447,8 +38678,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/hooks/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/hooks/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks/42
    " }, { "lang": "JavaScript", @@ -38483,7 +38714,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -38497,7 +38728,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}/pings", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -38530,8 +38761,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/hooks/42/pings", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/hooks/42/pings
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks/42/pings", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks/42/pings
    " }, { "lang": "JavaScript", @@ -38566,7 +38797,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -38580,7 +38811,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}/tests", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -38613,8 +38844,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/hooks/42/tests", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/hooks/42/tests
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks/42/tests", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks/42/tests
    " }, { "lang": "JavaScript", @@ -38649,7 +38880,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -38663,7 +38894,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/installation", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -38698,8 +38929,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/installation", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/installation
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/installation", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/installation
    " }, { "lang": "JavaScript", @@ -38758,7 +38989,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/invitations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -38802,8 +39033,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/invitations", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/invitations
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/invitations", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/invitations
    " }, { "lang": "JavaScript", @@ -38848,7 +39079,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/invitations/{invitation_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -38882,8 +39113,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/invitations/42 \\\n -d '{\"permissions\":\"permissions\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/invitations/42 \\\n  -d '{\"permissions\":\"permissions\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/invitations/42 \\\n -d '{\"permissions\":\"permissions\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/invitations/42 \\\n  -d '{\"permissions\":\"permissions\"}'
    " }, { "lang": "JavaScript", @@ -38972,7 +39203,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/invitations/{invitation_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -39006,8 +39237,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/invitations/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/invitations/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/invitations/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/invitations/42
    " }, { "lang": "JavaScript", @@ -39042,7 +39273,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -39051,7 +39282,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -39202,8 +39433,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues
    " }, { "lang": "JavaScript", @@ -39267,7 +39498,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/issues", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -39291,8 +39522,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues \\\n -d '{\"title\":\"title\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues \\\n  -d '{\"title\":\"title\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues \\\n -d '{\"title\":\"title\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues \\\n  -d '{\"title\":\"title\"}'
    " }, { "lang": "JavaScript", @@ -39583,7 +39814,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -39666,8 +39897,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/comments", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/comments
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/comments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/comments
    " }, { "lang": "JavaScript", @@ -39729,7 +39960,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -39763,8 +39994,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/comments/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/comments/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/comments/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/comments/42
    " }, { "lang": "JavaScript", @@ -39821,7 +40052,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -39855,8 +40086,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/comments/42 \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/comments/42 \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/comments/42 \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/comments/42 \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -39942,7 +40173,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -39976,8 +40207,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/comments/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/comments/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/comments/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/comments/42
    " }, { "lang": "JavaScript", @@ -40012,7 +40243,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -40021,7 +40252,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -40095,8 +40326,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/comments/42/reactions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/comments/42/reactions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/comments/42/reactions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/comments/42/reactions
    " }, { "lang": "JavaScript", @@ -40156,7 +40387,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -40190,8 +40421,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/comments/42/reactions \\\n -d '{\"content\":\"content\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/comments/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/comments/42/reactions \\\n -d '{\"content\":\"content\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/comments/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " }, { "lang": "JavaScript", @@ -40313,7 +40544,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/events", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -40357,8 +40588,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/events", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/events
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/events", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/events
    " }, { "lang": "JavaScript", @@ -40421,7 +40652,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/events/{event_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -40454,8 +40685,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/events/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/events/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/events/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/events/42
    " }, { "lang": "JavaScript", @@ -40534,7 +40765,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -40568,8 +40799,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42
    " }, { "lang": "JavaScript", @@ -40639,7 +40870,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -40673,8 +40904,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42 \\\n -d '{\"title\":\"title\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42 \\\n  -d '{\"title\":\"title\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42 \\\n -d '{\"title\":\"title\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42 \\\n  -d '{\"title\":\"title\"}'
    " }, { "lang": "JavaScript", @@ -40999,7 +41230,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/assignees", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -41033,8 +41264,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/assignees \\\n -d '{\"assignees\":[\"assignees\"]}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/assignees \\\n  -d '{\"assignees\":[\"assignees\"]}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/assignees \\\n -d '{\"assignees\":[\"assignees\"]}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/assignees \\\n  -d '{\"assignees\":[\"assignees\"]}'
    " }, { "lang": "JavaScript", @@ -41121,7 +41352,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/assignees", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -41155,8 +41386,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/assignees \\\n -d '{\"assignees\":[\"assignees\"]}'", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/assignees \\\n  -d '{\"assignees\":[\"assignees\"]}'
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/assignees \\\n -d '{\"assignees\":[\"assignees\"]}'", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/assignees \\\n  -d '{\"assignees\":[\"assignees\"]}'
    " }, { "lang": "JavaScript", @@ -41243,7 +41474,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -41307,8 +41538,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/comments", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/comments
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/comments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/comments
    " }, { "lang": "JavaScript", @@ -41370,7 +41601,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -41404,8 +41635,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/comments \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/comments \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/comments \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/comments \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -41507,7 +41738,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/events", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -41561,8 +41792,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/events", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/events
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/events", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/events
    " }, { "lang": "JavaScript", @@ -41625,7 +41856,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -41679,8 +41910,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/labels", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/labels
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/labels", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/labels
    " }, { "lang": "JavaScript", @@ -41730,7 +41961,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -41764,8 +41995,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/labels \\\n -d '{\"labels\":[\"labels\"]}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/labels \\\n  -d '{\"labels\":[\"labels\"]}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/labels \\\n -d '{\"labels\":[\"labels\"]}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/labels \\\n  -d '{\"labels\":[\"labels\"]}'
    " }, { "lang": "JavaScript", @@ -41865,7 +42096,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -41899,8 +42130,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/labels \\\n -d '{\"labels\":[\"labels\"]}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/labels \\\n  -d '{\"labels\":[\"labels\"]}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/labels \\\n -d '{\"labels\":[\"labels\"]}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/labels \\\n  -d '{\"labels\":[\"labels\"]}'
    " }, { "lang": "JavaScript", @@ -41997,7 +42228,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -42031,8 +42262,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/labels", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/labels
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/labels", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/labels
    " }, { "lang": "JavaScript", @@ -42067,7 +42298,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "410", @@ -42081,7 +42312,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels/{name}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -42124,8 +42355,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/labels/NAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/labels/NAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/labels/NAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/labels/NAME
    " }, { "lang": "JavaScript", @@ -42180,7 +42411,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/lock", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -42214,8 +42445,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/lock \\\n -d '{\"lock_reason\":\"lock_reason\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/lock \\\n  -d '{\"lock_reason\":\"lock_reason\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/lock \\\n -d '{\"lock_reason\":\"lock_reason\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/lock \\\n  -d '{\"lock_reason\":\"lock_reason\"}'
    " }, { "lang": "JavaScript", @@ -42281,7 +42512,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -42326,7 +42557,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/lock", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -42360,8 +42591,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/lock", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/lock
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/lock", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/lock
    " }, { "lang": "JavaScript", @@ -42394,7 +42625,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -42413,7 +42644,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -42487,8 +42718,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/reactions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/reactions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/reactions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/reactions
    " }, { "lang": "JavaScript", @@ -42553,7 +42784,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -42587,8 +42818,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/reactions \\\n -d '{\"content\":\"content\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/reactions \\\n -d '{\"content\":\"content\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " }, { "lang": "JavaScript", @@ -42704,7 +42935,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/timeline", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -42758,8 +42989,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.mockingbird-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/timeline", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.mockingbird-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/timeline
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.mockingbird-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/timeline", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.mockingbird-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/timeline
    " }, { "lang": "JavaScript", @@ -42832,7 +43063,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/keys", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -42876,8 +43107,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/keys", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/keys
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/keys", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/keys
    " }, { "lang": "JavaScript", @@ -42922,7 +43153,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/keys", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -42946,8 +43177,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/keys \\\n -d '{\"key\":\"key\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/keys \\\n  -d '{\"key\":\"key\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/keys \\\n -d '{\"key\":\"key\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/keys \\\n  -d '{\"key\":\"key\"}'
    " }, { "lang": "JavaScript", @@ -43071,7 +43302,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/keys/{key_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -43105,8 +43336,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/keys/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/keys/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/keys/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/keys/42
    " }, { "lang": "JavaScript", @@ -43156,7 +43387,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/keys/{key_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -43190,8 +43421,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/keys/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/keys/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/keys/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/keys/42
    " }, { "lang": "JavaScript", @@ -43226,7 +43457,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -43235,7 +43466,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/labels", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -43279,8 +43510,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/labels", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/labels
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/labels", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/labels
    " }, { "lang": "JavaScript", @@ -43330,7 +43561,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/labels", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -43354,8 +43585,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/labels \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/labels \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/labels \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/labels \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -43484,7 +43715,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/labels/{name}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -43517,8 +43748,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/labels/NAME", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/labels/NAME
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/labels/NAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/labels/NAME
    " }, { "lang": "JavaScript", @@ -43568,7 +43799,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/labels/{name}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -43601,8 +43832,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/labels/NAME \\\n -d '{\"new_name\":\"new_name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/labels/NAME \\\n  -d '{\"new_name\":\"new_name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/labels/NAME \\\n -d '{\"new_name\":\"new_name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/labels/NAME \\\n  -d '{\"new_name\":\"new_name\"}'
    " }, { "lang": "JavaScript", @@ -43718,7 +43949,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/labels/{name}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -43751,8 +43982,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/labels/NAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/labels/NAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/labels/NAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/labels/NAME
    " }, { "lang": "JavaScript", @@ -43787,7 +44018,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -43796,7 +44027,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/languages", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -43820,8 +44051,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/languages", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/languages
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/languages", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/languages
    " }, { "lang": "JavaScript", @@ -43864,7 +44095,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/license", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -43888,8 +44119,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/license", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/license
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/license", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/license
    " }, { "lang": "JavaScript", @@ -43932,7 +44163,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/merges", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -43956,8 +44187,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/merges \\\n -d '{\"base\":\"base\",\"head\":\"head\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/merges \\\n  -d '{\"base\":\"base\",\"head\":\"head\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/merges \\\n -d '{\"base\":\"base\",\"head\":\"head\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/merges \\\n  -d '{\"base\":\"base\",\"head\":\"head\"}'
    " }, { "lang": "JavaScript", @@ -44080,20 +44311,12 @@ { "httpStatusCode": "404", "httpStatusMessage": "Not Found", - "description": "Missing base response", - "payload": "
    {\n  \"message\": \"Base does not exist\"\n}\n
    " - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Missing head response", - "payload": "
    {\n  \"message\": \"Head does not exist\"\n}\n
    " + "description": "Response when the base or head does not exist" }, { "httpStatusCode": "409", "httpStatusMessage": "Conflict", - "description": "Merge conflict response", - "payload": "
    {\n  \"message\": \"Merge Conflict\"\n}\n
    " + "description": "Response when there is a merge conflict" }, { "httpStatusCode": "422", @@ -44105,7 +44328,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/milestones", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -44195,8 +44418,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/milestones", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/milestones
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/milestones", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/milestones
    " }, { "lang": "JavaScript", @@ -44246,7 +44469,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/milestones", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -44270,8 +44493,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/milestones \\\n -d '{\"title\":\"title\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/milestones \\\n  -d '{\"title\":\"title\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/milestones \\\n -d '{\"title\":\"title\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/milestones \\\n  -d '{\"title\":\"title\"}'
    " }, { "lang": "JavaScript", @@ -44429,7 +44652,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/milestones/{milestone_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -44463,8 +44686,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/milestones/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/milestones/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/milestones/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/milestones/42
    " }, { "lang": "JavaScript", @@ -44514,7 +44737,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/milestones/{milestone_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -44548,8 +44771,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/milestones/42 \\\n -d '{\"title\":\"title\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/milestones/42 \\\n  -d '{\"title\":\"title\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/milestones/42 \\\n -d '{\"title\":\"title\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/milestones/42 \\\n  -d '{\"title\":\"title\"}'
    " }, { "lang": "JavaScript", @@ -44694,7 +44917,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/milestones/{milestone_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -44728,8 +44951,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/milestones/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/milestones/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/milestones/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/milestones/42
    " }, { "lang": "JavaScript", @@ -44764,7 +44987,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -44778,7 +45001,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/milestones/{milestone_number}/labels", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -44832,8 +45055,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/milestones/42/labels", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/milestones/42/labels
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/milestones/42/labels", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/milestones/42/labels
    " }, { "lang": "JavaScript", @@ -44878,7 +45101,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/notifications", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -44964,8 +45187,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/notifications", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/notifications
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/notifications", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/notifications
    " }, { "lang": "JavaScript", @@ -45010,7 +45233,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/notifications", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -45034,8 +45257,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/notifications \\\n -d '{\"last_read_at\":\"last_read_at\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/notifications \\\n  -d '{\"last_read_at\":\"last_read_at\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/notifications \\\n -d '{\"last_read_at\":\"last_read_at\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/notifications \\\n  -d '{\"last_read_at\":\"last_read_at\"}'
    " }, { "lang": "JavaScript", @@ -45109,7 +45332,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pages", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -45133,8 +45356,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pages
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages
    " }, { "lang": "JavaScript", @@ -45184,7 +45407,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/pages", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -45208,8 +45431,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages \\\n -d '{\"source\":{\"branch\":\"branch\",\"path\":\"path\"}}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pages \\\n  -d '{\"source\":{\"branch\":\"branch\",\"path\":\"path\"}}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages \\\n -d '{\"source\":{\"branch\":\"branch\",\"path\":\"path\"}}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages \\\n  -d '{\"source\":{\"branch\":\"branch\",\"path\":\"path\"}}'
    " }, { "lang": "JavaScript", @@ -45450,7 +45673,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/pages", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -45474,8 +45697,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages \\\n -d '{\"public\":true}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pages \\\n  -d '{\"public\":true}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages \\\n -d '{\"public\":true}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages \\\n  -d '{\"public\":true}'
    " }, { "lang": "JavaScript", @@ -45580,7 +45803,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "400", @@ -45656,7 +45879,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/pages", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -45680,8 +45903,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pages
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages
    " }, { "lang": "JavaScript", @@ -45723,7 +45946,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -45747,7 +45970,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pages/builds", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -45791,8 +46014,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages/builds", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pages/builds
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages/builds", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages/builds
    " }, { "lang": "JavaScript", @@ -45837,7 +46060,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/pages/builds", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -45861,8 +46084,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages/builds", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pages/builds
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages/builds", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages/builds
    " }, { "lang": "JavaScript", @@ -45907,7 +46130,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pages/builds/latest", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -45931,8 +46154,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages/builds/latest", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pages/builds/latest
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages/builds/latest", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages/builds/latest
    " }, { "lang": "JavaScript", @@ -45977,7 +46200,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pages/builds/{build_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -46010,8 +46233,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages/builds/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pages/builds/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages/builds/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages/builds/42
    " }, { "lang": "JavaScript", @@ -46056,7 +46279,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -46095,13 +46318,43 @@ "default": 1 }, "descriptionHTML": "

    Page number of the results to fetch.

    " + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + }, + "descriptionHTML": "

    One of asc (ascending) or desc (descending).

    " + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + }, + "descriptionHTML": "" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pre-receive-hooks", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pre-receive-hooks
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pre-receive-hooks", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pre-receive-hooks
    " }, { "lang": "JavaScript", @@ -46153,7 +46406,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -46186,8 +46439,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pre-receive-hooks/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pre-receive-hooks/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pre-receive-hooks/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pre-receive-hooks/42
    " }, { "lang": "JavaScript", @@ -46239,7 +46492,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -46272,8 +46525,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pre-receive-hooks/42 \\\n -d '{\"enforcement\":\"enforcement\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pre-receive-hooks/42 \\\n  -d '{\"enforcement\":\"enforcement\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pre-receive-hooks/42 \\\n -d '{\"enforcement\":\"enforcement\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pre-receive-hooks/42 \\\n  -d '{\"enforcement\":\"enforcement\"}'
    " }, { "lang": "JavaScript", @@ -46358,7 +46611,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -46391,8 +46644,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pre-receive-hooks/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pre-receive-hooks/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pre-receive-hooks/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pre-receive-hooks/42
    " }, { "lang": "JavaScript", @@ -46444,7 +46697,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/projects", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -46504,8 +46757,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/projects", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/projects
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/projects", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/projects
    " }, { "lang": "JavaScript", @@ -46580,7 +46833,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/projects", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -46604,8 +46857,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/projects \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/projects \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/projects \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/projects \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -46735,7 +46988,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -46846,8 +47099,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls
    " }, { "lang": "JavaScript", @@ -46912,7 +47165,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/pulls", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -46936,8 +47189,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls \\\n -d '{\"head\":\"head\",\"base\":\"base\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls \\\n  -d '{\"head\":\"head\",\"base\":\"base\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls \\\n -d '{\"head\":\"head\",\"base\":\"base\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls \\\n  -d '{\"head\":\"head\",\"base\":\"base\"}'
    " }, { "lang": "JavaScript", @@ -47151,7 +47404,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -47173,18 +47426,17 @@ }, { "name": "sort", - "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to).", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "created", - "updated" - ], - "default": "created" + "updated", + "created_at" + ] }, - "descriptionHTML": "

    One of created (when the repository was starred) or updated (when it was last pushed to).

    " + "descriptionHTML": "" }, { "name": "direction", @@ -47234,8 +47486,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/comments", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/comments
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/comments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/comments
    " }, { "lang": "JavaScript", @@ -47293,7 +47545,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -47327,8 +47579,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/comments/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/comments/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/comments/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/comments/42
    " }, { "lang": "JavaScript", @@ -47391,7 +47643,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -47425,8 +47677,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/comments/42 \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/comments/42 \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/comments/42 \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/comments/42 \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -47514,7 +47766,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -47548,8 +47800,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/comments/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/comments/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/comments/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/comments/42
    " }, { "lang": "JavaScript", @@ -47584,7 +47836,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -47598,7 +47850,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -47672,8 +47924,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/comments/42/reactions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/comments/42/reactions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/comments/42/reactions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/comments/42/reactions
    " }, { "lang": "JavaScript", @@ -47733,7 +47985,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -47767,8 +48019,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/comments/42/reactions \\\n -d '{\"content\":\"content\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/comments/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/comments/42/reactions \\\n -d '{\"content\":\"content\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/comments/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " }, { "lang": "JavaScript", @@ -47890,7 +48142,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -47923,8 +48175,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42
    " }, { "lang": "JavaScript", @@ -47982,7 +48234,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -48015,8 +48267,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42 \\\n -d '{\"title\":\"title\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42 \\\n  -d '{\"title\":\"title\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42 \\\n -d '{\"title\":\"title\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42 \\\n  -d '{\"title\":\"title\"}'
    " }, { "lang": "JavaScript", @@ -48197,7 +48449,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -48289,8 +48541,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/comments", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/comments
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/comments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/comments
    " }, { "lang": "JavaScript", @@ -48348,7 +48600,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -48381,8 +48633,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/comments \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/comments \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/comments \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/comments \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -48664,7 +48916,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -48707,8 +48959,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/comments/42/replies \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/comments/42/replies \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/comments/42/replies \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/comments/42/replies \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -48795,7 +49047,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/commits", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -48848,8 +49100,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/commits", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/commits
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/commits", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/commits
    " }, { "lang": "JavaScript", @@ -48892,7 +49144,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/files", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -48945,8 +49197,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/files", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/files
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/files", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/files
    " }, { "lang": "JavaScript", @@ -48999,7 +49251,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/merge", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -49032,8 +49284,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/merge", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/merge
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/merge", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/merge
    " }, { "lang": "JavaScript", @@ -49080,7 +49332,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/merge", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -49113,8 +49365,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/merge \\\n -d '{\"commit_title\":\"commit_title\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/merge \\\n  -d '{\"commit_title\":\"commit_title\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/merge \\\n -d '{\"commit_title\":\"commit_title\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/merge \\\n  -d '{\"commit_title\":\"commit_title\"}'
    " }, { "lang": "JavaScript", @@ -49279,7 +49531,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -49332,8 +49584,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/requested_reviewers", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/requested_reviewers
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/requested_reviewers", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/requested_reviewers
    " }, { "lang": "JavaScript", @@ -49378,7 +49630,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -49411,8 +49663,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/requested_reviewers \\\n -d '{\"reviewers\":[\"reviewers\"]}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/requested_reviewers \\\n  -d '{\"reviewers\":[\"reviewers\"]}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/requested_reviewers \\\n -d '{\"reviewers\":[\"reviewers\"]}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/requested_reviewers \\\n  -d '{\"reviewers\":[\"reviewers\"]}'
    " }, { "lang": "JavaScript", @@ -49549,7 +49801,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -49582,8 +49834,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/requested_reviewers \\\n -d '{\"reviewers\":[\"reviewers\"]}'", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/requested_reviewers \\\n  -d '{\"reviewers\":[\"reviewers\"]}'
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/requested_reviewers \\\n -d '{\"reviewers\":[\"reviewers\"]}'", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/requested_reviewers \\\n  -d '{\"reviewers\":[\"reviewers\"]}'
    " }, { "lang": "JavaScript", @@ -49705,7 +49957,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -49758,8 +50010,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/reviews
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews
    " }, { "lang": "JavaScript", @@ -49804,7 +50056,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -49837,8 +50089,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews \\\n -d '{\"commit_id\":\"commit_id\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/reviews \\\n  -d '{\"commit_id\":\"commit_id\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews \\\n -d '{\"commit_id\":\"commit_id\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews \\\n  -d '{\"commit_id\":\"commit_id\"}'
    " }, { "lang": "JavaScript", @@ -50286,7 +50538,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -50329,8 +50581,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews/42
    " }, { "lang": "JavaScript", @@ -50380,7 +50632,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -50423,8 +50675,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42 \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42 \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews/42 \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews/42 \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -50510,7 +50762,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -50553,8 +50805,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews/42
    " }, { "lang": "JavaScript", @@ -50609,7 +50861,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -50672,8 +50924,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42/comments", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42/comments
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews/42/comments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews/42/comments
    " }, { "lang": "JavaScript", @@ -50723,7 +50975,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -50766,8 +51018,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42/dismissals \\\n -d '{\"message\":\"message\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42/dismissals \\\n  -d '{\"message\":\"message\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews/42/dismissals \\\n -d '{\"message\":\"message\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews/42/dismissals \\\n  -d '{\"message\":\"message\"}'
    " }, { "lang": "JavaScript", @@ -50873,7 +51125,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -50916,8 +51168,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42/events \\\n -d '{\"event\":\"event\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42/events \\\n  -d '{\"event\":\"event\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews/42/events \\\n -d '{\"event\":\"event\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews/42/events \\\n  -d '{\"event\":\"event\"}'
    " }, { "lang": "JavaScript", @@ -51038,7 +51290,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/update-branch", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -51071,8 +51323,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.lydian-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/update-branch \\\n -d '{\"expected_head_sha\":\"expected_head_sha\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.lydian-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/update-branch \\\n  -d '{\"expected_head_sha\":\"expected_head_sha\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.lydian-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/update-branch \\\n -d '{\"expected_head_sha\":\"expected_head_sha\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.lydian-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/update-branch \\\n  -d '{\"expected_head_sha\":\"expected_head_sha\"}'
    " }, { "lang": "JavaScript", @@ -51171,7 +51423,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/readme", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -51205,8 +51457,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/readme", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/readme
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/readme", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/readme
    " }, { "lang": "JavaScript", @@ -51258,10 +51510,111 @@ } ] }, + { + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/readme/{dir}", + "serverUrl": "http(s)://{hostname}/api/v3", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "dir", + "description": "The alternate path to look for a README file", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true, + "descriptionHTML": "

    The alternate path to look for a README file

    " + }, + { + "name": "ref", + "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    The name of the commit/branch/tag. Default: the repository’s default branch (usually master)

    " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/readme/DIR", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/readme/DIR
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /repos/{owner}/{repo}/readme/{dir}', {\n owner: 'octocat',\n repo: 'hello-world',\n dir: 'dir'\n})", + "html": "
    await octokit.request('GET /repos/{owner}/{repo}/readme/{dir}', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  dir: 'dir'\n})\n
    " + } + ], + "summary": "Get a repository README", + "description": "Gets the preferred README for a repository.\n\nREADMEs support [custom media types](https://docs.github.com/enterprise-server@2.20/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML.", + "tags": [ + "repos" + ], + "operationId": "repos/get-readme-from-alt-path", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@2.20/rest/reference/repos#get-a-repository-readme" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "contents" + }, + "slug": "get-a-repository-readme", + "category": "repos", + "categoryLabel": "Repos", + "subcategory": "contents", + "subcategoryLabel": "Contents", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

    Gets the preferred README for a repository.

    \n

    READMEs support custom media types for retrieving the raw content or rendered HTML.

    ", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
    {\n  \"type\": \"file\",\n  \"encoding\": \"base64\",\n  \"size\": 5362,\n  \"name\": \"README.md\",\n  \"path\": \"README.md\",\n  \"content\": \"encoded content ...\",\n  \"sha\": \"3d21ec53a331a6f037a91c368710b99387d012c1\",\n  \"url\": \"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\n  \"git_url\": \"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\n  \"html_url\": \"https://github.com/octokit/octokit.rb/blob/master/README.md\",\n  \"download_url\": \"https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md\",\n  \"_links\": {\n    \"git\": \"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\n    \"self\": \"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\n    \"html\": \"https://github.com/octokit/octokit.rb/blob/master/README.md\"\n  }\n}\n
    " + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + } + ] + }, { "verb": "get", "requestPath": "/repos/{owner}/{repo}/releases", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -51305,8 +51658,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases
    " }, { "lang": "JavaScript", @@ -51356,7 +51709,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/releases", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -51380,8 +51733,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases \\\n -d '{\"tag_name\":\"tag_name\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases \\\n  -d '{\"tag_name\":\"tag_name\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases \\\n -d '{\"tag_name\":\"tag_name\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases \\\n  -d '{\"tag_name\":\"tag_name\"}'
    " }, { "lang": "JavaScript", @@ -51567,7 +51920,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/releases/assets/{asset_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -51601,8 +51954,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/assets/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases/assets/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/assets/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/assets/42
    " }, { "lang": "JavaScript", @@ -51662,7 +52015,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/releases/assets/{asset_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -51696,8 +52049,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/assets/42 \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases/assets/42 \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/assets/42 \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/assets/42 \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -51812,7 +52165,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/releases/assets/{asset_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -51846,8 +52199,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/assets/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases/assets/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/assets/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/assets/42
    " }, { "lang": "JavaScript", @@ -51882,7 +52235,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -51891,7 +52244,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/releases/latest", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -51915,8 +52268,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/latest", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases/latest
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/latest", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/latest
    " }, { "lang": "JavaScript", @@ -51961,7 +52314,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/releases/tags/{tag}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -51983,21 +52336,21 @@ }, { "name": "tag", - "description": "tag+ parameter", + "description": "tag parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    tag+ parameter

    " + "descriptionHTML": "

    tag parameter

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/tags/TAG", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases/tags/TAG
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/tags/TAG", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/tags/TAG
    " }, { "lang": "JavaScript", @@ -52047,7 +52400,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/releases/{release_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -52081,8 +52434,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/42
    " }, { "lang": "JavaScript", @@ -52132,7 +52485,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/releases/{release_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -52166,8 +52519,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/42 \\\n -d '{\"tag_name\":\"tag_name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases/42 \\\n  -d '{\"tag_name\":\"tag_name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/42 \\\n -d '{\"tag_name\":\"tag_name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/42 \\\n  -d '{\"tag_name\":\"tag_name\"}'
    " }, { "lang": "JavaScript", @@ -52340,7 +52693,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/releases/{release_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -52374,8 +52727,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/42
    " }, { "lang": "JavaScript", @@ -52410,7 +52763,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -52419,7 +52772,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/releases/{release_id}/assets", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -52473,8 +52826,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/42/assets", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases/42/assets
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/42/assets", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/42/assets
    " }, { "lang": "JavaScript", @@ -52519,7 +52872,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/releases/{release_id}/assets", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -52569,8 +52922,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/42/assets", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases/42/assets
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/42/assets", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/42/assets
    " }, { "lang": "JavaScript", @@ -52636,7 +52989,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/stargazers", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -52680,8 +53033,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/stargazers", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/stargazers
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/stargazers", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/stargazers
    " }, { "lang": "JavaScript", @@ -52731,7 +53084,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/stats/code_frequency", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -52755,8 +53108,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/stats/code_frequency", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/stats/code_frequency
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/stats/code_frequency", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/stats/code_frequency
    " }, { "lang": "JavaScript", @@ -52801,7 +53154,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/stats/commit_activity", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -52825,8 +53178,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/stats/commit_activity", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/stats/commit_activity
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/stats/commit_activity", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/stats/commit_activity
    " }, { "lang": "JavaScript", @@ -52871,7 +53224,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/stats/contributors", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -52895,8 +53248,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/stats/contributors", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/stats/contributors
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/stats/contributors", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/stats/contributors
    " }, { "lang": "JavaScript", @@ -52941,7 +53294,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/stats/participation", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -52965,8 +53318,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/stats/participation", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/stats/participation
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/stats/participation", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/stats/participation
    " }, { "lang": "JavaScript", @@ -53016,7 +53369,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/stats/punch_card", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -53040,8 +53393,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/stats/punch_card", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/stats/punch_card
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/stats/punch_card", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/stats/punch_card
    " }, { "lang": "JavaScript", @@ -53086,7 +53439,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/statuses/{sha}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -53120,8 +53473,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/statuses/SHA \\\n -d '{\"state\":\"state\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/statuses/SHA \\\n  -d '{\"state\":\"state\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/statuses/SHA \\\n -d '{\"state\":\"state\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/statuses/SHA \\\n  -d '{\"state\":\"state\"}'
    " }, { "lang": "JavaScript", @@ -53273,7 +53626,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/subscribers", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -53317,8 +53670,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/subscribers", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/subscribers
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/subscribers", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/subscribers
    " }, { "lang": "JavaScript", @@ -53363,7 +53716,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/subscription", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -53387,8 +53740,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/subscription", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/subscription
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/subscription", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/subscription
    " }, { "lang": "JavaScript", @@ -53443,7 +53796,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/subscription", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -53467,8 +53820,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/subscription \\\n -d '{\"subscribed\":true}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/subscription \\\n  -d '{\"subscribed\":true}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/subscription \\\n -d '{\"subscribed\":true}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/subscription \\\n  -d '{\"subscribed\":true}'
    " }, { "lang": "JavaScript", @@ -53561,7 +53914,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/subscription", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -53585,8 +53938,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/subscription", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/subscription
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/subscription", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/subscription
    " }, { "lang": "JavaScript", @@ -53621,7 +53974,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -53630,7 +53983,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/tags", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -53674,8 +54027,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/tags", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/tags
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/tags", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/tags
    " }, { "lang": "JavaScript", @@ -53718,7 +54071,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/tarball/{ref}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -53751,8 +54104,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/tarball/REF", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/tarball/REF
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/tarball/REF", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/tarball/REF
    " }, { "lang": "JavaScript", @@ -53796,7 +54149,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/teams", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -53840,8 +54193,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/teams", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/teams
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/teams", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/teams
    " }, { "lang": "JavaScript", @@ -53884,7 +54237,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/topics", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -53903,13 +54256,33 @@ "type": "string" }, "descriptionHTML": "" + }, + { + "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.

    " + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "descriptionHTML": "

    Results per page (max 100).

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/topics", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/topics
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/topics", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/topics
    " }, { "lang": "JavaScript", @@ -53969,7 +54342,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/topics", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -53993,8 +54366,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/topics \\\n -d '{\"names\":[\"names\"]}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/topics \\\n  -d '{\"names\":[\"names\"]}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/topics \\\n -d '{\"names\":[\"names\"]}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/topics \\\n  -d '{\"names\":[\"names\"]}'
    " }, { "lang": "JavaScript", @@ -54106,7 +54479,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/transfer", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -54130,8 +54503,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/transfer \\\n -d '{\"new_owner\":\"new_owner\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/transfer \\\n  -d '{\"new_owner\":\"new_owner\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/transfer \\\n -d '{\"new_owner\":\"new_owner\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/transfer \\\n  -d '{\"new_owner\":\"new_owner\"}'
    " }, { "lang": "JavaScript", @@ -54238,7 +54611,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/vulnerability-alerts", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -54262,8 +54635,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/vulnerability-alerts", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/vulnerability-alerts
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/vulnerability-alerts", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/vulnerability-alerts
    " }, { "lang": "JavaScript", @@ -54303,7 +54676,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -54312,7 +54685,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/vulnerability-alerts", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -54336,8 +54709,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/vulnerability-alerts", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/vulnerability-alerts
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/vulnerability-alerts", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/vulnerability-alerts
    " }, { "lang": "JavaScript", @@ -54377,7 +54750,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -54386,7 +54759,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/zipball/{ref}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -54419,8 +54792,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/zipball/REF", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/zipball/REF
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/zipball/REF", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/zipball/REF
    " }, { "lang": "JavaScript", @@ -54464,7 +54837,7 @@ { "verb": "post", "requestPath": "/repos/{template_owner}/{template_repo}/generate", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "template_owner", @@ -54488,8 +54861,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.baptiste-preview+json\" \\\n https://api.github.com/repos/TEMPLATE_OWNER/TEMPLATE_REPO/generate \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.baptiste-preview+json\" \\\n  https://api.github.com/repos/TEMPLATE_OWNER/TEMPLATE_REPO/generate \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.baptiste-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/TEMPLATE_OWNER/TEMPLATE_REPO/generate \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.baptiste-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/TEMPLATE_OWNER/TEMPLATE_REPO/generate \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -54498,7 +54871,7 @@ } ], "summary": "Create a repository using a template", - "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@2.20/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.20/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", + "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@2.20/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.20/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository", "tags": [ "repos" ], @@ -54593,7 +54966,7 @@ "category": "repos", "categoryLabel": "Repos", "notes": [], - "descriptionHTML": "

    Creates a new repository using a repository template. Use the template_owner and template_repo route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the Get a repository endpoint and check that the is_template key is true.

    \n

    OAuth scope requirements

    \n

    When using OAuth, authorizations must include:

    \n
      \n
    • public_repo scope or repo scope to create a public repository
    • \n
    • repo scope to create a private repository
    • \n
    ", + "descriptionHTML": "

    Creates a new repository using a repository template. Use the template_owner and template_repo route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the Get a repository endpoint and check that the is_template key is true.

    \n

    OAuth scope requirements

    \n

    When using OAuth, authorizations must include:

    \n
      \n
    • public_repo scope or repo scope to create a public repository. Note: For GitHub AE, use repo scope to create an internal repository.
    • \n
    • repo scope to create a private repository
    • \n
    ", "bodyParameters": [ { "type": "string", @@ -54655,7 +55028,7 @@ { "verb": "get", "requestPath": "/repositories", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "since", @@ -54669,7 +55042,7 @@ }, { "name": "visibility", - "description": "Specifies the types of repositories to return. Can be one of `all` or `public`. Default: `public`.", + "description": "Specifies the types of repositories to return. Can be one of `all` or `public`. Default: `public`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise.", "in": "query", "required": false, "schema": { @@ -54681,14 +55054,14 @@ "public" ] }, - "descriptionHTML": "

    Specifies the types of repositories to return. Can be one of all or public. Default: public.

    " + "descriptionHTML": "

    Specifies the types of repositories to return. Can be one of all or public. Default: public. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise.

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repositories", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repositories
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repositories", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repositories
    " }, { "lang": "JavaScript", @@ -54697,7 +55070,7 @@ } ], "summary": "List public repositories", - "description": "Lists all public repositories in the order that they were created.\n\nNote: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@2.20/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.", + "description": "Lists all public repositories in the order that they were created.\n\nNotes:\n- For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise.\n- Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@2.20/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.", "tags": [ "repos" ], @@ -54718,7 +55091,7 @@ "categoryLabel": "Repos", "notes": [], "bodyParameters": [], - "descriptionHTML": "

    Lists all public repositories in the order that they were created.

    \n

    Note: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of repositories.

    ", + "descriptionHTML": "

    Lists all public repositories in the order that they were created.

    \n

    Notes:

    \n
      \n
    • For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise.
    • \n
    • Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of repositories.
    • \n
    ", "responses": [ { "httpStatusCode": "200", @@ -54741,7 +55114,7 @@ { "verb": "get", "requestPath": "/search/code", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "q", @@ -54805,8 +55178,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/search/code", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/search/code
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/search/code", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/search/code
    " }, { "lang": "JavaScript", @@ -54869,7 +55242,7 @@ { "verb": "get", "requestPath": "/search/commits", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "q", @@ -54934,8 +55307,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.cloak-preview+json\" \\\n https://api.github.com/search/commits", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.cloak-preview+json\" \\\n  https://api.github.com/search/commits
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.cloak-preview+json\" \\\n http(s)://{hostname}/api/v3/search/commits", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.cloak-preview+json\" \\\n  http(s)://{hostname}/api/v3/search/commits
    " }, { "lang": "JavaScript", @@ -54995,7 +55368,7 @@ { "verb": "get", "requestPath": "/search/issues", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "q", @@ -55069,8 +55442,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/search/issues", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/search/issues
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/search/issues", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/search/issues
    " }, { "lang": "JavaScript", @@ -55133,7 +55506,7 @@ { "verb": "get", "requestPath": "/search/labels", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "repository_id", @@ -55188,8 +55561,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/search/labels", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/search/labels
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/search/labels", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/search/labels
    " }, { "lang": "JavaScript", @@ -55252,7 +55625,7 @@ { "verb": "get", "requestPath": "/search/repositories", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "q", @@ -55319,8 +55692,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/search/repositories", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/search/repositories
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/search/repositories", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/search/repositories
    " }, { "lang": "JavaScript", @@ -55385,7 +55758,7 @@ { "verb": "get", "requestPath": "/search/topics", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "q", @@ -55401,8 +55774,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n https://api.github.com/search/topics", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n  https://api.github.com/search/topics
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n http(s)://{hostname}/api/v3/search/topics", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n  http(s)://{hostname}/api/v3/search/topics
    " }, { "lang": "JavaScript", @@ -55462,7 +55835,7 @@ { "verb": "get", "requestPath": "/search/users", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "q", @@ -55528,8 +55901,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/search/users", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/search/users
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/search/users", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/search/users
    " }, { "lang": "JavaScript", @@ -55587,13 +55960,13 @@ { "verb": "get", "requestPath": "/setup/api/configcheck", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/configcheck", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/setup/api/configcheck
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/setup/api/configcheck", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/setup/api/configcheck
    " }, { "lang": "JavaScript", @@ -55638,13 +56011,13 @@ { "verb": "post", "requestPath": "/setup/api/configure", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/configure", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/setup/api/configure
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/setup/api/configure", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/setup/api/configure
    " }, { "lang": "JavaScript", @@ -55688,13 +56061,13 @@ { "verb": "get", "requestPath": "/setup/api/maintenance", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/maintenance", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/setup/api/maintenance
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/setup/api/maintenance", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/setup/api/maintenance
    " }, { "lang": "JavaScript", @@ -55739,13 +56112,13 @@ { "verb": "post", "requestPath": "/setup/api/maintenance", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/maintenance \\\n -d '{\"maintenance\":\"maintenance\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/setup/api/maintenance \\\n  -d '{\"maintenance\":\"maintenance\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/setup/api/maintenance \\\n -d '{\"maintenance\":\"maintenance\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/setup/api/maintenance \\\n  -d '{\"maintenance\":\"maintenance\"}'
    " }, { "lang": "JavaScript", @@ -55823,13 +56196,13 @@ { "verb": "get", "requestPath": "/setup/api/settings", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/settings", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/setup/api/settings
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/setup/api/settings", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/setup/api/settings
    " }, { "lang": "JavaScript", @@ -55874,13 +56247,13 @@ { "verb": "put", "requestPath": "/setup/api/settings", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/settings \\\n -d '{\"settings\":\"settings\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/setup/api/settings \\\n  -d '{\"settings\":\"settings\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/setup/api/settings \\\n -d '{\"settings\":\"settings\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/setup/api/settings \\\n  -d '{\"settings\":\"settings\"}'
    " }, { "lang": "JavaScript", @@ -55938,7 +56311,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "descriptionHTML": "

    For a list of the available settings, see the Get settings endpoint.

    ", @@ -55957,13 +56330,13 @@ { "verb": "get", "requestPath": "/setup/api/settings/authorized-keys", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/settings/authorized-keys", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/setup/api/settings/authorized-keys
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/setup/api/settings/authorized-keys", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/setup/api/settings/authorized-keys
    " }, { "lang": "JavaScript", @@ -56008,13 +56381,13 @@ { "verb": "post", "requestPath": "/setup/api/settings/authorized-keys", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/settings/authorized-keys \\\n -d '{\"authorized_key\":\"authorized_key\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/setup/api/settings/authorized-keys \\\n  -d '{\"authorized_key\":\"authorized_key\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/setup/api/settings/authorized-keys \\\n -d '{\"authorized_key\":\"authorized_key\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/setup/api/settings/authorized-keys \\\n  -d '{\"authorized_key\":\"authorized_key\"}'
    " }, { "lang": "JavaScript", @@ -56092,13 +56465,13 @@ { "verb": "delete", "requestPath": "/setup/api/settings/authorized-keys", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/settings/authorized-keys \\\n -d '{\"authorized_key\":\"authorized_key\"}'", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/setup/api/settings/authorized-keys \\\n  -d '{\"authorized_key\":\"authorized_key\"}'
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/setup/api/settings/authorized-keys \\\n -d '{\"authorized_key\":\"authorized_key\"}'", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/setup/api/settings/authorized-keys \\\n  -d '{\"authorized_key\":\"authorized_key\"}'
    " }, { "lang": "JavaScript", @@ -56176,13 +56549,13 @@ { "verb": "post", "requestPath": "/setup/api/start", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/start \\\n -d '{\"license\":\"license\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/setup/api/start \\\n  -d '{\"license\":\"license\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/setup/api/start \\\n -d '{\"license\":\"license\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/setup/api/start \\\n  -d '{\"license\":\"license\"}'
    " }, { "lang": "JavaScript", @@ -56295,13 +56668,13 @@ { "verb": "post", "requestPath": "/setup/api/upgrade", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/upgrade \\\n -d '{\"license\":\"license\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/setup/api/upgrade \\\n  -d '{\"license\":\"license\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/setup/api/upgrade \\\n -d '{\"license\":\"license\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/setup/api/upgrade \\\n  -d '{\"license\":\"license\"}'
    " }, { "lang": "JavaScript", @@ -56375,7 +56748,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -56390,8 +56763,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42
    " }, { "lang": "JavaScript", @@ -56433,7 +56806,7 @@ { "verb": "patch", "requestPath": "/teams/{team_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -56448,8 +56821,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42 \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42 \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42 \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42 \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -56620,7 +56993,7 @@ { "verb": "delete", "requestPath": "/teams/{team_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -56635,8 +57008,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42
    " }, { "lang": "JavaScript", @@ -56668,7 +57041,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -56677,7 +57050,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/discussions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -56727,8 +57100,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/discussions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions
    " }, { "lang": "JavaScript", @@ -56779,7 +57152,7 @@ { "verb": "post", "requestPath": "/teams/{team_id}/discussions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -56794,8 +57167,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions \\\n -d '{\"title\":\"title\",\"body\":\"body\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/discussions \\\n  -d '{\"title\":\"title\",\"body\":\"body\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions \\\n -d '{\"title\":\"title\",\"body\":\"body\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions \\\n  -d '{\"title\":\"title\",\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -56923,7 +57296,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/discussions/{discussion_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -56947,8 +57320,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/discussions/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions/42
    " }, { "lang": "JavaScript", @@ -56999,7 +57372,7 @@ { "verb": "patch", "requestPath": "/teams/{team_id}/discussions/{discussion_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -57023,8 +57396,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions/42 \\\n -d '{\"title\":\"title\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/discussions/42 \\\n  -d '{\"title\":\"title\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions/42 \\\n -d '{\"title\":\"title\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions/42 \\\n  -d '{\"title\":\"title\"}'
    " }, { "lang": "JavaScript", @@ -57126,7 +57499,7 @@ { "verb": "delete", "requestPath": "/teams/{team_id}/discussions/{discussion_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -57150,8 +57523,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/discussions/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions/42
    " }, { "lang": "JavaScript", @@ -57186,7 +57559,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -57195,7 +57568,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -57254,8 +57627,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions/42/comments", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/discussions/42/comments
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions/42/comments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions/42/comments
    " }, { "lang": "JavaScript", @@ -57306,7 +57679,7 @@ { "verb": "post", "requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -57330,8 +57703,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions/42/comments \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/discussions/42/comments \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions/42/comments \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions/42/comments \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -57419,7 +57792,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -57452,8 +57825,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions/42/comments/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/discussions/42/comments/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions/42/comments/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions/42/comments/42
    " }, { "lang": "JavaScript", @@ -57504,7 +57877,7 @@ { "verb": "patch", "requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -57537,8 +57910,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions/42/comments/42 \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/discussions/42/comments/42 \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions/42/comments/42 \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions/42/comments/42 \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -57625,7 +57998,7 @@ { "verb": "delete", "requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -57658,8 +58031,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions/42/comments/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/discussions/42/comments/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions/42/comments/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions/42/comments/42
    " }, { "lang": "JavaScript", @@ -57694,7 +58067,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -57703,7 +58076,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -57787,8 +58160,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions/42/comments/42/reactions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/discussions/42/comments/42/reactions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions/42/comments/42/reactions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions/42/comments/42/reactions
    " }, { "lang": "JavaScript", @@ -57836,7 +58209,7 @@ { "verb": "post", "requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -57880,8 +58253,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions/42/comments/42/reactions \\\n -d '{\"content\":\"content\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/discussions/42/comments/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions/42/comments/42/reactions \\\n -d '{\"content\":\"content\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions/42/comments/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " }, { "lang": "JavaScript", @@ -57985,7 +58358,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/discussions/{discussion_number}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -58060,8 +58433,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions/42/reactions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/discussions/42/reactions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions/42/reactions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions/42/reactions
    " }, { "lang": "JavaScript", @@ -58109,7 +58482,7 @@ { "verb": "post", "requestPath": "/teams/{team_id}/discussions/{discussion_number}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -58144,8 +58517,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions/42/reactions \\\n -d '{\"content\":\"content\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/discussions/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions/42/reactions \\\n -d '{\"content\":\"content\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " }, { "lang": "JavaScript", @@ -58249,7 +58622,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/members", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -58300,8 +58673,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/members", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/members
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/members", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/members
    " }, { "lang": "JavaScript", @@ -58346,7 +58719,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/members/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -58370,8 +58743,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/members/USERNAME", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/members/USERNAME
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/members/USERNAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/members/USERNAME
    " }, { "lang": "JavaScript", @@ -58423,7 +58796,7 @@ { "verb": "put", "requestPath": "/teams/{team_id}/members/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -58447,8 +58820,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/members/USERNAME", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/members/USERNAME
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/members/USERNAME", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/members/USERNAME
    " }, { "lang": "JavaScript", @@ -58482,13 +58855,11 @@ "subcategory": "members", "subcategoryLabel": "Members", "notes": [], - "bodyParameters": [], - "descriptionHTML": "

    The \"Add team member\" endpoint (described below) is deprecated.

    \n

    We recommend using the Add or update team membership for a user endpoint instead. It allows you to invite new organization members to your teams.

    \n

    Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

    \n

    To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.

    \n

    Note: When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"

    \n

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

    ", "responses": [ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -58503,21 +58874,16 @@ { "httpStatusCode": "422", "httpStatusMessage": "Unprocessable Entity", - "description": "Response if you attempt to add an organization to a team", - "payload": "
    {\n  \"message\": \"Cannot add an organization as a member.\",\n  \"errors\": [\n    {\n      \"code\": \"org\",\n      \"field\": \"user\",\n      \"resource\": \"TeamMember\"\n    }\n  ]\n}\n
    " - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Response if you attempt to add a user to a team when they are not a member of at least one other team in the same organization", - "payload": "
    {\n  \"message\": \"User isn't a member of this organization. Please invite them first.\",\n  \"errors\": [\n    {\n      \"code\": \"unaffiliated\",\n      \"field\": \"user\",\n      \"resource\": \"TeamMember\"\n    }\n  ]\n}\n
    " + "description": "Response if you attempt to add an organization to a team or you attempt to add a user to a team when they are not a member of at least one other team in the same organization" } - ] + ], + "bodyParameters": [], + "descriptionHTML": "

    The \"Add team member\" endpoint (described below) is deprecated.

    \n

    We recommend using the Add or update team membership for a user endpoint instead. It allows you to invite new organization members to your teams.

    \n

    Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

    \n

    To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.

    \n

    Note: When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"

    \n

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

    " }, { "verb": "delete", "requestPath": "/teams/{team_id}/members/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -58541,8 +58907,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/members/USERNAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/members/USERNAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/members/USERNAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/members/USERNAME
    " }, { "lang": "JavaScript", @@ -58580,7 +58946,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -58594,7 +58960,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/memberships/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -58618,8 +58984,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/memberships/USERNAME", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/memberships/USERNAME
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/memberships/USERNAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/memberships/USERNAME
    " }, { "lang": "JavaScript", @@ -58653,30 +59019,18 @@ "bodyParameters": [], "descriptionHTML": "

    Team members will include the members of child teams.

    \n

    To get a user's membership with a team, the team must be visible to the authenticated user.

    \n

    Note: The role for organization owners returns as maintainer. For more information about maintainer roles, see Create a team.

    ", "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response if user has an active membership with team", - "payload": "
    {\n  \"url\": \"https://api.github.com/teams/1/memberships/octocat\",\n  \"role\": \"member\",\n  \"state\": \"active\"\n}\n
    " - }, { "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Response if user is a team maintainer", "payload": "
    {\n  \"url\": \"https://api.github.com/teams/1/memberships/octocat\",\n  \"role\": \"maintainer\",\n  \"state\": \"active\"\n}\n
    " - }, - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response if user has a pending membership with team", - "payload": "
    {\n  \"url\": \"https://api.github.com/teams/1/memberships/octocat\",\n  \"role\": \"member\",\n  \"state\": \"pending\"\n}\n
    " } ] }, { "verb": "put", "requestPath": "/teams/{team_id}/memberships/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -58700,8 +59054,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/memberships/USERNAME \\\n -d '{\"role\":\"role\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/memberships/USERNAME \\\n  -d '{\"role\":\"role\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/memberships/USERNAME \\\n -d '{\"role\":\"role\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/memberships/USERNAME \\\n  -d '{\"role\":\"role\"}'
    " }, { "lang": "JavaScript", @@ -58775,12 +59129,6 @@ } ], "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response if user's membership with team is now active", - "payload": "
    {\n  \"url\": \"https://api.github.com/teams/1/memberships/octocat\",\n  \"role\": \"member\",\n  \"state\": \"active\"\n}\n
    " - }, { "httpStatusCode": "200", "httpStatusMessage": "OK", @@ -58790,15 +59138,14 @@ { "httpStatusCode": "422", "httpStatusMessage": "Unprocessable Entity", - "description": "Response if you attempt to add an organization to a team", - "payload": "
    {\n  \"message\": \"Cannot add an organization as a member.\",\n  \"errors\": [\n    {\n      \"code\": \"org\",\n      \"field\": \"user\",\n      \"resource\": \"TeamMember\"\n    }\n  ]\n}\n
    " + "description": "Response if you attempt to add an organization to a team" } ] }, { "verb": "delete", "requestPath": "/teams/{team_id}/memberships/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -58822,8 +59169,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/memberships/USERNAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/memberships/USERNAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/memberships/USERNAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/memberships/USERNAME
    " }, { "lang": "JavaScript", @@ -58858,7 +59205,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -58867,7 +59214,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/projects", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -58913,8 +59260,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/projects", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/projects
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/projects", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/projects
    " }, { "lang": "JavaScript", @@ -58962,7 +59309,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/projects/{project_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -58997,8 +59344,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/projects/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/projects/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/projects/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/projects/42
    " }, { "lang": "JavaScript", @@ -59051,7 +59398,7 @@ { "verb": "put", "requestPath": "/teams/{team_id}/projects/{project_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -59086,8 +59433,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/projects/42 \\\n -d '{\"permission\":\"permission\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/projects/42 \\\n  -d '{\"permission\":\"permission\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/projects/42 \\\n -d '{\"permission\":\"permission\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/projects/42 \\\n  -d '{\"permission\":\"permission\"}'
    " }, { "lang": "JavaScript", @@ -59168,7 +59515,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -59181,7 +59528,7 @@ { "verb": "delete", "requestPath": "/teams/{team_id}/projects/{project_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -59205,8 +59552,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/projects/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/projects/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/projects/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/projects/42
    " }, { "lang": "JavaScript", @@ -59239,7 +59586,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -59248,7 +59595,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/repos", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -59283,8 +59630,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/repos", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/repos
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/repos", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/repos
    " }, { "lang": "JavaScript", @@ -59326,7 +59673,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/repos/{owner}/{repo}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -59359,8 +59706,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/repos/octocat/hello-world", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/repos/octocat/hello-world
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/repos/octocat/hello-world", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/repos/octocat/hello-world
    " }, { "lang": "JavaScript", @@ -59411,7 +59758,7 @@ { "verb": "put", "requestPath": "/teams/{team_id}/repos/{owner}/{repo}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -59444,8 +59791,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/repos/octocat/hello-world \\\n -d '{\"permission\":\"permission\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/repos/octocat/hello-world \\\n  -d '{\"permission\":\"permission\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/repos/octocat/hello-world \\\n -d '{\"permission\":\"permission\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/repos/octocat/hello-world \\\n  -d '{\"permission\":\"permission\"}'
    " }, { "lang": "JavaScript", @@ -59502,7 +59849,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "descriptionHTML": "

    To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a 422 Unprocessable Entity status if you attempt to add a repository to a team that is not owned by the 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.\"

    ", @@ -59526,7 +59873,7 @@ { "verb": "delete", "requestPath": "/teams/{team_id}/repos/{owner}/{repo}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -59559,8 +59906,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/repos/octocat/hello-world", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/repos/octocat/hello-world
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/repos/octocat/hello-world", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/repos/octocat/hello-world
    " }, { "lang": "JavaScript", @@ -59593,7 +59940,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -59602,7 +59949,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/teams", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -59637,8 +59984,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/teams", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/teams
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/teams", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/teams
    " }, { "lang": "JavaScript", @@ -59680,13 +60027,13 @@ { "verb": "get", "requestPath": "/user", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user
    " }, { "lang": "JavaScript", @@ -59750,13 +60097,13 @@ { "verb": "patch", "requestPath": "/user", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -59994,7 +60341,7 @@ { "verb": "get", "requestPath": "/user/emails", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -60020,8 +60367,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/emails", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/emails
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/emails", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/emails
    " }, { "lang": "JavaScript", @@ -60086,13 +60433,13 @@ { "verb": "post", "requestPath": "/user/emails", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/emails \\\n -d '{\"emails\":[\"octocat@github.com\"]}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/emails \\\n  -d '{\"emails\":[\"octocat@github.com\"]}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/emails \\\n -d '{\"emails\":[\"octocat@github.com\"]}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/emails \\\n  -d '{\"emails\":[\"octocat@github.com\"]}'
    " }, { "lang": "JavaScript", @@ -60207,13 +60554,13 @@ { "verb": "delete", "requestPath": "/user/emails", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/emails \\\n -d '{\"emails\":[\"octocat@github.com\"]}'", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/emails \\\n  -d '{\"emails\":[\"octocat@github.com\"]}'
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/emails \\\n -d '{\"emails\":[\"octocat@github.com\"]}'", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/emails \\\n  -d '{\"emails\":[\"octocat@github.com\"]}'
    " }, { "lang": "JavaScript", @@ -60293,7 +60640,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -60327,7 +60674,7 @@ { "verb": "get", "requestPath": "/user/followers", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -60353,8 +60700,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/followers", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/followers
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/followers", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/followers
    " }, { "lang": "JavaScript", @@ -60414,7 +60761,7 @@ { "verb": "get", "requestPath": "/user/following", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -60440,8 +60787,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/following", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/following
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/following", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/following
    " }, { "lang": "JavaScript", @@ -60501,7 +60848,7 @@ { "verb": "get", "requestPath": "/user/following/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -60516,8 +60863,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/following/USERNAME", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/following/USERNAME
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/following/USERNAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/following/USERNAME
    " }, { "lang": "JavaScript", @@ -60581,7 +60928,7 @@ { "verb": "put", "requestPath": "/user/following/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -60596,8 +60943,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/following/USERNAME", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/following/USERNAME
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/following/USERNAME", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/following/USERNAME
    " }, { "lang": "JavaScript", @@ -60632,7 +60979,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -60661,7 +61008,7 @@ { "verb": "delete", "requestPath": "/user/following/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -60676,8 +61023,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/following/USERNAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/following/USERNAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/following/USERNAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/following/USERNAME
    " }, { "lang": "JavaScript", @@ -60712,7 +61059,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -60741,7 +61088,7 @@ { "verb": "get", "requestPath": "/user/gpg_keys", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -60767,8 +61114,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/gpg_keys", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/gpg_keys
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/gpg_keys", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/gpg_keys
    " }, { "lang": "JavaScript", @@ -60833,13 +61180,13 @@ { "verb": "post", "requestPath": "/user/gpg_keys", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/gpg_keys \\\n -d '{\"armored_public_key\":\"armored_public_key\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/gpg_keys \\\n  -d '{\"armored_public_key\":\"armored_public_key\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/gpg_keys \\\n -d '{\"armored_public_key\":\"armored_public_key\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/gpg_keys \\\n  -d '{\"armored_public_key\":\"armored_public_key\"}'
    " }, { "lang": "JavaScript", @@ -60942,7 +61289,7 @@ { "verb": "get", "requestPath": "/user/gpg_keys/{gpg_key_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gpg_key_id", @@ -60958,8 +61305,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/gpg_keys/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/gpg_keys/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/gpg_keys/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/gpg_keys/42
    " }, { "lang": "JavaScript", @@ -61024,7 +61371,7 @@ { "verb": "delete", "requestPath": "/user/gpg_keys/{gpg_key_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gpg_key_id", @@ -61040,8 +61387,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/gpg_keys/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/gpg_keys/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/gpg_keys/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/gpg_keys/42
    " }, { "lang": "JavaScript", @@ -61076,7 +61423,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -61110,7 +61457,7 @@ { "verb": "get", "requestPath": "/user/installations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -61147,8 +61494,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/user/installations", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  https://api.github.com/user/installations
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n http(s)://{hostname}/api/v3/user/installations", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  http(s)://{hostname}/api/v3/user/installations
    " }, { "lang": "JavaScript", @@ -61220,7 +61567,7 @@ { "verb": "get", "requestPath": "/user/installations/{installation_id}/repositories", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -61267,8 +61614,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/user/installations/42/repositories", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  https://api.github.com/user/installations/42/repositories
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n http(s)://{hostname}/api/v3/user/installations/42/repositories", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  http(s)://{hostname}/api/v3/user/installations/42/repositories
    " }, { "lang": "JavaScript", @@ -61341,7 +61688,7 @@ { "verb": "put", "requestPath": "/user/installations/{installation_id}/repositories/{repository_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "installation_id", @@ -61366,8 +61713,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/user/installations/42/repositories/42", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  https://api.github.com/user/installations/42/repositories/42
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n http(s)://{hostname}/api/v3/user/installations/42/repositories/42", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  http(s)://{hostname}/api/v3/user/installations/42/repositories/42
    " }, { "lang": "JavaScript", @@ -61409,7 +61756,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -61433,7 +61780,7 @@ { "verb": "delete", "requestPath": "/user/installations/{installation_id}/repositories/{repository_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "installation_id", @@ -61458,8 +61805,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/user/installations/42/repositories/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  https://api.github.com/user/installations/42/repositories/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n http(s)://{hostname}/api/v3/user/installations/42/repositories/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  http(s)://{hostname}/api/v3/user/installations/42/repositories/42
    " }, { "lang": "JavaScript", @@ -61501,7 +61848,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -61525,7 +61872,7 @@ { "verb": "get", "requestPath": "/user/issues", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "filter", @@ -61539,6 +61886,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -61636,8 +61984,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/issues", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/issues
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/issues", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/issues
    " }, { "lang": "JavaScript", @@ -61696,7 +62044,7 @@ { "verb": "get", "requestPath": "/user/keys", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -61722,8 +62070,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/keys", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/keys
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/keys", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/keys
    " }, { "lang": "JavaScript", @@ -61788,13 +62136,13 @@ { "verb": "post", "requestPath": "/user/keys", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/keys \\\n -d '{\"key\":\"key\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/keys \\\n  -d '{\"key\":\"key\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/keys \\\n -d '{\"key\":\"key\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/keys \\\n  -d '{\"key\":\"key\"}'
    " }, { "lang": "JavaScript", @@ -61919,7 +62267,7 @@ { "verb": "get", "requestPath": "/user/keys/{key_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "key_id", @@ -61935,8 +62283,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/keys/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/keys/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/keys/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/keys/42
    " }, { "lang": "JavaScript", @@ -62001,7 +62349,7 @@ { "verb": "delete", "requestPath": "/user/keys/{key_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "key_id", @@ -62017,8 +62365,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/keys/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/keys/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/keys/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/keys/42
    " }, { "lang": "JavaScript", @@ -62053,7 +62401,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -62082,7 +62430,7 @@ { "verb": "get", "requestPath": "/user/memberships/orgs", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "state", @@ -62122,8 +62470,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/memberships/orgs", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/memberships/orgs
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/memberships/orgs", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/memberships/orgs
    " }, { "lang": "JavaScript", @@ -62188,7 +62536,7 @@ { "verb": "get", "requestPath": "/user/memberships/orgs/{org}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -62203,8 +62551,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/memberships/orgs/ORG", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/memberships/orgs/ORG
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/memberships/orgs/ORG", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/memberships/orgs/ORG
    " }, { "lang": "JavaScript", @@ -62259,7 +62607,7 @@ { "verb": "patch", "requestPath": "/user/memberships/orgs/{org}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -62274,8 +62622,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/memberships/orgs/ORG \\\n -d '{\"state\":\"state\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/memberships/orgs/ORG \\\n  -d '{\"state\":\"state\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/memberships/orgs/ORG \\\n -d '{\"state\":\"state\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/memberships/orgs/ORG \\\n  -d '{\"state\":\"state\"}'
    " }, { "lang": "JavaScript", @@ -62377,7 +62725,7 @@ { "verb": "get", "requestPath": "/user/orgs", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -62403,8 +62751,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/orgs", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/orgs
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/orgs", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/orgs
    " }, { "lang": "JavaScript", @@ -62462,13 +62810,13 @@ { "verb": "post", "requestPath": "/user/projects", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/user/projects \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/user/projects \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/user/projects \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/user/projects \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -62600,7 +62948,7 @@ { "verb": "get", "requestPath": "/user/public_emails", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -62626,8 +62974,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/public_emails", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/public_emails
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/public_emails", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/public_emails
    " }, { "lang": "JavaScript", @@ -62692,11 +63040,11 @@ { "verb": "get", "requestPath": "/user/repos", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "visibility", - "description": "Can be one of `all`, `public`, or `private`.", + "description": "Can be one of `all`, `public`, or `private`. Note: For GitHub AE, can be one of `all`, `internal`, or `private`.", "in": "query", "required": false, "schema": { @@ -62708,7 +63056,7 @@ ], "default": "all" }, - "descriptionHTML": "

    Can be one of all, public, or private.

    " + "descriptionHTML": "

    Can be one of all, public, or private. Note: For GitHub AE, can be one of all, internal, or private.

    " }, { "name": "affiliation", @@ -62723,7 +63071,7 @@ }, { "name": "type", - "description": "Can be one of `all`, `owner`, `public`, `private`, `member`. Default: `all` \n \nWill cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.", + "description": "Can be one of `all`, `owner`, `public`, `private`, `member`. Note: For GitHub AE, can be one of `all`, `owner`, `internal`, `private`, `member`. Default: `all` \n \nWill cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.", "in": "query", "required": false, "schema": { @@ -62737,7 +63085,7 @@ ], "default": "all" }, - "descriptionHTML": "

    Can be one of all, owner, public, private, member. Default: all

    \n

    Will cause a 422 error if used in the same request as visibility or affiliation. Will cause a 422 error if used in the same request as visibility or affiliation.

    " + "descriptionHTML": "

    Can be one of all, owner, public, private, member. Note: For GitHub AE, can be one of all, owner, internal, private, member. Default: all

    \n

    Will cause a 422 error if used in the same request as visibility or affiliation. Will cause a 422 error if used in the same request as visibility or affiliation.

    " }, { "name": "sort", @@ -62814,8 +63162,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/repos", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/repos
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/repos", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/repos
    " }, { "lang": "JavaScript", @@ -62878,13 +63226,13 @@ { "verb": "post", "requestPath": "/user/repos", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/repos \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/repos \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/repos \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/repos \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -62893,7 +63241,7 @@ } ], "summary": "Create a repository for the authenticated user", - "description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.20/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", + "description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.20/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository.", "tags": [ "repos" ], @@ -62936,13 +63284,13 @@ "childParamsGroups": [] }, "private": { - "description": "

    Whether the repository is private or public.

    ", + "description": "

    Whether the repository is private.

    ", "default": false, "type": "boolean", "name": "private", "in": "body", "rawType": "boolean", - "rawDescription": "Whether the repository is private or public.", + "rawDescription": "Whether the repository is private.", "childParamsGroups": [] }, "has_issues": { @@ -63116,7 +63464,7 @@ "category": "repos", "categoryLabel": "Repos", "notes": [], - "descriptionHTML": "

    Creates a new repository for the authenticated user.

    \n

    OAuth scope requirements

    \n

    When using OAuth, authorizations must include:

    \n
      \n
    • public_repo scope or repo scope to create a public repository
    • \n
    • repo scope to create a private repository
    • \n
    ", + "descriptionHTML": "

    Creates a new repository for the authenticated user.

    \n

    OAuth scope requirements

    \n

    When using OAuth, authorizations must include:

    \n
      \n
    • public_repo scope or repo scope to create a public repository. Note: For GitHub AE, use repo scope to create an internal repository.
    • \n
    • repo scope to create a private repository.
    • \n
    ", "bodyParameters": [ { "description": "

    Required. The name of the repository.

    ", @@ -63147,13 +63495,13 @@ "childParamsGroups": [] }, { - "description": "

    Whether the repository is private or public.

    ", + "description": "

    Whether the repository is private.

    ", "default": false, "type": "boolean", "name": "private", "in": "body", "rawType": "boolean", - "rawDescription": "Whether the repository is private or public.", + "rawDescription": "Whether the repository is private.", "childParamsGroups": [] }, { @@ -63337,7 +63685,7 @@ { "verb": "get", "requestPath": "/user/repository_invitations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -63363,8 +63711,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/repository_invitations", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/repository_invitations
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/repository_invitations", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/repository_invitations
    " }, { "lang": "JavaScript", @@ -63429,7 +63777,7 @@ { "verb": "patch", "requestPath": "/user/repository_invitations/{invitation_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "invitation_id", @@ -63445,8 +63793,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/repository_invitations/42", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/repository_invitations/42
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/repository_invitations/42", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/repository_invitations/42
    " }, { "lang": "JavaScript", @@ -63481,7 +63829,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -63510,7 +63858,7 @@ { "verb": "delete", "requestPath": "/user/repository_invitations/{invitation_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "invitation_id", @@ -63526,8 +63874,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/repository_invitations/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/repository_invitations/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/repository_invitations/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/repository_invitations/42
    " }, { "lang": "JavaScript", @@ -63562,7 +63910,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -63591,7 +63939,7 @@ { "verb": "get", "requestPath": "/user/starred", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "sort", @@ -63647,8 +63995,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/starred", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/starred
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/starred", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/starred
    " }, { "lang": "JavaScript", @@ -63708,7 +64056,7 @@ { "verb": "get", "requestPath": "/user/starred/{owner}/{repo}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -63732,8 +64080,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/starred/octocat/hello-world", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/starred/octocat/hello-world
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/starred/octocat/hello-world", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/starred/octocat/hello-world
    " }, { "lang": "JavaScript", @@ -63797,7 +64145,7 @@ { "verb": "put", "requestPath": "/user/starred/{owner}/{repo}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -63821,8 +64169,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/starred/octocat/hello-world", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/starred/octocat/hello-world
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/starred/octocat/hello-world", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/starred/octocat/hello-world
    " }, { "lang": "JavaScript", @@ -63857,7 +64205,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -63886,7 +64234,7 @@ { "verb": "delete", "requestPath": "/user/starred/{owner}/{repo}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -63910,8 +64258,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/starred/octocat/hello-world", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/starred/octocat/hello-world
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/starred/octocat/hello-world", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/starred/octocat/hello-world
    " }, { "lang": "JavaScript", @@ -63946,7 +64294,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -63975,7 +64323,7 @@ { "verb": "get", "requestPath": "/user/subscriptions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -64001,8 +64349,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/subscriptions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/subscriptions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/subscriptions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/subscriptions
    " }, { "lang": "JavaScript", @@ -64062,7 +64410,7 @@ { "verb": "get", "requestPath": "/user/teams", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -64088,8 +64436,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/teams", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/teams
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/teams", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/teams
    " }, { "lang": "JavaScript", @@ -64147,7 +64495,7 @@ { "verb": "get", "requestPath": "/users", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "since", @@ -64173,8 +64521,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users
    " }, { "lang": "JavaScript", @@ -64222,7 +64570,7 @@ { "verb": "get", "requestPath": "/users/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -64237,8 +64585,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME
    " }, { "lang": "JavaScript", @@ -64292,7 +64640,7 @@ { "verb": "get", "requestPath": "/users/{username}/events", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -64327,8 +64675,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/events", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/events
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/events", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/events
    " }, { "lang": "JavaScript", @@ -64372,7 +64720,7 @@ { "verb": "get", "requestPath": "/users/{username}/events/orgs/{org}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -64416,8 +64764,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/events/orgs/ORG", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/events/orgs/ORG
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/events/orgs/ORG", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/events/orgs/ORG
    " }, { "lang": "JavaScript", @@ -64461,7 +64809,7 @@ { "verb": "get", "requestPath": "/users/{username}/events/public", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -64496,8 +64844,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/events/public", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/events/public
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/events/public", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/events/public
    " }, { "lang": "JavaScript", @@ -64541,7 +64889,7 @@ { "verb": "get", "requestPath": "/users/{username}/followers", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -64576,8 +64924,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/followers", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/followers
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/followers", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/followers
    " }, { "lang": "JavaScript", @@ -64622,7 +64970,7 @@ { "verb": "get", "requestPath": "/users/{username}/following", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -64657,8 +65005,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/following", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/following
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/following", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/following
    " }, { "lang": "JavaScript", @@ -64703,7 +65051,7 @@ { "verb": "get", "requestPath": "/users/{username}/following/{target_user}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -64727,8 +65075,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/following/TARGET_USER", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/following/TARGET_USER
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/following/TARGET_USER", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/following/TARGET_USER
    " }, { "lang": "JavaScript", @@ -64777,7 +65125,7 @@ { "verb": "get", "requestPath": "/users/{username}/gists", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -64822,8 +65170,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/gists", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/gists
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/gists", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/gists
    " }, { "lang": "JavaScript", @@ -64871,7 +65219,7 @@ { "verb": "get", "requestPath": "/users/{username}/gpg_keys", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -64906,8 +65254,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/gpg_keys", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/gpg_keys
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/gpg_keys", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/gpg_keys
    " }, { "lang": "JavaScript", @@ -64952,7 +65300,7 @@ { "verb": "get", "requestPath": "/users/{username}/hovercard", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -64993,8 +65341,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/hovercard", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/hovercard
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/hovercard", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/hovercard
    " }, { "lang": "JavaScript", @@ -65047,7 +65395,7 @@ { "verb": "get", "requestPath": "/users/{username}/installation", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -65073,8 +65421,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/users/USERNAME/installation", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  https://api.github.com/users/USERNAME/installation
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/installation", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/installation
    " }, { "lang": "JavaScript", @@ -65123,7 +65471,7 @@ { "verb": "get", "requestPath": "/users/{username}/keys", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -65158,8 +65506,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/keys", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/keys
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/keys", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/keys
    " }, { "lang": "JavaScript", @@ -65204,7 +65552,7 @@ { "verb": "get", "requestPath": "/users/{username}/orgs", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -65239,8 +65587,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/orgs", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/orgs
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/orgs", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/orgs
    " }, { "lang": "JavaScript", @@ -65283,7 +65631,7 @@ { "verb": "get", "requestPath": "/users/{username}/projects", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -65334,8 +65682,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/users/USERNAME/projects", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/users/USERNAME/projects
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/projects", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/projects
    " }, { "lang": "JavaScript", @@ -65395,7 +65743,7 @@ { "verb": "get", "requestPath": "/users/{username}/received_events", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -65430,8 +65778,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/received_events", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/received_events
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/received_events", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/received_events
    " }, { "lang": "JavaScript", @@ -65475,7 +65823,7 @@ { "verb": "get", "requestPath": "/users/{username}/received_events/public", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -65510,8 +65858,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/received_events/public", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/received_events/public
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/received_events/public", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/received_events/public
    " }, { "lang": "JavaScript", @@ -65555,7 +65903,7 @@ { "verb": "get", "requestPath": "/users/{username}/repos", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -65637,8 +65985,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/repos", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/repos
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/repos", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/repos
    " }, { "lang": "JavaScript", @@ -65647,7 +65995,7 @@ } ], "summary": "List repositories for a user", - "description": "Lists public repositories for the specified user.", + "description": "Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user.", "tags": [ "repos" ], @@ -65675,7 +66023,7 @@ "categoryLabel": "Repos", "notes": [], "bodyParameters": [], - "descriptionHTML": "

    Lists public repositories for the specified user.

    ", + "descriptionHTML": "

    Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user.

    ", "responses": [ { "httpStatusCode": "200", @@ -65688,7 +66036,7 @@ { "verb": "put", "requestPath": "/users/{username}/site_admin", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -65703,8 +66051,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/site_admin", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/site_admin
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/site_admin", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/site_admin
    " }, { "lang": "JavaScript", @@ -65739,7 +66087,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -65748,7 +66096,7 @@ { "verb": "delete", "requestPath": "/users/{username}/site_admin", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -65763,8 +66111,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/site_admin", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/site_admin
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/site_admin", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/site_admin
    " }, { "lang": "JavaScript", @@ -65799,7 +66147,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -65808,7 +66156,7 @@ { "verb": "get", "requestPath": "/users/{username}/starred", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -65873,8 +66221,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/starred", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/starred
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/starred", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/starred
    " }, { "lang": "JavaScript", @@ -65919,7 +66267,7 @@ { "verb": "get", "requestPath": "/users/{username}/subscriptions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -65954,8 +66302,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/subscriptions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/subscriptions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/subscriptions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/subscriptions
    " }, { "lang": "JavaScript", @@ -66000,7 +66348,7 @@ { "verb": "put", "requestPath": "/users/{username}/suspended", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -66015,8 +66363,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/suspended \\\n -d '{\"reason\":\"reason\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/suspended \\\n  -d '{\"reason\":\"reason\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/suspended \\\n -d '{\"reason\":\"reason\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/suspended \\\n  -d '{\"reason\":\"reason\"}'
    " }, { "lang": "JavaScript", @@ -66071,7 +66419,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "descriptionHTML": "

    If your GitHub instance uses LDAP Sync with Active Directory LDAP servers, Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a 403 response.

    \n

    You can suspend any user account except your own.

    \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.\"

    ", @@ -66090,7 +66438,7 @@ { "verb": "delete", "requestPath": "/users/{username}/suspended", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -66105,8 +66453,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/suspended \\\n -d '{\"reason\":\"reason\"}'", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/suspended \\\n  -d '{\"reason\":\"reason\"}'
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/suspended \\\n -d '{\"reason\":\"reason\"}'", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/suspended \\\n  -d '{\"reason\":\"reason\"}'
    " }, { "lang": "JavaScript", @@ -66161,7 +66509,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "descriptionHTML": "

    If your GitHub instance uses LDAP Sync with Active Directory LDAP servers, this API is disabled and will return a 403 response. Active Directory LDAP-authenticated users cannot be unsuspended using the API.

    ", @@ -66180,13 +66528,13 @@ { "verb": "get", "requestPath": "/zen", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/zen", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/zen
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/zen", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/zen
    " }, { "lang": "JavaScript", diff --git a/lib/rest/static/decorated/ghes-2.21.json b/lib/rest/static/decorated/ghes-2.21.json index 28d3a02486..2ff02f3796 100644 --- a/lib/rest/static/decorated/ghes-2.21.json +++ b/lib/rest/static/decorated/ghes-2.21.json @@ -2,13 +2,13 @@ { "verb": "get", "requestPath": "/", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/
    " }, { "lang": "JavaScript", @@ -45,7 +45,7 @@ { "verb": "get", "requestPath": "/admin/hooks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -82,8 +82,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n https://api.github.com/admin/hooks", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  https://api.github.com/admin/hooks
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/hooks", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/hooks
    " }, { "lang": "JavaScript", @@ -135,7 +135,7 @@ { "verb": "post", "requestPath": "/admin/hooks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -152,8 +152,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n https://api.github.com/admin/hooks \\\n -d '{\"name\":\"name\",\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  https://api.github.com/admin/hooks \\\n  -d '{\"name\":\"name\",\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/hooks \\\n -d '{\"name\":\"name\",\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/hooks \\\n  -d '{\"name\":\"name\",\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'
    " }, { "lang": "JavaScript", @@ -483,7 +483,7 @@ { "verb": "get", "requestPath": "/admin/hooks/{hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -509,8 +509,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n https://api.github.com/admin/hooks/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  https://api.github.com/admin/hooks/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/hooks/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/hooks/42
    " }, { "lang": "JavaScript", @@ -562,7 +562,7 @@ { "verb": "patch", "requestPath": "/admin/hooks/{hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -588,8 +588,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n https://api.github.com/admin/hooks/42 \\\n -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  https://api.github.com/admin/hooks/42 \\\n  -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/hooks/42 \\\n -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/hooks/42 \\\n  -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'
    " }, { "lang": "JavaScript", @@ -893,7 +893,7 @@ { "verb": "delete", "requestPath": "/admin/hooks/{hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -919,8 +919,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n https://api.github.com/admin/hooks/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  https://api.github.com/admin/hooks/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/hooks/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/hooks/42
    " }, { "lang": "JavaScript", @@ -962,7 +962,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -971,7 +971,7 @@ { "verb": "post", "requestPath": "/admin/hooks/{hook_id}/pings", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -997,8 +997,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n https://api.github.com/admin/hooks/42/pings", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  https://api.github.com/admin/hooks/42/pings
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/hooks/42/pings", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/hooks/42/pings
    " }, { "lang": "JavaScript", @@ -1040,7 +1040,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -1049,7 +1049,7 @@ { "verb": "get", "requestPath": "/admin/keys", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -1070,13 +1070,53 @@ "default": 1 }, "descriptionHTML": "

    Page number of the results to fetch.

    " + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + }, + "descriptionHTML": "

    One of asc (ascending) or desc (descending).

    " + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "accessed" + ], + "default": "created" + }, + "descriptionHTML": "" + }, + { + "name": "since", + "description": "Only show public keys accessed after the given time.", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    Only show public keys accessed after the given time.

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/keys", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/keys
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/keys", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/keys
    " }, { "lang": "JavaScript", @@ -1121,7 +1161,7 @@ { "verb": "delete", "requestPath": "/admin/keys/{key_ids}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "key_ids", @@ -1136,8 +1176,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/keys/KEY_IDS", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/keys/KEY_IDS
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/keys/KEY_IDS", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/keys/KEY_IDS
    " }, { "lang": "JavaScript", @@ -1172,7 +1212,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -1181,7 +1221,7 @@ { "verb": "patch", "requestPath": "/admin/ldap/teams/{team_id}/mapping", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -1196,8 +1236,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/ldap/teams/42/mapping \\\n -d '{\"ldap_dn\":\"ldap_dn\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/ldap/teams/42/mapping \\\n  -d '{\"ldap_dn\":\"ldap_dn\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/ldap/teams/42/mapping \\\n -d '{\"ldap_dn\":\"ldap_dn\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/ldap/teams/42/mapping \\\n  -d '{\"ldap_dn\":\"ldap_dn\"}'
    " }, { "lang": "JavaScript", @@ -1275,7 +1315,7 @@ { "verb": "post", "requestPath": "/admin/ldap/teams/{team_id}/sync", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -1290,8 +1330,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/ldap/teams/42/sync", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/ldap/teams/42/sync
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/ldap/teams/42/sync", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/ldap/teams/42/sync
    " }, { "lang": "JavaScript", @@ -1336,7 +1376,7 @@ { "verb": "patch", "requestPath": "/admin/ldap/users/{username}/mapping", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -1351,8 +1391,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/ldap/users/USERNAME/mapping \\\n -d '{\"ldap_dn\":\"ldap_dn\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/ldap/users/USERNAME/mapping \\\n  -d '{\"ldap_dn\":\"ldap_dn\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/ldap/users/USERNAME/mapping \\\n -d '{\"ldap_dn\":\"ldap_dn\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/ldap/users/USERNAME/mapping \\\n  -d '{\"ldap_dn\":\"ldap_dn\"}'
    " }, { "lang": "JavaScript", @@ -1430,7 +1470,7 @@ { "verb": "post", "requestPath": "/admin/ldap/users/{username}/sync", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -1445,8 +1485,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/ldap/users/USERNAME/sync", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/ldap/users/USERNAME/sync
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/ldap/users/USERNAME/sync", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/ldap/users/USERNAME/sync
    " }, { "lang": "JavaScript", @@ -1491,13 +1531,13 @@ { "verb": "post", "requestPath": "/admin/organizations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/organizations \\\n -d '{\"login\":\"login\",\"admin\":\"admin\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/organizations \\\n  -d '{\"login\":\"login\",\"admin\":\"admin\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/organizations \\\n -d '{\"login\":\"login\",\"admin\":\"admin\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/organizations \\\n  -d '{\"login\":\"login\",\"admin\":\"admin\"}'
    " }, { "lang": "JavaScript", @@ -1617,7 +1657,7 @@ { "verb": "patch", "requestPath": "/admin/organizations/{org}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -1632,8 +1672,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/organizations/ORG \\\n -d '{\"login\":\"login\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/organizations/ORG \\\n  -d '{\"login\":\"login\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/organizations/ORG \\\n -d '{\"login\":\"login\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/organizations/ORG \\\n  -d '{\"login\":\"login\"}'
    " }, { "lang": "JavaScript", @@ -1714,7 +1754,7 @@ { "verb": "get", "requestPath": "/admin/pre-receive-environments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -1735,13 +1775,43 @@ "default": 1 }, "descriptionHTML": "

    Page number of the results to fetch.

    " + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + }, + "descriptionHTML": "

    One of asc (ascending) or desc (descending).

    " + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + }, + "descriptionHTML": "" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-environments", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/admin/pre-receive-environments
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/pre-receive-environments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/pre-receive-environments
    " }, { "lang": "JavaScript", @@ -1793,13 +1863,13 @@ { "verb": "post", "requestPath": "/admin/pre-receive-environments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-environments \\\n -d '{\"name\":\"name\",\"image_url\":\"image_url\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/admin/pre-receive-environments \\\n  -d '{\"name\":\"name\",\"image_url\":\"image_url\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/pre-receive-environments \\\n -d '{\"name\":\"name\",\"image_url\":\"image_url\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/pre-receive-environments \\\n  -d '{\"name\":\"name\",\"image_url\":\"image_url\"}'
    " }, { "lang": "JavaScript", @@ -1907,7 +1977,7 @@ { "verb": "get", "requestPath": "/admin/pre-receive-environments/{pre_receive_environment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "pre_receive_environment_id", @@ -1922,8 +1992,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-environments/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/admin/pre-receive-environments/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/pre-receive-environments/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/pre-receive-environments/42
    " }, { "lang": "JavaScript", @@ -1975,7 +2045,7 @@ { "verb": "patch", "requestPath": "/admin/pre-receive-environments/{pre_receive_environment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "pre_receive_environment_id", @@ -1990,8 +2060,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-environments/42 \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/admin/pre-receive-environments/42 \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/pre-receive-environments/42 \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/pre-receive-environments/42 \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -2097,7 +2167,7 @@ { "verb": "delete", "requestPath": "/admin/pre-receive-environments/{pre_receive_environment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "pre_receive_environment_id", @@ -2112,8 +2182,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-environments/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/admin/pre-receive-environments/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/pre-receive-environments/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/pre-receive-environments/42
    " }, { "lang": "JavaScript", @@ -2157,7 +2227,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "422", @@ -2170,7 +2240,7 @@ { "verb": "post", "requestPath": "/admin/pre-receive-environments/{pre_receive_environment_id}/downloads", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "pre_receive_environment_id", @@ -2185,8 +2255,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-environments/42/downloads", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/admin/pre-receive-environments/42/downloads
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/pre-receive-environments/42/downloads", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/pre-receive-environments/42/downloads
    " }, { "lang": "JavaScript", @@ -2244,7 +2314,7 @@ { "verb": "get", "requestPath": "/admin/pre-receive-environments/{pre_receive_environment_id}/downloads/latest", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "pre_receive_environment_id", @@ -2259,8 +2329,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-environments/42/downloads/latest", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/admin/pre-receive-environments/42/downloads/latest
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/pre-receive-environments/42/downloads/latest", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/pre-receive-environments/42/downloads/latest
    " }, { "lang": "JavaScript", @@ -2312,7 +2382,7 @@ { "verb": "get", "requestPath": "/admin/pre-receive-hooks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -2333,13 +2403,44 @@ "default": 1 }, "descriptionHTML": "

    Page number of the results to fetch.

    " + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + }, + "descriptionHTML": "

    One of asc (ascending) or desc (descending).

    " + }, + { + "name": "sort", + "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to) or `name`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + }, + "descriptionHTML": "

    One of created (when the repository was starred) or updated (when it was last pushed to) or name.

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-hooks", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/admin/pre-receive-hooks
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/pre-receive-hooks", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/pre-receive-hooks
    " }, { "lang": "JavaScript", @@ -2391,13 +2492,13 @@ { "verb": "post", "requestPath": "/admin/pre-receive-hooks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-hooks \\\n -d '{\"name\":\"name\",\"script\":\"script\",\"script_repository\":{},\"environment\":{}}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/admin/pre-receive-hooks \\\n  -d '{\"name\":\"name\",\"script\":\"script\",\"script_repository\":{},\"environment\":{}}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/pre-receive-hooks \\\n -d '{\"name\":\"name\",\"script\":\"script\",\"script_repository\":{},\"environment\":{}}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/pre-receive-hooks \\\n  -d '{\"name\":\"name\",\"script\":\"script\",\"script_repository\":{},\"environment\":{}}'
    " }, { "lang": "JavaScript", @@ -2595,7 +2696,7 @@ { "verb": "get", "requestPath": "/admin/pre-receive-hooks/{pre_receive_hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "pre_receive_hook_id", @@ -2610,8 +2711,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-hooks/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/admin/pre-receive-hooks/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/pre-receive-hooks/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/pre-receive-hooks/42
    " }, { "lang": "JavaScript", @@ -2663,7 +2764,7 @@ { "verb": "patch", "requestPath": "/admin/pre-receive-hooks/{pre_receive_hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "pre_receive_hook_id", @@ -2678,8 +2779,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-hooks/42 \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/admin/pre-receive-hooks/42 \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/pre-receive-hooks/42 \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/pre-receive-hooks/42 \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -2866,7 +2967,7 @@ { "verb": "delete", "requestPath": "/admin/pre-receive-hooks/{pre_receive_hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "pre_receive_hook_id", @@ -2881,8 +2982,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-hooks/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/admin/pre-receive-hooks/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/pre-receive-hooks/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/pre-receive-hooks/42
    " }, { "lang": "JavaScript", @@ -2924,7 +3025,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -2933,7 +3034,7 @@ { "verb": "get", "requestPath": "/admin/tokens", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -2959,8 +3060,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/tokens", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/tokens
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/tokens", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/tokens
    " }, { "lang": "JavaScript", @@ -3005,7 +3106,7 @@ { "verb": "delete", "requestPath": "/admin/tokens/{token_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "token_id", @@ -3020,8 +3121,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/tokens/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/tokens/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/tokens/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/tokens/42
    " }, { "lang": "JavaScript", @@ -3056,7 +3157,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -3065,13 +3166,13 @@ { "verb": "post", "requestPath": "/admin/users", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/users \\\n -d '{\"login\":\"login\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/users \\\n  -d '{\"login\":\"login\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/users \\\n -d '{\"login\":\"login\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/users \\\n  -d '{\"login\":\"login\"}'
    " }, { "lang": "JavaScript", @@ -3171,7 +3272,7 @@ { "verb": "patch", "requestPath": "/admin/users/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -3186,8 +3287,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/users/USERNAME \\\n -d '{\"login\":\"login\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/users/USERNAME \\\n  -d '{\"login\":\"login\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/users/USERNAME \\\n -d '{\"login\":\"login\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/users/USERNAME \\\n  -d '{\"login\":\"login\"}'
    " }, { "lang": "JavaScript", @@ -3268,7 +3369,7 @@ { "verb": "delete", "requestPath": "/admin/users/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -3283,8 +3384,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/users/USERNAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/users/USERNAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/users/USERNAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/users/USERNAME
    " }, { "lang": "JavaScript", @@ -3319,7 +3420,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -3328,7 +3429,7 @@ { "verb": "post", "requestPath": "/admin/users/{username}/authorizations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -3343,8 +3444,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/users/USERNAME/authorizations \\\n -d '{\"scopes\":[\"scopes\"]}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/users/USERNAME/authorizations \\\n  -d '{\"scopes\":[\"scopes\"]}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/users/USERNAME/authorizations \\\n -d '{\"scopes\":[\"scopes\"]}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/users/USERNAME/authorizations \\\n  -d '{\"scopes\":[\"scopes\"]}'
    " }, { "lang": "JavaScript", @@ -3425,7 +3526,7 @@ { "verb": "delete", "requestPath": "/admin/users/{username}/authorizations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -3440,8 +3541,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/users/USERNAME/authorizations", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/users/USERNAME/authorizations
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/users/USERNAME/authorizations", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/users/USERNAME/authorizations
    " }, { "lang": "JavaScript", @@ -3476,7 +3577,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -3485,13 +3586,13 @@ { "verb": "get", "requestPath": "/app", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/app", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  https://api.github.com/app
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n http(s)://{hostname}/api/v3/app", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  http(s)://{hostname}/api/v3/app
    " }, { "lang": "JavaScript", @@ -3540,7 +3641,7 @@ { "verb": "post", "requestPath": "/app-manifests/{code}/conversions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "code", @@ -3555,8 +3656,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/app-manifests/CODE/conversions", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/app-manifests/CODE/conversions
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/app-manifests/CODE/conversions", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/app-manifests/CODE/conversions
    " }, { "lang": "JavaScript", @@ -3609,7 +3710,7 @@ { "verb": "get", "requestPath": "/app/installations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -3646,8 +3747,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/app/installations", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  https://api.github.com/app/installations
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n http(s)://{hostname}/api/v3/app/installations", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  http(s)://{hostname}/api/v3/app/installations
    " }, { "lang": "JavaScript", @@ -3696,7 +3797,7 @@ { "verb": "get", "requestPath": "/app/installations/{installation_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -3723,8 +3824,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/app/installations/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  https://api.github.com/app/installations/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n http(s)://{hostname}/api/v3/app/installations/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  http(s)://{hostname}/api/v3/app/installations/42
    " }, { "lang": "JavaScript", @@ -3783,7 +3884,7 @@ { "verb": "delete", "requestPath": "/app/installations/{installation_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -3810,8 +3911,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/app/installations/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  https://api.github.com/app/installations/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n http(s)://{hostname}/api/v3/app/installations/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  http(s)://{hostname}/api/v3/app/installations/42
    " }, { "lang": "JavaScript", @@ -3850,7 +3951,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -3864,7 +3965,7 @@ { "verb": "post", "requestPath": "/app/installations/{installation_id}/access_tokens", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -3891,8 +3992,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/app/installations/42/access_tokens \\\n -d '{\"repositories\":[\"repositories\"]}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  https://api.github.com/app/installations/42/access_tokens \\\n  -d '{\"repositories\":[\"repositories\"]}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n http(s)://{hostname}/api/v3/app/installations/42/access_tokens \\\n -d '{\"repositories\":[\"repositories\"]}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  http(s)://{hostname}/api/v3/app/installations/42/access_tokens \\\n  -d '{\"repositories\":[\"repositories\"]}'
    " }, { "lang": "JavaScript", @@ -5642,7 +5743,7 @@ { "verb": "get", "requestPath": "/applications/grants", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -5663,13 +5764,23 @@ "default": 1 }, "descriptionHTML": "

    Page number of the results to fetch.

    " + }, + { + "name": "client_id", + "in": "query", + "required": false, + "description": "The client ID of your GitHub app.", + "schema": { + "type": "string" + }, + "descriptionHTML": "

    The client ID of your GitHub app.

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/grants", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/applications/grants
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/applications/grants", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/applications/grants
    " }, { "lang": "JavaScript", @@ -5735,7 +5846,7 @@ { "verb": "get", "requestPath": "/applications/grants/{grant_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "grant_id", @@ -5751,8 +5862,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/grants/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/applications/grants/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/applications/grants/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/applications/grants/42
    " }, { "lang": "JavaScript", @@ -5813,7 +5924,7 @@ { "verb": "delete", "requestPath": "/applications/grants/{grant_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "grant_id", @@ -5829,8 +5940,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/grants/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/applications/grants/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/applications/grants/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/applications/grants/42
    " }, { "lang": "JavaScript", @@ -5866,7 +5977,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -5890,7 +6001,7 @@ { "verb": "delete", "requestPath": "/applications/{client_id}/grant", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "client_id", @@ -5906,8 +6017,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/CLIENT_ID/grant \\\n -d '{\"access_token\":\"access_token\"}'", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/applications/CLIENT_ID/grant \\\n  -d '{\"access_token\":\"access_token\"}'
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/applications/CLIENT_ID/grant \\\n -d '{\"access_token\":\"access_token\"}'", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/applications/CLIENT_ID/grant \\\n  -d '{\"access_token\":\"access_token\"}'
    " }, { "lang": "JavaScript", @@ -5965,7 +6076,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "422", @@ -5989,7 +6100,7 @@ { "verb": "delete", "requestPath": "/applications/{client_id}/grants/{access_token}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "client_id", @@ -6014,8 +6125,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/CLIENT_ID/grants/ACCESS_TOKEN", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/applications/CLIENT_ID/grants/ACCESS_TOKEN
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/applications/CLIENT_ID/grants/ACCESS_TOKEN", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/applications/CLIENT_ID/grants/ACCESS_TOKEN
    " }, { "lang": "JavaScript", @@ -6053,7 +6164,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -6062,7 +6173,7 @@ { "verb": "post", "requestPath": "/applications/{client_id}/token", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "client_id", @@ -6078,8 +6189,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/CLIENT_ID/token \\\n -d '{\"access_token\":\"access_token\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/applications/CLIENT_ID/token \\\n  -d '{\"access_token\":\"access_token\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/applications/CLIENT_ID/token \\\n -d '{\"access_token\":\"access_token\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/applications/CLIENT_ID/token \\\n  -d '{\"access_token\":\"access_token\"}'
    " }, { "lang": "JavaScript", @@ -6167,7 +6278,7 @@ { "verb": "patch", "requestPath": "/applications/{client_id}/token", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "client_id", @@ -6183,8 +6294,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/CLIENT_ID/token \\\n -d '{\"access_token\":\"access_token\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/applications/CLIENT_ID/token \\\n  -d '{\"access_token\":\"access_token\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/applications/CLIENT_ID/token \\\n -d '{\"access_token\":\"access_token\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/applications/CLIENT_ID/token \\\n  -d '{\"access_token\":\"access_token\"}'
    " }, { "lang": "JavaScript", @@ -6267,7 +6378,7 @@ { "verb": "delete", "requestPath": "/applications/{client_id}/token", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "client_id", @@ -6283,8 +6394,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/CLIENT_ID/token \\\n -d '{\"access_token\":\"access_token\"}'", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/applications/CLIENT_ID/token \\\n  -d '{\"access_token\":\"access_token\"}'
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/applications/CLIENT_ID/token \\\n -d '{\"access_token\":\"access_token\"}'", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/applications/CLIENT_ID/token \\\n  -d '{\"access_token\":\"access_token\"}'
    " }, { "lang": "JavaScript", @@ -6310,14 +6421,17 @@ "properties": { "access_token": { "type": "string", - "description": "

    The OAuth access token used to authenticate to the GitHub API.

    ", + "description": "

    Required. The OAuth access token used to authenticate to the GitHub API.

    ", "name": "access_token", "in": "body", "rawType": "string", "rawDescription": "The OAuth access token used to authenticate to the GitHub API.", "childParamsGroups": [] } - } + }, + "required": [ + "access_token" + ] }, "example": { "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a" @@ -6342,7 +6456,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "422", @@ -6354,7 +6468,7 @@ "bodyParameters": [ { "type": "string", - "description": "

    The OAuth access token used to authenticate to the GitHub API.

    ", + "description": "

    Required. The OAuth access token used to authenticate to the GitHub API.

    ", "name": "access_token", "in": "body", "rawType": "string", @@ -6366,7 +6480,7 @@ { "verb": "get", "requestPath": "/applications/{client_id}/tokens/{access_token}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "client_id", @@ -6391,8 +6505,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/CLIENT_ID/tokens/ACCESS_TOKEN", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/applications/CLIENT_ID/tokens/ACCESS_TOKEN
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/applications/CLIENT_ID/tokens/ACCESS_TOKEN", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/applications/CLIENT_ID/tokens/ACCESS_TOKEN
    " }, { "lang": "JavaScript", @@ -6445,7 +6559,7 @@ { "verb": "post", "requestPath": "/applications/{client_id}/tokens/{access_token}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "client_id", @@ -6470,8 +6584,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/CLIENT_ID/tokens/ACCESS_TOKEN", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/applications/CLIENT_ID/tokens/ACCESS_TOKEN
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/applications/CLIENT_ID/tokens/ACCESS_TOKEN", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/applications/CLIENT_ID/tokens/ACCESS_TOKEN
    " }, { "lang": "JavaScript", @@ -6519,7 +6633,7 @@ { "verb": "delete", "requestPath": "/applications/{client_id}/tokens/{access_token}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "client_id", @@ -6544,8 +6658,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/CLIENT_ID/tokens/ACCESS_TOKEN", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/applications/CLIENT_ID/tokens/ACCESS_TOKEN
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/applications/CLIENT_ID/tokens/ACCESS_TOKEN", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/applications/CLIENT_ID/tokens/ACCESS_TOKEN
    " }, { "lang": "JavaScript", @@ -6583,7 +6697,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -6592,7 +6706,7 @@ { "verb": "get", "requestPath": "/apps/{app_slug}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "app_slug", @@ -6607,8 +6721,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/apps/APP_SLUG", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  https://api.github.com/apps/APP_SLUG
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n http(s)://{hostname}/api/v3/apps/APP_SLUG", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  http(s)://{hostname}/api/v3/apps/APP_SLUG
    " }, { "lang": "JavaScript", @@ -6672,7 +6786,7 @@ { "verb": "get", "requestPath": "/authorizations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -6693,13 +6807,23 @@ "default": 1 }, "descriptionHTML": "

    Page number of the results to fetch.

    " + }, + { + "name": "client_id", + "in": "query", + "required": false, + "description": "The client ID of your GitHub app.", + "schema": { + "type": "string" + }, + "descriptionHTML": "

    The client ID of your GitHub app.

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/authorizations", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/authorizations
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/authorizations", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/authorizations
    " }, { "lang": "JavaScript", @@ -6765,13 +6889,13 @@ { "verb": "post", "requestPath": "/authorizations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/authorizations \\\n -d '{\"scopes\":[\"scopes\"]}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/authorizations \\\n  -d '{\"scopes\":[\"scopes\"]}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/authorizations \\\n -d '{\"scopes\":[\"scopes\"]}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/authorizations \\\n  -d '{\"scopes\":[\"scopes\"]}'
    " }, { "lang": "JavaScript", @@ -6984,7 +7108,7 @@ { "verb": "put", "requestPath": "/authorizations/clients/{client_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "client_id", @@ -7000,8 +7124,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/authorizations/clients/CLIENT_ID \\\n -d '{\"client_secret\":\"client_secret\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/authorizations/clients/CLIENT_ID \\\n  -d '{\"client_secret\":\"client_secret\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/authorizations/clients/CLIENT_ID \\\n -d '{\"client_secret\":\"client_secret\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/authorizations/clients/CLIENT_ID \\\n  -d '{\"client_secret\":\"client_secret\"}'
    " }, { "lang": "JavaScript", @@ -7198,7 +7322,7 @@ { "verb": "put", "requestPath": "/authorizations/clients/{client_id}/{fingerprint}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "client_id", @@ -7223,8 +7347,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/authorizations/clients/CLIENT_ID/FINGERPRINT \\\n -d '{\"client_secret\":\"client_secret\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/authorizations/clients/CLIENT_ID/FINGERPRINT \\\n  -d '{\"client_secret\":\"client_secret\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/authorizations/clients/CLIENT_ID/FINGERPRINT \\\n -d '{\"client_secret\":\"client_secret\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/authorizations/clients/CLIENT_ID/FINGERPRINT \\\n  -d '{\"client_secret\":\"client_secret\"}'
    " }, { "lang": "JavaScript", @@ -7388,7 +7512,7 @@ { "verb": "get", "requestPath": "/authorizations/{authorization_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "authorization_id", @@ -7404,8 +7528,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/authorizations/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/authorizations/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/authorizations/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/authorizations/42
    " }, { "lang": "JavaScript", @@ -7466,7 +7590,7 @@ { "verb": "patch", "requestPath": "/authorizations/{authorization_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "authorization_id", @@ -7482,8 +7606,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/authorizations/42 \\\n -d '{\"scopes\":[\"scopes\"]}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/authorizations/42 \\\n  -d '{\"scopes\":[\"scopes\"]}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/authorizations/42 \\\n -d '{\"scopes\":[\"scopes\"]}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/authorizations/42 \\\n  -d '{\"scopes\":[\"scopes\"]}'
    " }, { "lang": "JavaScript", @@ -7684,7 +7808,7 @@ { "verb": "delete", "requestPath": "/authorizations/{authorization_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "authorization_id", @@ -7700,8 +7824,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/authorizations/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/authorizations/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/authorizations/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/authorizations/42
    " }, { "lang": "JavaScript", @@ -7737,7 +7861,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -7761,13 +7885,13 @@ { "verb": "get", "requestPath": "/codes_of_conduct", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.scarlet-witch-preview+json\" \\\n https://api.github.com/codes_of_conduct", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.scarlet-witch-preview+json\" \\\n  https://api.github.com/codes_of_conduct
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.scarlet-witch-preview+json\" \\\n http(s)://{hostname}/api/v3/codes_of_conduct", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.scarlet-witch-preview+json\" \\\n  http(s)://{hostname}/api/v3/codes_of_conduct
    " }, { "lang": "JavaScript", @@ -7827,7 +7951,7 @@ { "verb": "get", "requestPath": "/codes_of_conduct/{key}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "key", @@ -7842,8 +7966,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.scarlet-witch-preview+json\" \\\n https://api.github.com/codes_of_conduct/KEY", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.scarlet-witch-preview+json\" \\\n  https://api.github.com/codes_of_conduct/KEY
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.scarlet-witch-preview+json\" \\\n http(s)://{hostname}/api/v3/codes_of_conduct/KEY", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.scarlet-witch-preview+json\" \\\n  http(s)://{hostname}/api/v3/codes_of_conduct/KEY
    " }, { "lang": "JavaScript", @@ -7908,7 +8032,7 @@ { "verb": "post", "requestPath": "/content_references/{content_reference_id}/attachments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "content_reference_id", @@ -7923,8 +8047,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n https://api.github.com/content_references/42/attachments \\\n -d '{\"title\":\"title\",\"body\":\"body\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n  https://api.github.com/content_references/42/attachments \\\n  -d '{\"title\":\"title\",\"body\":\"body\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n http(s)://{hostname}/api/v3/content_references/42/attachments \\\n -d '{\"title\":\"title\",\"body\":\"body\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n  http(s)://{hostname}/api/v3/content_references/42/attachments \\\n  -d '{\"title\":\"title\",\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -8066,13 +8190,13 @@ { "verb": "get", "requestPath": "/emojis", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/emojis", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/emojis
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/emojis", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/emojis
    " }, { "lang": "JavaScript", @@ -8119,13 +8243,13 @@ { "verb": "get", "requestPath": "/enterprise/settings/license", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprise/settings/license", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprise/settings/license
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/enterprise/settings/license", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/enterprise/settings/license
    " }, { "lang": "JavaScript", @@ -8170,7 +8294,7 @@ { "verb": "get", "requestPath": "/enterprise/stats/{type}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "type", @@ -8185,8 +8309,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprise/stats/TYPE", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprise/stats/TYPE
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/enterprise/stats/TYPE", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/enterprise/stats/TYPE
    " }, { "lang": "JavaScript", @@ -8231,7 +8355,7 @@ { "verb": "get", "requestPath": "/events", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -8257,8 +8381,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/events", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/events
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/events", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/events
    " }, { "lang": "JavaScript", @@ -8317,13 +8441,13 @@ { "verb": "get", "requestPath": "/feeds", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/feeds", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/feeds
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/feeds", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/feeds
    " }, { "lang": "JavaScript", @@ -8368,7 +8492,7 @@ { "verb": "get", "requestPath": "/gists", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "since", @@ -8404,8 +8528,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists
    " }, { "lang": "JavaScript", @@ -8458,13 +8582,13 @@ { "verb": "post", "requestPath": "/gists", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists \\\n -d '{\"files\":{}}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists \\\n  -d '{\"files\":{}}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists \\\n -d '{\"files\":{}}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists \\\n  -d '{\"files\":{}}'
    " }, { "lang": "JavaScript", @@ -8662,7 +8786,7 @@ { "verb": "get", "requestPath": "/gists/public", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "since", @@ -8698,8 +8822,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/public", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/public
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/public", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/public
    " }, { "lang": "JavaScript", @@ -8757,7 +8881,7 @@ { "verb": "get", "requestPath": "/gists/starred", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "since", @@ -8793,8 +8917,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/starred", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/starred
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/starred", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/starred
    " }, { "lang": "JavaScript", @@ -8852,7 +8976,7 @@ { "verb": "get", "requestPath": "/gists/{gist_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -8868,8 +8992,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID
    " }, { "lang": "JavaScript", @@ -8927,7 +9051,7 @@ { "verb": "patch", "requestPath": "/gists/{gist_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -8943,8 +9067,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID \\\n -d '{\"description\":\"description\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID \\\n  -d '{\"description\":\"description\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID \\\n -d '{\"description\":\"description\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID \\\n  -d '{\"description\":\"description\"}'
    " }, { "lang": "JavaScript", @@ -9134,7 +9258,7 @@ { "verb": "delete", "requestPath": "/gists/{gist_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -9150,8 +9274,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID
    " }, { "lang": "JavaScript", @@ -9184,7 +9308,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -9208,7 +9332,7 @@ { "verb": "get", "requestPath": "/gists/{gist_id}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -9244,8 +9368,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/comments", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/comments
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID/comments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID/comments
    " }, { "lang": "JavaScript", @@ -9305,7 +9429,7 @@ { "verb": "post", "requestPath": "/gists/{gist_id}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -9321,8 +9445,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/comments \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/comments \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID/comments \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID/comments \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -9419,7 +9543,7 @@ { "verb": "get", "requestPath": "/gists/{gist_id}/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -9445,8 +9569,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/comments/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/comments/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID/comments/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID/comments/42
    " }, { "lang": "JavaScript", @@ -9506,7 +9630,7 @@ { "verb": "patch", "requestPath": "/gists/{gist_id}/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -9532,8 +9656,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/comments/42 \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/comments/42 \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID/comments/42 \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID/comments/42 \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -9620,7 +9744,7 @@ { "verb": "delete", "requestPath": "/gists/{gist_id}/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -9646,8 +9770,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/comments/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/comments/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID/comments/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID/comments/42
    " }, { "lang": "JavaScript", @@ -9682,7 +9806,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -9706,7 +9830,7 @@ { "verb": "get", "requestPath": "/gists/{gist_id}/commits", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -9742,8 +9866,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/commits", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/commits
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID/commits", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID/commits
    " }, { "lang": "JavaScript", @@ -9801,7 +9925,7 @@ { "verb": "get", "requestPath": "/gists/{gist_id}/forks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -9837,8 +9961,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/forks", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/forks
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID/forks", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID/forks
    " }, { "lang": "JavaScript", @@ -9896,7 +10020,7 @@ { "verb": "post", "requestPath": "/gists/{gist_id}/forks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -9912,8 +10036,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/forks", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/forks
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID/forks", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID/forks
    " }, { "lang": "JavaScript", @@ -9976,7 +10100,7 @@ { "verb": "get", "requestPath": "/gists/{gist_id}/star", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -9992,8 +10116,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/star", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/star
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID/star", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID/star
    " }, { "lang": "JavaScript", @@ -10050,7 +10174,7 @@ { "verb": "put", "requestPath": "/gists/{gist_id}/star", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -10066,8 +10190,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/star", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/star
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID/star", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID/star
    " }, { "lang": "JavaScript", @@ -10100,7 +10224,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -10124,7 +10248,7 @@ { "verb": "delete", "requestPath": "/gists/{gist_id}/star", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -10140,8 +10264,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/star", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/star
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID/star", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID/star
    " }, { "lang": "JavaScript", @@ -10174,7 +10298,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -10198,7 +10322,7 @@ { "verb": "get", "requestPath": "/gists/{gist_id}/{sha}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -10223,8 +10347,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/SHA", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/SHA
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID/SHA", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID/SHA
    " }, { "lang": "JavaScript", @@ -10282,13 +10406,13 @@ { "verb": "get", "requestPath": "/gitignore/templates", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gitignore/templates", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gitignore/templates
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gitignore/templates", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gitignore/templates
    " }, { "lang": "JavaScript", @@ -10336,7 +10460,7 @@ { "verb": "get", "requestPath": "/gitignore/templates/{name}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "name", @@ -10351,8 +10475,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gitignore/templates/NAME", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gitignore/templates/NAME
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gitignore/templates/NAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gitignore/templates/NAME
    " }, { "lang": "JavaScript", @@ -10400,7 +10524,7 @@ { "verb": "get", "requestPath": "/installation/repositories", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -10437,8 +10561,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/installation/repositories", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  https://api.github.com/installation/repositories
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n http(s)://{hostname}/api/v3/installation/repositories", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  http(s)://{hostname}/api/v3/installation/repositories
    " }, { "lang": "JavaScript", @@ -10511,13 +10635,13 @@ { "verb": "delete", "requestPath": "/installation/token", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/installation/token", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/installation/token
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/installation/token", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/installation/token
    " }, { "lang": "JavaScript", @@ -10552,7 +10676,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -10561,7 +10685,7 @@ { "verb": "get", "requestPath": "/issues", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "filter", @@ -10575,6 +10699,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -10708,8 +10833,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/issues", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/issues
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/issues", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/issues
    " }, { "lang": "JavaScript", @@ -10773,7 +10898,7 @@ { "verb": "get", "requestPath": "/licenses", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "featured", @@ -10793,13 +10918,23 @@ "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/licenses", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/licenses
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/licenses", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/licenses
    " }, { "lang": "JavaScript", @@ -10847,7 +10982,7 @@ { "verb": "get", "requestPath": "/licenses/{license}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "license", @@ -10862,8 +10997,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/licenses/LICENSE", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/licenses/LICENSE
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/licenses/LICENSE", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/licenses/LICENSE
    " }, { "lang": "JavaScript", @@ -10921,13 +11056,13 @@ { "verb": "post", "requestPath": "/markdown", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/markdown \\\n -d '{\"text\":\"text\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/markdown \\\n  -d '{\"text\":\"text\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/markdown \\\n -d '{\"text\":\"text\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/markdown \\\n  -d '{\"text\":\"text\"}'
    " }, { "lang": "JavaScript", @@ -11055,13 +11190,13 @@ { "verb": "post", "requestPath": "/markdown/raw", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/markdown/raw", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/markdown/raw
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/markdown/raw", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/markdown/raw
    " }, { "lang": "JavaScript", @@ -11122,13 +11257,13 @@ { "verb": "get", "requestPath": "/meta", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/meta", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/meta
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/meta", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/meta
    " }, { "lang": "JavaScript", @@ -11176,7 +11311,7 @@ { "verb": "get", "requestPath": "/networks/{owner}/{repo}/events", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -11220,8 +11355,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/networks/octocat/hello-world/events", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/networks/octocat/hello-world/events
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/networks/octocat/hello-world/events", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/networks/octocat/hello-world/events
    " }, { "lang": "JavaScript", @@ -11285,7 +11420,7 @@ { "verb": "get", "requestPath": "/notifications", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "all", @@ -11353,8 +11488,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/notifications", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/notifications
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/notifications", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/notifications
    " }, { "lang": "JavaScript", @@ -11419,13 +11554,13 @@ { "verb": "put", "requestPath": "/notifications", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/notifications \\\n -d '{\"last_read_at\":\"last_read_at\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/notifications \\\n  -d '{\"last_read_at\":\"last_read_at\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/notifications \\\n -d '{\"last_read_at\":\"last_read_at\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/notifications \\\n  -d '{\"last_read_at\":\"last_read_at\"}'
    " }, { "lang": "JavaScript", @@ -11539,7 +11674,7 @@ { "verb": "get", "requestPath": "/notifications/threads/{thread_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "thread_id", @@ -11555,8 +11690,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/notifications/threads/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/notifications/threads/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/notifications/threads/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/notifications/threads/42
    " }, { "lang": "JavaScript", @@ -11616,7 +11751,7 @@ { "verb": "patch", "requestPath": "/notifications/threads/{thread_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "thread_id", @@ -11632,8 +11767,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/notifications/threads/42", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/notifications/threads/42
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/notifications/threads/42", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/notifications/threads/42
    " }, { "lang": "JavaScript", @@ -11687,7 +11822,7 @@ { "verb": "get", "requestPath": "/notifications/threads/{thread_id}/subscription", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "thread_id", @@ -11703,8 +11838,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/notifications/threads/42/subscription", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/notifications/threads/42/subscription
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/notifications/threads/42/subscription", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/notifications/threads/42/subscription
    " }, { "lang": "JavaScript", @@ -11764,7 +11899,7 @@ { "verb": "put", "requestPath": "/notifications/threads/{thread_id}/subscription", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "thread_id", @@ -11780,8 +11915,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/notifications/threads/42/subscription \\\n -d '{\"ignored\":true}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/notifications/threads/42/subscription \\\n  -d '{\"ignored\":true}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/notifications/threads/42/subscription \\\n -d '{\"ignored\":true}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/notifications/threads/42/subscription \\\n  -d '{\"ignored\":true}'
    " }, { "lang": "JavaScript", @@ -11873,7 +12008,7 @@ { "verb": "delete", "requestPath": "/notifications/threads/{thread_id}/subscription", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "thread_id", @@ -11889,8 +12024,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/notifications/threads/42/subscription", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/notifications/threads/42/subscription
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/notifications/threads/42/subscription", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/notifications/threads/42/subscription
    " }, { "lang": "JavaScript", @@ -11925,7 +12060,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -11949,7 +12084,7 @@ { "verb": "get", "requestPath": "/octocat", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "s", @@ -11965,8 +12100,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/octocat", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/octocat
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/octocat", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/octocat
    " }, { "lang": "JavaScript", @@ -12003,7 +12138,7 @@ { "verb": "get", "requestPath": "/organizations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "since", @@ -12029,8 +12164,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/organizations", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/organizations
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/organizations", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/organizations
    " }, { "lang": "JavaScript", @@ -12078,7 +12213,7 @@ { "verb": "get", "requestPath": "/orgs/{org}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -12093,8 +12228,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG
    " }, { "lang": "JavaScript", @@ -12137,13 +12272,7 @@ "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "
    {\n  \"login\": \"github\",\n  \"id\": 1,\n  \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n  \"url\": \"https://api.github.com/orgs/github\",\n  \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n  \"events_url\": \"https://api.github.com/orgs/github/events\",\n  \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n  \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n  \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n  \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n  \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n  \"description\": \"A great organization\",\n  \"name\": \"github\",\n  \"company\": \"GitHub\",\n  \"blog\": \"https://github.com/blog\",\n  \"location\": \"San Francisco\",\n  \"email\": \"octocat@github.com\",\n  \"twitter_username\": \"github\",\n  \"is_verified\": true,\n  \"has_organization_projects\": true,\n  \"has_repository_projects\": true,\n  \"public_repos\": 2,\n  \"public_gists\": 1,\n  \"followers\": 20,\n  \"following\": 0,\n  \"html_url\": \"https://github.com/octocat\",\n  \"created_at\": \"2008-01-14T04:33:35Z\",\n  \"updated_at\": \"2014-03-03T18:58:10Z\",\n  \"type\": \"Organization\",\n  \"total_private_repos\": 100,\n  \"owned_private_repos\": 100,\n  \"private_gists\": 81,\n  \"disk_usage\": 10000,\n  \"collaborators\": 8,\n  \"billing_email\": \"mona@github.com\",\n  \"plan\": {\n    \"name\": \"Medium\",\n    \"space\": 400,\n    \"private_repos\": 20\n  },\n  \"default_repository_permission\": \"read\",\n  \"members_can_create_repositories\": true,\n  \"two_factor_requirement_enabled\": true,\n  \"members_allowed_repository_creation_type\": \"all\",\n  \"members_can_create_public_repositories\": false,\n  \"members_can_create_private_repositories\": false,\n  \"members_can_create_internal_repositories\": false,\n  \"members_can_create_pages\": true\n}\n
    " - }, - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response with GitHub plan information", - "payload": "
    {\n  \"login\": \"github\",\n  \"id\": 1,\n  \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n  \"url\": \"https://api.github.com/orgs/github\",\n  \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n  \"events_url\": \"https://api.github.com/orgs/github/events\",\n  \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n  \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n  \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n  \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n  \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n  \"description\": \"A great organization\",\n  \"name\": \"github\",\n  \"company\": \"GitHub\",\n  \"blog\": \"https://github.com/blog\",\n  \"location\": \"San Francisco\",\n  \"email\": \"octocat@github.com\",\n  \"twitter_username\": \"github\",\n  \"is_verified\": true,\n  \"has_organization_projects\": true,\n  \"has_repository_projects\": true,\n  \"public_repos\": 2,\n  \"public_gists\": 1,\n  \"followers\": 20,\n  \"following\": 0,\n  \"html_url\": \"https://github.com/octocat\",\n  \"created_at\": \"2008-01-14T04:33:35Z\",\n  \"updated_at\": \"2014-03-03T18:58:10Z\",\n  \"type\": \"Organization\",\n  \"plan\": {\n    \"name\": \"team\",\n    \"space\": 976562499,\n    \"private_repos\": 999999,\n    \"filled_seats\": 4,\n    \"seats\": 5\n  }\n}\n
    " + "payload": "
    {\n  \"login\": \"github\",\n  \"id\": 1,\n  \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n  \"url\": \"https://api.github.com/orgs/github\",\n  \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n  \"events_url\": \"https://api.github.com/orgs/github/events\",\n  \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n  \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n  \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n  \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n  \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n  \"description\": \"A great organization\",\n  \"name\": \"github\",\n  \"company\": \"GitHub\",\n  \"blog\": \"https://github.com/blog\",\n  \"location\": \"San Francisco\",\n  \"email\": \"octocat@github.com\",\n  \"twitter_username\": \"github\",\n  \"is_verified\": true,\n  \"has_organization_projects\": true,\n  \"has_repository_projects\": true,\n  \"public_repos\": 2,\n  \"public_gists\": 1,\n  \"followers\": 20,\n  \"following\": 0,\n  \"html_url\": \"https://github.com/octocat\",\n  \"created_at\": \"2008-01-14T04:33:35Z\",\n  \"updated_at\": \"2014-03-03T18:58:10Z\",\n  \"type\": \"Organization\",\n  \"total_private_repos\": 100,\n  \"owned_private_repos\": 100,\n  \"private_gists\": 81,\n  \"disk_usage\": 10000,\n  \"collaborators\": 8,\n  \"billing_email\": \"mona@github.com\",\n  \"plan\": {\n    \"name\": \"Medium\",\n    \"space\": 400,\n    \"private_repos\": 20,\n    \"filled_seats\": 4,\n    \"seats\": 5\n  },\n  \"default_repository_permission\": \"read\",\n  \"members_can_create_repositories\": true,\n  \"two_factor_requirement_enabled\": true,\n  \"members_allowed_repository_creation_type\": \"all\",\n  \"members_can_create_public_repositories\": false,\n  \"members_can_create_private_repositories\": false,\n  \"members_can_create_internal_repositories\": false,\n  \"members_can_create_pages\": true\n}\n
    " }, { "httpStatusCode": "404", @@ -12155,7 +12284,7 @@ { "verb": "patch", "requestPath": "/orgs/{org}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -12170,8 +12299,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG \\\n -d '{\"billing_email\":\"billing_email\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG \\\n  -d '{\"billing_email\":\"billing_email\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG \\\n -d '{\"billing_email\":\"billing_email\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG \\\n  -d '{\"billing_email\":\"billing_email\"}'
    " }, { "lang": "JavaScript", @@ -12574,7 +12703,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/events", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -12609,8 +12738,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/events", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/events
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/events", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/events
    " }, { "lang": "JavaScript", @@ -12654,7 +12783,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/hooks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -12689,8 +12818,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/hooks", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/hooks
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/hooks", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/hooks
    " }, { "lang": "JavaScript", @@ -12740,7 +12869,7 @@ { "verb": "post", "requestPath": "/orgs/{org}/hooks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -12755,8 +12884,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/hooks \\\n -d '{\"name\":\"name\",\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"username\":\"username\",\"password\":\"password\"}}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/hooks \\\n  -d '{\"name\":\"name\",\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"username\":\"username\",\"password\":\"password\"}}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/hooks \\\n -d '{\"name\":\"name\",\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"username\":\"username\",\"password\":\"password\"}}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/hooks \\\n  -d '{\"name\":\"name\",\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"username\":\"username\",\"password\":\"password\"}}'
    " }, { "lang": "JavaScript", @@ -13187,7 +13316,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/hooks/{hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -13211,8 +13340,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/hooks/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/hooks/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/hooks/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/hooks/42
    " }, { "lang": "JavaScript", @@ -13262,7 +13391,7 @@ { "verb": "patch", "requestPath": "/orgs/{org}/hooks/{hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -13286,8 +13415,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/hooks/42 \\\n -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/hooks/42 \\\n  -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/hooks/42 \\\n -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/hooks/42 \\\n  -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'
    " }, { "lang": "JavaScript", @@ -13636,7 +13765,7 @@ { "verb": "delete", "requestPath": "/orgs/{org}/hooks/{hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -13660,8 +13789,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/hooks/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/hooks/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/hooks/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/hooks/42
    " }, { "lang": "JavaScript", @@ -13696,7 +13825,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -13710,7 +13839,7 @@ { "verb": "post", "requestPath": "/orgs/{org}/hooks/{hook_id}/pings", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -13734,8 +13863,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/hooks/42/pings", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/hooks/42/pings
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/hooks/42/pings", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/hooks/42/pings
    " }, { "lang": "JavaScript", @@ -13770,7 +13899,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -13784,7 +13913,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/installation", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -13810,8 +13939,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/orgs/ORG/installation", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  https://api.github.com/orgs/ORG/installation
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/installation", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/installation
    " }, { "lang": "JavaScript", @@ -13860,7 +13989,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/installations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -13906,8 +14035,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/orgs/ORG/installations", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  https://api.github.com/orgs/ORG/installations
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/installations", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/installations
    " }, { "lang": "JavaScript", @@ -13956,7 +14085,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/issues", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -13979,6 +14108,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -14076,8 +14206,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/issues", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/issues
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/issues", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/issues
    " }, { "lang": "JavaScript", @@ -14131,7 +14261,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/members", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -14197,8 +14327,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/members", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/members
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/members", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/members
    " }, { "lang": "JavaScript", @@ -14253,7 +14383,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/members/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -14277,8 +14407,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/members/USERNAME", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/members/USERNAME
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/members/USERNAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/members/USERNAME
    " }, { "lang": "JavaScript", @@ -14332,7 +14462,7 @@ { "verb": "delete", "requestPath": "/orgs/{org}/members/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -14356,8 +14486,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/members/USERNAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/members/USERNAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/members/USERNAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/members/USERNAME
    " }, { "lang": "JavaScript", @@ -14392,7 +14522,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -14406,7 +14536,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/memberships/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -14430,8 +14560,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/memberships/USERNAME", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/memberships/USERNAME
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/memberships/USERNAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/memberships/USERNAME
    " }, { "lang": "JavaScript", @@ -14440,7 +14570,7 @@ } ], "summary": "Get organization membership for a user", - "description": "In order to get a user's membership with an organization, the authenticated user must be an organization member.", + "description": "In order to get a user's membership with an organization, the authenticated user must be an organization member. The `state` parameter in the response can be used to identify the user's membership status.", "tags": [ "orgs" ], @@ -14463,7 +14593,7 @@ "subcategoryLabel": "Members", "notes": [], "bodyParameters": [], - "descriptionHTML": "

    In order to get a user's membership with an organization, the authenticated user must be an organization member.

    ", + "descriptionHTML": "

    In order to get a user's membership with an organization, the authenticated user must be an organization member. The state parameter in the response can be used to identify the user's membership status.

    ", "responses": [ { "httpStatusCode": "200", @@ -14471,18 +14601,6 @@ "description": "Response if user has an active admin membership with organization", "payload": "
    {\n  \"url\": \"https://api.github.com/orgs/octocat/memberships/defunkt\",\n  \"state\": \"active\",\n  \"role\": \"admin\",\n  \"organization_url\": \"https://api.github.com/orgs/octocat\",\n  \"organization\": {\n    \"login\": \"github\",\n    \"id\": 1,\n    \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n    \"url\": \"https://api.github.com/orgs/github\",\n    \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n    \"events_url\": \"https://api.github.com/orgs/github/events\",\n    \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n    \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n    \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n    \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"description\": \"A great organization\"\n  },\n  \"user\": {\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
    " }, - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response if user has an active membership with organization", - "payload": "
    {\n  \"url\": \"https://api.github.com/orgs/octocat/memberships/defunkt\",\n  \"state\": \"active\",\n  \"role\": \"member\",\n  \"organization_url\": \"https://api.github.com/orgs/octocat\",\n  \"organization\": {\n    \"login\": \"github\",\n    \"id\": 1,\n    \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n    \"url\": \"https://api.github.com/orgs/github\",\n    \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n    \"events_url\": \"https://api.github.com/orgs/github/events\",\n    \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n    \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n    \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n    \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"description\": \"A great organization\"\n  },\n  \"user\": {\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
    " - }, - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response if user has a pending membership with organization", - "payload": "
    {\n  \"url\": \"https://api.github.com/orgs/invitocat/memberships/defunkt\",\n  \"state\": \"pending\",\n  \"role\": \"member\",\n  \"organization_url\": \"https://api.github.com/orgs/invitocat\",\n  \"organization\": {\n    \"login\": \"github\",\n    \"id\": 1,\n    \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n    \"url\": \"https://api.github.com/orgs/github\",\n    \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n    \"events_url\": \"https://api.github.com/orgs/github/events\",\n    \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n    \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n    \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n    \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"description\": \"A great organization\"\n  },\n  \"user\": {\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
    " - }, { "httpStatusCode": "403", "httpStatusMessage": "Forbidden", @@ -14498,7 +14616,7 @@ { "verb": "put", "requestPath": "/orgs/{org}/memberships/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -14522,8 +14640,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/memberships/USERNAME \\\n -d '{\"role\":\"role\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/memberships/USERNAME \\\n  -d '{\"role\":\"role\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/memberships/USERNAME \\\n -d '{\"role\":\"role\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/memberships/USERNAME \\\n  -d '{\"role\":\"role\"}'
    " }, { "lang": "JavaScript", @@ -14600,13 +14718,7 @@ { "httpStatusCode": "200", "httpStatusMessage": "OK", - "description": "Response if user was previously unaffiliated with organization", - "payload": "
    {\n  \"url\": \"https://api.github.com/orgs/invitocat/memberships/defunkt\",\n  \"state\": \"pending\",\n  \"role\": \"admin\",\n  \"organization_url\": \"https://api.github.com/orgs/invitocat\",\n  \"organization\": {\n    \"login\": \"github\",\n    \"id\": 1,\n    \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n    \"url\": \"https://api.github.com/orgs/github\",\n    \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n    \"events_url\": \"https://api.github.com/orgs/github/events\",\n    \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n    \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n    \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n    \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"description\": \"A great organization\"\n  },\n  \"user\": {\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
    " - }, - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response if user already had membership with organization", + "description": "Response if user has an active admin membership with organization", "payload": "
    {\n  \"url\": \"https://api.github.com/orgs/octocat/memberships/defunkt\",\n  \"state\": \"active\",\n  \"role\": \"admin\",\n  \"organization_url\": \"https://api.github.com/orgs/octocat\",\n  \"organization\": {\n    \"login\": \"github\",\n    \"id\": 1,\n    \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n    \"url\": \"https://api.github.com/orgs/github\",\n    \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n    \"events_url\": \"https://api.github.com/orgs/github/events\",\n    \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n    \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n    \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n    \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"description\": \"A great organization\"\n  },\n  \"user\": {\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
    " }, { @@ -14624,7 +14736,7 @@ { "verb": "delete", "requestPath": "/orgs/{org}/memberships/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -14648,8 +14760,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/memberships/USERNAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/memberships/USERNAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/memberships/USERNAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/memberships/USERNAME
    " }, { "lang": "JavaScript", @@ -14684,7 +14796,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -14703,7 +14815,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/outside_collaborators", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -14753,8 +14865,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/outside_collaborators", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/outside_collaborators
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/outside_collaborators", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/outside_collaborators
    " }, { "lang": "JavaScript", @@ -14799,7 +14911,7 @@ { "verb": "put", "requestPath": "/orgs/{org}/outside_collaborators/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -14823,8 +14935,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/outside_collaborators/USERNAME", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/outside_collaborators/USERNAME
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/outside_collaborators/USERNAME", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/outside_collaborators/USERNAME
    " }, { "lang": "JavaScript", @@ -14855,8 +14967,6 @@ "subcategory": "outside-collaborators", "subcategoryLabel": "Outside collaborators", "notes": [], - "bodyParameters": [], - "descriptionHTML": "

    When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"Converting an organization member to an outside collaborator\".

    ", "responses": [ { "httpStatusCode": "202", @@ -14871,26 +14981,21 @@ { "httpStatusCode": "403", "httpStatusMessage": "Forbidden", - "description": "Response if user is the last owner of the organization", - "payload": "
    {\n  \"message\": \"Cannot convert the last owner to an outside collaborator\",\n  \"documentation_url\": \"https://docs.github.com/enterprise-server@2.21/rest/reference/orgs#convert-member-to-outside-collaborator\"\n}\n
    " - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Response if user is not a member of the organization", - "payload": "
    {\n  \"message\": \"<user> is not a member of the <organization> organization.\",\n  \"documentation_url\": \"https://docs.github.com/enterprise-server@2.21/rest/reference/orgs#convert-member-to-outside-collaborator\"\n}\n
    " + "description": "Response if user is the last owner of the organization or not a member of the organization" }, { "httpStatusCode": "404", "httpStatusMessage": "Not Found", "description": "Resource not found" } - ] + ], + "bodyParameters": [], + "descriptionHTML": "

    When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"Converting an organization member to an outside collaborator\".

    " }, { "verb": "delete", "requestPath": "/orgs/{org}/outside_collaborators/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -14914,8 +15019,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/outside_collaborators/USERNAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/outside_collaborators/USERNAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/outside_collaborators/USERNAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/outside_collaborators/USERNAME
    " }, { "lang": "JavaScript", @@ -14952,7 +15057,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "422", @@ -14965,7 +15070,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/pre-receive-hooks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -14995,13 +15100,44 @@ "default": 1 }, "descriptionHTML": "

    Page number of the results to fetch.

    " + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + }, + "descriptionHTML": "

    One of asc (ascending) or desc (descending).

    " + }, + { + "name": "sort", + "description": "The sort order for the response collection.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + }, + "descriptionHTML": "

    The sort order for the response collection.

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/orgs/ORG/pre-receive-hooks", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/orgs/ORG/pre-receive-hooks
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/pre-receive-hooks", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/pre-receive-hooks
    " }, { "lang": "JavaScript", @@ -15053,7 +15189,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -15077,8 +15213,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/orgs/ORG/pre-receive-hooks/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/orgs/ORG/pre-receive-hooks/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/pre-receive-hooks/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/pre-receive-hooks/42
    " }, { "lang": "JavaScript", @@ -15130,7 +15266,7 @@ { "verb": "patch", "requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -15154,8 +15290,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/orgs/ORG/pre-receive-hooks/42 \\\n -d '{\"enforcement\":\"enforcement\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/orgs/ORG/pre-receive-hooks/42 \\\n  -d '{\"enforcement\":\"enforcement\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/pre-receive-hooks/42 \\\n -d '{\"enforcement\":\"enforcement\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/pre-receive-hooks/42 \\\n  -d '{\"enforcement\":\"enforcement\"}'
    " }, { "lang": "JavaScript", @@ -15259,7 +15395,7 @@ { "verb": "delete", "requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -15283,8 +15419,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/orgs/ORG/pre-receive-hooks/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/orgs/ORG/pre-receive-hooks/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/pre-receive-hooks/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/pre-receive-hooks/42
    " }, { "lang": "JavaScript", @@ -15336,7 +15472,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/projects", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -15387,8 +15523,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/orgs/ORG/projects", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/orgs/ORG/projects
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/projects", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/projects
    " }, { "lang": "JavaScript", @@ -15443,7 +15579,7 @@ { "verb": "post", "requestPath": "/orgs/{org}/projects", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -15458,8 +15594,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/orgs/ORG/projects \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/orgs/ORG/projects \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/projects \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/projects \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -15589,7 +15725,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/public_members", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -15624,8 +15760,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/public_members", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/public_members
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/public_members", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/public_members
    " }, { "lang": "JavaScript", @@ -15670,7 +15806,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/public_members/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -15694,8 +15830,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/public_members/USERNAME", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/public_members/USERNAME
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/public_members/USERNAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/public_members/USERNAME
    " }, { "lang": "JavaScript", @@ -15744,7 +15880,7 @@ { "verb": "put", "requestPath": "/orgs/{org}/public_members/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -15768,8 +15904,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/public_members/USERNAME", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/public_members/USERNAME
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/public_members/USERNAME", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/public_members/USERNAME
    " }, { "lang": "JavaScript", @@ -15804,7 +15940,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -15818,7 +15954,7 @@ { "verb": "delete", "requestPath": "/orgs/{org}/public_members/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -15842,8 +15978,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/public_members/USERNAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/public_members/USERNAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/public_members/USERNAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/public_members/USERNAME
    " }, { "lang": "JavaScript", @@ -15878,7 +16014,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -15887,7 +16023,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/repos", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -15900,7 +16036,7 @@ }, { "name": "type", - "description": "Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`.", + "description": "Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Note: For GitHub AE, can be one of `all`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`.", "in": "query", "required": false, "schema": { @@ -15915,7 +16051,7 @@ "internal" ] }, - "descriptionHTML": "

    Specifies the types of repositories you want returned. Can be one of all, public, private, forks, sources, member, internal. Default: all. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, type can also be internal.

    " + "descriptionHTML": "

    Specifies the types of repositories you want returned. Can be one of all, public, private, forks, sources, member, internal. Note: For GitHub AE, can be one of all, private, forks, sources, member, internal. Default: all. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, type can also be internal.

    " }, { "name": "sort", @@ -15972,8 +16108,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/repos", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/repos
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/repos", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/repos
    " }, { "lang": "JavaScript", @@ -16029,7 +16165,7 @@ { "verb": "post", "requestPath": "/orgs/{org}/repos", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -16044,8 +16180,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/repos \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/repos \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/repos \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/repos \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -16054,7 +16190,7 @@ } ], "summary": "Create an organization repository", - "description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.21/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", + "description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.21/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository", "tags": [ "repos" ], @@ -16098,17 +16234,17 @@ }, "private": { "type": "boolean", - "description": "

    Either true to create a private repository or false to create a public one.

    ", + "description": "

    Whether the repository is private.

    ", "default": false, "name": "private", "in": "body", "rawType": "boolean", - "rawDescription": "Either `true` to create a private repository or `false` to create a public one.", + "rawDescription": "Whether the repository is private.", "childParamsGroups": [] }, "visibility": { "type": "string", - "description": "

    Can be public or private. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be internal. For more information, see \"Creating an internal repository\" in the GitHub Help documentation.
    \nThe visibility parameter overrides the private parameter when you use both parameters with the nebula-preview preview header.

    ", + "description": "

    Can be public or private. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be internal. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"Creating an internal repository\" in the GitHub Help documentation.
    \nThe visibility parameter overrides the private parameter when you use both parameters with the nebula-preview preview header.

    ", "enum": [ "public", "private", @@ -16118,7 +16254,7 @@ "name": "visibility", "in": "body", "rawType": "string", - "rawDescription": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", + "rawDescription": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", "childParamsGroups": [] }, "has_issues": { @@ -16279,7 +16415,7 @@ "category": "repos", "categoryLabel": "Repos", "notes": [], - "descriptionHTML": "

    Creates a new repository in the specified organization. The authenticated user must be a member of the organization.

    \n

    OAuth scope requirements

    \n

    When using OAuth, authorizations must include:

    \n
      \n
    • public_repo scope or repo scope to create a public repository
    • \n
    • repo scope to create a private repository
    • \n
    ", + "descriptionHTML": "

    Creates a new repository in the specified organization. The authenticated user must be a member of the organization.

    \n

    OAuth scope requirements

    \n

    When using OAuth, authorizations must include:

    \n
      \n
    • public_repo scope or repo scope to create a public repository. Note: For GitHub AE, use repo scope to create an internal repository.
    • \n
    • repo scope to create a private repository
    • \n
    ", "bodyParameters": [ { "type": "string", @@ -16310,17 +16446,17 @@ }, { "type": "boolean", - "description": "

    Either true to create a private repository or false to create a public one.

    ", + "description": "

    Whether the repository is private.

    ", "default": false, "name": "private", "in": "body", "rawType": "boolean", - "rawDescription": "Either `true` to create a private repository or `false` to create a public one.", + "rawDescription": "Whether the repository is private.", "childParamsGroups": [] }, { "type": "string", - "description": "

    Can be public or private. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be internal. For more information, see \"Creating an internal repository\" in the GitHub Help documentation.
    \nThe visibility parameter overrides the private parameter when you use both parameters with the nebula-preview preview header.

    ", + "description": "

    Can be public or private. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be internal. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"Creating an internal repository\" in the GitHub Help documentation.
    \nThe visibility parameter overrides the private parameter when you use both parameters with the nebula-preview preview header.

    ", "enum": [ "public", "private", @@ -16330,7 +16466,7 @@ "name": "visibility", "in": "body", "rawType": "string", - "rawDescription": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", + "rawDescription": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", "childParamsGroups": [] }, { @@ -16473,7 +16609,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/teams", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -16508,8 +16644,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams
    " }, { "lang": "JavaScript", @@ -16557,7 +16693,7 @@ { "verb": "post", "requestPath": "/orgs/{org}/teams", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -16572,8 +16708,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -16805,7 +16941,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -16830,8 +16966,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG
    " }, { "lang": "JavaScript", @@ -16879,7 +17015,7 @@ { "verb": "patch", "requestPath": "/orgs/{org}/teams/{team_slug}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -16904,8 +17040,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -17077,7 +17213,7 @@ { "verb": "delete", "requestPath": "/orgs/{org}/teams/{team_slug}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -17102,8 +17238,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG
    " }, { "lang": "JavaScript", @@ -17136,7 +17272,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -17145,7 +17281,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -17200,13 +17336,23 @@ "default": 1 }, "descriptionHTML": "

    Page number of the results to fetch.

    " + }, + { + "name": "pinned", + "in": "query", + "required": false, + "description": "Pinned discussions only filter", + "schema": { + "type": "string" + }, + "descriptionHTML": "

    Pinned discussions only filter

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions
    " }, { "lang": "JavaScript", @@ -17258,7 +17404,7 @@ { "verb": "post", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -17283,8 +17429,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions \\\n -d '{\"title\":\"title\",\"body\":\"body\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions \\\n  -d '{\"title\":\"title\",\"body\":\"body\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions \\\n -d '{\"title\":\"title\",\"body\":\"body\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions \\\n  -d '{\"title\":\"title\",\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -17413,7 +17559,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -17447,8 +17593,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42
    " }, { "lang": "JavaScript", @@ -17500,7 +17646,7 @@ { "verb": "patch", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -17534,8 +17680,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42 \\\n -d '{\"title\":\"title\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42 \\\n  -d '{\"title\":\"title\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42 \\\n -d '{\"title\":\"title\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42 \\\n  -d '{\"title\":\"title\"}'
    " }, { "lang": "JavaScript", @@ -17638,7 +17784,7 @@ { "verb": "delete", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -17672,8 +17818,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42
    " }, { "lang": "JavaScript", @@ -17708,7 +17854,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -17717,7 +17863,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -17786,8 +17932,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments
    " }, { "lang": "JavaScript", @@ -17839,7 +17985,7 @@ { "verb": "post", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -17873,8 +18019,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -17963,7 +18109,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -18006,8 +18152,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42
    " }, { "lang": "JavaScript", @@ -18059,7 +18205,7 @@ { "verb": "patch", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -18102,8 +18248,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42 \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42 \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42 \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42 \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -18191,7 +18337,7 @@ { "verb": "delete", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -18234,8 +18380,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42
    " }, { "lang": "JavaScript", @@ -18270,7 +18416,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -18279,7 +18425,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -18362,8 +18508,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42/reactions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42/reactions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42/reactions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42/reactions
    " }, { "lang": "JavaScript", @@ -18413,7 +18559,7 @@ { "verb": "post", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -18456,8 +18602,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42/reactions \\\n -d '{\"content\":\"content\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42/reactions \\\n -d '{\"content\":\"content\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " }, { "lang": "JavaScript", @@ -18563,7 +18709,7 @@ { "verb": "delete", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -18615,8 +18761,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42/reactions/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42/reactions/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42/reactions/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42/reactions/42
    " }, { "lang": "JavaScript", @@ -18656,7 +18802,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -18665,7 +18811,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -18739,8 +18885,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/reactions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/reactions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42/reactions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42/reactions
    " }, { "lang": "JavaScript", @@ -18790,7 +18936,7 @@ { "verb": "post", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -18824,8 +18970,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/reactions \\\n -d '{\"content\":\"content\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42/reactions \\\n -d '{\"content\":\"content\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " }, { "lang": "JavaScript", @@ -18931,7 +19077,7 @@ { "verb": "delete", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -18974,8 +19120,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/reactions/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/reactions/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42/reactions/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42/reactions/42
    " }, { "lang": "JavaScript", @@ -19015,7 +19161,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -19024,7 +19170,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/members", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -19085,8 +19231,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/members", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/members
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/members", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/members
    " }, { "lang": "JavaScript", @@ -19131,7 +19277,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/memberships/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -19165,8 +19311,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/memberships/USERNAME", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/memberships/USERNAME
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/memberships/USERNAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/memberships/USERNAME
    " }, { "lang": "JavaScript", @@ -19175,7 +19321,7 @@ } ], "summary": "Get team membership for a user", - "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.\n\n**Note:** The `role` for organization owners returns as `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@2.21/rest/reference/teams#create-a-team).", + "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.\n\n**Note:**\nThe response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see see [Create a team](https://docs.github.com/enterprise-server@2.21/rest/reference/teams#create-a-team).", "tags": [ "teams" ], @@ -19198,26 +19344,14 @@ "subcategoryLabel": "Members", "notes": [], "bodyParameters": [], - "descriptionHTML": "

    Team members will include the members of child teams.

    \n

    To get a user's membership with a team, the team must be visible to the authenticated user.

    \n

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

    \n

    Note: The role for organization owners returns as maintainer. For more information about maintainer roles, see Create a team.

    ", + "descriptionHTML": "

    Team members will include the members of child teams.

    \n

    To get a user's membership with a team, the team must be visible to the authenticated user.

    \n

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

    \n

    Note:\nThe response contains the state of the membership and the member's role.

    \n

    The role for organization owners is set to maintainer. For more information about maintainer roles, see see Create a team.

    ", "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response if user has an active membership with team", - "payload": "
    {\n  \"url\": \"https://api.github.com/teams/1/memberships/octocat\",\n  \"role\": \"member\",\n  \"state\": \"active\"\n}\n
    " - }, { "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Response if user is a team maintainer", "payload": "
    {\n  \"url\": \"https://api.github.com/teams/1/memberships/octocat\",\n  \"role\": \"maintainer\",\n  \"state\": \"active\"\n}\n
    " }, - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response if user has a pending membership with team", - "payload": "
    {\n  \"url\": \"https://api.github.com/teams/1/memberships/octocat\",\n  \"role\": \"member\",\n  \"state\": \"pending\"\n}\n
    " - }, { "httpStatusCode": "404", "httpStatusMessage": "Not Found", @@ -19228,7 +19362,7 @@ { "verb": "put", "requestPath": "/orgs/{org}/teams/{team_slug}/memberships/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -19262,8 +19396,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/memberships/USERNAME \\\n -d '{\"role\":\"role\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/memberships/USERNAME \\\n  -d '{\"role\":\"role\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/memberships/USERNAME \\\n -d '{\"role\":\"role\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/memberships/USERNAME \\\n  -d '{\"role\":\"role\"}'
    " }, { "lang": "JavaScript", @@ -19337,12 +19471,6 @@ } ], "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response if user's membership with team is now active", - "payload": "
    {\n  \"url\": \"https://api.github.com/teams/1/memberships/octocat\",\n  \"role\": \"member\",\n  \"state\": \"active\"\n}\n
    " - }, { "httpStatusCode": "200", "httpStatusMessage": "OK", @@ -19357,15 +19485,14 @@ { "httpStatusCode": "422", "httpStatusMessage": "Unprocessable Entity", - "description": "Response if you attempt to add an organization to a team", - "payload": "
    {\n  \"message\": \"Cannot add an organization as a member.\",\n  \"errors\": [\n    {\n      \"code\": \"org\",\n      \"field\": \"user\",\n      \"resource\": \"TeamMember\"\n    }\n  ]\n}\n
    " + "description": "Response if you attempt to add an organization to a team" } ] }, { "verb": "delete", "requestPath": "/orgs/{org}/teams/{team_slug}/memberships/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -19399,8 +19526,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/memberships/USERNAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/memberships/USERNAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/memberships/USERNAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/memberships/USERNAME
    " }, { "lang": "JavaScript", @@ -19435,7 +19562,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -19449,7 +19576,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/projects", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -19494,8 +19621,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/projects", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/projects
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/projects", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/projects
    " }, { "lang": "JavaScript", @@ -19545,7 +19672,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/projects/{project_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -19579,8 +19706,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/projects/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/projects/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/projects/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/projects/42
    " }, { "lang": "JavaScript", @@ -19635,7 +19762,7 @@ { "verb": "put", "requestPath": "/orgs/{org}/teams/{team_slug}/projects/{project_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -19669,8 +19796,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/projects/42 \\\n -d '{\"permission\":\"permission\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/projects/42 \\\n  -d '{\"permission\":\"permission\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/projects/42 \\\n -d '{\"permission\":\"permission\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/projects/42 \\\n  -d '{\"permission\":\"permission\"}'
    " }, { "lang": "JavaScript", @@ -19753,7 +19880,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -19766,7 +19893,7 @@ { "verb": "delete", "requestPath": "/orgs/{org}/teams/{team_slug}/projects/{project_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -19800,8 +19927,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/projects/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/projects/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/projects/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/projects/42
    " }, { "lang": "JavaScript", @@ -19834,7 +19961,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -19843,7 +19970,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/repos", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -19888,8 +20015,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/repos", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/repos
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/repos", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/repos
    " }, { "lang": "JavaScript", @@ -19932,7 +20059,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -19975,8 +20102,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/repos/octocat/hello-world", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/repos/octocat/hello-world
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/repos/octocat/hello-world", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/repos/octocat/hello-world
    " }, { "lang": "JavaScript", @@ -20028,7 +20155,7 @@ { "verb": "put", "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -20071,8 +20198,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/repos/octocat/hello-world \\\n -d '{\"permission\":\"permission\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/repos/octocat/hello-world \\\n  -d '{\"permission\":\"permission\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/repos/octocat/hello-world \\\n -d '{\"permission\":\"permission\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/repos/octocat/hello-world \\\n  -d '{\"permission\":\"permission\"}'
    " }, { "lang": "JavaScript", @@ -20132,7 +20259,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "descriptionHTML": "

    To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a 422 Unprocessable Entity status if you attempt to add a repository to a team that is not owned by the organization. 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

    Note: You can also specify a team by org_id and team_id using the route PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}.

    \n

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

    ", @@ -20158,7 +20285,7 @@ { "verb": "delete", "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -20201,8 +20328,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/repos/octocat/hello-world", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/repos/octocat/hello-world
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/repos/octocat/hello-world", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/repos/octocat/hello-world
    " }, { "lang": "JavaScript", @@ -20235,7 +20362,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -20244,7 +20371,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/teams", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -20289,8 +20416,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/teams", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/teams
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/teams", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/teams
    " }, { "lang": "JavaScript", @@ -20333,7 +20460,7 @@ { "verb": "get", "requestPath": "/projects/columns/cards/{card_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "card_id", @@ -20349,8 +20476,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/cards/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/cards/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/columns/cards/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/columns/cards/42
    " }, { "lang": "JavaScript", @@ -20422,7 +20549,7 @@ { "verb": "patch", "requestPath": "/projects/columns/cards/{card_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "card_id", @@ -20438,8 +20565,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/cards/42 \\\n -d '{\"note\":\"note\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/cards/42 \\\n  -d '{\"note\":\"note\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/columns/cards/42 \\\n -d '{\"note\":\"note\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/columns/cards/42 \\\n  -d '{\"note\":\"note\"}'
    " }, { "lang": "JavaScript", @@ -20570,7 +20697,7 @@ { "verb": "delete", "requestPath": "/projects/columns/cards/{card_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "card_id", @@ -20586,8 +20713,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/cards/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/cards/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/columns/cards/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/columns/cards/42
    " }, { "lang": "JavaScript", @@ -20629,7 +20756,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -20658,7 +20785,7 @@ { "verb": "post", "requestPath": "/projects/columns/cards/{card_id}/moves", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "card_id", @@ -20674,8 +20801,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/cards/42/moves \\\n -d '{\"position\":\"position\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/cards/42/moves \\\n  -d '{\"position\":\"position\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/columns/cards/42/moves \\\n -d '{\"position\":\"position\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/columns/cards/42/moves \\\n  -d '{\"position\":\"position\"}'
    " }, { "lang": "JavaScript", @@ -20808,7 +20935,7 @@ { "verb": "get", "requestPath": "/projects/columns/{column_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "column_id", @@ -20824,8 +20951,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/columns/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/columns/42
    " }, { "lang": "JavaScript", @@ -20897,7 +21024,7 @@ { "verb": "patch", "requestPath": "/projects/columns/{column_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "column_id", @@ -20913,8 +21040,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/42 \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/42 \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/columns/42 \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/columns/42 \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -21016,7 +21143,7 @@ { "verb": "delete", "requestPath": "/projects/columns/{column_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "column_id", @@ -21032,8 +21159,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/columns/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/columns/42
    " }, { "lang": "JavaScript", @@ -21075,7 +21202,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -21099,7 +21226,7 @@ { "verb": "get", "requestPath": "/projects/columns/{column_id}/cards", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "column_id", @@ -21151,8 +21278,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/42/cards", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/42/cards
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/columns/42/cards", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/columns/42/cards
    " }, { "lang": "JavaScript", @@ -21219,7 +21346,7 @@ { "verb": "post", "requestPath": "/projects/columns/{column_id}/cards", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "column_id", @@ -21235,8 +21362,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/42/cards \\\n -d '{\"note\":\"note\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/42/cards \\\n  -d '{\"note\":\"note\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/columns/42/cards \\\n -d '{\"note\":\"note\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/columns/42/cards \\\n  -d '{\"note\":\"note\"}'
    " }, { "lang": "JavaScript", @@ -21356,7 +21483,7 @@ { "verb": "post", "requestPath": "/projects/columns/{column_id}/moves", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "column_id", @@ -21372,8 +21499,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/42/moves \\\n -d '{\"position\":\"position\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/42/moves \\\n  -d '{\"position\":\"position\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/columns/42/moves \\\n -d '{\"position\":\"position\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/columns/42/moves \\\n  -d '{\"position\":\"position\"}'
    " }, { "lang": "JavaScript", @@ -21481,7 +21608,7 @@ { "verb": "get", "requestPath": "/projects/{project_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "project_id", @@ -21496,8 +21623,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/42
    " }, { "lang": "JavaScript", @@ -21562,7 +21689,7 @@ { "verb": "patch", "requestPath": "/projects/{project_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "project_id", @@ -21577,8 +21704,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42 \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/42 \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/42 \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/42 \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -21780,7 +21907,7 @@ { "verb": "delete", "requestPath": "/projects/{project_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "project_id", @@ -21795,8 +21922,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/42
    " }, { "lang": "JavaScript", @@ -21870,7 +21997,7 @@ { "verb": "get", "requestPath": "/projects/{project_id}/collaborators", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "project_id", @@ -21921,8 +22048,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42/collaborators", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/42/collaborators
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/42/collaborators", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/42/collaborators
    " }, { "lang": "JavaScript", @@ -22004,7 +22131,7 @@ { "verb": "put", "requestPath": "/projects/{project_id}/collaborators/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "project_id", @@ -22028,8 +22155,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42/collaborators/USERNAME \\\n -d '{\"permission\":\"permission\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/42/collaborators/USERNAME \\\n  -d '{\"permission\":\"permission\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/42/collaborators/USERNAME \\\n -d '{\"permission\":\"permission\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/42/collaborators/USERNAME \\\n  -d '{\"permission\":\"permission\"}'
    " }, { "lang": "JavaScript", @@ -22098,7 +22225,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -22154,7 +22281,7 @@ { "verb": "delete", "requestPath": "/projects/{project_id}/collaborators/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "project_id", @@ -22178,8 +22305,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42/collaborators/USERNAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/42/collaborators/USERNAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/42/collaborators/USERNAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/42/collaborators/USERNAME
    " }, { "lang": "JavaScript", @@ -22221,7 +22348,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -22260,7 +22387,7 @@ { "verb": "get", "requestPath": "/projects/{project_id}/collaborators/{username}/permission", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "project_id", @@ -22284,8 +22411,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42/collaborators/USERNAME/permission", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/42/collaborators/USERNAME/permission
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/42/collaborators/USERNAME/permission", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/42/collaborators/USERNAME/permission
    " }, { "lang": "JavaScript", @@ -22367,7 +22494,7 @@ { "verb": "get", "requestPath": "/projects/{project_id}/columns", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "project_id", @@ -22402,8 +22529,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42/columns", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/42/columns
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/42/columns", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/42/columns
    " }, { "lang": "JavaScript", @@ -22470,7 +22597,7 @@ { "verb": "post", "requestPath": "/projects/{project_id}/columns", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "project_id", @@ -22485,8 +22612,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42/columns \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/42/columns \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/42/columns \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/42/columns \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -22593,13 +22720,13 @@ { "verb": "get", "requestPath": "/rate_limit", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/rate_limit", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/rate_limit
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/rate_limit", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/rate_limit
    " }, { "lang": "JavaScript", @@ -22652,7 +22779,7 @@ { "verb": "delete", "requestPath": "/reactions/{reaction_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "reaction_id", @@ -22667,8 +22794,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/reactions/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/reactions/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/reactions/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/reactions/42
    " }, { "lang": "JavaScript", @@ -22711,7 +22838,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -22745,7 +22872,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -22769,8 +22896,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world
    " }, { "lang": "JavaScript", @@ -22847,7 +22974,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -22871,8 +22998,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -23266,7 +23393,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -23290,8 +23417,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world
    " }, { "lang": "JavaScript", @@ -23326,7 +23453,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -23344,7 +23471,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/assignees", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -23388,8 +23515,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/assignees", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/assignees
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/assignees", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/assignees
    " }, { "lang": "JavaScript", @@ -23439,7 +23566,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/assignees/{assignee}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -23472,8 +23599,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/assignees/ASSIGNEE", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/assignees/ASSIGNEE
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/assignees/ASSIGNEE", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/assignees/ASSIGNEE
    " }, { "lang": "JavaScript", @@ -23522,7 +23649,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -23576,8 +23703,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches
    " }, { "lang": "JavaScript", @@ -23615,12 +23742,6 @@ "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "
    [\n  {\n    \"name\": \"master\",\n    \"commit\": {\n      \"sha\": \"c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc\",\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc\"\n    },\n    \"protected\": true\n  }\n]\n
    " - }, - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "With protection", "payload": "
    [\n  {\n    \"name\": \"master\",\n    \"commit\": {\n      \"sha\": \"c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc\",\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc\"\n    },\n    \"protected\": true,\n    \"protection\": {\n      \"enabled\": true,\n      \"required_status_checks\": {\n        \"enforcement_level\": \"non_admins\",\n        \"contexts\": [\n          \"ci-test\",\n          \"linter\"\n        ]\n      }\n    },\n    \"protection_url\": \"https://api.github.com/repos/octocat/hello-world/branches/master/protection\"\n  }\n]\n
    " }, { @@ -23633,7 +23754,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -23668,8 +23789,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH
    " }, { "lang": "JavaScript", @@ -23724,7 +23845,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -23759,8 +23880,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection
    " }, { "lang": "JavaScript", @@ -23817,7 +23938,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -23852,8 +23973,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection \\\n -d '{\"required_status_checks\":{\"strict\":true,\"contexts\":[\"contexts\"]},\"enforce_admins\":true,\"required_pull_request_reviews\":{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":42},\"restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"],\"apps\":[\"apps\"]}}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection \\\n  -d '{\"required_status_checks\":{\"strict\":true,\"contexts\":[\"contexts\"]},\"enforce_admins\":true,\"required_pull_request_reviews\":{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":42},\"restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"],\"apps\":[\"apps\"]}}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection \\\n -d '{\"required_status_checks\":{\"strict\":true,\"contexts\":[\"contexts\"]},\"enforce_admins\":true,\"required_pull_request_reviews\":{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":42},\"restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"],\"apps\":[\"apps\"]}}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection \\\n  -d '{\"required_status_checks\":{\"strict\":true,\"contexts\":[\"contexts\"]},\"enforce_admins\":true,\"required_pull_request_reviews\":{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":42},\"restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"],\"apps\":[\"apps\"]}}'
    " }, { "lang": "JavaScript", @@ -24856,7 +24977,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -24891,8 +25012,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection
    " }, { "lang": "JavaScript", @@ -24927,7 +25048,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -24941,7 +25062,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -24976,8 +25097,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins
    " }, { "lang": "JavaScript", @@ -25022,7 +25143,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -25057,8 +25178,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins
    " }, { "lang": "JavaScript", @@ -25103,7 +25224,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -25138,8 +25259,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins
    " }, { "lang": "JavaScript", @@ -25188,7 +25309,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -25223,8 +25344,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews
    " }, { "lang": "JavaScript", @@ -25275,7 +25396,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -25310,8 +25431,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews \\\n -d '{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]}}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews \\\n  -d '{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]}}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews \\\n -d '{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]}}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews \\\n  -d '{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]}}'
    " }, { "lang": "JavaScript", @@ -25581,7 +25702,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -25616,8 +25737,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews
    " }, { "lang": "JavaScript", @@ -25666,7 +25787,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -25701,8 +25822,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures
    " }, { "lang": "JavaScript", @@ -25759,7 +25880,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -25794,8 +25915,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures
    " }, { "lang": "JavaScript", @@ -25852,7 +25973,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -25887,8 +26008,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures
    " }, { "lang": "JavaScript", @@ -25944,7 +26065,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -25979,8 +26100,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks
    " }, { "lang": "JavaScript", @@ -26030,7 +26151,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -26065,8 +26186,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks \\\n -d '{\"strict\":true}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks \\\n  -d '{\"strict\":true}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks \\\n -d '{\"strict\":true}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks \\\n  -d '{\"strict\":true}'
    " }, { "lang": "JavaScript", @@ -26181,7 +26302,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -26216,8 +26337,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks
    " }, { "lang": "JavaScript", @@ -26261,7 +26382,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -26296,8 +26417,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts
    " }, { "lang": "JavaScript", @@ -26347,7 +26468,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -26382,8 +26503,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n  -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n  -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'
    " }, { "lang": "JavaScript", @@ -26488,7 +26609,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -26523,8 +26644,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n  -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n  -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'
    " }, { "lang": "JavaScript", @@ -26624,7 +26745,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -26659,8 +26780,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n  -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n  -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'
    " }, { "lang": "JavaScript", @@ -26760,7 +26881,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -26795,8 +26916,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions
    " }, { "lang": "JavaScript", @@ -26846,7 +26967,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -26881,8 +27002,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions
    " }, { "lang": "JavaScript", @@ -26926,7 +27047,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -26961,8 +27082,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps
    " }, { "lang": "JavaScript", @@ -27012,7 +27133,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -27047,8 +27168,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps \\\n -d '{\"apps\":{\"apps\":[\"apps\"]}}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps \\\n  -d '{\"apps\":{\"apps\":[\"apps\"]}}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps \\\n -d '{\"apps\":{\"apps\":[\"apps\"]}}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps \\\n  -d '{\"apps\":{\"apps\":[\"apps\"]}}'
    " }, { "lang": "JavaScript", @@ -27143,7 +27264,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -27178,8 +27299,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps \\\n -d '{\"apps\":{\"apps\":[\"apps\"]}}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps \\\n  -d '{\"apps\":{\"apps\":[\"apps\"]}}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps \\\n -d '{\"apps\":{\"apps\":[\"apps\"]}}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps \\\n  -d '{\"apps\":{\"apps\":[\"apps\"]}}'
    " }, { "lang": "JavaScript", @@ -27274,7 +27395,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -27309,8 +27430,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps \\\n -d '{\"apps\":{\"apps\":[\"apps\"]}}'", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps \\\n  -d '{\"apps\":{\"apps\":[\"apps\"]}}'
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps \\\n -d '{\"apps\":{\"apps\":[\"apps\"]}}'", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps \\\n  -d '{\"apps\":{\"apps\":[\"apps\"]}}'
    " }, { "lang": "JavaScript", @@ -27405,7 +27526,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -27440,8 +27561,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams
    " }, { "lang": "JavaScript", @@ -27491,7 +27612,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -27526,8 +27647,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n -d '{\"teams\":{\"teams\":[\"teams\"]}}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n  -d '{\"teams\":{\"teams\":[\"teams\"]}}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n -d '{\"teams\":{\"teams\":[\"teams\"]}}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n  -d '{\"teams\":{\"teams\":[\"teams\"]}}'
    " }, { "lang": "JavaScript", @@ -27622,7 +27743,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -27657,8 +27778,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n -d '{\"teams\":{\"teams\":[\"teams\"]}}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n  -d '{\"teams\":{\"teams\":[\"teams\"]}}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n -d '{\"teams\":{\"teams\":[\"teams\"]}}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n  -d '{\"teams\":{\"teams\":[\"teams\"]}}'
    " }, { "lang": "JavaScript", @@ -27753,7 +27874,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -27788,8 +27909,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n -d '{\"teams\":{\"teams\":[\"teams\"]}}'", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n  -d '{\"teams\":{\"teams\":[\"teams\"]}}'
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n -d '{\"teams\":{\"teams\":[\"teams\"]}}'", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n  -d '{\"teams\":{\"teams\":[\"teams\"]}}'
    " }, { "lang": "JavaScript", @@ -27884,7 +28005,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -27919,8 +28040,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users
    " }, { "lang": "JavaScript", @@ -27970,7 +28091,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -28005,8 +28126,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n -d '{\"users\":{\"users\":[\"users\"]}}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n  -d '{\"users\":{\"users\":[\"users\"]}}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n -d '{\"users\":{\"users\":[\"users\"]}}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n  -d '{\"users\":{\"users\":[\"users\"]}}'
    " }, { "lang": "JavaScript", @@ -28101,7 +28222,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -28136,8 +28257,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n -d '{\"users\":{\"users\":[\"users\"]}}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n  -d '{\"users\":{\"users\":[\"users\"]}}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n -d '{\"users\":{\"users\":[\"users\"]}}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n  -d '{\"users\":{\"users\":[\"users\"]}}'
    " }, { "lang": "JavaScript", @@ -28232,7 +28353,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -28267,8 +28388,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n -d '{\"users\":{\"users\":[\"users\"]}}'", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n  -d '{\"users\":{\"users\":[\"users\"]}}'
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n -d '{\"users\":{\"users\":[\"users\"]}}'", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n  -d '{\"users\":{\"users\":[\"users\"]}}'
    " }, { "lang": "JavaScript", @@ -28363,7 +28484,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/check-runs", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -28387,8 +28508,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-runs \\\n -d '{\"name\":\"name\",\"head_sha\":\"head_sha\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/check-runs \\\n  -d '{\"name\":\"name\",\"head_sha\":\"head_sha\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-runs \\\n -d '{\"name\":\"name\",\"head_sha\":\"head_sha\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-runs \\\n  -d '{\"name\":\"name\",\"head_sha\":\"head_sha\"}'
    " }, { "lang": "JavaScript", @@ -29365,7 +29486,7 @@ "name", "head_sha" ], - "anyOf": [ + "oneOf": [ { "properties": { "status": { @@ -29375,6 +29496,7 @@ } }, "required": [ + "status", "conclusion" ], "additionalProperties": true @@ -29394,7 +29516,7 @@ }, "examples": { "example-of-in-progress-conclusion": { - "summary": "Example of in_progress conclusion", + "summary": "Response for in_progress conclusion", "value": { "name": "mighty_readme", "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -29409,7 +29531,7 @@ } }, "example-of-completed-conclusion": { - "summary": "Example of completed conclusion", + "summary": "Response for completed conclusion", "value": { "name": "mighty_readme", "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -29483,12 +29605,6 @@ "notes": [], "descriptionHTML": "

    Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

    \n

    Creates a new check run for a specific commit in a repository. Your GitHub App must have the checks:write permission to create check runs.

    \n

    In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.

    ", "responses": [ - { - "httpStatusCode": "201", - "httpStatusMessage": "Created", - "description": "Response for in_progress conclusion", - "payload": "
    {\n  \"id\": 4,\n  \"head_sha\": \"ce587453ced02b1526dfb4cb910479d431683101\",\n  \"node_id\": \"MDg6Q2hlY2tSdW40\",\n  \"external_id\": \"42\",\n  \"url\": \"https://api.github.com/repos/github/hello-world/check-runs/4\",\n  \"html_url\": \"https://github.com/github/hello-world/runs/4\",\n  \"details_url\": \"https://example.com\",\n  \"status\": \"in_progress\",\n  \"conclusion\": \"neutral\",\n  \"started_at\": \"2018-05-04T01:14:52Z\",\n  \"completed_at\": null,\n  \"output\": {\n    \"title\": \"Mighty Readme Report\",\n    \"summary\": \"\",\n    \"text\": \"\",\n    \"annotations_count\": 1,\n    \"annotations_url\": \"https://api.github.com/repos/github/hello-world/check-runs/4/annotations\"\n  },\n  \"name\": \"mighty_readme\",\n  \"check_suite\": {\n    \"id\": 5\n  },\n  \"app\": {\n    \"id\": 1,\n    \"slug\": \"octoapp\",\n    \"node_id\": \"MDExOkludGVncmF0aW9uMQ==\",\n    \"owner\": {\n      \"login\": \"github\",\n      \"id\": 1,\n      \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n      \"url\": \"https://api.github.com/orgs/github\",\n      \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n      \"events_url\": \"https://api.github.com/orgs/github/events\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\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      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": true\n    },\n    \"name\": \"Octocat App\",\n    \"description\": \"\",\n    \"external_url\": \"https://example.com\",\n    \"html_url\": \"https://github.com/apps/octoapp\",\n    \"created_at\": \"2017-07-08T16:18:44-04:00\",\n    \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n    \"permissions\": {\n      \"metadata\": \"read\",\n      \"contents\": \"read\",\n      \"issues\": \"write\",\n      \"single_file\": \"write\"\n    },\n    \"events\": [\n      \"push\",\n      \"pull_request\"\n    ]\n  },\n  \"pull_requests\": [\n    {\n      \"url\": \"https://api.github.com/repos/github/hello-world/pulls/1\",\n      \"id\": 1934,\n      \"number\": 3956,\n      \"head\": {\n        \"ref\": \"say-hello\",\n        \"sha\": \"3dca65fa3e8d4b3da3f3d056c59aee1c50f41390\",\n        \"repo\": {\n          \"id\": 526,\n          \"url\": \"https://api.github.com/repos/github/hello-world\",\n          \"name\": \"hello-world\"\n        }\n      },\n      \"base\": {\n        \"ref\": \"master\",\n        \"sha\": \"e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f\",\n        \"repo\": {\n          \"id\": 526,\n          \"url\": \"https://api.github.com/repos/github/hello-world\",\n          \"name\": \"hello-world\"\n        }\n      }\n    }\n  ]\n}\n
    " - }, { "httpStatusCode": "201", "httpStatusMessage": "Created", @@ -30450,7 +30566,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/check-runs/{check_run_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -30484,8 +30600,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-runs/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/check-runs/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-runs/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-runs/42
    " }, { "lang": "JavaScript", @@ -30537,7 +30653,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/check-runs/{check_run_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -30571,8 +30687,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-runs/42 \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/check-runs/42 \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-runs/42 \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-runs/42 \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -32574,7 +32690,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/check-runs/{check_run_id}/annotations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -32628,8 +32744,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-runs/42/annotations", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/check-runs/42/annotations
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-runs/42/annotations", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-runs/42/annotations
    " }, { "lang": "JavaScript", @@ -32681,7 +32797,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/check-suites", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -32705,8 +32821,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-suites \\\n -d '{\"head_sha\":\"head_sha\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/check-suites \\\n  -d '{\"head_sha\":\"head_sha\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-suites \\\n -d '{\"head_sha\":\"head_sha\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-suites \\\n  -d '{\"head_sha\":\"head_sha\"}'
    " }, { "lang": "JavaScript", @@ -32794,7 +32910,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/check-suites/preferences", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -32818,8 +32934,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-suites/preferences \\\n -d '{\"auto_trigger_checks\":[{\"app_id\":42,\"setting\":true}]}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/check-suites/preferences \\\n  -d '{\"auto_trigger_checks\":[{\"app_id\":42,\"setting\":true}]}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-suites/preferences \\\n -d '{\"auto_trigger_checks\":[{\"app_id\":42,\"setting\":true}]}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-suites/preferences \\\n  -d '{\"auto_trigger_checks\":[{\"app_id\":42,\"setting\":true}]}'
    " }, { "lang": "JavaScript", @@ -33019,7 +33135,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/check-suites/{check_suite_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -33053,8 +33169,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-suites/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/check-suites/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-suites/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-suites/42
    " }, { "lang": "JavaScript", @@ -33106,7 +33222,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -33200,8 +33316,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-suites/42/check-runs", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/check-suites/42/check-runs
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-suites/42/check-runs", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-suites/42/check-runs
    " }, { "lang": "JavaScript", @@ -33253,7 +33369,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -33287,8 +33403,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-suites/42/rerequest", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/check-suites/42/rerequest
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-suites/42/rerequest", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-suites/42/rerequest
    " }, { "lang": "JavaScript", @@ -33339,7 +33455,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/collaborators", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -33399,8 +33515,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/collaborators", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/collaborators
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/collaborators", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/collaborators
    " }, { "lang": "JavaScript", @@ -33450,7 +33566,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -33483,8 +33599,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/collaborators/USERNAME", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/collaborators/USERNAME
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/collaborators/USERNAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/collaborators/USERNAME
    " }, { "lang": "JavaScript", @@ -33533,7 +33649,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -33566,8 +33682,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/collaborators/USERNAME \\\n -d '{\"permission\":\"permission\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/collaborators/USERNAME \\\n  -d '{\"permission\":\"permission\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/collaborators/USERNAME \\\n -d '{\"permission\":\"permission\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/collaborators/USERNAME \\\n  -d '{\"permission\":\"permission\"}'
    " }, { "lang": "JavaScript", @@ -33692,7 +33808,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -33725,8 +33841,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/collaborators/USERNAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/collaborators/USERNAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/collaborators/USERNAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/collaborators/USERNAME
    " }, { "lang": "JavaScript", @@ -33761,7 +33877,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -33770,7 +33886,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/collaborators/{username}/permission", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -33803,8 +33919,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/collaborators/USERNAME/permission", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/collaborators/USERNAME/permission
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/collaborators/USERNAME/permission", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/collaborators/USERNAME/permission
    " }, { "lang": "JavaScript", @@ -33854,7 +33970,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -33898,8 +34014,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/comments", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/comments
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/comments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/comments
    " }, { "lang": "JavaScript", @@ -33951,7 +34067,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -33985,8 +34101,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/comments/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/comments/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/comments/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/comments/42
    " }, { "lang": "JavaScript", @@ -34043,7 +34159,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -34077,8 +34193,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/comments/42 \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/comments/42 \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/comments/42 \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/comments/42 \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -34164,7 +34280,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -34198,8 +34314,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/comments/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/comments/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/comments/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/comments/42
    " }, { "lang": "JavaScript", @@ -34234,7 +34350,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -34248,7 +34364,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -34322,8 +34438,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/comments/42/reactions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/comments/42/reactions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/comments/42/reactions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/comments/42/reactions
    " }, { "lang": "JavaScript", @@ -34383,7 +34499,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -34417,8 +34533,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/comments/42/reactions \\\n -d '{\"content\":\"content\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/comments/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/comments/42/reactions \\\n -d '{\"content\":\"content\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/comments/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " }, { "lang": "JavaScript", @@ -34540,7 +34656,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -34583,8 +34699,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/comments/42/reactions/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/comments/42/reactions/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/comments/42/reactions/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/comments/42/reactions/42
    " }, { "lang": "JavaScript", @@ -34624,7 +34740,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -34633,7 +34749,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/commits", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -34722,13 +34838,35 @@ "default": 1 }, "descriptionHTML": "

    Page number of the results to fetch.

    " + }, + { + "name": "top", + "description": "legacy parameter for pagination.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    legacy parameter for pagination.

    " + }, + { + "name": "last_sha", + "description": "legacy parameter for pagination.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    legacy parameter for pagination.

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/commits
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits
    " }, { "lang": "JavaScript", @@ -34793,7 +34931,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -34828,8 +34966,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.groot-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits/COMMIT_SHA/branches-where-head", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.groot-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/commits/COMMIT_SHA/branches-where-head
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.groot-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/COMMIT_SHA/branches-where-head", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.groot-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/COMMIT_SHA/branches-where-head
    " }, { "lang": "JavaScript", @@ -34891,7 +35029,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -34946,8 +35084,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits/COMMIT_SHA/comments", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/commits/COMMIT_SHA/comments
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/COMMIT_SHA/comments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/COMMIT_SHA/comments
    " }, { "lang": "JavaScript", @@ -34999,7 +35137,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -35034,8 +35172,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits/COMMIT_SHA/comments \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/commits/COMMIT_SHA/comments \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/COMMIT_SHA/comments \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/COMMIT_SHA/comments \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -35184,7 +35322,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/pulls", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -35239,8 +35377,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.groot-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits/COMMIT_SHA/pulls", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.groot-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/commits/COMMIT_SHA/pulls
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.groot-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/COMMIT_SHA/pulls", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.groot-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/COMMIT_SHA/pulls
    " }, { "lang": "JavaScript", @@ -35297,7 +35435,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/commits/{ref}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -35317,23 +35455,43 @@ }, "descriptionHTML": "" }, + { + "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.

    " + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "descriptionHTML": "

    Results per page (max 100).

    " + }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    ref+ parameter

    " + "descriptionHTML": "

    ref parameter

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits/REF", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/commits/REF
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/REF", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/REF
    " }, { "lang": "JavaScript", @@ -35393,7 +35551,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/commits/{ref}/check-runs", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -35415,14 +35573,14 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    ref+ parameter

    " + "descriptionHTML": "

    ref parameter

    " }, { "name": "check_name", @@ -35483,13 +35641,22 @@ "default": 1 }, "descriptionHTML": "

    Page number of the results to fetch.

    " + }, + { + "name": "app_id", + "in": "query", + "required": false, + "schema": { + "type": "integer" + }, + "descriptionHTML": "" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits/REF/check-runs", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/commits/REF/check-runs
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/REF/check-runs", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/REF/check-runs
    " }, { "lang": "JavaScript", @@ -35541,7 +35708,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/commits/{ref}/check-suites", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -35563,14 +35730,14 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    ref+ parameter

    " + "descriptionHTML": "

    ref parameter

    " }, { "name": "app_id", @@ -35617,8 +35784,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits/REF/check-suites", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/commits/REF/check-suites
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/REF/check-suites", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/REF/check-suites
    " }, { "lang": "JavaScript", @@ -35670,7 +35837,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/commits/{ref}/status", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -35692,21 +35859,41 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    ref+ parameter

    " + "descriptionHTML": "

    ref parameter

    " + }, + { + "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/repos/octocat/hello-world/commits/REF/status", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/commits/REF/status
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/REF/status", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/REF/status
    " }, { "lang": "JavaScript", @@ -35756,7 +35943,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/commits/{ref}/statuses", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -35778,14 +35965,14 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    ref+ parameter

    " + "descriptionHTML": "

    ref parameter

    " }, { "name": "per_page", @@ -35811,8 +35998,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits/REF/statuses", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/commits/REF/statuses
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/REF/statuses", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/REF/statuses
    " }, { "lang": "JavaScript", @@ -35862,7 +36049,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/compare/{base}...{head}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -35904,8 +36091,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/compare/BASE...HEAD", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/compare/BASE...HEAD
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/compare/BASE...HEAD", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/compare/BASE...HEAD
    " }, { "lang": "JavaScript", @@ -35960,7 +36147,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/contents/{path}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -35982,14 +36169,14 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    path+ parameter

    " + "descriptionHTML": "

    path parameter

    " }, { "name": "ref", @@ -36005,8 +36192,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/contents/PATH", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/contents/PATH
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/contents/PATH", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/contents/PATH
    " }, { "lang": "JavaScript", @@ -36084,7 +36271,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/contents/{path}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -36106,21 +36293,21 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    path+ parameter

    " + "descriptionHTML": "

    path parameter

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/contents/PATH \\\n -d '{\"message\":\"message\",\"content\":\"content\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/contents/PATH \\\n  -d '{\"message\":\"message\",\"content\":\"content\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/contents/PATH \\\n -d '{\"message\":\"message\",\"content\":\"content\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/contents/PATH \\\n  -d '{\"message\":\"message\",\"content\":\"content\"}'
    " }, { "lang": "JavaScript", @@ -36607,7 +36794,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/contents/{path}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -36629,21 +36816,21 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    path+ parameter

    " + "descriptionHTML": "

    path parameter

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/contents/PATH \\\n -d '{\"message\":\"message\",\"sha\":\"sha\"}'", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/contents/PATH \\\n  -d '{\"message\":\"message\",\"sha\":\"sha\"}'
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/contents/PATH \\\n -d '{\"message\":\"message\",\"sha\":\"sha\"}'", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/contents/PATH \\\n  -d '{\"message\":\"message\",\"sha\":\"sha\"}'
    " }, { "lang": "JavaScript", @@ -37006,7 +37193,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/contributors", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -37060,8 +37247,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/contributors", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/contributors
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/contributors", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/contributors
    " }, { "lang": "JavaScript", @@ -37119,7 +37306,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/deployments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -37179,7 +37366,8 @@ "required": false, "schema": { "type": "string", - "default": "none" + "default": "none", + "nullable": true }, "descriptionHTML": "

    The name of the environment that was deployed to (e.g., staging or production).

    " }, @@ -37207,8 +37395,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/deployments", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/deployments
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/deployments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/deployments
    " }, { "lang": "JavaScript", @@ -37260,7 +37448,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/deployments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -37284,8 +37472,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/deployments \\\n -d '{\"ref\":\"ref\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/deployments \\\n  -d '{\"ref\":\"ref\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/deployments \\\n -d '{\"ref\":\"ref\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/deployments \\\n  -d '{\"ref\":\"ref\"}'
    " }, { "lang": "JavaScript", @@ -37584,12 +37772,6 @@ "description": "Simple example", "payload": "
    {\n  \"url\": \"https://api.github.com/repos/octocat/example/deployments/1\",\n  \"id\": 1,\n  \"node_id\": \"MDEwOkRlcGxveW1lbnQx\",\n  \"sha\": \"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\n  \"ref\": \"topic-branch\",\n  \"task\": \"deploy\",\n  \"payload\": {},\n  \"original_environment\": \"staging\",\n  \"environment\": \"production\",\n  \"description\": \"Deploy request from hubot\",\n  \"creator\": {\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  \"created_at\": \"2012-07-20T01:19:13Z\",\n  \"updated_at\": \"2012-07-20T01:19:13Z\",\n  \"statuses_url\": \"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/example\",\n  \"transient_environment\": false,\n  \"production_environment\": true\n}\n
    " }, - { - "httpStatusCode": "201", - "httpStatusMessage": "Created", - "description": "Advanced example", - "payload": "
    {\n  \"url\": \"https://api.github.com/repos/octocat/example/deployments/1\",\n  \"id\": 1,\n  \"node_id\": \"MDEwOkRlcGxveW1lbnQx\",\n  \"sha\": \"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\n  \"ref\": \"topic-branch\",\n  \"task\": \"deploy\",\n  \"payload\": {},\n  \"original_environment\": \"staging\",\n  \"environment\": \"production\",\n  \"description\": \"Deploy request from hubot\",\n  \"creator\": {\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  \"created_at\": \"2012-07-20T01:19:13Z\",\n  \"updated_at\": \"2012-07-20T01:19:13Z\",\n  \"statuses_url\": \"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/example\",\n  \"transient_environment\": false,\n  \"production_environment\": true\n}\n
    " - }, { "httpStatusCode": "202", "httpStatusMessage": "Accepted", @@ -37599,14 +37781,7 @@ { "httpStatusCode": "409", "httpStatusMessage": "Conflict", - "description": "Merge conflict response", - "payload": "
    {\n  \"message\": \"Conflict merging master into topic-branch\"\n}\n
    " - }, - { - "httpStatusCode": "409", - "httpStatusMessage": "Conflict", - "description": "Failed commit status checks", - "payload": "
    {\n  \"message\": \"Conflict: Commit status checks failed for topic-branch.\"\n}\n
    " + "description": "Response when there is a merge conflict or the commit s status checks failed" }, { "httpStatusCode": "422", @@ -37618,7 +37793,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -37652,8 +37827,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/deployments/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/deployments/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/deployments/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/deployments/42
    " }, { "lang": "JavaScript", @@ -37716,7 +37891,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -37750,8 +37925,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/deployments/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/deployments/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/deployments/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/deployments/42
    " }, { "lang": "JavaScript", @@ -37786,7 +37961,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -37805,7 +37980,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -37859,8 +38034,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/deployments/42/statuses", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/deployments/42/statuses
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/deployments/42/statuses", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/deployments/42/statuses
    " }, { "lang": "JavaScript", @@ -37923,7 +38098,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -37957,8 +38132,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/deployments/42/statuses \\\n -d '{\"state\":\"state\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/deployments/42/statuses \\\n  -d '{\"state\":\"state\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/deployments/42/statuses \\\n -d '{\"state\":\"state\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/deployments/42/statuses \\\n  -d '{\"state\":\"state\"}'
    " }, { "lang": "JavaScript", @@ -38204,7 +38379,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -38247,8 +38422,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/deployments/42/statuses/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/deployments/42/statuses/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/deployments/42/statuses/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/deployments/42/statuses/42
    " }, { "lang": "JavaScript", @@ -38322,7 +38497,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/dispatches", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -38346,8 +38521,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/dispatches \\\n -d '{\"event_type\":\"event_type\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/dispatches \\\n  -d '{\"event_type\":\"event_type\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/dispatches \\\n -d '{\"event_type\":\"event_type\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/dispatches \\\n  -d '{\"event_type\":\"event_type\"}'
    " }, { "lang": "JavaScript", @@ -38420,7 +38595,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "422", @@ -38454,7 +38629,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/events", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -38498,8 +38673,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/events", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/events
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/events", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/events
    " }, { "lang": "JavaScript", @@ -38543,7 +38718,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/forks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -38573,7 +38748,8 @@ "enum": [ "newest", "oldest", - "stargazers" + "stargazers", + "watchers" ], "default": "newest" }, @@ -38598,13 +38774,35 @@ "default": 1 }, "descriptionHTML": "

    Page number of the results to fetch.

    " + }, + { + "name": "org", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    legacy query parameter for specifying the org.

    " + }, + { + "name": "organization", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    legacy query parameter for specifying the org.

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/forks", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/forks
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/forks", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/forks
    " }, { "lang": "JavaScript", @@ -38654,7 +38852,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/forks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -38673,13 +38871,35 @@ "type": "string" }, "descriptionHTML": "" + }, + { + "name": "org", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    legacy query parameter for specifying the org.

    " + }, + { + "name": "organization", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    legacy query parameter for specifying the org.

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/forks \\\n -d '{\"organization\":\"organization\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/forks \\\n  -d '{\"organization\":\"organization\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/forks \\\n -d '{\"organization\":\"organization\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/forks \\\n  -d '{\"organization\":\"organization\"}'
    " }, { "lang": "JavaScript", @@ -38702,6 +38922,7 @@ "application/json": { "schema": { "type": "object", + "nullable": true, "properties": { "organization": { "type": "string", @@ -38774,7 +38995,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/git/blobs", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -38798,8 +39019,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/blobs \\\n -d '{\"content\":\"content\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/blobs \\\n  -d '{\"content\":\"content\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/blobs \\\n -d '{\"content\":\"content\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/blobs \\\n  -d '{\"content\":\"content\"}'
    " }, { "lang": "JavaScript", @@ -38921,7 +39142,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/git/blobs/{file_sha}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -38954,8 +39175,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/blobs/FILE_SHA", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/blobs/FILE_SHA
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/blobs/FILE_SHA", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/blobs/FILE_SHA
    " }, { "lang": "JavaScript", @@ -39015,7 +39236,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/git/commits", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -39039,8 +39260,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/commits \\\n -d '{\"message\":\"message\",\"tree\":\"tree\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/commits \\\n  -d '{\"message\":\"message\",\"tree\":\"tree\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/commits \\\n -d '{\"message\":\"message\",\"tree\":\"tree\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/commits \\\n  -d '{\"message\":\"message\",\"tree\":\"tree\"}'
    " }, { "lang": "JavaScript", @@ -39494,7 +39715,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/git/commits/{commit_sha}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -39529,8 +39750,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/commits/COMMIT_SHA", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/commits/COMMIT_SHA
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/commits/COMMIT_SHA", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/commits/COMMIT_SHA
    " }, { "lang": "JavaScript", @@ -39580,7 +39801,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/git/matching-refs/{ref}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -39602,14 +39823,14 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    ref+ parameter

    " + "descriptionHTML": "

    ref parameter

    " }, { "name": "per_page", @@ -39635,8 +39856,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/matching-refs/REF", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/matching-refs/REF
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/matching-refs/REF", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/matching-refs/REF
    " }, { "lang": "JavaScript", @@ -39681,7 +39902,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/git/ref/{ref}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -39703,21 +39924,21 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    ref+ parameter

    " + "descriptionHTML": "

    ref parameter

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/ref/REF", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/ref/REF
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/ref/REF", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/ref/REF
    " }, { "lang": "JavaScript", @@ -39767,7 +39988,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/git/refs", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -39791,8 +40012,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/refs \\\n -d '{\"ref\":\"ref\",\"sha\":\"sha\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/refs \\\n  -d '{\"ref\":\"ref\",\"sha\":\"sha\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/refs \\\n -d '{\"ref\":\"ref\",\"sha\":\"sha\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/refs \\\n  -d '{\"ref\":\"ref\",\"sha\":\"sha\"}'
    " }, { "lang": "JavaScript", @@ -39916,7 +40137,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/git/refs/{ref}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -39938,21 +40159,21 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    ref+ parameter

    " + "descriptionHTML": "

    ref parameter

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/refs/REF \\\n -d '{\"sha\":\"sha\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/refs/REF \\\n  -d '{\"sha\":\"sha\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/refs/REF \\\n -d '{\"sha\":\"sha\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/refs/REF \\\n  -d '{\"sha\":\"sha\"}'
    " }, { "lang": "JavaScript", @@ -40059,7 +40280,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/git/refs/{ref}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -40081,21 +40302,21 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    ref+ parameter

    " + "descriptionHTML": "

    ref parameter

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/refs/REF", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/refs/REF
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/refs/REF", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/refs/REF
    " }, { "lang": "JavaScript", @@ -40130,7 +40351,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "422", @@ -40144,7 +40365,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/git/tags", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -40168,8 +40389,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/tags \\\n -d '{\"tag\":\"tag\",\"message\":\"message\",\"object\":\"object\",\"type\":\"type\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/tags \\\n  -d '{\"tag\":\"tag\",\"message\":\"message\",\"object\":\"object\",\"type\":\"type\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/tags \\\n -d '{\"tag\":\"tag\",\"message\":\"message\",\"object\":\"object\",\"type\":\"type\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/tags \\\n  -d '{\"tag\":\"tag\",\"message\":\"message\",\"object\":\"object\",\"type\":\"type\"}'
    " }, { "lang": "JavaScript", @@ -40476,7 +40697,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/git/tags/{tag_sha}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -40509,8 +40730,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/tags/TAG_SHA", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/tags/TAG_SHA
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/tags/TAG_SHA", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/tags/TAG_SHA
    " }, { "lang": "JavaScript", @@ -40560,7 +40781,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/git/trees", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -40584,8 +40805,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/trees \\\n -d '{\"tree\":[{\"path\":\"path\",\"mode\":\"mode\",\"type\":\"type\",\"sha\":\"sha\",\"content\":\"content\"}]}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/trees \\\n  -d '{\"tree\":[{\"path\":\"path\",\"mode\":\"mode\",\"type\":\"type\",\"sha\":\"sha\",\"content\":\"content\"}]}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/trees \\\n -d '{\"tree\":[{\"path\":\"path\",\"mode\":\"mode\",\"type\":\"type\",\"sha\":\"sha\",\"content\":\"content\"}]}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/trees \\\n  -d '{\"tree\":[{\"path\":\"path\",\"mode\":\"mode\",\"type\":\"type\",\"sha\":\"sha\",\"content\":\"content\"}]}'
    " }, { "lang": "JavaScript", @@ -40965,7 +41186,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/git/trees/{tree_sha}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -40992,6 +41213,7 @@ "schema": { "type": "string" }, + "x-multi-segment": true, "descriptionHTML": "" }, { @@ -41008,8 +41230,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/trees/TREE_SHA", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/trees/TREE_SHA
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/trees/TREE_SHA", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/trees/TREE_SHA
    " }, { "lang": "JavaScript", @@ -41070,7 +41292,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/hooks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -41114,8 +41336,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/hooks", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/hooks
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks
    " }, { "lang": "JavaScript", @@ -41165,7 +41387,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/hooks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -41189,8 +41411,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/hooks \\\n -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"token\":\"token\",\"digest\":\"digest\"}}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/hooks \\\n  -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"token\":\"token\",\"digest\":\"digest\"}}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks \\\n -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"token\":\"token\",\"digest\":\"digest\"}}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks \\\n  -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"token\":\"token\",\"digest\":\"digest\"}}'
    " }, { "lang": "JavaScript", @@ -41626,7 +41848,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -41659,8 +41881,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/hooks/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/hooks/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks/42
    " }, { "lang": "JavaScript", @@ -41710,7 +41932,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -41743,8 +41965,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/hooks/42 \\\n -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"address\":\"address\",\"room\":\"room\"}}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/hooks/42 \\\n  -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"address\":\"address\",\"room\":\"room\"}}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks/42 \\\n -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"address\":\"address\",\"room\":\"room\"}}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks/42 \\\n  -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"address\":\"address\",\"room\":\"room\"}}'
    " }, { "lang": "JavaScript", @@ -42195,7 +42417,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -42228,8 +42450,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/hooks/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/hooks/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks/42
    " }, { "lang": "JavaScript", @@ -42264,7 +42486,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -42278,7 +42500,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}/pings", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -42311,8 +42533,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/hooks/42/pings", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/hooks/42/pings
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks/42/pings", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks/42/pings
    " }, { "lang": "JavaScript", @@ -42347,7 +42569,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -42361,7 +42583,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}/tests", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -42394,8 +42616,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/hooks/42/tests", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/hooks/42/tests
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks/42/tests", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks/42/tests
    " }, { "lang": "JavaScript", @@ -42430,7 +42652,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -42444,7 +42666,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/installation", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -42479,8 +42701,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/installation", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/installation
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/installation", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/installation
    " }, { "lang": "JavaScript", @@ -42539,7 +42761,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/invitations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -42583,8 +42805,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/invitations", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/invitations
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/invitations", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/invitations
    " }, { "lang": "JavaScript", @@ -42629,7 +42851,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/invitations/{invitation_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -42663,8 +42885,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/invitations/42 \\\n -d '{\"permissions\":\"permissions\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/invitations/42 \\\n  -d '{\"permissions\":\"permissions\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/invitations/42 \\\n -d '{\"permissions\":\"permissions\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/invitations/42 \\\n  -d '{\"permissions\":\"permissions\"}'
    " }, { "lang": "JavaScript", @@ -42753,7 +42975,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/invitations/{invitation_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -42787,8 +43009,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/invitations/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/invitations/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/invitations/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/invitations/42
    " }, { "lang": "JavaScript", @@ -42823,7 +43045,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -42832,7 +43054,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -42983,8 +43205,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues
    " }, { "lang": "JavaScript", @@ -43048,7 +43270,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/issues", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -43072,8 +43294,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues \\\n -d '{\"title\":\"title\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues \\\n  -d '{\"title\":\"title\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues \\\n -d '{\"title\":\"title\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues \\\n  -d '{\"title\":\"title\"}'
    " }, { "lang": "JavaScript", @@ -43364,7 +43586,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -43447,8 +43669,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/comments", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/comments
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/comments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/comments
    " }, { "lang": "JavaScript", @@ -43510,7 +43732,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -43544,8 +43766,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/comments/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/comments/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/comments/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/comments/42
    " }, { "lang": "JavaScript", @@ -43602,7 +43824,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -43636,8 +43858,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/comments/42 \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/comments/42 \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/comments/42 \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/comments/42 \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -43723,7 +43945,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -43757,8 +43979,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/comments/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/comments/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/comments/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/comments/42
    " }, { "lang": "JavaScript", @@ -43793,7 +44015,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -43802,7 +44024,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -43876,8 +44098,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/comments/42/reactions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/comments/42/reactions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/comments/42/reactions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/comments/42/reactions
    " }, { "lang": "JavaScript", @@ -43937,7 +44159,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -43971,8 +44193,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/comments/42/reactions \\\n -d '{\"content\":\"content\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/comments/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/comments/42/reactions \\\n -d '{\"content\":\"content\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/comments/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " }, { "lang": "JavaScript", @@ -44094,7 +44316,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -44137,8 +44359,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/comments/42/reactions/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/comments/42/reactions/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/comments/42/reactions/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/comments/42/reactions/42
    " }, { "lang": "JavaScript", @@ -44178,7 +44400,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -44187,7 +44409,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/events", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -44231,8 +44453,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/events", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/events
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/events", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/events
    " }, { "lang": "JavaScript", @@ -44295,7 +44517,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/events/{event_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -44328,8 +44550,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/events/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/events/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/events/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/events/42
    " }, { "lang": "JavaScript", @@ -44408,7 +44630,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -44442,8 +44664,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42
    " }, { "lang": "JavaScript", @@ -44513,7 +44735,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -44547,8 +44769,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42 \\\n -d '{\"title\":\"title\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42 \\\n  -d '{\"title\":\"title\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42 \\\n -d '{\"title\":\"title\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42 \\\n  -d '{\"title\":\"title\"}'
    " }, { "lang": "JavaScript", @@ -44873,7 +45095,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/assignees", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -44907,8 +45129,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/assignees \\\n -d '{\"assignees\":[\"assignees\"]}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/assignees \\\n  -d '{\"assignees\":[\"assignees\"]}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/assignees \\\n -d '{\"assignees\":[\"assignees\"]}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/assignees \\\n  -d '{\"assignees\":[\"assignees\"]}'
    " }, { "lang": "JavaScript", @@ -44995,7 +45217,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/assignees", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -45029,8 +45251,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/assignees \\\n -d '{\"assignees\":[\"assignees\"]}'", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/assignees \\\n  -d '{\"assignees\":[\"assignees\"]}'
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/assignees \\\n -d '{\"assignees\":[\"assignees\"]}'", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/assignees \\\n  -d '{\"assignees\":[\"assignees\"]}'
    " }, { "lang": "JavaScript", @@ -45117,7 +45339,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -45181,8 +45403,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/comments", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/comments
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/comments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/comments
    " }, { "lang": "JavaScript", @@ -45244,7 +45466,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -45278,8 +45500,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/comments \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/comments \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/comments \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/comments \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -45381,7 +45603,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/events", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -45435,8 +45657,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/events", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/events
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/events", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/events
    " }, { "lang": "JavaScript", @@ -45499,7 +45721,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -45553,8 +45775,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/labels", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/labels
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/labels", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/labels
    " }, { "lang": "JavaScript", @@ -45604,7 +45826,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -45638,8 +45860,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/labels \\\n -d '{\"labels\":[\"labels\"]}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/labels \\\n  -d '{\"labels\":[\"labels\"]}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/labels \\\n -d '{\"labels\":[\"labels\"]}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/labels \\\n  -d '{\"labels\":[\"labels\"]}'
    " }, { "lang": "JavaScript", @@ -45739,7 +45961,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -45773,8 +45995,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/labels \\\n -d '{\"labels\":[\"labels\"]}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/labels \\\n  -d '{\"labels\":[\"labels\"]}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/labels \\\n -d '{\"labels\":[\"labels\"]}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/labels \\\n  -d '{\"labels\":[\"labels\"]}'
    " }, { "lang": "JavaScript", @@ -45871,7 +46093,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -45905,8 +46127,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/labels", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/labels
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/labels", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/labels
    " }, { "lang": "JavaScript", @@ -45941,7 +46163,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "410", @@ -45955,7 +46177,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels/{name}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -45998,8 +46220,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/labels/NAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/labels/NAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/labels/NAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/labels/NAME
    " }, { "lang": "JavaScript", @@ -46054,7 +46276,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/lock", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -46088,8 +46310,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/lock \\\n -d '{\"lock_reason\":\"lock_reason\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/lock \\\n  -d '{\"lock_reason\":\"lock_reason\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/lock \\\n -d '{\"lock_reason\":\"lock_reason\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/lock \\\n  -d '{\"lock_reason\":\"lock_reason\"}'
    " }, { "lang": "JavaScript", @@ -46155,7 +46377,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -46200,7 +46422,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/lock", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -46234,8 +46456,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/lock", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/lock
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/lock", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/lock
    " }, { "lang": "JavaScript", @@ -46268,7 +46490,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -46287,7 +46509,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -46361,8 +46583,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/reactions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/reactions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/reactions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/reactions
    " }, { "lang": "JavaScript", @@ -46427,7 +46649,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -46461,8 +46683,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/reactions \\\n -d '{\"content\":\"content\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/reactions \\\n -d '{\"content\":\"content\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " }, { "lang": "JavaScript", @@ -46578,7 +46800,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -46621,8 +46843,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/reactions/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/reactions/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/reactions/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/reactions/42
    " }, { "lang": "JavaScript", @@ -46662,7 +46884,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -46671,7 +46893,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/timeline", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -46725,8 +46947,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.mockingbird-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/timeline", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.mockingbird-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/timeline
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.mockingbird-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/timeline", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.mockingbird-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/timeline
    " }, { "lang": "JavaScript", @@ -46799,7 +47021,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/keys", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -46843,8 +47065,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/keys", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/keys
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/keys", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/keys
    " }, { "lang": "JavaScript", @@ -46889,7 +47111,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/keys", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -46913,8 +47135,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/keys \\\n -d '{\"key\":\"key\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/keys \\\n  -d '{\"key\":\"key\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/keys \\\n -d '{\"key\":\"key\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/keys \\\n  -d '{\"key\":\"key\"}'
    " }, { "lang": "JavaScript", @@ -47038,7 +47260,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/keys/{key_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -47072,8 +47294,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/keys/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/keys/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/keys/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/keys/42
    " }, { "lang": "JavaScript", @@ -47123,7 +47345,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/keys/{key_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -47157,8 +47379,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/keys/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/keys/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/keys/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/keys/42
    " }, { "lang": "JavaScript", @@ -47193,7 +47415,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -47202,7 +47424,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/labels", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -47246,8 +47468,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/labels", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/labels
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/labels", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/labels
    " }, { "lang": "JavaScript", @@ -47297,7 +47519,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/labels", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -47321,8 +47543,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/labels \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/labels \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/labels \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/labels \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -47451,7 +47673,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/labels/{name}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -47484,8 +47706,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/labels/NAME", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/labels/NAME
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/labels/NAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/labels/NAME
    " }, { "lang": "JavaScript", @@ -47535,7 +47757,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/labels/{name}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -47568,8 +47790,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/labels/NAME \\\n -d '{\"new_name\":\"new_name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/labels/NAME \\\n  -d '{\"new_name\":\"new_name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/labels/NAME \\\n -d '{\"new_name\":\"new_name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/labels/NAME \\\n  -d '{\"new_name\":\"new_name\"}'
    " }, { "lang": "JavaScript", @@ -47685,7 +47907,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/labels/{name}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -47718,8 +47940,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/labels/NAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/labels/NAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/labels/NAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/labels/NAME
    " }, { "lang": "JavaScript", @@ -47754,7 +47976,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -47763,7 +47985,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/languages", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -47787,8 +48009,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/languages", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/languages
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/languages", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/languages
    " }, { "lang": "JavaScript", @@ -47831,7 +48053,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/license", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -47855,8 +48077,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/license", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/license
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/license", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/license
    " }, { "lang": "JavaScript", @@ -47899,7 +48121,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/merges", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -47923,8 +48145,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/merges \\\n -d '{\"base\":\"base\",\"head\":\"head\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/merges \\\n  -d '{\"base\":\"base\",\"head\":\"head\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/merges \\\n -d '{\"base\":\"base\",\"head\":\"head\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/merges \\\n  -d '{\"base\":\"base\",\"head\":\"head\"}'
    " }, { "lang": "JavaScript", @@ -48047,20 +48269,12 @@ { "httpStatusCode": "404", "httpStatusMessage": "Not Found", - "description": "Missing base response", - "payload": "
    {\n  \"message\": \"Base does not exist\"\n}\n
    " - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Missing head response", - "payload": "
    {\n  \"message\": \"Head does not exist\"\n}\n
    " + "description": "Response when the base or head does not exist" }, { "httpStatusCode": "409", "httpStatusMessage": "Conflict", - "description": "Merge conflict response", - "payload": "
    {\n  \"message\": \"Merge Conflict\"\n}\n
    " + "description": "Response when there is a merge conflict" }, { "httpStatusCode": "422", @@ -48072,7 +48286,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/milestones", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -48162,8 +48376,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/milestones", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/milestones
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/milestones", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/milestones
    " }, { "lang": "JavaScript", @@ -48213,7 +48427,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/milestones", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -48237,8 +48451,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/milestones \\\n -d '{\"title\":\"title\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/milestones \\\n  -d '{\"title\":\"title\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/milestones \\\n -d '{\"title\":\"title\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/milestones \\\n  -d '{\"title\":\"title\"}'
    " }, { "lang": "JavaScript", @@ -48396,7 +48610,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/milestones/{milestone_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -48430,8 +48644,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/milestones/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/milestones/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/milestones/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/milestones/42
    " }, { "lang": "JavaScript", @@ -48481,7 +48695,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/milestones/{milestone_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -48515,8 +48729,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/milestones/42 \\\n -d '{\"title\":\"title\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/milestones/42 \\\n  -d '{\"title\":\"title\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/milestones/42 \\\n -d '{\"title\":\"title\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/milestones/42 \\\n  -d '{\"title\":\"title\"}'
    " }, { "lang": "JavaScript", @@ -48661,7 +48875,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/milestones/{milestone_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -48695,8 +48909,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/milestones/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/milestones/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/milestones/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/milestones/42
    " }, { "lang": "JavaScript", @@ -48731,7 +48945,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -48745,7 +48959,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/milestones/{milestone_number}/labels", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -48799,8 +49013,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/milestones/42/labels", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/milestones/42/labels
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/milestones/42/labels", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/milestones/42/labels
    " }, { "lang": "JavaScript", @@ -48845,7 +49059,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/notifications", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -48931,8 +49145,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/notifications", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/notifications
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/notifications", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/notifications
    " }, { "lang": "JavaScript", @@ -48977,7 +49191,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/notifications", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -49001,8 +49215,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/notifications \\\n -d '{\"last_read_at\":\"last_read_at\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/notifications \\\n  -d '{\"last_read_at\":\"last_read_at\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/notifications \\\n -d '{\"last_read_at\":\"last_read_at\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/notifications \\\n  -d '{\"last_read_at\":\"last_read_at\"}'
    " }, { "lang": "JavaScript", @@ -49076,7 +49290,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pages", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -49100,8 +49314,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pages
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages
    " }, { "lang": "JavaScript", @@ -49151,7 +49365,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/pages", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -49175,8 +49389,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages \\\n -d '{\"source\":{\"branch\":\"branch\",\"path\":\"path\"}}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pages \\\n  -d '{\"source\":{\"branch\":\"branch\",\"path\":\"path\"}}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages \\\n -d '{\"source\":{\"branch\":\"branch\",\"path\":\"path\"}}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages \\\n  -d '{\"source\":{\"branch\":\"branch\",\"path\":\"path\"}}'
    " }, { "lang": "JavaScript", @@ -49417,7 +49631,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/pages", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -49441,8 +49655,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages \\\n -d '{\"public\":true}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pages \\\n  -d '{\"public\":true}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages \\\n -d '{\"public\":true}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages \\\n  -d '{\"public\":true}'
    " }, { "lang": "JavaScript", @@ -49547,7 +49761,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "400", @@ -49623,7 +49837,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/pages", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -49647,8 +49861,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pages
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages
    " }, { "lang": "JavaScript", @@ -49690,7 +49904,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -49714,7 +49928,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pages/builds", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -49758,8 +49972,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages/builds", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pages/builds
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages/builds", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages/builds
    " }, { "lang": "JavaScript", @@ -49804,7 +50018,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/pages/builds", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -49828,8 +50042,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages/builds", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pages/builds
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages/builds", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages/builds
    " }, { "lang": "JavaScript", @@ -49874,7 +50088,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pages/builds/latest", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -49898,8 +50112,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages/builds/latest", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pages/builds/latest
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages/builds/latest", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages/builds/latest
    " }, { "lang": "JavaScript", @@ -49944,7 +50158,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pages/builds/{build_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -49977,8 +50191,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages/builds/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pages/builds/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages/builds/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages/builds/42
    " }, { "lang": "JavaScript", @@ -50023,7 +50237,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -50062,13 +50276,43 @@ "default": 1 }, "descriptionHTML": "

    Page number of the results to fetch.

    " + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + }, + "descriptionHTML": "

    One of asc (ascending) or desc (descending).

    " + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + }, + "descriptionHTML": "" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pre-receive-hooks", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pre-receive-hooks
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pre-receive-hooks", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pre-receive-hooks
    " }, { "lang": "JavaScript", @@ -50120,7 +50364,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -50153,8 +50397,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pre-receive-hooks/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pre-receive-hooks/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pre-receive-hooks/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pre-receive-hooks/42
    " }, { "lang": "JavaScript", @@ -50206,7 +50450,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -50239,8 +50483,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pre-receive-hooks/42 \\\n -d '{\"enforcement\":\"enforcement\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pre-receive-hooks/42 \\\n  -d '{\"enforcement\":\"enforcement\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pre-receive-hooks/42 \\\n -d '{\"enforcement\":\"enforcement\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pre-receive-hooks/42 \\\n  -d '{\"enforcement\":\"enforcement\"}'
    " }, { "lang": "JavaScript", @@ -50325,7 +50569,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -50358,8 +50602,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pre-receive-hooks/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pre-receive-hooks/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pre-receive-hooks/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pre-receive-hooks/42
    " }, { "lang": "JavaScript", @@ -50411,7 +50655,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/projects", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -50471,8 +50715,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/projects", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/projects
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/projects", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/projects
    " }, { "lang": "JavaScript", @@ -50547,7 +50791,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/projects", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -50571,8 +50815,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/projects \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/projects \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/projects \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/projects \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -50702,7 +50946,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -50813,8 +51057,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls
    " }, { "lang": "JavaScript", @@ -50873,7 +51117,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/pulls", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -50897,8 +51141,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls \\\n -d '{\"head\":\"head\",\"base\":\"base\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls \\\n  -d '{\"head\":\"head\",\"base\":\"base\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls \\\n -d '{\"head\":\"head\",\"base\":\"base\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls \\\n  -d '{\"head\":\"head\",\"base\":\"base\"}'
    " }, { "lang": "JavaScript", @@ -51106,7 +51350,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -51128,18 +51372,17 @@ }, { "name": "sort", - "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to).", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "created", - "updated" - ], - "default": "created" + "updated", + "created_at" + ] }, - "descriptionHTML": "

    One of created (when the repository was starred) or updated (when it was last pushed to).

    " + "descriptionHTML": "" }, { "name": "direction", @@ -51189,8 +51432,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/comments", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/comments
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/comments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/comments
    " }, { "lang": "JavaScript", @@ -51248,7 +51491,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -51282,8 +51525,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/comments/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/comments/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/comments/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/comments/42
    " }, { "lang": "JavaScript", @@ -51346,7 +51589,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -51380,8 +51623,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/comments/42 \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/comments/42 \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/comments/42 \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/comments/42 \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -51469,7 +51712,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -51503,8 +51746,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/comments/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/comments/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/comments/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/comments/42
    " }, { "lang": "JavaScript", @@ -51539,7 +51782,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -51553,7 +51796,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -51627,8 +51870,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/comments/42/reactions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/comments/42/reactions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/comments/42/reactions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/comments/42/reactions
    " }, { "lang": "JavaScript", @@ -51688,7 +51931,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -51722,8 +51965,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/comments/42/reactions \\\n -d '{\"content\":\"content\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/comments/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/comments/42/reactions \\\n -d '{\"content\":\"content\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/comments/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " }, { "lang": "JavaScript", @@ -51845,7 +52088,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -51888,8 +52131,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/comments/42/reactions/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/comments/42/reactions/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/comments/42/reactions/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/comments/42/reactions/42
    " }, { "lang": "JavaScript", @@ -51929,7 +52172,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -51938,7 +52181,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -51971,8 +52214,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42
    " }, { "lang": "JavaScript", @@ -52030,7 +52273,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -52063,8 +52306,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42 \\\n -d '{\"title\":\"title\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42 \\\n  -d '{\"title\":\"title\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42 \\\n -d '{\"title\":\"title\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42 \\\n  -d '{\"title\":\"title\"}'
    " }, { "lang": "JavaScript", @@ -52239,7 +52482,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -52331,8 +52574,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/comments", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/comments
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/comments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/comments
    " }, { "lang": "JavaScript", @@ -52390,7 +52633,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -52423,8 +52666,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/comments \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/comments \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/comments \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/comments \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -52706,7 +52949,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -52749,8 +52992,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/comments/42/replies \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/comments/42/replies \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/comments/42/replies \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/comments/42/replies \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -52837,7 +53080,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/commits", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -52890,8 +53133,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/commits", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/commits
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/commits", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/commits
    " }, { "lang": "JavaScript", @@ -52934,7 +53177,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/files", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -52987,8 +53230,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/files", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/files
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/files", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/files
    " }, { "lang": "JavaScript", @@ -53041,7 +53284,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/merge", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -53074,8 +53317,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/merge", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/merge
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/merge", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/merge
    " }, { "lang": "JavaScript", @@ -53122,7 +53365,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/merge", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -53155,8 +53398,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/merge \\\n -d '{\"commit_title\":\"commit_title\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/merge \\\n  -d '{\"commit_title\":\"commit_title\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/merge \\\n -d '{\"commit_title\":\"commit_title\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/merge \\\n  -d '{\"commit_title\":\"commit_title\"}'
    " }, { "lang": "JavaScript", @@ -53322,7 +53565,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -53375,8 +53618,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/requested_reviewers", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/requested_reviewers
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/requested_reviewers", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/requested_reviewers
    " }, { "lang": "JavaScript", @@ -53421,7 +53664,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -53454,8 +53697,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/requested_reviewers \\\n -d '{\"reviewers\":[\"reviewers\"]}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/requested_reviewers \\\n  -d '{\"reviewers\":[\"reviewers\"]}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/requested_reviewers \\\n -d '{\"reviewers\":[\"reviewers\"]}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/requested_reviewers \\\n  -d '{\"reviewers\":[\"reviewers\"]}'
    " }, { "lang": "JavaScript", @@ -53593,7 +53836,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -53626,8 +53869,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/requested_reviewers \\\n -d '{\"reviewers\":[\"reviewers\"]}'", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/requested_reviewers \\\n  -d '{\"reviewers\":[\"reviewers\"]}'
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/requested_reviewers \\\n -d '{\"reviewers\":[\"reviewers\"]}'", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/requested_reviewers \\\n  -d '{\"reviewers\":[\"reviewers\"]}'
    " }, { "lang": "JavaScript", @@ -53749,7 +53992,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -53802,8 +54045,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/reviews
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews
    " }, { "lang": "JavaScript", @@ -53848,7 +54091,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -53881,8 +54124,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews \\\n -d '{\"commit_id\":\"commit_id\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/reviews \\\n  -d '{\"commit_id\":\"commit_id\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews \\\n -d '{\"commit_id\":\"commit_id\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews \\\n  -d '{\"commit_id\":\"commit_id\"}'
    " }, { "lang": "JavaScript", @@ -54330,7 +54573,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -54373,8 +54616,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews/42
    " }, { "lang": "JavaScript", @@ -54424,7 +54667,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -54467,8 +54710,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42 \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42 \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews/42 \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews/42 \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -54554,7 +54797,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -54597,8 +54840,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews/42
    " }, { "lang": "JavaScript", @@ -54653,7 +54896,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -54716,8 +54959,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42/comments", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42/comments
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews/42/comments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews/42/comments
    " }, { "lang": "JavaScript", @@ -54767,7 +55010,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -54810,8 +55053,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42/dismissals \\\n -d '{\"message\":\"message\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42/dismissals \\\n  -d '{\"message\":\"message\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews/42/dismissals \\\n -d '{\"message\":\"message\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews/42/dismissals \\\n  -d '{\"message\":\"message\"}'
    " }, { "lang": "JavaScript", @@ -54917,7 +55160,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -54960,8 +55203,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42/events \\\n -d '{\"event\":\"event\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42/events \\\n  -d '{\"event\":\"event\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews/42/events \\\n -d '{\"event\":\"event\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews/42/events \\\n  -d '{\"event\":\"event\"}'
    " }, { "lang": "JavaScript", @@ -55082,7 +55325,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/update-branch", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -55115,8 +55358,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.lydian-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/update-branch \\\n -d '{\"expected_head_sha\":\"expected_head_sha\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.lydian-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/update-branch \\\n  -d '{\"expected_head_sha\":\"expected_head_sha\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.lydian-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/update-branch \\\n -d '{\"expected_head_sha\":\"expected_head_sha\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.lydian-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/update-branch \\\n  -d '{\"expected_head_sha\":\"expected_head_sha\"}'
    " }, { "lang": "JavaScript", @@ -55215,7 +55458,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/readme", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -55249,8 +55492,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/readme", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/readme
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/readme", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/readme
    " }, { "lang": "JavaScript", @@ -55302,10 +55545,111 @@ } ] }, + { + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/readme/{dir}", + "serverUrl": "http(s)://{hostname}/api/v3", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "dir", + "description": "The alternate path to look for a README file", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true, + "descriptionHTML": "

    The alternate path to look for a README file

    " + }, + { + "name": "ref", + "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    The name of the commit/branch/tag. Default: the repository’s default branch (usually master)

    " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/readme/DIR", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/readme/DIR
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /repos/{owner}/{repo}/readme/{dir}', {\n owner: 'octocat',\n repo: 'hello-world',\n dir: 'dir'\n})", + "html": "
    await octokit.request('GET /repos/{owner}/{repo}/readme/{dir}', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  dir: 'dir'\n})\n
    " + } + ], + "summary": "Get a repository README", + "description": "Gets the preferred README for a repository.\n\nREADMEs support [custom media types](https://docs.github.com/enterprise-server@2.21/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML.", + "tags": [ + "repos" + ], + "operationId": "repos/get-readme-from-alt-path", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@2.21/rest/reference/repos#get-a-repository-readme" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "contents" + }, + "slug": "get-a-repository-readme", + "category": "repos", + "categoryLabel": "Repos", + "subcategory": "contents", + "subcategoryLabel": "Contents", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

    Gets the preferred README for a repository.

    \n

    READMEs support custom media types for retrieving the raw content or rendered HTML.

    ", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
    {\n  \"type\": \"file\",\n  \"encoding\": \"base64\",\n  \"size\": 5362,\n  \"name\": \"README.md\",\n  \"path\": \"README.md\",\n  \"content\": \"encoded content ...\",\n  \"sha\": \"3d21ec53a331a6f037a91c368710b99387d012c1\",\n  \"url\": \"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\n  \"git_url\": \"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\n  \"html_url\": \"https://github.com/octokit/octokit.rb/blob/master/README.md\",\n  \"download_url\": \"https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md\",\n  \"_links\": {\n    \"git\": \"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\n    \"self\": \"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\n    \"html\": \"https://github.com/octokit/octokit.rb/blob/master/README.md\"\n  }\n}\n
    " + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + } + ] + }, { "verb": "get", "requestPath": "/repos/{owner}/{repo}/releases", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -55349,8 +55693,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases
    " }, { "lang": "JavaScript", @@ -55400,7 +55744,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/releases", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -55424,8 +55768,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases \\\n -d '{\"tag_name\":\"tag_name\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases \\\n  -d '{\"tag_name\":\"tag_name\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases \\\n -d '{\"tag_name\":\"tag_name\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases \\\n  -d '{\"tag_name\":\"tag_name\"}'
    " }, { "lang": "JavaScript", @@ -55611,7 +55955,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/releases/assets/{asset_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -55645,8 +55989,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/assets/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases/assets/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/assets/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/assets/42
    " }, { "lang": "JavaScript", @@ -55706,7 +56050,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/releases/assets/{asset_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -55740,8 +56084,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/assets/42 \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases/assets/42 \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/assets/42 \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/assets/42 \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -55856,7 +56200,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/releases/assets/{asset_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -55890,8 +56234,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/assets/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases/assets/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/assets/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/assets/42
    " }, { "lang": "JavaScript", @@ -55926,7 +56270,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -55935,7 +56279,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/releases/latest", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -55959,8 +56303,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/latest", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases/latest
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/latest", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/latest
    " }, { "lang": "JavaScript", @@ -56005,7 +56349,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/releases/tags/{tag}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -56027,21 +56371,21 @@ }, { "name": "tag", - "description": "tag+ parameter", + "description": "tag parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    tag+ parameter

    " + "descriptionHTML": "

    tag parameter

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/tags/TAG", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases/tags/TAG
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/tags/TAG", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/tags/TAG
    " }, { "lang": "JavaScript", @@ -56091,7 +56435,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/releases/{release_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -56125,8 +56469,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/42
    " }, { "lang": "JavaScript", @@ -56176,7 +56520,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/releases/{release_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -56210,8 +56554,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/42 \\\n -d '{\"tag_name\":\"tag_name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases/42 \\\n  -d '{\"tag_name\":\"tag_name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/42 \\\n -d '{\"tag_name\":\"tag_name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/42 \\\n  -d '{\"tag_name\":\"tag_name\"}'
    " }, { "lang": "JavaScript", @@ -56384,7 +56728,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/releases/{release_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -56418,8 +56762,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/42
    " }, { "lang": "JavaScript", @@ -56454,7 +56798,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -56463,7 +56807,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/releases/{release_id}/assets", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -56517,8 +56861,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/42/assets", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases/42/assets
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/42/assets", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/42/assets
    " }, { "lang": "JavaScript", @@ -56563,7 +56907,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/releases/{release_id}/assets", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -56613,8 +56957,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/42/assets", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases/42/assets
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/42/assets", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/42/assets
    " }, { "lang": "JavaScript", @@ -56680,7 +57024,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/stargazers", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -56724,8 +57068,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/stargazers", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/stargazers
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/stargazers", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/stargazers
    " }, { "lang": "JavaScript", @@ -56775,7 +57119,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/stats/code_frequency", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -56799,8 +57143,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/stats/code_frequency", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/stats/code_frequency
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/stats/code_frequency", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/stats/code_frequency
    " }, { "lang": "JavaScript", @@ -56845,7 +57189,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/stats/commit_activity", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -56869,8 +57213,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/stats/commit_activity", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/stats/commit_activity
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/stats/commit_activity", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/stats/commit_activity
    " }, { "lang": "JavaScript", @@ -56915,7 +57259,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/stats/contributors", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -56939,8 +57283,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/stats/contributors", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/stats/contributors
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/stats/contributors", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/stats/contributors
    " }, { "lang": "JavaScript", @@ -56985,7 +57329,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/stats/participation", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -57009,8 +57353,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/stats/participation", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/stats/participation
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/stats/participation", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/stats/participation
    " }, { "lang": "JavaScript", @@ -57060,7 +57404,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/stats/punch_card", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -57084,8 +57428,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/stats/punch_card", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/stats/punch_card
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/stats/punch_card", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/stats/punch_card
    " }, { "lang": "JavaScript", @@ -57130,7 +57474,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/statuses/{sha}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -57164,8 +57508,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/statuses/SHA \\\n -d '{\"state\":\"state\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/statuses/SHA \\\n  -d '{\"state\":\"state\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/statuses/SHA \\\n -d '{\"state\":\"state\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/statuses/SHA \\\n  -d '{\"state\":\"state\"}'
    " }, { "lang": "JavaScript", @@ -57317,7 +57661,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/subscribers", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -57361,8 +57705,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/subscribers", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/subscribers
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/subscribers", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/subscribers
    " }, { "lang": "JavaScript", @@ -57407,7 +57751,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/subscription", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -57431,8 +57775,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/subscription", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/subscription
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/subscription", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/subscription
    " }, { "lang": "JavaScript", @@ -57487,7 +57831,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/subscription", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -57511,8 +57855,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/subscription \\\n -d '{\"subscribed\":true}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/subscription \\\n  -d '{\"subscribed\":true}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/subscription \\\n -d '{\"subscribed\":true}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/subscription \\\n  -d '{\"subscribed\":true}'
    " }, { "lang": "JavaScript", @@ -57605,7 +57949,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/subscription", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -57629,8 +57973,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/subscription", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/subscription
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/subscription", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/subscription
    " }, { "lang": "JavaScript", @@ -57665,7 +58009,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -57674,7 +58018,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/tags", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -57718,8 +58062,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/tags", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/tags
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/tags", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/tags
    " }, { "lang": "JavaScript", @@ -57762,7 +58106,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/tarball/{ref}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -57795,8 +58139,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/tarball/REF", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/tarball/REF
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/tarball/REF", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/tarball/REF
    " }, { "lang": "JavaScript", @@ -57840,7 +58184,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/teams", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -57884,8 +58228,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/teams", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/teams
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/teams", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/teams
    " }, { "lang": "JavaScript", @@ -57928,7 +58272,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/topics", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -57947,13 +58291,33 @@ "type": "string" }, "descriptionHTML": "" + }, + { + "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.

    " + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "descriptionHTML": "

    Results per page (max 100).

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/topics", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/topics
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/topics", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/topics
    " }, { "lang": "JavaScript", @@ -58013,7 +58377,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/topics", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -58037,8 +58401,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/topics \\\n -d '{\"names\":[\"names\"]}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/topics \\\n  -d '{\"names\":[\"names\"]}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/topics \\\n -d '{\"names\":[\"names\"]}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/topics \\\n  -d '{\"names\":[\"names\"]}'
    " }, { "lang": "JavaScript", @@ -58150,7 +58514,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/transfer", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -58174,8 +58538,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/transfer \\\n -d '{\"new_owner\":\"new_owner\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/transfer \\\n  -d '{\"new_owner\":\"new_owner\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/transfer \\\n -d '{\"new_owner\":\"new_owner\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/transfer \\\n  -d '{\"new_owner\":\"new_owner\"}'
    " }, { "lang": "JavaScript", @@ -58282,7 +58646,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/vulnerability-alerts", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -58306,8 +58670,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/vulnerability-alerts", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/vulnerability-alerts
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/vulnerability-alerts", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/vulnerability-alerts
    " }, { "lang": "JavaScript", @@ -58347,7 +58711,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -58356,7 +58720,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/vulnerability-alerts", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -58380,8 +58744,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/vulnerability-alerts", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/vulnerability-alerts
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/vulnerability-alerts", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/vulnerability-alerts
    " }, { "lang": "JavaScript", @@ -58421,7 +58785,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -58430,7 +58794,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/zipball/{ref}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -58463,8 +58827,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/zipball/REF", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/zipball/REF
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/zipball/REF", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/zipball/REF
    " }, { "lang": "JavaScript", @@ -58508,7 +58872,7 @@ { "verb": "post", "requestPath": "/repos/{template_owner}/{template_repo}/generate", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "template_owner", @@ -58532,8 +58896,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.baptiste-preview+json\" \\\n https://api.github.com/repos/TEMPLATE_OWNER/TEMPLATE_REPO/generate \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.baptiste-preview+json\" \\\n  https://api.github.com/repos/TEMPLATE_OWNER/TEMPLATE_REPO/generate \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.baptiste-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/TEMPLATE_OWNER/TEMPLATE_REPO/generate \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.baptiste-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/TEMPLATE_OWNER/TEMPLATE_REPO/generate \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -58542,7 +58906,7 @@ } ], "summary": "Create a repository using a template", - "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@2.21/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.21/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", + "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@2.21/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.21/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository", "tags": [ "repos" ], @@ -58637,7 +59001,7 @@ "category": "repos", "categoryLabel": "Repos", "notes": [], - "descriptionHTML": "

    Creates a new repository using a repository template. Use the template_owner and template_repo route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the Get a repository endpoint and check that the is_template key is true.

    \n

    OAuth scope requirements

    \n

    When using OAuth, authorizations must include:

    \n
      \n
    • public_repo scope or repo scope to create a public repository
    • \n
    • repo scope to create a private repository
    • \n
    ", + "descriptionHTML": "

    Creates a new repository using a repository template. Use the template_owner and template_repo route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the Get a repository endpoint and check that the is_template key is true.

    \n

    OAuth scope requirements

    \n

    When using OAuth, authorizations must include:

    \n
      \n
    • public_repo scope or repo scope to create a public repository. Note: For GitHub AE, use repo scope to create an internal repository.
    • \n
    • repo scope to create a private repository
    • \n
    ", "bodyParameters": [ { "type": "string", @@ -58699,7 +59063,7 @@ { "verb": "get", "requestPath": "/repositories", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "since", @@ -58713,7 +59077,7 @@ }, { "name": "visibility", - "description": "Specifies the types of repositories to return. Can be one of `all` or `public`. Default: `public`.", + "description": "Specifies the types of repositories to return. Can be one of `all` or `public`. Default: `public`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise.", "in": "query", "required": false, "schema": { @@ -58725,14 +59089,14 @@ "public" ] }, - "descriptionHTML": "

    Specifies the types of repositories to return. Can be one of all or public. Default: public.

    " + "descriptionHTML": "

    Specifies the types of repositories to return. Can be one of all or public. Default: public. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise.

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repositories", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repositories
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repositories", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repositories
    " }, { "lang": "JavaScript", @@ -58741,7 +59105,7 @@ } ], "summary": "List public repositories", - "description": "Lists all public repositories in the order that they were created.\n\nNote: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@2.21/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.", + "description": "Lists all public repositories in the order that they were created.\n\nNotes:\n- For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise.\n- Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@2.21/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.", "tags": [ "repos" ], @@ -58762,7 +59126,7 @@ "categoryLabel": "Repos", "notes": [], "bodyParameters": [], - "descriptionHTML": "

    Lists all public repositories in the order that they were created.

    \n

    Note: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of repositories.

    ", + "descriptionHTML": "

    Lists all public repositories in the order that they were created.

    \n

    Notes:

    \n
      \n
    • For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise.
    • \n
    • Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of repositories.
    • \n
    ", "responses": [ { "httpStatusCode": "200", @@ -58785,7 +59149,7 @@ { "verb": "get", "requestPath": "/search/code", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "q", @@ -58849,8 +59213,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/search/code", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/search/code
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/search/code", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/search/code
    " }, { "lang": "JavaScript", @@ -58913,7 +59277,7 @@ { "verb": "get", "requestPath": "/search/commits", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "q", @@ -58978,8 +59342,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.cloak-preview+json\" \\\n https://api.github.com/search/commits", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.cloak-preview+json\" \\\n  https://api.github.com/search/commits
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.cloak-preview+json\" \\\n http(s)://{hostname}/api/v3/search/commits", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.cloak-preview+json\" \\\n  http(s)://{hostname}/api/v3/search/commits
    " }, { "lang": "JavaScript", @@ -59039,7 +59403,7 @@ { "verb": "get", "requestPath": "/search/issues", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "q", @@ -59113,8 +59477,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/search/issues", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/search/issues
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/search/issues", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/search/issues
    " }, { "lang": "JavaScript", @@ -59177,7 +59541,7 @@ { "verb": "get", "requestPath": "/search/labels", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "repository_id", @@ -59232,8 +59596,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/search/labels", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/search/labels
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/search/labels", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/search/labels
    " }, { "lang": "JavaScript", @@ -59296,7 +59660,7 @@ { "verb": "get", "requestPath": "/search/repositories", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "q", @@ -59363,8 +59727,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/search/repositories", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/search/repositories
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/search/repositories", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/search/repositories
    " }, { "lang": "JavaScript", @@ -59429,7 +59793,7 @@ { "verb": "get", "requestPath": "/search/topics", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "q", @@ -59445,8 +59809,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n https://api.github.com/search/topics", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n  https://api.github.com/search/topics
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n http(s)://{hostname}/api/v3/search/topics", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n  http(s)://{hostname}/api/v3/search/topics
    " }, { "lang": "JavaScript", @@ -59506,7 +59870,7 @@ { "verb": "get", "requestPath": "/search/users", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "q", @@ -59572,8 +59936,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/search/users", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/search/users
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/search/users", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/search/users
    " }, { "lang": "JavaScript", @@ -59631,13 +59995,13 @@ { "verb": "get", "requestPath": "/setup/api/configcheck", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/configcheck", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/setup/api/configcheck
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/setup/api/configcheck", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/setup/api/configcheck
    " }, { "lang": "JavaScript", @@ -59682,13 +60046,13 @@ { "verb": "post", "requestPath": "/setup/api/configure", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/configure", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/setup/api/configure
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/setup/api/configure", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/setup/api/configure
    " }, { "lang": "JavaScript", @@ -59732,13 +60096,13 @@ { "verb": "get", "requestPath": "/setup/api/maintenance", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/maintenance", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/setup/api/maintenance
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/setup/api/maintenance", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/setup/api/maintenance
    " }, { "lang": "JavaScript", @@ -59783,13 +60147,13 @@ { "verb": "post", "requestPath": "/setup/api/maintenance", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/maintenance \\\n -d '{\"maintenance\":\"maintenance\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/setup/api/maintenance \\\n  -d '{\"maintenance\":\"maintenance\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/setup/api/maintenance \\\n -d '{\"maintenance\":\"maintenance\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/setup/api/maintenance \\\n  -d '{\"maintenance\":\"maintenance\"}'
    " }, { "lang": "JavaScript", @@ -59867,13 +60231,13 @@ { "verb": "get", "requestPath": "/setup/api/settings", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/settings", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/setup/api/settings
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/setup/api/settings", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/setup/api/settings
    " }, { "lang": "JavaScript", @@ -59918,13 +60282,13 @@ { "verb": "put", "requestPath": "/setup/api/settings", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/settings \\\n -d '{\"settings\":\"settings\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/setup/api/settings \\\n  -d '{\"settings\":\"settings\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/setup/api/settings \\\n -d '{\"settings\":\"settings\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/setup/api/settings \\\n  -d '{\"settings\":\"settings\"}'
    " }, { "lang": "JavaScript", @@ -59982,7 +60346,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "descriptionHTML": "

    For a list of the available settings, see the Get settings endpoint.

    ", @@ -60001,13 +60365,13 @@ { "verb": "get", "requestPath": "/setup/api/settings/authorized-keys", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/settings/authorized-keys", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/setup/api/settings/authorized-keys
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/setup/api/settings/authorized-keys", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/setup/api/settings/authorized-keys
    " }, { "lang": "JavaScript", @@ -60052,13 +60416,13 @@ { "verb": "post", "requestPath": "/setup/api/settings/authorized-keys", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/settings/authorized-keys \\\n -d '{\"authorized_key\":\"authorized_key\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/setup/api/settings/authorized-keys \\\n  -d '{\"authorized_key\":\"authorized_key\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/setup/api/settings/authorized-keys \\\n -d '{\"authorized_key\":\"authorized_key\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/setup/api/settings/authorized-keys \\\n  -d '{\"authorized_key\":\"authorized_key\"}'
    " }, { "lang": "JavaScript", @@ -60136,13 +60500,13 @@ { "verb": "delete", "requestPath": "/setup/api/settings/authorized-keys", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/settings/authorized-keys \\\n -d '{\"authorized_key\":\"authorized_key\"}'", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/setup/api/settings/authorized-keys \\\n  -d '{\"authorized_key\":\"authorized_key\"}'
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/setup/api/settings/authorized-keys \\\n -d '{\"authorized_key\":\"authorized_key\"}'", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/setup/api/settings/authorized-keys \\\n  -d '{\"authorized_key\":\"authorized_key\"}'
    " }, { "lang": "JavaScript", @@ -60220,13 +60584,13 @@ { "verb": "post", "requestPath": "/setup/api/start", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/start \\\n -d '{\"license\":\"license\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/setup/api/start \\\n  -d '{\"license\":\"license\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/setup/api/start \\\n -d '{\"license\":\"license\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/setup/api/start \\\n  -d '{\"license\":\"license\"}'
    " }, { "lang": "JavaScript", @@ -60339,13 +60703,13 @@ { "verb": "post", "requestPath": "/setup/api/upgrade", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/upgrade \\\n -d '{\"license\":\"license\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/setup/api/upgrade \\\n  -d '{\"license\":\"license\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/setup/api/upgrade \\\n -d '{\"license\":\"license\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/setup/api/upgrade \\\n  -d '{\"license\":\"license\"}'
    " }, { "lang": "JavaScript", @@ -60419,7 +60783,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -60434,8 +60798,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42
    " }, { "lang": "JavaScript", @@ -60486,7 +60850,7 @@ { "verb": "patch", "requestPath": "/teams/{team_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -60501,8 +60865,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42 \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42 \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42 \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42 \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -60695,7 +61059,7 @@ { "verb": "delete", "requestPath": "/teams/{team_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -60710,8 +61074,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42
    " }, { "lang": "JavaScript", @@ -60747,7 +61111,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -60766,7 +61130,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/discussions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -60816,8 +61180,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/discussions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions
    " }, { "lang": "JavaScript", @@ -60872,7 +61236,7 @@ { "verb": "post", "requestPath": "/teams/{team_id}/discussions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -60887,8 +61251,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions \\\n -d '{\"title\":\"title\",\"body\":\"body\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/discussions \\\n  -d '{\"title\":\"title\",\"body\":\"body\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions \\\n -d '{\"title\":\"title\",\"body\":\"body\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions \\\n  -d '{\"title\":\"title\",\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -61020,7 +61384,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/discussions/{discussion_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -61044,8 +61408,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/discussions/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions/42
    " }, { "lang": "JavaScript", @@ -61100,7 +61464,7 @@ { "verb": "patch", "requestPath": "/teams/{team_id}/discussions/{discussion_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -61124,8 +61488,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions/42 \\\n -d '{\"title\":\"title\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/discussions/42 \\\n  -d '{\"title\":\"title\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions/42 \\\n -d '{\"title\":\"title\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions/42 \\\n  -d '{\"title\":\"title\"}'
    " }, { "lang": "JavaScript", @@ -61231,7 +61595,7 @@ { "verb": "delete", "requestPath": "/teams/{team_id}/discussions/{discussion_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -61255,8 +61619,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/discussions/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions/42
    " }, { "lang": "JavaScript", @@ -61294,7 +61658,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -61303,7 +61667,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -61362,8 +61726,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions/42/comments", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/discussions/42/comments
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions/42/comments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions/42/comments
    " }, { "lang": "JavaScript", @@ -61418,7 +61782,7 @@ { "verb": "post", "requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -61442,8 +61806,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions/42/comments \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/discussions/42/comments \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions/42/comments \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions/42/comments \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -61535,7 +61899,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -61568,8 +61932,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions/42/comments/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/discussions/42/comments/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions/42/comments/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions/42/comments/42
    " }, { "lang": "JavaScript", @@ -61624,7 +61988,7 @@ { "verb": "patch", "requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -61657,8 +62021,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions/42/comments/42 \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/discussions/42/comments/42 \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions/42/comments/42 \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions/42/comments/42 \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -61749,7 +62113,7 @@ { "verb": "delete", "requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -61782,8 +62146,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions/42/comments/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/discussions/42/comments/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions/42/comments/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions/42/comments/42
    " }, { "lang": "JavaScript", @@ -61821,7 +62185,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -61830,7 +62194,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -61903,8 +62267,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/teams/42/discussions/42/comments/42/reactions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/teams/42/discussions/42/comments/42/reactions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions/42/comments/42/reactions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions/42/comments/42/reactions
    " }, { "lang": "JavaScript", @@ -61957,7 +62321,7 @@ { "verb": "post", "requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -61990,8 +62354,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/teams/42/discussions/42/comments/42/reactions \\\n -d '{\"content\":\"content\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/teams/42/discussions/42/comments/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions/42/comments/42/reactions \\\n -d '{\"content\":\"content\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions/42/comments/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " }, { "lang": "JavaScript", @@ -62100,7 +62464,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/discussions/{discussion_number}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -62164,8 +62528,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/teams/42/discussions/42/reactions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/teams/42/discussions/42/reactions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions/42/reactions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions/42/reactions
    " }, { "lang": "JavaScript", @@ -62218,7 +62582,7 @@ { "verb": "post", "requestPath": "/teams/{team_id}/discussions/{discussion_number}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -62242,8 +62606,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/teams/42/discussions/42/reactions \\\n -d '{\"content\":\"content\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/teams/42/discussions/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions/42/reactions \\\n -d '{\"content\":\"content\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " }, { "lang": "JavaScript", @@ -62352,7 +62716,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/members", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -62403,8 +62767,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/members", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/members
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/members", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/members
    " }, { "lang": "JavaScript", @@ -62457,7 +62821,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/members/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -62481,8 +62845,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/members/USERNAME", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/members/USERNAME
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/members/USERNAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/members/USERNAME
    " }, { "lang": "JavaScript", @@ -62534,7 +62898,7 @@ { "verb": "put", "requestPath": "/teams/{team_id}/members/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -62558,8 +62922,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/members/USERNAME", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/members/USERNAME
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/members/USERNAME", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/members/USERNAME
    " }, { "lang": "JavaScript", @@ -62593,13 +62957,11 @@ "subcategory": "members", "subcategoryLabel": "Members", "notes": [], - "bodyParameters": [], - "descriptionHTML": "

    The \"Add team member\" endpoint (described below) is deprecated.

    \n

    We recommend using the Add or update team membership for a user endpoint instead. It allows you to invite new organization members to your teams.

    \n

    Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

    \n

    To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.

    \n

    Note: When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"

    \n

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

    ", "responses": [ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -62614,21 +62976,16 @@ { "httpStatusCode": "422", "httpStatusMessage": "Unprocessable Entity", - "description": "Response if you attempt to add an organization to a team", - "payload": "
    {\n  \"message\": \"Cannot add an organization as a member.\",\n  \"errors\": [\n    {\n      \"code\": \"org\",\n      \"field\": \"user\",\n      \"resource\": \"TeamMember\"\n    }\n  ]\n}\n
    " - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Response if you attempt to add a user to a team when they are not a member of at least one other team in the same organization", - "payload": "
    {\n  \"message\": \"User isn't a member of this organization. Please invite them first.\",\n  \"errors\": [\n    {\n      \"code\": \"unaffiliated\",\n      \"field\": \"user\",\n      \"resource\": \"TeamMember\"\n    }\n  ]\n}\n
    " + "description": "Response if you attempt to add an organization to a team or you attempt to add a user to a team when they are not a member of at least one other team in the same organization" } - ] + ], + "bodyParameters": [], + "descriptionHTML": "

    The \"Add team member\" endpoint (described below) is deprecated.

    \n

    We recommend using the Add or update team membership for a user endpoint instead. It allows you to invite new organization members to your teams.

    \n

    Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

    \n

    To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.

    \n

    Note: When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"

    \n

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

    " }, { "verb": "delete", "requestPath": "/teams/{team_id}/members/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -62652,8 +63009,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/members/USERNAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/members/USERNAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/members/USERNAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/members/USERNAME
    " }, { "lang": "JavaScript", @@ -62691,7 +63048,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -62705,7 +63062,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/memberships/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -62729,8 +63086,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/memberships/USERNAME", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/memberships/USERNAME
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/memberships/USERNAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/memberships/USERNAME
    " }, { "lang": "JavaScript", @@ -62739,7 +63096,7 @@ } ], "summary": "Get team membership for a user (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 [Get team membership for a user](https://docs.github.com/enterprise-server@2.21/rest/reference/teams#get-team-membership-for-a-user) endpoint.\n\nTeam members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:** The `role` for organization owners returns as `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@2.21/rest/reference/teams#create-a-team).", + "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 [Get team membership for a user](https://docs.github.com/enterprise-server@2.21/rest/reference/teams#get-team-membership-for-a-user) endpoint.\n\nTeam members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:**\nThe response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@2.21/rest/reference/teams#create-a-team).", "tags": [ "teams" ], @@ -62765,26 +63122,14 @@ "subcategoryLabel": "Members", "notes": [], "bodyParameters": [], - "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 Get team membership for a user endpoint.

    \n

    Team members will include the members of child teams.

    \n

    To get a user's membership with a team, the team must be visible to the authenticated user.

    \n

    Note: The role for organization owners returns as maintainer. For more information about maintainer roles, see Create a team.

    ", + "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 Get team membership for a user endpoint.

    \n

    Team members will include the members of child teams.

    \n

    To get a user's membership with a team, the team must be visible to the authenticated user.

    \n

    Note:\nThe response contains the state of the membership and the member's role.

    \n

    The role for organization owners is set to maintainer. For more information about maintainer roles, see Create a team.

    ", "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response if user has an active membership with team", - "payload": "
    {\n  \"url\": \"https://api.github.com/teams/1/memberships/octocat\",\n  \"role\": \"member\",\n  \"state\": \"active\"\n}\n
    " - }, { "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Response if user is a team maintainer", "payload": "
    {\n  \"url\": \"https://api.github.com/teams/1/memberships/octocat\",\n  \"role\": \"maintainer\",\n  \"state\": \"active\"\n}\n
    " }, - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response if user has a pending membership with team", - "payload": "
    {\n  \"url\": \"https://api.github.com/teams/1/memberships/octocat\",\n  \"role\": \"member\",\n  \"state\": \"pending\"\n}\n
    " - }, { "httpStatusCode": "404", "httpStatusMessage": "Not Found", @@ -62795,7 +63140,7 @@ { "verb": "put", "requestPath": "/teams/{team_id}/memberships/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -62819,8 +63164,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/memberships/USERNAME \\\n -d '{\"role\":\"role\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/memberships/USERNAME \\\n  -d '{\"role\":\"role\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/memberships/USERNAME \\\n -d '{\"role\":\"role\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/memberships/USERNAME \\\n  -d '{\"role\":\"role\"}'
    " }, { "lang": "JavaScript", @@ -62897,12 +63242,6 @@ } ], "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response if user's membership with team is now active", - "payload": "
    {\n  \"url\": \"https://api.github.com/teams/1/memberships/octocat\",\n  \"role\": \"member\",\n  \"state\": \"active\"\n}\n
    " - }, { "httpStatusCode": "200", "httpStatusMessage": "OK", @@ -62922,15 +63261,14 @@ { "httpStatusCode": "422", "httpStatusMessage": "Unprocessable Entity", - "description": "Response if you attempt to add an organization to a team", - "payload": "
    {\n  \"message\": \"Cannot add an organization as a member.\",\n  \"errors\": [\n    {\n      \"code\": \"org\",\n      \"field\": \"user\",\n      \"resource\": \"TeamMember\"\n    }\n  ]\n}\n
    " + "description": "Response if you attempt to add an organization to a team" } ] }, { "verb": "delete", "requestPath": "/teams/{team_id}/memberships/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -62954,8 +63292,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/memberships/USERNAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/memberships/USERNAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/memberships/USERNAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/memberships/USERNAME
    " }, { "lang": "JavaScript", @@ -62993,7 +63331,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -63007,7 +63345,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/projects", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -63042,8 +63380,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/teams/42/projects", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/teams/42/projects
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/teams/42/projects", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/projects
    " }, { "lang": "JavaScript", @@ -63106,7 +63444,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/projects/{project_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -63130,8 +63468,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/teams/42/projects/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/teams/42/projects/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/teams/42/projects/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/projects/42
    " }, { "lang": "JavaScript", @@ -63194,7 +63532,7 @@ { "verb": "put", "requestPath": "/teams/{team_id}/projects/{project_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -63218,8 +63556,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/teams/42/projects/42 \\\n -d '{\"permission\":\"permission\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/teams/42/projects/42 \\\n  -d '{\"permission\":\"permission\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/teams/42/projects/42 \\\n -d '{\"permission\":\"permission\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/projects/42 \\\n  -d '{\"permission\":\"permission\"}'
    " }, { "lang": "JavaScript", @@ -63304,7 +63642,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -63332,7 +63670,7 @@ { "verb": "delete", "requestPath": "/teams/{team_id}/projects/{project_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -63356,8 +63694,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/projects/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/projects/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/projects/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/projects/42
    " }, { "lang": "JavaScript", @@ -63393,7 +63731,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -63417,7 +63755,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/repos", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -63452,8 +63790,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/repos", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/repos
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/repos", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/repos
    " }, { "lang": "JavaScript", @@ -63504,7 +63842,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/repos/{owner}/{repo}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -63537,8 +63875,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/repos/octocat/hello-world", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/repos/octocat/hello-world
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/repos/octocat/hello-world", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/repos/octocat/hello-world
    " }, { "lang": "JavaScript", @@ -63593,7 +63931,7 @@ { "verb": "put", "requestPath": "/teams/{team_id}/repos/{owner}/{repo}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -63626,8 +63964,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/repos/octocat/hello-world \\\n -d '{\"permission\":\"permission\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/repos/octocat/hello-world \\\n  -d '{\"permission\":\"permission\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/repos/octocat/hello-world \\\n -d '{\"permission\":\"permission\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/repos/octocat/hello-world \\\n  -d '{\"permission\":\"permission\"}'
    " }, { "lang": "JavaScript", @@ -63688,7 +64026,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -63722,7 +64060,7 @@ { "verb": "delete", "requestPath": "/teams/{team_id}/repos/{owner}/{repo}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -63755,8 +64093,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/repos/octocat/hello-world", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/repos/octocat/hello-world
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/repos/octocat/hello-world", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/repos/octocat/hello-world
    " }, { "lang": "JavaScript", @@ -63792,7 +64130,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -63801,7 +64139,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/teams", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -63836,8 +64174,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/teams", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/teams
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/teams", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/teams
    " }, { "lang": "JavaScript", @@ -63898,13 +64236,13 @@ { "verb": "get", "requestPath": "/user", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user
    " }, { "lang": "JavaScript", @@ -63968,13 +64306,13 @@ { "verb": "patch", "requestPath": "/user", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -64212,7 +64550,7 @@ { "verb": "get", "requestPath": "/user/emails", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -64238,8 +64576,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/emails", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/emails
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/emails", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/emails
    " }, { "lang": "JavaScript", @@ -64304,13 +64642,13 @@ { "verb": "post", "requestPath": "/user/emails", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/emails \\\n -d '{\"emails\":[\"octocat@github.com\"]}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/emails \\\n  -d '{\"emails\":[\"octocat@github.com\"]}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/emails \\\n -d '{\"emails\":[\"octocat@github.com\"]}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/emails \\\n  -d '{\"emails\":[\"octocat@github.com\"]}'
    " }, { "lang": "JavaScript", @@ -64425,13 +64763,13 @@ { "verb": "delete", "requestPath": "/user/emails", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/emails \\\n -d '{\"emails\":[\"octocat@github.com\"]}'", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/emails \\\n  -d '{\"emails\":[\"octocat@github.com\"]}'
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/emails \\\n -d '{\"emails\":[\"octocat@github.com\"]}'", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/emails \\\n  -d '{\"emails\":[\"octocat@github.com\"]}'
    " }, { "lang": "JavaScript", @@ -64511,7 +64849,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -64545,7 +64883,7 @@ { "verb": "get", "requestPath": "/user/followers", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -64571,8 +64909,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/followers", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/followers
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/followers", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/followers
    " }, { "lang": "JavaScript", @@ -64632,7 +64970,7 @@ { "verb": "get", "requestPath": "/user/following", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -64658,8 +64996,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/following", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/following
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/following", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/following
    " }, { "lang": "JavaScript", @@ -64719,7 +65057,7 @@ { "verb": "get", "requestPath": "/user/following/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -64734,8 +65072,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/following/USERNAME", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/following/USERNAME
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/following/USERNAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/following/USERNAME
    " }, { "lang": "JavaScript", @@ -64799,7 +65137,7 @@ { "verb": "put", "requestPath": "/user/following/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -64814,8 +65152,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/following/USERNAME", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/following/USERNAME
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/following/USERNAME", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/following/USERNAME
    " }, { "lang": "JavaScript", @@ -64850,7 +65188,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -64879,7 +65217,7 @@ { "verb": "delete", "requestPath": "/user/following/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -64894,8 +65232,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/following/USERNAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/following/USERNAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/following/USERNAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/following/USERNAME
    " }, { "lang": "JavaScript", @@ -64930,7 +65268,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -64959,7 +65297,7 @@ { "verb": "get", "requestPath": "/user/gpg_keys", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -64985,8 +65323,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/gpg_keys", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/gpg_keys
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/gpg_keys", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/gpg_keys
    " }, { "lang": "JavaScript", @@ -65051,13 +65389,13 @@ { "verb": "post", "requestPath": "/user/gpg_keys", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/gpg_keys \\\n -d '{\"armored_public_key\":\"armored_public_key\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/gpg_keys \\\n  -d '{\"armored_public_key\":\"armored_public_key\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/gpg_keys \\\n -d '{\"armored_public_key\":\"armored_public_key\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/gpg_keys \\\n  -d '{\"armored_public_key\":\"armored_public_key\"}'
    " }, { "lang": "JavaScript", @@ -65160,7 +65498,7 @@ { "verb": "get", "requestPath": "/user/gpg_keys/{gpg_key_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gpg_key_id", @@ -65176,8 +65514,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/gpg_keys/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/gpg_keys/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/gpg_keys/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/gpg_keys/42
    " }, { "lang": "JavaScript", @@ -65242,7 +65580,7 @@ { "verb": "delete", "requestPath": "/user/gpg_keys/{gpg_key_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gpg_key_id", @@ -65258,8 +65596,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/gpg_keys/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/gpg_keys/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/gpg_keys/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/gpg_keys/42
    " }, { "lang": "JavaScript", @@ -65294,7 +65632,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -65328,7 +65666,7 @@ { "verb": "get", "requestPath": "/user/installations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -65365,8 +65703,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/user/installations", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  https://api.github.com/user/installations
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n http(s)://{hostname}/api/v3/user/installations", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  http(s)://{hostname}/api/v3/user/installations
    " }, { "lang": "JavaScript", @@ -65438,7 +65776,7 @@ { "verb": "get", "requestPath": "/user/installations/{installation_id}/repositories", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -65485,8 +65823,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/user/installations/42/repositories", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  https://api.github.com/user/installations/42/repositories
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n http(s)://{hostname}/api/v3/user/installations/42/repositories", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  http(s)://{hostname}/api/v3/user/installations/42/repositories
    " }, { "lang": "JavaScript", @@ -65559,7 +65897,7 @@ { "verb": "put", "requestPath": "/user/installations/{installation_id}/repositories/{repository_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "installation_id", @@ -65584,8 +65922,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/user/installations/42/repositories/42", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  https://api.github.com/user/installations/42/repositories/42
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n http(s)://{hostname}/api/v3/user/installations/42/repositories/42", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  http(s)://{hostname}/api/v3/user/installations/42/repositories/42
    " }, { "lang": "JavaScript", @@ -65627,7 +65965,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -65651,7 +65989,7 @@ { "verb": "delete", "requestPath": "/user/installations/{installation_id}/repositories/{repository_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "installation_id", @@ -65676,8 +66014,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/user/installations/42/repositories/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  https://api.github.com/user/installations/42/repositories/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n http(s)://{hostname}/api/v3/user/installations/42/repositories/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  http(s)://{hostname}/api/v3/user/installations/42/repositories/42
    " }, { "lang": "JavaScript", @@ -65719,7 +66057,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -65743,7 +66081,7 @@ { "verb": "get", "requestPath": "/user/issues", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "filter", @@ -65757,6 +66095,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -65854,8 +66193,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/issues", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/issues
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/issues", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/issues
    " }, { "lang": "JavaScript", @@ -65914,7 +66253,7 @@ { "verb": "get", "requestPath": "/user/keys", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -65940,8 +66279,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/keys", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/keys
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/keys", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/keys
    " }, { "lang": "JavaScript", @@ -66006,13 +66345,13 @@ { "verb": "post", "requestPath": "/user/keys", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/keys \\\n -d '{\"key\":\"key\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/keys \\\n  -d '{\"key\":\"key\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/keys \\\n -d '{\"key\":\"key\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/keys \\\n  -d '{\"key\":\"key\"}'
    " }, { "lang": "JavaScript", @@ -66137,7 +66476,7 @@ { "verb": "get", "requestPath": "/user/keys/{key_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "key_id", @@ -66153,8 +66492,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/keys/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/keys/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/keys/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/keys/42
    " }, { "lang": "JavaScript", @@ -66219,7 +66558,7 @@ { "verb": "delete", "requestPath": "/user/keys/{key_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "key_id", @@ -66235,8 +66574,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/keys/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/keys/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/keys/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/keys/42
    " }, { "lang": "JavaScript", @@ -66271,7 +66610,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -66300,7 +66639,7 @@ { "verb": "get", "requestPath": "/user/memberships/orgs", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "state", @@ -66340,8 +66679,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/memberships/orgs", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/memberships/orgs
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/memberships/orgs", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/memberships/orgs
    " }, { "lang": "JavaScript", @@ -66406,7 +66745,7 @@ { "verb": "get", "requestPath": "/user/memberships/orgs/{org}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -66421,8 +66760,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/memberships/orgs/ORG", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/memberships/orgs/ORG
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/memberships/orgs/ORG", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/memberships/orgs/ORG
    " }, { "lang": "JavaScript", @@ -66477,7 +66816,7 @@ { "verb": "patch", "requestPath": "/user/memberships/orgs/{org}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -66492,8 +66831,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/memberships/orgs/ORG \\\n -d '{\"state\":\"state\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/memberships/orgs/ORG \\\n  -d '{\"state\":\"state\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/memberships/orgs/ORG \\\n -d '{\"state\":\"state\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/memberships/orgs/ORG \\\n  -d '{\"state\":\"state\"}'
    " }, { "lang": "JavaScript", @@ -66595,7 +66934,7 @@ { "verb": "get", "requestPath": "/user/orgs", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -66621,8 +66960,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/orgs", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/orgs
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/orgs", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/orgs
    " }, { "lang": "JavaScript", @@ -66680,13 +67019,13 @@ { "verb": "post", "requestPath": "/user/projects", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/user/projects \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/user/projects \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/user/projects \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/user/projects \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -66818,7 +67157,7 @@ { "verb": "get", "requestPath": "/user/public_emails", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -66844,8 +67183,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/public_emails", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/public_emails
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/public_emails", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/public_emails
    " }, { "lang": "JavaScript", @@ -66910,11 +67249,11 @@ { "verb": "get", "requestPath": "/user/repos", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "visibility", - "description": "Can be one of `all`, `public`, or `private`.", + "description": "Can be one of `all`, `public`, or `private`. Note: For GitHub AE, can be one of `all`, `internal`, or `private`.", "in": "query", "required": false, "schema": { @@ -66926,7 +67265,7 @@ ], "default": "all" }, - "descriptionHTML": "

    Can be one of all, public, or private.

    " + "descriptionHTML": "

    Can be one of all, public, or private. Note: For GitHub AE, can be one of all, internal, or private.

    " }, { "name": "affiliation", @@ -66941,7 +67280,7 @@ }, { "name": "type", - "description": "Can be one of `all`, `owner`, `public`, `private`, `member`. Default: `all` \n \nWill cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.", + "description": "Can be one of `all`, `owner`, `public`, `private`, `member`. Note: For GitHub AE, can be one of `all`, `owner`, `internal`, `private`, `member`. Default: `all` \n \nWill cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.", "in": "query", "required": false, "schema": { @@ -66955,7 +67294,7 @@ ], "default": "all" }, - "descriptionHTML": "

    Can be one of all, owner, public, private, member. Default: all

    \n

    Will cause a 422 error if used in the same request as visibility or affiliation. Will cause a 422 error if used in the same request as visibility or affiliation.

    " + "descriptionHTML": "

    Can be one of all, owner, public, private, member. Note: For GitHub AE, can be one of all, owner, internal, private, member. Default: all

    \n

    Will cause a 422 error if used in the same request as visibility or affiliation. Will cause a 422 error if used in the same request as visibility or affiliation.

    " }, { "name": "sort", @@ -67032,8 +67371,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/repos", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/repos
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/repos", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/repos
    " }, { "lang": "JavaScript", @@ -67096,13 +67435,13 @@ { "verb": "post", "requestPath": "/user/repos", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/repos \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/repos \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/repos \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/repos \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -67111,7 +67450,7 @@ } ], "summary": "Create a repository for the authenticated user", - "description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.21/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", + "description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.21/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository.", "tags": [ "repos" ], @@ -67154,13 +67493,13 @@ "childParamsGroups": [] }, "private": { - "description": "

    Whether the repository is private or public.

    ", + "description": "

    Whether the repository is private.

    ", "default": false, "type": "boolean", "name": "private", "in": "body", "rawType": "boolean", - "rawDescription": "Whether the repository is private or public.", + "rawDescription": "Whether the repository is private.", "childParamsGroups": [] }, "has_issues": { @@ -67334,7 +67673,7 @@ "category": "repos", "categoryLabel": "Repos", "notes": [], - "descriptionHTML": "

    Creates a new repository for the authenticated user.

    \n

    OAuth scope requirements

    \n

    When using OAuth, authorizations must include:

    \n
      \n
    • public_repo scope or repo scope to create a public repository
    • \n
    • repo scope to create a private repository
    • \n
    ", + "descriptionHTML": "

    Creates a new repository for the authenticated user.

    \n

    OAuth scope requirements

    \n

    When using OAuth, authorizations must include:

    \n
      \n
    • public_repo scope or repo scope to create a public repository. Note: For GitHub AE, use repo scope to create an internal repository.
    • \n
    • repo scope to create a private repository.
    • \n
    ", "bodyParameters": [ { "description": "

    Required. The name of the repository.

    ", @@ -67365,13 +67704,13 @@ "childParamsGroups": [] }, { - "description": "

    Whether the repository is private or public.

    ", + "description": "

    Whether the repository is private.

    ", "default": false, "type": "boolean", "name": "private", "in": "body", "rawType": "boolean", - "rawDescription": "Whether the repository is private or public.", + "rawDescription": "Whether the repository is private.", "childParamsGroups": [] }, { @@ -67555,7 +67894,7 @@ { "verb": "get", "requestPath": "/user/repository_invitations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -67581,8 +67920,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/repository_invitations", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/repository_invitations
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/repository_invitations", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/repository_invitations
    " }, { "lang": "JavaScript", @@ -67647,7 +67986,7 @@ { "verb": "patch", "requestPath": "/user/repository_invitations/{invitation_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "invitation_id", @@ -67663,8 +68002,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/repository_invitations/42", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/repository_invitations/42
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/repository_invitations/42", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/repository_invitations/42
    " }, { "lang": "JavaScript", @@ -67699,7 +68038,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -67728,7 +68067,7 @@ { "verb": "delete", "requestPath": "/user/repository_invitations/{invitation_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "invitation_id", @@ -67744,8 +68083,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/repository_invitations/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/repository_invitations/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/repository_invitations/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/repository_invitations/42
    " }, { "lang": "JavaScript", @@ -67780,7 +68119,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -67809,7 +68148,7 @@ { "verb": "get", "requestPath": "/user/starred", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "sort", @@ -67865,8 +68204,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/starred", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/starred
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/starred", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/starred
    " }, { "lang": "JavaScript", @@ -67926,7 +68265,7 @@ { "verb": "get", "requestPath": "/user/starred/{owner}/{repo}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -67950,8 +68289,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/starred/octocat/hello-world", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/starred/octocat/hello-world
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/starred/octocat/hello-world", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/starred/octocat/hello-world
    " }, { "lang": "JavaScript", @@ -68015,7 +68354,7 @@ { "verb": "put", "requestPath": "/user/starred/{owner}/{repo}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -68039,8 +68378,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/starred/octocat/hello-world", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/starred/octocat/hello-world
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/starred/octocat/hello-world", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/starred/octocat/hello-world
    " }, { "lang": "JavaScript", @@ -68075,7 +68414,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -68104,7 +68443,7 @@ { "verb": "delete", "requestPath": "/user/starred/{owner}/{repo}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -68128,8 +68467,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/starred/octocat/hello-world", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/starred/octocat/hello-world
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/starred/octocat/hello-world", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/starred/octocat/hello-world
    " }, { "lang": "JavaScript", @@ -68164,7 +68503,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -68193,7 +68532,7 @@ { "verb": "get", "requestPath": "/user/subscriptions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -68219,8 +68558,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/subscriptions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/subscriptions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/subscriptions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/subscriptions
    " }, { "lang": "JavaScript", @@ -68280,7 +68619,7 @@ { "verb": "get", "requestPath": "/user/teams", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -68306,8 +68645,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/teams", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/teams
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/teams", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/teams
    " }, { "lang": "JavaScript", @@ -68365,7 +68704,7 @@ { "verb": "get", "requestPath": "/users", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "since", @@ -68391,8 +68730,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users
    " }, { "lang": "JavaScript", @@ -68440,7 +68779,7 @@ { "verb": "get", "requestPath": "/users/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -68455,8 +68794,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME
    " }, { "lang": "JavaScript", @@ -68510,7 +68849,7 @@ { "verb": "get", "requestPath": "/users/{username}/events", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -68545,8 +68884,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/events", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/events
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/events", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/events
    " }, { "lang": "JavaScript", @@ -68590,7 +68929,7 @@ { "verb": "get", "requestPath": "/users/{username}/events/orgs/{org}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -68634,8 +68973,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/events/orgs/ORG", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/events/orgs/ORG
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/events/orgs/ORG", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/events/orgs/ORG
    " }, { "lang": "JavaScript", @@ -68679,7 +69018,7 @@ { "verb": "get", "requestPath": "/users/{username}/events/public", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -68714,8 +69053,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/events/public", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/events/public
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/events/public", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/events/public
    " }, { "lang": "JavaScript", @@ -68759,7 +69098,7 @@ { "verb": "get", "requestPath": "/users/{username}/followers", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -68794,8 +69133,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/followers", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/followers
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/followers", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/followers
    " }, { "lang": "JavaScript", @@ -68840,7 +69179,7 @@ { "verb": "get", "requestPath": "/users/{username}/following", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -68875,8 +69214,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/following", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/following
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/following", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/following
    " }, { "lang": "JavaScript", @@ -68921,7 +69260,7 @@ { "verb": "get", "requestPath": "/users/{username}/following/{target_user}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -68945,8 +69284,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/following/TARGET_USER", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/following/TARGET_USER
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/following/TARGET_USER", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/following/TARGET_USER
    " }, { "lang": "JavaScript", @@ -68995,7 +69334,7 @@ { "verb": "get", "requestPath": "/users/{username}/gists", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -69040,8 +69379,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/gists", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/gists
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/gists", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/gists
    " }, { "lang": "JavaScript", @@ -69089,7 +69428,7 @@ { "verb": "get", "requestPath": "/users/{username}/gpg_keys", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -69124,8 +69463,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/gpg_keys", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/gpg_keys
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/gpg_keys", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/gpg_keys
    " }, { "lang": "JavaScript", @@ -69170,7 +69509,7 @@ { "verb": "get", "requestPath": "/users/{username}/hovercard", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -69211,8 +69550,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/hovercard", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/hovercard
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/hovercard", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/hovercard
    " }, { "lang": "JavaScript", @@ -69265,7 +69604,7 @@ { "verb": "get", "requestPath": "/users/{username}/installation", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -69291,8 +69630,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/users/USERNAME/installation", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  https://api.github.com/users/USERNAME/installation
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/installation", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/installation
    " }, { "lang": "JavaScript", @@ -69341,7 +69680,7 @@ { "verb": "get", "requestPath": "/users/{username}/keys", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -69376,8 +69715,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/keys", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/keys
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/keys", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/keys
    " }, { "lang": "JavaScript", @@ -69422,7 +69761,7 @@ { "verb": "get", "requestPath": "/users/{username}/orgs", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -69457,8 +69796,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/orgs", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/orgs
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/orgs", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/orgs
    " }, { "lang": "JavaScript", @@ -69501,7 +69840,7 @@ { "verb": "get", "requestPath": "/users/{username}/projects", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -69552,8 +69891,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/users/USERNAME/projects", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/users/USERNAME/projects
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/projects", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/projects
    " }, { "lang": "JavaScript", @@ -69613,7 +69952,7 @@ { "verb": "get", "requestPath": "/users/{username}/received_events", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -69648,8 +69987,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/received_events", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/received_events
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/received_events", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/received_events
    " }, { "lang": "JavaScript", @@ -69693,7 +70032,7 @@ { "verb": "get", "requestPath": "/users/{username}/received_events/public", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -69728,8 +70067,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/received_events/public", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/received_events/public
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/received_events/public", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/received_events/public
    " }, { "lang": "JavaScript", @@ -69773,7 +70112,7 @@ { "verb": "get", "requestPath": "/users/{username}/repos", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -69855,8 +70194,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/repos", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/repos
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/repos", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/repos
    " }, { "lang": "JavaScript", @@ -69865,7 +70204,7 @@ } ], "summary": "List repositories for a user", - "description": "Lists public repositories for the specified user.", + "description": "Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user.", "tags": [ "repos" ], @@ -69893,7 +70232,7 @@ "categoryLabel": "Repos", "notes": [], "bodyParameters": [], - "descriptionHTML": "

    Lists public repositories for the specified user.

    ", + "descriptionHTML": "

    Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user.

    ", "responses": [ { "httpStatusCode": "200", @@ -69906,7 +70245,7 @@ { "verb": "put", "requestPath": "/users/{username}/site_admin", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -69921,8 +70260,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/site_admin", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/site_admin
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/site_admin", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/site_admin
    " }, { "lang": "JavaScript", @@ -69957,7 +70296,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -69966,7 +70305,7 @@ { "verb": "delete", "requestPath": "/users/{username}/site_admin", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -69981,8 +70320,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/site_admin", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/site_admin
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/site_admin", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/site_admin
    " }, { "lang": "JavaScript", @@ -70017,7 +70356,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -70026,7 +70365,7 @@ { "verb": "get", "requestPath": "/users/{username}/starred", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -70091,8 +70430,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/starred", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/starred
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/starred", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/starred
    " }, { "lang": "JavaScript", @@ -70137,7 +70476,7 @@ { "verb": "get", "requestPath": "/users/{username}/subscriptions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -70172,8 +70511,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/subscriptions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/subscriptions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/subscriptions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/subscriptions
    " }, { "lang": "JavaScript", @@ -70218,7 +70557,7 @@ { "verb": "put", "requestPath": "/users/{username}/suspended", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -70233,8 +70572,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/suspended \\\n -d '{\"reason\":\"reason\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/suspended \\\n  -d '{\"reason\":\"reason\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/suspended \\\n -d '{\"reason\":\"reason\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/suspended \\\n  -d '{\"reason\":\"reason\"}'
    " }, { "lang": "JavaScript", @@ -70289,7 +70628,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "descriptionHTML": "

    If your GitHub instance uses LDAP Sync with Active Directory LDAP servers, Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a 403 response.

    \n

    You can suspend any user account except your own.

    \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.\"

    ", @@ -70308,7 +70647,7 @@ { "verb": "delete", "requestPath": "/users/{username}/suspended", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -70323,8 +70662,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/suspended \\\n -d '{\"reason\":\"reason\"}'", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/suspended \\\n  -d '{\"reason\":\"reason\"}'
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/suspended \\\n -d '{\"reason\":\"reason\"}'", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/suspended \\\n  -d '{\"reason\":\"reason\"}'
    " }, { "lang": "JavaScript", @@ -70379,7 +70718,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "descriptionHTML": "

    If your GitHub instance uses LDAP Sync with Active Directory LDAP servers, this API is disabled and will return a 403 response. Active Directory LDAP-authenticated users cannot be unsuspended using the API.

    ", @@ -70398,13 +70737,13 @@ { "verb": "get", "requestPath": "/zen", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/zen", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/zen
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/zen", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/zen
    " }, { "lang": "JavaScript", diff --git a/lib/rest/static/decorated/ghes-2.22.json b/lib/rest/static/decorated/ghes-2.22.json index 191b8a41d7..452eebbd9b 100644 --- a/lib/rest/static/decorated/ghes-2.22.json +++ b/lib/rest/static/decorated/ghes-2.22.json @@ -2,13 +2,13 @@ { "verb": "get", "requestPath": "/", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/
    " }, { "lang": "JavaScript", @@ -45,7 +45,7 @@ { "verb": "get", "requestPath": "/admin/hooks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -82,8 +82,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n https://api.github.com/admin/hooks", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  https://api.github.com/admin/hooks
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/hooks", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/hooks
    " }, { "lang": "JavaScript", @@ -135,7 +135,7 @@ { "verb": "post", "requestPath": "/admin/hooks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -152,8 +152,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n https://api.github.com/admin/hooks \\\n -d '{\"name\":\"name\",\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  https://api.github.com/admin/hooks \\\n  -d '{\"name\":\"name\",\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/hooks \\\n -d '{\"name\":\"name\",\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/hooks \\\n  -d '{\"name\":\"name\",\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'
    " }, { "lang": "JavaScript", @@ -483,7 +483,7 @@ { "verb": "get", "requestPath": "/admin/hooks/{hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -509,8 +509,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n https://api.github.com/admin/hooks/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  https://api.github.com/admin/hooks/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/hooks/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/hooks/42
    " }, { "lang": "JavaScript", @@ -562,7 +562,7 @@ { "verb": "patch", "requestPath": "/admin/hooks/{hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -588,8 +588,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n https://api.github.com/admin/hooks/42 \\\n -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  https://api.github.com/admin/hooks/42 \\\n  -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/hooks/42 \\\n -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/hooks/42 \\\n  -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'
    " }, { "lang": "JavaScript", @@ -893,7 +893,7 @@ { "verb": "delete", "requestPath": "/admin/hooks/{hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -919,8 +919,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n https://api.github.com/admin/hooks/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  https://api.github.com/admin/hooks/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/hooks/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/hooks/42
    " }, { "lang": "JavaScript", @@ -962,7 +962,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -971,7 +971,7 @@ { "verb": "post", "requestPath": "/admin/hooks/{hook_id}/pings", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -997,8 +997,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n https://api.github.com/admin/hooks/42/pings", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  https://api.github.com/admin/hooks/42/pings
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/hooks/42/pings", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/hooks/42/pings
    " }, { "lang": "JavaScript", @@ -1040,7 +1040,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -1049,7 +1049,7 @@ { "verb": "get", "requestPath": "/admin/keys", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -1070,13 +1070,53 @@ "default": 1 }, "descriptionHTML": "

    Page number of the results to fetch.

    " + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + }, + "descriptionHTML": "

    One of asc (ascending) or desc (descending).

    " + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "accessed" + ], + "default": "created" + }, + "descriptionHTML": "" + }, + { + "name": "since", + "description": "Only show public keys accessed after the given time.", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    Only show public keys accessed after the given time.

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/keys", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/keys
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/keys", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/keys
    " }, { "lang": "JavaScript", @@ -1121,7 +1161,7 @@ { "verb": "delete", "requestPath": "/admin/keys/{key_ids}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "key_ids", @@ -1136,8 +1176,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/keys/KEY_IDS", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/keys/KEY_IDS
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/keys/KEY_IDS", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/keys/KEY_IDS
    " }, { "lang": "JavaScript", @@ -1172,7 +1212,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -1181,7 +1221,7 @@ { "verb": "patch", "requestPath": "/admin/ldap/teams/{team_id}/mapping", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -1196,8 +1236,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/ldap/teams/42/mapping \\\n -d '{\"ldap_dn\":\"ldap_dn\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/ldap/teams/42/mapping \\\n  -d '{\"ldap_dn\":\"ldap_dn\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/ldap/teams/42/mapping \\\n -d '{\"ldap_dn\":\"ldap_dn\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/ldap/teams/42/mapping \\\n  -d '{\"ldap_dn\":\"ldap_dn\"}'
    " }, { "lang": "JavaScript", @@ -1282,7 +1322,7 @@ { "verb": "post", "requestPath": "/admin/ldap/teams/{team_id}/sync", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -1297,8 +1337,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/ldap/teams/42/sync", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/ldap/teams/42/sync
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/ldap/teams/42/sync", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/ldap/teams/42/sync
    " }, { "lang": "JavaScript", @@ -1343,7 +1383,7 @@ { "verb": "patch", "requestPath": "/admin/ldap/users/{username}/mapping", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -1358,8 +1398,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/ldap/users/USERNAME/mapping \\\n -d '{\"ldap_dn\":\"ldap_dn\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/ldap/users/USERNAME/mapping \\\n  -d '{\"ldap_dn\":\"ldap_dn\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/ldap/users/USERNAME/mapping \\\n -d '{\"ldap_dn\":\"ldap_dn\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/ldap/users/USERNAME/mapping \\\n  -d '{\"ldap_dn\":\"ldap_dn\"}'
    " }, { "lang": "JavaScript", @@ -1437,7 +1477,7 @@ { "verb": "post", "requestPath": "/admin/ldap/users/{username}/sync", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -1452,8 +1492,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/ldap/users/USERNAME/sync", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/ldap/users/USERNAME/sync
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/ldap/users/USERNAME/sync", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/ldap/users/USERNAME/sync
    " }, { "lang": "JavaScript", @@ -1498,13 +1538,13 @@ { "verb": "post", "requestPath": "/admin/organizations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/organizations \\\n -d '{\"login\":\"login\",\"admin\":\"admin\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/organizations \\\n  -d '{\"login\":\"login\",\"admin\":\"admin\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/organizations \\\n -d '{\"login\":\"login\",\"admin\":\"admin\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/organizations \\\n  -d '{\"login\":\"login\",\"admin\":\"admin\"}'
    " }, { "lang": "JavaScript", @@ -1624,7 +1664,7 @@ { "verb": "patch", "requestPath": "/admin/organizations/{org}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -1639,8 +1679,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/organizations/ORG \\\n -d '{\"login\":\"login\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/organizations/ORG \\\n  -d '{\"login\":\"login\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/organizations/ORG \\\n -d '{\"login\":\"login\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/organizations/ORG \\\n  -d '{\"login\":\"login\"}'
    " }, { "lang": "JavaScript", @@ -1721,7 +1761,7 @@ { "verb": "get", "requestPath": "/admin/pre-receive-environments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -1742,13 +1782,43 @@ "default": 1 }, "descriptionHTML": "

    Page number of the results to fetch.

    " + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + }, + "descriptionHTML": "

    One of asc (ascending) or desc (descending).

    " + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + }, + "descriptionHTML": "" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-environments", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/admin/pre-receive-environments
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/pre-receive-environments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/pre-receive-environments
    " }, { "lang": "JavaScript", @@ -1800,13 +1870,13 @@ { "verb": "post", "requestPath": "/admin/pre-receive-environments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-environments \\\n -d '{\"name\":\"name\",\"image_url\":\"image_url\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/admin/pre-receive-environments \\\n  -d '{\"name\":\"name\",\"image_url\":\"image_url\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/pre-receive-environments \\\n -d '{\"name\":\"name\",\"image_url\":\"image_url\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/pre-receive-environments \\\n  -d '{\"name\":\"name\",\"image_url\":\"image_url\"}'
    " }, { "lang": "JavaScript", @@ -1914,7 +1984,7 @@ { "verb": "get", "requestPath": "/admin/pre-receive-environments/{pre_receive_environment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "pre_receive_environment_id", @@ -1929,8 +1999,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-environments/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/admin/pre-receive-environments/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/pre-receive-environments/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/pre-receive-environments/42
    " }, { "lang": "JavaScript", @@ -1982,7 +2052,7 @@ { "verb": "patch", "requestPath": "/admin/pre-receive-environments/{pre_receive_environment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "pre_receive_environment_id", @@ -1997,8 +2067,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-environments/42 \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/admin/pre-receive-environments/42 \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/pre-receive-environments/42 \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/pre-receive-environments/42 \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -2104,7 +2174,7 @@ { "verb": "delete", "requestPath": "/admin/pre-receive-environments/{pre_receive_environment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "pre_receive_environment_id", @@ -2119,8 +2189,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-environments/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/admin/pre-receive-environments/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/pre-receive-environments/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/pre-receive-environments/42
    " }, { "lang": "JavaScript", @@ -2164,7 +2234,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "422", @@ -2177,7 +2247,7 @@ { "verb": "post", "requestPath": "/admin/pre-receive-environments/{pre_receive_environment_id}/downloads", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "pre_receive_environment_id", @@ -2192,8 +2262,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-environments/42/downloads", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/admin/pre-receive-environments/42/downloads
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/pre-receive-environments/42/downloads", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/pre-receive-environments/42/downloads
    " }, { "lang": "JavaScript", @@ -2251,7 +2321,7 @@ { "verb": "get", "requestPath": "/admin/pre-receive-environments/{pre_receive_environment_id}/downloads/latest", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "pre_receive_environment_id", @@ -2266,8 +2336,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-environments/42/downloads/latest", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/admin/pre-receive-environments/42/downloads/latest
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/pre-receive-environments/42/downloads/latest", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/pre-receive-environments/42/downloads/latest
    " }, { "lang": "JavaScript", @@ -2319,7 +2389,7 @@ { "verb": "get", "requestPath": "/admin/pre-receive-hooks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -2340,13 +2410,44 @@ "default": 1 }, "descriptionHTML": "

    Page number of the results to fetch.

    " + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + }, + "descriptionHTML": "

    One of asc (ascending) or desc (descending).

    " + }, + { + "name": "sort", + "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to) or `name`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + }, + "descriptionHTML": "

    One of created (when the repository was starred) or updated (when it was last pushed to) or name.

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-hooks", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/admin/pre-receive-hooks
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/pre-receive-hooks", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/pre-receive-hooks
    " }, { "lang": "JavaScript", @@ -2398,13 +2499,13 @@ { "verb": "post", "requestPath": "/admin/pre-receive-hooks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-hooks \\\n -d '{\"name\":\"name\",\"script\":\"script\",\"script_repository\":{},\"environment\":{}}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/admin/pre-receive-hooks \\\n  -d '{\"name\":\"name\",\"script\":\"script\",\"script_repository\":{},\"environment\":{}}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/pre-receive-hooks \\\n -d '{\"name\":\"name\",\"script\":\"script\",\"script_repository\":{},\"environment\":{}}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/pre-receive-hooks \\\n  -d '{\"name\":\"name\",\"script\":\"script\",\"script_repository\":{},\"environment\":{}}'
    " }, { "lang": "JavaScript", @@ -2602,7 +2703,7 @@ { "verb": "get", "requestPath": "/admin/pre-receive-hooks/{pre_receive_hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "pre_receive_hook_id", @@ -2617,8 +2718,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-hooks/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/admin/pre-receive-hooks/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/pre-receive-hooks/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/pre-receive-hooks/42
    " }, { "lang": "JavaScript", @@ -2670,7 +2771,7 @@ { "verb": "patch", "requestPath": "/admin/pre-receive-hooks/{pre_receive_hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "pre_receive_hook_id", @@ -2685,8 +2786,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-hooks/42 \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/admin/pre-receive-hooks/42 \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/pre-receive-hooks/42 \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/pre-receive-hooks/42 \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -2873,7 +2974,7 @@ { "verb": "delete", "requestPath": "/admin/pre-receive-hooks/{pre_receive_hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "pre_receive_hook_id", @@ -2888,8 +2989,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-hooks/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/admin/pre-receive-hooks/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/pre-receive-hooks/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/pre-receive-hooks/42
    " }, { "lang": "JavaScript", @@ -2931,7 +3032,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -2940,7 +3041,7 @@ { "verb": "get", "requestPath": "/admin/tokens", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -2966,8 +3067,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/tokens", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/tokens
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/tokens", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/tokens
    " }, { "lang": "JavaScript", @@ -3012,7 +3113,7 @@ { "verb": "delete", "requestPath": "/admin/tokens/{token_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "token_id", @@ -3027,8 +3128,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/tokens/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/tokens/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/tokens/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/tokens/42
    " }, { "lang": "JavaScript", @@ -3063,7 +3164,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -3072,13 +3173,13 @@ { "verb": "post", "requestPath": "/admin/users", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/users \\\n -d '{\"login\":\"login\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/users \\\n  -d '{\"login\":\"login\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/users \\\n -d '{\"login\":\"login\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/users \\\n  -d '{\"login\":\"login\"}'
    " }, { "lang": "JavaScript", @@ -3178,7 +3279,7 @@ { "verb": "patch", "requestPath": "/admin/users/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -3193,8 +3294,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/users/USERNAME \\\n -d '{\"login\":\"login\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/users/USERNAME \\\n  -d '{\"login\":\"login\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/users/USERNAME \\\n -d '{\"login\":\"login\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/users/USERNAME \\\n  -d '{\"login\":\"login\"}'
    " }, { "lang": "JavaScript", @@ -3275,7 +3376,7 @@ { "verb": "delete", "requestPath": "/admin/users/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -3290,8 +3391,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/users/USERNAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/users/USERNAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/users/USERNAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/users/USERNAME
    " }, { "lang": "JavaScript", @@ -3326,7 +3427,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -3335,7 +3436,7 @@ { "verb": "post", "requestPath": "/admin/users/{username}/authorizations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -3350,8 +3451,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/users/USERNAME/authorizations \\\n -d '{\"scopes\":[\"scopes\"]}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/users/USERNAME/authorizations \\\n  -d '{\"scopes\":[\"scopes\"]}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/users/USERNAME/authorizations \\\n -d '{\"scopes\":[\"scopes\"]}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/users/USERNAME/authorizations \\\n  -d '{\"scopes\":[\"scopes\"]}'
    " }, { "lang": "JavaScript", @@ -3432,7 +3533,7 @@ { "verb": "delete", "requestPath": "/admin/users/{username}/authorizations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -3447,8 +3548,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/users/USERNAME/authorizations", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/users/USERNAME/authorizations
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/users/USERNAME/authorizations", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/users/USERNAME/authorizations
    " }, { "lang": "JavaScript", @@ -3483,7 +3584,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -3492,13 +3593,13 @@ { "verb": "get", "requestPath": "/app", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/app", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/app
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/app", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/app
    " }, { "lang": "JavaScript", @@ -3541,7 +3642,7 @@ { "verb": "post", "requestPath": "/app-manifests/{code}/conversions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "code", @@ -3556,8 +3657,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/app-manifests/CODE/conversions", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/app-manifests/CODE/conversions
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/app-manifests/CODE/conversions", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/app-manifests/CODE/conversions
    " }, { "lang": "JavaScript", @@ -3610,7 +3711,7 @@ { "verb": "get", "requestPath": "/app/installations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -3655,8 +3756,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/app/installations", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/app/installations
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/app/installations", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/app/installations
    " }, { "lang": "JavaScript", @@ -3699,7 +3800,7 @@ { "verb": "get", "requestPath": "/app/installations/{installation_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "installation_id", @@ -3715,8 +3816,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/app/installations/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/app/installations/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/app/installations/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/app/installations/42
    " }, { "lang": "JavaScript", @@ -3769,7 +3870,7 @@ { "verb": "delete", "requestPath": "/app/installations/{installation_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "installation_id", @@ -3785,8 +3886,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/app/installations/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/app/installations/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/app/installations/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/app/installations/42
    " }, { "lang": "JavaScript", @@ -3819,7 +3920,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -3833,7 +3934,7 @@ { "verb": "post", "requestPath": "/app/installations/{installation_id}/access_tokens", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "installation_id", @@ -3849,8 +3950,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/app/installations/42/access_tokens \\\n -d '{\"repositories\":[\"repositories\"]}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/app/installations/42/access_tokens \\\n  -d '{\"repositories\":[\"repositories\"]}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/app/installations/42/access_tokens \\\n -d '{\"repositories\":[\"repositories\"]}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/app/installations/42/access_tokens \\\n  -d '{\"repositories\":[\"repositories\"]}'
    " }, { "lang": "JavaScript", @@ -5594,7 +5695,7 @@ { "verb": "put", "requestPath": "/app/installations/{installation_id}/suspended", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "installation_id", @@ -5610,8 +5711,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/app/installations/42/suspended", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/app/installations/42/suspended
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/app/installations/42/suspended", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/app/installations/42/suspended
    " }, { "lang": "JavaScript", @@ -5644,7 +5745,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -5658,7 +5759,7 @@ { "verb": "delete", "requestPath": "/app/installations/{installation_id}/suspended", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "installation_id", @@ -5674,8 +5775,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/app/installations/42/suspended", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/app/installations/42/suspended
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/app/installations/42/suspended", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/app/installations/42/suspended
    " }, { "lang": "JavaScript", @@ -5708,7 +5809,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -5722,7 +5823,7 @@ { "verb": "get", "requestPath": "/applications/grants", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -5743,13 +5844,23 @@ "default": 1 }, "descriptionHTML": "

    Page number of the results to fetch.

    " + }, + { + "name": "client_id", + "in": "query", + "required": false, + "description": "The client ID of your GitHub app.", + "schema": { + "type": "string" + }, + "descriptionHTML": "

    The client ID of your GitHub app.

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/grants", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/applications/grants
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/applications/grants", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/applications/grants
    " }, { "lang": "JavaScript", @@ -5815,7 +5926,7 @@ { "verb": "get", "requestPath": "/applications/grants/{grant_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "grant_id", @@ -5831,8 +5942,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/grants/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/applications/grants/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/applications/grants/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/applications/grants/42
    " }, { "lang": "JavaScript", @@ -5893,7 +6004,7 @@ { "verb": "delete", "requestPath": "/applications/grants/{grant_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "grant_id", @@ -5909,8 +6020,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/grants/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/applications/grants/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/applications/grants/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/applications/grants/42
    " }, { "lang": "JavaScript", @@ -5946,7 +6057,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -5970,7 +6081,7 @@ { "verb": "delete", "requestPath": "/applications/{client_id}/grant", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "client_id", @@ -5986,8 +6097,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/CLIENT_ID/grant \\\n -d '{\"access_token\":\"access_token\"}'", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/applications/CLIENT_ID/grant \\\n  -d '{\"access_token\":\"access_token\"}'
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/applications/CLIENT_ID/grant \\\n -d '{\"access_token\":\"access_token\"}'", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/applications/CLIENT_ID/grant \\\n  -d '{\"access_token\":\"access_token\"}'
    " }, { "lang": "JavaScript", @@ -6045,7 +6156,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "422", @@ -6069,7 +6180,7 @@ { "verb": "delete", "requestPath": "/applications/{client_id}/grants/{access_token}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "client_id", @@ -6094,8 +6205,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/CLIENT_ID/grants/ACCESS_TOKEN", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/applications/CLIENT_ID/grants/ACCESS_TOKEN
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/applications/CLIENT_ID/grants/ACCESS_TOKEN", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/applications/CLIENT_ID/grants/ACCESS_TOKEN
    " }, { "lang": "JavaScript", @@ -6133,7 +6244,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -6142,7 +6253,7 @@ { "verb": "post", "requestPath": "/applications/{client_id}/token", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "client_id", @@ -6158,8 +6269,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/CLIENT_ID/token \\\n -d '{\"access_token\":\"access_token\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/applications/CLIENT_ID/token \\\n  -d '{\"access_token\":\"access_token\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/applications/CLIENT_ID/token \\\n -d '{\"access_token\":\"access_token\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/applications/CLIENT_ID/token \\\n  -d '{\"access_token\":\"access_token\"}'
    " }, { "lang": "JavaScript", @@ -6247,7 +6358,7 @@ { "verb": "patch", "requestPath": "/applications/{client_id}/token", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "client_id", @@ -6263,8 +6374,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/CLIENT_ID/token \\\n -d '{\"access_token\":\"access_token\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/applications/CLIENT_ID/token \\\n  -d '{\"access_token\":\"access_token\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/applications/CLIENT_ID/token \\\n -d '{\"access_token\":\"access_token\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/applications/CLIENT_ID/token \\\n  -d '{\"access_token\":\"access_token\"}'
    " }, { "lang": "JavaScript", @@ -6347,7 +6458,7 @@ { "verb": "delete", "requestPath": "/applications/{client_id}/token", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "client_id", @@ -6363,8 +6474,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/CLIENT_ID/token \\\n -d '{\"access_token\":\"access_token\"}'", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/applications/CLIENT_ID/token \\\n  -d '{\"access_token\":\"access_token\"}'
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/applications/CLIENT_ID/token \\\n -d '{\"access_token\":\"access_token\"}'", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/applications/CLIENT_ID/token \\\n  -d '{\"access_token\":\"access_token\"}'
    " }, { "lang": "JavaScript", @@ -6390,14 +6501,17 @@ "properties": { "access_token": { "type": "string", - "description": "

    The OAuth access token used to authenticate to the GitHub API.

    ", + "description": "

    Required. The OAuth access token used to authenticate to the GitHub API.

    ", "name": "access_token", "in": "body", "rawType": "string", "rawDescription": "The OAuth access token used to authenticate to the GitHub API.", "childParamsGroups": [] } - } + }, + "required": [ + "access_token" + ] }, "example": { "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a" @@ -6422,7 +6536,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "422", @@ -6434,7 +6548,7 @@ "bodyParameters": [ { "type": "string", - "description": "

    The OAuth access token used to authenticate to the GitHub API.

    ", + "description": "

    Required. The OAuth access token used to authenticate to the GitHub API.

    ", "name": "access_token", "in": "body", "rawType": "string", @@ -6446,7 +6560,7 @@ { "verb": "get", "requestPath": "/applications/{client_id}/tokens/{access_token}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "client_id", @@ -6471,8 +6585,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/CLIENT_ID/tokens/ACCESS_TOKEN", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/applications/CLIENT_ID/tokens/ACCESS_TOKEN
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/applications/CLIENT_ID/tokens/ACCESS_TOKEN", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/applications/CLIENT_ID/tokens/ACCESS_TOKEN
    " }, { "lang": "JavaScript", @@ -6525,7 +6639,7 @@ { "verb": "post", "requestPath": "/applications/{client_id}/tokens/{access_token}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "client_id", @@ -6550,8 +6664,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/CLIENT_ID/tokens/ACCESS_TOKEN", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/applications/CLIENT_ID/tokens/ACCESS_TOKEN
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/applications/CLIENT_ID/tokens/ACCESS_TOKEN", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/applications/CLIENT_ID/tokens/ACCESS_TOKEN
    " }, { "lang": "JavaScript", @@ -6599,7 +6713,7 @@ { "verb": "delete", "requestPath": "/applications/{client_id}/tokens/{access_token}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "client_id", @@ -6624,8 +6738,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/CLIENT_ID/tokens/ACCESS_TOKEN", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/applications/CLIENT_ID/tokens/ACCESS_TOKEN
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/applications/CLIENT_ID/tokens/ACCESS_TOKEN", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/applications/CLIENT_ID/tokens/ACCESS_TOKEN
    " }, { "lang": "JavaScript", @@ -6663,7 +6777,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -6672,7 +6786,7 @@ { "verb": "get", "requestPath": "/apps/{app_slug}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "app_slug", @@ -6687,8 +6801,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/apps/APP_SLUG", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/apps/APP_SLUG
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/apps/APP_SLUG", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/apps/APP_SLUG
    " }, { "lang": "JavaScript", @@ -6746,7 +6860,7 @@ { "verb": "get", "requestPath": "/authorizations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -6767,13 +6881,23 @@ "default": 1 }, "descriptionHTML": "

    Page number of the results to fetch.

    " + }, + { + "name": "client_id", + "in": "query", + "required": false, + "description": "The client ID of your GitHub app.", + "schema": { + "type": "string" + }, + "descriptionHTML": "

    The client ID of your GitHub app.

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/authorizations", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/authorizations
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/authorizations", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/authorizations
    " }, { "lang": "JavaScript", @@ -6839,13 +6963,13 @@ { "verb": "post", "requestPath": "/authorizations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/authorizations \\\n -d '{\"scopes\":[\"scopes\"]}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/authorizations \\\n  -d '{\"scopes\":[\"scopes\"]}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/authorizations \\\n -d '{\"scopes\":[\"scopes\"]}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/authorizations \\\n  -d '{\"scopes\":[\"scopes\"]}'
    " }, { "lang": "JavaScript", @@ -7058,7 +7182,7 @@ { "verb": "put", "requestPath": "/authorizations/clients/{client_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "client_id", @@ -7074,8 +7198,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/authorizations/clients/CLIENT_ID \\\n -d '{\"client_secret\":\"client_secret\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/authorizations/clients/CLIENT_ID \\\n  -d '{\"client_secret\":\"client_secret\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/authorizations/clients/CLIENT_ID \\\n -d '{\"client_secret\":\"client_secret\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/authorizations/clients/CLIENT_ID \\\n  -d '{\"client_secret\":\"client_secret\"}'
    " }, { "lang": "JavaScript", @@ -7272,7 +7396,7 @@ { "verb": "put", "requestPath": "/authorizations/clients/{client_id}/{fingerprint}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "client_id", @@ -7297,8 +7421,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/authorizations/clients/CLIENT_ID/FINGERPRINT \\\n -d '{\"client_secret\":\"client_secret\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/authorizations/clients/CLIENT_ID/FINGERPRINT \\\n  -d '{\"client_secret\":\"client_secret\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/authorizations/clients/CLIENT_ID/FINGERPRINT \\\n -d '{\"client_secret\":\"client_secret\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/authorizations/clients/CLIENT_ID/FINGERPRINT \\\n  -d '{\"client_secret\":\"client_secret\"}'
    " }, { "lang": "JavaScript", @@ -7462,7 +7586,7 @@ { "verb": "get", "requestPath": "/authorizations/{authorization_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "authorization_id", @@ -7478,8 +7602,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/authorizations/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/authorizations/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/authorizations/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/authorizations/42
    " }, { "lang": "JavaScript", @@ -7540,7 +7664,7 @@ { "verb": "patch", "requestPath": "/authorizations/{authorization_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "authorization_id", @@ -7556,8 +7680,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/authorizations/42 \\\n -d '{\"scopes\":[\"scopes\"]}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/authorizations/42 \\\n  -d '{\"scopes\":[\"scopes\"]}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/authorizations/42 \\\n -d '{\"scopes\":[\"scopes\"]}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/authorizations/42 \\\n  -d '{\"scopes\":[\"scopes\"]}'
    " }, { "lang": "JavaScript", @@ -7758,7 +7882,7 @@ { "verb": "delete", "requestPath": "/authorizations/{authorization_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "authorization_id", @@ -7774,8 +7898,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/authorizations/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/authorizations/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/authorizations/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/authorizations/42
    " }, { "lang": "JavaScript", @@ -7811,7 +7935,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -7835,13 +7959,13 @@ { "verb": "get", "requestPath": "/codes_of_conduct", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.scarlet-witch-preview+json\" \\\n https://api.github.com/codes_of_conduct", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.scarlet-witch-preview+json\" \\\n  https://api.github.com/codes_of_conduct
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.scarlet-witch-preview+json\" \\\n http(s)://{hostname}/api/v3/codes_of_conduct", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.scarlet-witch-preview+json\" \\\n  http(s)://{hostname}/api/v3/codes_of_conduct
    " }, { "lang": "JavaScript", @@ -7901,7 +8025,7 @@ { "verb": "get", "requestPath": "/codes_of_conduct/{key}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "key", @@ -7916,8 +8040,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.scarlet-witch-preview+json\" \\\n https://api.github.com/codes_of_conduct/KEY", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.scarlet-witch-preview+json\" \\\n  https://api.github.com/codes_of_conduct/KEY
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.scarlet-witch-preview+json\" \\\n http(s)://{hostname}/api/v3/codes_of_conduct/KEY", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.scarlet-witch-preview+json\" \\\n  http(s)://{hostname}/api/v3/codes_of_conduct/KEY
    " }, { "lang": "JavaScript", @@ -7982,7 +8106,7 @@ { "verb": "post", "requestPath": "/content_references/{content_reference_id}/attachments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "content_reference_id", @@ -7997,8 +8121,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n https://api.github.com/content_references/42/attachments \\\n -d '{\"title\":\"title\",\"body\":\"body\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n  https://api.github.com/content_references/42/attachments \\\n  -d '{\"title\":\"title\",\"body\":\"body\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n http(s)://{hostname}/api/v3/content_references/42/attachments \\\n -d '{\"title\":\"title\",\"body\":\"body\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n  http(s)://{hostname}/api/v3/content_references/42/attachments \\\n  -d '{\"title\":\"title\",\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -8140,13 +8264,13 @@ { "verb": "get", "requestPath": "/emojis", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/emojis", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/emojis
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/emojis", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/emojis
    " }, { "lang": "JavaScript", @@ -8193,13 +8317,13 @@ { "verb": "get", "requestPath": "/enterprise/settings/license", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprise/settings/license", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprise/settings/license
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/enterprise/settings/license", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/enterprise/settings/license
    " }, { "lang": "JavaScript", @@ -8244,7 +8368,7 @@ { "verb": "get", "requestPath": "/enterprise/stats/{type}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "type", @@ -8259,8 +8383,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprise/stats/TYPE", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprise/stats/TYPE
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/enterprise/stats/TYPE", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/enterprise/stats/TYPE
    " }, { "lang": "JavaScript", @@ -8305,7 +8429,7 @@ { "verb": "get", "requestPath": "/enterprises/{enterprise}/actions/runner-groups", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "enterprise", @@ -8341,8 +8465,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprises/ENTERPRISE/actions/runner-groups", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprises/ENTERPRISE/actions/runner-groups
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/runner-groups", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/runner-groups
    " }, { "lang": "JavaScript", @@ -8387,7 +8511,7 @@ { "verb": "post", "requestPath": "/enterprises/{enterprise}/actions/runner-groups", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "enterprise", @@ -8403,8 +8527,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprises/ENTERPRISE/actions/runner-groups \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprises/ENTERPRISE/actions/runner-groups \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/runner-groups \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/runner-groups \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -8572,7 +8696,7 @@ { "verb": "get", "requestPath": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "enterprise", @@ -8598,8 +8722,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprises/ENTERPRISE/actions/runner-groups/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprises/ENTERPRISE/actions/runner-groups/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/runner-groups/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/runner-groups/42
    " }, { "lang": "JavaScript", @@ -8644,7 +8768,7 @@ { "verb": "patch", "requestPath": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "enterprise", @@ -8670,8 +8794,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprises/ENTERPRISE/actions/runner-groups/42 \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprises/ENTERPRISE/actions/runner-groups/42 \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/runner-groups/42 \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/runner-groups/42 \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -8778,7 +8902,7 @@ { "verb": "delete", "requestPath": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "enterprise", @@ -8804,8 +8928,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprises/ENTERPRISE/actions/runner-groups/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprises/ENTERPRISE/actions/runner-groups/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/runner-groups/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/runner-groups/42
    " }, { "lang": "JavaScript", @@ -8840,7 +8964,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -8849,7 +8973,7 @@ { "verb": "get", "requestPath": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "enterprise", @@ -8895,8 +9019,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprises/ENTERPRISE/actions/runner-groups/42/organizations", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprises/ENTERPRISE/actions/runner-groups/42/organizations
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/runner-groups/42/organizations", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/runner-groups/42/organizations
    " }, { "lang": "JavaScript", @@ -8941,7 +9065,7 @@ { "verb": "put", "requestPath": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "enterprise", @@ -8967,8 +9091,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprises/ENTERPRISE/actions/runner-groups/42/organizations \\\n -d '{\"selected_organization_ids\":[42]}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprises/ENTERPRISE/actions/runner-groups/42/organizations \\\n  -d '{\"selected_organization_ids\":[42]}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/runner-groups/42/organizations \\\n -d '{\"selected_organization_ids\":[42]}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/runner-groups/42/organizations \\\n  -d '{\"selected_organization_ids\":[42]}'
    " }, { "lang": "JavaScript", @@ -9036,7 +9160,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "descriptionHTML": "

    Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.

    \n

    You must authenticate using an access token with the admin:enterprise scope to use this endpoint.

    ", @@ -9059,7 +9183,7 @@ { "verb": "put", "requestPath": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations/{org_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "enterprise", @@ -9095,8 +9219,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprises/ENTERPRISE/actions/runner-groups/42/organizations/42", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprises/ENTERPRISE/actions/runner-groups/42/organizations/42
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/runner-groups/42/organizations/42", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/runner-groups/42/organizations/42
    " }, { "lang": "JavaScript", @@ -9131,7 +9255,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -9140,7 +9264,7 @@ { "verb": "delete", "requestPath": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations/{org_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "enterprise", @@ -9176,8 +9300,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprises/ENTERPRISE/actions/runner-groups/42/organizations/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprises/ENTERPRISE/actions/runner-groups/42/organizations/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/runner-groups/42/organizations/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/runner-groups/42/organizations/42
    " }, { "lang": "JavaScript", @@ -9212,7 +9336,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -9221,7 +9345,7 @@ { "verb": "get", "requestPath": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "enterprise", @@ -9267,8 +9391,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprises/ENTERPRISE/actions/runner-groups/42/runners", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprises/ENTERPRISE/actions/runner-groups/42/runners
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/runner-groups/42/runners", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/runner-groups/42/runners
    " }, { "lang": "JavaScript", @@ -9313,7 +9437,7 @@ { "verb": "put", "requestPath": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "enterprise", @@ -9339,8 +9463,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprises/ENTERPRISE/actions/runner-groups/42/runners \\\n -d '{\"runners\":[42]}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprises/ENTERPRISE/actions/runner-groups/42/runners \\\n  -d '{\"runners\":[42]}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/runner-groups/42/runners \\\n -d '{\"runners\":[42]}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/runner-groups/42/runners \\\n  -d '{\"runners\":[42]}'
    " }, { "lang": "JavaScript", @@ -9408,7 +9532,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "descriptionHTML": "

    Replaces the list of self-hosted runners that are part of an enterprise runner group.

    \n

    You must authenticate using an access token with the admin:enterprise scope to use this endpoint.

    ", @@ -9431,7 +9555,7 @@ { "verb": "put", "requestPath": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "enterprise", @@ -9467,8 +9591,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprises/ENTERPRISE/actions/runner-groups/42/runners/42", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprises/ENTERPRISE/actions/runner-groups/42/runners/42
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/runner-groups/42/runners/42", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/runner-groups/42/runners/42
    " }, { "lang": "JavaScript", @@ -9503,7 +9627,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -9512,7 +9636,7 @@ { "verb": "delete", "requestPath": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "enterprise", @@ -9548,8 +9672,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprises/ENTERPRISE/actions/runner-groups/42/runners/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprises/ENTERPRISE/actions/runner-groups/42/runners/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/runner-groups/42/runners/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/runner-groups/42/runners/42
    " }, { "lang": "JavaScript", @@ -9584,7 +9708,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -9593,7 +9717,7 @@ { "verb": "get", "requestPath": "/enterprises/{enterprise}/actions/runners", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "enterprise", @@ -9629,8 +9753,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprises/ENTERPRISE/actions/runners", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprises/ENTERPRISE/actions/runners
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/runners", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/runners
    " }, { "lang": "JavaScript", @@ -9675,7 +9799,7 @@ { "verb": "get", "requestPath": "/enterprises/{enterprise}/actions/runners/downloads", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "enterprise", @@ -9691,8 +9815,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprises/ENTERPRISE/actions/runners/downloads", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprises/ENTERPRISE/actions/runners/downloads
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/runners/downloads", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/runners/downloads
    " }, { "lang": "JavaScript", @@ -9737,7 +9861,7 @@ { "verb": "post", "requestPath": "/enterprises/{enterprise}/actions/runners/registration-token", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "enterprise", @@ -9753,8 +9877,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprises/ENTERPRISE/actions/runners/registration-token", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprises/ENTERPRISE/actions/runners/registration-token
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/runners/registration-token", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/runners/registration-token
    " }, { "lang": "JavaScript", @@ -9799,7 +9923,7 @@ { "verb": "post", "requestPath": "/enterprises/{enterprise}/actions/runners/remove-token", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "enterprise", @@ -9815,8 +9939,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprises/ENTERPRISE/actions/runners/remove-token", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprises/ENTERPRISE/actions/runners/remove-token
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/runners/remove-token", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/runners/remove-token
    " }, { "lang": "JavaScript", @@ -9861,7 +9985,7 @@ { "verb": "get", "requestPath": "/enterprises/{enterprise}/actions/runners/{runner_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "enterprise", @@ -9887,8 +10011,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprises/ENTERPRISE/actions/runners/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprises/ENTERPRISE/actions/runners/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/runners/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/runners/42
    " }, { "lang": "JavaScript", @@ -9933,7 +10057,7 @@ { "verb": "delete", "requestPath": "/enterprises/{enterprise}/actions/runners/{runner_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "enterprise", @@ -9959,8 +10083,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprises/ENTERPRISE/actions/runners/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprises/ENTERPRISE/actions/runners/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/runners/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/runners/42
    " }, { "lang": "JavaScript", @@ -9995,7 +10119,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -10004,7 +10128,7 @@ { "verb": "get", "requestPath": "/events", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -10030,8 +10154,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/events", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/events
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/events", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/events
    " }, { "lang": "JavaScript", @@ -10090,13 +10214,13 @@ { "verb": "get", "requestPath": "/feeds", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/feeds", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/feeds
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/feeds", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/feeds
    " }, { "lang": "JavaScript", @@ -10141,7 +10265,7 @@ { "verb": "get", "requestPath": "/gists", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "since", @@ -10177,8 +10301,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists
    " }, { "lang": "JavaScript", @@ -10231,13 +10355,13 @@ { "verb": "post", "requestPath": "/gists", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists \\\n -d '{\"files\":{}}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists \\\n  -d '{\"files\":{}}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists \\\n -d '{\"files\":{}}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists \\\n  -d '{\"files\":{}}'
    " }, { "lang": "JavaScript", @@ -10435,7 +10559,7 @@ { "verb": "get", "requestPath": "/gists/public", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "since", @@ -10471,8 +10595,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/public", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/public
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/public", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/public
    " }, { "lang": "JavaScript", @@ -10530,7 +10654,7 @@ { "verb": "get", "requestPath": "/gists/starred", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "since", @@ -10566,8 +10690,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/starred", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/starred
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/starred", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/starred
    " }, { "lang": "JavaScript", @@ -10625,7 +10749,7 @@ { "verb": "get", "requestPath": "/gists/{gist_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -10641,8 +10765,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID
    " }, { "lang": "JavaScript", @@ -10700,7 +10824,7 @@ { "verb": "patch", "requestPath": "/gists/{gist_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -10716,8 +10840,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID \\\n -d '{\"description\":\"description\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID \\\n  -d '{\"description\":\"description\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID \\\n -d '{\"description\":\"description\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID \\\n  -d '{\"description\":\"description\"}'
    " }, { "lang": "JavaScript", @@ -10907,7 +11031,7 @@ { "verb": "delete", "requestPath": "/gists/{gist_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -10923,8 +11047,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID
    " }, { "lang": "JavaScript", @@ -10957,7 +11081,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -10981,7 +11105,7 @@ { "verb": "get", "requestPath": "/gists/{gist_id}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -11017,8 +11141,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/comments", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/comments
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID/comments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID/comments
    " }, { "lang": "JavaScript", @@ -11078,7 +11202,7 @@ { "verb": "post", "requestPath": "/gists/{gist_id}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -11094,8 +11218,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/comments \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/comments \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID/comments \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID/comments \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -11192,7 +11316,7 @@ { "verb": "get", "requestPath": "/gists/{gist_id}/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -11218,8 +11342,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/comments/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/comments/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID/comments/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID/comments/42
    " }, { "lang": "JavaScript", @@ -11279,7 +11403,7 @@ { "verb": "patch", "requestPath": "/gists/{gist_id}/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -11305,8 +11429,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/comments/42 \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/comments/42 \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID/comments/42 \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID/comments/42 \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -11393,7 +11517,7 @@ { "verb": "delete", "requestPath": "/gists/{gist_id}/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -11419,8 +11543,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/comments/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/comments/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID/comments/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID/comments/42
    " }, { "lang": "JavaScript", @@ -11455,7 +11579,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -11479,7 +11603,7 @@ { "verb": "get", "requestPath": "/gists/{gist_id}/commits", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -11515,8 +11639,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/commits", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/commits
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID/commits", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID/commits
    " }, { "lang": "JavaScript", @@ -11574,7 +11698,7 @@ { "verb": "get", "requestPath": "/gists/{gist_id}/forks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -11610,8 +11734,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/forks", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/forks
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID/forks", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID/forks
    " }, { "lang": "JavaScript", @@ -11669,7 +11793,7 @@ { "verb": "post", "requestPath": "/gists/{gist_id}/forks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -11685,8 +11809,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/forks", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/forks
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID/forks", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID/forks
    " }, { "lang": "JavaScript", @@ -11749,7 +11873,7 @@ { "verb": "get", "requestPath": "/gists/{gist_id}/star", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -11765,8 +11889,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/star", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/star
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID/star", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID/star
    " }, { "lang": "JavaScript", @@ -11823,7 +11947,7 @@ { "verb": "put", "requestPath": "/gists/{gist_id}/star", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -11839,8 +11963,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/star", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/star
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID/star", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID/star
    " }, { "lang": "JavaScript", @@ -11873,7 +11997,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -11897,7 +12021,7 @@ { "verb": "delete", "requestPath": "/gists/{gist_id}/star", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -11913,8 +12037,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/star", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/star
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID/star", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID/star
    " }, { "lang": "JavaScript", @@ -11947,7 +12071,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -11971,7 +12095,7 @@ { "verb": "get", "requestPath": "/gists/{gist_id}/{sha}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -11996,8 +12120,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/SHA", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/SHA
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID/SHA", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID/SHA
    " }, { "lang": "JavaScript", @@ -12055,13 +12179,13 @@ { "verb": "get", "requestPath": "/gitignore/templates", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gitignore/templates", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gitignore/templates
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gitignore/templates", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gitignore/templates
    " }, { "lang": "JavaScript", @@ -12109,7 +12233,7 @@ { "verb": "get", "requestPath": "/gitignore/templates/{name}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "name", @@ -12124,8 +12248,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gitignore/templates/NAME", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gitignore/templates/NAME
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gitignore/templates/NAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gitignore/templates/NAME
    " }, { "lang": "JavaScript", @@ -12173,7 +12297,7 @@ { "verb": "get", "requestPath": "/installation/repositories", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -12199,8 +12323,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/installation/repositories", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/installation/repositories
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/installation/repositories", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/installation/repositories
    " }, { "lang": "JavaScript", @@ -12267,13 +12391,13 @@ { "verb": "delete", "requestPath": "/installation/token", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/installation/token", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/installation/token
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/installation/token", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/installation/token
    " }, { "lang": "JavaScript", @@ -12308,7 +12432,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -12317,7 +12441,7 @@ { "verb": "get", "requestPath": "/issues", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "filter", @@ -12331,6 +12455,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -12464,8 +12589,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/issues", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/issues
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/issues", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/issues
    " }, { "lang": "JavaScript", @@ -12530,7 +12655,7 @@ { "verb": "get", "requestPath": "/licenses", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "featured", @@ -12550,13 +12675,23 @@ "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/licenses", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/licenses
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/licenses", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/licenses
    " }, { "lang": "JavaScript", @@ -12604,7 +12739,7 @@ { "verb": "get", "requestPath": "/licenses/{license}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "license", @@ -12619,8 +12754,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/licenses/LICENSE", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/licenses/LICENSE
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/licenses/LICENSE", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/licenses/LICENSE
    " }, { "lang": "JavaScript", @@ -12678,13 +12813,13 @@ { "verb": "post", "requestPath": "/markdown", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/markdown \\\n -d '{\"text\":\"text\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/markdown \\\n  -d '{\"text\":\"text\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/markdown \\\n -d '{\"text\":\"text\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/markdown \\\n  -d '{\"text\":\"text\"}'
    " }, { "lang": "JavaScript", @@ -12812,13 +12947,13 @@ { "verb": "post", "requestPath": "/markdown/raw", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/markdown/raw", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/markdown/raw
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/markdown/raw", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/markdown/raw
    " }, { "lang": "JavaScript", @@ -12879,13 +13014,13 @@ { "verb": "get", "requestPath": "/meta", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/meta", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/meta
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/meta", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/meta
    " }, { "lang": "JavaScript", @@ -12933,7 +13068,7 @@ { "verb": "get", "requestPath": "/networks/{owner}/{repo}/events", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -12977,8 +13112,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/networks/octocat/hello-world/events", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/networks/octocat/hello-world/events
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/networks/octocat/hello-world/events", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/networks/octocat/hello-world/events
    " }, { "lang": "JavaScript", @@ -13042,7 +13177,7 @@ { "verb": "get", "requestPath": "/notifications", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "all", @@ -13110,8 +13245,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/notifications", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/notifications
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/notifications", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/notifications
    " }, { "lang": "JavaScript", @@ -13176,13 +13311,13 @@ { "verb": "put", "requestPath": "/notifications", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/notifications \\\n -d '{\"last_read_at\":\"last_read_at\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/notifications \\\n  -d '{\"last_read_at\":\"last_read_at\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/notifications \\\n -d '{\"last_read_at\":\"last_read_at\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/notifications \\\n  -d '{\"last_read_at\":\"last_read_at\"}'
    " }, { "lang": "JavaScript", @@ -13296,7 +13431,7 @@ { "verb": "get", "requestPath": "/notifications/threads/{thread_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "thread_id", @@ -13312,8 +13447,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/notifications/threads/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/notifications/threads/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/notifications/threads/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/notifications/threads/42
    " }, { "lang": "JavaScript", @@ -13373,7 +13508,7 @@ { "verb": "patch", "requestPath": "/notifications/threads/{thread_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "thread_id", @@ -13389,8 +13524,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/notifications/threads/42", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/notifications/threads/42
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/notifications/threads/42", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/notifications/threads/42
    " }, { "lang": "JavaScript", @@ -13444,7 +13579,7 @@ { "verb": "get", "requestPath": "/notifications/threads/{thread_id}/subscription", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "thread_id", @@ -13460,8 +13595,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/notifications/threads/42/subscription", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/notifications/threads/42/subscription
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/notifications/threads/42/subscription", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/notifications/threads/42/subscription
    " }, { "lang": "JavaScript", @@ -13521,7 +13656,7 @@ { "verb": "put", "requestPath": "/notifications/threads/{thread_id}/subscription", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "thread_id", @@ -13537,8 +13672,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/notifications/threads/42/subscription \\\n -d '{\"ignored\":true}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/notifications/threads/42/subscription \\\n  -d '{\"ignored\":true}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/notifications/threads/42/subscription \\\n -d '{\"ignored\":true}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/notifications/threads/42/subscription \\\n  -d '{\"ignored\":true}'
    " }, { "lang": "JavaScript", @@ -13630,7 +13765,7 @@ { "verb": "delete", "requestPath": "/notifications/threads/{thread_id}/subscription", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "thread_id", @@ -13646,8 +13781,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/notifications/threads/42/subscription", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/notifications/threads/42/subscription
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/notifications/threads/42/subscription", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/notifications/threads/42/subscription
    " }, { "lang": "JavaScript", @@ -13682,7 +13817,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -13706,7 +13841,7 @@ { "verb": "get", "requestPath": "/octocat", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "s", @@ -13722,8 +13857,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/octocat", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/octocat
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/octocat", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/octocat
    " }, { "lang": "JavaScript", @@ -13760,7 +13895,7 @@ { "verb": "get", "requestPath": "/organizations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "since", @@ -13786,8 +13921,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/organizations", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/organizations
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/organizations", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/organizations
    " }, { "lang": "JavaScript", @@ -13835,7 +13970,7 @@ { "verb": "get", "requestPath": "/orgs/{org}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -13850,8 +13985,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG
    " }, { "lang": "JavaScript", @@ -13894,13 +14029,7 @@ "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "
    {\n  \"login\": \"github\",\n  \"id\": 1,\n  \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n  \"url\": \"https://api.github.com/orgs/github\",\n  \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n  \"events_url\": \"https://api.github.com/orgs/github/events\",\n  \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n  \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n  \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n  \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n  \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n  \"description\": \"A great organization\",\n  \"name\": \"github\",\n  \"company\": \"GitHub\",\n  \"blog\": \"https://github.com/blog\",\n  \"location\": \"San Francisco\",\n  \"email\": \"octocat@github.com\",\n  \"twitter_username\": \"github\",\n  \"is_verified\": true,\n  \"has_organization_projects\": true,\n  \"has_repository_projects\": true,\n  \"public_repos\": 2,\n  \"public_gists\": 1,\n  \"followers\": 20,\n  \"following\": 0,\n  \"html_url\": \"https://github.com/octocat\",\n  \"created_at\": \"2008-01-14T04:33:35Z\",\n  \"updated_at\": \"2014-03-03T18:58:10Z\",\n  \"type\": \"Organization\",\n  \"total_private_repos\": 100,\n  \"owned_private_repos\": 100,\n  \"private_gists\": 81,\n  \"disk_usage\": 10000,\n  \"collaborators\": 8,\n  \"billing_email\": \"mona@github.com\",\n  \"plan\": {\n    \"name\": \"Medium\",\n    \"space\": 400,\n    \"private_repos\": 20\n  },\n  \"default_repository_permission\": \"read\",\n  \"members_can_create_repositories\": true,\n  \"two_factor_requirement_enabled\": true,\n  \"members_allowed_repository_creation_type\": \"all\",\n  \"members_can_create_public_repositories\": false,\n  \"members_can_create_private_repositories\": false,\n  \"members_can_create_internal_repositories\": false,\n  \"members_can_create_pages\": true\n}\n
    " - }, - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response with GitHub plan information", - "payload": "
    {\n  \"login\": \"github\",\n  \"id\": 1,\n  \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n  \"url\": \"https://api.github.com/orgs/github\",\n  \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n  \"events_url\": \"https://api.github.com/orgs/github/events\",\n  \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n  \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n  \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n  \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n  \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n  \"description\": \"A great organization\",\n  \"name\": \"github\",\n  \"company\": \"GitHub\",\n  \"blog\": \"https://github.com/blog\",\n  \"location\": \"San Francisco\",\n  \"email\": \"octocat@github.com\",\n  \"twitter_username\": \"github\",\n  \"is_verified\": true,\n  \"has_organization_projects\": true,\n  \"has_repository_projects\": true,\n  \"public_repos\": 2,\n  \"public_gists\": 1,\n  \"followers\": 20,\n  \"following\": 0,\n  \"html_url\": \"https://github.com/octocat\",\n  \"created_at\": \"2008-01-14T04:33:35Z\",\n  \"updated_at\": \"2014-03-03T18:58:10Z\",\n  \"type\": \"Organization\",\n  \"plan\": {\n    \"name\": \"team\",\n    \"space\": 976562499,\n    \"private_repos\": 999999,\n    \"filled_seats\": 4,\n    \"seats\": 5\n  }\n}\n
    " + "payload": "
    {\n  \"login\": \"github\",\n  \"id\": 1,\n  \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n  \"url\": \"https://api.github.com/orgs/github\",\n  \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n  \"events_url\": \"https://api.github.com/orgs/github/events\",\n  \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n  \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n  \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n  \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n  \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n  \"description\": \"A great organization\",\n  \"name\": \"github\",\n  \"company\": \"GitHub\",\n  \"blog\": \"https://github.com/blog\",\n  \"location\": \"San Francisco\",\n  \"email\": \"octocat@github.com\",\n  \"twitter_username\": \"github\",\n  \"is_verified\": true,\n  \"has_organization_projects\": true,\n  \"has_repository_projects\": true,\n  \"public_repos\": 2,\n  \"public_gists\": 1,\n  \"followers\": 20,\n  \"following\": 0,\n  \"html_url\": \"https://github.com/octocat\",\n  \"created_at\": \"2008-01-14T04:33:35Z\",\n  \"updated_at\": \"2014-03-03T18:58:10Z\",\n  \"type\": \"Organization\",\n  \"total_private_repos\": 100,\n  \"owned_private_repos\": 100,\n  \"private_gists\": 81,\n  \"disk_usage\": 10000,\n  \"collaborators\": 8,\n  \"billing_email\": \"mona@github.com\",\n  \"plan\": {\n    \"name\": \"Medium\",\n    \"space\": 400,\n    \"private_repos\": 20,\n    \"filled_seats\": 4,\n    \"seats\": 5\n  },\n  \"default_repository_permission\": \"read\",\n  \"members_can_create_repositories\": true,\n  \"two_factor_requirement_enabled\": true,\n  \"members_allowed_repository_creation_type\": \"all\",\n  \"members_can_create_public_repositories\": false,\n  \"members_can_create_private_repositories\": false,\n  \"members_can_create_internal_repositories\": false,\n  \"members_can_create_pages\": true\n}\n
    " }, { "httpStatusCode": "404", @@ -13912,7 +14041,7 @@ { "verb": "patch", "requestPath": "/orgs/{org}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -13927,8 +14056,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG \\\n -d '{\"billing_email\":\"billing_email\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG \\\n  -d '{\"billing_email\":\"billing_email\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG \\\n -d '{\"billing_email\":\"billing_email\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG \\\n  -d '{\"billing_email\":\"billing_email\"}'
    " }, { "lang": "JavaScript", @@ -14331,7 +14460,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/actions/runner-groups", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -14366,8 +14495,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/runner-groups", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/runner-groups
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/actions/runner-groups", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/actions/runner-groups
    " }, { "lang": "JavaScript", @@ -14412,7 +14541,7 @@ { "verb": "post", "requestPath": "/orgs/{org}/actions/runner-groups", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -14427,8 +14556,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/runner-groups \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/runner-groups \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/actions/runner-groups \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/actions/runner-groups \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -14600,7 +14729,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -14625,8 +14754,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/runner-groups/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/runner-groups/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/actions/runner-groups/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/actions/runner-groups/42
    " }, { "lang": "JavaScript", @@ -14671,7 +14800,7 @@ { "verb": "patch", "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -14696,8 +14825,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/runner-groups/42 \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/runner-groups/42 \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/actions/runner-groups/42 \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/actions/runner-groups/42 \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -14804,7 +14933,7 @@ { "verb": "delete", "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -14829,8 +14958,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/runner-groups/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/runner-groups/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/actions/runner-groups/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/actions/runner-groups/42
    " }, { "lang": "JavaScript", @@ -14865,7 +14994,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -14874,7 +15003,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -14894,13 +15023,33 @@ "type": "integer" }, "descriptionHTML": "

    Unique identifier of the self-hosted runner group.

    " + }, + { + "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.

    " + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "descriptionHTML": "

    Results per page (max 100).

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/runner-groups/42/repositories", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/runner-groups/42/repositories
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/actions/runner-groups/42/repositories", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/actions/runner-groups/42/repositories
    " }, { "lang": "JavaScript", @@ -14945,7 +15094,7 @@ { "verb": "put", "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -14970,8 +15119,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/runner-groups/42/repositories \\\n -d '{\"selected_repository_ids\":[42]}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/runner-groups/42/repositories \\\n  -d '{\"selected_repository_ids\":[42]}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/actions/runner-groups/42/repositories \\\n -d '{\"selected_repository_ids\":[42]}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/actions/runner-groups/42/repositories \\\n  -d '{\"selected_repository_ids\":[42]}'
    " }, { "lang": "JavaScript", @@ -15039,7 +15188,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "descriptionHTML": "

    Replaces the list of repositories that have access to a self-hosted runner group configured in an organization.\nYou must authenticate using an access token with the admin:org scope to use this endpoint.

    ", @@ -15062,7 +15211,7 @@ { "verb": "put", "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -15096,8 +15245,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/runner-groups/42/repositories/42", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/runner-groups/42/repositories/42
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/actions/runner-groups/42/repositories/42", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/actions/runner-groups/42/repositories/42
    " }, { "lang": "JavaScript", @@ -15132,7 +15281,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -15141,7 +15290,7 @@ { "verb": "delete", "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -15175,8 +15324,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/runner-groups/42/repositories/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/runner-groups/42/repositories/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/actions/runner-groups/42/repositories/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/actions/runner-groups/42/repositories/42
    " }, { "lang": "JavaScript", @@ -15211,7 +15360,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -15220,7 +15369,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -15265,8 +15414,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/runner-groups/42/runners", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/runner-groups/42/runners
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/actions/runner-groups/42/runners", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/actions/runner-groups/42/runners
    " }, { "lang": "JavaScript", @@ -15311,7 +15460,7 @@ { "verb": "put", "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -15336,8 +15485,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/runner-groups/42/runners \\\n -d '{\"runners\":[42]}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/runner-groups/42/runners \\\n  -d '{\"runners\":[42]}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/actions/runner-groups/42/runners \\\n -d '{\"runners\":[42]}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/actions/runner-groups/42/runners \\\n  -d '{\"runners\":[42]}'
    " }, { "lang": "JavaScript", @@ -15405,7 +15554,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "descriptionHTML": "

    Replaces the list of self-hosted runners that are part of an organization runner group.\nYou must authenticate using an access token with the admin:org scope to use this endpoint.

    ", @@ -15428,7 +15577,7 @@ { "verb": "put", "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -15463,8 +15612,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/runner-groups/42/runners/42", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/runner-groups/42/runners/42
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/actions/runner-groups/42/runners/42", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/actions/runner-groups/42/runners/42
    " }, { "lang": "JavaScript", @@ -15499,7 +15648,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -15508,7 +15657,7 @@ { "verb": "delete", "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -15543,8 +15692,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/runner-groups/42/runners/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/runner-groups/42/runners/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/actions/runner-groups/42/runners/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/actions/runner-groups/42/runners/42
    " }, { "lang": "JavaScript", @@ -15579,7 +15728,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -15588,7 +15737,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/actions/runners", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -15623,8 +15772,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/runners", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/runners
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/actions/runners", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/actions/runners
    " }, { "lang": "JavaScript", @@ -15669,7 +15818,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/actions/runners/downloads", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -15684,8 +15833,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/runners/downloads", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/runners/downloads
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/actions/runners/downloads", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/actions/runners/downloads
    " }, { "lang": "JavaScript", @@ -15730,7 +15879,7 @@ { "verb": "post", "requestPath": "/orgs/{org}/actions/runners/registration-token", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -15745,8 +15894,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/runners/registration-token", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/runners/registration-token
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/actions/runners/registration-token", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/actions/runners/registration-token
    " }, { "lang": "JavaScript", @@ -15791,7 +15940,7 @@ { "verb": "post", "requestPath": "/orgs/{org}/actions/runners/remove-token", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -15806,8 +15955,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/runners/remove-token", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/runners/remove-token
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/actions/runners/remove-token", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/actions/runners/remove-token
    " }, { "lang": "JavaScript", @@ -15852,7 +16001,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/actions/runners/{runner_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -15877,8 +16026,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/runners/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/runners/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/actions/runners/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/actions/runners/42
    " }, { "lang": "JavaScript", @@ -15923,7 +16072,7 @@ { "verb": "delete", "requestPath": "/orgs/{org}/actions/runners/{runner_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -15948,8 +16097,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/runners/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/runners/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/actions/runners/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/actions/runners/42
    " }, { "lang": "JavaScript", @@ -15984,7 +16133,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -15993,7 +16142,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/actions/secrets", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -16028,8 +16177,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/secrets", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/secrets
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/actions/secrets", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/actions/secrets
    " }, { "lang": "JavaScript", @@ -16074,7 +16223,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/actions/secrets/public-key", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -16089,8 +16238,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/secrets/public-key", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/secrets/public-key
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/actions/secrets/public-key", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/actions/secrets/public-key
    " }, { "lang": "JavaScript", @@ -16135,7 +16284,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/actions/secrets/{secret_name}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -16160,8 +16309,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/secrets/SECRET_NAME", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/secrets/SECRET_NAME
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/actions/secrets/SECRET_NAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/actions/secrets/SECRET_NAME
    " }, { "lang": "JavaScript", @@ -16206,7 +16355,7 @@ { "verb": "put", "requestPath": "/orgs/{org}/actions/secrets/{secret_name}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -16231,8 +16380,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/secrets/SECRET_NAME \\\n -d '{\"encrypted_value\":\"encrypted_value\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/secrets/SECRET_NAME \\\n  -d '{\"encrypted_value\":\"encrypted_value\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/actions/secrets/SECRET_NAME \\\n -d '{\"encrypted_value\":\"encrypted_value\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/actions/secrets/SECRET_NAME \\\n  -d '{\"encrypted_value\":\"encrypted_value\"}'
    " }, { "lang": "JavaScript", @@ -16259,6 +16408,7 @@ "encrypted_value": { "type": "string", "description": "

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an organization public key endpoint.

    ", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", "rawType": "string", @@ -16303,7 +16453,7 @@ } }, "example": { - "encrypted_value": "****************************************************************************************", + "encrypted_value": "c2VjcmV0", "key_id": "012345678912345678", "visibility": "selected", "selected_repository_ids": [ @@ -16344,6 +16494,7 @@ { "type": "string", "description": "

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an organization public key endpoint.

    ", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", "rawType": "string", @@ -16390,7 +16541,7 @@ { "verb": "delete", "requestPath": "/orgs/{org}/actions/secrets/{secret_name}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -16415,8 +16566,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/secrets/SECRET_NAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/secrets/SECRET_NAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/actions/secrets/SECRET_NAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/actions/secrets/SECRET_NAME
    " }, { "lang": "JavaScript", @@ -16451,7 +16602,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -16460,7 +16611,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/actions/secrets/{secret_name}/repositories", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -16480,13 +16631,33 @@ "type": "string" }, "descriptionHTML": "

    secret_name parameter

    " + }, + { + "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.

    " + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "descriptionHTML": "

    Results per page (max 100).

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/secrets/SECRET_NAME/repositories", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/secrets/SECRET_NAME/repositories
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/actions/secrets/SECRET_NAME/repositories", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/actions/secrets/SECRET_NAME/repositories
    " }, { "lang": "JavaScript", @@ -16531,7 +16702,7 @@ { "verb": "put", "requestPath": "/orgs/{org}/actions/secrets/{secret_name}/repositories", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -16556,8 +16727,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/secrets/SECRET_NAME/repositories \\\n -d '{\"selected_repository_ids\":[42]}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/secrets/SECRET_NAME/repositories \\\n  -d '{\"selected_repository_ids\":[42]}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/actions/secrets/SECRET_NAME/repositories \\\n -d '{\"selected_repository_ids\":[42]}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/actions/secrets/SECRET_NAME/repositories \\\n  -d '{\"selected_repository_ids\":[42]}'
    " }, { "lang": "JavaScript", @@ -16620,7 +16791,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "descriptionHTML": "

    Replaces all repositories for an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the secrets organization permission to use this endpoint.

    ", @@ -16642,7 +16813,7 @@ { "verb": "put", "requestPath": "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -16676,8 +16847,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/secrets/SECRET_NAME/repositories/42", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/secrets/SECRET_NAME/repositories/42
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/actions/secrets/SECRET_NAME/repositories/42", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/actions/secrets/SECRET_NAME/repositories/42
    " }, { "lang": "JavaScript", @@ -16726,7 +16897,7 @@ { "verb": "delete", "requestPath": "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -16760,8 +16931,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/secrets/SECRET_NAME/repositories/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/secrets/SECRET_NAME/repositories/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/actions/secrets/SECRET_NAME/repositories/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/actions/secrets/SECRET_NAME/repositories/42
    " }, { "lang": "JavaScript", @@ -16810,7 +16981,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/events", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -16845,8 +17016,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/events", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/events
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/events", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/events
    " }, { "lang": "JavaScript", @@ -16890,7 +17061,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/hooks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -16925,8 +17096,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/hooks", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/hooks
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/hooks", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/hooks
    " }, { "lang": "JavaScript", @@ -16976,7 +17147,7 @@ { "verb": "post", "requestPath": "/orgs/{org}/hooks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -16991,8 +17162,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/hooks \\\n -d '{\"name\":\"name\",\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"username\":\"username\",\"password\":\"password\"}}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/hooks \\\n  -d '{\"name\":\"name\",\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"username\":\"username\",\"password\":\"password\"}}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/hooks \\\n -d '{\"name\":\"name\",\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"username\":\"username\",\"password\":\"password\"}}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/hooks \\\n  -d '{\"name\":\"name\",\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"username\":\"username\",\"password\":\"password\"}}'
    " }, { "lang": "JavaScript", @@ -17423,7 +17594,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/hooks/{hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -17447,8 +17618,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/hooks/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/hooks/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/hooks/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/hooks/42
    " }, { "lang": "JavaScript", @@ -17498,7 +17669,7 @@ { "verb": "patch", "requestPath": "/orgs/{org}/hooks/{hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -17522,8 +17693,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/hooks/42 \\\n -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/hooks/42 \\\n  -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/hooks/42 \\\n -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/hooks/42 \\\n  -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'
    " }, { "lang": "JavaScript", @@ -17872,7 +18043,7 @@ { "verb": "delete", "requestPath": "/orgs/{org}/hooks/{hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -17896,8 +18067,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/hooks/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/hooks/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/hooks/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/hooks/42
    " }, { "lang": "JavaScript", @@ -17932,7 +18103,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -17946,7 +18117,7 @@ { "verb": "post", "requestPath": "/orgs/{org}/hooks/{hook_id}/pings", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -17970,8 +18141,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/hooks/42/pings", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/hooks/42/pings
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/hooks/42/pings", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/hooks/42/pings
    " }, { "lang": "JavaScript", @@ -18006,7 +18177,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -18020,7 +18191,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/installation", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -18035,8 +18206,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/installation", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/installation
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/installation", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/installation
    " }, { "lang": "JavaScript", @@ -18079,7 +18250,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/installations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -18114,8 +18285,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/installations", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/installations
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/installations", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/installations
    " }, { "lang": "JavaScript", @@ -18158,7 +18329,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/issues", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -18181,6 +18352,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -18278,8 +18450,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/issues", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/issues
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/issues", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/issues
    " }, { "lang": "JavaScript", @@ -18334,7 +18506,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/members", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -18400,8 +18572,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/members", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/members
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/members", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/members
    " }, { "lang": "JavaScript", @@ -18456,7 +18628,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/members/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -18480,8 +18652,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/members/USERNAME", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/members/USERNAME
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/members/USERNAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/members/USERNAME
    " }, { "lang": "JavaScript", @@ -18535,7 +18707,7 @@ { "verb": "delete", "requestPath": "/orgs/{org}/members/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -18559,8 +18731,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/members/USERNAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/members/USERNAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/members/USERNAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/members/USERNAME
    " }, { "lang": "JavaScript", @@ -18595,7 +18767,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -18609,7 +18781,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/memberships/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -18633,8 +18805,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/memberships/USERNAME", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/memberships/USERNAME
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/memberships/USERNAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/memberships/USERNAME
    " }, { "lang": "JavaScript", @@ -18643,7 +18815,7 @@ } ], "summary": "Get organization membership for a user", - "description": "In order to get a user's membership with an organization, the authenticated user must be an organization member.", + "description": "In order to get a user's membership with an organization, the authenticated user must be an organization member. The `state` parameter in the response can be used to identify the user's membership status.", "tags": [ "orgs" ], @@ -18666,7 +18838,7 @@ "subcategoryLabel": "Members", "notes": [], "bodyParameters": [], - "descriptionHTML": "

    In order to get a user's membership with an organization, the authenticated user must be an organization member.

    ", + "descriptionHTML": "

    In order to get a user's membership with an organization, the authenticated user must be an organization member. The state parameter in the response can be used to identify the user's membership status.

    ", "responses": [ { "httpStatusCode": "200", @@ -18674,18 +18846,6 @@ "description": "Response if user has an active admin membership with organization", "payload": "
    {\n  \"url\": \"https://api.github.com/orgs/octocat/memberships/defunkt\",\n  \"state\": \"active\",\n  \"role\": \"admin\",\n  \"organization_url\": \"https://api.github.com/orgs/octocat\",\n  \"organization\": {\n    \"login\": \"github\",\n    \"id\": 1,\n    \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n    \"url\": \"https://api.github.com/orgs/github\",\n    \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n    \"events_url\": \"https://api.github.com/orgs/github/events\",\n    \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n    \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n    \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n    \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"description\": \"A great organization\"\n  },\n  \"user\": {\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
    " }, - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response if user has an active membership with organization", - "payload": "
    {\n  \"url\": \"https://api.github.com/orgs/octocat/memberships/defunkt\",\n  \"state\": \"active\",\n  \"role\": \"member\",\n  \"organization_url\": \"https://api.github.com/orgs/octocat\",\n  \"organization\": {\n    \"login\": \"github\",\n    \"id\": 1,\n    \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n    \"url\": \"https://api.github.com/orgs/github\",\n    \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n    \"events_url\": \"https://api.github.com/orgs/github/events\",\n    \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n    \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n    \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n    \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"description\": \"A great organization\"\n  },\n  \"user\": {\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
    " - }, - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response if user has a pending membership with organization", - "payload": "
    {\n  \"url\": \"https://api.github.com/orgs/invitocat/memberships/defunkt\",\n  \"state\": \"pending\",\n  \"role\": \"member\",\n  \"organization_url\": \"https://api.github.com/orgs/invitocat\",\n  \"organization\": {\n    \"login\": \"github\",\n    \"id\": 1,\n    \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n    \"url\": \"https://api.github.com/orgs/github\",\n    \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n    \"events_url\": \"https://api.github.com/orgs/github/events\",\n    \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n    \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n    \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n    \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"description\": \"A great organization\"\n  },\n  \"user\": {\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
    " - }, { "httpStatusCode": "403", "httpStatusMessage": "Forbidden", @@ -18701,7 +18861,7 @@ { "verb": "put", "requestPath": "/orgs/{org}/memberships/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -18725,8 +18885,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/memberships/USERNAME \\\n -d '{\"role\":\"role\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/memberships/USERNAME \\\n  -d '{\"role\":\"role\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/memberships/USERNAME \\\n -d '{\"role\":\"role\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/memberships/USERNAME \\\n  -d '{\"role\":\"role\"}'
    " }, { "lang": "JavaScript", @@ -18803,13 +18963,7 @@ { "httpStatusCode": "200", "httpStatusMessage": "OK", - "description": "Response if user was previously unaffiliated with organization", - "payload": "
    {\n  \"url\": \"https://api.github.com/orgs/invitocat/memberships/defunkt\",\n  \"state\": \"pending\",\n  \"role\": \"admin\",\n  \"organization_url\": \"https://api.github.com/orgs/invitocat\",\n  \"organization\": {\n    \"login\": \"github\",\n    \"id\": 1,\n    \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n    \"url\": \"https://api.github.com/orgs/github\",\n    \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n    \"events_url\": \"https://api.github.com/orgs/github/events\",\n    \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n    \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n    \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n    \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"description\": \"A great organization\"\n  },\n  \"user\": {\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
    " - }, - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response if user already had membership with organization", + "description": "Response if user has an active admin membership with organization", "payload": "
    {\n  \"url\": \"https://api.github.com/orgs/octocat/memberships/defunkt\",\n  \"state\": \"active\",\n  \"role\": \"admin\",\n  \"organization_url\": \"https://api.github.com/orgs/octocat\",\n  \"organization\": {\n    \"login\": \"github\",\n    \"id\": 1,\n    \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n    \"url\": \"https://api.github.com/orgs/github\",\n    \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n    \"events_url\": \"https://api.github.com/orgs/github/events\",\n    \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n    \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n    \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n    \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"description\": \"A great organization\"\n  },\n  \"user\": {\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
    " }, { @@ -18827,7 +18981,7 @@ { "verb": "delete", "requestPath": "/orgs/{org}/memberships/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -18851,8 +19005,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/memberships/USERNAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/memberships/USERNAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/memberships/USERNAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/memberships/USERNAME
    " }, { "lang": "JavaScript", @@ -18887,7 +19041,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -18906,7 +19060,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/outside_collaborators", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -18956,8 +19110,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/outside_collaborators", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/outside_collaborators
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/outside_collaborators", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/outside_collaborators
    " }, { "lang": "JavaScript", @@ -19002,7 +19156,7 @@ { "verb": "put", "requestPath": "/orgs/{org}/outside_collaborators/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -19026,8 +19180,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/outside_collaborators/USERNAME", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/outside_collaborators/USERNAME
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/outside_collaborators/USERNAME", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/outside_collaborators/USERNAME
    " }, { "lang": "JavaScript", @@ -19058,8 +19212,6 @@ "subcategory": "outside-collaborators", "subcategoryLabel": "Outside collaborators", "notes": [], - "bodyParameters": [], - "descriptionHTML": "

    When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"Converting an organization member to an outside collaborator\".

    ", "responses": [ { "httpStatusCode": "202", @@ -19074,26 +19226,21 @@ { "httpStatusCode": "403", "httpStatusMessage": "Forbidden", - "description": "Response if user is the last owner of the organization", - "payload": "
    {\n  \"message\": \"Cannot convert the last owner to an outside collaborator\",\n  \"documentation_url\": \"https://docs.github.com/enterprise-server@2.22/rest/reference/orgs#convert-member-to-outside-collaborator\"\n}\n
    " - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Response if user is not a member of the organization", - "payload": "
    {\n  \"message\": \"<user> is not a member of the <organization> organization.\",\n  \"documentation_url\": \"https://docs.github.com/enterprise-server@2.22/rest/reference/orgs#convert-member-to-outside-collaborator\"\n}\n
    " + "description": "Response if user is the last owner of the organization or not a member of the organization" }, { "httpStatusCode": "404", "httpStatusMessage": "Not Found", "description": "Resource not found" } - ] + ], + "bodyParameters": [], + "descriptionHTML": "

    When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"Converting an organization member to an outside collaborator\".

    " }, { "verb": "delete", "requestPath": "/orgs/{org}/outside_collaborators/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -19117,8 +19264,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/outside_collaborators/USERNAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/outside_collaborators/USERNAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/outside_collaborators/USERNAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/outside_collaborators/USERNAME
    " }, { "lang": "JavaScript", @@ -19155,7 +19302,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "422", @@ -19168,7 +19315,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/pre-receive-hooks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -19198,13 +19345,44 @@ "default": 1 }, "descriptionHTML": "

    Page number of the results to fetch.

    " + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + }, + "descriptionHTML": "

    One of asc (ascending) or desc (descending).

    " + }, + { + "name": "sort", + "description": "The sort order for the response collection.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + }, + "descriptionHTML": "

    The sort order for the response collection.

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/orgs/ORG/pre-receive-hooks", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/orgs/ORG/pre-receive-hooks
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/pre-receive-hooks", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/pre-receive-hooks
    " }, { "lang": "JavaScript", @@ -19256,7 +19434,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -19280,8 +19458,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/orgs/ORG/pre-receive-hooks/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/orgs/ORG/pre-receive-hooks/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/pre-receive-hooks/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/pre-receive-hooks/42
    " }, { "lang": "JavaScript", @@ -19333,7 +19511,7 @@ { "verb": "patch", "requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -19357,8 +19535,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/orgs/ORG/pre-receive-hooks/42 \\\n -d '{\"enforcement\":\"enforcement\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/orgs/ORG/pre-receive-hooks/42 \\\n  -d '{\"enforcement\":\"enforcement\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/pre-receive-hooks/42 \\\n -d '{\"enforcement\":\"enforcement\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/pre-receive-hooks/42 \\\n  -d '{\"enforcement\":\"enforcement\"}'
    " }, { "lang": "JavaScript", @@ -19462,7 +19640,7 @@ { "verb": "delete", "requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -19486,8 +19664,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/orgs/ORG/pre-receive-hooks/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/orgs/ORG/pre-receive-hooks/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/pre-receive-hooks/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/pre-receive-hooks/42
    " }, { "lang": "JavaScript", @@ -19539,7 +19717,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/projects", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -19590,8 +19768,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/orgs/ORG/projects", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/orgs/ORG/projects
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/projects", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/projects
    " }, { "lang": "JavaScript", @@ -19646,7 +19824,7 @@ { "verb": "post", "requestPath": "/orgs/{org}/projects", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -19661,8 +19839,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/orgs/ORG/projects \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/orgs/ORG/projects \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/projects \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/projects \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -19792,7 +19970,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/public_members", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -19827,8 +20005,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/public_members", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/public_members
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/public_members", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/public_members
    " }, { "lang": "JavaScript", @@ -19873,7 +20051,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/public_members/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -19897,8 +20075,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/public_members/USERNAME", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/public_members/USERNAME
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/public_members/USERNAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/public_members/USERNAME
    " }, { "lang": "JavaScript", @@ -19947,7 +20125,7 @@ { "verb": "put", "requestPath": "/orgs/{org}/public_members/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -19971,8 +20149,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/public_members/USERNAME", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/public_members/USERNAME
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/public_members/USERNAME", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/public_members/USERNAME
    " }, { "lang": "JavaScript", @@ -20007,7 +20185,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -20021,7 +20199,7 @@ { "verb": "delete", "requestPath": "/orgs/{org}/public_members/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -20045,8 +20223,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/public_members/USERNAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/public_members/USERNAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/public_members/USERNAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/public_members/USERNAME
    " }, { "lang": "JavaScript", @@ -20081,7 +20259,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -20090,7 +20268,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/repos", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -20103,7 +20281,7 @@ }, { "name": "type", - "description": "Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`.", + "description": "Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Note: For GitHub AE, can be one of `all`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`.", "in": "query", "required": false, "schema": { @@ -20118,7 +20296,7 @@ "internal" ] }, - "descriptionHTML": "

    Specifies the types of repositories you want returned. Can be one of all, public, private, forks, sources, member, internal. Default: all. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, type can also be internal.

    " + "descriptionHTML": "

    Specifies the types of repositories you want returned. Can be one of all, public, private, forks, sources, member, internal. Note: For GitHub AE, can be one of all, private, forks, sources, member, internal. Default: all. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, type can also be internal.

    " }, { "name": "sort", @@ -20175,8 +20353,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/repos", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/repos
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/repos", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/repos
    " }, { "lang": "JavaScript", @@ -20232,7 +20410,7 @@ { "verb": "post", "requestPath": "/orgs/{org}/repos", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -20247,8 +20425,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/repos \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/repos \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/repos \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/repos \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -20257,7 +20435,7 @@ } ], "summary": "Create an organization repository", - "description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", + "description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository", "tags": [ "repos" ], @@ -20301,17 +20479,17 @@ }, "private": { "type": "boolean", - "description": "

    Either true to create a private repository or false to create a public one.

    ", + "description": "

    Whether the repository is private.

    ", "default": false, "name": "private", "in": "body", "rawType": "boolean", - "rawDescription": "Either `true` to create a private repository or `false` to create a public one.", + "rawDescription": "Whether the repository is private.", "childParamsGroups": [] }, "visibility": { "type": "string", - "description": "

    Can be public or private. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be internal. For more information, see \"Creating an internal repository\" in the GitHub Help documentation.
    \nThe visibility parameter overrides the private parameter when you use both parameters with the nebula-preview preview header.

    ", + "description": "

    Can be public or private. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be internal. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"Creating an internal repository\" in the GitHub Help documentation.
    \nThe visibility parameter overrides the private parameter when you use both parameters with the nebula-preview preview header.

    ", "enum": [ "public", "private", @@ -20321,7 +20499,7 @@ "name": "visibility", "in": "body", "rawType": "string", - "rawDescription": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", + "rawDescription": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", "childParamsGroups": [] }, "has_issues": { @@ -20482,7 +20660,7 @@ "category": "repos", "categoryLabel": "Repos", "notes": [], - "descriptionHTML": "

    Creates a new repository in the specified organization. The authenticated user must be a member of the organization.

    \n

    OAuth scope requirements

    \n

    When using OAuth, authorizations must include:

    \n
      \n
    • public_repo scope or repo scope to create a public repository
    • \n
    • repo scope to create a private repository
    • \n
    ", + "descriptionHTML": "

    Creates a new repository in the specified organization. The authenticated user must be a member of the organization.

    \n

    OAuth scope requirements

    \n

    When using OAuth, authorizations must include:

    \n
      \n
    • public_repo scope or repo scope to create a public repository. Note: For GitHub AE, use repo scope to create an internal repository.
    • \n
    • repo scope to create a private repository
    • \n
    ", "bodyParameters": [ { "type": "string", @@ -20513,17 +20691,17 @@ }, { "type": "boolean", - "description": "

    Either true to create a private repository or false to create a public one.

    ", + "description": "

    Whether the repository is private.

    ", "default": false, "name": "private", "in": "body", "rawType": "boolean", - "rawDescription": "Either `true` to create a private repository or `false` to create a public one.", + "rawDescription": "Whether the repository is private.", "childParamsGroups": [] }, { "type": "string", - "description": "

    Can be public or private. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be internal. For more information, see \"Creating an internal repository\" in the GitHub Help documentation.
    \nThe visibility parameter overrides the private parameter when you use both parameters with the nebula-preview preview header.

    ", + "description": "

    Can be public or private. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be internal. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"Creating an internal repository\" in the GitHub Help documentation.
    \nThe visibility parameter overrides the private parameter when you use both parameters with the nebula-preview preview header.

    ", "enum": [ "public", "private", @@ -20533,7 +20711,7 @@ "name": "visibility", "in": "body", "rawType": "string", - "rawDescription": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", + "rawDescription": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", "childParamsGroups": [] }, { @@ -20676,7 +20854,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/teams", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -20711,8 +20889,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams
    " }, { "lang": "JavaScript", @@ -20760,7 +20938,7 @@ { "verb": "post", "requestPath": "/orgs/{org}/teams", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -20775,8 +20953,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -21008,7 +21186,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -21033,8 +21211,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG
    " }, { "lang": "JavaScript", @@ -21082,7 +21260,7 @@ { "verb": "patch", "requestPath": "/orgs/{org}/teams/{team_slug}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -21107,8 +21285,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -21280,7 +21458,7 @@ { "verb": "delete", "requestPath": "/orgs/{org}/teams/{team_slug}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -21305,8 +21483,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG
    " }, { "lang": "JavaScript", @@ -21339,7 +21517,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -21348,7 +21526,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -21403,13 +21581,23 @@ "default": 1 }, "descriptionHTML": "

    Page number of the results to fetch.

    " + }, + { + "name": "pinned", + "in": "query", + "required": false, + "description": "Pinned discussions only filter", + "schema": { + "type": "string" + }, + "descriptionHTML": "

    Pinned discussions only filter

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions
    " }, { "lang": "JavaScript", @@ -21461,7 +21649,7 @@ { "verb": "post", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -21486,8 +21674,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions \\\n -d '{\"title\":\"title\",\"body\":\"body\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions \\\n  -d '{\"title\":\"title\",\"body\":\"body\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions \\\n -d '{\"title\":\"title\",\"body\":\"body\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions \\\n  -d '{\"title\":\"title\",\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -21616,7 +21804,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -21650,8 +21838,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42
    " }, { "lang": "JavaScript", @@ -21703,7 +21891,7 @@ { "verb": "patch", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -21737,8 +21925,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42 \\\n -d '{\"title\":\"title\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42 \\\n  -d '{\"title\":\"title\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42 \\\n -d '{\"title\":\"title\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42 \\\n  -d '{\"title\":\"title\"}'
    " }, { "lang": "JavaScript", @@ -21841,7 +22029,7 @@ { "verb": "delete", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -21875,8 +22063,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42
    " }, { "lang": "JavaScript", @@ -21911,7 +22099,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -21920,7 +22108,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -21989,8 +22177,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments
    " }, { "lang": "JavaScript", @@ -22042,7 +22230,7 @@ { "verb": "post", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -22076,8 +22264,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -22166,7 +22354,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -22209,8 +22397,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42
    " }, { "lang": "JavaScript", @@ -22262,7 +22450,7 @@ { "verb": "patch", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -22305,8 +22493,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42 \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42 \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42 \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42 \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -22394,7 +22582,7 @@ { "verb": "delete", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -22437,8 +22625,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42
    " }, { "lang": "JavaScript", @@ -22473,7 +22661,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -22482,7 +22670,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -22565,8 +22753,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42/reactions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42/reactions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42/reactions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42/reactions
    " }, { "lang": "JavaScript", @@ -22616,7 +22804,7 @@ { "verb": "post", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -22659,8 +22847,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42/reactions \\\n -d '{\"content\":\"content\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42/reactions \\\n -d '{\"content\":\"content\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " }, { "lang": "JavaScript", @@ -22766,7 +22954,7 @@ { "verb": "delete", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -22818,8 +23006,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42/reactions/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42/reactions/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42/reactions/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42/reactions/42
    " }, { "lang": "JavaScript", @@ -22859,7 +23047,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -22868,7 +23056,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -22942,8 +23130,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/reactions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/reactions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42/reactions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42/reactions
    " }, { "lang": "JavaScript", @@ -22993,7 +23181,7 @@ { "verb": "post", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -23027,8 +23215,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/reactions \\\n -d '{\"content\":\"content\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42/reactions \\\n -d '{\"content\":\"content\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " }, { "lang": "JavaScript", @@ -23134,7 +23322,7 @@ { "verb": "delete", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -23177,8 +23365,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/reactions/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/reactions/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42/reactions/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42/reactions/42
    " }, { "lang": "JavaScript", @@ -23218,7 +23406,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -23227,7 +23415,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/members", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -23288,8 +23476,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/members", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/members
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/members", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/members
    " }, { "lang": "JavaScript", @@ -23334,7 +23522,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/memberships/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -23368,8 +23556,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/memberships/USERNAME", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/memberships/USERNAME
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/memberships/USERNAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/memberships/USERNAME
    " }, { "lang": "JavaScript", @@ -23378,7 +23566,7 @@ } ], "summary": "Get team membership for a user", - "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.\n\n**Note:** The `role` for organization owners returns as `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@2.22/rest/reference/teams#create-a-team).", + "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.\n\n**Note:**\nThe response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see see [Create a team](https://docs.github.com/enterprise-server@2.22/rest/reference/teams#create-a-team).", "tags": [ "teams" ], @@ -23401,26 +23589,14 @@ "subcategoryLabel": "Members", "notes": [], "bodyParameters": [], - "descriptionHTML": "

    Team members will include the members of child teams.

    \n

    To get a user's membership with a team, the team must be visible to the authenticated user.

    \n

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

    \n

    Note: The role for organization owners returns as maintainer. For more information about maintainer roles, see Create a team.

    ", + "descriptionHTML": "

    Team members will include the members of child teams.

    \n

    To get a user's membership with a team, the team must be visible to the authenticated user.

    \n

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

    \n

    Note:\nThe response contains the state of the membership and the member's role.

    \n

    The role for organization owners is set to maintainer. For more information about maintainer roles, see see Create a team.

    ", "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response if user has an active membership with team", - "payload": "
    {\n  \"url\": \"https://api.github.com/teams/1/memberships/octocat\",\n  \"role\": \"member\",\n  \"state\": \"active\"\n}\n
    " - }, { "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Response if user is a team maintainer", "payload": "
    {\n  \"url\": \"https://api.github.com/teams/1/memberships/octocat\",\n  \"role\": \"maintainer\",\n  \"state\": \"active\"\n}\n
    " }, - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response if user has a pending membership with team", - "payload": "
    {\n  \"url\": \"https://api.github.com/teams/1/memberships/octocat\",\n  \"role\": \"member\",\n  \"state\": \"pending\"\n}\n
    " - }, { "httpStatusCode": "404", "httpStatusMessage": "Not Found", @@ -23431,7 +23607,7 @@ { "verb": "put", "requestPath": "/orgs/{org}/teams/{team_slug}/memberships/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -23465,8 +23641,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/memberships/USERNAME \\\n -d '{\"role\":\"role\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/memberships/USERNAME \\\n  -d '{\"role\":\"role\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/memberships/USERNAME \\\n -d '{\"role\":\"role\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/memberships/USERNAME \\\n  -d '{\"role\":\"role\"}'
    " }, { "lang": "JavaScript", @@ -23540,12 +23716,6 @@ } ], "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response if user's membership with team is now active", - "payload": "
    {\n  \"url\": \"https://api.github.com/teams/1/memberships/octocat\",\n  \"role\": \"member\",\n  \"state\": \"active\"\n}\n
    " - }, { "httpStatusCode": "200", "httpStatusMessage": "OK", @@ -23560,15 +23730,14 @@ { "httpStatusCode": "422", "httpStatusMessage": "Unprocessable Entity", - "description": "Response if you attempt to add an organization to a team", - "payload": "
    {\n  \"message\": \"Cannot add an organization as a member.\",\n  \"errors\": [\n    {\n      \"code\": \"org\",\n      \"field\": \"user\",\n      \"resource\": \"TeamMember\"\n    }\n  ]\n}\n
    " + "description": "Response if you attempt to add an organization to a team" } ] }, { "verb": "delete", "requestPath": "/orgs/{org}/teams/{team_slug}/memberships/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -23602,8 +23771,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/memberships/USERNAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/memberships/USERNAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/memberships/USERNAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/memberships/USERNAME
    " }, { "lang": "JavaScript", @@ -23638,7 +23807,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -23652,7 +23821,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/projects", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -23697,8 +23866,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/projects", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/projects
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/projects", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/projects
    " }, { "lang": "JavaScript", @@ -23748,7 +23917,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/projects/{project_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -23782,8 +23951,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/projects/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/projects/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/projects/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/projects/42
    " }, { "lang": "JavaScript", @@ -23838,7 +24007,7 @@ { "verb": "put", "requestPath": "/orgs/{org}/teams/{team_slug}/projects/{project_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -23872,8 +24041,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/projects/42 \\\n -d '{\"permission\":\"permission\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/projects/42 \\\n  -d '{\"permission\":\"permission\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/projects/42 \\\n -d '{\"permission\":\"permission\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/projects/42 \\\n  -d '{\"permission\":\"permission\"}'
    " }, { "lang": "JavaScript", @@ -23956,7 +24125,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -23969,7 +24138,7 @@ { "verb": "delete", "requestPath": "/orgs/{org}/teams/{team_slug}/projects/{project_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -24003,8 +24172,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/projects/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/projects/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/projects/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/projects/42
    " }, { "lang": "JavaScript", @@ -24037,7 +24206,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -24046,7 +24215,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/repos", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -24091,8 +24260,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/repos", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/repos
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/repos", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/repos
    " }, { "lang": "JavaScript", @@ -24135,7 +24304,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -24178,8 +24347,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/repos/octocat/hello-world", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/repos/octocat/hello-world
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/repos/octocat/hello-world", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/repos/octocat/hello-world
    " }, { "lang": "JavaScript", @@ -24231,7 +24400,7 @@ { "verb": "put", "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -24274,8 +24443,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/repos/octocat/hello-world \\\n -d '{\"permission\":\"permission\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/repos/octocat/hello-world \\\n  -d '{\"permission\":\"permission\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/repos/octocat/hello-world \\\n -d '{\"permission\":\"permission\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/repos/octocat/hello-world \\\n  -d '{\"permission\":\"permission\"}'
    " }, { "lang": "JavaScript", @@ -24335,7 +24504,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "descriptionHTML": "

    To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a 422 Unprocessable Entity status if you attempt to add a repository to a team that is not owned by the organization. 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

    Note: You can also specify a team by org_id and team_id using the route PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}.

    \n

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

    ", @@ -24361,7 +24530,7 @@ { "verb": "delete", "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -24404,8 +24573,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/repos/octocat/hello-world", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/repos/octocat/hello-world
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/repos/octocat/hello-world", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/repos/octocat/hello-world
    " }, { "lang": "JavaScript", @@ -24438,7 +24607,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -24447,7 +24616,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/teams", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -24492,8 +24661,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/teams", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/teams
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/teams", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/teams
    " }, { "lang": "JavaScript", @@ -24536,7 +24705,7 @@ { "verb": "get", "requestPath": "/projects/columns/cards/{card_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "card_id", @@ -24552,8 +24721,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/cards/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/cards/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/columns/cards/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/columns/cards/42
    " }, { "lang": "JavaScript", @@ -24625,7 +24794,7 @@ { "verb": "patch", "requestPath": "/projects/columns/cards/{card_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "card_id", @@ -24641,8 +24810,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/cards/42 \\\n -d '{\"note\":\"note\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/cards/42 \\\n  -d '{\"note\":\"note\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/columns/cards/42 \\\n -d '{\"note\":\"note\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/columns/cards/42 \\\n  -d '{\"note\":\"note\"}'
    " }, { "lang": "JavaScript", @@ -24773,7 +24942,7 @@ { "verb": "delete", "requestPath": "/projects/columns/cards/{card_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "card_id", @@ -24789,8 +24958,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/cards/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/cards/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/columns/cards/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/columns/cards/42
    " }, { "lang": "JavaScript", @@ -24832,7 +25001,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -24861,7 +25030,7 @@ { "verb": "post", "requestPath": "/projects/columns/cards/{card_id}/moves", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "card_id", @@ -24877,8 +25046,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/cards/42/moves \\\n -d '{\"position\":\"position\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/cards/42/moves \\\n  -d '{\"position\":\"position\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/columns/cards/42/moves \\\n -d '{\"position\":\"position\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/columns/cards/42/moves \\\n  -d '{\"position\":\"position\"}'
    " }, { "lang": "JavaScript", @@ -25011,7 +25180,7 @@ { "verb": "get", "requestPath": "/projects/columns/{column_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "column_id", @@ -25027,8 +25196,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/columns/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/columns/42
    " }, { "lang": "JavaScript", @@ -25100,7 +25269,7 @@ { "verb": "patch", "requestPath": "/projects/columns/{column_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "column_id", @@ -25116,8 +25285,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/42 \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/42 \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/columns/42 \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/columns/42 \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -25219,7 +25388,7 @@ { "verb": "delete", "requestPath": "/projects/columns/{column_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "column_id", @@ -25235,8 +25404,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/columns/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/columns/42
    " }, { "lang": "JavaScript", @@ -25278,7 +25447,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -25302,7 +25471,7 @@ { "verb": "get", "requestPath": "/projects/columns/{column_id}/cards", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "column_id", @@ -25354,8 +25523,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/42/cards", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/42/cards
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/columns/42/cards", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/columns/42/cards
    " }, { "lang": "JavaScript", @@ -25422,7 +25591,7 @@ { "verb": "post", "requestPath": "/projects/columns/{column_id}/cards", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "column_id", @@ -25438,8 +25607,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/42/cards \\\n -d '{\"note\":\"note\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/42/cards \\\n  -d '{\"note\":\"note\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/columns/42/cards \\\n -d '{\"note\":\"note\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/columns/42/cards \\\n  -d '{\"note\":\"note\"}'
    " }, { "lang": "JavaScript", @@ -25559,7 +25728,7 @@ { "verb": "post", "requestPath": "/projects/columns/{column_id}/moves", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "column_id", @@ -25575,8 +25744,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/42/moves \\\n -d '{\"position\":\"position\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/42/moves \\\n  -d '{\"position\":\"position\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/columns/42/moves \\\n -d '{\"position\":\"position\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/columns/42/moves \\\n  -d '{\"position\":\"position\"}'
    " }, { "lang": "JavaScript", @@ -25684,7 +25853,7 @@ { "verb": "get", "requestPath": "/projects/{project_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "project_id", @@ -25699,8 +25868,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/42
    " }, { "lang": "JavaScript", @@ -25765,7 +25934,7 @@ { "verb": "patch", "requestPath": "/projects/{project_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "project_id", @@ -25780,8 +25949,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42 \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/42 \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/42 \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/42 \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -25983,7 +26152,7 @@ { "verb": "delete", "requestPath": "/projects/{project_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "project_id", @@ -25998,8 +26167,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/42
    " }, { "lang": "JavaScript", @@ -26073,7 +26242,7 @@ { "verb": "get", "requestPath": "/projects/{project_id}/collaborators", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "project_id", @@ -26124,8 +26293,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42/collaborators", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/42/collaborators
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/42/collaborators", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/42/collaborators
    " }, { "lang": "JavaScript", @@ -26207,7 +26376,7 @@ { "verb": "put", "requestPath": "/projects/{project_id}/collaborators/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "project_id", @@ -26231,8 +26400,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42/collaborators/USERNAME \\\n -d '{\"permission\":\"permission\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/42/collaborators/USERNAME \\\n  -d '{\"permission\":\"permission\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/42/collaborators/USERNAME \\\n -d '{\"permission\":\"permission\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/42/collaborators/USERNAME \\\n  -d '{\"permission\":\"permission\"}'
    " }, { "lang": "JavaScript", @@ -26301,7 +26470,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -26357,7 +26526,7 @@ { "verb": "delete", "requestPath": "/projects/{project_id}/collaborators/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "project_id", @@ -26381,8 +26550,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42/collaborators/USERNAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/42/collaborators/USERNAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/42/collaborators/USERNAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/42/collaborators/USERNAME
    " }, { "lang": "JavaScript", @@ -26424,7 +26593,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -26463,7 +26632,7 @@ { "verb": "get", "requestPath": "/projects/{project_id}/collaborators/{username}/permission", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "project_id", @@ -26487,8 +26656,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42/collaborators/USERNAME/permission", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/42/collaborators/USERNAME/permission
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/42/collaborators/USERNAME/permission", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/42/collaborators/USERNAME/permission
    " }, { "lang": "JavaScript", @@ -26570,7 +26739,7 @@ { "verb": "get", "requestPath": "/projects/{project_id}/columns", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "project_id", @@ -26605,8 +26774,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42/columns", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/42/columns
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/42/columns", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/42/columns
    " }, { "lang": "JavaScript", @@ -26673,7 +26842,7 @@ { "verb": "post", "requestPath": "/projects/{project_id}/columns", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "project_id", @@ -26688,8 +26857,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42/columns \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/42/columns \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/42/columns \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/42/columns \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -26796,13 +26965,13 @@ { "verb": "get", "requestPath": "/rate_limit", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/rate_limit", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/rate_limit
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/rate_limit", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/rate_limit
    " }, { "lang": "JavaScript", @@ -26855,7 +27024,7 @@ { "verb": "delete", "requestPath": "/reactions/{reaction_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "reaction_id", @@ -26870,8 +27039,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/reactions/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/reactions/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/reactions/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/reactions/42
    " }, { "lang": "JavaScript", @@ -26914,7 +27083,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -26948,7 +27117,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -26972,8 +27141,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world
    " }, { "lang": "JavaScript", @@ -27050,7 +27219,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -27074,8 +27243,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -27469,7 +27638,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -27493,8 +27662,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world
    " }, { "lang": "JavaScript", @@ -27529,7 +27698,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -27547,7 +27716,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/actions/artifacts", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -27591,8 +27760,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/artifacts", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/artifacts
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/artifacts", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/artifacts
    " }, { "lang": "JavaScript", @@ -27637,7 +27806,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -27671,8 +27840,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/artifacts/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/artifacts/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/artifacts/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/artifacts/42
    " }, { "lang": "JavaScript", @@ -27717,7 +27886,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -27751,8 +27920,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/artifacts/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/artifacts/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/artifacts/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/artifacts/42
    " }, { "lang": "JavaScript", @@ -27787,7 +27956,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -27796,7 +27965,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -27839,8 +28008,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/artifacts/42/ARCHIVE_FORMAT", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/artifacts/42/ARCHIVE_FORMAT
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/artifacts/42/ARCHIVE_FORMAT", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/artifacts/42/ARCHIVE_FORMAT
    " }, { "lang": "JavaScript", @@ -27884,7 +28053,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/actions/jobs/{job_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -27918,8 +28087,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/jobs/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/jobs/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/jobs/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/jobs/42
    " }, { "lang": "JavaScript", @@ -27964,7 +28133,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/actions/jobs/{job_id}/logs", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -27998,8 +28167,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/jobs/42/logs", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/jobs/42/logs
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/jobs/42/logs", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/jobs/42/logs
    " }, { "lang": "JavaScript", @@ -28043,7 +28212,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/actions/runners", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -28087,8 +28256,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/runners", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/runners
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/runners", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/runners
    " }, { "lang": "JavaScript", @@ -28133,7 +28302,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/actions/runners/downloads", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -28157,8 +28326,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/runners/downloads", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/runners/downloads
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/runners/downloads", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/runners/downloads
    " }, { "lang": "JavaScript", @@ -28203,7 +28372,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/actions/runners/registration-token", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -28227,8 +28396,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/runners/registration-token", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/runners/registration-token
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/runners/registration-token", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/runners/registration-token
    " }, { "lang": "JavaScript", @@ -28273,7 +28442,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/actions/runners/remove-token", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -28297,8 +28466,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/runners/remove-token", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/runners/remove-token
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/runners/remove-token", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/runners/remove-token
    " }, { "lang": "JavaScript", @@ -28343,7 +28512,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/actions/runners/{runner_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -28377,8 +28546,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/runners/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/runners/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/runners/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/runners/42
    " }, { "lang": "JavaScript", @@ -28423,7 +28592,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/actions/runners/{runner_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -28457,8 +28626,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/runners/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/runners/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/runners/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/runners/42
    " }, { "lang": "JavaScript", @@ -28493,7 +28662,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -28502,7 +28671,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/actions/runs", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -28601,8 +28770,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/runs", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/runs
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/runs", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/runs
    " }, { "lang": "JavaScript", @@ -28647,7 +28816,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -28681,8 +28850,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/runs/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/runs/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/runs/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/runs/42
    " }, { "lang": "JavaScript", @@ -28727,7 +28896,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -28761,8 +28930,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/runs/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/runs/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/runs/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/runs/42
    " }, { "lang": "JavaScript", @@ -28797,7 +28966,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -28806,7 +28975,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/artifacts", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -28860,8 +29029,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/runs/42/artifacts", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/runs/42/artifacts
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/runs/42/artifacts", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/runs/42/artifacts
    " }, { "lang": "JavaScript", @@ -28906,7 +29075,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/cancel", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -28940,8 +29109,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/runs/42/cancel", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/runs/42/cancel
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/runs/42/cancel", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/runs/42/cancel
    " }, { "lang": "JavaScript", @@ -28985,7 +29154,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/jobs", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -29054,8 +29223,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/runs/42/jobs", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/runs/42/jobs
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/runs/42/jobs", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/runs/42/jobs
    " }, { "lang": "JavaScript", @@ -29100,7 +29269,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/logs", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -29134,8 +29303,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/runs/42/logs", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/runs/42/logs
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/runs/42/logs", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/runs/42/logs
    " }, { "lang": "JavaScript", @@ -29179,7 +29348,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/logs", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -29213,8 +29382,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/runs/42/logs", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/runs/42/logs
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/runs/42/logs", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/runs/42/logs
    " }, { "lang": "JavaScript", @@ -29249,7 +29418,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -29258,7 +29427,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -29292,8 +29461,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/runs/42/rerun", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/runs/42/rerun
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/runs/42/rerun", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/runs/42/rerun
    " }, { "lang": "JavaScript", @@ -29337,7 +29506,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/actions/secrets", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -29381,8 +29550,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/secrets", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/secrets
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/secrets", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/secrets
    " }, { "lang": "JavaScript", @@ -29427,7 +29596,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/actions/secrets/public-key", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -29451,8 +29620,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/secrets/public-key", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/secrets/public-key
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/secrets/public-key", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/secrets/public-key
    " }, { "lang": "JavaScript", @@ -29497,7 +29666,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/actions/secrets/{secret_name}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -29531,8 +29700,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/secrets/SECRET_NAME", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/secrets/SECRET_NAME
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/secrets/SECRET_NAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/secrets/SECRET_NAME
    " }, { "lang": "JavaScript", @@ -29577,7 +29746,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/actions/secrets/{secret_name}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -29611,8 +29780,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/secrets/SECRET_NAME \\\n -d '{\"encrypted_value\":\"encrypted_value\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/secrets/SECRET_NAME \\\n  -d '{\"encrypted_value\":\"encrypted_value\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/secrets/SECRET_NAME \\\n -d '{\"encrypted_value\":\"encrypted_value\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/secrets/SECRET_NAME \\\n  -d '{\"encrypted_value\":\"encrypted_value\"}'
    " }, { "lang": "JavaScript", @@ -29639,6 +29808,7 @@ "encrypted_value": { "type": "string", "description": "

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.

    ", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", "rawType": "string", @@ -29657,7 +29827,7 @@ } }, "example": { - "encrypted_value": "****************************************************************************************", + "encrypted_value": "c2VjcmV0", "key_id": "012345678912345678" } } @@ -29693,6 +29863,7 @@ { "type": "string", "description": "

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.

    ", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", "rawType": "string", @@ -29713,7 +29884,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/actions/secrets/{secret_name}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -29747,8 +29918,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/secrets/SECRET_NAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/secrets/SECRET_NAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/secrets/SECRET_NAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/secrets/SECRET_NAME
    " }, { "lang": "JavaScript", @@ -29783,7 +29954,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -29792,7 +29963,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/actions/workflows", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -29836,8 +30007,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/workflows", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/workflows
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/workflows", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/workflows
    " }, { "lang": "JavaScript", @@ -29882,7 +30053,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -29923,8 +30094,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/workflows/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/workflows/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/workflows/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/workflows/42
    " }, { "lang": "JavaScript", @@ -29969,7 +30140,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -30010,8 +30181,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/workflows/42/dispatches \\\n -d '{\"ref\":\"ref\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/workflows/42/dispatches \\\n  -d '{\"ref\":\"ref\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/workflows/42/dispatches \\\n -d '{\"ref\":\"ref\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/workflows/42/dispatches \\\n  -d '{\"ref\":\"ref\"}'
    " }, { "lang": "JavaScript", @@ -30089,7 +30260,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "descriptionHTML": "

    You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace workflow_id with the workflow file name. For example, you could use main.yaml.

    \n

    You must configure your GitHub Actions workflow to run when the workflow_dispatch webhook event occurs. The inputs are configured in the workflow file. For more information about how to configure the workflow_dispatch event in the workflow file, see \"Events that trigger workflows.\"

    \n

    You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions:write permission to use this endpoint. For more information, see \"Creating a personal access token for the command line.\"

    ", @@ -30121,7 +30292,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -30237,8 +30408,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/workflows/42/runs", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/workflows/42/runs
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/workflows/42/runs", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/workflows/42/runs
    " }, { "lang": "JavaScript", @@ -30283,7 +30454,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/assignees", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -30327,8 +30498,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/assignees", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/assignees
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/assignees", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/assignees
    " }, { "lang": "JavaScript", @@ -30378,7 +30549,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/assignees/{assignee}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -30411,8 +30582,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/assignees/ASSIGNEE", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/assignees/ASSIGNEE
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/assignees/ASSIGNEE", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/assignees/ASSIGNEE
    " }, { "lang": "JavaScript", @@ -30461,7 +30632,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -30515,8 +30686,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches
    " }, { "lang": "JavaScript", @@ -30554,12 +30725,6 @@ "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "
    [\n  {\n    \"name\": \"master\",\n    \"commit\": {\n      \"sha\": \"c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc\",\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc\"\n    },\n    \"protected\": true\n  }\n]\n
    " - }, - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "With protection", "payload": "
    [\n  {\n    \"name\": \"master\",\n    \"commit\": {\n      \"sha\": \"c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc\",\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc\"\n    },\n    \"protected\": true,\n    \"protection\": {\n      \"enabled\": true,\n      \"required_status_checks\": {\n        \"enforcement_level\": \"non_admins\",\n        \"contexts\": [\n          \"ci-test\",\n          \"linter\"\n        ]\n      }\n    },\n    \"protection_url\": \"https://api.github.com/repos/octocat/hello-world/branches/master/protection\"\n  }\n]\n
    " }, { @@ -30572,7 +30737,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -30607,8 +30772,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH
    " }, { "lang": "JavaScript", @@ -30663,7 +30828,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -30698,8 +30863,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection
    " }, { "lang": "JavaScript", @@ -30756,7 +30921,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -30791,8 +30956,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection \\\n -d '{\"required_status_checks\":{\"strict\":true,\"contexts\":[\"contexts\"]},\"enforce_admins\":true,\"required_pull_request_reviews\":{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":42},\"restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"],\"apps\":[\"apps\"]}}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection \\\n  -d '{\"required_status_checks\":{\"strict\":true,\"contexts\":[\"contexts\"]},\"enforce_admins\":true,\"required_pull_request_reviews\":{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":42},\"restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"],\"apps\":[\"apps\"]}}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection \\\n -d '{\"required_status_checks\":{\"strict\":true,\"contexts\":[\"contexts\"]},\"enforce_admins\":true,\"required_pull_request_reviews\":{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":42},\"restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"],\"apps\":[\"apps\"]}}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection \\\n  -d '{\"required_status_checks\":{\"strict\":true,\"contexts\":[\"contexts\"]},\"enforce_admins\":true,\"required_pull_request_reviews\":{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":42},\"restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"],\"apps\":[\"apps\"]}}'
    " }, { "lang": "JavaScript", @@ -31795,7 +31960,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -31830,8 +31995,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection
    " }, { "lang": "JavaScript", @@ -31866,7 +32031,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -31880,7 +32045,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -31915,8 +32080,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins
    " }, { "lang": "JavaScript", @@ -31961,7 +32126,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -31996,8 +32161,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins
    " }, { "lang": "JavaScript", @@ -32042,7 +32207,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -32077,8 +32242,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins
    " }, { "lang": "JavaScript", @@ -32127,7 +32292,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -32162,8 +32327,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews
    " }, { "lang": "JavaScript", @@ -32214,7 +32379,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -32249,8 +32414,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews \\\n -d '{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]}}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews \\\n  -d '{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]}}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews \\\n -d '{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]}}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews \\\n  -d '{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]}}'
    " }, { "lang": "JavaScript", @@ -32520,7 +32685,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -32555,8 +32720,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews
    " }, { "lang": "JavaScript", @@ -32605,7 +32770,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -32640,8 +32805,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures
    " }, { "lang": "JavaScript", @@ -32698,7 +32863,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -32733,8 +32898,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures
    " }, { "lang": "JavaScript", @@ -32791,7 +32956,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -32826,8 +32991,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures
    " }, { "lang": "JavaScript", @@ -32883,7 +33048,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -32918,8 +33083,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks
    " }, { "lang": "JavaScript", @@ -32969,7 +33134,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -33004,8 +33169,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks \\\n -d '{\"strict\":true}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks \\\n  -d '{\"strict\":true}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks \\\n -d '{\"strict\":true}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks \\\n  -d '{\"strict\":true}'
    " }, { "lang": "JavaScript", @@ -33120,7 +33285,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -33155,8 +33320,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks
    " }, { "lang": "JavaScript", @@ -33200,7 +33365,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -33235,8 +33400,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts
    " }, { "lang": "JavaScript", @@ -33286,7 +33451,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -33321,8 +33486,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n  -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n  -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'
    " }, { "lang": "JavaScript", @@ -33427,7 +33592,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -33462,8 +33627,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n  -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n  -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'
    " }, { "lang": "JavaScript", @@ -33563,7 +33728,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -33598,8 +33763,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n  -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n  -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'
    " }, { "lang": "JavaScript", @@ -33699,7 +33864,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -33734,8 +33899,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions
    " }, { "lang": "JavaScript", @@ -33785,7 +33950,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -33820,8 +33985,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions
    " }, { "lang": "JavaScript", @@ -33865,7 +34030,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -33900,8 +34065,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps
    " }, { "lang": "JavaScript", @@ -33951,7 +34116,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -33986,8 +34151,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps \\\n -d '{\"apps\":{\"apps\":[\"apps\"]}}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps \\\n  -d '{\"apps\":{\"apps\":[\"apps\"]}}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps \\\n -d '{\"apps\":{\"apps\":[\"apps\"]}}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps \\\n  -d '{\"apps\":{\"apps\":[\"apps\"]}}'
    " }, { "lang": "JavaScript", @@ -34082,7 +34247,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -34117,8 +34282,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps \\\n -d '{\"apps\":{\"apps\":[\"apps\"]}}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps \\\n  -d '{\"apps\":{\"apps\":[\"apps\"]}}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps \\\n -d '{\"apps\":{\"apps\":[\"apps\"]}}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps \\\n  -d '{\"apps\":{\"apps\":[\"apps\"]}}'
    " }, { "lang": "JavaScript", @@ -34213,7 +34378,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -34248,8 +34413,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps \\\n -d '{\"apps\":{\"apps\":[\"apps\"]}}'", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps \\\n  -d '{\"apps\":{\"apps\":[\"apps\"]}}'
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps \\\n -d '{\"apps\":{\"apps\":[\"apps\"]}}'", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps \\\n  -d '{\"apps\":{\"apps\":[\"apps\"]}}'
    " }, { "lang": "JavaScript", @@ -34344,7 +34509,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -34379,8 +34544,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams
    " }, { "lang": "JavaScript", @@ -34430,7 +34595,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -34465,8 +34630,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n -d '{\"teams\":{\"teams\":[\"teams\"]}}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n  -d '{\"teams\":{\"teams\":[\"teams\"]}}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n -d '{\"teams\":{\"teams\":[\"teams\"]}}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n  -d '{\"teams\":{\"teams\":[\"teams\"]}}'
    " }, { "lang": "JavaScript", @@ -34561,7 +34726,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -34596,8 +34761,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n -d '{\"teams\":{\"teams\":[\"teams\"]}}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n  -d '{\"teams\":{\"teams\":[\"teams\"]}}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n -d '{\"teams\":{\"teams\":[\"teams\"]}}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n  -d '{\"teams\":{\"teams\":[\"teams\"]}}'
    " }, { "lang": "JavaScript", @@ -34692,7 +34857,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -34727,8 +34892,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n -d '{\"teams\":{\"teams\":[\"teams\"]}}'", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n  -d '{\"teams\":{\"teams\":[\"teams\"]}}'
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n -d '{\"teams\":{\"teams\":[\"teams\"]}}'", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n  -d '{\"teams\":{\"teams\":[\"teams\"]}}'
    " }, { "lang": "JavaScript", @@ -34823,7 +34988,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -34858,8 +35023,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users
    " }, { "lang": "JavaScript", @@ -34909,7 +35074,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -34944,8 +35109,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n -d '{\"users\":{\"users\":[\"users\"]}}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n  -d '{\"users\":{\"users\":[\"users\"]}}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n -d '{\"users\":{\"users\":[\"users\"]}}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n  -d '{\"users\":{\"users\":[\"users\"]}}'
    " }, { "lang": "JavaScript", @@ -35040,7 +35205,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -35075,8 +35240,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n -d '{\"users\":{\"users\":[\"users\"]}}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n  -d '{\"users\":{\"users\":[\"users\"]}}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n -d '{\"users\":{\"users\":[\"users\"]}}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n  -d '{\"users\":{\"users\":[\"users\"]}}'
    " }, { "lang": "JavaScript", @@ -35171,7 +35336,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -35206,8 +35371,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n -d '{\"users\":{\"users\":[\"users\"]}}'", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n  -d '{\"users\":{\"users\":[\"users\"]}}'
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n -d '{\"users\":{\"users\":[\"users\"]}}'", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n  -d '{\"users\":{\"users\":[\"users\"]}}'
    " }, { "lang": "JavaScript", @@ -35302,7 +35467,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/check-runs", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -35326,8 +35491,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-runs \\\n -d '{\"name\":\"name\",\"head_sha\":\"head_sha\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/check-runs \\\n  -d '{\"name\":\"name\",\"head_sha\":\"head_sha\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-runs \\\n -d '{\"name\":\"name\",\"head_sha\":\"head_sha\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-runs \\\n  -d '{\"name\":\"name\",\"head_sha\":\"head_sha\"}'
    " }, { "lang": "JavaScript", @@ -36304,7 +36469,7 @@ "name", "head_sha" ], - "anyOf": [ + "oneOf": [ { "properties": { "status": { @@ -36314,6 +36479,7 @@ } }, "required": [ + "status", "conclusion" ], "additionalProperties": true @@ -36333,7 +36499,7 @@ }, "examples": { "example-of-in-progress-conclusion": { - "summary": "Example of in_progress conclusion", + "summary": "Response for in_progress conclusion", "value": { "name": "mighty_readme", "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -36348,7 +36514,7 @@ } }, "example-of-completed-conclusion": { - "summary": "Example of completed conclusion", + "summary": "Response for completed conclusion", "value": { "name": "mighty_readme", "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -36422,12 +36588,6 @@ "notes": [], "descriptionHTML": "

    Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

    \n

    Creates a new check run for a specific commit in a repository. Your GitHub App must have the checks:write permission to create check runs.

    \n

    In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.

    ", "responses": [ - { - "httpStatusCode": "201", - "httpStatusMessage": "Created", - "description": "Response for in_progress conclusion", - "payload": "
    {\n  \"id\": 4,\n  \"head_sha\": \"ce587453ced02b1526dfb4cb910479d431683101\",\n  \"node_id\": \"MDg6Q2hlY2tSdW40\",\n  \"external_id\": \"42\",\n  \"url\": \"https://api.github.com/repos/github/hello-world/check-runs/4\",\n  \"html_url\": \"https://github.com/github/hello-world/runs/4\",\n  \"details_url\": \"https://example.com\",\n  \"status\": \"in_progress\",\n  \"conclusion\": \"neutral\",\n  \"started_at\": \"2018-05-04T01:14:52Z\",\n  \"completed_at\": null,\n  \"output\": {\n    \"title\": \"Mighty Readme Report\",\n    \"summary\": \"\",\n    \"text\": \"\",\n    \"annotations_count\": 1,\n    \"annotations_url\": \"https://api.github.com/repos/github/hello-world/check-runs/4/annotations\"\n  },\n  \"name\": \"mighty_readme\",\n  \"check_suite\": {\n    \"id\": 5\n  },\n  \"app\": {\n    \"id\": 1,\n    \"slug\": \"octoapp\",\n    \"node_id\": \"MDExOkludGVncmF0aW9uMQ==\",\n    \"owner\": {\n      \"login\": \"github\",\n      \"id\": 1,\n      \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n      \"url\": \"https://api.github.com/orgs/github\",\n      \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n      \"events_url\": \"https://api.github.com/orgs/github/events\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\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      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": true\n    },\n    \"name\": \"Octocat App\",\n    \"description\": \"\",\n    \"external_url\": \"https://example.com\",\n    \"html_url\": \"https://github.com/apps/octoapp\",\n    \"created_at\": \"2017-07-08T16:18:44-04:00\",\n    \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n    \"permissions\": {\n      \"metadata\": \"read\",\n      \"contents\": \"read\",\n      \"issues\": \"write\",\n      \"single_file\": \"write\"\n    },\n    \"events\": [\n      \"push\",\n      \"pull_request\"\n    ]\n  },\n  \"pull_requests\": [\n    {\n      \"url\": \"https://api.github.com/repos/github/hello-world/pulls/1\",\n      \"id\": 1934,\n      \"number\": 3956,\n      \"head\": {\n        \"ref\": \"say-hello\",\n        \"sha\": \"3dca65fa3e8d4b3da3f3d056c59aee1c50f41390\",\n        \"repo\": {\n          \"id\": 526,\n          \"url\": \"https://api.github.com/repos/github/hello-world\",\n          \"name\": \"hello-world\"\n        }\n      },\n      \"base\": {\n        \"ref\": \"master\",\n        \"sha\": \"e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f\",\n        \"repo\": {\n          \"id\": 526,\n          \"url\": \"https://api.github.com/repos/github/hello-world\",\n          \"name\": \"hello-world\"\n        }\n      }\n    }\n  ]\n}\n
    " - }, { "httpStatusCode": "201", "httpStatusMessage": "Created", @@ -37389,7 +37549,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/check-runs/{check_run_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -37423,8 +37583,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-runs/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/check-runs/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-runs/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-runs/42
    " }, { "lang": "JavaScript", @@ -37476,7 +37636,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/check-runs/{check_run_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -37510,8 +37670,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-runs/42 \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/check-runs/42 \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-runs/42 \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-runs/42 \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -39513,7 +39673,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/check-runs/{check_run_id}/annotations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -39567,8 +39727,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-runs/42/annotations", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/check-runs/42/annotations
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-runs/42/annotations", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-runs/42/annotations
    " }, { "lang": "JavaScript", @@ -39620,7 +39780,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/check-suites", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -39644,8 +39804,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-suites \\\n -d '{\"head_sha\":\"head_sha\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/check-suites \\\n  -d '{\"head_sha\":\"head_sha\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-suites \\\n -d '{\"head_sha\":\"head_sha\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-suites \\\n  -d '{\"head_sha\":\"head_sha\"}'
    " }, { "lang": "JavaScript", @@ -39733,7 +39893,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/check-suites/preferences", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -39757,8 +39917,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-suites/preferences \\\n -d '{\"auto_trigger_checks\":[{\"app_id\":42,\"setting\":true}]}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/check-suites/preferences \\\n  -d '{\"auto_trigger_checks\":[{\"app_id\":42,\"setting\":true}]}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-suites/preferences \\\n -d '{\"auto_trigger_checks\":[{\"app_id\":42,\"setting\":true}]}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-suites/preferences \\\n  -d '{\"auto_trigger_checks\":[{\"app_id\":42,\"setting\":true}]}'
    " }, { "lang": "JavaScript", @@ -39958,7 +40118,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/check-suites/{check_suite_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -39992,8 +40152,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-suites/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/check-suites/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-suites/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-suites/42
    " }, { "lang": "JavaScript", @@ -40045,7 +40205,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -40139,8 +40299,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-suites/42/check-runs", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/check-suites/42/check-runs
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-suites/42/check-runs", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-suites/42/check-runs
    " }, { "lang": "JavaScript", @@ -40192,7 +40352,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -40226,8 +40386,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-suites/42/rerequest", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/check-suites/42/rerequest
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-suites/42/rerequest", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-suites/42/rerequest
    " }, { "lang": "JavaScript", @@ -40278,7 +40438,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/code-scanning/alerts", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -40348,7 +40508,7 @@ "required": false, "schema": { "type": "string", - "description": "The full Git reference, formatted as `refs/heads/`." + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." }, "descriptionHTML": "

    The Git reference for the results you want to list. The ref for a branch can be formatted either as refs/heads/<branch name> or simply <branch name>. To reference a pull request use refs/pull/<number>/merge.

    " }, @@ -40362,6 +40522,7 @@ "description": "State of a code scanning alert.", "enum": [ "open", + "closed", "dismissed", "fixed" ] @@ -40372,8 +40533,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/code-scanning/alerts", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/code-scanning/alerts
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/code-scanning/alerts", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/code-scanning/alerts
    " }, { "lang": "JavaScript", @@ -40382,7 +40543,7 @@ } ], "summary": "List code scanning alerts for a repository", - "description": "Lists all open code scanning alerts for the default branch (usually `main`\nor `master`). You must use an access token with the `security_events` scope to use\nthis endpoint. GitHub Apps must have the `security_events` read permission to use\nthis endpoint.\n\nThe response includes a `most_recent_instance` object.\nThis provides details of the most recent instance of this alert\nfor the the default branch or for the specified Git reference\n(if you used `ref` in the request).", + "description": "Lists all open code scanning alerts for the default branch (usually `main`\nor `master`). You must use an access token with the `security_events` scope to use\nthis endpoint. GitHub Apps must have the `security_events` read permission to use\nthis endpoint.\n\nThe response includes a `most_recent_instance` object.\nThis provides details of the most recent instance of this alert\nfor the default branch or for the specified Git reference\n(if you used `ref` in the request).", "tags": [ "code-scanning" ], @@ -40403,7 +40564,7 @@ "categoryLabel": "Code scanning", "notes": [], "bodyParameters": [], - "descriptionHTML": "

    Lists all open code scanning alerts for the default branch (usually main\nor master). You must use an access token with the security_events scope to use\nthis endpoint. GitHub Apps must have the security_events read permission to use\nthis endpoint.

    \n

    The response includes a most_recent_instance object.\nThis provides details of the most recent instance of this alert\nfor the the default branch or for the specified Git reference\n(if you used ref in the request).

    ", + "descriptionHTML": "

    Lists all open code scanning alerts for the default branch (usually main\nor master). You must use an access token with the security_events scope to use\nthis endpoint. GitHub Apps must have the security_events read permission to use\nthis endpoint.

    \n

    The response includes a most_recent_instance object.\nThis provides details of the most recent instance of this alert\nfor the default branch or for the specified Git reference\n(if you used ref in the request).

    ", "responses": [ { "httpStatusCode": "200", @@ -40431,7 +40592,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -40468,8 +40629,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/code-scanning/alerts/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/code-scanning/alerts/42
    " }, { "lang": "JavaScript", @@ -40527,7 +40688,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -40564,8 +40725,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42 \\\n -d '{\"state\":\"state\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42 \\\n  -d '{\"state\":\"state\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/code-scanning/alerts/42 \\\n -d '{\"state\":\"state\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/code-scanning/alerts/42 \\\n  -d '{\"state\":\"state\"}'
    " }, { "lang": "JavaScript", @@ -40715,7 +40876,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/code-scanning/analyses", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -40785,7 +40946,7 @@ "required": false, "schema": { "type": "string", - "description": "The full Git reference, formatted as `refs/heads/`." + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." }, "descriptionHTML": "

    The Git reference for the analyses you want to list. The ref for a branch can be formatted either as refs/heads/<branch name> or simply <branch name>. To reference a pull request use refs/pull/<number>/merge.

    " }, @@ -40806,8 +40967,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/code-scanning/analyses", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/code-scanning/analyses
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/code-scanning/analyses", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/code-scanning/analyses
    " }, { "lang": "JavaScript", @@ -40864,7 +41025,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/code-scanning/sarifs", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -40888,8 +41049,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/code-scanning/sarifs \\\n -d '{\"commit_sha\":\"commit_sha\",\"ref\":\"ref\",\"sarif\":\"sarif\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/code-scanning/sarifs \\\n  -d '{\"commit_sha\":\"commit_sha\",\"ref\":\"ref\",\"sarif\":\"sarif\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/code-scanning/sarifs \\\n -d '{\"commit_sha\":\"commit_sha\",\"ref\":\"ref\",\"sarif\":\"sarif\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/code-scanning/sarifs \\\n  -d '{\"commit_sha\":\"commit_sha\",\"ref\":\"ref\",\"sarif\":\"sarif\"}'
    " }, { "lang": "JavaScript", @@ -40898,7 +41059,7 @@ } ], "summary": "Upload an analysis as SARIF data", - "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint.\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64\n```\n\nSARIF upload supports a maximum of 1000 results per analysis run. Any results over this limit are ignored. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.\n\nThe `202 Accepted`, response includes an `id` value.\nYou can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload).\"", + "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint.\n\nThere are two places where you can upload code scanning results.\n - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see \"[Triaging code scanning alerts in pull requests](/github/finding-security-vulnerabilities-and-errors-in-your-code/triaging-code-scanning-alerts-in-pull-requests).\"\n - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see \"[Managing code scanning alerts for your repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository).\"\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64\n```\n\nSARIF upload supports a maximum of 1000 results per analysis run. Any results over this limit are ignored. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.\n\nThe `202 Accepted`, response includes an `id` value.\nYou can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload).\"", "operationId": "code-scanning/upload-sarif", "tags": [ "code-scanning" @@ -40927,11 +41088,11 @@ }, "ref": { "type": "string", - "description": "

    Required. The full Git reference, formatted as refs/heads/<branch name>.

    ", + "description": "

    Required. The full Git reference, formatted as refs/heads/<branch name>,\nrefs/pull/<number>/merge, or refs/pull/<number>/head.

    ", "name": "ref", "in": "body", "rawType": "string", - "rawDescription": "The full Git reference, formatted as `refs/heads/`.", + "rawDescription": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`.", "childParamsGroups": [] }, "sarif": { @@ -40993,7 +41154,7 @@ "category": "code-scanning", "categoryLabel": "Code scanning", "notes": [], - "descriptionHTML": "

    Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the security_events scope to use this endpoint. GitHub Apps must have the security_events write permission to use this endpoint.

    \n

    You must compress the SARIF-formatted analysis data that you want to upload, using gzip, and then encode it as a Base64 format string. For example:

    \n
    gzip -c analysis-data.sarif | base64\n
    \n

    SARIF upload supports a maximum of 1000 results per analysis run. Any results over this limit are ignored. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.

    \n

    The 202 Accepted, response includes an id value.\nYou can use this ID to check the status of the upload by using this for the /sarifs/{sarif_id} endpoint.\nFor more information, see \"Get information about a SARIF upload.\"

    ", + "descriptionHTML": "

    Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the security_events scope to use this endpoint. GitHub Apps must have the security_events write permission to use this endpoint.

    \n

    There are two places where you can upload code scanning results.

    \n\n

    You must compress the SARIF-formatted analysis data that you want to upload, using gzip, and then encode it as a Base64 format string. For example:

    \n
    gzip -c analysis-data.sarif | base64\n
    \n

    SARIF upload supports a maximum of 1000 results per analysis run. Any results over this limit are ignored. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.

    \n

    The 202 Accepted, response includes an id value.\nYou can use this ID to check the status of the upload by using this for the /sarifs/{sarif_id} endpoint.\nFor more information, see \"Get information about a SARIF upload.\"

    ", "bodyParameters": [ { "description": "

    Required. The SHA of the commit to which the analysis you are uploading relates.

    ", @@ -41009,11 +41170,11 @@ }, { "type": "string", - "description": "

    Required. The full Git reference, formatted as refs/heads/<branch name>.

    ", + "description": "

    Required. The full Git reference, formatted as refs/heads/<branch name>,\nrefs/pull/<number>/merge, or refs/pull/<number>/head.

    ", "name": "ref", "in": "body", "rawType": "string", - "rawDescription": "The full Git reference, formatted as `refs/heads/`.", + "rawDescription": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`.", "childParamsGroups": [] }, { @@ -41093,7 +41254,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/collaborators", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -41153,8 +41314,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/collaborators", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/collaborators
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/collaborators", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/collaborators
    " }, { "lang": "JavaScript", @@ -41204,7 +41365,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -41237,8 +41398,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/collaborators/USERNAME", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/collaborators/USERNAME
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/collaborators/USERNAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/collaborators/USERNAME
    " }, { "lang": "JavaScript", @@ -41287,7 +41448,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -41320,8 +41481,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/collaborators/USERNAME \\\n -d '{\"permission\":\"permission\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/collaborators/USERNAME \\\n  -d '{\"permission\":\"permission\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/collaborators/USERNAME \\\n -d '{\"permission\":\"permission\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/collaborators/USERNAME \\\n  -d '{\"permission\":\"permission\"}'
    " }, { "lang": "JavaScript", @@ -41446,7 +41607,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -41479,8 +41640,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/collaborators/USERNAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/collaborators/USERNAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/collaborators/USERNAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/collaborators/USERNAME
    " }, { "lang": "JavaScript", @@ -41515,7 +41676,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -41524,7 +41685,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/collaborators/{username}/permission", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -41557,8 +41718,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/collaborators/USERNAME/permission", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/collaborators/USERNAME/permission
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/collaborators/USERNAME/permission", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/collaborators/USERNAME/permission
    " }, { "lang": "JavaScript", @@ -41608,7 +41769,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -41652,8 +41813,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/comments", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/comments
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/comments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/comments
    " }, { "lang": "JavaScript", @@ -41705,7 +41866,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -41739,8 +41900,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/comments/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/comments/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/comments/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/comments/42
    " }, { "lang": "JavaScript", @@ -41797,7 +41958,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -41831,8 +41992,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/comments/42 \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/comments/42 \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/comments/42 \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/comments/42 \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -41918,7 +42079,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -41952,8 +42113,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/comments/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/comments/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/comments/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/comments/42
    " }, { "lang": "JavaScript", @@ -41988,7 +42149,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -42002,7 +42163,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -42076,8 +42237,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/comments/42/reactions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/comments/42/reactions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/comments/42/reactions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/comments/42/reactions
    " }, { "lang": "JavaScript", @@ -42137,7 +42298,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -42171,8 +42332,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/comments/42/reactions \\\n -d '{\"content\":\"content\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/comments/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/comments/42/reactions \\\n -d '{\"content\":\"content\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/comments/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " }, { "lang": "JavaScript", @@ -42294,7 +42455,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -42337,8 +42498,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/comments/42/reactions/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/comments/42/reactions/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/comments/42/reactions/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/comments/42/reactions/42
    " }, { "lang": "JavaScript", @@ -42378,7 +42539,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -42387,7 +42548,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/commits", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -42476,13 +42637,35 @@ "default": 1 }, "descriptionHTML": "

    Page number of the results to fetch.

    " + }, + { + "name": "top", + "description": "legacy parameter for pagination.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    legacy parameter for pagination.

    " + }, + { + "name": "last_sha", + "description": "legacy parameter for pagination.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    legacy parameter for pagination.

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/commits
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits
    " }, { "lang": "JavaScript", @@ -42547,7 +42730,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -42582,8 +42765,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.groot-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits/COMMIT_SHA/branches-where-head", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.groot-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/commits/COMMIT_SHA/branches-where-head
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.groot-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/COMMIT_SHA/branches-where-head", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.groot-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/COMMIT_SHA/branches-where-head
    " }, { "lang": "JavaScript", @@ -42645,7 +42828,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -42700,8 +42883,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits/COMMIT_SHA/comments", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/commits/COMMIT_SHA/comments
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/COMMIT_SHA/comments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/COMMIT_SHA/comments
    " }, { "lang": "JavaScript", @@ -42753,7 +42936,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -42788,8 +42971,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits/COMMIT_SHA/comments \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/commits/COMMIT_SHA/comments \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/COMMIT_SHA/comments \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/COMMIT_SHA/comments \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -42938,7 +43121,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/pulls", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -42993,8 +43176,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.groot-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits/COMMIT_SHA/pulls", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.groot-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/commits/COMMIT_SHA/pulls
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.groot-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/COMMIT_SHA/pulls", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.groot-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/COMMIT_SHA/pulls
    " }, { "lang": "JavaScript", @@ -43051,7 +43234,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/commits/{ref}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -43071,23 +43254,43 @@ }, "descriptionHTML": "" }, + { + "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.

    " + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "descriptionHTML": "

    Results per page (max 100).

    " + }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    ref+ parameter

    " + "descriptionHTML": "

    ref parameter

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits/REF", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/commits/REF
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/REF", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/REF
    " }, { "lang": "JavaScript", @@ -43147,7 +43350,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/commits/{ref}/check-runs", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -43169,14 +43372,14 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    ref+ parameter

    " + "descriptionHTML": "

    ref parameter

    " }, { "name": "check_name", @@ -43237,13 +43440,22 @@ "default": 1 }, "descriptionHTML": "

    Page number of the results to fetch.

    " + }, + { + "name": "app_id", + "in": "query", + "required": false, + "schema": { + "type": "integer" + }, + "descriptionHTML": "" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits/REF/check-runs", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/commits/REF/check-runs
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/REF/check-runs", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/REF/check-runs
    " }, { "lang": "JavaScript", @@ -43295,7 +43507,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/commits/{ref}/check-suites", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -43317,14 +43529,14 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    ref+ parameter

    " + "descriptionHTML": "

    ref parameter

    " }, { "name": "app_id", @@ -43371,8 +43583,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits/REF/check-suites", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/commits/REF/check-suites
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/REF/check-suites", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/REF/check-suites
    " }, { "lang": "JavaScript", @@ -43424,7 +43636,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/commits/{ref}/status", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -43446,21 +43658,41 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    ref+ parameter

    " + "descriptionHTML": "

    ref parameter

    " + }, + { + "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/repos/octocat/hello-world/commits/REF/status", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/commits/REF/status
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/REF/status", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/REF/status
    " }, { "lang": "JavaScript", @@ -43510,7 +43742,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/commits/{ref}/statuses", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -43532,14 +43764,14 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    ref+ parameter

    " + "descriptionHTML": "

    ref parameter

    " }, { "name": "per_page", @@ -43565,8 +43797,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits/REF/statuses", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/commits/REF/statuses
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/REF/statuses", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/REF/statuses
    " }, { "lang": "JavaScript", @@ -43616,7 +43848,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/compare/{base}...{head}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -43658,8 +43890,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/compare/BASE...HEAD", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/compare/BASE...HEAD
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/compare/BASE...HEAD", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/compare/BASE...HEAD
    " }, { "lang": "JavaScript", @@ -43714,7 +43946,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/contents/{path}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -43736,14 +43968,14 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    path+ parameter

    " + "descriptionHTML": "

    path parameter

    " }, { "name": "ref", @@ -43759,8 +43991,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/contents/PATH", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/contents/PATH
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/contents/PATH", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/contents/PATH
    " }, { "lang": "JavaScript", @@ -43838,7 +44070,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/contents/{path}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -43860,21 +44092,21 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    path+ parameter

    " + "descriptionHTML": "

    path parameter

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/contents/PATH \\\n -d '{\"message\":\"message\",\"content\":\"content\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/contents/PATH \\\n  -d '{\"message\":\"message\",\"content\":\"content\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/contents/PATH \\\n -d '{\"message\":\"message\",\"content\":\"content\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/contents/PATH \\\n  -d '{\"message\":\"message\",\"content\":\"content\"}'
    " }, { "lang": "JavaScript", @@ -44361,7 +44593,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/contents/{path}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -44383,21 +44615,21 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    path+ parameter

    " + "descriptionHTML": "

    path parameter

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/contents/PATH \\\n -d '{\"message\":\"message\",\"sha\":\"sha\"}'", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/contents/PATH \\\n  -d '{\"message\":\"message\",\"sha\":\"sha\"}'
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/contents/PATH \\\n -d '{\"message\":\"message\",\"sha\":\"sha\"}'", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/contents/PATH \\\n  -d '{\"message\":\"message\",\"sha\":\"sha\"}'
    " }, { "lang": "JavaScript", @@ -44760,7 +44992,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/contributors", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -44814,8 +45046,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/contributors", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/contributors
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/contributors", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/contributors
    " }, { "lang": "JavaScript", @@ -44873,7 +45105,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/deployments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -44933,7 +45165,8 @@ "required": false, "schema": { "type": "string", - "default": "none" + "default": "none", + "nullable": true }, "descriptionHTML": "

    The name of the environment that was deployed to (e.g., staging or production).

    " }, @@ -44961,8 +45194,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/deployments", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/deployments
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/deployments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/deployments
    " }, { "lang": "JavaScript", @@ -45014,7 +45247,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/deployments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -45038,8 +45271,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/deployments \\\n -d '{\"ref\":\"ref\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/deployments \\\n  -d '{\"ref\":\"ref\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/deployments \\\n -d '{\"ref\":\"ref\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/deployments \\\n  -d '{\"ref\":\"ref\"}'
    " }, { "lang": "JavaScript", @@ -45338,12 +45571,6 @@ "description": "Simple example", "payload": "
    {\n  \"url\": \"https://api.github.com/repos/octocat/example/deployments/1\",\n  \"id\": 1,\n  \"node_id\": \"MDEwOkRlcGxveW1lbnQx\",\n  \"sha\": \"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\n  \"ref\": \"topic-branch\",\n  \"task\": \"deploy\",\n  \"payload\": {},\n  \"original_environment\": \"staging\",\n  \"environment\": \"production\",\n  \"description\": \"Deploy request from hubot\",\n  \"creator\": {\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  \"created_at\": \"2012-07-20T01:19:13Z\",\n  \"updated_at\": \"2012-07-20T01:19:13Z\",\n  \"statuses_url\": \"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/example\",\n  \"transient_environment\": false,\n  \"production_environment\": true\n}\n
    " }, - { - "httpStatusCode": "201", - "httpStatusMessage": "Created", - "description": "Advanced example", - "payload": "
    {\n  \"url\": \"https://api.github.com/repos/octocat/example/deployments/1\",\n  \"id\": 1,\n  \"node_id\": \"MDEwOkRlcGxveW1lbnQx\",\n  \"sha\": \"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\n  \"ref\": \"topic-branch\",\n  \"task\": \"deploy\",\n  \"payload\": {},\n  \"original_environment\": \"staging\",\n  \"environment\": \"production\",\n  \"description\": \"Deploy request from hubot\",\n  \"creator\": {\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  \"created_at\": \"2012-07-20T01:19:13Z\",\n  \"updated_at\": \"2012-07-20T01:19:13Z\",\n  \"statuses_url\": \"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/example\",\n  \"transient_environment\": false,\n  \"production_environment\": true\n}\n
    " - }, { "httpStatusCode": "202", "httpStatusMessage": "Accepted", @@ -45353,14 +45580,7 @@ { "httpStatusCode": "409", "httpStatusMessage": "Conflict", - "description": "Merge conflict response", - "payload": "
    {\n  \"message\": \"Conflict merging master into topic-branch\"\n}\n
    " - }, - { - "httpStatusCode": "409", - "httpStatusMessage": "Conflict", - "description": "Failed commit status checks", - "payload": "
    {\n  \"message\": \"Conflict: Commit status checks failed for topic-branch.\"\n}\n
    " + "description": "Response when there is a merge conflict or the commit s status checks failed" }, { "httpStatusCode": "422", @@ -45372,7 +45592,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -45406,8 +45626,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/deployments/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/deployments/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/deployments/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/deployments/42
    " }, { "lang": "JavaScript", @@ -45464,7 +45684,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -45498,8 +45718,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/deployments/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/deployments/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/deployments/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/deployments/42
    " }, { "lang": "JavaScript", @@ -45534,7 +45754,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -45553,7 +45773,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -45607,8 +45827,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/deployments/42/statuses", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/deployments/42/statuses
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/deployments/42/statuses", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/deployments/42/statuses
    " }, { "lang": "JavaScript", @@ -45671,7 +45891,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -45705,8 +45925,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/deployments/42/statuses \\\n -d '{\"state\":\"state\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/deployments/42/statuses \\\n  -d '{\"state\":\"state\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/deployments/42/statuses \\\n -d '{\"state\":\"state\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/deployments/42/statuses \\\n  -d '{\"state\":\"state\"}'
    " }, { "lang": "JavaScript", @@ -45952,7 +46172,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -45995,8 +46215,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/deployments/42/statuses/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/deployments/42/statuses/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/deployments/42/statuses/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/deployments/42/statuses/42
    " }, { "lang": "JavaScript", @@ -46064,7 +46284,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/dispatches", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -46088,8 +46308,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/dispatches \\\n -d '{\"event_type\":\"event_type\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/dispatches \\\n  -d '{\"event_type\":\"event_type\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/dispatches \\\n -d '{\"event_type\":\"event_type\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/dispatches \\\n  -d '{\"event_type\":\"event_type\"}'
    " }, { "lang": "JavaScript", @@ -46162,7 +46382,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "422", @@ -46196,7 +46416,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/events", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -46240,8 +46460,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/events", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/events
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/events", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/events
    " }, { "lang": "JavaScript", @@ -46285,7 +46505,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/forks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -46315,7 +46535,8 @@ "enum": [ "newest", "oldest", - "stargazers" + "stargazers", + "watchers" ], "default": "newest" }, @@ -46340,13 +46561,35 @@ "default": 1 }, "descriptionHTML": "

    Page number of the results to fetch.

    " + }, + { + "name": "org", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    legacy query parameter for specifying the org.

    " + }, + { + "name": "organization", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    legacy query parameter for specifying the org.

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/forks", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/forks
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/forks", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/forks
    " }, { "lang": "JavaScript", @@ -46396,7 +46639,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/forks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -46415,13 +46658,35 @@ "type": "string" }, "descriptionHTML": "" + }, + { + "name": "org", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    legacy query parameter for specifying the org.

    " + }, + { + "name": "organization", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    legacy query parameter for specifying the org.

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/forks \\\n -d '{\"organization\":\"organization\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/forks \\\n  -d '{\"organization\":\"organization\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/forks \\\n -d '{\"organization\":\"organization\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/forks \\\n  -d '{\"organization\":\"organization\"}'
    " }, { "lang": "JavaScript", @@ -46444,6 +46709,7 @@ "application/json": { "schema": { "type": "object", + "nullable": true, "properties": { "organization": { "type": "string", @@ -46516,7 +46782,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/git/blobs", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -46540,8 +46806,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/blobs \\\n -d '{\"content\":\"content\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/blobs \\\n  -d '{\"content\":\"content\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/blobs \\\n -d '{\"content\":\"content\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/blobs \\\n  -d '{\"content\":\"content\"}'
    " }, { "lang": "JavaScript", @@ -46663,7 +46929,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/git/blobs/{file_sha}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -46696,8 +46962,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/blobs/FILE_SHA", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/blobs/FILE_SHA
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/blobs/FILE_SHA", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/blobs/FILE_SHA
    " }, { "lang": "JavaScript", @@ -46757,7 +47023,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/git/commits", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -46781,8 +47047,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/commits \\\n -d '{\"message\":\"message\",\"tree\":\"tree\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/commits \\\n  -d '{\"message\":\"message\",\"tree\":\"tree\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/commits \\\n -d '{\"message\":\"message\",\"tree\":\"tree\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/commits \\\n  -d '{\"message\":\"message\",\"tree\":\"tree\"}'
    " }, { "lang": "JavaScript", @@ -47236,7 +47502,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/git/commits/{commit_sha}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -47271,8 +47537,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/commits/COMMIT_SHA", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/commits/COMMIT_SHA
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/commits/COMMIT_SHA", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/commits/COMMIT_SHA
    " }, { "lang": "JavaScript", @@ -47322,7 +47588,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/git/matching-refs/{ref}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -47344,14 +47610,14 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    ref+ parameter

    " + "descriptionHTML": "

    ref parameter

    " }, { "name": "per_page", @@ -47377,8 +47643,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/matching-refs/REF", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/matching-refs/REF
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/matching-refs/REF", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/matching-refs/REF
    " }, { "lang": "JavaScript", @@ -47423,7 +47689,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/git/ref/{ref}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -47445,21 +47711,21 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    ref+ parameter

    " + "descriptionHTML": "

    ref parameter

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/ref/REF", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/ref/REF
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/ref/REF", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/ref/REF
    " }, { "lang": "JavaScript", @@ -47509,7 +47775,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/git/refs", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -47533,8 +47799,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/refs \\\n -d '{\"ref\":\"ref\",\"sha\":\"sha\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/refs \\\n  -d '{\"ref\":\"ref\",\"sha\":\"sha\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/refs \\\n -d '{\"ref\":\"ref\",\"sha\":\"sha\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/refs \\\n  -d '{\"ref\":\"ref\",\"sha\":\"sha\"}'
    " }, { "lang": "JavaScript", @@ -47658,7 +47924,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/git/refs/{ref}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -47680,21 +47946,21 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    ref+ parameter

    " + "descriptionHTML": "

    ref parameter

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/refs/REF \\\n -d '{\"sha\":\"sha\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/refs/REF \\\n  -d '{\"sha\":\"sha\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/refs/REF \\\n -d '{\"sha\":\"sha\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/refs/REF \\\n  -d '{\"sha\":\"sha\"}'
    " }, { "lang": "JavaScript", @@ -47801,7 +48067,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/git/refs/{ref}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -47823,21 +48089,21 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    ref+ parameter

    " + "descriptionHTML": "

    ref parameter

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/refs/REF", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/refs/REF
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/refs/REF", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/refs/REF
    " }, { "lang": "JavaScript", @@ -47872,7 +48138,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "422", @@ -47886,7 +48152,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/git/tags", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -47910,8 +48176,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/tags \\\n -d '{\"tag\":\"tag\",\"message\":\"message\",\"object\":\"object\",\"type\":\"type\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/tags \\\n  -d '{\"tag\":\"tag\",\"message\":\"message\",\"object\":\"object\",\"type\":\"type\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/tags \\\n -d '{\"tag\":\"tag\",\"message\":\"message\",\"object\":\"object\",\"type\":\"type\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/tags \\\n  -d '{\"tag\":\"tag\",\"message\":\"message\",\"object\":\"object\",\"type\":\"type\"}'
    " }, { "lang": "JavaScript", @@ -48218,7 +48484,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/git/tags/{tag_sha}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -48251,8 +48517,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/tags/TAG_SHA", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/tags/TAG_SHA
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/tags/TAG_SHA", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/tags/TAG_SHA
    " }, { "lang": "JavaScript", @@ -48302,7 +48568,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/git/trees", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -48326,8 +48592,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/trees \\\n -d '{\"tree\":[{\"path\":\"path\",\"mode\":\"mode\",\"type\":\"type\",\"sha\":\"sha\",\"content\":\"content\"}]}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/trees \\\n  -d '{\"tree\":[{\"path\":\"path\",\"mode\":\"mode\",\"type\":\"type\",\"sha\":\"sha\",\"content\":\"content\"}]}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/trees \\\n -d '{\"tree\":[{\"path\":\"path\",\"mode\":\"mode\",\"type\":\"type\",\"sha\":\"sha\",\"content\":\"content\"}]}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/trees \\\n  -d '{\"tree\":[{\"path\":\"path\",\"mode\":\"mode\",\"type\":\"type\",\"sha\":\"sha\",\"content\":\"content\"}]}'
    " }, { "lang": "JavaScript", @@ -48707,7 +48973,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/git/trees/{tree_sha}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -48734,6 +49000,7 @@ "schema": { "type": "string" }, + "x-multi-segment": true, "descriptionHTML": "" }, { @@ -48750,8 +49017,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/trees/TREE_SHA", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/trees/TREE_SHA
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/trees/TREE_SHA", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/trees/TREE_SHA
    " }, { "lang": "JavaScript", @@ -48812,7 +49079,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/hooks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -48856,8 +49123,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/hooks", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/hooks
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks
    " }, { "lang": "JavaScript", @@ -48907,7 +49174,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/hooks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -48931,8 +49198,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/hooks \\\n -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"token\":\"token\",\"digest\":\"digest\"}}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/hooks \\\n  -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"token\":\"token\",\"digest\":\"digest\"}}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks \\\n -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"token\":\"token\",\"digest\":\"digest\"}}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks \\\n  -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"token\":\"token\",\"digest\":\"digest\"}}'
    " }, { "lang": "JavaScript", @@ -49368,7 +49635,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -49401,8 +49668,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/hooks/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/hooks/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks/42
    " }, { "lang": "JavaScript", @@ -49452,7 +49719,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -49485,8 +49752,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/hooks/42 \\\n -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"address\":\"address\",\"room\":\"room\"}}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/hooks/42 \\\n  -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"address\":\"address\",\"room\":\"room\"}}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks/42 \\\n -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"address\":\"address\",\"room\":\"room\"}}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks/42 \\\n  -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"address\":\"address\",\"room\":\"room\"}}'
    " }, { "lang": "JavaScript", @@ -49937,7 +50204,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -49970,8 +50237,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/hooks/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/hooks/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks/42
    " }, { "lang": "JavaScript", @@ -50006,7 +50273,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -50020,7 +50287,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}/pings", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -50053,8 +50320,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/hooks/42/pings", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/hooks/42/pings
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks/42/pings", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks/42/pings
    " }, { "lang": "JavaScript", @@ -50089,7 +50356,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -50103,7 +50370,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}/tests", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -50136,8 +50403,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/hooks/42/tests", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/hooks/42/tests
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks/42/tests", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks/42/tests
    " }, { "lang": "JavaScript", @@ -50172,7 +50439,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -50186,7 +50453,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/installation", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -50210,8 +50477,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/installation", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/installation
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/installation", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/installation
    " }, { "lang": "JavaScript", @@ -50264,7 +50531,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/invitations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -50308,8 +50575,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/invitations", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/invitations
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/invitations", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/invitations
    " }, { "lang": "JavaScript", @@ -50354,7 +50621,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/invitations/{invitation_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -50388,8 +50655,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/invitations/42 \\\n -d '{\"permissions\":\"permissions\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/invitations/42 \\\n  -d '{\"permissions\":\"permissions\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/invitations/42 \\\n -d '{\"permissions\":\"permissions\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/invitations/42 \\\n  -d '{\"permissions\":\"permissions\"}'
    " }, { "lang": "JavaScript", @@ -50478,7 +50745,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/invitations/{invitation_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -50512,8 +50779,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/invitations/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/invitations/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/invitations/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/invitations/42
    " }, { "lang": "JavaScript", @@ -50548,7 +50815,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -50557,7 +50824,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -50708,8 +50975,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues
    " }, { "lang": "JavaScript", @@ -50774,7 +51041,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/issues", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -50798,8 +51065,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues \\\n -d '{\"title\":\"title\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues \\\n  -d '{\"title\":\"title\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues \\\n -d '{\"title\":\"title\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues \\\n  -d '{\"title\":\"title\"}'
    " }, { "lang": "JavaScript", @@ -51090,7 +51357,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -51173,8 +51440,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/comments", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/comments
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/comments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/comments
    " }, { "lang": "JavaScript", @@ -51236,7 +51503,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -51270,8 +51537,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/comments/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/comments/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/comments/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/comments/42
    " }, { "lang": "JavaScript", @@ -51328,7 +51595,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -51362,8 +51629,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/comments/42 \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/comments/42 \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/comments/42 \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/comments/42 \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -51449,7 +51716,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -51483,8 +51750,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/comments/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/comments/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/comments/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/comments/42
    " }, { "lang": "JavaScript", @@ -51519,7 +51786,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -51528,7 +51795,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -51602,8 +51869,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/comments/42/reactions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/comments/42/reactions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/comments/42/reactions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/comments/42/reactions
    " }, { "lang": "JavaScript", @@ -51663,7 +51930,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -51697,8 +51964,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/comments/42/reactions \\\n -d '{\"content\":\"content\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/comments/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/comments/42/reactions \\\n -d '{\"content\":\"content\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/comments/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " }, { "lang": "JavaScript", @@ -51820,7 +52087,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -51863,8 +52130,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/comments/42/reactions/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/comments/42/reactions/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/comments/42/reactions/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/comments/42/reactions/42
    " }, { "lang": "JavaScript", @@ -51904,7 +52171,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -51913,7 +52180,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/events", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -51957,8 +52224,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/events", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/events
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/events", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/events
    " }, { "lang": "JavaScript", @@ -52015,7 +52282,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/events/{event_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -52048,8 +52315,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/events/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/events/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/events/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/events/42
    " }, { "lang": "JavaScript", @@ -52116,7 +52383,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -52150,8 +52417,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42
    " }, { "lang": "JavaScript", @@ -52221,7 +52488,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -52255,8 +52522,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42 \\\n -d '{\"title\":\"title\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42 \\\n  -d '{\"title\":\"title\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42 \\\n -d '{\"title\":\"title\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42 \\\n  -d '{\"title\":\"title\"}'
    " }, { "lang": "JavaScript", @@ -52581,7 +52848,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/assignees", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -52615,8 +52882,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/assignees \\\n -d '{\"assignees\":[\"assignees\"]}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/assignees \\\n  -d '{\"assignees\":[\"assignees\"]}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/assignees \\\n -d '{\"assignees\":[\"assignees\"]}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/assignees \\\n  -d '{\"assignees\":[\"assignees\"]}'
    " }, { "lang": "JavaScript", @@ -52703,7 +52970,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/assignees", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -52737,8 +53004,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/assignees \\\n -d '{\"assignees\":[\"assignees\"]}'", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/assignees \\\n  -d '{\"assignees\":[\"assignees\"]}'
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/assignees \\\n -d '{\"assignees\":[\"assignees\"]}'", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/assignees \\\n  -d '{\"assignees\":[\"assignees\"]}'
    " }, { "lang": "JavaScript", @@ -52825,7 +53092,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -52889,8 +53156,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/comments", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/comments
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/comments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/comments
    " }, { "lang": "JavaScript", @@ -52952,7 +53219,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -52986,8 +53253,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/comments \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/comments \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/comments \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/comments \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -53089,7 +53356,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/events", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -53143,8 +53410,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/events", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/events
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/events", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/events
    " }, { "lang": "JavaScript", @@ -53201,7 +53468,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -53255,8 +53522,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/labels", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/labels
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/labels", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/labels
    " }, { "lang": "JavaScript", @@ -53306,7 +53573,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -53340,8 +53607,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/labels \\\n -d '{\"labels\":[\"labels\"]}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/labels \\\n  -d '{\"labels\":[\"labels\"]}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/labels \\\n -d '{\"labels\":[\"labels\"]}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/labels \\\n  -d '{\"labels\":[\"labels\"]}'
    " }, { "lang": "JavaScript", @@ -53441,7 +53708,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -53475,8 +53742,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/labels \\\n -d '{\"labels\":[\"labels\"]}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/labels \\\n  -d '{\"labels\":[\"labels\"]}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/labels \\\n -d '{\"labels\":[\"labels\"]}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/labels \\\n  -d '{\"labels\":[\"labels\"]}'
    " }, { "lang": "JavaScript", @@ -53573,7 +53840,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -53607,8 +53874,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/labels", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/labels
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/labels", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/labels
    " }, { "lang": "JavaScript", @@ -53643,7 +53910,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "410", @@ -53657,7 +53924,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels/{name}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -53700,8 +53967,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/labels/NAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/labels/NAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/labels/NAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/labels/NAME
    " }, { "lang": "JavaScript", @@ -53756,7 +54023,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/lock", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -53790,8 +54057,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/lock \\\n -d '{\"lock_reason\":\"lock_reason\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/lock \\\n  -d '{\"lock_reason\":\"lock_reason\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/lock \\\n -d '{\"lock_reason\":\"lock_reason\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/lock \\\n  -d '{\"lock_reason\":\"lock_reason\"}'
    " }, { "lang": "JavaScript", @@ -53851,7 +54118,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -53896,7 +54163,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/lock", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -53930,8 +54197,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/lock", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/lock
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/lock", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/lock
    " }, { "lang": "JavaScript", @@ -53964,7 +54231,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -53983,7 +54250,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -54057,8 +54324,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/reactions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/reactions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/reactions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/reactions
    " }, { "lang": "JavaScript", @@ -54123,7 +54390,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -54157,8 +54424,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/reactions \\\n -d '{\"content\":\"content\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/reactions \\\n -d '{\"content\":\"content\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " }, { "lang": "JavaScript", @@ -54274,7 +54541,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -54317,8 +54584,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/reactions/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/reactions/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/reactions/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/reactions/42
    " }, { "lang": "JavaScript", @@ -54358,7 +54625,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -54367,7 +54634,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/timeline", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -54421,8 +54688,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.mockingbird-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/timeline", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.mockingbird-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/timeline
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.mockingbird-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/timeline", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.mockingbird-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/timeline
    " }, { "lang": "JavaScript", @@ -54495,7 +54762,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/keys", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -54539,8 +54806,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/keys", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/keys
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/keys", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/keys
    " }, { "lang": "JavaScript", @@ -54585,7 +54852,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/keys", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -54609,8 +54876,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/keys \\\n -d '{\"key\":\"key\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/keys \\\n  -d '{\"key\":\"key\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/keys \\\n -d '{\"key\":\"key\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/keys \\\n  -d '{\"key\":\"key\"}'
    " }, { "lang": "JavaScript", @@ -54734,7 +55001,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/keys/{key_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -54768,8 +55035,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/keys/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/keys/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/keys/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/keys/42
    " }, { "lang": "JavaScript", @@ -54819,7 +55086,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/keys/{key_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -54853,8 +55120,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/keys/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/keys/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/keys/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/keys/42
    " }, { "lang": "JavaScript", @@ -54889,7 +55156,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -54898,7 +55165,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/labels", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -54942,8 +55209,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/labels", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/labels
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/labels", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/labels
    " }, { "lang": "JavaScript", @@ -54993,7 +55260,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/labels", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -55017,8 +55284,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/labels \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/labels \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/labels \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/labels \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -55147,7 +55414,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/labels/{name}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -55180,8 +55447,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/labels/NAME", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/labels/NAME
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/labels/NAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/labels/NAME
    " }, { "lang": "JavaScript", @@ -55231,7 +55498,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/labels/{name}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -55264,8 +55531,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/labels/NAME \\\n -d '{\"new_name\":\"new_name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/labels/NAME \\\n  -d '{\"new_name\":\"new_name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/labels/NAME \\\n -d '{\"new_name\":\"new_name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/labels/NAME \\\n  -d '{\"new_name\":\"new_name\"}'
    " }, { "lang": "JavaScript", @@ -55381,7 +55648,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/labels/{name}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -55414,8 +55681,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/labels/NAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/labels/NAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/labels/NAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/labels/NAME
    " }, { "lang": "JavaScript", @@ -55450,7 +55717,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -55459,7 +55726,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/languages", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -55483,8 +55750,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/languages", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/languages
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/languages", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/languages
    " }, { "lang": "JavaScript", @@ -55527,7 +55794,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/license", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -55551,8 +55818,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/license", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/license
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/license", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/license
    " }, { "lang": "JavaScript", @@ -55595,7 +55862,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/merges", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -55619,8 +55886,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/merges \\\n -d '{\"base\":\"base\",\"head\":\"head\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/merges \\\n  -d '{\"base\":\"base\",\"head\":\"head\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/merges \\\n -d '{\"base\":\"base\",\"head\":\"head\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/merges \\\n  -d '{\"base\":\"base\",\"head\":\"head\"}'
    " }, { "lang": "JavaScript", @@ -55743,20 +56010,12 @@ { "httpStatusCode": "404", "httpStatusMessage": "Not Found", - "description": "Missing base response", - "payload": "
    {\n  \"message\": \"Base does not exist\"\n}\n
    " - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Missing head response", - "payload": "
    {\n  \"message\": \"Head does not exist\"\n}\n
    " + "description": "Response when the base or head does not exist" }, { "httpStatusCode": "409", "httpStatusMessage": "Conflict", - "description": "Merge conflict response", - "payload": "
    {\n  \"message\": \"Merge Conflict\"\n}\n
    " + "description": "Response when there is a merge conflict" }, { "httpStatusCode": "422", @@ -55768,7 +56027,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/milestones", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -55858,8 +56117,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/milestones", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/milestones
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/milestones", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/milestones
    " }, { "lang": "JavaScript", @@ -55909,7 +56168,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/milestones", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -55933,8 +56192,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/milestones \\\n -d '{\"title\":\"title\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/milestones \\\n  -d '{\"title\":\"title\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/milestones \\\n -d '{\"title\":\"title\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/milestones \\\n  -d '{\"title\":\"title\"}'
    " }, { "lang": "JavaScript", @@ -56092,7 +56351,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/milestones/{milestone_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -56126,8 +56385,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/milestones/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/milestones/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/milestones/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/milestones/42
    " }, { "lang": "JavaScript", @@ -56177,7 +56436,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/milestones/{milestone_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -56211,8 +56470,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/milestones/42 \\\n -d '{\"title\":\"title\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/milestones/42 \\\n  -d '{\"title\":\"title\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/milestones/42 \\\n -d '{\"title\":\"title\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/milestones/42 \\\n  -d '{\"title\":\"title\"}'
    " }, { "lang": "JavaScript", @@ -56357,7 +56616,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/milestones/{milestone_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -56391,8 +56650,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/milestones/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/milestones/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/milestones/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/milestones/42
    " }, { "lang": "JavaScript", @@ -56427,7 +56686,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -56441,7 +56700,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/milestones/{milestone_number}/labels", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -56495,8 +56754,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/milestones/42/labels", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/milestones/42/labels
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/milestones/42/labels", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/milestones/42/labels
    " }, { "lang": "JavaScript", @@ -56541,7 +56800,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/notifications", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -56627,8 +56886,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/notifications", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/notifications
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/notifications", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/notifications
    " }, { "lang": "JavaScript", @@ -56673,7 +56932,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/notifications", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -56697,8 +56956,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/notifications \\\n -d '{\"last_read_at\":\"last_read_at\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/notifications \\\n  -d '{\"last_read_at\":\"last_read_at\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/notifications \\\n -d '{\"last_read_at\":\"last_read_at\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/notifications \\\n  -d '{\"last_read_at\":\"last_read_at\"}'
    " }, { "lang": "JavaScript", @@ -56772,7 +57031,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pages", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -56796,8 +57055,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pages
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages
    " }, { "lang": "JavaScript", @@ -56847,7 +57106,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/pages", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -56871,8 +57130,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages \\\n -d '{\"source\":{\"branch\":\"branch\",\"path\":\"path\"}}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pages \\\n  -d '{\"source\":{\"branch\":\"branch\",\"path\":\"path\"}}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages \\\n -d '{\"source\":{\"branch\":\"branch\",\"path\":\"path\"}}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages \\\n  -d '{\"source\":{\"branch\":\"branch\",\"path\":\"path\"}}'
    " }, { "lang": "JavaScript", @@ -57097,7 +57356,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/pages", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -57121,8 +57380,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages \\\n -d '{\"source\":\"source\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pages \\\n  -d '{\"source\":\"source\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages \\\n -d '{\"source\":\"source\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages \\\n  -d '{\"source\":\"source\"}'
    " }, { "lang": "JavaScript", @@ -57236,7 +57495,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "400", @@ -57314,7 +57573,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/pages", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -57338,8 +57597,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pages
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages
    " }, { "lang": "JavaScript", @@ -57381,7 +57640,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -57405,7 +57664,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pages/builds", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -57449,8 +57708,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages/builds", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pages/builds
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages/builds", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages/builds
    " }, { "lang": "JavaScript", @@ -57495,7 +57754,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/pages/builds", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -57519,8 +57778,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages/builds", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pages/builds
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages/builds", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages/builds
    " }, { "lang": "JavaScript", @@ -57565,7 +57824,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pages/builds/latest", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -57589,8 +57848,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages/builds/latest", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pages/builds/latest
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages/builds/latest", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages/builds/latest
    " }, { "lang": "JavaScript", @@ -57635,7 +57894,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pages/builds/{build_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -57668,8 +57927,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages/builds/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pages/builds/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages/builds/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages/builds/42
    " }, { "lang": "JavaScript", @@ -57714,7 +57973,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -57753,13 +58012,43 @@ "default": 1 }, "descriptionHTML": "

    Page number of the results to fetch.

    " + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + }, + "descriptionHTML": "

    One of asc (ascending) or desc (descending).

    " + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + }, + "descriptionHTML": "" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pre-receive-hooks", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pre-receive-hooks
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pre-receive-hooks", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pre-receive-hooks
    " }, { "lang": "JavaScript", @@ -57811,7 +58100,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -57844,8 +58133,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pre-receive-hooks/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pre-receive-hooks/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pre-receive-hooks/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pre-receive-hooks/42
    " }, { "lang": "JavaScript", @@ -57897,7 +58186,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -57930,8 +58219,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pre-receive-hooks/42 \\\n -d '{\"enforcement\":\"enforcement\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pre-receive-hooks/42 \\\n  -d '{\"enforcement\":\"enforcement\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pre-receive-hooks/42 \\\n -d '{\"enforcement\":\"enforcement\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pre-receive-hooks/42 \\\n  -d '{\"enforcement\":\"enforcement\"}'
    " }, { "lang": "JavaScript", @@ -58016,7 +58305,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -58049,8 +58338,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pre-receive-hooks/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pre-receive-hooks/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pre-receive-hooks/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pre-receive-hooks/42
    " }, { "lang": "JavaScript", @@ -58102,7 +58391,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/projects", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -58162,8 +58451,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/projects", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/projects
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/projects", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/projects
    " }, { "lang": "JavaScript", @@ -58238,7 +58527,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/projects", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -58262,8 +58551,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/projects \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/projects \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/projects \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/projects \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -58393,7 +58682,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -58504,8 +58793,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls
    " }, { "lang": "JavaScript", @@ -58558,7 +58847,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/pulls", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -58582,8 +58871,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls \\\n -d '{\"head\":\"head\",\"base\":\"base\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls \\\n  -d '{\"head\":\"head\",\"base\":\"base\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls \\\n -d '{\"head\":\"head\",\"base\":\"base\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls \\\n  -d '{\"head\":\"head\",\"base\":\"base\"}'
    " }, { "lang": "JavaScript", @@ -58785,7 +59074,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -58807,18 +59096,17 @@ }, { "name": "sort", - "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to).", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "created", - "updated" - ], - "default": "created" + "updated", + "created_at" + ] }, - "descriptionHTML": "

    One of created (when the repository was starred) or updated (when it was last pushed to).

    " + "descriptionHTML": "" }, { "name": "direction", @@ -58868,8 +59156,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/comments", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/comments
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/comments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/comments
    " }, { "lang": "JavaScript", @@ -58927,7 +59215,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -58961,8 +59249,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/comments/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/comments/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/comments/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/comments/42
    " }, { "lang": "JavaScript", @@ -59025,7 +59313,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -59059,8 +59347,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/comments/42 \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/comments/42 \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/comments/42 \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/comments/42 \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -59148,7 +59436,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -59182,8 +59470,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/comments/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/comments/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/comments/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/comments/42
    " }, { "lang": "JavaScript", @@ -59218,7 +59506,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -59232,7 +59520,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -59306,8 +59594,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/comments/42/reactions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/comments/42/reactions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/comments/42/reactions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/comments/42/reactions
    " }, { "lang": "JavaScript", @@ -59367,7 +59655,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -59401,8 +59689,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/comments/42/reactions \\\n -d '{\"content\":\"content\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/comments/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/comments/42/reactions \\\n -d '{\"content\":\"content\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/comments/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " }, { "lang": "JavaScript", @@ -59524,7 +59812,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -59567,8 +59855,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/comments/42/reactions/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/comments/42/reactions/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/comments/42/reactions/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/comments/42/reactions/42
    " }, { "lang": "JavaScript", @@ -59608,7 +59896,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -59617,7 +59905,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -59650,8 +59938,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42
    " }, { "lang": "JavaScript", @@ -59709,7 +59997,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -59742,8 +60030,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42 \\\n -d '{\"title\":\"title\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42 \\\n  -d '{\"title\":\"title\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42 \\\n -d '{\"title\":\"title\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42 \\\n  -d '{\"title\":\"title\"}'
    " }, { "lang": "JavaScript", @@ -59912,7 +60200,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -60004,8 +60292,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/comments", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/comments
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/comments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/comments
    " }, { "lang": "JavaScript", @@ -60063,7 +60351,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -60096,8 +60384,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/comments \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/comments \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/comments \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/comments \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -60379,7 +60667,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -60422,8 +60710,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/comments/42/replies \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/comments/42/replies \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/comments/42/replies \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/comments/42/replies \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -60510,7 +60798,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/commits", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -60563,8 +60851,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/commits", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/commits
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/commits", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/commits
    " }, { "lang": "JavaScript", @@ -60607,7 +60895,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/files", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -60660,8 +60948,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/files", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/files
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/files", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/files
    " }, { "lang": "JavaScript", @@ -60714,7 +61002,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/merge", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -60747,8 +61035,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/merge", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/merge
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/merge", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/merge
    " }, { "lang": "JavaScript", @@ -60795,7 +61083,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/merge", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -60828,8 +61116,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/merge \\\n -d '{\"commit_title\":\"commit_title\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/merge \\\n  -d '{\"commit_title\":\"commit_title\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/merge \\\n -d '{\"commit_title\":\"commit_title\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/merge \\\n  -d '{\"commit_title\":\"commit_title\"}'
    " }, { "lang": "JavaScript", @@ -60995,7 +61283,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -61048,8 +61336,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/requested_reviewers", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/requested_reviewers
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/requested_reviewers", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/requested_reviewers
    " }, { "lang": "JavaScript", @@ -61094,7 +61382,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -61127,8 +61415,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/requested_reviewers \\\n -d '{\"reviewers\":[\"reviewers\"]}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/requested_reviewers \\\n  -d '{\"reviewers\":[\"reviewers\"]}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/requested_reviewers \\\n -d '{\"reviewers\":[\"reviewers\"]}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/requested_reviewers \\\n  -d '{\"reviewers\":[\"reviewers\"]}'
    " }, { "lang": "JavaScript", @@ -61266,7 +61554,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -61299,8 +61587,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/requested_reviewers \\\n -d '{\"reviewers\":[\"reviewers\"]}'", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/requested_reviewers \\\n  -d '{\"reviewers\":[\"reviewers\"]}'
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/requested_reviewers \\\n -d '{\"reviewers\":[\"reviewers\"]}'", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/requested_reviewers \\\n  -d '{\"reviewers\":[\"reviewers\"]}'
    " }, { "lang": "JavaScript", @@ -61422,7 +61710,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -61475,8 +61763,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/reviews
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews
    " }, { "lang": "JavaScript", @@ -61521,7 +61809,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -61554,8 +61842,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews \\\n -d '{\"commit_id\":\"commit_id\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/reviews \\\n  -d '{\"commit_id\":\"commit_id\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews \\\n -d '{\"commit_id\":\"commit_id\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews \\\n  -d '{\"commit_id\":\"commit_id\"}'
    " }, { "lang": "JavaScript", @@ -62003,7 +62291,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -62046,8 +62334,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews/42
    " }, { "lang": "JavaScript", @@ -62097,7 +62385,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -62140,8 +62428,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42 \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42 \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews/42 \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews/42 \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -62227,7 +62515,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -62270,8 +62558,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews/42
    " }, { "lang": "JavaScript", @@ -62326,7 +62614,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -62389,8 +62677,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42/comments", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42/comments
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews/42/comments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews/42/comments
    " }, { "lang": "JavaScript", @@ -62440,7 +62728,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -62483,8 +62771,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42/dismissals \\\n -d '{\"message\":\"message\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42/dismissals \\\n  -d '{\"message\":\"message\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews/42/dismissals \\\n -d '{\"message\":\"message\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews/42/dismissals \\\n  -d '{\"message\":\"message\"}'
    " }, { "lang": "JavaScript", @@ -62590,7 +62878,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -62633,8 +62921,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42/events \\\n -d '{\"event\":\"event\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42/events \\\n  -d '{\"event\":\"event\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews/42/events \\\n -d '{\"event\":\"event\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews/42/events \\\n  -d '{\"event\":\"event\"}'
    " }, { "lang": "JavaScript", @@ -62755,7 +63043,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/update-branch", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -62788,8 +63076,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.lydian-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/update-branch \\\n -d '{\"expected_head_sha\":\"expected_head_sha\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.lydian-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/update-branch \\\n  -d '{\"expected_head_sha\":\"expected_head_sha\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.lydian-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/update-branch \\\n -d '{\"expected_head_sha\":\"expected_head_sha\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.lydian-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/update-branch \\\n  -d '{\"expected_head_sha\":\"expected_head_sha\"}'
    " }, { "lang": "JavaScript", @@ -62888,7 +63176,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/readme", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -62922,8 +63210,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/readme", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/readme
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/readme", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/readme
    " }, { "lang": "JavaScript", @@ -62975,10 +63263,111 @@ } ] }, + { + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/readme/{dir}", + "serverUrl": "http(s)://{hostname}/api/v3", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "dir", + "description": "The alternate path to look for a README file", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true, + "descriptionHTML": "

    The alternate path to look for a README file

    " + }, + { + "name": "ref", + "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    The name of the commit/branch/tag. Default: the repository’s default branch (usually master)

    " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/readme/DIR", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/readme/DIR
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /repos/{owner}/{repo}/readme/{dir}', {\n owner: 'octocat',\n repo: 'hello-world',\n dir: 'dir'\n})", + "html": "
    await octokit.request('GET /repos/{owner}/{repo}/readme/{dir}', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  dir: 'dir'\n})\n
    " + } + ], + "summary": "Get a repository README", + "description": "Gets the preferred README for a repository.\n\nREADMEs support [custom media types](https://docs.github.com/enterprise-server@2.22/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML.", + "tags": [ + "repos" + ], + "operationId": "repos/get-readme-from-alt-path", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@2.22/rest/reference/repos#get-a-repository-readme" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "contents" + }, + "slug": "get-a-repository-readme", + "category": "repos", + "categoryLabel": "Repos", + "subcategory": "contents", + "subcategoryLabel": "Contents", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

    Gets the preferred README for a repository.

    \n

    READMEs support custom media types for retrieving the raw content or rendered HTML.

    ", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
    {\n  \"type\": \"file\",\n  \"encoding\": \"base64\",\n  \"size\": 5362,\n  \"name\": \"README.md\",\n  \"path\": \"README.md\",\n  \"content\": \"encoded content ...\",\n  \"sha\": \"3d21ec53a331a6f037a91c368710b99387d012c1\",\n  \"url\": \"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\n  \"git_url\": \"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\n  \"html_url\": \"https://github.com/octokit/octokit.rb/blob/master/README.md\",\n  \"download_url\": \"https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md\",\n  \"_links\": {\n    \"git\": \"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\n    \"self\": \"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\n    \"html\": \"https://github.com/octokit/octokit.rb/blob/master/README.md\"\n  }\n}\n
    " + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + } + ] + }, { "verb": "get", "requestPath": "/repos/{owner}/{repo}/releases", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -63022,8 +63411,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases
    " }, { "lang": "JavaScript", @@ -63073,7 +63462,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/releases", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -63097,8 +63486,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases \\\n -d '{\"tag_name\":\"tag_name\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases \\\n  -d '{\"tag_name\":\"tag_name\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases \\\n -d '{\"tag_name\":\"tag_name\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases \\\n  -d '{\"tag_name\":\"tag_name\"}'
    " }, { "lang": "JavaScript", @@ -63284,7 +63673,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/releases/assets/{asset_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -63318,8 +63707,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/assets/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases/assets/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/assets/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/assets/42
    " }, { "lang": "JavaScript", @@ -63379,7 +63768,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/releases/assets/{asset_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -63413,8 +63802,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/assets/42 \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases/assets/42 \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/assets/42 \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/assets/42 \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -63529,7 +63918,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/releases/assets/{asset_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -63563,8 +63952,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/assets/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases/assets/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/assets/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/assets/42
    " }, { "lang": "JavaScript", @@ -63599,7 +63988,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -63608,7 +63997,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/releases/latest", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -63632,8 +64021,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/latest", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases/latest
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/latest", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/latest
    " }, { "lang": "JavaScript", @@ -63678,7 +64067,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/releases/tags/{tag}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -63700,21 +64089,21 @@ }, { "name": "tag", - "description": "tag+ parameter", + "description": "tag parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    tag+ parameter

    " + "descriptionHTML": "

    tag parameter

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/tags/TAG", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases/tags/TAG
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/tags/TAG", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/tags/TAG
    " }, { "lang": "JavaScript", @@ -63764,7 +64153,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/releases/{release_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -63798,8 +64187,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/42
    " }, { "lang": "JavaScript", @@ -63849,7 +64238,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/releases/{release_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -63883,8 +64272,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/42 \\\n -d '{\"tag_name\":\"tag_name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases/42 \\\n  -d '{\"tag_name\":\"tag_name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/42 \\\n -d '{\"tag_name\":\"tag_name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/42 \\\n  -d '{\"tag_name\":\"tag_name\"}'
    " }, { "lang": "JavaScript", @@ -64057,7 +64446,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/releases/{release_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -64091,8 +64480,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/42
    " }, { "lang": "JavaScript", @@ -64127,7 +64516,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -64136,7 +64525,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/releases/{release_id}/assets", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -64190,8 +64579,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/42/assets", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases/42/assets
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/42/assets", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/42/assets
    " }, { "lang": "JavaScript", @@ -64236,7 +64625,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/releases/{release_id}/assets", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -64286,8 +64675,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/42/assets", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases/42/assets
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/42/assets", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/42/assets
    " }, { "lang": "JavaScript", @@ -64353,7 +64742,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/stargazers", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -64397,8 +64786,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/stargazers", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/stargazers
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/stargazers", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/stargazers
    " }, { "lang": "JavaScript", @@ -64448,7 +64837,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/stats/code_frequency", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -64472,8 +64861,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/stats/code_frequency", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/stats/code_frequency
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/stats/code_frequency", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/stats/code_frequency
    " }, { "lang": "JavaScript", @@ -64518,7 +64907,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/stats/commit_activity", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -64542,8 +64931,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/stats/commit_activity", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/stats/commit_activity
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/stats/commit_activity", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/stats/commit_activity
    " }, { "lang": "JavaScript", @@ -64588,7 +64977,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/stats/contributors", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -64612,8 +65001,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/stats/contributors", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/stats/contributors
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/stats/contributors", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/stats/contributors
    " }, { "lang": "JavaScript", @@ -64658,7 +65047,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/stats/participation", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -64682,8 +65071,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/stats/participation", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/stats/participation
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/stats/participation", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/stats/participation
    " }, { "lang": "JavaScript", @@ -64733,7 +65122,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/stats/punch_card", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -64757,8 +65146,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/stats/punch_card", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/stats/punch_card
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/stats/punch_card", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/stats/punch_card
    " }, { "lang": "JavaScript", @@ -64803,7 +65192,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/statuses/{sha}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -64837,8 +65226,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/statuses/SHA \\\n -d '{\"state\":\"state\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/statuses/SHA \\\n  -d '{\"state\":\"state\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/statuses/SHA \\\n -d '{\"state\":\"state\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/statuses/SHA \\\n  -d '{\"state\":\"state\"}'
    " }, { "lang": "JavaScript", @@ -64990,7 +65379,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/subscribers", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -65034,8 +65423,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/subscribers", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/subscribers
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/subscribers", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/subscribers
    " }, { "lang": "JavaScript", @@ -65080,7 +65469,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/subscription", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -65104,8 +65493,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/subscription", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/subscription
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/subscription", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/subscription
    " }, { "lang": "JavaScript", @@ -65160,7 +65549,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/subscription", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -65184,8 +65573,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/subscription \\\n -d '{\"subscribed\":true}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/subscription \\\n  -d '{\"subscribed\":true}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/subscription \\\n -d '{\"subscribed\":true}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/subscription \\\n  -d '{\"subscribed\":true}'
    " }, { "lang": "JavaScript", @@ -65278,7 +65667,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/subscription", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -65302,8 +65691,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/subscription", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/subscription
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/subscription", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/subscription
    " }, { "lang": "JavaScript", @@ -65338,7 +65727,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -65347,7 +65736,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/tags", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -65391,8 +65780,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/tags", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/tags
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/tags", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/tags
    " }, { "lang": "JavaScript", @@ -65435,7 +65824,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/tarball/{ref}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -65468,8 +65857,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/tarball/REF", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/tarball/REF
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/tarball/REF", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/tarball/REF
    " }, { "lang": "JavaScript", @@ -65513,7 +65902,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/teams", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -65557,8 +65946,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/teams", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/teams
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/teams", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/teams
    " }, { "lang": "JavaScript", @@ -65601,7 +65990,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/topics", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -65620,13 +66009,33 @@ "type": "string" }, "descriptionHTML": "" + }, + { + "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.

    " + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "descriptionHTML": "

    Results per page (max 100).

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/topics", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/topics
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/topics", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/topics
    " }, { "lang": "JavaScript", @@ -65686,7 +66095,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/topics", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -65710,8 +66119,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/topics \\\n -d '{\"names\":[\"names\"]}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/topics \\\n  -d '{\"names\":[\"names\"]}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/topics \\\n -d '{\"names\":[\"names\"]}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/topics \\\n  -d '{\"names\":[\"names\"]}'
    " }, { "lang": "JavaScript", @@ -65823,7 +66232,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/transfer", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -65847,8 +66256,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/transfer \\\n -d '{\"new_owner\":\"new_owner\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/transfer \\\n  -d '{\"new_owner\":\"new_owner\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/transfer \\\n -d '{\"new_owner\":\"new_owner\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/transfer \\\n  -d '{\"new_owner\":\"new_owner\"}'
    " }, { "lang": "JavaScript", @@ -65955,7 +66364,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/vulnerability-alerts", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -65979,8 +66388,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/vulnerability-alerts", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/vulnerability-alerts
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/vulnerability-alerts", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/vulnerability-alerts
    " }, { "lang": "JavaScript", @@ -66020,7 +66429,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -66029,7 +66438,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/vulnerability-alerts", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -66053,8 +66462,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/vulnerability-alerts", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/vulnerability-alerts
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/vulnerability-alerts", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/vulnerability-alerts
    " }, { "lang": "JavaScript", @@ -66094,7 +66503,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -66103,7 +66512,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/zipball/{ref}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -66136,8 +66545,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/zipball/REF", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/zipball/REF
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/zipball/REF", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/zipball/REF
    " }, { "lang": "JavaScript", @@ -66181,7 +66590,7 @@ { "verb": "post", "requestPath": "/repos/{template_owner}/{template_repo}/generate", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "template_owner", @@ -66205,8 +66614,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.baptiste-preview+json\" \\\n https://api.github.com/repos/TEMPLATE_OWNER/TEMPLATE_REPO/generate \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.baptiste-preview+json\" \\\n  https://api.github.com/repos/TEMPLATE_OWNER/TEMPLATE_REPO/generate \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.baptiste-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/TEMPLATE_OWNER/TEMPLATE_REPO/generate \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.baptiste-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/TEMPLATE_OWNER/TEMPLATE_REPO/generate \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -66215,7 +66624,7 @@ } ], "summary": "Create a repository using a template", - "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@2.22/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", + "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@2.22/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository", "tags": [ "repos" ], @@ -66310,7 +66719,7 @@ "category": "repos", "categoryLabel": "Repos", "notes": [], - "descriptionHTML": "

    Creates a new repository using a repository template. Use the template_owner and template_repo route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the Get a repository endpoint and check that the is_template key is true.

    \n

    OAuth scope requirements

    \n

    When using OAuth, authorizations must include:

    \n
      \n
    • public_repo scope or repo scope to create a public repository
    • \n
    • repo scope to create a private repository
    • \n
    ", + "descriptionHTML": "

    Creates a new repository using a repository template. Use the template_owner and template_repo route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the Get a repository endpoint and check that the is_template key is true.

    \n

    OAuth scope requirements

    \n

    When using OAuth, authorizations must include:

    \n
      \n
    • public_repo scope or repo scope to create a public repository. Note: For GitHub AE, use repo scope to create an internal repository.
    • \n
    • repo scope to create a private repository
    • \n
    ", "bodyParameters": [ { "type": "string", @@ -66372,7 +66781,7 @@ { "verb": "get", "requestPath": "/repositories", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "since", @@ -66386,7 +66795,7 @@ }, { "name": "visibility", - "description": "Specifies the types of repositories to return. Can be one of `all` or `public`. Default: `public`.", + "description": "Specifies the types of repositories to return. Can be one of `all` or `public`. Default: `public`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise.", "in": "query", "required": false, "schema": { @@ -66398,14 +66807,14 @@ "public" ] }, - "descriptionHTML": "

    Specifies the types of repositories to return. Can be one of all or public. Default: public.

    " + "descriptionHTML": "

    Specifies the types of repositories to return. Can be one of all or public. Default: public. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise.

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repositories", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repositories
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repositories", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repositories
    " }, { "lang": "JavaScript", @@ -66414,7 +66823,7 @@ } ], "summary": "List public repositories", - "description": "Lists all public repositories in the order that they were created.\n\nNote: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@2.22/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.", + "description": "Lists all public repositories in the order that they were created.\n\nNotes:\n- For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise.\n- Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@2.22/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.", "tags": [ "repos" ], @@ -66435,7 +66844,7 @@ "categoryLabel": "Repos", "notes": [], "bodyParameters": [], - "descriptionHTML": "

    Lists all public repositories in the order that they were created.

    \n

    Note: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of repositories.

    ", + "descriptionHTML": "

    Lists all public repositories in the order that they were created.

    \n

    Notes:

    \n
      \n
    • For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise.
    • \n
    • Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of repositories.
    • \n
    ", "responses": [ { "httpStatusCode": "200", @@ -66458,7 +66867,7 @@ { "verb": "get", "requestPath": "/search/code", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "q", @@ -66522,8 +66931,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/search/code", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/search/code
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/search/code", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/search/code
    " }, { "lang": "JavaScript", @@ -66586,7 +66995,7 @@ { "verb": "get", "requestPath": "/search/commits", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "q", @@ -66651,8 +67060,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.cloak-preview+json\" \\\n https://api.github.com/search/commits", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.cloak-preview+json\" \\\n  https://api.github.com/search/commits
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.cloak-preview+json\" \\\n http(s)://{hostname}/api/v3/search/commits", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.cloak-preview+json\" \\\n  http(s)://{hostname}/api/v3/search/commits
    " }, { "lang": "JavaScript", @@ -66712,7 +67121,7 @@ { "verb": "get", "requestPath": "/search/issues", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "q", @@ -66786,8 +67195,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/search/issues", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/search/issues
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/search/issues", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/search/issues
    " }, { "lang": "JavaScript", @@ -66850,7 +67259,7 @@ { "verb": "get", "requestPath": "/search/labels", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "repository_id", @@ -66905,8 +67314,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/search/labels", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/search/labels
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/search/labels", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/search/labels
    " }, { "lang": "JavaScript", @@ -66969,7 +67378,7 @@ { "verb": "get", "requestPath": "/search/repositories", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "q", @@ -67036,8 +67445,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/search/repositories", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/search/repositories
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/search/repositories", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/search/repositories
    " }, { "lang": "JavaScript", @@ -67102,7 +67511,7 @@ { "verb": "get", "requestPath": "/search/topics", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "q", @@ -67118,8 +67527,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n https://api.github.com/search/topics", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n  https://api.github.com/search/topics
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n http(s)://{hostname}/api/v3/search/topics", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n  http(s)://{hostname}/api/v3/search/topics
    " }, { "lang": "JavaScript", @@ -67179,7 +67588,7 @@ { "verb": "get", "requestPath": "/search/users", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "q", @@ -67245,8 +67654,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/search/users", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/search/users
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/search/users", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/search/users
    " }, { "lang": "JavaScript", @@ -67304,13 +67713,13 @@ { "verb": "get", "requestPath": "/setup/api/configcheck", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/configcheck", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/setup/api/configcheck
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/setup/api/configcheck", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/setup/api/configcheck
    " }, { "lang": "JavaScript", @@ -67355,13 +67764,13 @@ { "verb": "post", "requestPath": "/setup/api/configure", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/configure", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/setup/api/configure
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/setup/api/configure", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/setup/api/configure
    " }, { "lang": "JavaScript", @@ -67405,13 +67814,13 @@ { "verb": "get", "requestPath": "/setup/api/maintenance", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/maintenance", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/setup/api/maintenance
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/setup/api/maintenance", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/setup/api/maintenance
    " }, { "lang": "JavaScript", @@ -67456,13 +67865,13 @@ { "verb": "post", "requestPath": "/setup/api/maintenance", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/maintenance \\\n -d '{\"maintenance\":\"maintenance\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/setup/api/maintenance \\\n  -d '{\"maintenance\":\"maintenance\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/setup/api/maintenance \\\n -d '{\"maintenance\":\"maintenance\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/setup/api/maintenance \\\n  -d '{\"maintenance\":\"maintenance\"}'
    " }, { "lang": "JavaScript", @@ -67540,13 +67949,13 @@ { "verb": "get", "requestPath": "/setup/api/settings", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/settings", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/setup/api/settings
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/setup/api/settings", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/setup/api/settings
    " }, { "lang": "JavaScript", @@ -67591,13 +68000,13 @@ { "verb": "put", "requestPath": "/setup/api/settings", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/settings \\\n -d '{\"settings\":\"settings\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/setup/api/settings \\\n  -d '{\"settings\":\"settings\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/setup/api/settings \\\n -d '{\"settings\":\"settings\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/setup/api/settings \\\n  -d '{\"settings\":\"settings\"}'
    " }, { "lang": "JavaScript", @@ -67655,7 +68064,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "descriptionHTML": "

    For a list of the available settings, see the Get settings endpoint.

    ", @@ -67674,13 +68083,13 @@ { "verb": "get", "requestPath": "/setup/api/settings/authorized-keys", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/settings/authorized-keys", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/setup/api/settings/authorized-keys
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/setup/api/settings/authorized-keys", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/setup/api/settings/authorized-keys
    " }, { "lang": "JavaScript", @@ -67725,13 +68134,13 @@ { "verb": "post", "requestPath": "/setup/api/settings/authorized-keys", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/settings/authorized-keys \\\n -d '{\"authorized_key\":\"authorized_key\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/setup/api/settings/authorized-keys \\\n  -d '{\"authorized_key\":\"authorized_key\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/setup/api/settings/authorized-keys \\\n -d '{\"authorized_key\":\"authorized_key\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/setup/api/settings/authorized-keys \\\n  -d '{\"authorized_key\":\"authorized_key\"}'
    " }, { "lang": "JavaScript", @@ -67809,13 +68218,13 @@ { "verb": "delete", "requestPath": "/setup/api/settings/authorized-keys", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/settings/authorized-keys \\\n -d '{\"authorized_key\":\"authorized_key\"}'", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/setup/api/settings/authorized-keys \\\n  -d '{\"authorized_key\":\"authorized_key\"}'
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/setup/api/settings/authorized-keys \\\n -d '{\"authorized_key\":\"authorized_key\"}'", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/setup/api/settings/authorized-keys \\\n  -d '{\"authorized_key\":\"authorized_key\"}'
    " }, { "lang": "JavaScript", @@ -67893,13 +68302,13 @@ { "verb": "post", "requestPath": "/setup/api/start", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/start \\\n -d '{\"license\":\"license\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/setup/api/start \\\n  -d '{\"license\":\"license\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/setup/api/start \\\n -d '{\"license\":\"license\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/setup/api/start \\\n  -d '{\"license\":\"license\"}'
    " }, { "lang": "JavaScript", @@ -68012,13 +68421,13 @@ { "verb": "post", "requestPath": "/setup/api/upgrade", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/upgrade \\\n -d '{\"license\":\"license\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/setup/api/upgrade \\\n  -d '{\"license\":\"license\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/setup/api/upgrade \\\n -d '{\"license\":\"license\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/setup/api/upgrade \\\n  -d '{\"license\":\"license\"}'
    " }, { "lang": "JavaScript", @@ -68092,7 +68501,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -68107,8 +68516,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42
    " }, { "lang": "JavaScript", @@ -68159,7 +68568,7 @@ { "verb": "patch", "requestPath": "/teams/{team_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -68174,8 +68583,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42 \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42 \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42 \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42 \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -68368,7 +68777,7 @@ { "verb": "delete", "requestPath": "/teams/{team_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -68383,8 +68792,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42
    " }, { "lang": "JavaScript", @@ -68420,7 +68829,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -68439,7 +68848,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/discussions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -68489,8 +68898,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/discussions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions
    " }, { "lang": "JavaScript", @@ -68545,7 +68954,7 @@ { "verb": "post", "requestPath": "/teams/{team_id}/discussions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -68560,8 +68969,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions \\\n -d '{\"title\":\"title\",\"body\":\"body\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/discussions \\\n  -d '{\"title\":\"title\",\"body\":\"body\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions \\\n -d '{\"title\":\"title\",\"body\":\"body\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions \\\n  -d '{\"title\":\"title\",\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -68693,7 +69102,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/discussions/{discussion_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -68717,8 +69126,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/discussions/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions/42
    " }, { "lang": "JavaScript", @@ -68773,7 +69182,7 @@ { "verb": "patch", "requestPath": "/teams/{team_id}/discussions/{discussion_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -68797,8 +69206,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions/42 \\\n -d '{\"title\":\"title\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/discussions/42 \\\n  -d '{\"title\":\"title\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions/42 \\\n -d '{\"title\":\"title\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions/42 \\\n  -d '{\"title\":\"title\"}'
    " }, { "lang": "JavaScript", @@ -68904,7 +69313,7 @@ { "verb": "delete", "requestPath": "/teams/{team_id}/discussions/{discussion_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -68928,8 +69337,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/discussions/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions/42
    " }, { "lang": "JavaScript", @@ -68967,7 +69376,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -68976,7 +69385,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -69035,8 +69444,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions/42/comments", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/discussions/42/comments
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions/42/comments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions/42/comments
    " }, { "lang": "JavaScript", @@ -69091,7 +69500,7 @@ { "verb": "post", "requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -69115,8 +69524,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions/42/comments \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/discussions/42/comments \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions/42/comments \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions/42/comments \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -69208,7 +69617,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -69241,8 +69650,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions/42/comments/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/discussions/42/comments/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions/42/comments/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions/42/comments/42
    " }, { "lang": "JavaScript", @@ -69297,7 +69706,7 @@ { "verb": "patch", "requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -69330,8 +69739,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions/42/comments/42 \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/discussions/42/comments/42 \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions/42/comments/42 \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions/42/comments/42 \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -69422,7 +69831,7 @@ { "verb": "delete", "requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -69455,8 +69864,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions/42/comments/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/discussions/42/comments/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions/42/comments/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions/42/comments/42
    " }, { "lang": "JavaScript", @@ -69494,7 +69903,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -69503,7 +69912,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -69576,8 +69985,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/teams/42/discussions/42/comments/42/reactions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/teams/42/discussions/42/comments/42/reactions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions/42/comments/42/reactions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions/42/comments/42/reactions
    " }, { "lang": "JavaScript", @@ -69630,7 +70039,7 @@ { "verb": "post", "requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -69663,8 +70072,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/teams/42/discussions/42/comments/42/reactions \\\n -d '{\"content\":\"content\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/teams/42/discussions/42/comments/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions/42/comments/42/reactions \\\n -d '{\"content\":\"content\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions/42/comments/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " }, { "lang": "JavaScript", @@ -69773,7 +70182,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/discussions/{discussion_number}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -69837,8 +70246,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/teams/42/discussions/42/reactions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/teams/42/discussions/42/reactions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions/42/reactions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions/42/reactions
    " }, { "lang": "JavaScript", @@ -69891,7 +70300,7 @@ { "verb": "post", "requestPath": "/teams/{team_id}/discussions/{discussion_number}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -69915,8 +70324,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/teams/42/discussions/42/reactions \\\n -d '{\"content\":\"content\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/teams/42/discussions/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions/42/reactions \\\n -d '{\"content\":\"content\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " }, { "lang": "JavaScript", @@ -70025,7 +70434,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/members", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -70076,8 +70485,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/members", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/members
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/members", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/members
    " }, { "lang": "JavaScript", @@ -70130,7 +70539,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/members/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -70154,8 +70563,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/members/USERNAME", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/members/USERNAME
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/members/USERNAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/members/USERNAME
    " }, { "lang": "JavaScript", @@ -70207,7 +70616,7 @@ { "verb": "put", "requestPath": "/teams/{team_id}/members/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -70231,8 +70640,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/members/USERNAME", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/members/USERNAME
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/members/USERNAME", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/members/USERNAME
    " }, { "lang": "JavaScript", @@ -70266,13 +70675,11 @@ "subcategory": "members", "subcategoryLabel": "Members", "notes": [], - "bodyParameters": [], - "descriptionHTML": "

    The \"Add team member\" endpoint (described below) is deprecated.

    \n

    We recommend using the Add or update team membership for a user endpoint instead. It allows you to invite new organization members to your teams.

    \n

    Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

    \n

    To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.

    \n

    Note: When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"

    \n

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

    ", "responses": [ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -70287,21 +70694,16 @@ { "httpStatusCode": "422", "httpStatusMessage": "Unprocessable Entity", - "description": "Response if you attempt to add an organization to a team", - "payload": "
    {\n  \"message\": \"Cannot add an organization as a member.\",\n  \"errors\": [\n    {\n      \"code\": \"org\",\n      \"field\": \"user\",\n      \"resource\": \"TeamMember\"\n    }\n  ]\n}\n
    " - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Response if you attempt to add a user to a team when they are not a member of at least one other team in the same organization", - "payload": "
    {\n  \"message\": \"User isn't a member of this organization. Please invite them first.\",\n  \"errors\": [\n    {\n      \"code\": \"unaffiliated\",\n      \"field\": \"user\",\n      \"resource\": \"TeamMember\"\n    }\n  ]\n}\n
    " + "description": "Response if you attempt to add an organization to a team or you attempt to add a user to a team when they are not a member of at least one other team in the same organization" } - ] + ], + "bodyParameters": [], + "descriptionHTML": "

    The \"Add team member\" endpoint (described below) is deprecated.

    \n

    We recommend using the Add or update team membership for a user endpoint instead. It allows you to invite new organization members to your teams.

    \n

    Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

    \n

    To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.

    \n

    Note: When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"

    \n

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

    " }, { "verb": "delete", "requestPath": "/teams/{team_id}/members/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -70325,8 +70727,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/members/USERNAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/members/USERNAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/members/USERNAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/members/USERNAME
    " }, { "lang": "JavaScript", @@ -70364,7 +70766,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -70378,7 +70780,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/memberships/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -70402,8 +70804,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/memberships/USERNAME", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/memberships/USERNAME
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/memberships/USERNAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/memberships/USERNAME
    " }, { "lang": "JavaScript", @@ -70412,7 +70814,7 @@ } ], "summary": "Get team membership for a user (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 [Get team membership for a user](https://docs.github.com/enterprise-server@2.22/rest/reference/teams#get-team-membership-for-a-user) endpoint.\n\nTeam members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:** The `role` for organization owners returns as `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@2.22/rest/reference/teams#create-a-team).", + "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 [Get team membership for a user](https://docs.github.com/enterprise-server@2.22/rest/reference/teams#get-team-membership-for-a-user) endpoint.\n\nTeam members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:**\nThe response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@2.22/rest/reference/teams#create-a-team).", "tags": [ "teams" ], @@ -70438,26 +70840,14 @@ "subcategoryLabel": "Members", "notes": [], "bodyParameters": [], - "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 Get team membership for a user endpoint.

    \n

    Team members will include the members of child teams.

    \n

    To get a user's membership with a team, the team must be visible to the authenticated user.

    \n

    Note: The role for organization owners returns as maintainer. For more information about maintainer roles, see Create a team.

    ", + "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 Get team membership for a user endpoint.

    \n

    Team members will include the members of child teams.

    \n

    To get a user's membership with a team, the team must be visible to the authenticated user.

    \n

    Note:\nThe response contains the state of the membership and the member's role.

    \n

    The role for organization owners is set to maintainer. For more information about maintainer roles, see Create a team.

    ", "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response if user has an active membership with team", - "payload": "
    {\n  \"url\": \"https://api.github.com/teams/1/memberships/octocat\",\n  \"role\": \"member\",\n  \"state\": \"active\"\n}\n
    " - }, { "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Response if user is a team maintainer", "payload": "
    {\n  \"url\": \"https://api.github.com/teams/1/memberships/octocat\",\n  \"role\": \"maintainer\",\n  \"state\": \"active\"\n}\n
    " }, - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response if user has a pending membership with team", - "payload": "
    {\n  \"url\": \"https://api.github.com/teams/1/memberships/octocat\",\n  \"role\": \"member\",\n  \"state\": \"pending\"\n}\n
    " - }, { "httpStatusCode": "404", "httpStatusMessage": "Not Found", @@ -70468,7 +70858,7 @@ { "verb": "put", "requestPath": "/teams/{team_id}/memberships/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -70492,8 +70882,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/memberships/USERNAME \\\n -d '{\"role\":\"role\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/memberships/USERNAME \\\n  -d '{\"role\":\"role\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/memberships/USERNAME \\\n -d '{\"role\":\"role\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/memberships/USERNAME \\\n  -d '{\"role\":\"role\"}'
    " }, { "lang": "JavaScript", @@ -70570,12 +70960,6 @@ } ], "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response if user's membership with team is now active", - "payload": "
    {\n  \"url\": \"https://api.github.com/teams/1/memberships/octocat\",\n  \"role\": \"member\",\n  \"state\": \"active\"\n}\n
    " - }, { "httpStatusCode": "200", "httpStatusMessage": "OK", @@ -70595,15 +70979,14 @@ { "httpStatusCode": "422", "httpStatusMessage": "Unprocessable Entity", - "description": "Response if you attempt to add an organization to a team", - "payload": "
    {\n  \"message\": \"Cannot add an organization as a member.\",\n  \"errors\": [\n    {\n      \"code\": \"org\",\n      \"field\": \"user\",\n      \"resource\": \"TeamMember\"\n    }\n  ]\n}\n
    " + "description": "Response if you attempt to add an organization to a team" } ] }, { "verb": "delete", "requestPath": "/teams/{team_id}/memberships/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -70627,8 +71010,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/memberships/USERNAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/memberships/USERNAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/memberships/USERNAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/memberships/USERNAME
    " }, { "lang": "JavaScript", @@ -70666,7 +71049,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -70680,7 +71063,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/projects", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -70715,8 +71098,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/teams/42/projects", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/teams/42/projects
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/teams/42/projects", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/projects
    " }, { "lang": "JavaScript", @@ -70779,7 +71162,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/projects/{project_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -70803,8 +71186,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/teams/42/projects/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/teams/42/projects/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/teams/42/projects/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/projects/42
    " }, { "lang": "JavaScript", @@ -70867,7 +71250,7 @@ { "verb": "put", "requestPath": "/teams/{team_id}/projects/{project_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -70891,8 +71274,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/teams/42/projects/42 \\\n -d '{\"permission\":\"permission\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/teams/42/projects/42 \\\n  -d '{\"permission\":\"permission\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/teams/42/projects/42 \\\n -d '{\"permission\":\"permission\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/projects/42 \\\n  -d '{\"permission\":\"permission\"}'
    " }, { "lang": "JavaScript", @@ -70977,7 +71360,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -71005,7 +71388,7 @@ { "verb": "delete", "requestPath": "/teams/{team_id}/projects/{project_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -71029,8 +71412,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/projects/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/projects/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/projects/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/projects/42
    " }, { "lang": "JavaScript", @@ -71066,7 +71449,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -71090,7 +71473,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/repos", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -71125,8 +71508,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/repos", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/repos
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/repos", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/repos
    " }, { "lang": "JavaScript", @@ -71177,7 +71560,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/repos/{owner}/{repo}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -71210,8 +71593,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/repos/octocat/hello-world", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/repos/octocat/hello-world
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/repos/octocat/hello-world", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/repos/octocat/hello-world
    " }, { "lang": "JavaScript", @@ -71266,7 +71649,7 @@ { "verb": "put", "requestPath": "/teams/{team_id}/repos/{owner}/{repo}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -71299,8 +71682,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/repos/octocat/hello-world \\\n -d '{\"permission\":\"permission\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/repos/octocat/hello-world \\\n  -d '{\"permission\":\"permission\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/repos/octocat/hello-world \\\n -d '{\"permission\":\"permission\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/repos/octocat/hello-world \\\n  -d '{\"permission\":\"permission\"}'
    " }, { "lang": "JavaScript", @@ -71361,7 +71744,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -71395,7 +71778,7 @@ { "verb": "delete", "requestPath": "/teams/{team_id}/repos/{owner}/{repo}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -71428,8 +71811,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/repos/octocat/hello-world", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/repos/octocat/hello-world
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/repos/octocat/hello-world", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/repos/octocat/hello-world
    " }, { "lang": "JavaScript", @@ -71465,7 +71848,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -71474,7 +71857,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/teams", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -71509,8 +71892,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/teams", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/teams
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/teams", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/teams
    " }, { "lang": "JavaScript", @@ -71571,13 +71954,13 @@ { "verb": "get", "requestPath": "/user", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user
    " }, { "lang": "JavaScript", @@ -71641,13 +72024,13 @@ { "verb": "patch", "requestPath": "/user", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -71885,7 +72268,7 @@ { "verb": "get", "requestPath": "/user/emails", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -71911,8 +72294,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/emails", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/emails
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/emails", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/emails
    " }, { "lang": "JavaScript", @@ -71977,13 +72360,13 @@ { "verb": "post", "requestPath": "/user/emails", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/emails \\\n -d '{\"emails\":[\"octocat@github.com\"]}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/emails \\\n  -d '{\"emails\":[\"octocat@github.com\"]}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/emails \\\n -d '{\"emails\":[\"octocat@github.com\"]}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/emails \\\n  -d '{\"emails\":[\"octocat@github.com\"]}'
    " }, { "lang": "JavaScript", @@ -72098,13 +72481,13 @@ { "verb": "delete", "requestPath": "/user/emails", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/emails \\\n -d '{\"emails\":[\"octocat@github.com\"]}'", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/emails \\\n  -d '{\"emails\":[\"octocat@github.com\"]}'
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/emails \\\n -d '{\"emails\":[\"octocat@github.com\"]}'", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/emails \\\n  -d '{\"emails\":[\"octocat@github.com\"]}'
    " }, { "lang": "JavaScript", @@ -72184,7 +72567,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -72218,7 +72601,7 @@ { "verb": "get", "requestPath": "/user/followers", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -72244,8 +72627,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/followers", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/followers
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/followers", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/followers
    " }, { "lang": "JavaScript", @@ -72305,7 +72688,7 @@ { "verb": "get", "requestPath": "/user/following", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -72331,8 +72714,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/following", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/following
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/following", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/following
    " }, { "lang": "JavaScript", @@ -72392,7 +72775,7 @@ { "verb": "get", "requestPath": "/user/following/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -72407,8 +72790,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/following/USERNAME", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/following/USERNAME
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/following/USERNAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/following/USERNAME
    " }, { "lang": "JavaScript", @@ -72472,7 +72855,7 @@ { "verb": "put", "requestPath": "/user/following/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -72487,8 +72870,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/following/USERNAME", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/following/USERNAME
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/following/USERNAME", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/following/USERNAME
    " }, { "lang": "JavaScript", @@ -72523,7 +72906,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -72552,7 +72935,7 @@ { "verb": "delete", "requestPath": "/user/following/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -72567,8 +72950,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/following/USERNAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/following/USERNAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/following/USERNAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/following/USERNAME
    " }, { "lang": "JavaScript", @@ -72603,7 +72986,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -72632,7 +73015,7 @@ { "verb": "get", "requestPath": "/user/gpg_keys", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -72658,8 +73041,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/gpg_keys", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/gpg_keys
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/gpg_keys", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/gpg_keys
    " }, { "lang": "JavaScript", @@ -72724,13 +73107,13 @@ { "verb": "post", "requestPath": "/user/gpg_keys", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/gpg_keys \\\n -d '{\"armored_public_key\":\"armored_public_key\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/gpg_keys \\\n  -d '{\"armored_public_key\":\"armored_public_key\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/gpg_keys \\\n -d '{\"armored_public_key\":\"armored_public_key\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/gpg_keys \\\n  -d '{\"armored_public_key\":\"armored_public_key\"}'
    " }, { "lang": "JavaScript", @@ -72833,7 +73216,7 @@ { "verb": "get", "requestPath": "/user/gpg_keys/{gpg_key_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gpg_key_id", @@ -72849,8 +73232,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/gpg_keys/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/gpg_keys/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/gpg_keys/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/gpg_keys/42
    " }, { "lang": "JavaScript", @@ -72915,7 +73298,7 @@ { "verb": "delete", "requestPath": "/user/gpg_keys/{gpg_key_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gpg_key_id", @@ -72931,8 +73314,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/gpg_keys/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/gpg_keys/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/gpg_keys/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/gpg_keys/42
    " }, { "lang": "JavaScript", @@ -72967,7 +73350,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -73001,7 +73384,7 @@ { "verb": "get", "requestPath": "/user/installations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -73027,8 +73410,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/installations", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/installations
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/installations", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/installations
    " }, { "lang": "JavaScript", @@ -73093,7 +73476,7 @@ { "verb": "get", "requestPath": "/user/installations/{installation_id}/repositories", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "installation_id", @@ -73129,8 +73512,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/installations/42/repositories", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/installations/42/repositories
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/installations/42/repositories", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/installations/42/repositories
    " }, { "lang": "JavaScript", @@ -73197,7 +73580,7 @@ { "verb": "put", "requestPath": "/user/installations/{installation_id}/repositories/{repository_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "installation_id", @@ -73222,8 +73605,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/installations/42/repositories/42", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/installations/42/repositories/42
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/installations/42/repositories/42", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/installations/42/repositories/42
    " }, { "lang": "JavaScript", @@ -73258,7 +73641,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -73282,7 +73665,7 @@ { "verb": "delete", "requestPath": "/user/installations/{installation_id}/repositories/{repository_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "installation_id", @@ -73307,8 +73690,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/installations/42/repositories/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/installations/42/repositories/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/installations/42/repositories/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/installations/42/repositories/42
    " }, { "lang": "JavaScript", @@ -73343,7 +73726,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -73367,7 +73750,7 @@ { "verb": "get", "requestPath": "/user/issues", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "filter", @@ -73381,6 +73764,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -73478,8 +73862,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/issues", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/issues
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/issues", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/issues
    " }, { "lang": "JavaScript", @@ -73539,7 +73923,7 @@ { "verb": "get", "requestPath": "/user/keys", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -73565,8 +73949,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/keys", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/keys
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/keys", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/keys
    " }, { "lang": "JavaScript", @@ -73631,13 +74015,13 @@ { "verb": "post", "requestPath": "/user/keys", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/keys \\\n -d '{\"key\":\"key\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/keys \\\n  -d '{\"key\":\"key\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/keys \\\n -d '{\"key\":\"key\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/keys \\\n  -d '{\"key\":\"key\"}'
    " }, { "lang": "JavaScript", @@ -73762,7 +74146,7 @@ { "verb": "get", "requestPath": "/user/keys/{key_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "key_id", @@ -73778,8 +74162,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/keys/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/keys/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/keys/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/keys/42
    " }, { "lang": "JavaScript", @@ -73844,7 +74228,7 @@ { "verb": "delete", "requestPath": "/user/keys/{key_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "key_id", @@ -73860,8 +74244,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/keys/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/keys/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/keys/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/keys/42
    " }, { "lang": "JavaScript", @@ -73896,7 +74280,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -73925,7 +74309,7 @@ { "verb": "get", "requestPath": "/user/memberships/orgs", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "state", @@ -73965,8 +74349,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/memberships/orgs", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/memberships/orgs
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/memberships/orgs", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/memberships/orgs
    " }, { "lang": "JavaScript", @@ -74031,7 +74415,7 @@ { "verb": "get", "requestPath": "/user/memberships/orgs/{org}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -74046,8 +74430,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/memberships/orgs/ORG", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/memberships/orgs/ORG
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/memberships/orgs/ORG", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/memberships/orgs/ORG
    " }, { "lang": "JavaScript", @@ -74102,7 +74486,7 @@ { "verb": "patch", "requestPath": "/user/memberships/orgs/{org}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -74117,8 +74501,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/memberships/orgs/ORG \\\n -d '{\"state\":\"state\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/memberships/orgs/ORG \\\n  -d '{\"state\":\"state\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/memberships/orgs/ORG \\\n -d '{\"state\":\"state\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/memberships/orgs/ORG \\\n  -d '{\"state\":\"state\"}'
    " }, { "lang": "JavaScript", @@ -74220,7 +74604,7 @@ { "verb": "get", "requestPath": "/user/orgs", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -74246,8 +74630,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/orgs", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/orgs
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/orgs", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/orgs
    " }, { "lang": "JavaScript", @@ -74305,13 +74689,13 @@ { "verb": "post", "requestPath": "/user/projects", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/user/projects \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/user/projects \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/user/projects \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/user/projects \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -74443,7 +74827,7 @@ { "verb": "get", "requestPath": "/user/public_emails", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -74469,8 +74853,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/public_emails", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/public_emails
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/public_emails", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/public_emails
    " }, { "lang": "JavaScript", @@ -74535,11 +74919,11 @@ { "verb": "get", "requestPath": "/user/repos", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "visibility", - "description": "Can be one of `all`, `public`, or `private`.", + "description": "Can be one of `all`, `public`, or `private`. Note: For GitHub AE, can be one of `all`, `internal`, or `private`.", "in": "query", "required": false, "schema": { @@ -74551,7 +74935,7 @@ ], "default": "all" }, - "descriptionHTML": "

    Can be one of all, public, or private.

    " + "descriptionHTML": "

    Can be one of all, public, or private. Note: For GitHub AE, can be one of all, internal, or private.

    " }, { "name": "affiliation", @@ -74566,7 +74950,7 @@ }, { "name": "type", - "description": "Can be one of `all`, `owner`, `public`, `private`, `member`. Default: `all` \n \nWill cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.", + "description": "Can be one of `all`, `owner`, `public`, `private`, `member`. Note: For GitHub AE, can be one of `all`, `owner`, `internal`, `private`, `member`. Default: `all` \n \nWill cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.", "in": "query", "required": false, "schema": { @@ -74580,7 +74964,7 @@ ], "default": "all" }, - "descriptionHTML": "

    Can be one of all, owner, public, private, member. Default: all

    \n

    Will cause a 422 error if used in the same request as visibility or affiliation. Will cause a 422 error if used in the same request as visibility or affiliation.

    " + "descriptionHTML": "

    Can be one of all, owner, public, private, member. Note: For GitHub AE, can be one of all, owner, internal, private, member. Default: all

    \n

    Will cause a 422 error if used in the same request as visibility or affiliation. Will cause a 422 error if used in the same request as visibility or affiliation.

    " }, { "name": "sort", @@ -74657,8 +75041,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/repos", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/repos
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/repos", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/repos
    " }, { "lang": "JavaScript", @@ -74721,13 +75105,13 @@ { "verb": "post", "requestPath": "/user/repos", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/repos \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/repos \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/repos \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/repos \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -74736,7 +75120,7 @@ } ], "summary": "Create a repository for the authenticated user", - "description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", + "description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository.", "tags": [ "repos" ], @@ -74779,13 +75163,13 @@ "childParamsGroups": [] }, "private": { - "description": "

    Whether the repository is private or public.

    ", + "description": "

    Whether the repository is private.

    ", "default": false, "type": "boolean", "name": "private", "in": "body", "rawType": "boolean", - "rawDescription": "Whether the repository is private or public.", + "rawDescription": "Whether the repository is private.", "childParamsGroups": [] }, "has_issues": { @@ -74959,7 +75343,7 @@ "category": "repos", "categoryLabel": "Repos", "notes": [], - "descriptionHTML": "

    Creates a new repository for the authenticated user.

    \n

    OAuth scope requirements

    \n

    When using OAuth, authorizations must include:

    \n
      \n
    • public_repo scope or repo scope to create a public repository
    • \n
    • repo scope to create a private repository
    • \n
    ", + "descriptionHTML": "

    Creates a new repository for the authenticated user.

    \n

    OAuth scope requirements

    \n

    When using OAuth, authorizations must include:

    \n
      \n
    • public_repo scope or repo scope to create a public repository. Note: For GitHub AE, use repo scope to create an internal repository.
    • \n
    • repo scope to create a private repository.
    • \n
    ", "bodyParameters": [ { "description": "

    Required. The name of the repository.

    ", @@ -74990,13 +75374,13 @@ "childParamsGroups": [] }, { - "description": "

    Whether the repository is private or public.

    ", + "description": "

    Whether the repository is private.

    ", "default": false, "type": "boolean", "name": "private", "in": "body", "rawType": "boolean", - "rawDescription": "Whether the repository is private or public.", + "rawDescription": "Whether the repository is private.", "childParamsGroups": [] }, { @@ -75180,7 +75564,7 @@ { "verb": "get", "requestPath": "/user/repository_invitations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -75206,8 +75590,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/repository_invitations", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/repository_invitations
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/repository_invitations", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/repository_invitations
    " }, { "lang": "JavaScript", @@ -75272,7 +75656,7 @@ { "verb": "patch", "requestPath": "/user/repository_invitations/{invitation_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "invitation_id", @@ -75288,8 +75672,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/repository_invitations/42", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/repository_invitations/42
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/repository_invitations/42", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/repository_invitations/42
    " }, { "lang": "JavaScript", @@ -75324,7 +75708,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -75353,7 +75737,7 @@ { "verb": "delete", "requestPath": "/user/repository_invitations/{invitation_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "invitation_id", @@ -75369,8 +75753,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/repository_invitations/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/repository_invitations/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/repository_invitations/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/repository_invitations/42
    " }, { "lang": "JavaScript", @@ -75405,7 +75789,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -75434,7 +75818,7 @@ { "verb": "get", "requestPath": "/user/starred", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "sort", @@ -75490,8 +75874,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/starred", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/starred
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/starred", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/starred
    " }, { "lang": "JavaScript", @@ -75551,7 +75935,7 @@ { "verb": "get", "requestPath": "/user/starred/{owner}/{repo}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -75575,8 +75959,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/starred/octocat/hello-world", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/starred/octocat/hello-world
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/starred/octocat/hello-world", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/starred/octocat/hello-world
    " }, { "lang": "JavaScript", @@ -75640,7 +76024,7 @@ { "verb": "put", "requestPath": "/user/starred/{owner}/{repo}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -75664,8 +76048,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/starred/octocat/hello-world", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/starred/octocat/hello-world
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/starred/octocat/hello-world", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/starred/octocat/hello-world
    " }, { "lang": "JavaScript", @@ -75700,7 +76084,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -75729,7 +76113,7 @@ { "verb": "delete", "requestPath": "/user/starred/{owner}/{repo}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -75753,8 +76137,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/starred/octocat/hello-world", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/starred/octocat/hello-world
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/starred/octocat/hello-world", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/starred/octocat/hello-world
    " }, { "lang": "JavaScript", @@ -75789,7 +76173,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -75818,7 +76202,7 @@ { "verb": "get", "requestPath": "/user/subscriptions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -75844,8 +76228,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/subscriptions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/subscriptions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/subscriptions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/subscriptions
    " }, { "lang": "JavaScript", @@ -75905,7 +76289,7 @@ { "verb": "get", "requestPath": "/user/teams", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -75931,8 +76315,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/teams", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/teams
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/teams", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/teams
    " }, { "lang": "JavaScript", @@ -75990,7 +76374,7 @@ { "verb": "get", "requestPath": "/users", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "since", @@ -76016,8 +76400,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users
    " }, { "lang": "JavaScript", @@ -76065,7 +76449,7 @@ { "verb": "get", "requestPath": "/users/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -76080,8 +76464,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME
    " }, { "lang": "JavaScript", @@ -76135,7 +76519,7 @@ { "verb": "get", "requestPath": "/users/{username}/events", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -76170,8 +76554,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/events", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/events
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/events", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/events
    " }, { "lang": "JavaScript", @@ -76215,7 +76599,7 @@ { "verb": "get", "requestPath": "/users/{username}/events/orgs/{org}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -76259,8 +76643,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/events/orgs/ORG", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/events/orgs/ORG
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/events/orgs/ORG", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/events/orgs/ORG
    " }, { "lang": "JavaScript", @@ -76304,7 +76688,7 @@ { "verb": "get", "requestPath": "/users/{username}/events/public", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -76339,8 +76723,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/events/public", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/events/public
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/events/public", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/events/public
    " }, { "lang": "JavaScript", @@ -76384,7 +76768,7 @@ { "verb": "get", "requestPath": "/users/{username}/followers", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -76419,8 +76803,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/followers", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/followers
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/followers", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/followers
    " }, { "lang": "JavaScript", @@ -76465,7 +76849,7 @@ { "verb": "get", "requestPath": "/users/{username}/following", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -76500,8 +76884,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/following", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/following
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/following", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/following
    " }, { "lang": "JavaScript", @@ -76546,7 +76930,7 @@ { "verb": "get", "requestPath": "/users/{username}/following/{target_user}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -76570,8 +76954,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/following/TARGET_USER", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/following/TARGET_USER
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/following/TARGET_USER", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/following/TARGET_USER
    " }, { "lang": "JavaScript", @@ -76620,7 +77004,7 @@ { "verb": "get", "requestPath": "/users/{username}/gists", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -76665,8 +77049,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/gists", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/gists
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/gists", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/gists
    " }, { "lang": "JavaScript", @@ -76714,7 +77098,7 @@ { "verb": "get", "requestPath": "/users/{username}/gpg_keys", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -76749,8 +77133,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/gpg_keys", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/gpg_keys
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/gpg_keys", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/gpg_keys
    " }, { "lang": "JavaScript", @@ -76795,7 +77179,7 @@ { "verb": "get", "requestPath": "/users/{username}/hovercard", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -76836,8 +77220,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/hovercard", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/hovercard
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/hovercard", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/hovercard
    " }, { "lang": "JavaScript", @@ -76890,7 +77274,7 @@ { "verb": "get", "requestPath": "/users/{username}/installation", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -76905,8 +77289,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/installation", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/installation
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/installation", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/installation
    " }, { "lang": "JavaScript", @@ -76949,7 +77333,7 @@ { "verb": "get", "requestPath": "/users/{username}/keys", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -76984,8 +77368,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/keys", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/keys
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/keys", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/keys
    " }, { "lang": "JavaScript", @@ -77030,7 +77414,7 @@ { "verb": "get", "requestPath": "/users/{username}/orgs", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -77065,8 +77449,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/orgs", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/orgs
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/orgs", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/orgs
    " }, { "lang": "JavaScript", @@ -77109,7 +77493,7 @@ { "verb": "get", "requestPath": "/users/{username}/projects", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -77160,8 +77544,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/users/USERNAME/projects", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/users/USERNAME/projects
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/projects", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/projects
    " }, { "lang": "JavaScript", @@ -77221,7 +77605,7 @@ { "verb": "get", "requestPath": "/users/{username}/received_events", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -77256,8 +77640,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/received_events", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/received_events
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/received_events", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/received_events
    " }, { "lang": "JavaScript", @@ -77301,7 +77685,7 @@ { "verb": "get", "requestPath": "/users/{username}/received_events/public", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -77336,8 +77720,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/received_events/public", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/received_events/public
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/received_events/public", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/received_events/public
    " }, { "lang": "JavaScript", @@ -77381,7 +77765,7 @@ { "verb": "get", "requestPath": "/users/{username}/repos", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -77463,8 +77847,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/repos", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/repos
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/repos", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/repos
    " }, { "lang": "JavaScript", @@ -77473,7 +77857,7 @@ } ], "summary": "List repositories for a user", - "description": "Lists public repositories for the specified user.", + "description": "Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user.", "tags": [ "repos" ], @@ -77501,7 +77885,7 @@ "categoryLabel": "Repos", "notes": [], "bodyParameters": [], - "descriptionHTML": "

    Lists public repositories for the specified user.

    ", + "descriptionHTML": "

    Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user.

    ", "responses": [ { "httpStatusCode": "200", @@ -77514,7 +77898,7 @@ { "verb": "put", "requestPath": "/users/{username}/site_admin", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -77529,8 +77913,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/site_admin", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/site_admin
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/site_admin", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/site_admin
    " }, { "lang": "JavaScript", @@ -77565,7 +77949,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -77574,7 +77958,7 @@ { "verb": "delete", "requestPath": "/users/{username}/site_admin", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -77589,8 +77973,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/site_admin", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/site_admin
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/site_admin", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/site_admin
    " }, { "lang": "JavaScript", @@ -77625,7 +78009,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -77634,7 +78018,7 @@ { "verb": "get", "requestPath": "/users/{username}/starred", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -77699,8 +78083,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/starred", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/starred
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/starred", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/starred
    " }, { "lang": "JavaScript", @@ -77745,7 +78129,7 @@ { "verb": "get", "requestPath": "/users/{username}/subscriptions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -77780,8 +78164,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/subscriptions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/subscriptions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/subscriptions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/subscriptions
    " }, { "lang": "JavaScript", @@ -77826,7 +78210,7 @@ { "verb": "put", "requestPath": "/users/{username}/suspended", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -77841,8 +78225,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/suspended \\\n -d '{\"reason\":\"reason\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/suspended \\\n  -d '{\"reason\":\"reason\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/suspended \\\n -d '{\"reason\":\"reason\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/suspended \\\n  -d '{\"reason\":\"reason\"}'
    " }, { "lang": "JavaScript", @@ -77897,7 +78281,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "descriptionHTML": "

    If your GitHub instance uses LDAP Sync with Active Directory LDAP servers, Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a 403 response.

    \n

    You can suspend any user account except your own.

    \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.\"

    ", @@ -77916,7 +78300,7 @@ { "verb": "delete", "requestPath": "/users/{username}/suspended", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -77931,8 +78315,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/suspended \\\n -d '{\"reason\":\"reason\"}'", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/suspended \\\n  -d '{\"reason\":\"reason\"}'
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/suspended \\\n -d '{\"reason\":\"reason\"}'", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/suspended \\\n  -d '{\"reason\":\"reason\"}'
    " }, { "lang": "JavaScript", @@ -77987,7 +78371,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "descriptionHTML": "

    If your GitHub instance uses LDAP Sync with Active Directory LDAP servers, this API is disabled and will return a 403 response. Active Directory LDAP-authenticated users cannot be unsuspended using the API.

    ", @@ -78006,13 +78390,13 @@ { "verb": "get", "requestPath": "/zen", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/zen", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/zen
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/zen", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/zen
    " }, { "lang": "JavaScript", diff --git a/lib/rest/static/decorated/ghes-3.0.json b/lib/rest/static/decorated/ghes-3.0.json index 6d098ff7be..2a7eb79759 100644 --- a/lib/rest/static/decorated/ghes-3.0.json +++ b/lib/rest/static/decorated/ghes-3.0.json @@ -2,13 +2,13 @@ { "verb": "get", "requestPath": "/", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/
    " }, { "lang": "JavaScript", @@ -45,7 +45,7 @@ { "verb": "get", "requestPath": "/admin/hooks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -82,8 +82,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n https://api.github.com/admin/hooks", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  https://api.github.com/admin/hooks
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/hooks", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/hooks
    " }, { "lang": "JavaScript", @@ -135,7 +135,7 @@ { "verb": "post", "requestPath": "/admin/hooks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -152,8 +152,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n https://api.github.com/admin/hooks \\\n -d '{\"name\":\"name\",\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  https://api.github.com/admin/hooks \\\n  -d '{\"name\":\"name\",\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/hooks \\\n -d '{\"name\":\"name\",\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/hooks \\\n  -d '{\"name\":\"name\",\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'
    " }, { "lang": "JavaScript", @@ -483,7 +483,7 @@ { "verb": "get", "requestPath": "/admin/hooks/{hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -509,8 +509,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n https://api.github.com/admin/hooks/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  https://api.github.com/admin/hooks/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/hooks/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/hooks/42
    " }, { "lang": "JavaScript", @@ -562,7 +562,7 @@ { "verb": "patch", "requestPath": "/admin/hooks/{hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -588,8 +588,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n https://api.github.com/admin/hooks/42 \\\n -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  https://api.github.com/admin/hooks/42 \\\n  -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/hooks/42 \\\n -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/hooks/42 \\\n  -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'
    " }, { "lang": "JavaScript", @@ -893,7 +893,7 @@ { "verb": "delete", "requestPath": "/admin/hooks/{hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -919,8 +919,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n https://api.github.com/admin/hooks/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  https://api.github.com/admin/hooks/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/hooks/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/hooks/42
    " }, { "lang": "JavaScript", @@ -962,7 +962,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -971,7 +971,7 @@ { "verb": "post", "requestPath": "/admin/hooks/{hook_id}/pings", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "accept", @@ -997,8 +997,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n https://api.github.com/admin/hooks/42/pings", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  https://api.github.com/admin/hooks/42/pings
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/hooks/42/pings", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/hooks/42/pings
    " }, { "lang": "JavaScript", @@ -1040,7 +1040,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -1049,7 +1049,7 @@ { "verb": "get", "requestPath": "/admin/keys", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -1070,13 +1070,53 @@ "default": 1 }, "descriptionHTML": "

    Page number of the results to fetch.

    " + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + }, + "descriptionHTML": "

    One of asc (ascending) or desc (descending).

    " + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "accessed" + ], + "default": "created" + }, + "descriptionHTML": "" + }, + { + "name": "since", + "description": "Only show public keys accessed after the given time.", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    Only show public keys accessed after the given time.

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/keys", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/keys
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/keys", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/keys
    " }, { "lang": "JavaScript", @@ -1121,7 +1161,7 @@ { "verb": "delete", "requestPath": "/admin/keys/{key_ids}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "key_ids", @@ -1136,8 +1176,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/keys/KEY_IDS", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/keys/KEY_IDS
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/keys/KEY_IDS", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/keys/KEY_IDS
    " }, { "lang": "JavaScript", @@ -1172,7 +1212,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -1181,7 +1221,7 @@ { "verb": "patch", "requestPath": "/admin/ldap/teams/{team_id}/mapping", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -1196,8 +1236,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/ldap/teams/42/mapping \\\n -d '{\"ldap_dn\":\"ldap_dn\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/ldap/teams/42/mapping \\\n  -d '{\"ldap_dn\":\"ldap_dn\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/ldap/teams/42/mapping \\\n -d '{\"ldap_dn\":\"ldap_dn\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/ldap/teams/42/mapping \\\n  -d '{\"ldap_dn\":\"ldap_dn\"}'
    " }, { "lang": "JavaScript", @@ -1282,7 +1322,7 @@ { "verb": "post", "requestPath": "/admin/ldap/teams/{team_id}/sync", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -1297,8 +1337,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/ldap/teams/42/sync", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/ldap/teams/42/sync
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/ldap/teams/42/sync", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/ldap/teams/42/sync
    " }, { "lang": "JavaScript", @@ -1343,7 +1383,7 @@ { "verb": "patch", "requestPath": "/admin/ldap/users/{username}/mapping", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -1358,8 +1398,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/ldap/users/USERNAME/mapping \\\n -d '{\"ldap_dn\":\"ldap_dn\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/ldap/users/USERNAME/mapping \\\n  -d '{\"ldap_dn\":\"ldap_dn\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/ldap/users/USERNAME/mapping \\\n -d '{\"ldap_dn\":\"ldap_dn\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/ldap/users/USERNAME/mapping \\\n  -d '{\"ldap_dn\":\"ldap_dn\"}'
    " }, { "lang": "JavaScript", @@ -1437,7 +1477,7 @@ { "verb": "post", "requestPath": "/admin/ldap/users/{username}/sync", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -1452,8 +1492,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/ldap/users/USERNAME/sync", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/ldap/users/USERNAME/sync
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/ldap/users/USERNAME/sync", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/ldap/users/USERNAME/sync
    " }, { "lang": "JavaScript", @@ -1498,13 +1538,13 @@ { "verb": "post", "requestPath": "/admin/organizations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/organizations \\\n -d '{\"login\":\"login\",\"admin\":\"admin\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/organizations \\\n  -d '{\"login\":\"login\",\"admin\":\"admin\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/organizations \\\n -d '{\"login\":\"login\",\"admin\":\"admin\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/organizations \\\n  -d '{\"login\":\"login\",\"admin\":\"admin\"}'
    " }, { "lang": "JavaScript", @@ -1624,7 +1664,7 @@ { "verb": "patch", "requestPath": "/admin/organizations/{org}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -1639,8 +1679,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/organizations/ORG \\\n -d '{\"login\":\"login\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/organizations/ORG \\\n  -d '{\"login\":\"login\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/organizations/ORG \\\n -d '{\"login\":\"login\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/organizations/ORG \\\n  -d '{\"login\":\"login\"}'
    " }, { "lang": "JavaScript", @@ -1721,7 +1761,7 @@ { "verb": "get", "requestPath": "/admin/pre-receive-environments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -1742,13 +1782,43 @@ "default": 1 }, "descriptionHTML": "

    Page number of the results to fetch.

    " + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + }, + "descriptionHTML": "

    One of asc (ascending) or desc (descending).

    " + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + }, + "descriptionHTML": "" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-environments", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/admin/pre-receive-environments
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/pre-receive-environments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/pre-receive-environments
    " }, { "lang": "JavaScript", @@ -1800,13 +1870,13 @@ { "verb": "post", "requestPath": "/admin/pre-receive-environments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-environments \\\n -d '{\"name\":\"name\",\"image_url\":\"image_url\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/admin/pre-receive-environments \\\n  -d '{\"name\":\"name\",\"image_url\":\"image_url\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/pre-receive-environments \\\n -d '{\"name\":\"name\",\"image_url\":\"image_url\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/pre-receive-environments \\\n  -d '{\"name\":\"name\",\"image_url\":\"image_url\"}'
    " }, { "lang": "JavaScript", @@ -1914,7 +1984,7 @@ { "verb": "get", "requestPath": "/admin/pre-receive-environments/{pre_receive_environment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "pre_receive_environment_id", @@ -1929,8 +1999,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-environments/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/admin/pre-receive-environments/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/pre-receive-environments/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/pre-receive-environments/42
    " }, { "lang": "JavaScript", @@ -1982,7 +2052,7 @@ { "verb": "patch", "requestPath": "/admin/pre-receive-environments/{pre_receive_environment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "pre_receive_environment_id", @@ -1997,8 +2067,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-environments/42 \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/admin/pre-receive-environments/42 \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/pre-receive-environments/42 \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/pre-receive-environments/42 \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -2104,7 +2174,7 @@ { "verb": "delete", "requestPath": "/admin/pre-receive-environments/{pre_receive_environment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "pre_receive_environment_id", @@ -2119,8 +2189,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-environments/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/admin/pre-receive-environments/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/pre-receive-environments/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/pre-receive-environments/42
    " }, { "lang": "JavaScript", @@ -2164,7 +2234,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "422", @@ -2177,7 +2247,7 @@ { "verb": "post", "requestPath": "/admin/pre-receive-environments/{pre_receive_environment_id}/downloads", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "pre_receive_environment_id", @@ -2192,8 +2262,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-environments/42/downloads", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/admin/pre-receive-environments/42/downloads
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/pre-receive-environments/42/downloads", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/pre-receive-environments/42/downloads
    " }, { "lang": "JavaScript", @@ -2251,7 +2321,7 @@ { "verb": "get", "requestPath": "/admin/pre-receive-environments/{pre_receive_environment_id}/downloads/latest", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "pre_receive_environment_id", @@ -2266,8 +2336,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-environments/42/downloads/latest", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/admin/pre-receive-environments/42/downloads/latest
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/pre-receive-environments/42/downloads/latest", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/pre-receive-environments/42/downloads/latest
    " }, { "lang": "JavaScript", @@ -2319,7 +2389,7 @@ { "verb": "get", "requestPath": "/admin/pre-receive-hooks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -2340,13 +2410,44 @@ "default": 1 }, "descriptionHTML": "

    Page number of the results to fetch.

    " + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + }, + "descriptionHTML": "

    One of asc (ascending) or desc (descending).

    " + }, + { + "name": "sort", + "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to) or `name`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + }, + "descriptionHTML": "

    One of created (when the repository was starred) or updated (when it was last pushed to) or name.

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-hooks", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/admin/pre-receive-hooks
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/pre-receive-hooks", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/pre-receive-hooks
    " }, { "lang": "JavaScript", @@ -2398,13 +2499,13 @@ { "verb": "post", "requestPath": "/admin/pre-receive-hooks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-hooks \\\n -d '{\"name\":\"name\",\"script\":\"script\",\"script_repository\":{},\"environment\":{}}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/admin/pre-receive-hooks \\\n  -d '{\"name\":\"name\",\"script\":\"script\",\"script_repository\":{},\"environment\":{}}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/pre-receive-hooks \\\n -d '{\"name\":\"name\",\"script\":\"script\",\"script_repository\":{},\"environment\":{}}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/pre-receive-hooks \\\n  -d '{\"name\":\"name\",\"script\":\"script\",\"script_repository\":{},\"environment\":{}}'
    " }, { "lang": "JavaScript", @@ -2602,7 +2703,7 @@ { "verb": "get", "requestPath": "/admin/pre-receive-hooks/{pre_receive_hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "pre_receive_hook_id", @@ -2617,8 +2718,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-hooks/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/admin/pre-receive-hooks/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/pre-receive-hooks/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/pre-receive-hooks/42
    " }, { "lang": "JavaScript", @@ -2670,7 +2771,7 @@ { "verb": "patch", "requestPath": "/admin/pre-receive-hooks/{pre_receive_hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "pre_receive_hook_id", @@ -2685,8 +2786,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-hooks/42 \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/admin/pre-receive-hooks/42 \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/pre-receive-hooks/42 \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/pre-receive-hooks/42 \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -2873,7 +2974,7 @@ { "verb": "delete", "requestPath": "/admin/pre-receive-hooks/{pre_receive_hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "pre_receive_hook_id", @@ -2888,8 +2989,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-hooks/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/admin/pre-receive-hooks/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/admin/pre-receive-hooks/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/admin/pre-receive-hooks/42
    " }, { "lang": "JavaScript", @@ -2931,7 +3032,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -2940,7 +3041,7 @@ { "verb": "get", "requestPath": "/admin/tokens", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -2966,8 +3067,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/tokens", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/tokens
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/tokens", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/tokens
    " }, { "lang": "JavaScript", @@ -3012,7 +3113,7 @@ { "verb": "delete", "requestPath": "/admin/tokens/{token_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "token_id", @@ -3027,8 +3128,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/tokens/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/tokens/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/tokens/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/tokens/42
    " }, { "lang": "JavaScript", @@ -3063,7 +3164,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -3072,13 +3173,13 @@ { "verb": "post", "requestPath": "/admin/users", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/users \\\n -d '{\"login\":\"login\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/users \\\n  -d '{\"login\":\"login\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/users \\\n -d '{\"login\":\"login\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/users \\\n  -d '{\"login\":\"login\"}'
    " }, { "lang": "JavaScript", @@ -3178,7 +3279,7 @@ { "verb": "patch", "requestPath": "/admin/users/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -3193,8 +3294,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/users/USERNAME \\\n -d '{\"login\":\"login\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/users/USERNAME \\\n  -d '{\"login\":\"login\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/users/USERNAME \\\n -d '{\"login\":\"login\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/users/USERNAME \\\n  -d '{\"login\":\"login\"}'
    " }, { "lang": "JavaScript", @@ -3275,7 +3376,7 @@ { "verb": "delete", "requestPath": "/admin/users/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -3290,8 +3391,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/users/USERNAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/users/USERNAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/users/USERNAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/users/USERNAME
    " }, { "lang": "JavaScript", @@ -3326,7 +3427,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -3335,7 +3436,7 @@ { "verb": "post", "requestPath": "/admin/users/{username}/authorizations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -3350,8 +3451,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/users/USERNAME/authorizations \\\n -d '{\"scopes\":[\"scopes\"]}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/users/USERNAME/authorizations \\\n  -d '{\"scopes\":[\"scopes\"]}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/users/USERNAME/authorizations \\\n -d '{\"scopes\":[\"scopes\"]}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/users/USERNAME/authorizations \\\n  -d '{\"scopes\":[\"scopes\"]}'
    " }, { "lang": "JavaScript", @@ -3432,7 +3533,7 @@ { "verb": "delete", "requestPath": "/admin/users/{username}/authorizations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -3447,8 +3548,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/users/USERNAME/authorizations", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/users/USERNAME/authorizations
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/admin/users/USERNAME/authorizations", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/admin/users/USERNAME/authorizations
    " }, { "lang": "JavaScript", @@ -3483,7 +3584,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -3492,13 +3593,13 @@ { "verb": "get", "requestPath": "/app", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/app", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/app
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/app", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/app
    " }, { "lang": "JavaScript", @@ -3541,7 +3642,7 @@ { "verb": "post", "requestPath": "/app-manifests/{code}/conversions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "code", @@ -3556,8 +3657,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/app-manifests/CODE/conversions", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/app-manifests/CODE/conversions
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/app-manifests/CODE/conversions", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/app-manifests/CODE/conversions
    " }, { "lang": "JavaScript", @@ -3610,13 +3711,13 @@ { "verb": "get", "requestPath": "/app/hook/config", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/app/hook/config", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/app/hook/config
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/app/hook/config", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/app/hook/config
    " }, { "lang": "JavaScript", @@ -3661,13 +3762,13 @@ { "verb": "patch", "requestPath": "/app/hook/config", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/app/hook/config \\\n -d '{\"url\":\"url\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/app/hook/config \\\n  -d '{\"url\":\"url\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/app/hook/config \\\n -d '{\"url\":\"url\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/app/hook/config \\\n  -d '{\"url\":\"url\"}'
    " }, { "lang": "JavaScript", @@ -3812,7 +3913,7 @@ { "verb": "get", "requestPath": "/app/installations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -3857,8 +3958,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/app/installations", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/app/installations
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/app/installations", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/app/installations
    " }, { "lang": "JavaScript", @@ -3901,7 +4002,7 @@ { "verb": "get", "requestPath": "/app/installations/{installation_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "installation_id", @@ -3917,8 +4018,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/app/installations/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/app/installations/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/app/installations/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/app/installations/42
    " }, { "lang": "JavaScript", @@ -3971,7 +4072,7 @@ { "verb": "delete", "requestPath": "/app/installations/{installation_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "installation_id", @@ -3987,8 +4088,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/app/installations/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/app/installations/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/app/installations/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/app/installations/42
    " }, { "lang": "JavaScript", @@ -4021,7 +4122,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -4035,7 +4136,7 @@ { "verb": "post", "requestPath": "/app/installations/{installation_id}/access_tokens", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "installation_id", @@ -4051,8 +4152,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/app/installations/42/access_tokens \\\n -d '{\"repositories\":[\"repositories\"]}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/app/installations/42/access_tokens \\\n  -d '{\"repositories\":[\"repositories\"]}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/app/installations/42/access_tokens \\\n -d '{\"repositories\":[\"repositories\"]}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/app/installations/42/access_tokens \\\n  -d '{\"repositories\":[\"repositories\"]}'
    " }, { "lang": "JavaScript", @@ -5796,7 +5897,7 @@ { "verb": "put", "requestPath": "/app/installations/{installation_id}/suspended", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "installation_id", @@ -5812,8 +5913,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/app/installations/42/suspended", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/app/installations/42/suspended
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/app/installations/42/suspended", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/app/installations/42/suspended
    " }, { "lang": "JavaScript", @@ -5846,7 +5947,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -5860,7 +5961,7 @@ { "verb": "delete", "requestPath": "/app/installations/{installation_id}/suspended", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "installation_id", @@ -5876,8 +5977,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/app/installations/42/suspended", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/app/installations/42/suspended
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/app/installations/42/suspended", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/app/installations/42/suspended
    " }, { "lang": "JavaScript", @@ -5910,7 +6011,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -5924,7 +6025,7 @@ { "verb": "get", "requestPath": "/applications/grants", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -5945,13 +6046,23 @@ "default": 1 }, "descriptionHTML": "

    Page number of the results to fetch.

    " + }, + { + "name": "client_id", + "in": "query", + "required": false, + "description": "The client ID of your GitHub app.", + "schema": { + "type": "string" + }, + "descriptionHTML": "

    The client ID of your GitHub app.

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/grants", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/applications/grants
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/applications/grants", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/applications/grants
    " }, { "lang": "JavaScript", @@ -6017,7 +6128,7 @@ { "verb": "get", "requestPath": "/applications/grants/{grant_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "grant_id", @@ -6033,8 +6144,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/grants/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/applications/grants/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/applications/grants/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/applications/grants/42
    " }, { "lang": "JavaScript", @@ -6095,7 +6206,7 @@ { "verb": "delete", "requestPath": "/applications/grants/{grant_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "grant_id", @@ -6111,8 +6222,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/grants/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/applications/grants/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/applications/grants/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/applications/grants/42
    " }, { "lang": "JavaScript", @@ -6148,7 +6259,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -6172,7 +6283,7 @@ { "verb": "delete", "requestPath": "/applications/{client_id}/grant", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "client_id", @@ -6188,8 +6299,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/CLIENT_ID/grant \\\n -d '{\"access_token\":\"access_token\"}'", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/applications/CLIENT_ID/grant \\\n  -d '{\"access_token\":\"access_token\"}'
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/applications/CLIENT_ID/grant \\\n -d '{\"access_token\":\"access_token\"}'", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/applications/CLIENT_ID/grant \\\n  -d '{\"access_token\":\"access_token\"}'
    " }, { "lang": "JavaScript", @@ -6247,7 +6358,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "422", @@ -6271,7 +6382,7 @@ { "verb": "delete", "requestPath": "/applications/{client_id}/grants/{access_token}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "client_id", @@ -6296,8 +6407,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/CLIENT_ID/grants/ACCESS_TOKEN", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/applications/CLIENT_ID/grants/ACCESS_TOKEN
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/applications/CLIENT_ID/grants/ACCESS_TOKEN", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/applications/CLIENT_ID/grants/ACCESS_TOKEN
    " }, { "lang": "JavaScript", @@ -6335,7 +6446,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -6344,7 +6455,7 @@ { "verb": "post", "requestPath": "/applications/{client_id}/token", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "client_id", @@ -6360,8 +6471,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/CLIENT_ID/token \\\n -d '{\"access_token\":\"access_token\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/applications/CLIENT_ID/token \\\n  -d '{\"access_token\":\"access_token\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/applications/CLIENT_ID/token \\\n -d '{\"access_token\":\"access_token\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/applications/CLIENT_ID/token \\\n  -d '{\"access_token\":\"access_token\"}'
    " }, { "lang": "JavaScript", @@ -6449,7 +6560,7 @@ { "verb": "patch", "requestPath": "/applications/{client_id}/token", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "client_id", @@ -6465,8 +6576,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/CLIENT_ID/token \\\n -d '{\"access_token\":\"access_token\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/applications/CLIENT_ID/token \\\n  -d '{\"access_token\":\"access_token\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/applications/CLIENT_ID/token \\\n -d '{\"access_token\":\"access_token\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/applications/CLIENT_ID/token \\\n  -d '{\"access_token\":\"access_token\"}'
    " }, { "lang": "JavaScript", @@ -6549,7 +6660,7 @@ { "verb": "delete", "requestPath": "/applications/{client_id}/token", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "client_id", @@ -6565,8 +6676,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/CLIENT_ID/token \\\n -d '{\"access_token\":\"access_token\"}'", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/applications/CLIENT_ID/token \\\n  -d '{\"access_token\":\"access_token\"}'
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/applications/CLIENT_ID/token \\\n -d '{\"access_token\":\"access_token\"}'", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/applications/CLIENT_ID/token \\\n  -d '{\"access_token\":\"access_token\"}'
    " }, { "lang": "JavaScript", @@ -6592,14 +6703,17 @@ "properties": { "access_token": { "type": "string", - "description": "

    The OAuth access token used to authenticate to the GitHub API.

    ", + "description": "

    Required. The OAuth access token used to authenticate to the GitHub API.

    ", "name": "access_token", "in": "body", "rawType": "string", "rawDescription": "The OAuth access token used to authenticate to the GitHub API.", "childParamsGroups": [] } - } + }, + "required": [ + "access_token" + ] }, "example": { "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a" @@ -6624,7 +6738,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "422", @@ -6636,7 +6750,7 @@ "bodyParameters": [ { "type": "string", - "description": "

    The OAuth access token used to authenticate to the GitHub API.

    ", + "description": "

    Required. The OAuth access token used to authenticate to the GitHub API.

    ", "name": "access_token", "in": "body", "rawType": "string", @@ -6648,7 +6762,7 @@ { "verb": "post", "requestPath": "/applications/{client_id}/token/scoped", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "client_id", @@ -6664,8 +6778,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/CLIENT_ID/token/scoped \\\n -d '{\"access_token\":\"access_token\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/applications/CLIENT_ID/token/scoped \\\n  -d '{\"access_token\":\"access_token\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/applications/CLIENT_ID/token/scoped \\\n -d '{\"access_token\":\"access_token\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/applications/CLIENT_ID/token/scoped \\\n  -d '{\"access_token\":\"access_token\"}'
    " }, { "lang": "JavaScript", @@ -6691,7 +6805,7 @@ "properties": { "access_token": { "type": "string", - "description": "

    Required. The OAuth access token used to authenticate to the GitHub API.

    ", + "description": "

    Required. Required. The OAuth access token used to authenticate to the GitHub API.

    ", "example": "e72e16c7e42f292c6912e7710c838347ae178b4a", "name": "access_token", "in": "body", @@ -6720,7 +6834,7 @@ "childParamsGroups": [] }, "repositories": { - "description": "

    The list of repository IDs to scope the user-to-server access token to. repositories may not be specified if repository_ids is specified.

    ", + "description": "

    The list of repository names to scope the user-to-server access token to. repositories may not be specified if repository_ids is specified.

    ", "type": "array of strings", "items": { "type": "string", @@ -6729,11 +6843,11 @@ "name": "repositories", "in": "body", "rawType": "array", - "rawDescription": "The list of repository IDs to scope the user-to-server access token to. `repositories` may not be specified if `repository_ids` is specified.", + "rawDescription": "The list of repository names to scope the user-to-server access token to. `repositories` may not be specified if `repository_ids` is specified.", "childParamsGroups": [] }, "repository_ids": { - "description": "

    The list of repository names to scope the user-to-server access token to. repository_ids may not be specified if repositories is specified.

    ", + "description": "

    The list of repository IDs to scope the user-to-server access token to. repository_ids may not be specified if repositories is specified.

    ", "example": [ 1 ], @@ -6744,7 +6858,7 @@ "name": "repository_ids", "in": "body", "rawType": "array", - "rawDescription": "The list of repository names to scope the user-to-server access token to. `repository_ids` may not be specified if `repositories` is specified.", + "rawDescription": "The list of repository IDs to scope the user-to-server access token to. `repository_ids` may not be specified if `repositories` is specified.", "childParamsGroups": [] }, "permissions": { @@ -7551,7 +7665,10 @@ } ] } - } + }, + "required": [ + "access_token" + ] } } } @@ -7601,7 +7718,7 @@ "bodyParameters": [ { "type": "string", - "description": "

    Required. The OAuth access token used to authenticate to the GitHub API.

    ", + "description": "

    Required. Required. The OAuth access token used to authenticate to the GitHub API.

    ", "example": "e72e16c7e42f292c6912e7710c838347ae178b4a", "name": "access_token", "in": "body", @@ -7630,7 +7747,7 @@ "childParamsGroups": [] }, { - "description": "

    The list of repository IDs to scope the user-to-server access token to. repositories may not be specified if repository_ids is specified.

    ", + "description": "

    The list of repository names to scope the user-to-server access token to. repositories may not be specified if repository_ids is specified.

    ", "type": "array of strings", "items": { "type": "string", @@ -7639,11 +7756,11 @@ "name": "repositories", "in": "body", "rawType": "array", - "rawDescription": "The list of repository IDs to scope the user-to-server access token to. `repositories` may not be specified if `repository_ids` is specified.", + "rawDescription": "The list of repository names to scope the user-to-server access token to. `repositories` may not be specified if `repository_ids` is specified.", "childParamsGroups": [] }, { - "description": "

    The list of repository names to scope the user-to-server access token to. repository_ids may not be specified if repositories is specified.

    ", + "description": "

    The list of repository IDs to scope the user-to-server access token to. repository_ids may not be specified if repositories is specified.

    ", "example": [ 1 ], @@ -7654,7 +7771,7 @@ "name": "repository_ids", "in": "body", "rawType": "array", - "rawDescription": "The list of repository names to scope the user-to-server access token to. `repository_ids` may not be specified if `repositories` is specified.", + "rawDescription": "The list of repository IDs to scope the user-to-server access token to. `repository_ids` may not be specified if `repositories` is specified.", "childParamsGroups": [] }, { @@ -8466,7 +8583,7 @@ { "verb": "get", "requestPath": "/applications/{client_id}/tokens/{access_token}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "client_id", @@ -8491,8 +8608,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/CLIENT_ID/tokens/ACCESS_TOKEN", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/applications/CLIENT_ID/tokens/ACCESS_TOKEN
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/applications/CLIENT_ID/tokens/ACCESS_TOKEN", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/applications/CLIENT_ID/tokens/ACCESS_TOKEN
    " }, { "lang": "JavaScript", @@ -8545,7 +8662,7 @@ { "verb": "post", "requestPath": "/applications/{client_id}/tokens/{access_token}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "client_id", @@ -8570,8 +8687,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/CLIENT_ID/tokens/ACCESS_TOKEN", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/applications/CLIENT_ID/tokens/ACCESS_TOKEN
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/applications/CLIENT_ID/tokens/ACCESS_TOKEN", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/applications/CLIENT_ID/tokens/ACCESS_TOKEN
    " }, { "lang": "JavaScript", @@ -8619,7 +8736,7 @@ { "verb": "delete", "requestPath": "/applications/{client_id}/tokens/{access_token}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "client_id", @@ -8644,8 +8761,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/CLIENT_ID/tokens/ACCESS_TOKEN", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/applications/CLIENT_ID/tokens/ACCESS_TOKEN
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/applications/CLIENT_ID/tokens/ACCESS_TOKEN", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/applications/CLIENT_ID/tokens/ACCESS_TOKEN
    " }, { "lang": "JavaScript", @@ -8683,7 +8800,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -8692,7 +8809,7 @@ { "verb": "get", "requestPath": "/apps/{app_slug}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "app_slug", @@ -8707,8 +8824,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/apps/APP_SLUG", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/apps/APP_SLUG
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/apps/APP_SLUG", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/apps/APP_SLUG
    " }, { "lang": "JavaScript", @@ -8766,7 +8883,7 @@ { "verb": "get", "requestPath": "/authorizations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -8787,13 +8904,23 @@ "default": 1 }, "descriptionHTML": "

    Page number of the results to fetch.

    " + }, + { + "name": "client_id", + "in": "query", + "required": false, + "description": "The client ID of your GitHub app.", + "schema": { + "type": "string" + }, + "descriptionHTML": "

    The client ID of your GitHub app.

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/authorizations", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/authorizations
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/authorizations", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/authorizations
    " }, { "lang": "JavaScript", @@ -8859,13 +8986,13 @@ { "verb": "post", "requestPath": "/authorizations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/authorizations \\\n -d '{\"scopes\":[\"scopes\"]}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/authorizations \\\n  -d '{\"scopes\":[\"scopes\"]}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/authorizations \\\n -d '{\"scopes\":[\"scopes\"]}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/authorizations \\\n  -d '{\"scopes\":[\"scopes\"]}'
    " }, { "lang": "JavaScript", @@ -9078,7 +9205,7 @@ { "verb": "put", "requestPath": "/authorizations/clients/{client_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "client_id", @@ -9094,8 +9221,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/authorizations/clients/CLIENT_ID \\\n -d '{\"client_secret\":\"client_secret\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/authorizations/clients/CLIENT_ID \\\n  -d '{\"client_secret\":\"client_secret\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/authorizations/clients/CLIENT_ID \\\n -d '{\"client_secret\":\"client_secret\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/authorizations/clients/CLIENT_ID \\\n  -d '{\"client_secret\":\"client_secret\"}'
    " }, { "lang": "JavaScript", @@ -9292,7 +9419,7 @@ { "verb": "put", "requestPath": "/authorizations/clients/{client_id}/{fingerprint}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "client_id", @@ -9317,8 +9444,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/authorizations/clients/CLIENT_ID/FINGERPRINT \\\n -d '{\"client_secret\":\"client_secret\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/authorizations/clients/CLIENT_ID/FINGERPRINT \\\n  -d '{\"client_secret\":\"client_secret\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/authorizations/clients/CLIENT_ID/FINGERPRINT \\\n -d '{\"client_secret\":\"client_secret\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/authorizations/clients/CLIENT_ID/FINGERPRINT \\\n  -d '{\"client_secret\":\"client_secret\"}'
    " }, { "lang": "JavaScript", @@ -9482,7 +9609,7 @@ { "verb": "get", "requestPath": "/authorizations/{authorization_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "authorization_id", @@ -9498,8 +9625,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/authorizations/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/authorizations/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/authorizations/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/authorizations/42
    " }, { "lang": "JavaScript", @@ -9560,7 +9687,7 @@ { "verb": "patch", "requestPath": "/authorizations/{authorization_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "authorization_id", @@ -9576,8 +9703,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/authorizations/42 \\\n -d '{\"scopes\":[\"scopes\"]}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/authorizations/42 \\\n  -d '{\"scopes\":[\"scopes\"]}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/authorizations/42 \\\n -d '{\"scopes\":[\"scopes\"]}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/authorizations/42 \\\n  -d '{\"scopes\":[\"scopes\"]}'
    " }, { "lang": "JavaScript", @@ -9778,7 +9905,7 @@ { "verb": "delete", "requestPath": "/authorizations/{authorization_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "authorization_id", @@ -9794,8 +9921,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/authorizations/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/authorizations/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/authorizations/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/authorizations/42
    " }, { "lang": "JavaScript", @@ -9831,7 +9958,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -9855,13 +9982,13 @@ { "verb": "get", "requestPath": "/codes_of_conduct", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.scarlet-witch-preview+json\" \\\n https://api.github.com/codes_of_conduct", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.scarlet-witch-preview+json\" \\\n  https://api.github.com/codes_of_conduct
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.scarlet-witch-preview+json\" \\\n http(s)://{hostname}/api/v3/codes_of_conduct", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.scarlet-witch-preview+json\" \\\n  http(s)://{hostname}/api/v3/codes_of_conduct
    " }, { "lang": "JavaScript", @@ -9921,7 +10048,7 @@ { "verb": "get", "requestPath": "/codes_of_conduct/{key}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "key", @@ -9936,8 +10063,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.scarlet-witch-preview+json\" \\\n https://api.github.com/codes_of_conduct/KEY", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.scarlet-witch-preview+json\" \\\n  https://api.github.com/codes_of_conduct/KEY
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.scarlet-witch-preview+json\" \\\n http(s)://{hostname}/api/v3/codes_of_conduct/KEY", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.scarlet-witch-preview+json\" \\\n  http(s)://{hostname}/api/v3/codes_of_conduct/KEY
    " }, { "lang": "JavaScript", @@ -10002,7 +10129,7 @@ { "verb": "post", "requestPath": "/content_references/{content_reference_id}/attachments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "content_reference_id", @@ -10017,8 +10144,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n https://api.github.com/content_references/42/attachments \\\n -d '{\"title\":\"title\",\"body\":\"body\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n  https://api.github.com/content_references/42/attachments \\\n  -d '{\"title\":\"title\",\"body\":\"body\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n http(s)://{hostname}/api/v3/content_references/42/attachments \\\n -d '{\"title\":\"title\",\"body\":\"body\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n  http(s)://{hostname}/api/v3/content_references/42/attachments \\\n  -d '{\"title\":\"title\",\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -10160,13 +10287,13 @@ { "verb": "get", "requestPath": "/emojis", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/emojis", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/emojis
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/emojis", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/emojis
    " }, { "lang": "JavaScript", @@ -10213,13 +10340,13 @@ { "verb": "get", "requestPath": "/enterprise/announcement", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprise/announcement", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprise/announcement
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/enterprise/announcement", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/enterprise/announcement
    " }, { "lang": "JavaScript", @@ -10264,13 +10391,13 @@ { "verb": "patch", "requestPath": "/enterprise/announcement", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprise/announcement \\\n -d '{\"announcement\":\"announcement\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprise/announcement \\\n  -d '{\"announcement\":\"announcement\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/enterprise/announcement \\\n -d '{\"announcement\":\"announcement\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/enterprise/announcement \\\n  -d '{\"announcement\":\"announcement\"}'
    " }, { "lang": "JavaScript", @@ -10374,13 +10501,13 @@ { "verb": "delete", "requestPath": "/enterprise/announcement", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprise/announcement", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprise/announcement
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/enterprise/announcement", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/enterprise/announcement
    " }, { "lang": "JavaScript", @@ -10415,7 +10542,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -10424,13 +10551,13 @@ { "verb": "get", "requestPath": "/enterprise/settings/license", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprise/settings/license", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprise/settings/license
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/enterprise/settings/license", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/enterprise/settings/license
    " }, { "lang": "JavaScript", @@ -10475,7 +10602,7 @@ { "verb": "get", "requestPath": "/enterprise/stats/{type}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "type", @@ -10490,8 +10617,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprise/stats/TYPE", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprise/stats/TYPE
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/enterprise/stats/TYPE", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/enterprise/stats/TYPE
    " }, { "lang": "JavaScript", @@ -10536,7 +10663,7 @@ { "verb": "get", "requestPath": "/enterprises/{enterprise}/actions/permissions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "enterprise", @@ -10552,8 +10679,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprises/ENTERPRISE/actions/permissions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprises/ENTERPRISE/actions/permissions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/permissions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/permissions
    " }, { "lang": "JavaScript", @@ -10598,7 +10725,7 @@ { "verb": "put", "requestPath": "/enterprises/{enterprise}/actions/permissions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "enterprise", @@ -10614,8 +10741,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprises/ENTERPRISE/actions/permissions \\\n -d '{\"enabled_organizations\":\"enabled_organizations\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprises/ENTERPRISE/actions/permissions \\\n  -d '{\"enabled_organizations\":\"enabled_organizations\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/permissions \\\n -d '{\"enabled_organizations\":\"enabled_organizations\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/permissions \\\n  -d '{\"enabled_organizations\":\"enabled_organizations\"}'
    " }, { "lang": "JavaScript", @@ -10696,7 +10823,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "descriptionHTML": "

    Sets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise.

    \n

    You must authenticate using an access token with the admin:enterprise scope to use this endpoint.

    ", @@ -10734,7 +10861,7 @@ { "verb": "get", "requestPath": "/enterprises/{enterprise}/actions/permissions/organizations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "enterprise", @@ -10770,8 +10897,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprises/ENTERPRISE/actions/permissions/organizations", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprises/ENTERPRISE/actions/permissions/organizations
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/permissions/organizations", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/permissions/organizations
    " }, { "lang": "JavaScript", @@ -10816,7 +10943,7 @@ { "verb": "put", "requestPath": "/enterprises/{enterprise}/actions/permissions/organizations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "enterprise", @@ -10832,8 +10959,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprises/ENTERPRISE/actions/permissions/organizations \\\n -d '{\"selected_organization_ids\":[42]}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprises/ENTERPRISE/actions/permissions/organizations \\\n  -d '{\"selected_organization_ids\":[42]}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/permissions/organizations \\\n -d '{\"selected_organization_ids\":[42]}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/permissions/organizations \\\n  -d '{\"selected_organization_ids\":[42]}'
    " }, { "lang": "JavaScript", @@ -10901,7 +11028,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "descriptionHTML": "

    Replaces the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for enabled_organizations must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"

    \n

    You must authenticate using an access token with the admin:enterprise scope to use this endpoint.

    ", @@ -10924,7 +11051,7 @@ { "verb": "put", "requestPath": "/enterprises/{enterprise}/actions/permissions/organizations/{org_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "enterprise", @@ -10950,8 +11077,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprises/ENTERPRISE/actions/permissions/organizations/42", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprises/ENTERPRISE/actions/permissions/organizations/42
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/permissions/organizations/42", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/permissions/organizations/42
    " }, { "lang": "JavaScript", @@ -10986,7 +11113,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -10995,7 +11122,7 @@ { "verb": "delete", "requestPath": "/enterprises/{enterprise}/actions/permissions/organizations/{org_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "enterprise", @@ -11021,8 +11148,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprises/ENTERPRISE/actions/permissions/organizations/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprises/ENTERPRISE/actions/permissions/organizations/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/permissions/organizations/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/permissions/organizations/42
    " }, { "lang": "JavaScript", @@ -11057,7 +11184,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -11066,7 +11193,7 @@ { "verb": "get", "requestPath": "/enterprises/{enterprise}/actions/permissions/selected-actions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "enterprise", @@ -11082,8 +11209,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprises/ENTERPRISE/actions/permissions/selected-actions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprises/ENTERPRISE/actions/permissions/selected-actions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/permissions/selected-actions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/permissions/selected-actions
    " }, { "lang": "JavaScript", @@ -11128,7 +11255,7 @@ { "verb": "put", "requestPath": "/enterprises/{enterprise}/actions/permissions/selected-actions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "enterprise", @@ -11144,8 +11271,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprises/ENTERPRISE/actions/permissions/selected-actions \\\n -d '{\"github_owned_allowed\":true,\"patterns_allowed\":[\"patterns_allowed\"]}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprises/ENTERPRISE/actions/permissions/selected-actions \\\n  -d '{\"github_owned_allowed\":true,\"patterns_allowed\":[\"patterns_allowed\"]}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/permissions/selected-actions \\\n -d '{\"github_owned_allowed\":true,\"patterns_allowed\":[\"patterns_allowed\"]}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/permissions/selected-actions \\\n  -d '{\"github_owned_allowed\":true,\"patterns_allowed\":[\"patterns_allowed\"]}'
    " }, { "lang": "JavaScript", @@ -11228,7 +11355,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "descriptionHTML": "

    Sets the actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"

    \n

    You must authenticate using an access token with the admin:enterprise scope to use this endpoint.

    ", @@ -11259,7 +11386,7 @@ { "verb": "get", "requestPath": "/enterprises/{enterprise}/actions/runner-groups", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "enterprise", @@ -11295,8 +11422,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprises/ENTERPRISE/actions/runner-groups", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprises/ENTERPRISE/actions/runner-groups
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/runner-groups", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/runner-groups
    " }, { "lang": "JavaScript", @@ -11341,7 +11468,7 @@ { "verb": "post", "requestPath": "/enterprises/{enterprise}/actions/runner-groups", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "enterprise", @@ -11357,8 +11484,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprises/ENTERPRISE/actions/runner-groups \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprises/ENTERPRISE/actions/runner-groups \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/runner-groups \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/runner-groups \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -11526,7 +11653,7 @@ { "verb": "get", "requestPath": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "enterprise", @@ -11552,8 +11679,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprises/ENTERPRISE/actions/runner-groups/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprises/ENTERPRISE/actions/runner-groups/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/runner-groups/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/runner-groups/42
    " }, { "lang": "JavaScript", @@ -11598,7 +11725,7 @@ { "verb": "patch", "requestPath": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "enterprise", @@ -11624,8 +11751,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprises/ENTERPRISE/actions/runner-groups/42 \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprises/ENTERPRISE/actions/runner-groups/42 \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/runner-groups/42 \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/runner-groups/42 \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -11732,7 +11859,7 @@ { "verb": "delete", "requestPath": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "enterprise", @@ -11758,8 +11885,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprises/ENTERPRISE/actions/runner-groups/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprises/ENTERPRISE/actions/runner-groups/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/runner-groups/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/runner-groups/42
    " }, { "lang": "JavaScript", @@ -11794,7 +11921,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -11803,7 +11930,7 @@ { "verb": "get", "requestPath": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "enterprise", @@ -11849,8 +11976,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprises/ENTERPRISE/actions/runner-groups/42/organizations", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprises/ENTERPRISE/actions/runner-groups/42/organizations
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/runner-groups/42/organizations", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/runner-groups/42/organizations
    " }, { "lang": "JavaScript", @@ -11895,7 +12022,7 @@ { "verb": "put", "requestPath": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "enterprise", @@ -11921,8 +12048,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprises/ENTERPRISE/actions/runner-groups/42/organizations \\\n -d '{\"selected_organization_ids\":[42]}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprises/ENTERPRISE/actions/runner-groups/42/organizations \\\n  -d '{\"selected_organization_ids\":[42]}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/runner-groups/42/organizations \\\n -d '{\"selected_organization_ids\":[42]}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/runner-groups/42/organizations \\\n  -d '{\"selected_organization_ids\":[42]}'
    " }, { "lang": "JavaScript", @@ -11990,7 +12117,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "descriptionHTML": "

    Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.

    \n

    You must authenticate using an access token with the admin:enterprise scope to use this endpoint.

    ", @@ -12013,7 +12140,7 @@ { "verb": "put", "requestPath": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations/{org_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "enterprise", @@ -12049,8 +12176,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprises/ENTERPRISE/actions/runner-groups/42/organizations/42", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprises/ENTERPRISE/actions/runner-groups/42/organizations/42
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/runner-groups/42/organizations/42", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/runner-groups/42/organizations/42
    " }, { "lang": "JavaScript", @@ -12085,7 +12212,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -12094,7 +12221,7 @@ { "verb": "delete", "requestPath": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations/{org_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "enterprise", @@ -12130,8 +12257,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprises/ENTERPRISE/actions/runner-groups/42/organizations/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprises/ENTERPRISE/actions/runner-groups/42/organizations/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/runner-groups/42/organizations/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/runner-groups/42/organizations/42
    " }, { "lang": "JavaScript", @@ -12166,7 +12293,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -12175,7 +12302,7 @@ { "verb": "get", "requestPath": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "enterprise", @@ -12221,8 +12348,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprises/ENTERPRISE/actions/runner-groups/42/runners", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprises/ENTERPRISE/actions/runner-groups/42/runners
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/runner-groups/42/runners", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/runner-groups/42/runners
    " }, { "lang": "JavaScript", @@ -12267,7 +12394,7 @@ { "verb": "put", "requestPath": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "enterprise", @@ -12293,8 +12420,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprises/ENTERPRISE/actions/runner-groups/42/runners \\\n -d '{\"runners\":[42]}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprises/ENTERPRISE/actions/runner-groups/42/runners \\\n  -d '{\"runners\":[42]}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/runner-groups/42/runners \\\n -d '{\"runners\":[42]}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/runner-groups/42/runners \\\n  -d '{\"runners\":[42]}'
    " }, { "lang": "JavaScript", @@ -12362,7 +12489,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "descriptionHTML": "

    Replaces the list of self-hosted runners that are part of an enterprise runner group.

    \n

    You must authenticate using an access token with the admin:enterprise scope to use this endpoint.

    ", @@ -12385,7 +12512,7 @@ { "verb": "put", "requestPath": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "enterprise", @@ -12421,8 +12548,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprises/ENTERPRISE/actions/runner-groups/42/runners/42", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprises/ENTERPRISE/actions/runner-groups/42/runners/42
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/runner-groups/42/runners/42", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/runner-groups/42/runners/42
    " }, { "lang": "JavaScript", @@ -12457,7 +12584,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -12466,7 +12593,7 @@ { "verb": "delete", "requestPath": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "enterprise", @@ -12502,8 +12629,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprises/ENTERPRISE/actions/runner-groups/42/runners/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprises/ENTERPRISE/actions/runner-groups/42/runners/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/runner-groups/42/runners/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/runner-groups/42/runners/42
    " }, { "lang": "JavaScript", @@ -12538,7 +12665,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -12547,7 +12674,7 @@ { "verb": "get", "requestPath": "/enterprises/{enterprise}/actions/runners", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "enterprise", @@ -12583,8 +12710,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprises/ENTERPRISE/actions/runners", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprises/ENTERPRISE/actions/runners
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/runners", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/runners
    " }, { "lang": "JavaScript", @@ -12629,7 +12756,7 @@ { "verb": "get", "requestPath": "/enterprises/{enterprise}/actions/runners/downloads", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "enterprise", @@ -12645,8 +12772,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprises/ENTERPRISE/actions/runners/downloads", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprises/ENTERPRISE/actions/runners/downloads
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/runners/downloads", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/runners/downloads
    " }, { "lang": "JavaScript", @@ -12691,7 +12818,7 @@ { "verb": "post", "requestPath": "/enterprises/{enterprise}/actions/runners/registration-token", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "enterprise", @@ -12707,8 +12834,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprises/ENTERPRISE/actions/runners/registration-token", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprises/ENTERPRISE/actions/runners/registration-token
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/runners/registration-token", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/runners/registration-token
    " }, { "lang": "JavaScript", @@ -12753,7 +12880,7 @@ { "verb": "post", "requestPath": "/enterprises/{enterprise}/actions/runners/remove-token", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "enterprise", @@ -12769,8 +12896,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprises/ENTERPRISE/actions/runners/remove-token", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprises/ENTERPRISE/actions/runners/remove-token
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/runners/remove-token", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/runners/remove-token
    " }, { "lang": "JavaScript", @@ -12815,7 +12942,7 @@ { "verb": "get", "requestPath": "/enterprises/{enterprise}/actions/runners/{runner_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "enterprise", @@ -12841,8 +12968,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprises/ENTERPRISE/actions/runners/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprises/ENTERPRISE/actions/runners/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/runners/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/runners/42
    " }, { "lang": "JavaScript", @@ -12887,7 +13014,7 @@ { "verb": "delete", "requestPath": "/enterprises/{enterprise}/actions/runners/{runner_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "enterprise", @@ -12913,8 +13040,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprises/ENTERPRISE/actions/runners/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprises/ENTERPRISE/actions/runners/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/runners/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/enterprises/ENTERPRISE/actions/runners/42
    " }, { "lang": "JavaScript", @@ -12949,7 +13076,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -12958,7 +13085,7 @@ { "verb": "get", "requestPath": "/events", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -12984,8 +13111,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/events", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/events
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/events", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/events
    " }, { "lang": "JavaScript", @@ -13044,13 +13171,13 @@ { "verb": "get", "requestPath": "/feeds", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/feeds", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/feeds
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/feeds", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/feeds
    " }, { "lang": "JavaScript", @@ -13095,7 +13222,7 @@ { "verb": "get", "requestPath": "/gists", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "since", @@ -13131,8 +13258,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists
    " }, { "lang": "JavaScript", @@ -13185,13 +13312,13 @@ { "verb": "post", "requestPath": "/gists", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists \\\n -d '{\"files\":{}}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists \\\n  -d '{\"files\":{}}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists \\\n -d '{\"files\":{}}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists \\\n  -d '{\"files\":{}}'
    " }, { "lang": "JavaScript", @@ -13389,7 +13516,7 @@ { "verb": "get", "requestPath": "/gists/public", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "since", @@ -13425,8 +13552,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/public", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/public
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/public", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/public
    " }, { "lang": "JavaScript", @@ -13484,7 +13611,7 @@ { "verb": "get", "requestPath": "/gists/starred", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "since", @@ -13520,8 +13647,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/starred", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/starred
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/starred", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/starred
    " }, { "lang": "JavaScript", @@ -13579,7 +13706,7 @@ { "verb": "get", "requestPath": "/gists/{gist_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -13595,8 +13722,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID
    " }, { "lang": "JavaScript", @@ -13654,7 +13781,7 @@ { "verb": "patch", "requestPath": "/gists/{gist_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -13670,8 +13797,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID \\\n -d '{\"description\":\"description\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID \\\n  -d '{\"description\":\"description\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID \\\n -d '{\"description\":\"description\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID \\\n  -d '{\"description\":\"description\"}'
    " }, { "lang": "JavaScript", @@ -13861,7 +13988,7 @@ { "verb": "delete", "requestPath": "/gists/{gist_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -13877,8 +14004,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID
    " }, { "lang": "JavaScript", @@ -13911,7 +14038,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -13935,7 +14062,7 @@ { "verb": "get", "requestPath": "/gists/{gist_id}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -13971,8 +14098,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/comments", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/comments
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID/comments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID/comments
    " }, { "lang": "JavaScript", @@ -14032,7 +14159,7 @@ { "verb": "post", "requestPath": "/gists/{gist_id}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -14048,8 +14175,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/comments \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/comments \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID/comments \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID/comments \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -14146,7 +14273,7 @@ { "verb": "get", "requestPath": "/gists/{gist_id}/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -14172,8 +14299,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/comments/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/comments/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID/comments/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID/comments/42
    " }, { "lang": "JavaScript", @@ -14233,7 +14360,7 @@ { "verb": "patch", "requestPath": "/gists/{gist_id}/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -14259,8 +14386,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/comments/42 \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/comments/42 \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID/comments/42 \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID/comments/42 \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -14347,7 +14474,7 @@ { "verb": "delete", "requestPath": "/gists/{gist_id}/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -14373,8 +14500,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/comments/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/comments/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID/comments/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID/comments/42
    " }, { "lang": "JavaScript", @@ -14409,7 +14536,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -14433,7 +14560,7 @@ { "verb": "get", "requestPath": "/gists/{gist_id}/commits", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -14469,8 +14596,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/commits", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/commits
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID/commits", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID/commits
    " }, { "lang": "JavaScript", @@ -14528,7 +14655,7 @@ { "verb": "get", "requestPath": "/gists/{gist_id}/forks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -14564,8 +14691,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/forks", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/forks
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID/forks", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID/forks
    " }, { "lang": "JavaScript", @@ -14623,7 +14750,7 @@ { "verb": "post", "requestPath": "/gists/{gist_id}/forks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -14639,8 +14766,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/forks", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/forks
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID/forks", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID/forks
    " }, { "lang": "JavaScript", @@ -14703,7 +14830,7 @@ { "verb": "get", "requestPath": "/gists/{gist_id}/star", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -14719,8 +14846,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/star", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/star
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID/star", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID/star
    " }, { "lang": "JavaScript", @@ -14777,7 +14904,7 @@ { "verb": "put", "requestPath": "/gists/{gist_id}/star", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -14793,8 +14920,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/star", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/star
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID/star", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID/star
    " }, { "lang": "JavaScript", @@ -14827,7 +14954,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -14851,7 +14978,7 @@ { "verb": "delete", "requestPath": "/gists/{gist_id}/star", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -14867,8 +14994,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/star", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/star
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID/star", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID/star
    " }, { "lang": "JavaScript", @@ -14901,7 +15028,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -14925,7 +15052,7 @@ { "verb": "get", "requestPath": "/gists/{gist_id}/{sha}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gist_id", @@ -14950,8 +15077,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/SHA", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/SHA
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gists/GIST_ID/SHA", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gists/GIST_ID/SHA
    " }, { "lang": "JavaScript", @@ -15009,13 +15136,13 @@ { "verb": "get", "requestPath": "/gitignore/templates", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gitignore/templates", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gitignore/templates
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gitignore/templates", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gitignore/templates
    " }, { "lang": "JavaScript", @@ -15063,7 +15190,7 @@ { "verb": "get", "requestPath": "/gitignore/templates/{name}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "name", @@ -15078,8 +15205,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gitignore/templates/NAME", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gitignore/templates/NAME
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/gitignore/templates/NAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/gitignore/templates/NAME
    " }, { "lang": "JavaScript", @@ -15127,7 +15254,7 @@ { "verb": "get", "requestPath": "/installation/repositories", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -15153,8 +15280,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/installation/repositories", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/installation/repositories
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/installation/repositories", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/installation/repositories
    " }, { "lang": "JavaScript", @@ -15221,13 +15348,13 @@ { "verb": "delete", "requestPath": "/installation/token", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/installation/token", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/installation/token
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/installation/token", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/installation/token
    " }, { "lang": "JavaScript", @@ -15262,7 +15389,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -15271,7 +15398,7 @@ { "verb": "get", "requestPath": "/issues", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "filter", @@ -15285,6 +15412,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -15418,8 +15546,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/issues", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/issues
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/issues", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/issues
    " }, { "lang": "JavaScript", @@ -15484,7 +15612,7 @@ { "verb": "get", "requestPath": "/licenses", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "featured", @@ -15504,13 +15632,23 @@ "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/licenses", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/licenses
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/licenses", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/licenses
    " }, { "lang": "JavaScript", @@ -15558,7 +15696,7 @@ { "verb": "get", "requestPath": "/licenses/{license}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "license", @@ -15573,8 +15711,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/licenses/LICENSE", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/licenses/LICENSE
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/licenses/LICENSE", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/licenses/LICENSE
    " }, { "lang": "JavaScript", @@ -15632,13 +15770,13 @@ { "verb": "post", "requestPath": "/markdown", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/markdown \\\n -d '{\"text\":\"text\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/markdown \\\n  -d '{\"text\":\"text\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/markdown \\\n -d '{\"text\":\"text\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/markdown \\\n  -d '{\"text\":\"text\"}'
    " }, { "lang": "JavaScript", @@ -15766,13 +15904,13 @@ { "verb": "post", "requestPath": "/markdown/raw", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/markdown/raw", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/markdown/raw
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/markdown/raw", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/markdown/raw
    " }, { "lang": "JavaScript", @@ -15833,13 +15971,13 @@ { "verb": "get", "requestPath": "/meta", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/meta", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/meta
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/meta", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/meta
    " }, { "lang": "JavaScript", @@ -15887,7 +16025,7 @@ { "verb": "get", "requestPath": "/networks/{owner}/{repo}/events", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -15931,8 +16069,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/networks/octocat/hello-world/events", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/networks/octocat/hello-world/events
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/networks/octocat/hello-world/events", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/networks/octocat/hello-world/events
    " }, { "lang": "JavaScript", @@ -15996,7 +16134,7 @@ { "verb": "get", "requestPath": "/notifications", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "all", @@ -16064,8 +16202,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/notifications", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/notifications
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/notifications", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/notifications
    " }, { "lang": "JavaScript", @@ -16130,13 +16268,13 @@ { "verb": "put", "requestPath": "/notifications", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/notifications \\\n -d '{\"last_read_at\":\"last_read_at\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/notifications \\\n  -d '{\"last_read_at\":\"last_read_at\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/notifications \\\n -d '{\"last_read_at\":\"last_read_at\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/notifications \\\n  -d '{\"last_read_at\":\"last_read_at\"}'
    " }, { "lang": "JavaScript", @@ -16250,7 +16388,7 @@ { "verb": "get", "requestPath": "/notifications/threads/{thread_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "thread_id", @@ -16266,8 +16404,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/notifications/threads/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/notifications/threads/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/notifications/threads/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/notifications/threads/42
    " }, { "lang": "JavaScript", @@ -16327,7 +16465,7 @@ { "verb": "patch", "requestPath": "/notifications/threads/{thread_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "thread_id", @@ -16343,8 +16481,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/notifications/threads/42", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/notifications/threads/42
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/notifications/threads/42", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/notifications/threads/42
    " }, { "lang": "JavaScript", @@ -16398,7 +16536,7 @@ { "verb": "get", "requestPath": "/notifications/threads/{thread_id}/subscription", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "thread_id", @@ -16414,8 +16552,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/notifications/threads/42/subscription", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/notifications/threads/42/subscription
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/notifications/threads/42/subscription", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/notifications/threads/42/subscription
    " }, { "lang": "JavaScript", @@ -16475,7 +16613,7 @@ { "verb": "put", "requestPath": "/notifications/threads/{thread_id}/subscription", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "thread_id", @@ -16491,8 +16629,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/notifications/threads/42/subscription \\\n -d '{\"ignored\":true}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/notifications/threads/42/subscription \\\n  -d '{\"ignored\":true}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/notifications/threads/42/subscription \\\n -d '{\"ignored\":true}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/notifications/threads/42/subscription \\\n  -d '{\"ignored\":true}'
    " }, { "lang": "JavaScript", @@ -16584,7 +16722,7 @@ { "verb": "delete", "requestPath": "/notifications/threads/{thread_id}/subscription", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "thread_id", @@ -16600,8 +16738,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/notifications/threads/42/subscription", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/notifications/threads/42/subscription
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/notifications/threads/42/subscription", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/notifications/threads/42/subscription
    " }, { "lang": "JavaScript", @@ -16636,7 +16774,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -16660,7 +16798,7 @@ { "verb": "get", "requestPath": "/octocat", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "s", @@ -16676,8 +16814,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/octocat", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/octocat
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/octocat", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/octocat
    " }, { "lang": "JavaScript", @@ -16714,7 +16852,7 @@ { "verb": "get", "requestPath": "/organizations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "since", @@ -16740,8 +16878,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/organizations", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/organizations
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/organizations", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/organizations
    " }, { "lang": "JavaScript", @@ -16789,7 +16927,7 @@ { "verb": "get", "requestPath": "/orgs/{org}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -16804,8 +16942,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG
    " }, { "lang": "JavaScript", @@ -16848,13 +16986,7 @@ "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "
    {\n  \"login\": \"github\",\n  \"id\": 1,\n  \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n  \"url\": \"https://api.github.com/orgs/github\",\n  \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n  \"events_url\": \"https://api.github.com/orgs/github/events\",\n  \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n  \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n  \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n  \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n  \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n  \"description\": \"A great organization\",\n  \"name\": \"github\",\n  \"company\": \"GitHub\",\n  \"blog\": \"https://github.com/blog\",\n  \"location\": \"San Francisco\",\n  \"email\": \"octocat@github.com\",\n  \"twitter_username\": \"github\",\n  \"is_verified\": true,\n  \"has_organization_projects\": true,\n  \"has_repository_projects\": true,\n  \"public_repos\": 2,\n  \"public_gists\": 1,\n  \"followers\": 20,\n  \"following\": 0,\n  \"html_url\": \"https://github.com/octocat\",\n  \"created_at\": \"2008-01-14T04:33:35Z\",\n  \"updated_at\": \"2014-03-03T18:58:10Z\",\n  \"type\": \"Organization\",\n  \"total_private_repos\": 100,\n  \"owned_private_repos\": 100,\n  \"private_gists\": 81,\n  \"disk_usage\": 10000,\n  \"collaborators\": 8,\n  \"billing_email\": \"mona@github.com\",\n  \"plan\": {\n    \"name\": \"Medium\",\n    \"space\": 400,\n    \"private_repos\": 20\n  },\n  \"default_repository_permission\": \"read\",\n  \"members_can_create_repositories\": true,\n  \"two_factor_requirement_enabled\": true,\n  \"members_allowed_repository_creation_type\": \"all\",\n  \"members_can_create_public_repositories\": false,\n  \"members_can_create_private_repositories\": false,\n  \"members_can_create_internal_repositories\": false,\n  \"members_can_create_pages\": true\n}\n
    " - }, - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response with GitHub plan information", - "payload": "
    {\n  \"login\": \"github\",\n  \"id\": 1,\n  \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n  \"url\": \"https://api.github.com/orgs/github\",\n  \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n  \"events_url\": \"https://api.github.com/orgs/github/events\",\n  \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n  \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n  \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n  \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n  \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n  \"description\": \"A great organization\",\n  \"name\": \"github\",\n  \"company\": \"GitHub\",\n  \"blog\": \"https://github.com/blog\",\n  \"location\": \"San Francisco\",\n  \"email\": \"octocat@github.com\",\n  \"twitter_username\": \"github\",\n  \"is_verified\": true,\n  \"has_organization_projects\": true,\n  \"has_repository_projects\": true,\n  \"public_repos\": 2,\n  \"public_gists\": 1,\n  \"followers\": 20,\n  \"following\": 0,\n  \"html_url\": \"https://github.com/octocat\",\n  \"created_at\": \"2008-01-14T04:33:35Z\",\n  \"updated_at\": \"2014-03-03T18:58:10Z\",\n  \"type\": \"Organization\",\n  \"plan\": {\n    \"name\": \"team\",\n    \"space\": 976562499,\n    \"private_repos\": 999999,\n    \"filled_seats\": 4,\n    \"seats\": 5\n  }\n}\n
    " + "payload": "
    {\n  \"login\": \"github\",\n  \"id\": 1,\n  \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n  \"url\": \"https://api.github.com/orgs/github\",\n  \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n  \"events_url\": \"https://api.github.com/orgs/github/events\",\n  \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n  \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n  \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n  \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n  \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n  \"description\": \"A great organization\",\n  \"name\": \"github\",\n  \"company\": \"GitHub\",\n  \"blog\": \"https://github.com/blog\",\n  \"location\": \"San Francisco\",\n  \"email\": \"octocat@github.com\",\n  \"twitter_username\": \"github\",\n  \"is_verified\": true,\n  \"has_organization_projects\": true,\n  \"has_repository_projects\": true,\n  \"public_repos\": 2,\n  \"public_gists\": 1,\n  \"followers\": 20,\n  \"following\": 0,\n  \"html_url\": \"https://github.com/octocat\",\n  \"created_at\": \"2008-01-14T04:33:35Z\",\n  \"updated_at\": \"2014-03-03T18:58:10Z\",\n  \"type\": \"Organization\",\n  \"total_private_repos\": 100,\n  \"owned_private_repos\": 100,\n  \"private_gists\": 81,\n  \"disk_usage\": 10000,\n  \"collaborators\": 8,\n  \"billing_email\": \"mona@github.com\",\n  \"plan\": {\n    \"name\": \"Medium\",\n    \"space\": 400,\n    \"private_repos\": 20,\n    \"filled_seats\": 4,\n    \"seats\": 5\n  },\n  \"default_repository_permission\": \"read\",\n  \"members_can_create_repositories\": true,\n  \"two_factor_requirement_enabled\": true,\n  \"members_allowed_repository_creation_type\": \"all\",\n  \"members_can_create_public_repositories\": false,\n  \"members_can_create_private_repositories\": false,\n  \"members_can_create_internal_repositories\": false,\n  \"members_can_create_pages\": true\n}\n
    " }, { "httpStatusCode": "404", @@ -16866,7 +16998,7 @@ { "verb": "patch", "requestPath": "/orgs/{org}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -16881,8 +17013,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG \\\n -d '{\"billing_email\":\"billing_email\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG \\\n  -d '{\"billing_email\":\"billing_email\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG \\\n -d '{\"billing_email\":\"billing_email\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG \\\n  -d '{\"billing_email\":\"billing_email\"}'
    " }, { "lang": "JavaScript", @@ -17305,7 +17437,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/actions/permissions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -17320,8 +17452,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/permissions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/permissions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/actions/permissions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/actions/permissions
    " }, { "lang": "JavaScript", @@ -17366,7 +17498,7 @@ { "verb": "put", "requestPath": "/orgs/{org}/actions/permissions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -17381,8 +17513,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/permissions \\\n -d '{\"enabled_repositories\":\"enabled_repositories\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/permissions \\\n  -d '{\"enabled_repositories\":\"enabled_repositories\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/actions/permissions \\\n -d '{\"enabled_repositories\":\"enabled_repositories\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/actions/permissions \\\n  -d '{\"enabled_repositories\":\"enabled_repositories\"}'
    " }, { "lang": "JavaScript", @@ -17463,7 +17595,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "descriptionHTML": "

    Sets the GitHub Actions permissions policy for repositories and allowed actions in an organization.

    \n

    If the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as allowed_actions to selected actions, then you cannot override them for the organization.

    \n

    You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.

    ", @@ -17501,7 +17633,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/actions/permissions/repositories", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -17536,8 +17668,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/permissions/repositories", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/permissions/repositories
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/actions/permissions/repositories", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/actions/permissions/repositories
    " }, { "lang": "JavaScript", @@ -17582,7 +17714,7 @@ { "verb": "put", "requestPath": "/orgs/{org}/actions/permissions/repositories", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -17597,8 +17729,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/permissions/repositories \\\n -d '{\"selected_repository_ids\":[42]}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/permissions/repositories \\\n  -d '{\"selected_repository_ids\":[42]}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/actions/permissions/repositories \\\n -d '{\"selected_repository_ids\":[42]}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/actions/permissions/repositories \\\n  -d '{\"selected_repository_ids\":[42]}'
    " }, { "lang": "JavaScript", @@ -17666,7 +17798,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "descriptionHTML": "

    Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"

    \n

    You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.

    ", @@ -17689,7 +17821,7 @@ { "verb": "put", "requestPath": "/orgs/{org}/actions/permissions/repositories/{repository_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -17713,8 +17845,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/permissions/repositories/42", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/permissions/repositories/42
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/actions/permissions/repositories/42", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/actions/permissions/repositories/42
    " }, { "lang": "JavaScript", @@ -17749,7 +17881,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -17758,7 +17890,7 @@ { "verb": "delete", "requestPath": "/orgs/{org}/actions/permissions/repositories/{repository_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -17782,8 +17914,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/permissions/repositories/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/permissions/repositories/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/actions/permissions/repositories/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/actions/permissions/repositories/42
    " }, { "lang": "JavaScript", @@ -17818,7 +17950,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -17827,7 +17959,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/actions/permissions/selected-actions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -17842,8 +17974,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/permissions/selected-actions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/permissions/selected-actions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/actions/permissions/selected-actions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/actions/permissions/selected-actions
    " }, { "lang": "JavaScript", @@ -17888,7 +18020,7 @@ { "verb": "put", "requestPath": "/orgs/{org}/actions/permissions/selected-actions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -17903,8 +18035,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/permissions/selected-actions \\\n -d '{\"github_owned_allowed\":true,\"patterns_allowed\":[\"patterns_allowed\"]}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/permissions/selected-actions \\\n  -d '{\"github_owned_allowed\":true,\"patterns_allowed\":[\"patterns_allowed\"]}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/actions/permissions/selected-actions \\\n -d '{\"github_owned_allowed\":true,\"patterns_allowed\":[\"patterns_allowed\"]}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/actions/permissions/selected-actions \\\n  -d '{\"github_owned_allowed\":true,\"patterns_allowed\":[\"patterns_allowed\"]}'
    " }, { "lang": "JavaScript", @@ -17987,7 +18119,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "descriptionHTML": "

    Sets the actions that are allowed in an organization. To use this endpoint, the organization permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"

    \n

    If the organization belongs to an enterprise that has selected actions set at the enterprise level, then you cannot override any of the enterprise's allowed actions settings.

    \n

    To use the patterns_allowed setting for private repositories, the organization must belong to an enterprise. If the organization does not belong to an enterprise, then the patterns_allowed setting only applies to public repositories in the organization.

    \n

    You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.

    ", @@ -18018,7 +18150,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/actions/runner-groups", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -18053,8 +18185,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/runner-groups", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/runner-groups
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/actions/runner-groups", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/actions/runner-groups
    " }, { "lang": "JavaScript", @@ -18099,7 +18231,7 @@ { "verb": "post", "requestPath": "/orgs/{org}/actions/runner-groups", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -18114,8 +18246,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/runner-groups \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/runner-groups \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/actions/runner-groups \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/actions/runner-groups \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -18287,7 +18419,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -18312,8 +18444,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/runner-groups/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/runner-groups/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/actions/runner-groups/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/actions/runner-groups/42
    " }, { "lang": "JavaScript", @@ -18358,7 +18490,7 @@ { "verb": "patch", "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -18383,8 +18515,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/runner-groups/42 \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/runner-groups/42 \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/actions/runner-groups/42 \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/actions/runner-groups/42 \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -18491,7 +18623,7 @@ { "verb": "delete", "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -18516,8 +18648,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/runner-groups/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/runner-groups/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/actions/runner-groups/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/actions/runner-groups/42
    " }, { "lang": "JavaScript", @@ -18552,7 +18684,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -18561,7 +18693,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -18581,13 +18713,33 @@ "type": "integer" }, "descriptionHTML": "

    Unique identifier of the self-hosted runner group.

    " + }, + { + "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.

    " + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "descriptionHTML": "

    Results per page (max 100).

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/runner-groups/42/repositories", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/runner-groups/42/repositories
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/actions/runner-groups/42/repositories", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/actions/runner-groups/42/repositories
    " }, { "lang": "JavaScript", @@ -18632,7 +18784,7 @@ { "verb": "put", "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -18657,8 +18809,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/runner-groups/42/repositories \\\n -d '{\"selected_repository_ids\":[42]}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/runner-groups/42/repositories \\\n  -d '{\"selected_repository_ids\":[42]}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/actions/runner-groups/42/repositories \\\n -d '{\"selected_repository_ids\":[42]}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/actions/runner-groups/42/repositories \\\n  -d '{\"selected_repository_ids\":[42]}'
    " }, { "lang": "JavaScript", @@ -18726,7 +18878,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "descriptionHTML": "

    Replaces the list of repositories that have access to a self-hosted runner group configured in an organization.\nYou must authenticate using an access token with the admin:org scope to use this endpoint.

    ", @@ -18749,7 +18901,7 @@ { "verb": "put", "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -18783,8 +18935,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/runner-groups/42/repositories/42", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/runner-groups/42/repositories/42
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/actions/runner-groups/42/repositories/42", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/actions/runner-groups/42/repositories/42
    " }, { "lang": "JavaScript", @@ -18819,7 +18971,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -18828,7 +18980,7 @@ { "verb": "delete", "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -18862,8 +19014,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/runner-groups/42/repositories/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/runner-groups/42/repositories/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/actions/runner-groups/42/repositories/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/actions/runner-groups/42/repositories/42
    " }, { "lang": "JavaScript", @@ -18898,7 +19050,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -18907,7 +19059,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -18952,8 +19104,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/runner-groups/42/runners", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/runner-groups/42/runners
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/actions/runner-groups/42/runners", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/actions/runner-groups/42/runners
    " }, { "lang": "JavaScript", @@ -18998,7 +19150,7 @@ { "verb": "put", "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -19023,8 +19175,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/runner-groups/42/runners \\\n -d '{\"runners\":[42]}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/runner-groups/42/runners \\\n  -d '{\"runners\":[42]}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/actions/runner-groups/42/runners \\\n -d '{\"runners\":[42]}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/actions/runner-groups/42/runners \\\n  -d '{\"runners\":[42]}'
    " }, { "lang": "JavaScript", @@ -19092,7 +19244,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "descriptionHTML": "

    Replaces the list of self-hosted runners that are part of an organization runner group.\nYou must authenticate using an access token with the admin:org scope to use this endpoint.

    ", @@ -19115,7 +19267,7 @@ { "verb": "put", "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -19150,8 +19302,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/runner-groups/42/runners/42", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/runner-groups/42/runners/42
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/actions/runner-groups/42/runners/42", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/actions/runner-groups/42/runners/42
    " }, { "lang": "JavaScript", @@ -19186,7 +19338,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -19195,7 +19347,7 @@ { "verb": "delete", "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -19230,8 +19382,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/runner-groups/42/runners/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/runner-groups/42/runners/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/actions/runner-groups/42/runners/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/actions/runner-groups/42/runners/42
    " }, { "lang": "JavaScript", @@ -19266,7 +19418,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -19275,7 +19427,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/actions/runners", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -19310,8 +19462,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/runners", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/runners
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/actions/runners", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/actions/runners
    " }, { "lang": "JavaScript", @@ -19356,7 +19508,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/actions/runners/downloads", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -19371,8 +19523,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/runners/downloads", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/runners/downloads
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/actions/runners/downloads", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/actions/runners/downloads
    " }, { "lang": "JavaScript", @@ -19417,7 +19569,7 @@ { "verb": "post", "requestPath": "/orgs/{org}/actions/runners/registration-token", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -19432,8 +19584,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/runners/registration-token", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/runners/registration-token
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/actions/runners/registration-token", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/actions/runners/registration-token
    " }, { "lang": "JavaScript", @@ -19478,7 +19630,7 @@ { "verb": "post", "requestPath": "/orgs/{org}/actions/runners/remove-token", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -19493,8 +19645,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/runners/remove-token", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/runners/remove-token
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/actions/runners/remove-token", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/actions/runners/remove-token
    " }, { "lang": "JavaScript", @@ -19539,7 +19691,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/actions/runners/{runner_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -19564,8 +19716,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/runners/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/runners/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/actions/runners/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/actions/runners/42
    " }, { "lang": "JavaScript", @@ -19610,7 +19762,7 @@ { "verb": "delete", "requestPath": "/orgs/{org}/actions/runners/{runner_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -19635,8 +19787,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/runners/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/runners/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/actions/runners/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/actions/runners/42
    " }, { "lang": "JavaScript", @@ -19671,7 +19823,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -19680,7 +19832,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/actions/secrets", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -19715,8 +19867,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/secrets", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/secrets
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/actions/secrets", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/actions/secrets
    " }, { "lang": "JavaScript", @@ -19761,7 +19913,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/actions/secrets/public-key", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -19776,8 +19928,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/secrets/public-key", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/secrets/public-key
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/actions/secrets/public-key", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/actions/secrets/public-key
    " }, { "lang": "JavaScript", @@ -19822,7 +19974,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/actions/secrets/{secret_name}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -19847,8 +19999,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/secrets/SECRET_NAME", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/secrets/SECRET_NAME
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/actions/secrets/SECRET_NAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/actions/secrets/SECRET_NAME
    " }, { "lang": "JavaScript", @@ -19893,7 +20045,7 @@ { "verb": "put", "requestPath": "/orgs/{org}/actions/secrets/{secret_name}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -19918,8 +20070,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/secrets/SECRET_NAME \\\n -d '{\"encrypted_value\":\"encrypted_value\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/secrets/SECRET_NAME \\\n  -d '{\"encrypted_value\":\"encrypted_value\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/actions/secrets/SECRET_NAME \\\n -d '{\"encrypted_value\":\"encrypted_value\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/actions/secrets/SECRET_NAME \\\n  -d '{\"encrypted_value\":\"encrypted_value\"}'
    " }, { "lang": "JavaScript", @@ -19946,6 +20098,7 @@ "encrypted_value": { "type": "string", "description": "

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an organization public key endpoint.

    ", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", "rawType": "string", @@ -19990,7 +20143,7 @@ } }, "example": { - "encrypted_value": "****************************************************************************************", + "encrypted_value": "c2VjcmV0", "key_id": "012345678912345678", "visibility": "selected", "selected_repository_ids": [ @@ -20031,6 +20184,7 @@ { "type": "string", "description": "

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an organization public key endpoint.

    ", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", "rawType": "string", @@ -20077,7 +20231,7 @@ { "verb": "delete", "requestPath": "/orgs/{org}/actions/secrets/{secret_name}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -20102,8 +20256,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/secrets/SECRET_NAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/secrets/SECRET_NAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/actions/secrets/SECRET_NAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/actions/secrets/SECRET_NAME
    " }, { "lang": "JavaScript", @@ -20138,7 +20292,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -20147,7 +20301,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/actions/secrets/{secret_name}/repositories", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -20167,13 +20321,33 @@ "type": "string" }, "descriptionHTML": "

    secret_name parameter

    " + }, + { + "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.

    " + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "descriptionHTML": "

    Results per page (max 100).

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/secrets/SECRET_NAME/repositories", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/secrets/SECRET_NAME/repositories
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/actions/secrets/SECRET_NAME/repositories", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/actions/secrets/SECRET_NAME/repositories
    " }, { "lang": "JavaScript", @@ -20218,7 +20392,7 @@ { "verb": "put", "requestPath": "/orgs/{org}/actions/secrets/{secret_name}/repositories", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -20243,8 +20417,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/secrets/SECRET_NAME/repositories \\\n -d '{\"selected_repository_ids\":[42]}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/secrets/SECRET_NAME/repositories \\\n  -d '{\"selected_repository_ids\":[42]}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/actions/secrets/SECRET_NAME/repositories \\\n -d '{\"selected_repository_ids\":[42]}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/actions/secrets/SECRET_NAME/repositories \\\n  -d '{\"selected_repository_ids\":[42]}'
    " }, { "lang": "JavaScript", @@ -20307,7 +20481,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "descriptionHTML": "

    Replaces all repositories for an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the secrets organization permission to use this endpoint.

    ", @@ -20329,7 +20503,7 @@ { "verb": "put", "requestPath": "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -20363,8 +20537,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/secrets/SECRET_NAME/repositories/42", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/secrets/SECRET_NAME/repositories/42
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/actions/secrets/SECRET_NAME/repositories/42", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/actions/secrets/SECRET_NAME/repositories/42
    " }, { "lang": "JavaScript", @@ -20413,7 +20587,7 @@ { "verb": "delete", "requestPath": "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -20447,8 +20621,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/secrets/SECRET_NAME/repositories/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/secrets/SECRET_NAME/repositories/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/actions/secrets/SECRET_NAME/repositories/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/actions/secrets/SECRET_NAME/repositories/42
    " }, { "lang": "JavaScript", @@ -20497,7 +20671,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/events", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -20532,8 +20706,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/events", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/events
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/events", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/events
    " }, { "lang": "JavaScript", @@ -20577,7 +20751,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/hooks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -20612,8 +20786,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/hooks", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/hooks
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/hooks", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/hooks
    " }, { "lang": "JavaScript", @@ -20663,7 +20837,7 @@ { "verb": "post", "requestPath": "/orgs/{org}/hooks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -20678,8 +20852,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/hooks \\\n -d '{\"name\":\"name\",\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"username\":\"username\",\"password\":\"password\"}}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/hooks \\\n  -d '{\"name\":\"name\",\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"username\":\"username\",\"password\":\"password\"}}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/hooks \\\n -d '{\"name\":\"name\",\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"username\":\"username\",\"password\":\"password\"}}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/hooks \\\n  -d '{\"name\":\"name\",\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"username\":\"username\",\"password\":\"password\"}}'
    " }, { "lang": "JavaScript", @@ -21110,7 +21284,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/hooks/{hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -21134,8 +21308,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/hooks/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/hooks/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/hooks/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/hooks/42
    " }, { "lang": "JavaScript", @@ -21185,7 +21359,7 @@ { "verb": "patch", "requestPath": "/orgs/{org}/hooks/{hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -21209,8 +21383,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/hooks/42 \\\n -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/hooks/42 \\\n  -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/hooks/42 \\\n -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/hooks/42 \\\n  -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'
    " }, { "lang": "JavaScript", @@ -21559,7 +21733,7 @@ { "verb": "delete", "requestPath": "/orgs/{org}/hooks/{hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -21583,8 +21757,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/hooks/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/hooks/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/hooks/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/hooks/42
    " }, { "lang": "JavaScript", @@ -21619,7 +21793,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -21633,7 +21807,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/hooks/{hook_id}/config", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -21657,8 +21831,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/hooks/42/config", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/hooks/42/config
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/hooks/42/config", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/hooks/42/config
    " }, { "lang": "JavaScript", @@ -21703,7 +21877,7 @@ { "verb": "patch", "requestPath": "/orgs/{org}/hooks/{hook_id}/config", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -21727,8 +21901,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/hooks/42/config \\\n -d '{\"url\":\"url\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/hooks/42/config \\\n  -d '{\"url\":\"url\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/hooks/42/config \\\n -d '{\"url\":\"url\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/hooks/42/config \\\n  -d '{\"url\":\"url\"}'
    " }, { "lang": "JavaScript", @@ -21873,7 +22047,7 @@ { "verb": "post", "requestPath": "/orgs/{org}/hooks/{hook_id}/pings", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -21897,8 +22071,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/hooks/42/pings", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/hooks/42/pings
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/hooks/42/pings", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/hooks/42/pings
    " }, { "lang": "JavaScript", @@ -21933,7 +22107,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -21947,7 +22121,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/installation", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -21962,8 +22136,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/installation", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/installation
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/installation", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/installation
    " }, { "lang": "JavaScript", @@ -22006,7 +22180,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/installations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -22041,8 +22215,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/installations", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/installations
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/installations", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/installations
    " }, { "lang": "JavaScript", @@ -22085,7 +22259,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/issues", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -22108,6 +22282,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -22205,8 +22380,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/issues", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/issues
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/issues", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/issues
    " }, { "lang": "JavaScript", @@ -22261,7 +22436,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/members", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -22327,8 +22502,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/members", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/members
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/members", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/members
    " }, { "lang": "JavaScript", @@ -22383,7 +22558,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/members/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -22407,8 +22582,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/members/USERNAME", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/members/USERNAME
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/members/USERNAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/members/USERNAME
    " }, { "lang": "JavaScript", @@ -22462,7 +22637,7 @@ { "verb": "delete", "requestPath": "/orgs/{org}/members/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -22486,8 +22661,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/members/USERNAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/members/USERNAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/members/USERNAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/members/USERNAME
    " }, { "lang": "JavaScript", @@ -22522,7 +22697,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -22536,7 +22711,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/memberships/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -22560,8 +22735,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/memberships/USERNAME", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/memberships/USERNAME
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/memberships/USERNAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/memberships/USERNAME
    " }, { "lang": "JavaScript", @@ -22570,7 +22745,7 @@ } ], "summary": "Get organization membership for a user", - "description": "In order to get a user's membership with an organization, the authenticated user must be an organization member.", + "description": "In order to get a user's membership with an organization, the authenticated user must be an organization member. The `state` parameter in the response can be used to identify the user's membership status.", "tags": [ "orgs" ], @@ -22593,7 +22768,7 @@ "subcategoryLabel": "Members", "notes": [], "bodyParameters": [], - "descriptionHTML": "

    In order to get a user's membership with an organization, the authenticated user must be an organization member.

    ", + "descriptionHTML": "

    In order to get a user's membership with an organization, the authenticated user must be an organization member. The state parameter in the response can be used to identify the user's membership status.

    ", "responses": [ { "httpStatusCode": "200", @@ -22601,18 +22776,6 @@ "description": "Response if user has an active admin membership with organization", "payload": "
    {\n  \"url\": \"https://api.github.com/orgs/octocat/memberships/defunkt\",\n  \"state\": \"active\",\n  \"role\": \"admin\",\n  \"organization_url\": \"https://api.github.com/orgs/octocat\",\n  \"organization\": {\n    \"login\": \"github\",\n    \"id\": 1,\n    \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n    \"url\": \"https://api.github.com/orgs/github\",\n    \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n    \"events_url\": \"https://api.github.com/orgs/github/events\",\n    \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n    \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n    \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n    \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"description\": \"A great organization\"\n  },\n  \"user\": {\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
    " }, - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response if user has an active membership with organization", - "payload": "
    {\n  \"url\": \"https://api.github.com/orgs/octocat/memberships/defunkt\",\n  \"state\": \"active\",\n  \"role\": \"member\",\n  \"organization_url\": \"https://api.github.com/orgs/octocat\",\n  \"organization\": {\n    \"login\": \"github\",\n    \"id\": 1,\n    \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n    \"url\": \"https://api.github.com/orgs/github\",\n    \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n    \"events_url\": \"https://api.github.com/orgs/github/events\",\n    \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n    \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n    \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n    \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"description\": \"A great organization\"\n  },\n  \"user\": {\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
    " - }, - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response if user has a pending membership with organization", - "payload": "
    {\n  \"url\": \"https://api.github.com/orgs/invitocat/memberships/defunkt\",\n  \"state\": \"pending\",\n  \"role\": \"member\",\n  \"organization_url\": \"https://api.github.com/orgs/invitocat\",\n  \"organization\": {\n    \"login\": \"github\",\n    \"id\": 1,\n    \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n    \"url\": \"https://api.github.com/orgs/github\",\n    \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n    \"events_url\": \"https://api.github.com/orgs/github/events\",\n    \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n    \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n    \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n    \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"description\": \"A great organization\"\n  },\n  \"user\": {\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
    " - }, { "httpStatusCode": "403", "httpStatusMessage": "Forbidden", @@ -22628,7 +22791,7 @@ { "verb": "put", "requestPath": "/orgs/{org}/memberships/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -22652,8 +22815,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/memberships/USERNAME \\\n -d '{\"role\":\"role\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/memberships/USERNAME \\\n  -d '{\"role\":\"role\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/memberships/USERNAME \\\n -d '{\"role\":\"role\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/memberships/USERNAME \\\n  -d '{\"role\":\"role\"}'
    " }, { "lang": "JavaScript", @@ -22730,13 +22893,7 @@ { "httpStatusCode": "200", "httpStatusMessage": "OK", - "description": "Response if user was previously unaffiliated with organization", - "payload": "
    {\n  \"url\": \"https://api.github.com/orgs/invitocat/memberships/defunkt\",\n  \"state\": \"pending\",\n  \"role\": \"admin\",\n  \"organization_url\": \"https://api.github.com/orgs/invitocat\",\n  \"organization\": {\n    \"login\": \"github\",\n    \"id\": 1,\n    \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n    \"url\": \"https://api.github.com/orgs/github\",\n    \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n    \"events_url\": \"https://api.github.com/orgs/github/events\",\n    \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n    \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n    \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n    \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"description\": \"A great organization\"\n  },\n  \"user\": {\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
    " - }, - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response if user already had membership with organization", + "description": "Response if user has an active admin membership with organization", "payload": "
    {\n  \"url\": \"https://api.github.com/orgs/octocat/memberships/defunkt\",\n  \"state\": \"active\",\n  \"role\": \"admin\",\n  \"organization_url\": \"https://api.github.com/orgs/octocat\",\n  \"organization\": {\n    \"login\": \"github\",\n    \"id\": 1,\n    \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n    \"url\": \"https://api.github.com/orgs/github\",\n    \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n    \"events_url\": \"https://api.github.com/orgs/github/events\",\n    \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n    \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n    \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n    \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"description\": \"A great organization\"\n  },\n  \"user\": {\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
    " }, { @@ -22754,7 +22911,7 @@ { "verb": "delete", "requestPath": "/orgs/{org}/memberships/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -22778,8 +22935,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/memberships/USERNAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/memberships/USERNAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/memberships/USERNAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/memberships/USERNAME
    " }, { "lang": "JavaScript", @@ -22814,7 +22971,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -22833,7 +22990,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/outside_collaborators", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -22883,8 +23040,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/outside_collaborators", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/outside_collaborators
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/outside_collaborators", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/outside_collaborators
    " }, { "lang": "JavaScript", @@ -22929,7 +23086,7 @@ { "verb": "put", "requestPath": "/orgs/{org}/outside_collaborators/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -22953,8 +23110,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/outside_collaborators/USERNAME", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/outside_collaborators/USERNAME
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/outside_collaborators/USERNAME", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/outside_collaborators/USERNAME
    " }, { "lang": "JavaScript", @@ -22985,8 +23142,6 @@ "subcategory": "outside-collaborators", "subcategoryLabel": "Outside collaborators", "notes": [], - "bodyParameters": [], - "descriptionHTML": "

    When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"Converting an organization member to an outside collaborator\".

    ", "responses": [ { "httpStatusCode": "202", @@ -23001,26 +23156,21 @@ { "httpStatusCode": "403", "httpStatusMessage": "Forbidden", - "description": "Response if user is the last owner of the organization", - "payload": "
    {\n  \"message\": \"Cannot convert the last owner to an outside collaborator\",\n  \"documentation_url\": \"https://docs.github.com/enterprise-server@3.0/rest/reference/orgs#convert-member-to-outside-collaborator\"\n}\n
    " - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Response if user is not a member of the organization", - "payload": "
    {\n  \"message\": \"<user> is not a member of the <organization> organization.\",\n  \"documentation_url\": \"https://docs.github.com/enterprise-server@3.0/rest/reference/orgs#convert-member-to-outside-collaborator\"\n}\n
    " + "description": "Response if user is the last owner of the organization or not a member of the organization" }, { "httpStatusCode": "404", "httpStatusMessage": "Not Found", "description": "Resource not found" } - ] + ], + "bodyParameters": [], + "descriptionHTML": "

    When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"Converting an organization member to an outside collaborator\".

    " }, { "verb": "delete", "requestPath": "/orgs/{org}/outside_collaborators/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -23044,8 +23194,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/outside_collaborators/USERNAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/outside_collaborators/USERNAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/outside_collaborators/USERNAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/outside_collaborators/USERNAME
    " }, { "lang": "JavaScript", @@ -23082,7 +23232,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "422", @@ -23095,7 +23245,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/pre-receive-hooks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -23125,13 +23275,44 @@ "default": 1 }, "descriptionHTML": "

    Page number of the results to fetch.

    " + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + }, + "descriptionHTML": "

    One of asc (ascending) or desc (descending).

    " + }, + { + "name": "sort", + "description": "The sort order for the response collection.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + }, + "descriptionHTML": "

    The sort order for the response collection.

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/orgs/ORG/pre-receive-hooks", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/orgs/ORG/pre-receive-hooks
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/pre-receive-hooks", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/pre-receive-hooks
    " }, { "lang": "JavaScript", @@ -23183,7 +23364,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -23207,8 +23388,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/orgs/ORG/pre-receive-hooks/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/orgs/ORG/pre-receive-hooks/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/pre-receive-hooks/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/pre-receive-hooks/42
    " }, { "lang": "JavaScript", @@ -23260,7 +23441,7 @@ { "verb": "patch", "requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -23284,8 +23465,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/orgs/ORG/pre-receive-hooks/42 \\\n -d '{\"enforcement\":\"enforcement\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/orgs/ORG/pre-receive-hooks/42 \\\n  -d '{\"enforcement\":\"enforcement\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/pre-receive-hooks/42 \\\n -d '{\"enforcement\":\"enforcement\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/pre-receive-hooks/42 \\\n  -d '{\"enforcement\":\"enforcement\"}'
    " }, { "lang": "JavaScript", @@ -23389,7 +23570,7 @@ { "verb": "delete", "requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -23413,8 +23594,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/orgs/ORG/pre-receive-hooks/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/orgs/ORG/pre-receive-hooks/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/pre-receive-hooks/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/pre-receive-hooks/42
    " }, { "lang": "JavaScript", @@ -23466,7 +23647,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/projects", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -23517,8 +23698,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/orgs/ORG/projects", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/orgs/ORG/projects
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/projects", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/projects
    " }, { "lang": "JavaScript", @@ -23573,7 +23754,7 @@ { "verb": "post", "requestPath": "/orgs/{org}/projects", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -23588,8 +23769,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/orgs/ORG/projects \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/orgs/ORG/projects \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/projects \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/projects \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -23719,7 +23900,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/public_members", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -23754,8 +23935,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/public_members", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/public_members
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/public_members", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/public_members
    " }, { "lang": "JavaScript", @@ -23800,7 +23981,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/public_members/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -23824,8 +24005,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/public_members/USERNAME", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/public_members/USERNAME
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/public_members/USERNAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/public_members/USERNAME
    " }, { "lang": "JavaScript", @@ -23874,7 +24055,7 @@ { "verb": "put", "requestPath": "/orgs/{org}/public_members/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -23898,8 +24079,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/public_members/USERNAME", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/public_members/USERNAME
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/public_members/USERNAME", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/public_members/USERNAME
    " }, { "lang": "JavaScript", @@ -23934,7 +24115,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -23948,7 +24129,7 @@ { "verb": "delete", "requestPath": "/orgs/{org}/public_members/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -23972,8 +24153,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/public_members/USERNAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/public_members/USERNAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/public_members/USERNAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/public_members/USERNAME
    " }, { "lang": "JavaScript", @@ -24008,7 +24189,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -24017,7 +24198,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/repos", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -24030,7 +24211,7 @@ }, { "name": "type", - "description": "Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`.", + "description": "Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Note: For GitHub AE, can be one of `all`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`.", "in": "query", "required": false, "schema": { @@ -24045,7 +24226,7 @@ "internal" ] }, - "descriptionHTML": "

    Specifies the types of repositories you want returned. Can be one of all, public, private, forks, sources, member, internal. Default: all. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, type can also be internal.

    " + "descriptionHTML": "

    Specifies the types of repositories you want returned. Can be one of all, public, private, forks, sources, member, internal. Note: For GitHub AE, can be one of all, private, forks, sources, member, internal. Default: all. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, type can also be internal.

    " }, { "name": "sort", @@ -24102,8 +24283,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/repos", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/repos
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/repos", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/repos
    " }, { "lang": "JavaScript", @@ -24159,7 +24340,7 @@ { "verb": "post", "requestPath": "/orgs/{org}/repos", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -24174,8 +24355,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/repos \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/repos \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/repos \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/repos \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -24184,7 +24365,7 @@ } ], "summary": "Create an organization repository", - "description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", + "description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository", "tags": [ "repos" ], @@ -24228,17 +24409,17 @@ }, "private": { "type": "boolean", - "description": "

    Either true to create a private repository or false to create a public one.

    ", + "description": "

    Whether the repository is private.

    ", "default": false, "name": "private", "in": "body", "rawType": "boolean", - "rawDescription": "Either `true` to create a private repository or `false` to create a public one.", + "rawDescription": "Whether the repository is private.", "childParamsGroups": [] }, "visibility": { "type": "string", - "description": "

    Can be public or private. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be internal. For more information, see \"Creating an internal repository\" in the GitHub Help documentation.
    \nThe visibility parameter overrides the private parameter when you use both parameters with the nebula-preview preview header.

    ", + "description": "

    Can be public or private. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be internal. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"Creating an internal repository\" in the GitHub Help documentation.
    \nThe visibility parameter overrides the private parameter when you use both parameters with the nebula-preview preview header.

    ", "enum": [ "public", "private", @@ -24248,7 +24429,7 @@ "name": "visibility", "in": "body", "rawType": "string", - "rawDescription": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", + "rawDescription": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", "childParamsGroups": [] }, "has_issues": { @@ -24409,7 +24590,7 @@ "category": "repos", "categoryLabel": "Repos", "notes": [], - "descriptionHTML": "

    Creates a new repository in the specified organization. The authenticated user must be a member of the organization.

    \n

    OAuth scope requirements

    \n

    When using OAuth, authorizations must include:

    \n
      \n
    • public_repo scope or repo scope to create a public repository
    • \n
    • repo scope to create a private repository
    • \n
    ", + "descriptionHTML": "

    Creates a new repository in the specified organization. The authenticated user must be a member of the organization.

    \n

    OAuth scope requirements

    \n

    When using OAuth, authorizations must include:

    \n
      \n
    • public_repo scope or repo scope to create a public repository. Note: For GitHub AE, use repo scope to create an internal repository.
    • \n
    • repo scope to create a private repository
    • \n
    ", "bodyParameters": [ { "type": "string", @@ -24440,17 +24621,17 @@ }, { "type": "boolean", - "description": "

    Either true to create a private repository or false to create a public one.

    ", + "description": "

    Whether the repository is private.

    ", "default": false, "name": "private", "in": "body", "rawType": "boolean", - "rawDescription": "Either `true` to create a private repository or `false` to create a public one.", + "rawDescription": "Whether the repository is private.", "childParamsGroups": [] }, { "type": "string", - "description": "

    Can be public or private. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be internal. For more information, see \"Creating an internal repository\" in the GitHub Help documentation.
    \nThe visibility parameter overrides the private parameter when you use both parameters with the nebula-preview preview header.

    ", + "description": "

    Can be public or private. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be internal. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"Creating an internal repository\" in the GitHub Help documentation.
    \nThe visibility parameter overrides the private parameter when you use both parameters with the nebula-preview preview header.

    ", "enum": [ "public", "private", @@ -24460,7 +24641,7 @@ "name": "visibility", "in": "body", "rawType": "string", - "rawDescription": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", + "rawDescription": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", "childParamsGroups": [] }, { @@ -24603,7 +24784,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/teams", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -24638,8 +24819,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams
    " }, { "lang": "JavaScript", @@ -24687,7 +24868,7 @@ { "verb": "post", "requestPath": "/orgs/{org}/teams", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -24702,8 +24883,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -24935,7 +25116,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -24960,8 +25141,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG
    " }, { "lang": "JavaScript", @@ -25009,7 +25190,7 @@ { "verb": "patch", "requestPath": "/orgs/{org}/teams/{team_slug}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -25034,8 +25215,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -25207,7 +25388,7 @@ { "verb": "delete", "requestPath": "/orgs/{org}/teams/{team_slug}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -25232,8 +25413,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG
    " }, { "lang": "JavaScript", @@ -25266,7 +25447,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -25275,7 +25456,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -25330,13 +25511,23 @@ "default": 1 }, "descriptionHTML": "

    Page number of the results to fetch.

    " + }, + { + "name": "pinned", + "in": "query", + "required": false, + "description": "Pinned discussions only filter", + "schema": { + "type": "string" + }, + "descriptionHTML": "

    Pinned discussions only filter

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions
    " }, { "lang": "JavaScript", @@ -25388,7 +25579,7 @@ { "verb": "post", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -25413,8 +25604,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions \\\n -d '{\"title\":\"title\",\"body\":\"body\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions \\\n  -d '{\"title\":\"title\",\"body\":\"body\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions \\\n -d '{\"title\":\"title\",\"body\":\"body\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions \\\n  -d '{\"title\":\"title\",\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -25543,7 +25734,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -25577,8 +25768,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42
    " }, { "lang": "JavaScript", @@ -25630,7 +25821,7 @@ { "verb": "patch", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -25664,8 +25855,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42 \\\n -d '{\"title\":\"title\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42 \\\n  -d '{\"title\":\"title\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42 \\\n -d '{\"title\":\"title\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42 \\\n  -d '{\"title\":\"title\"}'
    " }, { "lang": "JavaScript", @@ -25768,7 +25959,7 @@ { "verb": "delete", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -25802,8 +25993,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42
    " }, { "lang": "JavaScript", @@ -25838,7 +26029,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -25847,7 +26038,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -25916,8 +26107,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments
    " }, { "lang": "JavaScript", @@ -25969,7 +26160,7 @@ { "verb": "post", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -26003,8 +26194,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -26093,7 +26284,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -26136,8 +26327,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42
    " }, { "lang": "JavaScript", @@ -26189,7 +26380,7 @@ { "verb": "patch", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -26232,8 +26423,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42 \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42 \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42 \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42 \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -26321,7 +26512,7 @@ { "verb": "delete", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -26364,8 +26555,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42
    " }, { "lang": "JavaScript", @@ -26400,7 +26591,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -26409,7 +26600,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -26492,8 +26683,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42/reactions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42/reactions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42/reactions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42/reactions
    " }, { "lang": "JavaScript", @@ -26543,7 +26734,7 @@ { "verb": "post", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -26586,8 +26777,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42/reactions \\\n -d '{\"content\":\"content\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42/reactions \\\n -d '{\"content\":\"content\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " }, { "lang": "JavaScript", @@ -26693,7 +26884,7 @@ { "verb": "delete", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -26745,8 +26936,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42/reactions/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42/reactions/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42/reactions/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42/reactions/42
    " }, { "lang": "JavaScript", @@ -26786,7 +26977,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -26795,7 +26986,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -26869,8 +27060,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/reactions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/reactions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42/reactions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42/reactions
    " }, { "lang": "JavaScript", @@ -26920,7 +27111,7 @@ { "verb": "post", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -26954,8 +27145,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/reactions \\\n -d '{\"content\":\"content\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42/reactions \\\n -d '{\"content\":\"content\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " }, { "lang": "JavaScript", @@ -27061,7 +27252,7 @@ { "verb": "delete", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -27104,8 +27295,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/reactions/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/reactions/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42/reactions/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/42/reactions/42
    " }, { "lang": "JavaScript", @@ -27145,7 +27336,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -27154,7 +27345,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/members", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -27215,8 +27406,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/members", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/members
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/members", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/members
    " }, { "lang": "JavaScript", @@ -27261,7 +27452,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/memberships/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -27295,8 +27486,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/memberships/USERNAME", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/memberships/USERNAME
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/memberships/USERNAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/memberships/USERNAME
    " }, { "lang": "JavaScript", @@ -27305,7 +27496,7 @@ } ], "summary": "Get team membership for a user", - "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.\n\n**Note:** The `role` for organization owners returns as `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@3.0/rest/reference/teams#create-a-team).", + "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.\n\n**Note:**\nThe response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see see [Create a team](https://docs.github.com/enterprise-server@3.0/rest/reference/teams#create-a-team).", "tags": [ "teams" ], @@ -27328,26 +27519,14 @@ "subcategoryLabel": "Members", "notes": [], "bodyParameters": [], - "descriptionHTML": "

    Team members will include the members of child teams.

    \n

    To get a user's membership with a team, the team must be visible to the authenticated user.

    \n

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

    \n

    Note: The role for organization owners returns as maintainer. For more information about maintainer roles, see Create a team.

    ", + "descriptionHTML": "

    Team members will include the members of child teams.

    \n

    To get a user's membership with a team, the team must be visible to the authenticated user.

    \n

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

    \n

    Note:\nThe response contains the state of the membership and the member's role.

    \n

    The role for organization owners is set to maintainer. For more information about maintainer roles, see see Create a team.

    ", "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response if user has an active membership with team", - "payload": "
    {\n  \"url\": \"https://api.github.com/teams/1/memberships/octocat\",\n  \"role\": \"member\",\n  \"state\": \"active\"\n}\n
    " - }, { "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Response if user is a team maintainer", "payload": "
    {\n  \"url\": \"https://api.github.com/teams/1/memberships/octocat\",\n  \"role\": \"maintainer\",\n  \"state\": \"active\"\n}\n
    " }, - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response if user has a pending membership with team", - "payload": "
    {\n  \"url\": \"https://api.github.com/teams/1/memberships/octocat\",\n  \"role\": \"member\",\n  \"state\": \"pending\"\n}\n
    " - }, { "httpStatusCode": "404", "httpStatusMessage": "Not Found", @@ -27358,7 +27537,7 @@ { "verb": "put", "requestPath": "/orgs/{org}/teams/{team_slug}/memberships/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -27392,8 +27571,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/memberships/USERNAME \\\n -d '{\"role\":\"role\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/memberships/USERNAME \\\n  -d '{\"role\":\"role\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/memberships/USERNAME \\\n -d '{\"role\":\"role\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/memberships/USERNAME \\\n  -d '{\"role\":\"role\"}'
    " }, { "lang": "JavaScript", @@ -27467,12 +27646,6 @@ } ], "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response if user's membership with team is now active", - "payload": "
    {\n  \"url\": \"https://api.github.com/teams/1/memberships/octocat\",\n  \"role\": \"member\",\n  \"state\": \"active\"\n}\n
    " - }, { "httpStatusCode": "200", "httpStatusMessage": "OK", @@ -27487,15 +27660,14 @@ { "httpStatusCode": "422", "httpStatusMessage": "Unprocessable Entity", - "description": "Response if you attempt to add an organization to a team", - "payload": "
    {\n  \"message\": \"Cannot add an organization as a member.\",\n  \"errors\": [\n    {\n      \"code\": \"org\",\n      \"field\": \"user\",\n      \"resource\": \"TeamMember\"\n    }\n  ]\n}\n
    " + "description": "Response if you attempt to add an organization to a team" } ] }, { "verb": "delete", "requestPath": "/orgs/{org}/teams/{team_slug}/memberships/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -27529,8 +27701,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/memberships/USERNAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/memberships/USERNAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/memberships/USERNAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/memberships/USERNAME
    " }, { "lang": "JavaScript", @@ -27565,7 +27737,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -27579,7 +27751,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/projects", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -27624,8 +27796,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/projects", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/projects
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/projects", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/projects
    " }, { "lang": "JavaScript", @@ -27675,7 +27847,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/projects/{project_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -27709,8 +27881,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/projects/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/projects/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/projects/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/projects/42
    " }, { "lang": "JavaScript", @@ -27765,7 +27937,7 @@ { "verb": "put", "requestPath": "/orgs/{org}/teams/{team_slug}/projects/{project_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -27799,8 +27971,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/projects/42 \\\n -d '{\"permission\":\"permission\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/projects/42 \\\n  -d '{\"permission\":\"permission\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/projects/42 \\\n -d '{\"permission\":\"permission\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/projects/42 \\\n  -d '{\"permission\":\"permission\"}'
    " }, { "lang": "JavaScript", @@ -27883,7 +28055,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -27896,7 +28068,7 @@ { "verb": "delete", "requestPath": "/orgs/{org}/teams/{team_slug}/projects/{project_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -27930,8 +28102,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/projects/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/projects/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/projects/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/projects/42
    " }, { "lang": "JavaScript", @@ -27964,7 +28136,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -27973,7 +28145,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/repos", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -28018,8 +28190,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/repos", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/repos
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/repos", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/repos
    " }, { "lang": "JavaScript", @@ -28062,7 +28234,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -28105,8 +28277,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/repos/octocat/hello-world", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/repos/octocat/hello-world
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/repos/octocat/hello-world", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/repos/octocat/hello-world
    " }, { "lang": "JavaScript", @@ -28158,7 +28330,7 @@ { "verb": "put", "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -28201,8 +28373,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/repos/octocat/hello-world \\\n -d '{\"permission\":\"permission\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/repos/octocat/hello-world \\\n  -d '{\"permission\":\"permission\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/repos/octocat/hello-world \\\n -d '{\"permission\":\"permission\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/repos/octocat/hello-world \\\n  -d '{\"permission\":\"permission\"}'
    " }, { "lang": "JavaScript", @@ -28262,7 +28434,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "descriptionHTML": "

    To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a 422 Unprocessable Entity status if you attempt to add a repository to a team that is not owned by the organization. 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

    Note: You can also specify a team by org_id and team_id using the route PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}.

    \n

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

    ", @@ -28288,7 +28460,7 @@ { "verb": "delete", "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -28331,8 +28503,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/repos/octocat/hello-world", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/repos/octocat/hello-world
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/repos/octocat/hello-world", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/repos/octocat/hello-world
    " }, { "lang": "JavaScript", @@ -28365,7 +28537,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -28374,7 +28546,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/teams", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -28419,8 +28591,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/teams", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/teams
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/teams", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/teams
    " }, { "lang": "JavaScript", @@ -28463,7 +28635,7 @@ { "verb": "get", "requestPath": "/projects/columns/cards/{card_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "card_id", @@ -28479,8 +28651,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/cards/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/cards/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/columns/cards/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/columns/cards/42
    " }, { "lang": "JavaScript", @@ -28552,7 +28724,7 @@ { "verb": "patch", "requestPath": "/projects/columns/cards/{card_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "card_id", @@ -28568,8 +28740,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/cards/42 \\\n -d '{\"note\":\"note\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/cards/42 \\\n  -d '{\"note\":\"note\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/columns/cards/42 \\\n -d '{\"note\":\"note\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/columns/cards/42 \\\n  -d '{\"note\":\"note\"}'
    " }, { "lang": "JavaScript", @@ -28700,7 +28872,7 @@ { "verb": "delete", "requestPath": "/projects/columns/cards/{card_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "card_id", @@ -28716,8 +28888,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/cards/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/cards/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/columns/cards/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/columns/cards/42
    " }, { "lang": "JavaScript", @@ -28759,7 +28931,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -28788,7 +28960,7 @@ { "verb": "post", "requestPath": "/projects/columns/cards/{card_id}/moves", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "card_id", @@ -28804,8 +28976,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/cards/42/moves \\\n -d '{\"position\":\"position\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/cards/42/moves \\\n  -d '{\"position\":\"position\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/columns/cards/42/moves \\\n -d '{\"position\":\"position\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/columns/cards/42/moves \\\n  -d '{\"position\":\"position\"}'
    " }, { "lang": "JavaScript", @@ -28938,7 +29110,7 @@ { "verb": "get", "requestPath": "/projects/columns/{column_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "column_id", @@ -28954,8 +29126,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/columns/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/columns/42
    " }, { "lang": "JavaScript", @@ -29027,7 +29199,7 @@ { "verb": "patch", "requestPath": "/projects/columns/{column_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "column_id", @@ -29043,8 +29215,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/42 \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/42 \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/columns/42 \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/columns/42 \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -29146,7 +29318,7 @@ { "verb": "delete", "requestPath": "/projects/columns/{column_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "column_id", @@ -29162,8 +29334,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/columns/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/columns/42
    " }, { "lang": "JavaScript", @@ -29205,7 +29377,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -29229,7 +29401,7 @@ { "verb": "get", "requestPath": "/projects/columns/{column_id}/cards", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "column_id", @@ -29281,8 +29453,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/42/cards", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/42/cards
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/columns/42/cards", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/columns/42/cards
    " }, { "lang": "JavaScript", @@ -29349,7 +29521,7 @@ { "verb": "post", "requestPath": "/projects/columns/{column_id}/cards", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "column_id", @@ -29365,8 +29537,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/42/cards \\\n -d '{\"note\":\"note\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/42/cards \\\n  -d '{\"note\":\"note\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/columns/42/cards \\\n -d '{\"note\":\"note\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/columns/42/cards \\\n  -d '{\"note\":\"note\"}'
    " }, { "lang": "JavaScript", @@ -29486,7 +29658,7 @@ { "verb": "post", "requestPath": "/projects/columns/{column_id}/moves", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "column_id", @@ -29502,8 +29674,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/42/moves \\\n -d '{\"position\":\"position\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/42/moves \\\n  -d '{\"position\":\"position\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/columns/42/moves \\\n -d '{\"position\":\"position\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/columns/42/moves \\\n  -d '{\"position\":\"position\"}'
    " }, { "lang": "JavaScript", @@ -29611,7 +29783,7 @@ { "verb": "get", "requestPath": "/projects/{project_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "project_id", @@ -29626,8 +29798,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/42
    " }, { "lang": "JavaScript", @@ -29692,7 +29864,7 @@ { "verb": "patch", "requestPath": "/projects/{project_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "project_id", @@ -29707,8 +29879,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42 \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/42 \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/42 \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/42 \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -29910,7 +30082,7 @@ { "verb": "delete", "requestPath": "/projects/{project_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "project_id", @@ -29925,8 +30097,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/42
    " }, { "lang": "JavaScript", @@ -30000,7 +30172,7 @@ { "verb": "get", "requestPath": "/projects/{project_id}/collaborators", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "project_id", @@ -30051,8 +30223,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42/collaborators", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/42/collaborators
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/42/collaborators", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/42/collaborators
    " }, { "lang": "JavaScript", @@ -30134,7 +30306,7 @@ { "verb": "put", "requestPath": "/projects/{project_id}/collaborators/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "project_id", @@ -30158,8 +30330,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42/collaborators/USERNAME \\\n -d '{\"permission\":\"permission\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/42/collaborators/USERNAME \\\n  -d '{\"permission\":\"permission\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/42/collaborators/USERNAME \\\n -d '{\"permission\":\"permission\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/42/collaborators/USERNAME \\\n  -d '{\"permission\":\"permission\"}'
    " }, { "lang": "JavaScript", @@ -30228,7 +30400,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -30284,7 +30456,7 @@ { "verb": "delete", "requestPath": "/projects/{project_id}/collaborators/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "project_id", @@ -30308,8 +30480,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42/collaborators/USERNAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/42/collaborators/USERNAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/42/collaborators/USERNAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/42/collaborators/USERNAME
    " }, { "lang": "JavaScript", @@ -30351,7 +30523,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -30390,7 +30562,7 @@ { "verb": "get", "requestPath": "/projects/{project_id}/collaborators/{username}/permission", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "project_id", @@ -30414,8 +30586,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42/collaborators/USERNAME/permission", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/42/collaborators/USERNAME/permission
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/42/collaborators/USERNAME/permission", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/42/collaborators/USERNAME/permission
    " }, { "lang": "JavaScript", @@ -30497,7 +30669,7 @@ { "verb": "get", "requestPath": "/projects/{project_id}/columns", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "project_id", @@ -30532,8 +30704,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42/columns", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/42/columns
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/42/columns", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/42/columns
    " }, { "lang": "JavaScript", @@ -30600,7 +30772,7 @@ { "verb": "post", "requestPath": "/projects/{project_id}/columns", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "project_id", @@ -30615,8 +30787,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42/columns \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/42/columns \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/projects/42/columns \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/projects/42/columns \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -30723,13 +30895,13 @@ { "verb": "get", "requestPath": "/rate_limit", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/rate_limit", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/rate_limit
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/rate_limit", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/rate_limit
    " }, { "lang": "JavaScript", @@ -30782,7 +30954,7 @@ { "verb": "delete", "requestPath": "/reactions/{reaction_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "reaction_id", @@ -30797,8 +30969,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/reactions/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/reactions/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/reactions/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/reactions/42
    " }, { "lang": "JavaScript", @@ -30841,7 +31013,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -30875,7 +31047,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -30899,8 +31071,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world
    " }, { "lang": "JavaScript", @@ -30977,7 +31149,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -31001,8 +31173,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -31396,7 +31568,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -31420,8 +31592,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world
    " }, { "lang": "JavaScript", @@ -31456,7 +31628,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -31474,7 +31646,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/actions/artifacts", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -31518,8 +31690,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/artifacts", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/artifacts
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/artifacts", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/artifacts
    " }, { "lang": "JavaScript", @@ -31564,7 +31736,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -31598,8 +31770,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/artifacts/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/artifacts/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/artifacts/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/artifacts/42
    " }, { "lang": "JavaScript", @@ -31644,7 +31816,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -31678,8 +31850,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/artifacts/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/artifacts/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/artifacts/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/artifacts/42
    " }, { "lang": "JavaScript", @@ -31714,7 +31886,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -31723,7 +31895,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -31766,8 +31938,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/artifacts/42/ARCHIVE_FORMAT", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/artifacts/42/ARCHIVE_FORMAT
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/artifacts/42/ARCHIVE_FORMAT", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/artifacts/42/ARCHIVE_FORMAT
    " }, { "lang": "JavaScript", @@ -31811,7 +31983,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/actions/jobs/{job_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -31845,8 +32017,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/jobs/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/jobs/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/jobs/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/jobs/42
    " }, { "lang": "JavaScript", @@ -31891,7 +32063,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/actions/jobs/{job_id}/logs", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -31925,8 +32097,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/jobs/42/logs", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/jobs/42/logs
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/jobs/42/logs", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/jobs/42/logs
    " }, { "lang": "JavaScript", @@ -31970,7 +32142,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/actions/permissions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -31994,8 +32166,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/permissions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/permissions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/permissions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/permissions
    " }, { "lang": "JavaScript", @@ -32040,7 +32212,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/actions/permissions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -32064,8 +32236,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/permissions \\\n -d '{\"enabled\":true}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/permissions \\\n  -d '{\"enabled\":true}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/permissions \\\n -d '{\"enabled\":true}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/permissions \\\n  -d '{\"enabled\":true}'
    " }, { "lang": "JavaScript", @@ -32141,7 +32313,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "descriptionHTML": "

    Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions in the repository.

    \n

    If the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as allowed_actions to selected actions, then you cannot override them for the repository.

    \n

    You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the administration repository permission to use this API.

    ", @@ -32174,7 +32346,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/actions/permissions/selected-actions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -32198,8 +32370,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/permissions/selected-actions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/permissions/selected-actions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/permissions/selected-actions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/permissions/selected-actions
    " }, { "lang": "JavaScript", @@ -32244,7 +32416,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/actions/permissions/selected-actions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -32268,8 +32440,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/permissions/selected-actions \\\n -d '{\"github_owned_allowed\":true,\"patterns_allowed\":[\"patterns_allowed\"]}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/permissions/selected-actions \\\n  -d '{\"github_owned_allowed\":true,\"patterns_allowed\":[\"patterns_allowed\"]}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/permissions/selected-actions \\\n -d '{\"github_owned_allowed\":true,\"patterns_allowed\":[\"patterns_allowed\"]}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/permissions/selected-actions \\\n  -d '{\"github_owned_allowed\":true,\"patterns_allowed\":[\"patterns_allowed\"]}'
    " }, { "lang": "JavaScript", @@ -32352,7 +32524,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "descriptionHTML": "

    Sets the actions that are allowed in a repository. To use this endpoint, the repository permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for a repository.\"

    \n

    If the repository belongs to an organization or enterprise that has selected actions set at the organization or enterprise levels, then you cannot override any of the allowed actions settings.

    \n

    To use the patterns_allowed setting for private repositories, the repository must belong to an enterprise. If the repository does not belong to an enterprise, then the patterns_allowed setting only applies to public repositories.

    \n

    You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the administration repository permission to use this API.

    ", @@ -32383,7 +32555,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/actions/runners", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -32427,8 +32599,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/runners", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/runners
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/runners", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/runners
    " }, { "lang": "JavaScript", @@ -32473,7 +32645,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/actions/runners/downloads", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -32497,8 +32669,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/runners/downloads", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/runners/downloads
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/runners/downloads", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/runners/downloads
    " }, { "lang": "JavaScript", @@ -32543,7 +32715,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/actions/runners/registration-token", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -32567,8 +32739,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/runners/registration-token", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/runners/registration-token
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/runners/registration-token", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/runners/registration-token
    " }, { "lang": "JavaScript", @@ -32613,7 +32785,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/actions/runners/remove-token", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -32637,8 +32809,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/runners/remove-token", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/runners/remove-token
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/runners/remove-token", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/runners/remove-token
    " }, { "lang": "JavaScript", @@ -32683,7 +32855,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/actions/runners/{runner_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -32717,8 +32889,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/runners/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/runners/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/runners/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/runners/42
    " }, { "lang": "JavaScript", @@ -32763,7 +32935,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/actions/runners/{runner_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -32797,8 +32969,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/runners/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/runners/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/runners/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/runners/42
    " }, { "lang": "JavaScript", @@ -32833,7 +33005,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -32842,7 +33014,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/actions/runs", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -32941,8 +33113,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/runs", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/runs
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/runs", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/runs
    " }, { "lang": "JavaScript", @@ -32987,7 +33159,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -33021,8 +33193,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/runs/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/runs/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/runs/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/runs/42
    " }, { "lang": "JavaScript", @@ -33067,7 +33239,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -33101,8 +33273,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/runs/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/runs/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/runs/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/runs/42
    " }, { "lang": "JavaScript", @@ -33137,7 +33309,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -33146,7 +33318,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/artifacts", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -33200,8 +33372,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/runs/42/artifacts", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/runs/42/artifacts
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/runs/42/artifacts", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/runs/42/artifacts
    " }, { "lang": "JavaScript", @@ -33246,7 +33418,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/cancel", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -33280,8 +33452,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/runs/42/cancel", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/runs/42/cancel
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/runs/42/cancel", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/runs/42/cancel
    " }, { "lang": "JavaScript", @@ -33325,7 +33497,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/jobs", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -33394,8 +33566,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/runs/42/jobs", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/runs/42/jobs
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/runs/42/jobs", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/runs/42/jobs
    " }, { "lang": "JavaScript", @@ -33440,7 +33612,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/logs", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -33474,8 +33646,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/runs/42/logs", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/runs/42/logs
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/runs/42/logs", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/runs/42/logs
    " }, { "lang": "JavaScript", @@ -33519,7 +33691,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/logs", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -33553,8 +33725,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/runs/42/logs", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/runs/42/logs
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/runs/42/logs", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/runs/42/logs
    " }, { "lang": "JavaScript", @@ -33589,7 +33761,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -33598,7 +33770,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -33632,8 +33804,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/runs/42/rerun", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/runs/42/rerun
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/runs/42/rerun", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/runs/42/rerun
    " }, { "lang": "JavaScript", @@ -33677,7 +33849,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/actions/secrets", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -33721,8 +33893,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/secrets", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/secrets
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/secrets", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/secrets
    " }, { "lang": "JavaScript", @@ -33767,7 +33939,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/actions/secrets/public-key", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -33791,8 +33963,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/secrets/public-key", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/secrets/public-key
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/secrets/public-key", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/secrets/public-key
    " }, { "lang": "JavaScript", @@ -33837,7 +34009,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/actions/secrets/{secret_name}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -33871,8 +34043,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/secrets/SECRET_NAME", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/secrets/SECRET_NAME
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/secrets/SECRET_NAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/secrets/SECRET_NAME
    " }, { "lang": "JavaScript", @@ -33917,7 +34089,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/actions/secrets/{secret_name}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -33951,8 +34123,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/secrets/SECRET_NAME \\\n -d '{\"encrypted_value\":\"encrypted_value\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/secrets/SECRET_NAME \\\n  -d '{\"encrypted_value\":\"encrypted_value\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/secrets/SECRET_NAME \\\n -d '{\"encrypted_value\":\"encrypted_value\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/secrets/SECRET_NAME \\\n  -d '{\"encrypted_value\":\"encrypted_value\"}'
    " }, { "lang": "JavaScript", @@ -33979,6 +34151,7 @@ "encrypted_value": { "type": "string", "description": "

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.

    ", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", "rawType": "string", @@ -33997,7 +34170,7 @@ } }, "example": { - "encrypted_value": "****************************************************************************************", + "encrypted_value": "c2VjcmV0", "key_id": "012345678912345678" } } @@ -34033,6 +34206,7 @@ { "type": "string", "description": "

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.

    ", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", "rawType": "string", @@ -34053,7 +34227,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/actions/secrets/{secret_name}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -34087,8 +34261,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/secrets/SECRET_NAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/secrets/SECRET_NAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/secrets/SECRET_NAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/secrets/SECRET_NAME
    " }, { "lang": "JavaScript", @@ -34123,7 +34297,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -34132,7 +34306,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/actions/workflows", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -34176,8 +34350,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/workflows", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/workflows
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/workflows", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/workflows
    " }, { "lang": "JavaScript", @@ -34222,7 +34396,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -34263,8 +34437,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/workflows/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/workflows/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/workflows/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/workflows/42
    " }, { "lang": "JavaScript", @@ -34309,7 +34483,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -34350,8 +34524,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/workflows/42/disable", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/workflows/42/disable
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/workflows/42/disable", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/workflows/42/disable
    " }, { "lang": "JavaScript", @@ -34386,7 +34560,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -34395,7 +34569,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -34436,8 +34610,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/workflows/42/dispatches \\\n -d '{\"ref\":\"ref\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/workflows/42/dispatches \\\n  -d '{\"ref\":\"ref\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/workflows/42/dispatches \\\n -d '{\"ref\":\"ref\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/workflows/42/dispatches \\\n  -d '{\"ref\":\"ref\"}'
    " }, { "lang": "JavaScript", @@ -34515,7 +34689,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "descriptionHTML": "

    You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace workflow_id with the workflow file name. For example, you could use main.yaml.

    \n

    You must configure your GitHub Actions workflow to run when the workflow_dispatch webhook event occurs. The inputs are configured in the workflow file. For more information about how to configure the workflow_dispatch event in the workflow file, see \"Events that trigger workflows.\"

    \n

    You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions:write permission to use this endpoint. For more information, see \"Creating a personal access token for the command line.\"

    ", @@ -34547,7 +34721,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -34588,8 +34762,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/workflows/42/enable", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/workflows/42/enable
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/workflows/42/enable", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/workflows/42/enable
    " }, { "lang": "JavaScript", @@ -34624,7 +34798,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -34633,7 +34807,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -34749,8 +34923,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/workflows/42/runs", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/workflows/42/runs
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/workflows/42/runs", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/actions/workflows/42/runs
    " }, { "lang": "JavaScript", @@ -34795,7 +34969,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/assignees", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -34839,8 +35013,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/assignees", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/assignees
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/assignees", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/assignees
    " }, { "lang": "JavaScript", @@ -34890,7 +35064,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/assignees/{assignee}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -34923,8 +35097,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/assignees/ASSIGNEE", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/assignees/ASSIGNEE
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/assignees/ASSIGNEE", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/assignees/ASSIGNEE
    " }, { "lang": "JavaScript", @@ -34973,7 +35147,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -35027,8 +35201,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches
    " }, { "lang": "JavaScript", @@ -35066,12 +35240,6 @@ "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "
    [\n  {\n    \"name\": \"master\",\n    \"commit\": {\n      \"sha\": \"c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc\",\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc\"\n    },\n    \"protected\": true\n  }\n]\n
    " - }, - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "With protection", "payload": "
    [\n  {\n    \"name\": \"master\",\n    \"commit\": {\n      \"sha\": \"c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc\",\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc\"\n    },\n    \"protected\": true,\n    \"protection\": {\n      \"enabled\": true,\n      \"required_status_checks\": {\n        \"enforcement_level\": \"non_admins\",\n        \"contexts\": [\n          \"ci-test\",\n          \"linter\"\n        ]\n      }\n    },\n    \"protection_url\": \"https://api.github.com/repos/octocat/hello-world/branches/master/protection\"\n  }\n]\n
    " }, { @@ -35084,7 +35252,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -35119,8 +35287,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH
    " }, { "lang": "JavaScript", @@ -35175,7 +35343,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -35210,8 +35378,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection
    " }, { "lang": "JavaScript", @@ -35268,7 +35436,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -35303,8 +35471,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection \\\n -d '{\"required_status_checks\":{\"strict\":true,\"contexts\":[\"contexts\"]},\"enforce_admins\":true,\"required_pull_request_reviews\":{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":42},\"restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"],\"apps\":[\"apps\"]}}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection \\\n  -d '{\"required_status_checks\":{\"strict\":true,\"contexts\":[\"contexts\"]},\"enforce_admins\":true,\"required_pull_request_reviews\":{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":42},\"restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"],\"apps\":[\"apps\"]}}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection \\\n -d '{\"required_status_checks\":{\"strict\":true,\"contexts\":[\"contexts\"]},\"enforce_admins\":true,\"required_pull_request_reviews\":{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":42},\"restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"],\"apps\":[\"apps\"]}}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection \\\n  -d '{\"required_status_checks\":{\"strict\":true,\"contexts\":[\"contexts\"]},\"enforce_admins\":true,\"required_pull_request_reviews\":{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":42},\"restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"],\"apps\":[\"apps\"]}}'
    " }, { "lang": "JavaScript", @@ -36307,7 +36475,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -36342,8 +36510,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection
    " }, { "lang": "JavaScript", @@ -36378,7 +36546,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -36392,7 +36560,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -36427,8 +36595,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins
    " }, { "lang": "JavaScript", @@ -36473,7 +36641,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -36508,8 +36676,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins
    " }, { "lang": "JavaScript", @@ -36554,7 +36722,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -36589,8 +36757,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins
    " }, { "lang": "JavaScript", @@ -36639,7 +36807,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -36674,8 +36842,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews
    " }, { "lang": "JavaScript", @@ -36726,7 +36894,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -36761,8 +36929,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews \\\n -d '{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]}}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews \\\n  -d '{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]}}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews \\\n -d '{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]}}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews \\\n  -d '{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]}}'
    " }, { "lang": "JavaScript", @@ -37032,7 +37200,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -37067,8 +37235,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews
    " }, { "lang": "JavaScript", @@ -37117,7 +37285,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -37152,8 +37320,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures
    " }, { "lang": "JavaScript", @@ -37210,7 +37378,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -37245,8 +37413,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures
    " }, { "lang": "JavaScript", @@ -37303,7 +37471,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -37338,8 +37506,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures
    " }, { "lang": "JavaScript", @@ -37395,7 +37563,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -37430,8 +37598,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks
    " }, { "lang": "JavaScript", @@ -37481,7 +37649,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -37516,8 +37684,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks \\\n -d '{\"strict\":true}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks \\\n  -d '{\"strict\":true}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks \\\n -d '{\"strict\":true}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks \\\n  -d '{\"strict\":true}'
    " }, { "lang": "JavaScript", @@ -37632,7 +37800,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -37667,8 +37835,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks
    " }, { "lang": "JavaScript", @@ -37712,7 +37880,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -37747,8 +37915,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts
    " }, { "lang": "JavaScript", @@ -37798,7 +37966,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -37833,8 +38001,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n  -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n  -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'
    " }, { "lang": "JavaScript", @@ -37939,7 +38107,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -37974,8 +38142,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n  -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n  -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'
    " }, { "lang": "JavaScript", @@ -38075,7 +38243,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -38110,8 +38278,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n  -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n  -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'
    " }, { "lang": "JavaScript", @@ -38211,7 +38379,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -38246,8 +38414,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions
    " }, { "lang": "JavaScript", @@ -38297,7 +38465,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -38332,8 +38500,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions
    " }, { "lang": "JavaScript", @@ -38377,7 +38545,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -38412,8 +38580,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps
    " }, { "lang": "JavaScript", @@ -38463,7 +38631,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -38498,8 +38666,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps \\\n -d '{\"apps\":{\"apps\":[\"apps\"]}}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps \\\n  -d '{\"apps\":{\"apps\":[\"apps\"]}}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps \\\n -d '{\"apps\":{\"apps\":[\"apps\"]}}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps \\\n  -d '{\"apps\":{\"apps\":[\"apps\"]}}'
    " }, { "lang": "JavaScript", @@ -38594,7 +38762,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -38629,8 +38797,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps \\\n -d '{\"apps\":{\"apps\":[\"apps\"]}}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps \\\n  -d '{\"apps\":{\"apps\":[\"apps\"]}}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps \\\n -d '{\"apps\":{\"apps\":[\"apps\"]}}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps \\\n  -d '{\"apps\":{\"apps\":[\"apps\"]}}'
    " }, { "lang": "JavaScript", @@ -38725,7 +38893,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -38760,8 +38928,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps \\\n -d '{\"apps\":{\"apps\":[\"apps\"]}}'", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps \\\n  -d '{\"apps\":{\"apps\":[\"apps\"]}}'
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps \\\n -d '{\"apps\":{\"apps\":[\"apps\"]}}'", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps \\\n  -d '{\"apps\":{\"apps\":[\"apps\"]}}'
    " }, { "lang": "JavaScript", @@ -38856,7 +39024,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -38891,8 +39059,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams
    " }, { "lang": "JavaScript", @@ -38942,7 +39110,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -38977,8 +39145,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n -d '{\"teams\":{\"teams\":[\"teams\"]}}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n  -d '{\"teams\":{\"teams\":[\"teams\"]}}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n -d '{\"teams\":{\"teams\":[\"teams\"]}}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n  -d '{\"teams\":{\"teams\":[\"teams\"]}}'
    " }, { "lang": "JavaScript", @@ -39073,7 +39241,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -39108,8 +39276,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n -d '{\"teams\":{\"teams\":[\"teams\"]}}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n  -d '{\"teams\":{\"teams\":[\"teams\"]}}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n -d '{\"teams\":{\"teams\":[\"teams\"]}}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n  -d '{\"teams\":{\"teams\":[\"teams\"]}}'
    " }, { "lang": "JavaScript", @@ -39204,7 +39372,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -39239,8 +39407,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n -d '{\"teams\":{\"teams\":[\"teams\"]}}'", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n  -d '{\"teams\":{\"teams\":[\"teams\"]}}'
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n -d '{\"teams\":{\"teams\":[\"teams\"]}}'", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n  -d '{\"teams\":{\"teams\":[\"teams\"]}}'
    " }, { "lang": "JavaScript", @@ -39335,7 +39503,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -39370,8 +39538,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users
    " }, { "lang": "JavaScript", @@ -39421,7 +39589,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -39456,8 +39624,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n -d '{\"users\":{\"users\":[\"users\"]}}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n  -d '{\"users\":{\"users\":[\"users\"]}}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n -d '{\"users\":{\"users\":[\"users\"]}}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n  -d '{\"users\":{\"users\":[\"users\"]}}'
    " }, { "lang": "JavaScript", @@ -39552,7 +39720,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -39587,8 +39755,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n -d '{\"users\":{\"users\":[\"users\"]}}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n  -d '{\"users\":{\"users\":[\"users\"]}}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n -d '{\"users\":{\"users\":[\"users\"]}}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n  -d '{\"users\":{\"users\":[\"users\"]}}'
    " }, { "lang": "JavaScript", @@ -39683,7 +39851,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -39718,8 +39886,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n -d '{\"users\":{\"users\":[\"users\"]}}'", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n  -d '{\"users\":{\"users\":[\"users\"]}}'
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n -d '{\"users\":{\"users\":[\"users\"]}}'", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n  -d '{\"users\":{\"users\":[\"users\"]}}'
    " }, { "lang": "JavaScript", @@ -39814,7 +39982,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/check-runs", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -39838,8 +40006,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-runs \\\n -d '{\"name\":\"name\",\"head_sha\":\"head_sha\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/check-runs \\\n  -d '{\"name\":\"name\",\"head_sha\":\"head_sha\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-runs \\\n -d '{\"name\":\"name\",\"head_sha\":\"head_sha\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-runs \\\n  -d '{\"name\":\"name\",\"head_sha\":\"head_sha\"}'
    " }, { "lang": "JavaScript", @@ -40816,7 +40984,7 @@ "name", "head_sha" ], - "anyOf": [ + "oneOf": [ { "properties": { "status": { @@ -40826,6 +40994,7 @@ } }, "required": [ + "status", "conclusion" ], "additionalProperties": true @@ -40845,7 +41014,7 @@ }, "examples": { "example-of-in-progress-conclusion": { - "summary": "Example of in_progress conclusion", + "summary": "Response for in_progress conclusion", "value": { "name": "mighty_readme", "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -40860,7 +41029,7 @@ } }, "example-of-completed-conclusion": { - "summary": "Example of completed conclusion", + "summary": "Response for completed conclusion", "value": { "name": "mighty_readme", "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -40927,12 +41096,6 @@ "notes": [], "descriptionHTML": "

    Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

    \n

    Creates a new check run for a specific commit in a repository. Your GitHub App must have the checks:write permission to create check runs.

    \n

    In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.

    ", "responses": [ - { - "httpStatusCode": "201", - "httpStatusMessage": "Created", - "description": "Response for in_progress conclusion", - "payload": "
    {\n  \"id\": 4,\n  \"head_sha\": \"ce587453ced02b1526dfb4cb910479d431683101\",\n  \"node_id\": \"MDg6Q2hlY2tSdW40\",\n  \"external_id\": \"42\",\n  \"url\": \"https://api.github.com/repos/github/hello-world/check-runs/4\",\n  \"html_url\": \"https://github.com/github/hello-world/runs/4\",\n  \"details_url\": \"https://example.com\",\n  \"status\": \"in_progress\",\n  \"conclusion\": \"neutral\",\n  \"started_at\": \"2018-05-04T01:14:52Z\",\n  \"completed_at\": null,\n  \"output\": {\n    \"title\": \"Mighty Readme Report\",\n    \"summary\": \"\",\n    \"text\": \"\",\n    \"annotations_count\": 1,\n    \"annotations_url\": \"https://api.github.com/repos/github/hello-world/check-runs/4/annotations\"\n  },\n  \"name\": \"mighty_readme\",\n  \"check_suite\": {\n    \"id\": 5\n  },\n  \"app\": {\n    \"id\": 1,\n    \"slug\": \"octoapp\",\n    \"node_id\": \"MDExOkludGVncmF0aW9uMQ==\",\n    \"owner\": {\n      \"login\": \"github\",\n      \"id\": 1,\n      \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n      \"url\": \"https://api.github.com/orgs/github\",\n      \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n      \"events_url\": \"https://api.github.com/orgs/github/events\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\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      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": true\n    },\n    \"name\": \"Octocat App\",\n    \"description\": \"\",\n    \"external_url\": \"https://example.com\",\n    \"html_url\": \"https://github.com/apps/octoapp\",\n    \"created_at\": \"2017-07-08T16:18:44-04:00\",\n    \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n    \"permissions\": {\n      \"metadata\": \"read\",\n      \"contents\": \"read\",\n      \"issues\": \"write\",\n      \"single_file\": \"write\"\n    },\n    \"events\": [\n      \"push\",\n      \"pull_request\"\n    ]\n  },\n  \"pull_requests\": [\n    {\n      \"url\": \"https://api.github.com/repos/github/hello-world/pulls/1\",\n      \"id\": 1934,\n      \"number\": 3956,\n      \"head\": {\n        \"ref\": \"say-hello\",\n        \"sha\": \"3dca65fa3e8d4b3da3f3d056c59aee1c50f41390\",\n        \"repo\": {\n          \"id\": 526,\n          \"url\": \"https://api.github.com/repos/github/hello-world\",\n          \"name\": \"hello-world\"\n        }\n      },\n      \"base\": {\n        \"ref\": \"master\",\n        \"sha\": \"e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f\",\n        \"repo\": {\n          \"id\": 526,\n          \"url\": \"https://api.github.com/repos/github/hello-world\",\n          \"name\": \"hello-world\"\n        }\n      }\n    }\n  ]\n}\n
    " - }, { "httpStatusCode": "201", "httpStatusMessage": "Created", @@ -41894,7 +42057,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/check-runs/{check_run_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -41928,8 +42091,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-runs/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/check-runs/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-runs/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-runs/42
    " }, { "lang": "JavaScript", @@ -41974,7 +42137,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/check-runs/{check_run_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -42008,8 +42171,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-runs/42 \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/check-runs/42 \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-runs/42 \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-runs/42 \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -44004,7 +44167,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/check-runs/{check_run_id}/annotations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -44058,8 +44221,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-runs/42/annotations", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/check-runs/42/annotations
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-runs/42/annotations", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-runs/42/annotations
    " }, { "lang": "JavaScript", @@ -44104,7 +44267,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/check-suites", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -44128,8 +44291,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-suites \\\n -d '{\"head_sha\":\"head_sha\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/check-suites \\\n  -d '{\"head_sha\":\"head_sha\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-suites \\\n -d '{\"head_sha\":\"head_sha\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-suites \\\n  -d '{\"head_sha\":\"head_sha\"}'
    " }, { "lang": "JavaScript", @@ -44210,7 +44373,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/check-suites/preferences", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -44234,8 +44397,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-suites/preferences \\\n -d '{\"auto_trigger_checks\":[{\"app_id\":42,\"setting\":true}]}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/check-suites/preferences \\\n  -d '{\"auto_trigger_checks\":[{\"app_id\":42,\"setting\":true}]}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-suites/preferences \\\n -d '{\"auto_trigger_checks\":[{\"app_id\":42,\"setting\":true}]}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-suites/preferences \\\n  -d '{\"auto_trigger_checks\":[{\"app_id\":42,\"setting\":true}]}'
    " }, { "lang": "JavaScript", @@ -44428,7 +44591,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/check-suites/{check_suite_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -44462,8 +44625,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-suites/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/check-suites/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-suites/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-suites/42
    " }, { "lang": "JavaScript", @@ -44508,7 +44671,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -44602,8 +44765,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-suites/42/check-runs", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/check-suites/42/check-runs
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-suites/42/check-runs", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-suites/42/check-runs
    " }, { "lang": "JavaScript", @@ -44648,7 +44811,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -44682,8 +44845,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-suites/42/rerequest", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/check-suites/42/rerequest
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-suites/42/rerequest", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/check-suites/42/rerequest
    " }, { "lang": "JavaScript", @@ -44727,7 +44890,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/code-scanning/alerts", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -44797,7 +44960,7 @@ "required": false, "schema": { "type": "string", - "description": "The full Git reference, formatted as `refs/heads/`." + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." }, "descriptionHTML": "

    The Git reference for the results you want to list. The ref for a branch can be formatted either as refs/heads/<branch name> or simply <branch name>. To reference a pull request use refs/pull/<number>/merge.

    " }, @@ -44811,6 +44974,7 @@ "description": "State of a code scanning alert.", "enum": [ "open", + "closed", "dismissed", "fixed" ] @@ -44821,8 +44985,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/code-scanning/alerts", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/code-scanning/alerts
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/code-scanning/alerts", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/code-scanning/alerts
    " }, { "lang": "JavaScript", @@ -44831,7 +44995,7 @@ } ], "summary": "List code scanning alerts for a repository", - "description": "Lists all open code scanning alerts for the default branch (usually `main`\nor `master`). You must use an access token with the `security_events` scope to use\nthis endpoint. GitHub Apps must have the `security_events` read permission to use\nthis endpoint.\n\nThe response includes a `most_recent_instance` object.\nThis provides details of the most recent instance of this alert\nfor the the default branch or for the specified Git reference\n(if you used `ref` in the request).", + "description": "Lists all open code scanning alerts for the default branch (usually `main`\nor `master`). You must use an access token with the `security_events` scope to use\nthis endpoint. GitHub Apps must have the `security_events` read permission to use\nthis endpoint.\n\nThe response includes a `most_recent_instance` object.\nThis provides details of the most recent instance of this alert\nfor the default branch or for the specified Git reference\n(if you used `ref` in the request).", "tags": [ "code-scanning" ], @@ -44852,7 +45016,7 @@ "categoryLabel": "Code scanning", "notes": [], "bodyParameters": [], - "descriptionHTML": "

    Lists all open code scanning alerts for the default branch (usually main\nor master). You must use an access token with the security_events scope to use\nthis endpoint. GitHub Apps must have the security_events read permission to use\nthis endpoint.

    \n

    The response includes a most_recent_instance object.\nThis provides details of the most recent instance of this alert\nfor the the default branch or for the specified Git reference\n(if you used ref in the request).

    ", + "descriptionHTML": "

    Lists all open code scanning alerts for the default branch (usually main\nor master). You must use an access token with the security_events scope to use\nthis endpoint. GitHub Apps must have the security_events read permission to use\nthis endpoint.

    \n

    The response includes a most_recent_instance object.\nThis provides details of the most recent instance of this alert\nfor the default branch or for the specified Git reference\n(if you used ref in the request).

    ", "responses": [ { "httpStatusCode": "200", @@ -44863,7 +45027,7 @@ { "httpStatusCode": "403", "httpStatusMessage": "Forbidden", - "description": "Response if github advanced security is not enabled for this repository" + "description": "Response if git hub advanced security is not enabled for this repository" }, { "httpStatusCode": "404", @@ -44880,7 +45044,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -44917,8 +45081,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/code-scanning/alerts/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/code-scanning/alerts/42
    " }, { "lang": "JavaScript", @@ -44959,7 +45123,7 @@ { "httpStatusCode": "403", "httpStatusMessage": "Forbidden", - "description": "Response if github advanced security is not enabled for this repository" + "description": "Response if git hub advanced security is not enabled for this repository" }, { "httpStatusCode": "404", @@ -44976,7 +45140,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -45013,8 +45177,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42 \\\n -d '{\"state\":\"state\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42 \\\n  -d '{\"state\":\"state\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/code-scanning/alerts/42 \\\n -d '{\"state\":\"state\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/code-scanning/alerts/42 \\\n  -d '{\"state\":\"state\"}'
    " }, { "lang": "JavaScript", @@ -45164,7 +45328,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/code-scanning/analyses", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -45234,7 +45398,7 @@ "required": false, "schema": { "type": "string", - "description": "The full Git reference, formatted as `refs/heads/`." + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." }, "descriptionHTML": "

    The Git reference for the analyses you want to list. The ref for a branch can be formatted either as refs/heads/<branch name> or simply <branch name>. To reference a pull request use refs/pull/<number>/merge.

    " }, @@ -45255,8 +45419,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/code-scanning/analyses", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/code-scanning/analyses
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/code-scanning/analyses", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/code-scanning/analyses
    " }, { "lang": "JavaScript", @@ -45296,7 +45460,7 @@ { "httpStatusCode": "403", "httpStatusMessage": "Forbidden", - "description": "Response if github advanced security is not enabled for this repository" + "description": "Response if git hub advanced security is not enabled for this repository" }, { "httpStatusCode": "404", @@ -45313,7 +45477,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/code-scanning/sarifs", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -45337,8 +45501,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/code-scanning/sarifs \\\n -d '{\"commit_sha\":\"commit_sha\",\"ref\":\"ref\",\"sarif\":\"sarif\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/code-scanning/sarifs \\\n  -d '{\"commit_sha\":\"commit_sha\",\"ref\":\"ref\",\"sarif\":\"sarif\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/code-scanning/sarifs \\\n -d '{\"commit_sha\":\"commit_sha\",\"ref\":\"ref\",\"sarif\":\"sarif\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/code-scanning/sarifs \\\n  -d '{\"commit_sha\":\"commit_sha\",\"ref\":\"ref\",\"sarif\":\"sarif\"}'
    " }, { "lang": "JavaScript", @@ -45347,7 +45511,7 @@ } ], "summary": "Upload an analysis as SARIF data", - "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint.\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64\n```\n\nSARIF upload supports a maximum of 1000 results per analysis run. Any results over this limit are ignored. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.\n\nThe `202 Accepted`, response includes an `id` value.\nYou can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload).\"", + "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint.\n\nThere are two places where you can upload code scanning results.\n - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see \"[Triaging code scanning alerts in pull requests](/github/finding-security-vulnerabilities-and-errors-in-your-code/triaging-code-scanning-alerts-in-pull-requests).\"\n - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see \"[Managing code scanning alerts for your repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository).\"\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64\n```\n\nSARIF upload supports a maximum of 1000 results per analysis run. Any results over this limit are ignored. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.\n\nThe `202 Accepted`, response includes an `id` value.\nYou can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload).\"", "operationId": "code-scanning/upload-sarif", "tags": [ "code-scanning" @@ -45376,11 +45540,11 @@ }, "ref": { "type": "string", - "description": "

    Required. The full Git reference, formatted as refs/heads/<branch name>.

    ", + "description": "

    Required. The full Git reference, formatted as refs/heads/<branch name>,\nrefs/pull/<number>/merge, or refs/pull/<number>/head.

    ", "name": "ref", "in": "body", "rawType": "string", - "rawDescription": "The full Git reference, formatted as `refs/heads/`.", + "rawDescription": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`.", "childParamsGroups": [] }, "sarif": { @@ -45442,7 +45606,7 @@ "category": "code-scanning", "categoryLabel": "Code scanning", "notes": [], - "descriptionHTML": "

    Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the security_events scope to use this endpoint. GitHub Apps must have the security_events write permission to use this endpoint.

    \n

    You must compress the SARIF-formatted analysis data that you want to upload, using gzip, and then encode it as a Base64 format string. For example:

    \n
    gzip -c analysis-data.sarif | base64\n
    \n

    SARIF upload supports a maximum of 1000 results per analysis run. Any results over this limit are ignored. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.

    \n

    The 202 Accepted, response includes an id value.\nYou can use this ID to check the status of the upload by using this for the /sarifs/{sarif_id} endpoint.\nFor more information, see \"Get information about a SARIF upload.\"

    ", + "descriptionHTML": "

    Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the security_events scope to use this endpoint. GitHub Apps must have the security_events write permission to use this endpoint.

    \n

    There are two places where you can upload code scanning results.

    \n\n

    You must compress the SARIF-formatted analysis data that you want to upload, using gzip, and then encode it as a Base64 format string. For example:

    \n
    gzip -c analysis-data.sarif | base64\n
    \n

    SARIF upload supports a maximum of 1000 results per analysis run. Any results over this limit are ignored. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.

    \n

    The 202 Accepted, response includes an id value.\nYou can use this ID to check the status of the upload by using this for the /sarifs/{sarif_id} endpoint.\nFor more information, see \"Get information about a SARIF upload.\"

    ", "bodyParameters": [ { "description": "

    Required. The SHA of the commit to which the analysis you are uploading relates.

    ", @@ -45458,11 +45622,11 @@ }, { "type": "string", - "description": "

    Required. The full Git reference, formatted as refs/heads/<branch name>.

    ", + "description": "

    Required. The full Git reference, formatted as refs/heads/<branch name>,\nrefs/pull/<number>/merge, or refs/pull/<number>/head.

    ", "name": "ref", "in": "body", "rawType": "string", - "rawDescription": "The full Git reference, formatted as `refs/heads/`.", + "rawDescription": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`.", "childParamsGroups": [] }, { @@ -45542,7 +45706,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/collaborators", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -45602,8 +45766,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/collaborators", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/collaborators
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/collaborators", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/collaborators
    " }, { "lang": "JavaScript", @@ -45653,7 +45817,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -45686,8 +45850,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/collaborators/USERNAME", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/collaborators/USERNAME
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/collaborators/USERNAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/collaborators/USERNAME
    " }, { "lang": "JavaScript", @@ -45736,7 +45900,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -45769,8 +45933,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/collaborators/USERNAME \\\n -d '{\"permission\":\"permission\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/collaborators/USERNAME \\\n  -d '{\"permission\":\"permission\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/collaborators/USERNAME \\\n -d '{\"permission\":\"permission\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/collaborators/USERNAME \\\n  -d '{\"permission\":\"permission\"}'
    " }, { "lang": "JavaScript", @@ -45895,7 +46059,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -45928,8 +46092,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/collaborators/USERNAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/collaborators/USERNAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/collaborators/USERNAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/collaborators/USERNAME
    " }, { "lang": "JavaScript", @@ -45964,7 +46128,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -45973,7 +46137,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/collaborators/{username}/permission", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -46006,8 +46170,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/collaborators/USERNAME/permission", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/collaborators/USERNAME/permission
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/collaborators/USERNAME/permission", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/collaborators/USERNAME/permission
    " }, { "lang": "JavaScript", @@ -46057,7 +46221,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -46101,8 +46265,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/comments", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/comments
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/comments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/comments
    " }, { "lang": "JavaScript", @@ -46154,7 +46318,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -46188,8 +46352,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/comments/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/comments/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/comments/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/comments/42
    " }, { "lang": "JavaScript", @@ -46246,7 +46410,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -46280,8 +46444,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/comments/42 \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/comments/42 \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/comments/42 \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/comments/42 \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -46367,7 +46531,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -46401,8 +46565,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/comments/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/comments/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/comments/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/comments/42
    " }, { "lang": "JavaScript", @@ -46437,7 +46601,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -46451,7 +46615,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -46525,8 +46689,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/comments/42/reactions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/comments/42/reactions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/comments/42/reactions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/comments/42/reactions
    " }, { "lang": "JavaScript", @@ -46586,7 +46750,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -46620,8 +46784,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/comments/42/reactions \\\n -d '{\"content\":\"content\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/comments/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/comments/42/reactions \\\n -d '{\"content\":\"content\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/comments/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " }, { "lang": "JavaScript", @@ -46743,7 +46907,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -46786,8 +46950,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/comments/42/reactions/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/comments/42/reactions/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/comments/42/reactions/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/comments/42/reactions/42
    " }, { "lang": "JavaScript", @@ -46827,7 +46991,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -46836,7 +47000,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/commits", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -46925,13 +47089,35 @@ "default": 1 }, "descriptionHTML": "

    Page number of the results to fetch.

    " + }, + { + "name": "top", + "description": "legacy parameter for pagination.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    legacy parameter for pagination.

    " + }, + { + "name": "last_sha", + "description": "legacy parameter for pagination.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    legacy parameter for pagination.

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/commits
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits
    " }, { "lang": "JavaScript", @@ -46996,7 +47182,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -47031,8 +47217,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.groot-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits/COMMIT_SHA/branches-where-head", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.groot-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/commits/COMMIT_SHA/branches-where-head
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.groot-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/COMMIT_SHA/branches-where-head", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.groot-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/COMMIT_SHA/branches-where-head
    " }, { "lang": "JavaScript", @@ -47094,7 +47280,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -47149,8 +47335,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits/COMMIT_SHA/comments", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/commits/COMMIT_SHA/comments
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/COMMIT_SHA/comments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/COMMIT_SHA/comments
    " }, { "lang": "JavaScript", @@ -47202,7 +47388,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -47237,8 +47423,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits/COMMIT_SHA/comments \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/commits/COMMIT_SHA/comments \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/COMMIT_SHA/comments \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/COMMIT_SHA/comments \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -47387,7 +47573,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/pulls", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -47442,8 +47628,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.groot-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits/COMMIT_SHA/pulls", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.groot-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/commits/COMMIT_SHA/pulls
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.groot-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/COMMIT_SHA/pulls", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.groot-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/COMMIT_SHA/pulls
    " }, { "lang": "JavaScript", @@ -47500,7 +47686,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/commits/{ref}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -47520,23 +47706,43 @@ }, "descriptionHTML": "" }, + { + "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.

    " + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "descriptionHTML": "

    Results per page (max 100).

    " + }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    ref+ parameter

    " + "descriptionHTML": "

    ref parameter

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits/REF", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/commits/REF
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/REF", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/REF
    " }, { "lang": "JavaScript", @@ -47596,7 +47802,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/commits/{ref}/check-runs", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -47618,14 +47824,14 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    ref+ parameter

    " + "descriptionHTML": "

    ref parameter

    " }, { "name": "check_name", @@ -47686,13 +47892,22 @@ "default": 1 }, "descriptionHTML": "

    Page number of the results to fetch.

    " + }, + { + "name": "app_id", + "in": "query", + "required": false, + "schema": { + "type": "integer" + }, + "descriptionHTML": "" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits/REF/check-runs", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/commits/REF/check-runs
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/REF/check-runs", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/REF/check-runs
    " }, { "lang": "JavaScript", @@ -47737,7 +47952,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/commits/{ref}/check-suites", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -47759,14 +47974,14 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    ref+ parameter

    " + "descriptionHTML": "

    ref parameter

    " }, { "name": "app_id", @@ -47813,8 +48028,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits/REF/check-suites", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/commits/REF/check-suites
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/REF/check-suites", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/REF/check-suites
    " }, { "lang": "JavaScript", @@ -47859,7 +48074,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/commits/{ref}/status", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -47881,21 +48096,41 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    ref+ parameter

    " + "descriptionHTML": "

    ref parameter

    " + }, + { + "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/repos/octocat/hello-world/commits/REF/status", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/commits/REF/status
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/REF/status", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/REF/status
    " }, { "lang": "JavaScript", @@ -47945,7 +48180,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/commits/{ref}/statuses", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -47967,14 +48202,14 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    ref+ parameter

    " + "descriptionHTML": "

    ref parameter

    " }, { "name": "per_page", @@ -48000,8 +48235,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits/REF/statuses", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/commits/REF/statuses
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/REF/statuses", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/commits/REF/statuses
    " }, { "lang": "JavaScript", @@ -48051,7 +48286,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/compare/{base}...{head}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -48093,8 +48328,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/compare/BASE...HEAD", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/compare/BASE...HEAD
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/compare/BASE...HEAD", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/compare/BASE...HEAD
    " }, { "lang": "JavaScript", @@ -48149,7 +48384,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/contents/{path}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -48171,14 +48406,14 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    path+ parameter

    " + "descriptionHTML": "

    path parameter

    " }, { "name": "ref", @@ -48194,8 +48429,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/contents/PATH", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/contents/PATH
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/contents/PATH", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/contents/PATH
    " }, { "lang": "JavaScript", @@ -48273,7 +48508,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/contents/{path}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -48295,21 +48530,21 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    path+ parameter

    " + "descriptionHTML": "

    path parameter

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/contents/PATH \\\n -d '{\"message\":\"message\",\"content\":\"content\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/contents/PATH \\\n  -d '{\"message\":\"message\",\"content\":\"content\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/contents/PATH \\\n -d '{\"message\":\"message\",\"content\":\"content\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/contents/PATH \\\n  -d '{\"message\":\"message\",\"content\":\"content\"}'
    " }, { "lang": "JavaScript", @@ -48796,7 +49031,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/contents/{path}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -48818,21 +49053,21 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    path+ parameter

    " + "descriptionHTML": "

    path parameter

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/contents/PATH \\\n -d '{\"message\":\"message\",\"sha\":\"sha\"}'", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/contents/PATH \\\n  -d '{\"message\":\"message\",\"sha\":\"sha\"}'
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/contents/PATH \\\n -d '{\"message\":\"message\",\"sha\":\"sha\"}'", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/contents/PATH \\\n  -d '{\"message\":\"message\",\"sha\":\"sha\"}'
    " }, { "lang": "JavaScript", @@ -49195,7 +49430,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/contributors", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -49249,8 +49484,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/contributors", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/contributors
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/contributors", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/contributors
    " }, { "lang": "JavaScript", @@ -49308,7 +49543,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/deployments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -49368,7 +49603,8 @@ "required": false, "schema": { "type": "string", - "default": "none" + "default": "none", + "nullable": true }, "descriptionHTML": "

    The name of the environment that was deployed to (e.g., staging or production).

    " }, @@ -49396,8 +49632,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/deployments", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/deployments
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/deployments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/deployments
    " }, { "lang": "JavaScript", @@ -49449,7 +49685,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/deployments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -49473,8 +49709,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/deployments \\\n -d '{\"ref\":\"ref\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/deployments \\\n  -d '{\"ref\":\"ref\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/deployments \\\n -d '{\"ref\":\"ref\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/deployments \\\n  -d '{\"ref\":\"ref\"}'
    " }, { "lang": "JavaScript", @@ -49773,12 +50009,6 @@ "description": "Simple example", "payload": "
    {\n  \"url\": \"https://api.github.com/repos/octocat/example/deployments/1\",\n  \"id\": 1,\n  \"node_id\": \"MDEwOkRlcGxveW1lbnQx\",\n  \"sha\": \"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\n  \"ref\": \"topic-branch\",\n  \"task\": \"deploy\",\n  \"payload\": {},\n  \"original_environment\": \"staging\",\n  \"environment\": \"production\",\n  \"description\": \"Deploy request from hubot\",\n  \"creator\": {\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  \"created_at\": \"2012-07-20T01:19:13Z\",\n  \"updated_at\": \"2012-07-20T01:19:13Z\",\n  \"statuses_url\": \"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/example\",\n  \"transient_environment\": false,\n  \"production_environment\": true\n}\n
    " }, - { - "httpStatusCode": "201", - "httpStatusMessage": "Created", - "description": "Advanced example", - "payload": "
    {\n  \"url\": \"https://api.github.com/repos/octocat/example/deployments/1\",\n  \"id\": 1,\n  \"node_id\": \"MDEwOkRlcGxveW1lbnQx\",\n  \"sha\": \"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\n  \"ref\": \"topic-branch\",\n  \"task\": \"deploy\",\n  \"payload\": {},\n  \"original_environment\": \"staging\",\n  \"environment\": \"production\",\n  \"description\": \"Deploy request from hubot\",\n  \"creator\": {\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  \"created_at\": \"2012-07-20T01:19:13Z\",\n  \"updated_at\": \"2012-07-20T01:19:13Z\",\n  \"statuses_url\": \"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/example\",\n  \"transient_environment\": false,\n  \"production_environment\": true\n}\n
    " - }, { "httpStatusCode": "202", "httpStatusMessage": "Accepted", @@ -49788,14 +50018,7 @@ { "httpStatusCode": "409", "httpStatusMessage": "Conflict", - "description": "Merge conflict response", - "payload": "
    {\n  \"message\": \"Conflict merging master into topic-branch\"\n}\n
    " - }, - { - "httpStatusCode": "409", - "httpStatusMessage": "Conflict", - "description": "Failed commit status checks", - "payload": "
    {\n  \"message\": \"Conflict: Commit status checks failed for topic-branch.\"\n}\n
    " + "description": "Response when there is a merge conflict or the commit s status checks failed" }, { "httpStatusCode": "422", @@ -49807,7 +50030,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -49841,8 +50064,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/deployments/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/deployments/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/deployments/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/deployments/42
    " }, { "lang": "JavaScript", @@ -49899,7 +50122,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -49933,8 +50156,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/deployments/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/deployments/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/deployments/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/deployments/42
    " }, { "lang": "JavaScript", @@ -49969,7 +50192,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -49988,7 +50211,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -50042,8 +50265,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/deployments/42/statuses", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/deployments/42/statuses
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/deployments/42/statuses", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/deployments/42/statuses
    " }, { "lang": "JavaScript", @@ -50106,7 +50329,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -50140,8 +50363,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/deployments/42/statuses \\\n -d '{\"state\":\"state\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/deployments/42/statuses \\\n  -d '{\"state\":\"state\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/deployments/42/statuses \\\n -d '{\"state\":\"state\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/deployments/42/statuses \\\n  -d '{\"state\":\"state\"}'
    " }, { "lang": "JavaScript", @@ -50387,7 +50610,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -50430,8 +50653,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/deployments/42/statuses/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/deployments/42/statuses/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/deployments/42/statuses/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/deployments/42/statuses/42
    " }, { "lang": "JavaScript", @@ -50499,7 +50722,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/dispatches", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -50523,8 +50746,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/dispatches \\\n -d '{\"event_type\":\"event_type\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/dispatches \\\n  -d '{\"event_type\":\"event_type\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/dispatches \\\n -d '{\"event_type\":\"event_type\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/dispatches \\\n  -d '{\"event_type\":\"event_type\"}'
    " }, { "lang": "JavaScript", @@ -50597,7 +50820,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "422", @@ -50631,7 +50854,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/events", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -50675,8 +50898,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/events", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/events
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/events", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/events
    " }, { "lang": "JavaScript", @@ -50720,7 +50943,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/forks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -50750,7 +50973,8 @@ "enum": [ "newest", "oldest", - "stargazers" + "stargazers", + "watchers" ], "default": "newest" }, @@ -50775,13 +50999,35 @@ "default": 1 }, "descriptionHTML": "

    Page number of the results to fetch.

    " + }, + { + "name": "org", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    legacy query parameter for specifying the org.

    " + }, + { + "name": "organization", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    legacy query parameter for specifying the org.

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/forks", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/forks
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/forks", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/forks
    " }, { "lang": "JavaScript", @@ -50831,7 +51077,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/forks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -50850,13 +51096,35 @@ "type": "string" }, "descriptionHTML": "" + }, + { + "name": "org", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    legacy query parameter for specifying the org.

    " + }, + { + "name": "organization", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    legacy query parameter for specifying the org.

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/forks \\\n -d '{\"organization\":\"organization\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/forks \\\n  -d '{\"organization\":\"organization\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/forks \\\n -d '{\"organization\":\"organization\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/forks \\\n  -d '{\"organization\":\"organization\"}'
    " }, { "lang": "JavaScript", @@ -50879,6 +51147,7 @@ "application/json": { "schema": { "type": "object", + "nullable": true, "properties": { "organization": { "type": "string", @@ -50951,7 +51220,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/git/blobs", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -50975,8 +51244,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/blobs \\\n -d '{\"content\":\"content\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/blobs \\\n  -d '{\"content\":\"content\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/blobs \\\n -d '{\"content\":\"content\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/blobs \\\n  -d '{\"content\":\"content\"}'
    " }, { "lang": "JavaScript", @@ -51098,7 +51367,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/git/blobs/{file_sha}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -51131,8 +51400,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/blobs/FILE_SHA", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/blobs/FILE_SHA
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/blobs/FILE_SHA", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/blobs/FILE_SHA
    " }, { "lang": "JavaScript", @@ -51192,7 +51461,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/git/commits", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -51216,8 +51485,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/commits \\\n -d '{\"message\":\"message\",\"tree\":\"tree\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/commits \\\n  -d '{\"message\":\"message\",\"tree\":\"tree\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/commits \\\n -d '{\"message\":\"message\",\"tree\":\"tree\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/commits \\\n  -d '{\"message\":\"message\",\"tree\":\"tree\"}'
    " }, { "lang": "JavaScript", @@ -51671,7 +51940,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/git/commits/{commit_sha}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -51706,8 +51975,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/commits/COMMIT_SHA", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/commits/COMMIT_SHA
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/commits/COMMIT_SHA", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/commits/COMMIT_SHA
    " }, { "lang": "JavaScript", @@ -51757,7 +52026,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/git/matching-refs/{ref}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -51779,14 +52048,14 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    ref+ parameter

    " + "descriptionHTML": "

    ref parameter

    " }, { "name": "per_page", @@ -51812,8 +52081,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/matching-refs/REF", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/matching-refs/REF
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/matching-refs/REF", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/matching-refs/REF
    " }, { "lang": "JavaScript", @@ -51858,7 +52127,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/git/ref/{ref}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -51880,21 +52149,21 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    ref+ parameter

    " + "descriptionHTML": "

    ref parameter

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/ref/REF", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/ref/REF
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/ref/REF", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/ref/REF
    " }, { "lang": "JavaScript", @@ -51944,7 +52213,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/git/refs", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -51968,8 +52237,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/refs \\\n -d '{\"ref\":\"ref\",\"sha\":\"sha\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/refs \\\n  -d '{\"ref\":\"ref\",\"sha\":\"sha\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/refs \\\n -d '{\"ref\":\"ref\",\"sha\":\"sha\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/refs \\\n  -d '{\"ref\":\"ref\",\"sha\":\"sha\"}'
    " }, { "lang": "JavaScript", @@ -52093,7 +52362,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/git/refs/{ref}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -52115,21 +52384,21 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    ref+ parameter

    " + "descriptionHTML": "

    ref parameter

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/refs/REF \\\n -d '{\"sha\":\"sha\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/refs/REF \\\n  -d '{\"sha\":\"sha\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/refs/REF \\\n -d '{\"sha\":\"sha\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/refs/REF \\\n  -d '{\"sha\":\"sha\"}'
    " }, { "lang": "JavaScript", @@ -52236,7 +52505,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/git/refs/{ref}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -52258,21 +52527,21 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    ref+ parameter

    " + "descriptionHTML": "

    ref parameter

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/refs/REF", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/refs/REF
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/refs/REF", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/refs/REF
    " }, { "lang": "JavaScript", @@ -52307,7 +52576,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "422", @@ -52321,7 +52590,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/git/tags", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -52345,8 +52614,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/tags \\\n -d '{\"tag\":\"tag\",\"message\":\"message\",\"object\":\"object\",\"type\":\"type\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/tags \\\n  -d '{\"tag\":\"tag\",\"message\":\"message\",\"object\":\"object\",\"type\":\"type\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/tags \\\n -d '{\"tag\":\"tag\",\"message\":\"message\",\"object\":\"object\",\"type\":\"type\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/tags \\\n  -d '{\"tag\":\"tag\",\"message\":\"message\",\"object\":\"object\",\"type\":\"type\"}'
    " }, { "lang": "JavaScript", @@ -52653,7 +52922,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/git/tags/{tag_sha}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -52686,8 +52955,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/tags/TAG_SHA", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/tags/TAG_SHA
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/tags/TAG_SHA", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/tags/TAG_SHA
    " }, { "lang": "JavaScript", @@ -52737,7 +53006,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/git/trees", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -52761,8 +53030,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/trees \\\n -d '{\"tree\":[{\"path\":\"path\",\"mode\":\"mode\",\"type\":\"type\",\"sha\":\"sha\",\"content\":\"content\"}]}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/trees \\\n  -d '{\"tree\":[{\"path\":\"path\",\"mode\":\"mode\",\"type\":\"type\",\"sha\":\"sha\",\"content\":\"content\"}]}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/trees \\\n -d '{\"tree\":[{\"path\":\"path\",\"mode\":\"mode\",\"type\":\"type\",\"sha\":\"sha\",\"content\":\"content\"}]}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/trees \\\n  -d '{\"tree\":[{\"path\":\"path\",\"mode\":\"mode\",\"type\":\"type\",\"sha\":\"sha\",\"content\":\"content\"}]}'
    " }, { "lang": "JavaScript", @@ -53142,7 +53411,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/git/trees/{tree_sha}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -53169,6 +53438,7 @@ "schema": { "type": "string" }, + "x-multi-segment": true, "descriptionHTML": "" }, { @@ -53185,8 +53455,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/trees/TREE_SHA", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/trees/TREE_SHA
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/trees/TREE_SHA", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/git/trees/TREE_SHA
    " }, { "lang": "JavaScript", @@ -53247,7 +53517,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/hooks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -53291,8 +53561,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/hooks", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/hooks
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks
    " }, { "lang": "JavaScript", @@ -53342,7 +53612,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/hooks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -53366,8 +53636,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/hooks \\\n -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"token\":\"token\",\"digest\":\"digest\"}}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/hooks \\\n  -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"token\":\"token\",\"digest\":\"digest\"}}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks \\\n -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"token\":\"token\",\"digest\":\"digest\"}}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks \\\n  -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"token\":\"token\",\"digest\":\"digest\"}}'
    " }, { "lang": "JavaScript", @@ -53803,7 +54073,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -53836,8 +54106,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/hooks/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/hooks/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks/42
    " }, { "lang": "JavaScript", @@ -53887,7 +54157,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -53920,8 +54190,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/hooks/42 \\\n -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"address\":\"address\",\"room\":\"room\"}}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/hooks/42 \\\n  -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"address\":\"address\",\"room\":\"room\"}}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks/42 \\\n -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"address\":\"address\",\"room\":\"room\"}}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks/42 \\\n  -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"address\":\"address\",\"room\":\"room\"}}'
    " }, { "lang": "JavaScript", @@ -54372,7 +54642,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -54405,8 +54675,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/hooks/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/hooks/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks/42
    " }, { "lang": "JavaScript", @@ -54441,7 +54711,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -54455,7 +54725,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}/config", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -54488,8 +54758,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/hooks/42/config", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/hooks/42/config
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks/42/config", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks/42/config
    " }, { "lang": "JavaScript", @@ -54534,7 +54804,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}/config", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -54567,8 +54837,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/hooks/42/config \\\n -d '{\"url\":\"url\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/hooks/42/config \\\n  -d '{\"url\":\"url\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks/42/config \\\n -d '{\"url\":\"url\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks/42/config \\\n  -d '{\"url\":\"url\"}'
    " }, { "lang": "JavaScript", @@ -54713,7 +54983,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}/pings", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -54746,8 +55016,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/hooks/42/pings", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/hooks/42/pings
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks/42/pings", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks/42/pings
    " }, { "lang": "JavaScript", @@ -54782,7 +55052,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -54796,7 +55066,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}/tests", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -54829,8 +55099,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/hooks/42/tests", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/hooks/42/tests
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks/42/tests", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/hooks/42/tests
    " }, { "lang": "JavaScript", @@ -54865,7 +55135,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -54879,7 +55149,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/installation", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -54903,8 +55173,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/installation", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/installation
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/installation", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/installation
    " }, { "lang": "JavaScript", @@ -54957,7 +55227,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/invitations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -55001,8 +55271,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/invitations", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/invitations
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/invitations", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/invitations
    " }, { "lang": "JavaScript", @@ -55047,7 +55317,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/invitations/{invitation_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -55081,8 +55351,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/invitations/42 \\\n -d '{\"permissions\":\"permissions\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/invitations/42 \\\n  -d '{\"permissions\":\"permissions\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/invitations/42 \\\n -d '{\"permissions\":\"permissions\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/invitations/42 \\\n  -d '{\"permissions\":\"permissions\"}'
    " }, { "lang": "JavaScript", @@ -55171,7 +55441,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/invitations/{invitation_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -55205,8 +55475,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/invitations/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/invitations/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/invitations/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/invitations/42
    " }, { "lang": "JavaScript", @@ -55241,7 +55511,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -55250,7 +55520,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -55401,8 +55671,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues
    " }, { "lang": "JavaScript", @@ -55467,7 +55737,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/issues", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -55491,8 +55761,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues \\\n -d '{\"title\":\"title\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues \\\n  -d '{\"title\":\"title\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues \\\n -d '{\"title\":\"title\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues \\\n  -d '{\"title\":\"title\"}'
    " }, { "lang": "JavaScript", @@ -55783,7 +56053,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -55866,8 +56136,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/comments", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/comments
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/comments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/comments
    " }, { "lang": "JavaScript", @@ -55929,7 +56199,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -55963,8 +56233,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/comments/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/comments/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/comments/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/comments/42
    " }, { "lang": "JavaScript", @@ -56021,7 +56291,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -56055,8 +56325,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/comments/42 \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/comments/42 \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/comments/42 \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/comments/42 \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -56142,7 +56412,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -56176,8 +56446,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/comments/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/comments/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/comments/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/comments/42
    " }, { "lang": "JavaScript", @@ -56212,7 +56482,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -56221,7 +56491,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -56295,8 +56565,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/comments/42/reactions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/comments/42/reactions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/comments/42/reactions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/comments/42/reactions
    " }, { "lang": "JavaScript", @@ -56356,7 +56626,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -56390,8 +56660,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/comments/42/reactions \\\n -d '{\"content\":\"content\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/comments/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/comments/42/reactions \\\n -d '{\"content\":\"content\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/comments/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " }, { "lang": "JavaScript", @@ -56513,7 +56783,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -56556,8 +56826,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/comments/42/reactions/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/comments/42/reactions/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/comments/42/reactions/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/comments/42/reactions/42
    " }, { "lang": "JavaScript", @@ -56597,7 +56867,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -56606,7 +56876,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/events", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -56650,8 +56920,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/events", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/events
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/events", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/events
    " }, { "lang": "JavaScript", @@ -56708,7 +56978,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/events/{event_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -56741,8 +57011,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/events/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/events/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/events/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/events/42
    " }, { "lang": "JavaScript", @@ -56809,7 +57079,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -56843,8 +57113,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42
    " }, { "lang": "JavaScript", @@ -56914,7 +57184,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -56948,8 +57218,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42 \\\n -d '{\"title\":\"title\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42 \\\n  -d '{\"title\":\"title\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42 \\\n -d '{\"title\":\"title\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42 \\\n  -d '{\"title\":\"title\"}'
    " }, { "lang": "JavaScript", @@ -57274,7 +57544,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/assignees", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -57308,8 +57578,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/assignees \\\n -d '{\"assignees\":[\"assignees\"]}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/assignees \\\n  -d '{\"assignees\":[\"assignees\"]}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/assignees \\\n -d '{\"assignees\":[\"assignees\"]}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/assignees \\\n  -d '{\"assignees\":[\"assignees\"]}'
    " }, { "lang": "JavaScript", @@ -57396,7 +57666,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/assignees", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -57430,8 +57700,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/assignees \\\n -d '{\"assignees\":[\"assignees\"]}'", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/assignees \\\n  -d '{\"assignees\":[\"assignees\"]}'
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/assignees \\\n -d '{\"assignees\":[\"assignees\"]}'", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/assignees \\\n  -d '{\"assignees\":[\"assignees\"]}'
    " }, { "lang": "JavaScript", @@ -57518,7 +57788,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -57582,8 +57852,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/comments", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/comments
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/comments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/comments
    " }, { "lang": "JavaScript", @@ -57645,7 +57915,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -57679,8 +57949,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/comments \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/comments \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/comments \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/comments \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -57782,7 +58052,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/events", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -57836,8 +58106,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/events", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/events
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/events", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/events
    " }, { "lang": "JavaScript", @@ -57894,7 +58164,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -57948,8 +58218,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/labels", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/labels
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/labels", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/labels
    " }, { "lang": "JavaScript", @@ -57999,7 +58269,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -58033,8 +58303,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/labels \\\n -d '{\"labels\":[\"labels\"]}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/labels \\\n  -d '{\"labels\":[\"labels\"]}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/labels \\\n -d '{\"labels\":[\"labels\"]}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/labels \\\n  -d '{\"labels\":[\"labels\"]}'
    " }, { "lang": "JavaScript", @@ -58134,7 +58404,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -58168,8 +58438,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/labels \\\n -d '{\"labels\":[\"labels\"]}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/labels \\\n  -d '{\"labels\":[\"labels\"]}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/labels \\\n -d '{\"labels\":[\"labels\"]}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/labels \\\n  -d '{\"labels\":[\"labels\"]}'
    " }, { "lang": "JavaScript", @@ -58266,7 +58536,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -58300,8 +58570,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/labels", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/labels
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/labels", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/labels
    " }, { "lang": "JavaScript", @@ -58336,7 +58606,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "410", @@ -58350,7 +58620,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels/{name}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -58393,8 +58663,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/labels/NAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/labels/NAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/labels/NAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/labels/NAME
    " }, { "lang": "JavaScript", @@ -58449,7 +58719,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/lock", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -58483,8 +58753,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/lock \\\n -d '{\"lock_reason\":\"lock_reason\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/lock \\\n  -d '{\"lock_reason\":\"lock_reason\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/lock \\\n -d '{\"lock_reason\":\"lock_reason\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/lock \\\n  -d '{\"lock_reason\":\"lock_reason\"}'
    " }, { "lang": "JavaScript", @@ -58544,7 +58814,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -58589,7 +58859,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/lock", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -58623,8 +58893,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/lock", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/lock
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/lock", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/lock
    " }, { "lang": "JavaScript", @@ -58657,7 +58927,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -58676,7 +58946,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -58750,8 +59020,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/reactions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/reactions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/reactions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/reactions
    " }, { "lang": "JavaScript", @@ -58816,7 +59086,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -58850,8 +59120,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/reactions \\\n -d '{\"content\":\"content\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/reactions \\\n -d '{\"content\":\"content\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " }, { "lang": "JavaScript", @@ -58967,7 +59237,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -59010,8 +59280,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/reactions/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/reactions/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/reactions/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/reactions/42
    " }, { "lang": "JavaScript", @@ -59051,7 +59321,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -59060,7 +59330,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/timeline", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -59114,8 +59384,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.mockingbird-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/timeline", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.mockingbird-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/timeline
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.mockingbird-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/timeline", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.mockingbird-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/issues/42/timeline
    " }, { "lang": "JavaScript", @@ -59188,7 +59458,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/keys", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -59232,8 +59502,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/keys", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/keys
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/keys", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/keys
    " }, { "lang": "JavaScript", @@ -59278,7 +59548,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/keys", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -59302,8 +59572,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/keys \\\n -d '{\"key\":\"key\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/keys \\\n  -d '{\"key\":\"key\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/keys \\\n -d '{\"key\":\"key\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/keys \\\n  -d '{\"key\":\"key\"}'
    " }, { "lang": "JavaScript", @@ -59427,7 +59697,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/keys/{key_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -59461,8 +59731,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/keys/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/keys/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/keys/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/keys/42
    " }, { "lang": "JavaScript", @@ -59512,7 +59782,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/keys/{key_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -59546,8 +59816,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/keys/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/keys/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/keys/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/keys/42
    " }, { "lang": "JavaScript", @@ -59582,7 +59852,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -59591,7 +59861,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/labels", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -59635,8 +59905,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/labels", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/labels
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/labels", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/labels
    " }, { "lang": "JavaScript", @@ -59686,7 +59956,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/labels", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -59710,8 +59980,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/labels \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/labels \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/labels \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/labels \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -59840,7 +60110,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/labels/{name}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -59873,8 +60143,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/labels/NAME", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/labels/NAME
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/labels/NAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/labels/NAME
    " }, { "lang": "JavaScript", @@ -59924,7 +60194,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/labels/{name}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -59957,8 +60227,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/labels/NAME \\\n -d '{\"new_name\":\"new_name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/labels/NAME \\\n  -d '{\"new_name\":\"new_name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/labels/NAME \\\n -d '{\"new_name\":\"new_name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/labels/NAME \\\n  -d '{\"new_name\":\"new_name\"}'
    " }, { "lang": "JavaScript", @@ -60074,7 +60344,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/labels/{name}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -60107,8 +60377,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/labels/NAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/labels/NAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/labels/NAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/labels/NAME
    " }, { "lang": "JavaScript", @@ -60143,7 +60413,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -60152,7 +60422,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/languages", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -60176,8 +60446,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/languages", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/languages
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/languages", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/languages
    " }, { "lang": "JavaScript", @@ -60220,7 +60490,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/license", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -60244,8 +60514,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/license", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/license
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/license", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/license
    " }, { "lang": "JavaScript", @@ -60288,7 +60558,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/merges", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -60312,8 +60582,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/merges \\\n -d '{\"base\":\"base\",\"head\":\"head\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/merges \\\n  -d '{\"base\":\"base\",\"head\":\"head\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/merges \\\n -d '{\"base\":\"base\",\"head\":\"head\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/merges \\\n  -d '{\"base\":\"base\",\"head\":\"head\"}'
    " }, { "lang": "JavaScript", @@ -60436,20 +60706,12 @@ { "httpStatusCode": "404", "httpStatusMessage": "Not Found", - "description": "Missing base response", - "payload": "
    {\n  \"message\": \"Base does not exist\"\n}\n
    " - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Missing head response", - "payload": "
    {\n  \"message\": \"Head does not exist\"\n}\n
    " + "description": "Response when the base or head does not exist" }, { "httpStatusCode": "409", "httpStatusMessage": "Conflict", - "description": "Merge conflict response", - "payload": "
    {\n  \"message\": \"Merge Conflict\"\n}\n
    " + "description": "Response when there is a merge conflict" }, { "httpStatusCode": "422", @@ -60461,7 +60723,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/milestones", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -60551,8 +60813,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/milestones", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/milestones
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/milestones", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/milestones
    " }, { "lang": "JavaScript", @@ -60602,7 +60864,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/milestones", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -60626,8 +60888,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/milestones \\\n -d '{\"title\":\"title\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/milestones \\\n  -d '{\"title\":\"title\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/milestones \\\n -d '{\"title\":\"title\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/milestones \\\n  -d '{\"title\":\"title\"}'
    " }, { "lang": "JavaScript", @@ -60785,7 +61047,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/milestones/{milestone_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -60819,8 +61081,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/milestones/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/milestones/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/milestones/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/milestones/42
    " }, { "lang": "JavaScript", @@ -60870,7 +61132,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/milestones/{milestone_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -60904,8 +61166,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/milestones/42 \\\n -d '{\"title\":\"title\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/milestones/42 \\\n  -d '{\"title\":\"title\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/milestones/42 \\\n -d '{\"title\":\"title\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/milestones/42 \\\n  -d '{\"title\":\"title\"}'
    " }, { "lang": "JavaScript", @@ -61050,7 +61312,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/milestones/{milestone_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -61084,8 +61346,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/milestones/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/milestones/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/milestones/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/milestones/42
    " }, { "lang": "JavaScript", @@ -61120,7 +61382,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -61134,7 +61396,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/milestones/{milestone_number}/labels", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -61188,8 +61450,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/milestones/42/labels", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/milestones/42/labels
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/milestones/42/labels", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/milestones/42/labels
    " }, { "lang": "JavaScript", @@ -61234,7 +61496,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/notifications", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -61320,8 +61582,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/notifications", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/notifications
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/notifications", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/notifications
    " }, { "lang": "JavaScript", @@ -61366,7 +61628,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/notifications", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -61390,8 +61652,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/notifications \\\n -d '{\"last_read_at\":\"last_read_at\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/notifications \\\n  -d '{\"last_read_at\":\"last_read_at\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/notifications \\\n -d '{\"last_read_at\":\"last_read_at\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/notifications \\\n  -d '{\"last_read_at\":\"last_read_at\"}'
    " }, { "lang": "JavaScript", @@ -61465,7 +61727,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pages", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -61489,8 +61751,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pages
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages
    " }, { "lang": "JavaScript", @@ -61540,7 +61802,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/pages", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -61564,8 +61826,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages \\\n -d '{\"source\":{\"branch\":\"branch\",\"path\":\"path\"}}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pages \\\n  -d '{\"source\":{\"branch\":\"branch\",\"path\":\"path\"}}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages \\\n -d '{\"source\":{\"branch\":\"branch\",\"path\":\"path\"}}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages \\\n  -d '{\"source\":{\"branch\":\"branch\",\"path\":\"path\"}}'
    " }, { "lang": "JavaScript", @@ -61790,7 +62052,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/pages", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -61814,8 +62076,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages \\\n -d '{\"source\":\"source\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pages \\\n  -d '{\"source\":\"source\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages \\\n -d '{\"source\":\"source\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages \\\n  -d '{\"source\":\"source\"}'
    " }, { "lang": "JavaScript", @@ -61929,7 +62191,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "400", @@ -62007,7 +62269,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/pages", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -62031,8 +62293,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pages
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages
    " }, { "lang": "JavaScript", @@ -62074,7 +62336,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -62098,7 +62360,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pages/builds", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -62142,8 +62404,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages/builds", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pages/builds
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages/builds", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages/builds
    " }, { "lang": "JavaScript", @@ -62188,7 +62450,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/pages/builds", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -62212,8 +62474,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages/builds", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pages/builds
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages/builds", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages/builds
    " }, { "lang": "JavaScript", @@ -62258,7 +62520,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pages/builds/latest", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -62282,8 +62544,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages/builds/latest", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pages/builds/latest
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages/builds/latest", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages/builds/latest
    " }, { "lang": "JavaScript", @@ -62328,7 +62590,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pages/builds/{build_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -62361,8 +62623,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages/builds/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pages/builds/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages/builds/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages/builds/42
    " }, { "lang": "JavaScript", @@ -62407,7 +62669,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -62446,13 +62708,43 @@ "default": 1 }, "descriptionHTML": "

    Page number of the results to fetch.

    " + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + }, + "descriptionHTML": "

    One of asc (ascending) or desc (descending).

    " + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + }, + "descriptionHTML": "" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pre-receive-hooks", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pre-receive-hooks
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pre-receive-hooks", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pre-receive-hooks
    " }, { "lang": "JavaScript", @@ -62504,7 +62796,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -62537,8 +62829,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pre-receive-hooks/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pre-receive-hooks/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pre-receive-hooks/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pre-receive-hooks/42
    " }, { "lang": "JavaScript", @@ -62590,7 +62882,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -62623,8 +62915,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pre-receive-hooks/42 \\\n -d '{\"enforcement\":\"enforcement\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pre-receive-hooks/42 \\\n  -d '{\"enforcement\":\"enforcement\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pre-receive-hooks/42 \\\n -d '{\"enforcement\":\"enforcement\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pre-receive-hooks/42 \\\n  -d '{\"enforcement\":\"enforcement\"}'
    " }, { "lang": "JavaScript", @@ -62709,7 +63001,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -62742,8 +63034,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pre-receive-hooks/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pre-receive-hooks/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pre-receive-hooks/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pre-receive-hooks/42
    " }, { "lang": "JavaScript", @@ -62795,7 +63087,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/projects", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -62855,8 +63147,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/projects", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/projects
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/projects", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/projects
    " }, { "lang": "JavaScript", @@ -62931,7 +63223,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/projects", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -62955,8 +63247,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/projects \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/projects \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/projects \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/projects \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -63086,7 +63378,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -63197,8 +63489,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls
    " }, { "lang": "JavaScript", @@ -63251,7 +63543,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/pulls", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -63275,8 +63567,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls \\\n -d '{\"head\":\"head\",\"base\":\"base\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls \\\n  -d '{\"head\":\"head\",\"base\":\"base\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls \\\n -d '{\"head\":\"head\",\"base\":\"base\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls \\\n  -d '{\"head\":\"head\",\"base\":\"base\"}'
    " }, { "lang": "JavaScript", @@ -63478,7 +63770,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -63500,18 +63792,17 @@ }, { "name": "sort", - "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to).", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "created", - "updated" - ], - "default": "created" + "updated", + "created_at" + ] }, - "descriptionHTML": "

    One of created (when the repository was starred) or updated (when it was last pushed to).

    " + "descriptionHTML": "" }, { "name": "direction", @@ -63561,8 +63852,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/comments", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/comments
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/comments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/comments
    " }, { "lang": "JavaScript", @@ -63620,7 +63911,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -63654,8 +63945,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/comments/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/comments/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/comments/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/comments/42
    " }, { "lang": "JavaScript", @@ -63718,7 +64009,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -63752,8 +64043,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/comments/42 \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/comments/42 \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/comments/42 \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/comments/42 \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -63841,7 +64132,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -63875,8 +64166,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/comments/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/comments/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/comments/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/comments/42
    " }, { "lang": "JavaScript", @@ -63911,7 +64202,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -63925,7 +64216,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -63999,8 +64290,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/comments/42/reactions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/comments/42/reactions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/comments/42/reactions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/comments/42/reactions
    " }, { "lang": "JavaScript", @@ -64060,7 +64351,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -64094,8 +64385,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/comments/42/reactions \\\n -d '{\"content\":\"content\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/comments/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/comments/42/reactions \\\n -d '{\"content\":\"content\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/comments/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " }, { "lang": "JavaScript", @@ -64217,7 +64508,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -64260,8 +64551,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/comments/42/reactions/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/comments/42/reactions/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/comments/42/reactions/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/comments/42/reactions/42
    " }, { "lang": "JavaScript", @@ -64301,7 +64592,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -64310,7 +64601,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -64343,8 +64634,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42
    " }, { "lang": "JavaScript", @@ -64402,7 +64693,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -64435,8 +64726,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42 \\\n -d '{\"title\":\"title\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42 \\\n  -d '{\"title\":\"title\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42 \\\n -d '{\"title\":\"title\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42 \\\n  -d '{\"title\":\"title\"}'
    " }, { "lang": "JavaScript", @@ -64605,7 +64896,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -64697,8 +64988,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/comments", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/comments
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/comments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/comments
    " }, { "lang": "JavaScript", @@ -64756,7 +65047,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -64789,8 +65080,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/comments \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/comments \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/comments \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/comments \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -65072,7 +65363,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -65115,8 +65406,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/comments/42/replies \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/comments/42/replies \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/comments/42/replies \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/comments/42/replies \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -65203,7 +65494,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/commits", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -65256,8 +65547,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/commits", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/commits
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/commits", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/commits
    " }, { "lang": "JavaScript", @@ -65300,7 +65591,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/files", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -65353,8 +65644,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/files", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/files
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/files", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/files
    " }, { "lang": "JavaScript", @@ -65407,7 +65698,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/merge", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -65440,8 +65731,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/merge", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/merge
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/merge", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/merge
    " }, { "lang": "JavaScript", @@ -65488,7 +65779,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/merge", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -65521,8 +65812,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/merge \\\n -d '{\"commit_title\":\"commit_title\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/merge \\\n  -d '{\"commit_title\":\"commit_title\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/merge \\\n -d '{\"commit_title\":\"commit_title\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/merge \\\n  -d '{\"commit_title\":\"commit_title\"}'
    " }, { "lang": "JavaScript", @@ -65688,7 +65979,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -65741,8 +66032,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/requested_reviewers", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/requested_reviewers
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/requested_reviewers", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/requested_reviewers
    " }, { "lang": "JavaScript", @@ -65787,7 +66078,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -65820,8 +66111,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/requested_reviewers \\\n -d '{\"reviewers\":[\"reviewers\"]}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/requested_reviewers \\\n  -d '{\"reviewers\":[\"reviewers\"]}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/requested_reviewers \\\n -d '{\"reviewers\":[\"reviewers\"]}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/requested_reviewers \\\n  -d '{\"reviewers\":[\"reviewers\"]}'
    " }, { "lang": "JavaScript", @@ -65959,7 +66250,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -65992,8 +66283,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/requested_reviewers \\\n -d '{\"reviewers\":[\"reviewers\"]}'", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/requested_reviewers \\\n  -d '{\"reviewers\":[\"reviewers\"]}'
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/requested_reviewers \\\n -d '{\"reviewers\":[\"reviewers\"]}'", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/requested_reviewers \\\n  -d '{\"reviewers\":[\"reviewers\"]}'
    " }, { "lang": "JavaScript", @@ -66115,7 +66406,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -66168,8 +66459,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/reviews
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews
    " }, { "lang": "JavaScript", @@ -66214,7 +66505,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -66247,8 +66538,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews \\\n -d '{\"commit_id\":\"commit_id\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/reviews \\\n  -d '{\"commit_id\":\"commit_id\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews \\\n -d '{\"commit_id\":\"commit_id\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews \\\n  -d '{\"commit_id\":\"commit_id\"}'
    " }, { "lang": "JavaScript", @@ -66696,7 +66987,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -66739,8 +67030,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews/42
    " }, { "lang": "JavaScript", @@ -66790,7 +67081,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -66833,8 +67124,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42 \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42 \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews/42 \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews/42 \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -66920,7 +67211,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -66963,8 +67254,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews/42
    " }, { "lang": "JavaScript", @@ -67019,7 +67310,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -67082,8 +67373,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42/comments", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42/comments
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews/42/comments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews/42/comments
    " }, { "lang": "JavaScript", @@ -67133,7 +67424,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -67176,8 +67467,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42/dismissals \\\n -d '{\"message\":\"message\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42/dismissals \\\n  -d '{\"message\":\"message\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews/42/dismissals \\\n -d '{\"message\":\"message\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews/42/dismissals \\\n  -d '{\"message\":\"message\"}'
    " }, { "lang": "JavaScript", @@ -67283,7 +67574,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -67326,8 +67617,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42/events \\\n -d '{\"event\":\"event\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42/events \\\n  -d '{\"event\":\"event\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews/42/events \\\n -d '{\"event\":\"event\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/reviews/42/events \\\n  -d '{\"event\":\"event\"}'
    " }, { "lang": "JavaScript", @@ -67448,7 +67739,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/update-branch", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -67481,8 +67772,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.lydian-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/update-branch \\\n -d '{\"expected_head_sha\":\"expected_head_sha\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.lydian-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/update-branch \\\n  -d '{\"expected_head_sha\":\"expected_head_sha\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.lydian-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/update-branch \\\n -d '{\"expected_head_sha\":\"expected_head_sha\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.lydian-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/pulls/42/update-branch \\\n  -d '{\"expected_head_sha\":\"expected_head_sha\"}'
    " }, { "lang": "JavaScript", @@ -67581,7 +67872,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/readme", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -67615,8 +67906,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/readme", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/readme
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/readme", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/readme
    " }, { "lang": "JavaScript", @@ -67668,10 +67959,111 @@ } ] }, + { + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/readme/{dir}", + "serverUrl": "http(s)://{hostname}/api/v3", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "dir", + "description": "The alternate path to look for a README file", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true, + "descriptionHTML": "

    The alternate path to look for a README file

    " + }, + { + "name": "ref", + "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    The name of the commit/branch/tag. Default: the repository’s default branch (usually master)

    " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/readme/DIR", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/readme/DIR
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /repos/{owner}/{repo}/readme/{dir}', {\n owner: 'octocat',\n repo: 'hello-world',\n dir: 'dir'\n})", + "html": "
    await octokit.request('GET /repos/{owner}/{repo}/readme/{dir}', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  dir: 'dir'\n})\n
    " + } + ], + "summary": "Get a repository README", + "description": "Gets the preferred README for a repository.\n\nREADMEs support [custom media types](https://docs.github.com/enterprise-server@3.0/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML.", + "tags": [ + "repos" + ], + "operationId": "repos/get-readme-from-alt-path", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#get-a-repository-readme" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "contents" + }, + "slug": "get-a-repository-readme", + "category": "repos", + "categoryLabel": "Repos", + "subcategory": "contents", + "subcategoryLabel": "Contents", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

    Gets the preferred README for a repository.

    \n

    READMEs support custom media types for retrieving the raw content or rendered HTML.

    ", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
    {\n  \"type\": \"file\",\n  \"encoding\": \"base64\",\n  \"size\": 5362,\n  \"name\": \"README.md\",\n  \"path\": \"README.md\",\n  \"content\": \"encoded content ...\",\n  \"sha\": \"3d21ec53a331a6f037a91c368710b99387d012c1\",\n  \"url\": \"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\n  \"git_url\": \"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\n  \"html_url\": \"https://github.com/octokit/octokit.rb/blob/master/README.md\",\n  \"download_url\": \"https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md\",\n  \"_links\": {\n    \"git\": \"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\n    \"self\": \"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\n    \"html\": \"https://github.com/octokit/octokit.rb/blob/master/README.md\"\n  }\n}\n
    " + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + } + ] + }, { "verb": "get", "requestPath": "/repos/{owner}/{repo}/releases", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -67715,8 +68107,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases
    " }, { "lang": "JavaScript", @@ -67766,7 +68158,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/releases", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -67790,8 +68182,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases \\\n -d '{\"tag_name\":\"tag_name\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases \\\n  -d '{\"tag_name\":\"tag_name\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases \\\n -d '{\"tag_name\":\"tag_name\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases \\\n  -d '{\"tag_name\":\"tag_name\"}'
    " }, { "lang": "JavaScript", @@ -67977,7 +68369,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/releases/assets/{asset_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -68011,8 +68403,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/assets/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases/assets/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/assets/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/assets/42
    " }, { "lang": "JavaScript", @@ -68072,7 +68464,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/releases/assets/{asset_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -68106,8 +68498,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/assets/42 \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases/assets/42 \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/assets/42 \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/assets/42 \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -68222,7 +68614,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/releases/assets/{asset_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -68256,8 +68648,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/assets/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases/assets/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/assets/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/assets/42
    " }, { "lang": "JavaScript", @@ -68292,7 +68684,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -68301,7 +68693,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/releases/latest", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -68325,8 +68717,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/latest", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases/latest
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/latest", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/latest
    " }, { "lang": "JavaScript", @@ -68371,7 +68763,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/releases/tags/{tag}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -68393,21 +68785,21 @@ }, { "name": "tag", - "description": "tag+ parameter", + "description": "tag parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    tag+ parameter

    " + "descriptionHTML": "

    tag parameter

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/tags/TAG", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases/tags/TAG
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/tags/TAG", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/tags/TAG
    " }, { "lang": "JavaScript", @@ -68457,7 +68849,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/releases/{release_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -68491,8 +68883,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/42
    " }, { "lang": "JavaScript", @@ -68542,7 +68934,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/releases/{release_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -68576,8 +68968,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/42 \\\n -d '{\"tag_name\":\"tag_name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases/42 \\\n  -d '{\"tag_name\":\"tag_name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/42 \\\n -d '{\"tag_name\":\"tag_name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/42 \\\n  -d '{\"tag_name\":\"tag_name\"}'
    " }, { "lang": "JavaScript", @@ -68750,7 +69142,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/releases/{release_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -68784,8 +69176,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/42
    " }, { "lang": "JavaScript", @@ -68820,7 +69212,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -68829,7 +69221,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/releases/{release_id}/assets", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -68883,8 +69275,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/42/assets", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases/42/assets
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/42/assets", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/42/assets
    " }, { "lang": "JavaScript", @@ -68929,7 +69321,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/releases/{release_id}/assets", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -68979,8 +69371,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/42/assets", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases/42/assets
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/42/assets", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/releases/42/assets
    " }, { "lang": "JavaScript", @@ -69046,7 +69438,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/stargazers", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -69090,8 +69482,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/stargazers", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/stargazers
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/stargazers", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/stargazers
    " }, { "lang": "JavaScript", @@ -69141,7 +69533,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/stats/code_frequency", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -69165,8 +69557,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/stats/code_frequency", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/stats/code_frequency
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/stats/code_frequency", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/stats/code_frequency
    " }, { "lang": "JavaScript", @@ -69211,7 +69603,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/stats/commit_activity", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -69235,8 +69627,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/stats/commit_activity", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/stats/commit_activity
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/stats/commit_activity", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/stats/commit_activity
    " }, { "lang": "JavaScript", @@ -69281,7 +69673,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/stats/contributors", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -69305,8 +69697,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/stats/contributors", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/stats/contributors
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/stats/contributors", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/stats/contributors
    " }, { "lang": "JavaScript", @@ -69351,7 +69743,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/stats/participation", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -69375,8 +69767,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/stats/participation", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/stats/participation
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/stats/participation", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/stats/participation
    " }, { "lang": "JavaScript", @@ -69426,7 +69818,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/stats/punch_card", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -69450,8 +69842,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/stats/punch_card", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/stats/punch_card
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/stats/punch_card", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/stats/punch_card
    " }, { "lang": "JavaScript", @@ -69496,7 +69888,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/statuses/{sha}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -69530,8 +69922,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/statuses/SHA \\\n -d '{\"state\":\"state\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/statuses/SHA \\\n  -d '{\"state\":\"state\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/statuses/SHA \\\n -d '{\"state\":\"state\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/statuses/SHA \\\n  -d '{\"state\":\"state\"}'
    " }, { "lang": "JavaScript", @@ -69683,7 +70075,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/subscribers", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -69727,8 +70119,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/subscribers", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/subscribers
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/subscribers", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/subscribers
    " }, { "lang": "JavaScript", @@ -69773,7 +70165,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/subscription", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -69797,8 +70189,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/subscription", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/subscription
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/subscription", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/subscription
    " }, { "lang": "JavaScript", @@ -69853,7 +70245,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/subscription", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -69877,8 +70269,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/subscription \\\n -d '{\"subscribed\":true}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/subscription \\\n  -d '{\"subscribed\":true}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/subscription \\\n -d '{\"subscribed\":true}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/subscription \\\n  -d '{\"subscribed\":true}'
    " }, { "lang": "JavaScript", @@ -69971,7 +70363,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/subscription", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -69995,8 +70387,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/subscription", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/subscription
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/subscription", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/subscription
    " }, { "lang": "JavaScript", @@ -70031,7 +70423,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -70040,7 +70432,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/tags", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -70084,8 +70476,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/tags", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/tags
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/tags", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/tags
    " }, { "lang": "JavaScript", @@ -70128,7 +70520,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/tarball/{ref}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -70161,8 +70553,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/tarball/REF", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/tarball/REF
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/tarball/REF", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/tarball/REF
    " }, { "lang": "JavaScript", @@ -70206,7 +70598,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/teams", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -70250,8 +70642,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/teams", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/teams
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/teams", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/teams
    " }, { "lang": "JavaScript", @@ -70294,7 +70686,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/topics", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -70313,13 +70705,33 @@ "type": "string" }, "descriptionHTML": "" + }, + { + "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.

    " + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "descriptionHTML": "

    Results per page (max 100).

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/topics", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/topics
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/topics", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/topics
    " }, { "lang": "JavaScript", @@ -70379,7 +70791,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/topics", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -70403,8 +70815,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/topics \\\n -d '{\"names\":[\"names\"]}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/topics \\\n  -d '{\"names\":[\"names\"]}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/topics \\\n -d '{\"names\":[\"names\"]}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/topics \\\n  -d '{\"names\":[\"names\"]}'
    " }, { "lang": "JavaScript", @@ -70516,7 +70928,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/transfer", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -70540,8 +70952,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/transfer \\\n -d '{\"new_owner\":\"new_owner\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/transfer \\\n  -d '{\"new_owner\":\"new_owner\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/transfer \\\n -d '{\"new_owner\":\"new_owner\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/transfer \\\n  -d '{\"new_owner\":\"new_owner\"}'
    " }, { "lang": "JavaScript", @@ -70648,7 +71060,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/vulnerability-alerts", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -70672,8 +71084,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/vulnerability-alerts", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/vulnerability-alerts
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/vulnerability-alerts", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/vulnerability-alerts
    " }, { "lang": "JavaScript", @@ -70713,7 +71125,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -70722,7 +71134,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/vulnerability-alerts", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -70746,8 +71158,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/vulnerability-alerts", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/vulnerability-alerts
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/vulnerability-alerts", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/vulnerability-alerts
    " }, { "lang": "JavaScript", @@ -70787,7 +71199,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -70796,7 +71208,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/zipball/{ref}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -70829,8 +71241,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/zipball/REF", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/zipball/REF
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/zipball/REF", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/zipball/REF
    " }, { "lang": "JavaScript", @@ -70874,7 +71286,7 @@ { "verb": "post", "requestPath": "/repos/{template_owner}/{template_repo}/generate", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "template_owner", @@ -70898,8 +71310,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.baptiste-preview+json\" \\\n https://api.github.com/repos/TEMPLATE_OWNER/TEMPLATE_REPO/generate \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.baptiste-preview+json\" \\\n  https://api.github.com/repos/TEMPLATE_OWNER/TEMPLATE_REPO/generate \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.baptiste-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/TEMPLATE_OWNER/TEMPLATE_REPO/generate \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.baptiste-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/TEMPLATE_OWNER/TEMPLATE_REPO/generate \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -70908,7 +71320,7 @@ } ], "summary": "Create a repository using a template", - "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@3.0/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", + "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@3.0/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository", "tags": [ "repos" ], @@ -71003,7 +71415,7 @@ "category": "repos", "categoryLabel": "Repos", "notes": [], - "descriptionHTML": "

    Creates a new repository using a repository template. Use the template_owner and template_repo route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the Get a repository endpoint and check that the is_template key is true.

    \n

    OAuth scope requirements

    \n

    When using OAuth, authorizations must include:

    \n
      \n
    • public_repo scope or repo scope to create a public repository
    • \n
    • repo scope to create a private repository
    • \n
    ", + "descriptionHTML": "

    Creates a new repository using a repository template. Use the template_owner and template_repo route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the Get a repository endpoint and check that the is_template key is true.

    \n

    OAuth scope requirements

    \n

    When using OAuth, authorizations must include:

    \n
      \n
    • public_repo scope or repo scope to create a public repository. Note: For GitHub AE, use repo scope to create an internal repository.
    • \n
    • repo scope to create a private repository
    • \n
    ", "bodyParameters": [ { "type": "string", @@ -71065,7 +71477,7 @@ { "verb": "get", "requestPath": "/repositories", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "since", @@ -71079,7 +71491,7 @@ }, { "name": "visibility", - "description": "Specifies the types of repositories to return. Can be one of `all` or `public`. Default: `public`.", + "description": "Specifies the types of repositories to return. Can be one of `all` or `public`. Default: `public`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise.", "in": "query", "required": false, "schema": { @@ -71091,14 +71503,14 @@ "public" ] }, - "descriptionHTML": "

    Specifies the types of repositories to return. Can be one of all or public. Default: public.

    " + "descriptionHTML": "

    Specifies the types of repositories to return. Can be one of all or public. Default: public. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise.

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repositories", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repositories
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repositories", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repositories
    " }, { "lang": "JavaScript", @@ -71107,7 +71519,7 @@ } ], "summary": "List public repositories", - "description": "Lists all public repositories in the order that they were created.\n\nNote: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.0/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.", + "description": "Lists all public repositories in the order that they were created.\n\nNotes:\n- For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise.\n- Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.0/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.", "tags": [ "repos" ], @@ -71128,7 +71540,7 @@ "categoryLabel": "Repos", "notes": [], "bodyParameters": [], - "descriptionHTML": "

    Lists all public repositories in the order that they were created.

    \n

    Note: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of repositories.

    ", + "descriptionHTML": "

    Lists all public repositories in the order that they were created.

    \n

    Notes:

    \n
      \n
    • For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise.
    • \n
    • Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of repositories.
    • \n
    ", "responses": [ { "httpStatusCode": "200", @@ -71151,7 +71563,7 @@ { "verb": "get", "requestPath": "/search/code", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "q", @@ -71215,8 +71627,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/search/code", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/search/code
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/search/code", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/search/code
    " }, { "lang": "JavaScript", @@ -71279,7 +71691,7 @@ { "verb": "get", "requestPath": "/search/commits", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "q", @@ -71344,8 +71756,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.cloak-preview+json\" \\\n https://api.github.com/search/commits", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.cloak-preview+json\" \\\n  https://api.github.com/search/commits
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.cloak-preview+json\" \\\n http(s)://{hostname}/api/v3/search/commits", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.cloak-preview+json\" \\\n  http(s)://{hostname}/api/v3/search/commits
    " }, { "lang": "JavaScript", @@ -71405,7 +71817,7 @@ { "verb": "get", "requestPath": "/search/issues", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "q", @@ -71479,8 +71891,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/search/issues", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/search/issues
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/search/issues", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/search/issues
    " }, { "lang": "JavaScript", @@ -71543,7 +71955,7 @@ { "verb": "get", "requestPath": "/search/labels", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "repository_id", @@ -71598,8 +72010,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/search/labels", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/search/labels
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/search/labels", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/search/labels
    " }, { "lang": "JavaScript", @@ -71662,7 +72074,7 @@ { "verb": "get", "requestPath": "/search/repositories", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "q", @@ -71729,8 +72141,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/search/repositories", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/search/repositories
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/search/repositories", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/search/repositories
    " }, { "lang": "JavaScript", @@ -71795,7 +72207,7 @@ { "verb": "get", "requestPath": "/search/topics", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "q", @@ -71811,8 +72223,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n https://api.github.com/search/topics", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n  https://api.github.com/search/topics
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n http(s)://{hostname}/api/v3/search/topics", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n  http(s)://{hostname}/api/v3/search/topics
    " }, { "lang": "JavaScript", @@ -71872,7 +72284,7 @@ { "verb": "get", "requestPath": "/search/users", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "q", @@ -71938,8 +72350,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/search/users", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/search/users
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/search/users", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/search/users
    " }, { "lang": "JavaScript", @@ -71997,13 +72409,13 @@ { "verb": "get", "requestPath": "/setup/api/configcheck", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/configcheck", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/setup/api/configcheck
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/setup/api/configcheck", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/setup/api/configcheck
    " }, { "lang": "JavaScript", @@ -72048,13 +72460,13 @@ { "verb": "post", "requestPath": "/setup/api/configure", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/configure", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/setup/api/configure
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/setup/api/configure", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/setup/api/configure
    " }, { "lang": "JavaScript", @@ -72098,13 +72510,13 @@ { "verb": "get", "requestPath": "/setup/api/maintenance", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/maintenance", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/setup/api/maintenance
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/setup/api/maintenance", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/setup/api/maintenance
    " }, { "lang": "JavaScript", @@ -72149,13 +72561,13 @@ { "verb": "post", "requestPath": "/setup/api/maintenance", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/maintenance \\\n -d '{\"maintenance\":\"maintenance\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/setup/api/maintenance \\\n  -d '{\"maintenance\":\"maintenance\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/setup/api/maintenance \\\n -d '{\"maintenance\":\"maintenance\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/setup/api/maintenance \\\n  -d '{\"maintenance\":\"maintenance\"}'
    " }, { "lang": "JavaScript", @@ -72233,13 +72645,13 @@ { "verb": "get", "requestPath": "/setup/api/settings", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/settings", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/setup/api/settings
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/setup/api/settings", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/setup/api/settings
    " }, { "lang": "JavaScript", @@ -72284,13 +72696,13 @@ { "verb": "put", "requestPath": "/setup/api/settings", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/settings \\\n -d '{\"settings\":\"settings\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/setup/api/settings \\\n  -d '{\"settings\":\"settings\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/setup/api/settings \\\n -d '{\"settings\":\"settings\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/setup/api/settings \\\n  -d '{\"settings\":\"settings\"}'
    " }, { "lang": "JavaScript", @@ -72348,7 +72760,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "descriptionHTML": "

    For a list of the available settings, see the Get settings endpoint.

    ", @@ -72367,13 +72779,13 @@ { "verb": "get", "requestPath": "/setup/api/settings/authorized-keys", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/settings/authorized-keys", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/setup/api/settings/authorized-keys
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/setup/api/settings/authorized-keys", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/setup/api/settings/authorized-keys
    " }, { "lang": "JavaScript", @@ -72418,13 +72830,13 @@ { "verb": "post", "requestPath": "/setup/api/settings/authorized-keys", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/settings/authorized-keys \\\n -d '{\"authorized_key\":\"authorized_key\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/setup/api/settings/authorized-keys \\\n  -d '{\"authorized_key\":\"authorized_key\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/setup/api/settings/authorized-keys \\\n -d '{\"authorized_key\":\"authorized_key\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/setup/api/settings/authorized-keys \\\n  -d '{\"authorized_key\":\"authorized_key\"}'
    " }, { "lang": "JavaScript", @@ -72502,13 +72914,13 @@ { "verb": "delete", "requestPath": "/setup/api/settings/authorized-keys", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/settings/authorized-keys \\\n -d '{\"authorized_key\":\"authorized_key\"}'", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/setup/api/settings/authorized-keys \\\n  -d '{\"authorized_key\":\"authorized_key\"}'
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/setup/api/settings/authorized-keys \\\n -d '{\"authorized_key\":\"authorized_key\"}'", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/setup/api/settings/authorized-keys \\\n  -d '{\"authorized_key\":\"authorized_key\"}'
    " }, { "lang": "JavaScript", @@ -72586,13 +72998,13 @@ { "verb": "post", "requestPath": "/setup/api/start", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/start \\\n -d '{\"license\":\"license\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/setup/api/start \\\n  -d '{\"license\":\"license\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/setup/api/start \\\n -d '{\"license\":\"license\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/setup/api/start \\\n  -d '{\"license\":\"license\"}'
    " }, { "lang": "JavaScript", @@ -72705,13 +73117,13 @@ { "verb": "post", "requestPath": "/setup/api/upgrade", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/upgrade \\\n -d '{\"license\":\"license\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/setup/api/upgrade \\\n  -d '{\"license\":\"license\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/setup/api/upgrade \\\n -d '{\"license\":\"license\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/setup/api/upgrade \\\n  -d '{\"license\":\"license\"}'
    " }, { "lang": "JavaScript", @@ -72785,7 +73197,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -72800,8 +73212,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42
    " }, { "lang": "JavaScript", @@ -72852,7 +73264,7 @@ { "verb": "patch", "requestPath": "/teams/{team_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -72867,8 +73279,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42 \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42 \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42 \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42 \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -73061,7 +73473,7 @@ { "verb": "delete", "requestPath": "/teams/{team_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -73076,8 +73488,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42
    " }, { "lang": "JavaScript", @@ -73113,7 +73525,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -73132,7 +73544,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/discussions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -73182,8 +73594,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/discussions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions
    " }, { "lang": "JavaScript", @@ -73238,7 +73650,7 @@ { "verb": "post", "requestPath": "/teams/{team_id}/discussions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -73253,8 +73665,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions \\\n -d '{\"title\":\"title\",\"body\":\"body\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/discussions \\\n  -d '{\"title\":\"title\",\"body\":\"body\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions \\\n -d '{\"title\":\"title\",\"body\":\"body\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions \\\n  -d '{\"title\":\"title\",\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -73386,7 +73798,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/discussions/{discussion_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -73410,8 +73822,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/discussions/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions/42
    " }, { "lang": "JavaScript", @@ -73466,7 +73878,7 @@ { "verb": "patch", "requestPath": "/teams/{team_id}/discussions/{discussion_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -73490,8 +73902,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions/42 \\\n -d '{\"title\":\"title\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/discussions/42 \\\n  -d '{\"title\":\"title\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions/42 \\\n -d '{\"title\":\"title\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions/42 \\\n  -d '{\"title\":\"title\"}'
    " }, { "lang": "JavaScript", @@ -73597,7 +74009,7 @@ { "verb": "delete", "requestPath": "/teams/{team_id}/discussions/{discussion_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -73621,8 +74033,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/discussions/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions/42
    " }, { "lang": "JavaScript", @@ -73660,7 +74072,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -73669,7 +74081,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -73728,8 +74140,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions/42/comments", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/discussions/42/comments
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions/42/comments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions/42/comments
    " }, { "lang": "JavaScript", @@ -73784,7 +74196,7 @@ { "verb": "post", "requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -73808,8 +74220,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions/42/comments \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/discussions/42/comments \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions/42/comments \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions/42/comments \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -73901,7 +74313,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -73934,8 +74346,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions/42/comments/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/discussions/42/comments/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions/42/comments/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions/42/comments/42
    " }, { "lang": "JavaScript", @@ -73990,7 +74402,7 @@ { "verb": "patch", "requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -74023,8 +74435,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions/42/comments/42 \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/discussions/42/comments/42 \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions/42/comments/42 \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions/42/comments/42 \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -74115,7 +74527,7 @@ { "verb": "delete", "requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -74148,8 +74560,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions/42/comments/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/discussions/42/comments/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions/42/comments/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions/42/comments/42
    " }, { "lang": "JavaScript", @@ -74187,7 +74599,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -74196,7 +74608,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -74269,8 +74681,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/teams/42/discussions/42/comments/42/reactions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/teams/42/discussions/42/comments/42/reactions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions/42/comments/42/reactions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions/42/comments/42/reactions
    " }, { "lang": "JavaScript", @@ -74323,7 +74735,7 @@ { "verb": "post", "requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -74356,8 +74768,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/teams/42/discussions/42/comments/42/reactions \\\n -d '{\"content\":\"content\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/teams/42/discussions/42/comments/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions/42/comments/42/reactions \\\n -d '{\"content\":\"content\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions/42/comments/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " }, { "lang": "JavaScript", @@ -74466,7 +74878,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/discussions/{discussion_number}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -74530,8 +74942,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/teams/42/discussions/42/reactions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/teams/42/discussions/42/reactions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions/42/reactions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions/42/reactions
    " }, { "lang": "JavaScript", @@ -74584,7 +74996,7 @@ { "verb": "post", "requestPath": "/teams/{team_id}/discussions/{discussion_number}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -74608,8 +75020,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/teams/42/discussions/42/reactions \\\n -d '{\"content\":\"content\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/teams/42/discussions/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://{hostname}/api/v3/teams/42/discussions/42/reactions \\\n -d '{\"content\":\"content\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/discussions/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " }, { "lang": "JavaScript", @@ -74718,7 +75130,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/members", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -74769,8 +75181,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/members", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/members
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/members", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/members
    " }, { "lang": "JavaScript", @@ -74823,7 +75235,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/members/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -74847,8 +75259,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/members/USERNAME", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/members/USERNAME
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/members/USERNAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/members/USERNAME
    " }, { "lang": "JavaScript", @@ -74900,7 +75312,7 @@ { "verb": "put", "requestPath": "/teams/{team_id}/members/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -74924,8 +75336,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/members/USERNAME", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/members/USERNAME
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/members/USERNAME", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/members/USERNAME
    " }, { "lang": "JavaScript", @@ -74959,13 +75371,11 @@ "subcategory": "members", "subcategoryLabel": "Members", "notes": [], - "bodyParameters": [], - "descriptionHTML": "

    The \"Add team member\" endpoint (described below) is deprecated.

    \n

    We recommend using the Add or update team membership for a user endpoint instead. It allows you to invite new organization members to your teams.

    \n

    Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

    \n

    To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.

    \n

    Note: When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"

    \n

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

    ", "responses": [ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -74980,21 +75390,16 @@ { "httpStatusCode": "422", "httpStatusMessage": "Unprocessable Entity", - "description": "Response if you attempt to add an organization to a team", - "payload": "
    {\n  \"message\": \"Cannot add an organization as a member.\",\n  \"errors\": [\n    {\n      \"code\": \"org\",\n      \"field\": \"user\",\n      \"resource\": \"TeamMember\"\n    }\n  ]\n}\n
    " - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Response if you attempt to add a user to a team when they are not a member of at least one other team in the same organization", - "payload": "
    {\n  \"message\": \"User isn't a member of this organization. Please invite them first.\",\n  \"errors\": [\n    {\n      \"code\": \"unaffiliated\",\n      \"field\": \"user\",\n      \"resource\": \"TeamMember\"\n    }\n  ]\n}\n
    " + "description": "Response if you attempt to add an organization to a team or you attempt to add a user to a team when they are not a member of at least one other team in the same organization" } - ] + ], + "bodyParameters": [], + "descriptionHTML": "

    The \"Add team member\" endpoint (described below) is deprecated.

    \n

    We recommend using the Add or update team membership for a user endpoint instead. It allows you to invite new organization members to your teams.

    \n

    Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

    \n

    To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.

    \n

    Note: When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"

    \n

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

    " }, { "verb": "delete", "requestPath": "/teams/{team_id}/members/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -75018,8 +75423,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/members/USERNAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/members/USERNAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/members/USERNAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/members/USERNAME
    " }, { "lang": "JavaScript", @@ -75057,7 +75462,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -75071,7 +75476,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/memberships/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -75095,8 +75500,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/memberships/USERNAME", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/memberships/USERNAME
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/memberships/USERNAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/memberships/USERNAME
    " }, { "lang": "JavaScript", @@ -75105,7 +75510,7 @@ } ], "summary": "Get team membership for a user (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 [Get team membership for a user](https://docs.github.com/enterprise-server@3.0/rest/reference/teams#get-team-membership-for-a-user) endpoint.\n\nTeam members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:** The `role` for organization owners returns as `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@3.0/rest/reference/teams#create-a-team).", + "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 [Get team membership for a user](https://docs.github.com/enterprise-server@3.0/rest/reference/teams#get-team-membership-for-a-user) endpoint.\n\nTeam members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:**\nThe response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@3.0/rest/reference/teams#create-a-team).", "tags": [ "teams" ], @@ -75131,26 +75536,14 @@ "subcategoryLabel": "Members", "notes": [], "bodyParameters": [], - "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 Get team membership for a user endpoint.

    \n

    Team members will include the members of child teams.

    \n

    To get a user's membership with a team, the team must be visible to the authenticated user.

    \n

    Note: The role for organization owners returns as maintainer. For more information about maintainer roles, see Create a team.

    ", + "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 Get team membership for a user endpoint.

    \n

    Team members will include the members of child teams.

    \n

    To get a user's membership with a team, the team must be visible to the authenticated user.

    \n

    Note:\nThe response contains the state of the membership and the member's role.

    \n

    The role for organization owners is set to maintainer. For more information about maintainer roles, see Create a team.

    ", "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response if user has an active membership with team", - "payload": "
    {\n  \"url\": \"https://api.github.com/teams/1/memberships/octocat\",\n  \"role\": \"member\",\n  \"state\": \"active\"\n}\n
    " - }, { "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Response if user is a team maintainer", "payload": "
    {\n  \"url\": \"https://api.github.com/teams/1/memberships/octocat\",\n  \"role\": \"maintainer\",\n  \"state\": \"active\"\n}\n
    " }, - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response if user has a pending membership with team", - "payload": "
    {\n  \"url\": \"https://api.github.com/teams/1/memberships/octocat\",\n  \"role\": \"member\",\n  \"state\": \"pending\"\n}\n
    " - }, { "httpStatusCode": "404", "httpStatusMessage": "Not Found", @@ -75161,7 +75554,7 @@ { "verb": "put", "requestPath": "/teams/{team_id}/memberships/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -75185,8 +75578,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/memberships/USERNAME \\\n -d '{\"role\":\"role\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/memberships/USERNAME \\\n  -d '{\"role\":\"role\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/memberships/USERNAME \\\n -d '{\"role\":\"role\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/memberships/USERNAME \\\n  -d '{\"role\":\"role\"}'
    " }, { "lang": "JavaScript", @@ -75263,12 +75656,6 @@ } ], "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response if user's membership with team is now active", - "payload": "
    {\n  \"url\": \"https://api.github.com/teams/1/memberships/octocat\",\n  \"role\": \"member\",\n  \"state\": \"active\"\n}\n
    " - }, { "httpStatusCode": "200", "httpStatusMessage": "OK", @@ -75288,15 +75675,14 @@ { "httpStatusCode": "422", "httpStatusMessage": "Unprocessable Entity", - "description": "Response if you attempt to add an organization to a team", - "payload": "
    {\n  \"message\": \"Cannot add an organization as a member.\",\n  \"errors\": [\n    {\n      \"code\": \"org\",\n      \"field\": \"user\",\n      \"resource\": \"TeamMember\"\n    }\n  ]\n}\n
    " + "description": "Response if you attempt to add an organization to a team" } ] }, { "verb": "delete", "requestPath": "/teams/{team_id}/memberships/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -75320,8 +75706,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/memberships/USERNAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/memberships/USERNAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/memberships/USERNAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/memberships/USERNAME
    " }, { "lang": "JavaScript", @@ -75359,7 +75745,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -75373,7 +75759,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/projects", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -75408,8 +75794,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/teams/42/projects", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/teams/42/projects
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/teams/42/projects", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/projects
    " }, { "lang": "JavaScript", @@ -75472,7 +75858,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/projects/{project_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -75496,8 +75882,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/teams/42/projects/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/teams/42/projects/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/teams/42/projects/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/projects/42
    " }, { "lang": "JavaScript", @@ -75560,7 +75946,7 @@ { "verb": "put", "requestPath": "/teams/{team_id}/projects/{project_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -75584,8 +75970,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/teams/42/projects/42 \\\n -d '{\"permission\":\"permission\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/teams/42/projects/42 \\\n  -d '{\"permission\":\"permission\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/teams/42/projects/42 \\\n -d '{\"permission\":\"permission\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/projects/42 \\\n  -d '{\"permission\":\"permission\"}'
    " }, { "lang": "JavaScript", @@ -75670,7 +76056,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -75698,7 +76084,7 @@ { "verb": "delete", "requestPath": "/teams/{team_id}/projects/{project_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -75722,8 +76108,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/projects/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/projects/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/projects/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/projects/42
    " }, { "lang": "JavaScript", @@ -75759,7 +76145,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -75783,7 +76169,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/repos", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -75818,8 +76204,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/repos", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/repos
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/repos", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/repos
    " }, { "lang": "JavaScript", @@ -75870,7 +76256,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/repos/{owner}/{repo}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -75903,8 +76289,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/repos/octocat/hello-world", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/repos/octocat/hello-world
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/repos/octocat/hello-world", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/repos/octocat/hello-world
    " }, { "lang": "JavaScript", @@ -75959,7 +76345,7 @@ { "verb": "put", "requestPath": "/teams/{team_id}/repos/{owner}/{repo}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -75992,8 +76378,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/repos/octocat/hello-world \\\n -d '{\"permission\":\"permission\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/repos/octocat/hello-world \\\n  -d '{\"permission\":\"permission\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/repos/octocat/hello-world \\\n -d '{\"permission\":\"permission\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/repos/octocat/hello-world \\\n  -d '{\"permission\":\"permission\"}'
    " }, { "lang": "JavaScript", @@ -76054,7 +76440,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -76088,7 +76474,7 @@ { "verb": "delete", "requestPath": "/teams/{team_id}/repos/{owner}/{repo}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -76121,8 +76507,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/repos/octocat/hello-world", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/repos/octocat/hello-world
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/repos/octocat/hello-world", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/repos/octocat/hello-world
    " }, { "lang": "JavaScript", @@ -76158,7 +76544,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -76167,7 +76553,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/teams", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "team_id", @@ -76202,8 +76588,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/teams", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/teams
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/teams/42/teams", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/teams/42/teams
    " }, { "lang": "JavaScript", @@ -76264,13 +76650,13 @@ { "verb": "get", "requestPath": "/user", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user
    " }, { "lang": "JavaScript", @@ -76334,13 +76720,13 @@ { "verb": "patch", "requestPath": "/user", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -76578,7 +76964,7 @@ { "verb": "get", "requestPath": "/user/emails", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -76604,8 +76990,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/emails", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/emails
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/emails", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/emails
    " }, { "lang": "JavaScript", @@ -76670,13 +77056,13 @@ { "verb": "post", "requestPath": "/user/emails", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/emails \\\n -d '{\"emails\":[\"octocat@github.com\"]}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/emails \\\n  -d '{\"emails\":[\"octocat@github.com\"]}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/emails \\\n -d '{\"emails\":[\"octocat@github.com\"]}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/emails \\\n  -d '{\"emails\":[\"octocat@github.com\"]}'
    " }, { "lang": "JavaScript", @@ -76791,13 +77177,13 @@ { "verb": "delete", "requestPath": "/user/emails", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/emails \\\n -d '{\"emails\":[\"octocat@github.com\"]}'", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/emails \\\n  -d '{\"emails\":[\"octocat@github.com\"]}'
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/emails \\\n -d '{\"emails\":[\"octocat@github.com\"]}'", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/emails \\\n  -d '{\"emails\":[\"octocat@github.com\"]}'
    " }, { "lang": "JavaScript", @@ -76877,7 +77263,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -76911,7 +77297,7 @@ { "verb": "get", "requestPath": "/user/followers", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -76937,8 +77323,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/followers", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/followers
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/followers", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/followers
    " }, { "lang": "JavaScript", @@ -76998,7 +77384,7 @@ { "verb": "get", "requestPath": "/user/following", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -77024,8 +77410,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/following", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/following
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/following", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/following
    " }, { "lang": "JavaScript", @@ -77085,7 +77471,7 @@ { "verb": "get", "requestPath": "/user/following/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -77100,8 +77486,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/following/USERNAME", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/following/USERNAME
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/following/USERNAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/following/USERNAME
    " }, { "lang": "JavaScript", @@ -77165,7 +77551,7 @@ { "verb": "put", "requestPath": "/user/following/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -77180,8 +77566,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/following/USERNAME", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/following/USERNAME
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/following/USERNAME", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/following/USERNAME
    " }, { "lang": "JavaScript", @@ -77216,7 +77602,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -77245,7 +77631,7 @@ { "verb": "delete", "requestPath": "/user/following/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -77260,8 +77646,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/following/USERNAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/following/USERNAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/following/USERNAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/following/USERNAME
    " }, { "lang": "JavaScript", @@ -77296,7 +77682,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -77325,7 +77711,7 @@ { "verb": "get", "requestPath": "/user/gpg_keys", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -77351,8 +77737,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/gpg_keys", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/gpg_keys
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/gpg_keys", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/gpg_keys
    " }, { "lang": "JavaScript", @@ -77417,13 +77803,13 @@ { "verb": "post", "requestPath": "/user/gpg_keys", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/gpg_keys \\\n -d '{\"armored_public_key\":\"armored_public_key\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/gpg_keys \\\n  -d '{\"armored_public_key\":\"armored_public_key\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/gpg_keys \\\n -d '{\"armored_public_key\":\"armored_public_key\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/gpg_keys \\\n  -d '{\"armored_public_key\":\"armored_public_key\"}'
    " }, { "lang": "JavaScript", @@ -77526,7 +77912,7 @@ { "verb": "get", "requestPath": "/user/gpg_keys/{gpg_key_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gpg_key_id", @@ -77542,8 +77928,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/gpg_keys/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/gpg_keys/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/gpg_keys/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/gpg_keys/42
    " }, { "lang": "JavaScript", @@ -77608,7 +77994,7 @@ { "verb": "delete", "requestPath": "/user/gpg_keys/{gpg_key_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "gpg_key_id", @@ -77624,8 +78010,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/gpg_keys/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/gpg_keys/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/gpg_keys/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/gpg_keys/42
    " }, { "lang": "JavaScript", @@ -77660,7 +78046,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -77694,7 +78080,7 @@ { "verb": "get", "requestPath": "/user/installations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -77720,8 +78106,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/installations", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/installations
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/installations", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/installations
    " }, { "lang": "JavaScript", @@ -77786,7 +78172,7 @@ { "verb": "get", "requestPath": "/user/installations/{installation_id}/repositories", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "installation_id", @@ -77822,8 +78208,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/installations/42/repositories", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/installations/42/repositories
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/installations/42/repositories", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/installations/42/repositories
    " }, { "lang": "JavaScript", @@ -77890,7 +78276,7 @@ { "verb": "put", "requestPath": "/user/installations/{installation_id}/repositories/{repository_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "installation_id", @@ -77915,8 +78301,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/installations/42/repositories/42", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/installations/42/repositories/42
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/installations/42/repositories/42", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/installations/42/repositories/42
    " }, { "lang": "JavaScript", @@ -77951,7 +78337,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -77975,7 +78361,7 @@ { "verb": "delete", "requestPath": "/user/installations/{installation_id}/repositories/{repository_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "installation_id", @@ -78000,8 +78386,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/installations/42/repositories/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/installations/42/repositories/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/installations/42/repositories/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/installations/42/repositories/42
    " }, { "lang": "JavaScript", @@ -78036,7 +78422,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -78060,7 +78446,7 @@ { "verb": "get", "requestPath": "/user/issues", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "filter", @@ -78074,6 +78460,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -78171,8 +78558,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/issues", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/issues
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/issues", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/issues
    " }, { "lang": "JavaScript", @@ -78232,7 +78619,7 @@ { "verb": "get", "requestPath": "/user/keys", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -78258,8 +78645,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/keys", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/keys
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/keys", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/keys
    " }, { "lang": "JavaScript", @@ -78324,13 +78711,13 @@ { "verb": "post", "requestPath": "/user/keys", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/keys \\\n -d '{\"key\":\"key\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/keys \\\n  -d '{\"key\":\"key\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/keys \\\n -d '{\"key\":\"key\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/keys \\\n  -d '{\"key\":\"key\"}'
    " }, { "lang": "JavaScript", @@ -78455,7 +78842,7 @@ { "verb": "get", "requestPath": "/user/keys/{key_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "key_id", @@ -78471,8 +78858,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/keys/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/keys/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/keys/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/keys/42
    " }, { "lang": "JavaScript", @@ -78537,7 +78924,7 @@ { "verb": "delete", "requestPath": "/user/keys/{key_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "key_id", @@ -78553,8 +78940,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/keys/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/keys/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/keys/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/keys/42
    " }, { "lang": "JavaScript", @@ -78589,7 +78976,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -78618,7 +79005,7 @@ { "verb": "get", "requestPath": "/user/memberships/orgs", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "state", @@ -78658,8 +79045,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/memberships/orgs", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/memberships/orgs
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/memberships/orgs", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/memberships/orgs
    " }, { "lang": "JavaScript", @@ -78724,7 +79111,7 @@ { "verb": "get", "requestPath": "/user/memberships/orgs/{org}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -78739,8 +79126,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/memberships/orgs/ORG", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/memberships/orgs/ORG
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/memberships/orgs/ORG", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/memberships/orgs/ORG
    " }, { "lang": "JavaScript", @@ -78795,7 +79182,7 @@ { "verb": "patch", "requestPath": "/user/memberships/orgs/{org}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "org", @@ -78810,8 +79197,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/memberships/orgs/ORG \\\n -d '{\"state\":\"state\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/memberships/orgs/ORG \\\n  -d '{\"state\":\"state\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/memberships/orgs/ORG \\\n -d '{\"state\":\"state\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/memberships/orgs/ORG \\\n  -d '{\"state\":\"state\"}'
    " }, { "lang": "JavaScript", @@ -78913,7 +79300,7 @@ { "verb": "get", "requestPath": "/user/orgs", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -78939,8 +79326,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/orgs", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/orgs
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/orgs", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/orgs
    " }, { "lang": "JavaScript", @@ -78998,13 +79385,13 @@ { "verb": "post", "requestPath": "/user/projects", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/user/projects \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/user/projects \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/user/projects \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/user/projects \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -79136,7 +79523,7 @@ { "verb": "get", "requestPath": "/user/public_emails", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -79162,8 +79549,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/public_emails", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/public_emails
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/public_emails", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/public_emails
    " }, { "lang": "JavaScript", @@ -79228,11 +79615,11 @@ { "verb": "get", "requestPath": "/user/repos", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "visibility", - "description": "Can be one of `all`, `public`, or `private`.", + "description": "Can be one of `all`, `public`, or `private`. Note: For GitHub AE, can be one of `all`, `internal`, or `private`.", "in": "query", "required": false, "schema": { @@ -79244,7 +79631,7 @@ ], "default": "all" }, - "descriptionHTML": "

    Can be one of all, public, or private.

    " + "descriptionHTML": "

    Can be one of all, public, or private. Note: For GitHub AE, can be one of all, internal, or private.

    " }, { "name": "affiliation", @@ -79259,7 +79646,7 @@ }, { "name": "type", - "description": "Can be one of `all`, `owner`, `public`, `private`, `member`. Default: `all` \n \nWill cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.", + "description": "Can be one of `all`, `owner`, `public`, `private`, `member`. Note: For GitHub AE, can be one of `all`, `owner`, `internal`, `private`, `member`. Default: `all` \n \nWill cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.", "in": "query", "required": false, "schema": { @@ -79273,7 +79660,7 @@ ], "default": "all" }, - "descriptionHTML": "

    Can be one of all, owner, public, private, member. Default: all

    \n

    Will cause a 422 error if used in the same request as visibility or affiliation. Will cause a 422 error if used in the same request as visibility or affiliation.

    " + "descriptionHTML": "

    Can be one of all, owner, public, private, member. Note: For GitHub AE, can be one of all, owner, internal, private, member. Default: all

    \n

    Will cause a 422 error if used in the same request as visibility or affiliation. Will cause a 422 error if used in the same request as visibility or affiliation.

    " }, { "name": "sort", @@ -79350,8 +79737,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/repos", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/repos
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/repos", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/repos
    " }, { "lang": "JavaScript", @@ -79414,13 +79801,13 @@ { "verb": "post", "requestPath": "/user/repos", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/repos \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/repos \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/repos \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/repos \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -79429,7 +79816,7 @@ } ], "summary": "Create a repository for the authenticated user", - "description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", + "description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository.", "tags": [ "repos" ], @@ -79472,13 +79859,13 @@ "childParamsGroups": [] }, "private": { - "description": "

    Whether the repository is private or public.

    ", + "description": "

    Whether the repository is private.

    ", "default": false, "type": "boolean", "name": "private", "in": "body", "rawType": "boolean", - "rawDescription": "Whether the repository is private or public.", + "rawDescription": "Whether the repository is private.", "childParamsGroups": [] }, "has_issues": { @@ -79652,7 +80039,7 @@ "category": "repos", "categoryLabel": "Repos", "notes": [], - "descriptionHTML": "

    Creates a new repository for the authenticated user.

    \n

    OAuth scope requirements

    \n

    When using OAuth, authorizations must include:

    \n
      \n
    • public_repo scope or repo scope to create a public repository
    • \n
    • repo scope to create a private repository
    • \n
    ", + "descriptionHTML": "

    Creates a new repository for the authenticated user.

    \n

    OAuth scope requirements

    \n

    When using OAuth, authorizations must include:

    \n
      \n
    • public_repo scope or repo scope to create a public repository. Note: For GitHub AE, use repo scope to create an internal repository.
    • \n
    • repo scope to create a private repository.
    • \n
    ", "bodyParameters": [ { "description": "

    Required. The name of the repository.

    ", @@ -79683,13 +80070,13 @@ "childParamsGroups": [] }, { - "description": "

    Whether the repository is private or public.

    ", + "description": "

    Whether the repository is private.

    ", "default": false, "type": "boolean", "name": "private", "in": "body", "rawType": "boolean", - "rawDescription": "Whether the repository is private or public.", + "rawDescription": "Whether the repository is private.", "childParamsGroups": [] }, { @@ -79873,7 +80260,7 @@ { "verb": "get", "requestPath": "/user/repository_invitations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -79899,8 +80286,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/repository_invitations", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/repository_invitations
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/repository_invitations", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/repository_invitations
    " }, { "lang": "JavaScript", @@ -79965,7 +80352,7 @@ { "verb": "patch", "requestPath": "/user/repository_invitations/{invitation_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "invitation_id", @@ -79981,8 +80368,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/repository_invitations/42", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/repository_invitations/42
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/repository_invitations/42", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/repository_invitations/42
    " }, { "lang": "JavaScript", @@ -80017,7 +80404,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -80046,7 +80433,7 @@ { "verb": "delete", "requestPath": "/user/repository_invitations/{invitation_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "invitation_id", @@ -80062,8 +80449,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/repository_invitations/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/repository_invitations/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/repository_invitations/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/repository_invitations/42
    " }, { "lang": "JavaScript", @@ -80098,7 +80485,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -80127,7 +80514,7 @@ { "verb": "get", "requestPath": "/user/starred", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "sort", @@ -80183,8 +80570,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/starred", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/starred
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/starred", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/starred
    " }, { "lang": "JavaScript", @@ -80244,7 +80631,7 @@ { "verb": "get", "requestPath": "/user/starred/{owner}/{repo}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -80268,8 +80655,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/starred/octocat/hello-world", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/starred/octocat/hello-world
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/starred/octocat/hello-world", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/starred/octocat/hello-world
    " }, { "lang": "JavaScript", @@ -80333,7 +80720,7 @@ { "verb": "put", "requestPath": "/user/starred/{owner}/{repo}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -80357,8 +80744,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/starred/octocat/hello-world", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/starred/octocat/hello-world
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/starred/octocat/hello-world", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/starred/octocat/hello-world
    " }, { "lang": "JavaScript", @@ -80393,7 +80780,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -80422,7 +80809,7 @@ { "verb": "delete", "requestPath": "/user/starred/{owner}/{repo}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "owner", @@ -80446,8 +80833,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/starred/octocat/hello-world", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/starred/octocat/hello-world
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/starred/octocat/hello-world", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/starred/octocat/hello-world
    " }, { "lang": "JavaScript", @@ -80482,7 +80869,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -80511,7 +80898,7 @@ { "verb": "get", "requestPath": "/user/subscriptions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -80537,8 +80924,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/subscriptions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/subscriptions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/subscriptions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/subscriptions
    " }, { "lang": "JavaScript", @@ -80598,7 +80985,7 @@ { "verb": "get", "requestPath": "/user/teams", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "per_page", @@ -80624,8 +81011,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/teams", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/teams
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/user/teams", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/user/teams
    " }, { "lang": "JavaScript", @@ -80683,7 +81070,7 @@ { "verb": "get", "requestPath": "/users", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "since", @@ -80709,8 +81096,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users
    " }, { "lang": "JavaScript", @@ -80758,7 +81145,7 @@ { "verb": "get", "requestPath": "/users/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -80773,8 +81160,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME
    " }, { "lang": "JavaScript", @@ -80828,7 +81215,7 @@ { "verb": "get", "requestPath": "/users/{username}/events", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -80863,8 +81250,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/events", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/events
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/events", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/events
    " }, { "lang": "JavaScript", @@ -80908,7 +81295,7 @@ { "verb": "get", "requestPath": "/users/{username}/events/orgs/{org}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -80952,8 +81339,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/events/orgs/ORG", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/events/orgs/ORG
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/events/orgs/ORG", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/events/orgs/ORG
    " }, { "lang": "JavaScript", @@ -80997,7 +81384,7 @@ { "verb": "get", "requestPath": "/users/{username}/events/public", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -81032,8 +81419,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/events/public", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/events/public
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/events/public", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/events/public
    " }, { "lang": "JavaScript", @@ -81077,7 +81464,7 @@ { "verb": "get", "requestPath": "/users/{username}/followers", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -81112,8 +81499,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/followers", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/followers
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/followers", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/followers
    " }, { "lang": "JavaScript", @@ -81158,7 +81545,7 @@ { "verb": "get", "requestPath": "/users/{username}/following", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -81193,8 +81580,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/following", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/following
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/following", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/following
    " }, { "lang": "JavaScript", @@ -81239,7 +81626,7 @@ { "verb": "get", "requestPath": "/users/{username}/following/{target_user}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -81263,8 +81650,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/following/TARGET_USER", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/following/TARGET_USER
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/following/TARGET_USER", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/following/TARGET_USER
    " }, { "lang": "JavaScript", @@ -81313,7 +81700,7 @@ { "verb": "get", "requestPath": "/users/{username}/gists", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -81358,8 +81745,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/gists", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/gists
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/gists", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/gists
    " }, { "lang": "JavaScript", @@ -81407,7 +81794,7 @@ { "verb": "get", "requestPath": "/users/{username}/gpg_keys", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -81442,8 +81829,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/gpg_keys", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/gpg_keys
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/gpg_keys", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/gpg_keys
    " }, { "lang": "JavaScript", @@ -81488,7 +81875,7 @@ { "verb": "get", "requestPath": "/users/{username}/hovercard", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -81529,8 +81916,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/hovercard", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/hovercard
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/hovercard", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/hovercard
    " }, { "lang": "JavaScript", @@ -81583,7 +81970,7 @@ { "verb": "get", "requestPath": "/users/{username}/installation", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -81598,8 +81985,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/installation", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/installation
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/installation", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/installation
    " }, { "lang": "JavaScript", @@ -81642,7 +82029,7 @@ { "verb": "get", "requestPath": "/users/{username}/keys", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -81677,8 +82064,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/keys", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/keys
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/keys", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/keys
    " }, { "lang": "JavaScript", @@ -81723,7 +82110,7 @@ { "verb": "get", "requestPath": "/users/{username}/orgs", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -81758,8 +82145,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/orgs", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/orgs
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/orgs", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/orgs
    " }, { "lang": "JavaScript", @@ -81802,7 +82189,7 @@ { "verb": "get", "requestPath": "/users/{username}/projects", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -81853,8 +82240,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/users/USERNAME/projects", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/users/USERNAME/projects
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/projects", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/projects
    " }, { "lang": "JavaScript", @@ -81914,7 +82301,7 @@ { "verb": "get", "requestPath": "/users/{username}/received_events", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -81949,8 +82336,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/received_events", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/received_events
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/received_events", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/received_events
    " }, { "lang": "JavaScript", @@ -81994,7 +82381,7 @@ { "verb": "get", "requestPath": "/users/{username}/received_events/public", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -82029,8 +82416,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/received_events/public", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/received_events/public
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/received_events/public", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/received_events/public
    " }, { "lang": "JavaScript", @@ -82074,7 +82461,7 @@ { "verb": "get", "requestPath": "/users/{username}/repos", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -82156,8 +82543,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/repos", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/repos
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/repos", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/repos
    " }, { "lang": "JavaScript", @@ -82166,7 +82553,7 @@ } ], "summary": "List repositories for a user", - "description": "Lists public repositories for the specified user.", + "description": "Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user.", "tags": [ "repos" ], @@ -82194,7 +82581,7 @@ "categoryLabel": "Repos", "notes": [], "bodyParameters": [], - "descriptionHTML": "

    Lists public repositories for the specified user.

    ", + "descriptionHTML": "

    Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user.

    ", "responses": [ { "httpStatusCode": "200", @@ -82207,7 +82594,7 @@ { "verb": "put", "requestPath": "/users/{username}/site_admin", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -82222,8 +82609,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/site_admin", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/site_admin
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/site_admin", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/site_admin
    " }, { "lang": "JavaScript", @@ -82258,7 +82645,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -82267,7 +82654,7 @@ { "verb": "delete", "requestPath": "/users/{username}/site_admin", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -82282,8 +82669,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/site_admin", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/site_admin
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/site_admin", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/site_admin
    " }, { "lang": "JavaScript", @@ -82318,7 +82705,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -82327,7 +82714,7 @@ { "verb": "get", "requestPath": "/users/{username}/starred", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -82392,8 +82779,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/starred", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/starred
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/starred", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/starred
    " }, { "lang": "JavaScript", @@ -82438,7 +82825,7 @@ { "verb": "get", "requestPath": "/users/{username}/subscriptions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -82473,8 +82860,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/subscriptions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/subscriptions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/subscriptions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/subscriptions
    " }, { "lang": "JavaScript", @@ -82519,7 +82906,7 @@ { "verb": "put", "requestPath": "/users/{username}/suspended", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -82534,8 +82921,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/suspended \\\n -d '{\"reason\":\"reason\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/suspended \\\n  -d '{\"reason\":\"reason\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/suspended \\\n -d '{\"reason\":\"reason\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/suspended \\\n  -d '{\"reason\":\"reason\"}'
    " }, { "lang": "JavaScript", @@ -82590,7 +82977,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "descriptionHTML": "

    If your GitHub instance uses LDAP Sync with Active Directory LDAP servers, Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a 403 response.

    \n

    You can suspend any user account except your own.

    \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.\"

    ", @@ -82609,7 +82996,7 @@ { "verb": "delete", "requestPath": "/users/{username}/suspended", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { "name": "username", @@ -82624,8 +83011,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/suspended \\\n -d '{\"reason\":\"reason\"}'", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/suspended \\\n  -d '{\"reason\":\"reason\"}'
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/users/USERNAME/suspended \\\n -d '{\"reason\":\"reason\"}'", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/users/USERNAME/suspended \\\n  -d '{\"reason\":\"reason\"}'
    " }, { "lang": "JavaScript", @@ -82680,7 +83067,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "descriptionHTML": "

    If your GitHub instance uses LDAP Sync with Active Directory LDAP servers, this API is disabled and will return a 403 response. Active Directory LDAP-authenticated users cannot be unsuspended using the API.

    ", @@ -82699,13 +83086,13 @@ { "verb": "get", "requestPath": "/zen", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/zen", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/zen
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/zen", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/zen
    " }, { "lang": "JavaScript", diff --git a/lib/rest/static/decorated/github.ae.json b/lib/rest/static/decorated/github.ae.json index febd2dd11a..87cd75e5eb 100644 --- a/lib/rest/static/decorated/github.ae.json +++ b/lib/rest/static/decorated/github.ae.json @@ -2,13 +2,13 @@ { "verb": "get", "requestPath": "/", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/
    " }, { "lang": "JavaScript", @@ -45,7 +45,7 @@ { "verb": "get", "requestPath": "/admin/hooks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "accept", @@ -82,8 +82,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n https://api.github.com/admin/hooks", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  https://api.github.com/admin/hooks
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n http(s)://api.{hostname}/admin/hooks", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  http(s)://api.{hostname}/admin/hooks
    " }, { "lang": "JavaScript", @@ -135,7 +135,7 @@ { "verb": "post", "requestPath": "/admin/hooks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "accept", @@ -152,8 +152,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n https://api.github.com/admin/hooks \\\n -d '{\"name\":\"name\",\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  https://api.github.com/admin/hooks \\\n  -d '{\"name\":\"name\",\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n http(s)://api.{hostname}/admin/hooks \\\n -d '{\"name\":\"name\",\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  http(s)://api.{hostname}/admin/hooks \\\n  -d '{\"name\":\"name\",\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'
    " }, { "lang": "JavaScript", @@ -483,7 +483,7 @@ { "verb": "get", "requestPath": "/admin/hooks/{hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "accept", @@ -509,8 +509,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n https://api.github.com/admin/hooks/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  https://api.github.com/admin/hooks/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n http(s)://api.{hostname}/admin/hooks/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  http(s)://api.{hostname}/admin/hooks/42
    " }, { "lang": "JavaScript", @@ -562,7 +562,7 @@ { "verb": "patch", "requestPath": "/admin/hooks/{hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "accept", @@ -588,8 +588,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n https://api.github.com/admin/hooks/42 \\\n -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  https://api.github.com/admin/hooks/42 \\\n  -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n http(s)://api.{hostname}/admin/hooks/42 \\\n -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  http(s)://api.{hostname}/admin/hooks/42 \\\n  -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'
    " }, { "lang": "JavaScript", @@ -893,7 +893,7 @@ { "verb": "delete", "requestPath": "/admin/hooks/{hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "accept", @@ -919,8 +919,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n https://api.github.com/admin/hooks/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  https://api.github.com/admin/hooks/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n http(s)://api.{hostname}/admin/hooks/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  http(s)://api.{hostname}/admin/hooks/42
    " }, { "lang": "JavaScript", @@ -962,7 +962,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -971,7 +971,7 @@ { "verb": "post", "requestPath": "/admin/hooks/{hook_id}/pings", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "accept", @@ -997,8 +997,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n https://api.github.com/admin/hooks/42/pings", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  https://api.github.com/admin/hooks/42/pings
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n http(s)://api.{hostname}/admin/hooks/42/pings", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  http(s)://api.{hostname}/admin/hooks/42/pings
    " }, { "lang": "JavaScript", @@ -1040,7 +1040,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -1049,7 +1049,7 @@ { "verb": "get", "requestPath": "/admin/keys", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "per_page", @@ -1070,13 +1070,53 @@ "default": 1 }, "descriptionHTML": "

    Page number of the results to fetch.

    " + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + }, + "descriptionHTML": "

    One of asc (ascending) or desc (descending).

    " + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "accessed" + ], + "default": "created" + }, + "descriptionHTML": "" + }, + { + "name": "since", + "description": "Only show public keys accessed after the given time.", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    Only show public keys accessed after the given time.

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/keys", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/keys
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/admin/keys", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/admin/keys
    " }, { "lang": "JavaScript", @@ -1121,7 +1161,7 @@ { "verb": "delete", "requestPath": "/admin/keys/{key_ids}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "key_ids", @@ -1136,8 +1176,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/keys/KEY_IDS", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/keys/KEY_IDS
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/admin/keys/KEY_IDS", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/admin/keys/KEY_IDS
    " }, { "lang": "JavaScript", @@ -1172,7 +1212,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -1181,13 +1221,13 @@ { "verb": "post", "requestPath": "/admin/organizations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/organizations \\\n -d '{\"login\":\"login\",\"admin\":\"admin\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/organizations \\\n  -d '{\"login\":\"login\",\"admin\":\"admin\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/admin/organizations \\\n -d '{\"login\":\"login\",\"admin\":\"admin\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/admin/organizations \\\n  -d '{\"login\":\"login\",\"admin\":\"admin\"}'
    " }, { "lang": "JavaScript", @@ -1307,7 +1347,7 @@ { "verb": "patch", "requestPath": "/admin/organizations/{org}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "org", @@ -1322,8 +1362,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/organizations/ORG \\\n -d '{\"login\":\"login\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/organizations/ORG \\\n  -d '{\"login\":\"login\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/admin/organizations/ORG \\\n -d '{\"login\":\"login\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/admin/organizations/ORG \\\n  -d '{\"login\":\"login\"}'
    " }, { "lang": "JavaScript", @@ -1404,7 +1444,7 @@ { "verb": "get", "requestPath": "/admin/pre-receive-environments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "per_page", @@ -1425,13 +1465,43 @@ "default": 1 }, "descriptionHTML": "

    Page number of the results to fetch.

    " + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + }, + "descriptionHTML": "

    One of asc (ascending) or desc (descending).

    " + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + }, + "descriptionHTML": "" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-environments", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/admin/pre-receive-environments
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://api.{hostname}/admin/pre-receive-environments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://api.{hostname}/admin/pre-receive-environments
    " }, { "lang": "JavaScript", @@ -1483,13 +1553,13 @@ { "verb": "post", "requestPath": "/admin/pre-receive-environments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-environments \\\n -d '{\"name\":\"name\",\"image_url\":\"image_url\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/admin/pre-receive-environments \\\n  -d '{\"name\":\"name\",\"image_url\":\"image_url\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://api.{hostname}/admin/pre-receive-environments \\\n -d '{\"name\":\"name\",\"image_url\":\"image_url\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://api.{hostname}/admin/pre-receive-environments \\\n  -d '{\"name\":\"name\",\"image_url\":\"image_url\"}'
    " }, { "lang": "JavaScript", @@ -1597,7 +1667,7 @@ { "verb": "get", "requestPath": "/admin/pre-receive-environments/{pre_receive_environment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "pre_receive_environment_id", @@ -1612,8 +1682,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-environments/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/admin/pre-receive-environments/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://api.{hostname}/admin/pre-receive-environments/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://api.{hostname}/admin/pre-receive-environments/42
    " }, { "lang": "JavaScript", @@ -1665,7 +1735,7 @@ { "verb": "patch", "requestPath": "/admin/pre-receive-environments/{pre_receive_environment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "pre_receive_environment_id", @@ -1680,8 +1750,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-environments/42 \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/admin/pre-receive-environments/42 \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://api.{hostname}/admin/pre-receive-environments/42 \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://api.{hostname}/admin/pre-receive-environments/42 \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -1787,7 +1857,7 @@ { "verb": "delete", "requestPath": "/admin/pre-receive-environments/{pre_receive_environment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "pre_receive_environment_id", @@ -1802,8 +1872,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-environments/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/admin/pre-receive-environments/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://api.{hostname}/admin/pre-receive-environments/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://api.{hostname}/admin/pre-receive-environments/42
    " }, { "lang": "JavaScript", @@ -1847,7 +1917,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "422", @@ -1860,7 +1930,7 @@ { "verb": "post", "requestPath": "/admin/pre-receive-environments/{pre_receive_environment_id}/downloads", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "pre_receive_environment_id", @@ -1875,8 +1945,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-environments/42/downloads", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/admin/pre-receive-environments/42/downloads
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://api.{hostname}/admin/pre-receive-environments/42/downloads", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://api.{hostname}/admin/pre-receive-environments/42/downloads
    " }, { "lang": "JavaScript", @@ -1934,7 +2004,7 @@ { "verb": "get", "requestPath": "/admin/pre-receive-environments/{pre_receive_environment_id}/downloads/latest", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "pre_receive_environment_id", @@ -1949,8 +2019,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-environments/42/downloads/latest", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://api.github.com/admin/pre-receive-environments/42/downloads/latest
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n http(s)://api.{hostname}/admin/pre-receive-environments/42/downloads/latest", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  http(s)://api.{hostname}/admin/pre-receive-environments/42/downloads/latest
    " }, { "lang": "JavaScript", @@ -2002,7 +2072,7 @@ { "verb": "get", "requestPath": "/admin/tokens", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "per_page", @@ -2028,8 +2098,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/tokens", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/tokens
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/admin/tokens", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/admin/tokens
    " }, { "lang": "JavaScript", @@ -2074,7 +2144,7 @@ { "verb": "delete", "requestPath": "/admin/tokens/{token_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "token_id", @@ -2089,8 +2159,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/tokens/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/tokens/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/admin/tokens/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/admin/tokens/42
    " }, { "lang": "JavaScript", @@ -2125,7 +2195,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -2134,7 +2204,7 @@ { "verb": "delete", "requestPath": "/admin/users/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "username", @@ -2149,8 +2219,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/users/USERNAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/users/USERNAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/admin/users/USERNAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/admin/users/USERNAME
    " }, { "lang": "JavaScript", @@ -2185,7 +2255,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -2194,7 +2264,7 @@ { "verb": "post", "requestPath": "/admin/users/{username}/authorizations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "username", @@ -2209,8 +2279,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/users/USERNAME/authorizations \\\n -d '{\"scopes\":[\"scopes\"]}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/users/USERNAME/authorizations \\\n  -d '{\"scopes\":[\"scopes\"]}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/admin/users/USERNAME/authorizations \\\n -d '{\"scopes\":[\"scopes\"]}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/admin/users/USERNAME/authorizations \\\n  -d '{\"scopes\":[\"scopes\"]}'
    " }, { "lang": "JavaScript", @@ -2291,7 +2361,7 @@ { "verb": "delete", "requestPath": "/admin/users/{username}/authorizations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "username", @@ -2306,8 +2376,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/users/USERNAME/authorizations", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/admin/users/USERNAME/authorizations
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/admin/users/USERNAME/authorizations", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/admin/users/USERNAME/authorizations
    " }, { "lang": "JavaScript", @@ -2342,7 +2412,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -2351,13 +2421,13 @@ { "verb": "get", "requestPath": "/app", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/app", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/app
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/app", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/app
    " }, { "lang": "JavaScript", @@ -2400,7 +2470,7 @@ { "verb": "post", "requestPath": "/app-manifests/{code}/conversions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "code", @@ -2415,8 +2485,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/app-manifests/CODE/conversions", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/app-manifests/CODE/conversions
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/app-manifests/CODE/conversions", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/app-manifests/CODE/conversions
    " }, { "lang": "JavaScript", @@ -2469,13 +2539,13 @@ { "verb": "get", "requestPath": "/app/hook/config", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/app/hook/config", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/app/hook/config
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/app/hook/config", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/app/hook/config
    " }, { "lang": "JavaScript", @@ -2520,13 +2590,13 @@ { "verb": "patch", "requestPath": "/app/hook/config", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/app/hook/config \\\n -d '{\"url\":\"url\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/app/hook/config \\\n  -d '{\"url\":\"url\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/app/hook/config \\\n -d '{\"url\":\"url\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/app/hook/config \\\n  -d '{\"url\":\"url\"}'
    " }, { "lang": "JavaScript", @@ -2671,7 +2741,7 @@ { "verb": "get", "requestPath": "/app/installations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "per_page", @@ -2716,8 +2786,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/app/installations", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/app/installations
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/app/installations", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/app/installations
    " }, { "lang": "JavaScript", @@ -2760,7 +2830,7 @@ { "verb": "get", "requestPath": "/app/installations/{installation_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "installation_id", @@ -2776,8 +2846,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/app/installations/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/app/installations/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/app/installations/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/app/installations/42
    " }, { "lang": "JavaScript", @@ -2830,7 +2900,7 @@ { "verb": "delete", "requestPath": "/app/installations/{installation_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "installation_id", @@ -2846,8 +2916,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/app/installations/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/app/installations/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/app/installations/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/app/installations/42
    " }, { "lang": "JavaScript", @@ -2880,7 +2950,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -2894,7 +2964,7 @@ { "verb": "post", "requestPath": "/app/installations/{installation_id}/access_tokens", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "installation_id", @@ -2910,8 +2980,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/app/installations/42/access_tokens \\\n -d '{\"repositories\":[\"repositories\"]}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/app/installations/42/access_tokens \\\n  -d '{\"repositories\":[\"repositories\"]}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/app/installations/42/access_tokens \\\n -d '{\"repositories\":[\"repositories\"]}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/app/installations/42/access_tokens \\\n  -d '{\"repositories\":[\"repositories\"]}'
    " }, { "lang": "JavaScript", @@ -4655,7 +4725,7 @@ { "verb": "put", "requestPath": "/app/installations/{installation_id}/suspended", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "installation_id", @@ -4671,8 +4741,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/app/installations/42/suspended", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/app/installations/42/suspended
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/app/installations/42/suspended", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/app/installations/42/suspended
    " }, { "lang": "JavaScript", @@ -4705,7 +4775,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -4719,7 +4789,7 @@ { "verb": "delete", "requestPath": "/app/installations/{installation_id}/suspended", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "installation_id", @@ -4735,8 +4805,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/app/installations/42/suspended", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/app/installations/42/suspended
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/app/installations/42/suspended", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/app/installations/42/suspended
    " }, { "lang": "JavaScript", @@ -4769,7 +4839,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -4783,7 +4853,7 @@ { "verb": "delete", "requestPath": "/applications/{client_id}/grant", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "client_id", @@ -4799,8 +4869,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/CLIENT_ID/grant \\\n -d '{\"access_token\":\"access_token\"}'", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/applications/CLIENT_ID/grant \\\n  -d '{\"access_token\":\"access_token\"}'
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/applications/CLIENT_ID/grant \\\n -d '{\"access_token\":\"access_token\"}'", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/applications/CLIENT_ID/grant \\\n  -d '{\"access_token\":\"access_token\"}'
    " }, { "lang": "JavaScript", @@ -4858,7 +4928,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "422", @@ -4882,7 +4952,7 @@ { "verb": "delete", "requestPath": "/applications/{client_id}/grants/{access_token}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "client_id", @@ -4907,8 +4977,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/CLIENT_ID/grants/ACCESS_TOKEN", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/applications/CLIENT_ID/grants/ACCESS_TOKEN
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/applications/CLIENT_ID/grants/ACCESS_TOKEN", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/applications/CLIENT_ID/grants/ACCESS_TOKEN
    " }, { "lang": "JavaScript", @@ -4946,7 +5016,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -4955,7 +5025,7 @@ { "verb": "post", "requestPath": "/applications/{client_id}/token", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "client_id", @@ -4971,8 +5041,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/CLIENT_ID/token \\\n -d '{\"access_token\":\"access_token\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/applications/CLIENT_ID/token \\\n  -d '{\"access_token\":\"access_token\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/applications/CLIENT_ID/token \\\n -d '{\"access_token\":\"access_token\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/applications/CLIENT_ID/token \\\n  -d '{\"access_token\":\"access_token\"}'
    " }, { "lang": "JavaScript", @@ -5060,7 +5130,7 @@ { "verb": "patch", "requestPath": "/applications/{client_id}/token", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "client_id", @@ -5076,8 +5146,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/CLIENT_ID/token \\\n -d '{\"access_token\":\"access_token\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/applications/CLIENT_ID/token \\\n  -d '{\"access_token\":\"access_token\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/applications/CLIENT_ID/token \\\n -d '{\"access_token\":\"access_token\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/applications/CLIENT_ID/token \\\n  -d '{\"access_token\":\"access_token\"}'
    " }, { "lang": "JavaScript", @@ -5160,7 +5230,7 @@ { "verb": "delete", "requestPath": "/applications/{client_id}/token", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "client_id", @@ -5176,8 +5246,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/CLIENT_ID/token \\\n -d '{\"access_token\":\"access_token\"}'", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/applications/CLIENT_ID/token \\\n  -d '{\"access_token\":\"access_token\"}'
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/applications/CLIENT_ID/token \\\n -d '{\"access_token\":\"access_token\"}'", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/applications/CLIENT_ID/token \\\n  -d '{\"access_token\":\"access_token\"}'
    " }, { "lang": "JavaScript", @@ -5203,14 +5273,17 @@ "properties": { "access_token": { "type": "string", - "description": "

    The OAuth access token used to authenticate to the GitHub API.

    ", + "description": "

    Required. The OAuth access token used to authenticate to the GitHub API.

    ", "name": "access_token", "in": "body", "rawType": "string", "rawDescription": "The OAuth access token used to authenticate to the GitHub API.", "childParamsGroups": [] } - } + }, + "required": [ + "access_token" + ] }, "example": { "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a" @@ -5235,7 +5308,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "422", @@ -5247,7 +5320,7 @@ "bodyParameters": [ { "type": "string", - "description": "

    The OAuth access token used to authenticate to the GitHub API.

    ", + "description": "

    Required. The OAuth access token used to authenticate to the GitHub API.

    ", "name": "access_token", "in": "body", "rawType": "string", @@ -5259,7 +5332,7 @@ { "verb": "get", "requestPath": "/applications/{client_id}/tokens/{access_token}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "client_id", @@ -5284,8 +5357,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/CLIENT_ID/tokens/ACCESS_TOKEN", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/applications/CLIENT_ID/tokens/ACCESS_TOKEN
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/applications/CLIENT_ID/tokens/ACCESS_TOKEN", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/applications/CLIENT_ID/tokens/ACCESS_TOKEN
    " }, { "lang": "JavaScript", @@ -5338,7 +5411,7 @@ { "verb": "post", "requestPath": "/applications/{client_id}/tokens/{access_token}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "client_id", @@ -5363,8 +5436,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/CLIENT_ID/tokens/ACCESS_TOKEN", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/applications/CLIENT_ID/tokens/ACCESS_TOKEN
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/applications/CLIENT_ID/tokens/ACCESS_TOKEN", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/applications/CLIENT_ID/tokens/ACCESS_TOKEN
    " }, { "lang": "JavaScript", @@ -5412,7 +5485,7 @@ { "verb": "delete", "requestPath": "/applications/{client_id}/tokens/{access_token}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "client_id", @@ -5437,8 +5510,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/CLIENT_ID/tokens/ACCESS_TOKEN", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/applications/CLIENT_ID/tokens/ACCESS_TOKEN
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/applications/CLIENT_ID/tokens/ACCESS_TOKEN", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/applications/CLIENT_ID/tokens/ACCESS_TOKEN
    " }, { "lang": "JavaScript", @@ -5476,7 +5549,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -5485,7 +5558,7 @@ { "verb": "get", "requestPath": "/apps/{app_slug}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "app_slug", @@ -5500,8 +5573,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/apps/APP_SLUG", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/apps/APP_SLUG
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/apps/APP_SLUG", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/apps/APP_SLUG
    " }, { "lang": "JavaScript", @@ -5559,13 +5632,13 @@ { "verb": "get", "requestPath": "/codes_of_conduct", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.scarlet-witch-preview+json\" \\\n https://api.github.com/codes_of_conduct", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.scarlet-witch-preview+json\" \\\n  https://api.github.com/codes_of_conduct
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.scarlet-witch-preview+json\" \\\n http(s)://api.{hostname}/codes_of_conduct", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.scarlet-witch-preview+json\" \\\n  http(s)://api.{hostname}/codes_of_conduct
    " }, { "lang": "JavaScript", @@ -5625,7 +5698,7 @@ { "verb": "get", "requestPath": "/codes_of_conduct/{key}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "key", @@ -5640,8 +5713,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.scarlet-witch-preview+json\" \\\n https://api.github.com/codes_of_conduct/KEY", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.scarlet-witch-preview+json\" \\\n  https://api.github.com/codes_of_conduct/KEY
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.scarlet-witch-preview+json\" \\\n http(s)://api.{hostname}/codes_of_conduct/KEY", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.scarlet-witch-preview+json\" \\\n  http(s)://api.{hostname}/codes_of_conduct/KEY
    " }, { "lang": "JavaScript", @@ -5706,7 +5779,7 @@ { "verb": "post", "requestPath": "/content_references/{content_reference_id}/attachments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "content_reference_id", @@ -5721,8 +5794,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n https://api.github.com/content_references/42/attachments \\\n -d '{\"title\":\"title\",\"body\":\"body\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n  https://api.github.com/content_references/42/attachments \\\n  -d '{\"title\":\"title\",\"body\":\"body\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n http(s)://api.{hostname}/content_references/42/attachments \\\n -d '{\"title\":\"title\",\"body\":\"body\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n  http(s)://api.{hostname}/content_references/42/attachments \\\n  -d '{\"title\":\"title\",\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -5864,13 +5937,13 @@ { "verb": "get", "requestPath": "/emojis", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/emojis", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/emojis
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/emojis", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/emojis
    " }, { "lang": "JavaScript", @@ -5917,13 +5990,13 @@ { "verb": "get", "requestPath": "/enterprise/announcement", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprise/announcement", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprise/announcement
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/enterprise/announcement", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/enterprise/announcement
    " }, { "lang": "JavaScript", @@ -5968,13 +6041,13 @@ { "verb": "patch", "requestPath": "/enterprise/announcement", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprise/announcement \\\n -d '{\"announcement\":\"announcement\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprise/announcement \\\n  -d '{\"announcement\":\"announcement\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/enterprise/announcement \\\n -d '{\"announcement\":\"announcement\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/enterprise/announcement \\\n  -d '{\"announcement\":\"announcement\"}'
    " }, { "lang": "JavaScript", @@ -6078,13 +6151,13 @@ { "verb": "delete", "requestPath": "/enterprise/announcement", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprise/announcement", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprise/announcement
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/enterprise/announcement", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/enterprise/announcement
    " }, { "lang": "JavaScript", @@ -6119,7 +6192,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -6128,13 +6201,13 @@ { "verb": "get", "requestPath": "/enterprise/encryption", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprise/encryption", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprise/encryption
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/enterprise/encryption", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/enterprise/encryption
    " }, { "lang": "JavaScript", @@ -6179,13 +6252,13 @@ { "verb": "patch", "requestPath": "/enterprise/encryption", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprise/encryption \\\n -d '{\"key\":\"key\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprise/encryption \\\n  -d '{\"key\":\"key\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/enterprise/encryption \\\n -d '{\"key\":\"key\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/enterprise/encryption \\\n  -d '{\"key\":\"key\"}'
    " }, { "lang": "JavaScript", @@ -6266,13 +6339,13 @@ { "verb": "delete", "requestPath": "/enterprise/encryption", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprise/encryption", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprise/encryption
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/enterprise/encryption", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/enterprise/encryption
    " }, { "lang": "JavaScript", @@ -6317,7 +6390,7 @@ { "verb": "get", "requestPath": "/enterprise/encryption/status/{request_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "request_id", @@ -6333,8 +6406,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprise/encryption/status/REQUEST_ID", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprise/encryption/status/REQUEST_ID
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/enterprise/encryption/status/REQUEST_ID", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/enterprise/encryption/status/REQUEST_ID
    " }, { "lang": "JavaScript", @@ -6384,13 +6457,13 @@ { "verb": "get", "requestPath": "/enterprise/settings/license", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprise/settings/license", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprise/settings/license
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/enterprise/settings/license", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/enterprise/settings/license
    " }, { "lang": "JavaScript", @@ -6435,7 +6508,7 @@ { "verb": "get", "requestPath": "/enterprise/stats/{type}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "type", @@ -6450,8 +6523,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprise/stats/TYPE", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprise/stats/TYPE
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/enterprise/stats/TYPE", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/enterprise/stats/TYPE
    " }, { "lang": "JavaScript", @@ -6493,10 +6566,1893 @@ } ] }, + { + "verb": "get", + "requestPath": "/enterprises/{enterprise}/actions/permissions", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    The slug version of the enterprise name. You can also substitute this value with the enterprise id.

    " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/enterprises/ENTERPRISE/actions/permissions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/enterprises/ENTERPRISE/actions/permissions
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /enterprises/{enterprise}/actions/permissions', {\n enterprise: 'enterprise'\n})", + "html": "
    await octokit.request('GET /enterprises/{enterprise}/actions/permissions', {\n  enterprise: 'enterprise'\n})\n
    " + } + ], + "summary": "Get GitHub Actions permissions for an enterprise", + "description": "Gets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/get-github-actions-permissions-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#get-github-actions-permissions-for-an-enterprise" + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [], + "category": "enterprise-admin", + "subcategory": "actions" + }, + "slug": "get-github-actions-permissions-for-an-enterprise", + "category": "enterprise-admin", + "categoryLabel": "Enterprise admin", + "subcategory": "actions", + "subcategoryLabel": "Actions", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

    Gets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise.

    \n

    You must authenticate using an access token with the admin:enterprise scope to use this endpoint.

    ", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
    {\n  \"enabled_organizations\": \"all\",\n  \"allowed_actions\": \"selected\",\n  \"selected_actions_url\": \"https://api.github.com/enterprises/2/actions/permissions/selected-actions\"\n}\n
    " + } + ] + }, + { + "verb": "put", + "requestPath": "/enterprises/{enterprise}/actions/permissions", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    The slug version of the enterprise name. You can also substitute this value with the enterprise id.

    " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/enterprises/ENTERPRISE/actions/permissions \\\n -d '{\"enabled_organizations\":\"enabled_organizations\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/enterprises/ENTERPRISE/actions/permissions \\\n  -d '{\"enabled_organizations\":\"enabled_organizations\"}'
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('PUT /enterprises/{enterprise}/actions/permissions', {\n enterprise: 'enterprise',\n enabled_organizations: 'enabled_organizations'\n})", + "html": "
    await octokit.request('PUT /enterprises/{enterprise}/actions/permissions', {\n  enterprise: 'enterprise',\n  enabled_organizations: 'enabled_organizations'\n})\n
    " + } + ], + "summary": "Set GitHub Actions permissions for an enterprise", + "description": "Sets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/set-github-actions-permissions-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#set-github-actions-permissions-for-an-enterprise" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "enabled_organizations": { + "type": "string", + "description": "

    Required. The policy that controls the organizations in the enterprise that are allowed to run GitHub Actions. Can be one of: all, none, or selected.

    ", + "enum": [ + "all", + "none", + "selected" + ], + "name": "enabled_organizations", + "in": "body", + "rawType": "string", + "rawDescription": "The policy that controls the organizations in the enterprise that are allowed to run GitHub Actions. Can be one of: `all`, `none`, or `selected`.", + "childParamsGroups": [] + }, + "allowed_actions": { + "type": "string", + "description": "

    The permissions policy that controls the actions that are allowed to run. Can be one of: all, local_only, or selected.

    ", + "enum": [ + "all", + "local_only", + "selected" + ], + "name": "allowed_actions", + "in": "body", + "rawType": "string", + "rawDescription": "The permissions policy that controls the actions that are allowed to run. Can be one of: `all`, `local_only`, or `selected`.", + "childParamsGroups": [] + } + }, + "required": [ + "enabled_organizations" + ] + }, + "example": { + "enabled_organizations": "all", + "allowed_actions": "selected" + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [], + "category": "enterprise-admin", + "subcategory": "actions" + }, + "slug": "set-github-actions-permissions-for-an-enterprise", + "category": "enterprise-admin", + "categoryLabel": "Enterprise admin", + "subcategory": "actions", + "subcategoryLabel": "Actions", + "notes": [], + "responses": [ + { + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Response" + } + ], + "descriptionHTML": "

    Sets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise.

    \n

    You must authenticate using an access token with the admin:enterprise scope to use this endpoint.

    ", + "bodyParameters": [ + { + "type": "string", + "description": "

    Required. The policy that controls the organizations in the enterprise that are allowed to run GitHub Actions. Can be one of: all, none, or selected.

    ", + "enum": [ + "all", + "none", + "selected" + ], + "name": "enabled_organizations", + "in": "body", + "rawType": "string", + "rawDescription": "The policy that controls the organizations in the enterprise that are allowed to run GitHub Actions. Can be one of: `all`, `none`, or `selected`.", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

    The permissions policy that controls the actions that are allowed to run. Can be one of: all, local_only, or selected.

    ", + "enum": [ + "all", + "local_only", + "selected" + ], + "name": "allowed_actions", + "in": "body", + "rawType": "string", + "rawDescription": "The permissions policy that controls the actions that are allowed to run. Can be one of: `all`, `local_only`, or `selected`.", + "childParamsGroups": [] + } + ] + }, + { + "verb": "get", + "requestPath": "/enterprises/{enterprise}/actions/permissions/organizations", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    The slug version of the enterprise name. You can also substitute this value with the enterprise id.

    " + }, + { + "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 http(s)://api.{hostname}/enterprises/ENTERPRISE/actions/permissions/organizations", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/enterprises/ENTERPRISE/actions/permissions/organizations
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /enterprises/{enterprise}/actions/permissions/organizations', {\n enterprise: 'enterprise'\n})", + "html": "
    await octokit.request('GET /enterprises/{enterprise}/actions/permissions/organizations', {\n  enterprise: 'enterprise'\n})\n
    " + } + ], + "summary": "List selected organizations enabled for GitHub Actions in an enterprise", + "description": "Lists the organizations that are selected to have GitHub Actions enabled in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/list-selected-organizations-enabled-github-actions-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#list-selected-organizations-enabled-for-github-actions-in-an-enterprise" + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [], + "category": "enterprise-admin", + "subcategory": "actions" + }, + "slug": "list-selected-organizations-enabled-for-github-actions-in-an-enterprise", + "category": "enterprise-admin", + "categoryLabel": "Enterprise admin", + "subcategory": "actions", + "subcategoryLabel": "Actions", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

    Lists the organizations that are selected to have GitHub Actions enabled in an enterprise. To use this endpoint, the enterprise permission policy for enabled_organizations must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"

    \n

    You must authenticate using an access token with the admin:enterprise scope to use this endpoint.

    ", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
    {\n  \"total_count\": 1,\n  \"organizations\": [\n    {\n      \"login\": \"octocat\",\n      \"id\": 161335,\n      \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n      \"url\": \"https://api.github.com/orgs/octo-org\",\n      \"repos_url\": \"https://api.github.com/orgs/octo-org/repos\",\n      \"events_url\": \"https://api.github.com/orgs/octo-org/events\",\n      \"hooks_url\": \"https://api.github.com/orgs/octo-org/hooks\",\n      \"issues_url\": \"https://api.github.com/orgs/octo-org/issues\",\n      \"members_url\": \"https://api.github.com/orgs/octo-org/members{/member}\",\n      \"public_members_url\": \"https://api.github.com/orgs/octo-org/public_members{/member}\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"description\": \"A great organization\"\n    }\n  ]\n}\n
    " + } + ] + }, + { + "verb": "put", + "requestPath": "/enterprises/{enterprise}/actions/permissions/organizations", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    The slug version of the enterprise name. You can also substitute this value with the enterprise id.

    " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/enterprises/ENTERPRISE/actions/permissions/organizations \\\n -d '{\"selected_organization_ids\":[42]}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/enterprises/ENTERPRISE/actions/permissions/organizations \\\n  -d '{\"selected_organization_ids\":[42]}'
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('PUT /enterprises/{enterprise}/actions/permissions/organizations', {\n enterprise: 'enterprise',\n selected_organization_ids: [\n 42\n ]\n})", + "html": "
    await octokit.request('PUT /enterprises/{enterprise}/actions/permissions/organizations', {\n  enterprise: 'enterprise',\n  selected_organization_ids: [\n    42\n  ]\n})\n
    " + } + ], + "summary": "Set selected organizations enabled for GitHub Actions in an enterprise", + "description": "Replaces the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/set-selected-organizations-enabled-github-actions-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#set-selected-organizations-enabled-for-github-actions-in-an-enterprise" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "selected_organization_ids": { + "description": "

    Required. List of organization IDs to enable for GitHub Actions.

    ", + "type": "array of integers", + "items": { + "type": "integer", + "description": "Unique identifier of the organization." + }, + "name": "selected_organization_ids", + "in": "body", + "rawType": "array", + "rawDescription": "List of organization IDs to enable for GitHub Actions.", + "childParamsGroups": [] + } + }, + "required": [ + "selected_organization_ids" + ] + }, + "example": { + "selected_organization_ids": [ + 32, + 91 + ] + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [], + "category": "enterprise-admin", + "subcategory": "actions" + }, + "slug": "set-selected-organizations-enabled-for-github-actions-in-an-enterprise", + "category": "enterprise-admin", + "categoryLabel": "Enterprise admin", + "subcategory": "actions", + "subcategoryLabel": "Actions", + "notes": [], + "responses": [ + { + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Response" + } + ], + "descriptionHTML": "

    Replaces the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for enabled_organizations must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"

    \n

    You must authenticate using an access token with the admin:enterprise scope to use this endpoint.

    ", + "bodyParameters": [ + { + "description": "

    Required. List of organization IDs to enable for GitHub Actions.

    ", + "type": "array of integers", + "items": { + "type": "integer", + "description": "Unique identifier of the organization." + }, + "name": "selected_organization_ids", + "in": "body", + "rawType": "array", + "rawDescription": "List of organization IDs to enable for GitHub Actions.", + "childParamsGroups": [] + } + ] + }, + { + "verb": "put", + "requestPath": "/enterprises/{enterprise}/actions/permissions/organizations/{org_id}", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    The slug version of the enterprise name. You can also substitute this value with the enterprise id.

    " + }, + { + "name": "org_id", + "description": "Unique identifier of an organization.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

    Unique identifier of an organization.

    " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/enterprises/ENTERPRISE/actions/permissions/organizations/42", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/enterprises/ENTERPRISE/actions/permissions/organizations/42
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('PUT /enterprises/{enterprise}/actions/permissions/organizations/{org_id}', {\n enterprise: 'enterprise',\n org_id: 42\n})", + "html": "
    await octokit.request('PUT /enterprises/{enterprise}/actions/permissions/organizations/{org_id}', {\n  enterprise: 'enterprise',\n  org_id: 42\n})\n
    " + } + ], + "summary": "Enable a selected organization for GitHub Actions in an enterprise", + "description": "Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/enable-selected-organization-github-actions-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#enable-a-selected-organization-for-github-actions-in-an-enterprise" + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [], + "category": "enterprise-admin", + "subcategory": "actions" + }, + "slug": "enable-a-selected-organization-for-github-actions-in-an-enterprise", + "category": "enterprise-admin", + "categoryLabel": "Enterprise admin", + "subcategory": "actions", + "subcategoryLabel": "Actions", + "notes": [], + "responses": [ + { + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Response" + } + ], + "bodyParameters": [], + "descriptionHTML": "

    Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for enabled_organizations must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"

    \n

    You must authenticate using an access token with the admin:enterprise scope to use this endpoint.

    " + }, + { + "verb": "delete", + "requestPath": "/enterprises/{enterprise}/actions/permissions/organizations/{org_id}", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    The slug version of the enterprise name. You can also substitute this value with the enterprise id.

    " + }, + { + "name": "org_id", + "description": "Unique identifier of an organization.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

    Unique identifier of an organization.

    " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/enterprises/ENTERPRISE/actions/permissions/organizations/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/enterprises/ENTERPRISE/actions/permissions/organizations/42
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('DELETE /enterprises/{enterprise}/actions/permissions/organizations/{org_id}', {\n enterprise: 'enterprise',\n org_id: 42\n})", + "html": "
    await octokit.request('DELETE /enterprises/{enterprise}/actions/permissions/organizations/{org_id}', {\n  enterprise: 'enterprise',\n  org_id: 42\n})\n
    " + } + ], + "summary": "Disable a selected organization for GitHub Actions in an enterprise", + "description": "Removes an organization from the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/disable-selected-organization-github-actions-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#disable-a-selected-organization-for-github-actions-in-an-enterprise" + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [], + "category": "enterprise-admin", + "subcategory": "actions" + }, + "slug": "disable-a-selected-organization-for-github-actions-in-an-enterprise", + "category": "enterprise-admin", + "categoryLabel": "Enterprise admin", + "subcategory": "actions", + "subcategoryLabel": "Actions", + "notes": [], + "responses": [ + { + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Response" + } + ], + "bodyParameters": [], + "descriptionHTML": "

    Removes an organization from the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for enabled_organizations must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"

    \n

    You must authenticate using an access token with the admin:enterprise scope to use this endpoint.

    " + }, + { + "verb": "get", + "requestPath": "/enterprises/{enterprise}/actions/permissions/selected-actions", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    The slug version of the enterprise name. You can also substitute this value with the enterprise id.

    " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/enterprises/ENTERPRISE/actions/permissions/selected-actions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/enterprises/ENTERPRISE/actions/permissions/selected-actions
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /enterprises/{enterprise}/actions/permissions/selected-actions', {\n enterprise: 'enterprise'\n})", + "html": "
    await octokit.request('GET /enterprises/{enterprise}/actions/permissions/selected-actions', {\n  enterprise: 'enterprise'\n})\n
    " + } + ], + "summary": "Get allowed actions for an enterprise", + "description": "Gets the selected actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/get-allowed-actions-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#get-allowed-actions-for-an-enterprise" + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [], + "category": "enterprise-admin", + "subcategory": "actions" + }, + "slug": "get-allowed-actions-for-an-enterprise", + "category": "enterprise-admin", + "categoryLabel": "Enterprise admin", + "subcategory": "actions", + "subcategoryLabel": "Actions", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

    Gets the selected actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"

    \n

    You must authenticate using an access token with the admin:enterprise scope to use this endpoint.

    ", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
    {\n  \"github_owned_allowed\": true,\n  \"verified_allowed\": false,\n  \"patterns_allowed\": [\n    \"monalisa/octocat@*\",\n    \"docker/*\"\n  ]\n}\n
    " + } + ] + }, + { + "verb": "put", + "requestPath": "/enterprises/{enterprise}/actions/permissions/selected-actions", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    The slug version of the enterprise name. You can also substitute this value with the enterprise id.

    " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/enterprises/ENTERPRISE/actions/permissions/selected-actions \\\n -d '{\"github_owned_allowed\":true,\"patterns_allowed\":[\"patterns_allowed\"],\"verified_allowed\":true}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/enterprises/ENTERPRISE/actions/permissions/selected-actions \\\n  -d '{\"github_owned_allowed\":true,\"patterns_allowed\":[\"patterns_allowed\"],\"verified_allowed\":true}'
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('PUT /enterprises/{enterprise}/actions/permissions/selected-actions', {\n enterprise: 'enterprise',\n github_owned_allowed: true,\n patterns_allowed: [\n 'patterns_allowed'\n ],\n verified_allowed: true\n})", + "html": "
    await octokit.request('PUT /enterprises/{enterprise}/actions/permissions/selected-actions', {\n  enterprise: 'enterprise',\n  github_owned_allowed: true,\n  patterns_allowed: [\n    'patterns_allowed'\n  ],\n  verified_allowed: true\n})\n
    " + } + ], + "summary": "Set allowed actions for an enterprise", + "description": "Sets the actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/set-allowed-actions-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#set-allowed-actions-for-an-enterprise" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "github_owned_allowed": { + "type": "boolean", + "description": "

    Required. Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

    ", + "name": "github_owned_allowed", + "in": "body", + "rawType": "boolean", + "rawDescription": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization.", + "childParamsGroups": [] + }, + "verified_allowed": { + "type": "boolean", + "description": "

    Required. Whether actions in GitHub Marketplace from verified creators are allowed. Set to true to allow all GitHub Marketplace actions by verified creators.

    ", + "name": "verified_allowed", + "in": "body", + "rawType": "boolean", + "rawDescription": "Whether actions in GitHub Marketplace from verified creators are allowed. Set to `true` to allow all GitHub Marketplace actions by verified creators.", + "childParamsGroups": [] + }, + "patterns_allowed": { + "type": "array of strings", + "description": "

    Required. Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"

    ", + "items": { + "type": "string" + }, + "name": "patterns_allowed", + "in": "body", + "rawType": "array", + "rawDescription": "Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"", + "childParamsGroups": [] + } + }, + "required": [ + "github_owned_allowed", + "patterns_allowed", + "verified_allowed" + ] + }, + "examples": { + "selected_actions": { + "value": { + "github_owned_allowed": true, + "verified_allowed": false, + "patterns_allowed": [ + "monalisa/octocat@*", + "docker/*" + ] + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [], + "category": "enterprise-admin", + "subcategory": "actions" + }, + "slug": "set-allowed-actions-for-an-enterprise", + "category": "enterprise-admin", + "categoryLabel": "Enterprise admin", + "subcategory": "actions", + "subcategoryLabel": "Actions", + "notes": [], + "responses": [ + { + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Response" + } + ], + "descriptionHTML": "

    Sets the actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"

    \n

    You must authenticate using an access token with the admin:enterprise scope to use this endpoint.

    ", + "bodyParameters": [ + { + "type": "boolean", + "description": "

    Required. Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

    ", + "name": "github_owned_allowed", + "in": "body", + "rawType": "boolean", + "rawDescription": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization.", + "childParamsGroups": [] + }, + { + "type": "boolean", + "description": "

    Required. Whether actions in GitHub Marketplace from verified creators are allowed. Set to true to allow all GitHub Marketplace actions by verified creators.

    ", + "name": "verified_allowed", + "in": "body", + "rawType": "boolean", + "rawDescription": "Whether actions in GitHub Marketplace from verified creators are allowed. Set to `true` to allow all GitHub Marketplace actions by verified creators.", + "childParamsGroups": [] + }, + { + "type": "array of strings", + "description": "

    Required. Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"

    ", + "items": { + "type": "string" + }, + "name": "patterns_allowed", + "in": "body", + "rawType": "array", + "rawDescription": "Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"", + "childParamsGroups": [] + } + ] + }, + { + "verb": "get", + "requestPath": "/enterprises/{enterprise}/actions/runner-groups", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    The slug version of the enterprise name. You can also substitute this value with the enterprise id.

    " + }, + { + "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 http(s)://api.{hostname}/enterprises/ENTERPRISE/actions/runner-groups", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/enterprises/ENTERPRISE/actions/runner-groups
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /enterprises/{enterprise}/actions/runner-groups', {\n enterprise: 'enterprise'\n})", + "html": "
    await octokit.request('GET /enterprises/{enterprise}/actions/runner-groups', {\n  enterprise: 'enterprise'\n})\n
    " + } + ], + "summary": "List self-hosted runner groups for an enterprise", + "description": "Lists all self-hosted runner groups for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/list-self-hosted-runner-groups-for-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#list-self-hosted-runner-groups-for-an-enterprise" + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [], + "category": "enterprise-admin", + "subcategory": "actions" + }, + "slug": "list-self-hosted-runner-groups-for-an-enterprise", + "category": "enterprise-admin", + "categoryLabel": "Enterprise admin", + "subcategory": "actions", + "subcategoryLabel": "Actions", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

    Lists all self-hosted runner groups for an enterprise.

    \n

    You must authenticate using an access token with the admin:enterprise scope to use this endpoint.

    ", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
    {\n  \"total_count\": 3,\n  \"runner_groups\": [\n    {\n      \"id\": 1,\n      \"name\": \"Default\",\n      \"visibility\": \"all\",\n      \"default\": true,\n      \"runners_url\": \"https://api.github.com/enterprises/octo-corp/actions/runner_groups/1/runners\",\n      \"allows_public_repositories\": false\n    },\n    {\n      \"id\": 2,\n      \"name\": \"octo-runner-group\",\n      \"visibility\": \"selected\",\n      \"default\": false,\n      \"selected_organizations_url\": \"https://api.github.com/enterprises/octo-corp/actions/runner_groups/2/organizations\",\n      \"runners_url\": \"https://api.github.com/enterprises/octo-corp/actions/runner_groups/2/runners\",\n      \"allows_public_repositories\": true\n    },\n    {\n      \"id\": 3,\n      \"name\": \"expensive-hardware\",\n      \"visibility\": \"private\",\n      \"default\": false,\n      \"runners_url\": \"https://api.github.com/enterprises/octo-corp/actions/runner_groups/3/runners\",\n      \"allows_public_repositories\": true\n    }\n  ]\n}\n
    " + } + ] + }, + { + "verb": "post", + "requestPath": "/enterprises/{enterprise}/actions/runner-groups", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    The slug version of the enterprise name. You can also substitute this value with the enterprise id.

    " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/enterprises/ENTERPRISE/actions/runner-groups \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/enterprises/ENTERPRISE/actions/runner-groups \\\n  -d '{\"name\":\"name\"}'
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('POST /enterprises/{enterprise}/actions/runner-groups', {\n enterprise: 'enterprise',\n name: 'name'\n})", + "html": "
    await octokit.request('POST /enterprises/{enterprise}/actions/runner-groups', {\n  enterprise: 'enterprise',\n  name: 'name'\n})\n
    " + } + ], + "summary": "Create a self-hosted runner group for an enterprise", + "description": "Creates a new self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/create-self-hosted-runner-group-for-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#create-self-hosted-runner-group-for-an-enterprise" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "description": "

    Required. Name of the runner group.

    ", + "type": "string", + "name": "name", + "in": "body", + "rawType": "string", + "rawDescription": "Name of the runner group.", + "childParamsGroups": [] + }, + "visibility": { + "description": "

    Visibility of a runner group. You can select all organizations or select individual organization. Can be one of: all or selected

    ", + "type": "string", + "enum": [ + "selected", + "all" + ], + "name": "visibility", + "in": "body", + "rawType": "string", + "rawDescription": "Visibility of a runner group. You can select all organizations or select individual organization. Can be one of: `all` or `selected`", + "childParamsGroups": [] + }, + "selected_organization_ids": { + "description": "

    List of organization IDs that can access the runner group.

    ", + "type": "array of integers", + "items": { + "type": "integer", + "description": "Unique identifier of the organization." + }, + "name": "selected_organization_ids", + "in": "body", + "rawType": "array", + "rawDescription": "List of organization IDs that can access the runner group.", + "childParamsGroups": [] + }, + "runners": { + "description": "

    List of runner IDs to add to the runner group.

    ", + "type": "array of integers", + "items": { + "type": "integer", + "description": "Unique identifier of the runner." + }, + "name": "runners", + "in": "body", + "rawType": "array", + "rawDescription": "List of runner IDs to add to the runner group.", + "childParamsGroups": [] + } + }, + "required": [ + "name" + ] + }, + "example": { + "name": "Expensive hardware runners", + "visibility": "selected", + "selected_organization_ids": [ + 32, + 91 + ], + "runners": [ + 9, + 2 + ] + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [], + "category": "enterprise-admin", + "subcategory": "actions" + }, + "slug": "create-a-self-hosted-runner-group-for-an-enterprise", + "category": "enterprise-admin", + "categoryLabel": "Enterprise admin", + "subcategory": "actions", + "subcategoryLabel": "Actions", + "notes": [], + "descriptionHTML": "

    Creates a new self-hosted runner group for an enterprise.

    \n

    You must authenticate using an access token with the admin:enterprise scope to use this endpoint.

    ", + "bodyParameters": [ + { + "description": "

    Required. Name of the runner group.

    ", + "type": "string", + "name": "name", + "in": "body", + "rawType": "string", + "rawDescription": "Name of the runner group.", + "childParamsGroups": [] + }, + { + "description": "

    Visibility of a runner group. You can select all organizations or select individual organization. Can be one of: all or selected

    ", + "type": "string", + "enum": [ + "selected", + "all" + ], + "name": "visibility", + "in": "body", + "rawType": "string", + "rawDescription": "Visibility of a runner group. You can select all organizations or select individual organization. Can be one of: `all` or `selected`", + "childParamsGroups": [] + }, + { + "description": "

    List of organization IDs that can access the runner group.

    ", + "type": "array of integers", + "items": { + "type": "integer", + "description": "Unique identifier of the organization." + }, + "name": "selected_organization_ids", + "in": "body", + "rawType": "array", + "rawDescription": "List of organization IDs that can access the runner group.", + "childParamsGroups": [] + }, + { + "description": "

    List of runner IDs to add to the runner group.

    ", + "type": "array of integers", + "items": { + "type": "integer", + "description": "Unique identifier of the runner." + }, + "name": "runners", + "in": "body", + "rawType": "array", + "rawDescription": "List of runner IDs to add to the runner group.", + "childParamsGroups": [] + } + ], + "responses": [ + { + "httpStatusCode": "201", + "httpStatusMessage": "Created", + "description": "Default response", + "payload": "
    {\n  \"id\": 2,\n  \"name\": \"octo-runner-group\",\n  \"visibility\": \"selected\",\n  \"default\": false,\n  \"selected_organizations_url\": \"https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/organizations\",\n  \"runners_url\": \"https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/runners\",\n  \"allows_public_repositories\": false\n}\n
    " + } + ] + }, + { + "verb": "get", + "requestPath": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    The slug version of the enterprise name. You can also substitute this value with the enterprise id.

    " + }, + { + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

    Unique identifier of the self-hosted runner group.

    " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/enterprises/ENTERPRISE/actions/runner-groups/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/enterprises/ENTERPRISE/actions/runner-groups/42
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}', {\n enterprise: 'enterprise',\n runner_group_id: 42\n})", + "html": "
    await octokit.request('GET /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}', {\n  enterprise: 'enterprise',\n  runner_group_id: 42\n})\n
    " + } + ], + "summary": "Get a self-hosted runner group for an enterprise", + "description": "Gets a specific self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/get-self-hosted-runner-group-for-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#get-a-self-hosted-runner-group-for-an-enterprise" + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [], + "category": "enterprise-admin", + "subcategory": "actions" + }, + "slug": "get-a-self-hosted-runner-group-for-an-enterprise", + "category": "enterprise-admin", + "categoryLabel": "Enterprise admin", + "subcategory": "actions", + "subcategoryLabel": "Actions", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

    Gets a specific self-hosted runner group for an enterprise.

    \n

    You must authenticate using an access token with the admin:enterprise scope to use this endpoint.

    ", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
    {\n  \"id\": 2,\n  \"name\": \"octo-runner-group\",\n  \"visibility\": \"selected\",\n  \"default\": false,\n  \"selected_organizations_url\": \"https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/organizations\",\n  \"runners_url\": \"https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/runners\",\n  \"allows_public_repositories\": false\n}\n
    " + } + ] + }, + { + "verb": "patch", + "requestPath": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    The slug version of the enterprise name. You can also substitute this value with the enterprise id.

    " + }, + { + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

    Unique identifier of the self-hosted runner group.

    " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/enterprises/ENTERPRISE/actions/runner-groups/42 \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/enterprises/ENTERPRISE/actions/runner-groups/42 \\\n  -d '{\"name\":\"name\"}'
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('PATCH /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}', {\n enterprise: 'enterprise',\n runner_group_id: 42,\n name: 'name'\n})", + "html": "
    await octokit.request('PATCH /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}', {\n  enterprise: 'enterprise',\n  runner_group_id: 42,\n  name: 'name'\n})\n
    " + } + ], + "summary": "Update a self-hosted runner group for an enterprise", + "description": "Updates the `name` and `visibility` of a self-hosted runner group in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/update-self-hosted-runner-group-for-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#update-a-self-hosted-runner-group-for-an-enterprise" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "description": "

    Name of the runner group.

    ", + "type": "string", + "name": "name", + "in": "body", + "rawType": "string", + "rawDescription": "Name of the runner group.", + "childParamsGroups": [] + }, + "visibility": { + "description": "

    Visibility of a runner group. You can select all organizations or select individual organizations. Can be one of: all or selected

    ", + "type": "string", + "enum": [ + "selected", + "all" + ], + "default": "all", + "name": "visibility", + "in": "body", + "rawType": "string", + "rawDescription": "Visibility of a runner group. You can select all organizations or select individual organizations. Can be one of: `all` or `selected`", + "childParamsGroups": [] + } + } + }, + "example": { + "name": "Expensive hardware runners", + "visibility": "selected" + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [], + "category": "enterprise-admin", + "subcategory": "actions" + }, + "slug": "update-a-self-hosted-runner-group-for-an-enterprise", + "category": "enterprise-admin", + "categoryLabel": "Enterprise admin", + "subcategory": "actions", + "subcategoryLabel": "Actions", + "notes": [], + "descriptionHTML": "

    Updates the name and visibility of a self-hosted runner group in an enterprise.

    \n

    You must authenticate using an access token with the admin:enterprise scope to use this endpoint.

    ", + "bodyParameters": [ + { + "description": "

    Name of the runner group.

    ", + "type": "string", + "name": "name", + "in": "body", + "rawType": "string", + "rawDescription": "Name of the runner group.", + "childParamsGroups": [] + }, + { + "description": "

    Visibility of a runner group. You can select all organizations or select individual organizations. Can be one of: all or selected

    ", + "type": "string", + "enum": [ + "selected", + "all" + ], + "default": "all", + "name": "visibility", + "in": "body", + "rawType": "string", + "rawDescription": "Visibility of a runner group. You can select all organizations or select individual organizations. Can be one of: `all` or `selected`", + "childParamsGroups": [] + } + ], + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
    {\n  \"id\": 2,\n  \"name\": \"Expensive hardware runners\",\n  \"visibility\": \"selected\",\n  \"default\": false,\n  \"selected_organizations_url\": \"https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/organizations\",\n  \"runners_url\": \"https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/runners\",\n  \"allows_public_repositories\": true\n}\n
    " + } + ] + }, + { + "verb": "delete", + "requestPath": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    The slug version of the enterprise name. You can also substitute this value with the enterprise id.

    " + }, + { + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

    Unique identifier of the self-hosted runner group.

    " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/enterprises/ENTERPRISE/actions/runner-groups/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/enterprises/ENTERPRISE/actions/runner-groups/42
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('DELETE /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}', {\n enterprise: 'enterprise',\n runner_group_id: 42\n})", + "html": "
    await octokit.request('DELETE /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}', {\n  enterprise: 'enterprise',\n  runner_group_id: 42\n})\n
    " + } + ], + "summary": "Delete a self-hosted runner group from an enterprise", + "description": "Deletes a self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/delete-self-hosted-runner-group-from-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#delete-a-self-hosted-runner-group-from-an-enterprise" + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [], + "category": "enterprise-admin", + "subcategory": "actions" + }, + "slug": "delete-a-self-hosted-runner-group-from-an-enterprise", + "category": "enterprise-admin", + "categoryLabel": "Enterprise admin", + "subcategory": "actions", + "subcategoryLabel": "Actions", + "notes": [], + "responses": [ + { + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Response" + } + ], + "bodyParameters": [], + "descriptionHTML": "

    Deletes a self-hosted runner group for an enterprise.

    \n

    You must authenticate using an access token with the admin:enterprise scope to use this endpoint.

    " + }, + { + "verb": "get", + "requestPath": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    The slug version of the enterprise name. You can also substitute this value with the enterprise id.

    " + }, + { + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

    Unique identifier of the self-hosted runner group.

    " + }, + { + "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 http(s)://api.{hostname}/enterprises/ENTERPRISE/actions/runner-groups/42/runners", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/enterprises/ENTERPRISE/actions/runner-groups/42/runners
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners', {\n enterprise: 'enterprise',\n runner_group_id: 42\n})", + "html": "
    await octokit.request('GET /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners', {\n  enterprise: 'enterprise',\n  runner_group_id: 42\n})\n
    " + } + ], + "summary": "List self-hosted runners in a group for an enterprise", + "description": "Lists the self-hosted runners that are in a specific enterprise group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/list-self-hosted-runners-in-group-for-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#list-self-hosted-runners-in-a-group-for-an-enterprise" + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [], + "category": "enterprise-admin", + "subcategory": "actions" + }, + "slug": "list-self-hosted-runners-in-a-group-for-an-enterprise", + "category": "enterprise-admin", + "categoryLabel": "Enterprise admin", + "subcategory": "actions", + "subcategoryLabel": "Actions", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

    Lists the self-hosted runners that are in a specific enterprise group.

    \n

    You must authenticate using an access token with the admin:enterprise scope to use this endpoint.

    ", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
    {\n  \"total_count\": 2,\n  \"runners\": [\n    {\n      \"id\": 23,\n      \"name\": \"linux_runner\",\n      \"os\": \"linux\",\n      \"status\": \"online\",\n      \"busy\": true,\n      \"labels\": [\n        {\n          \"id\": 5,\n          \"name\": \"self-hosted\",\n          \"type\": \"read-only\"\n        },\n        {\n          \"id\": 7,\n          \"name\": \"X64\",\n          \"type\": \"read-only\"\n        },\n        {\n          \"id\": 11,\n          \"name\": \"Linux\",\n          \"type\": \"read-only\"\n        }\n      ]\n    },\n    {\n      \"id\": 24,\n      \"name\": \"mac_runner\",\n      \"os\": \"macos\",\n      \"status\": \"offline\",\n      \"busy\": false,\n      \"labels\": [\n        {\n          \"id\": 5,\n          \"name\": \"self-hosted\",\n          \"type\": \"read-only\"\n        },\n        {\n          \"id\": 7,\n          \"name\": \"X64\",\n          \"type\": \"read-only\"\n        },\n        {\n          \"id\": 20,\n          \"name\": \"macOS\",\n          \"type\": \"read-only\"\n        },\n        {\n          \"id\": 21,\n          \"name\": \"no-gpu\",\n          \"type\": \"custom\"\n        }\n      ]\n    }\n  ]\n}\n
    " + } + ] + }, + { + "verb": "put", + "requestPath": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    The slug version of the enterprise name. You can also substitute this value with the enterprise id.

    " + }, + { + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

    Unique identifier of the self-hosted runner group.

    " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/enterprises/ENTERPRISE/actions/runner-groups/42/runners \\\n -d '{\"runners\":[42]}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/enterprises/ENTERPRISE/actions/runner-groups/42/runners \\\n  -d '{\"runners\":[42]}'
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('PUT /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners', {\n enterprise: 'enterprise',\n runner_group_id: 42,\n runners: [\n 42\n ]\n})", + "html": "
    await octokit.request('PUT /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners', {\n  enterprise: 'enterprise',\n  runner_group_id: 42,\n  runners: [\n    42\n  ]\n})\n
    " + } + ], + "summary": "Set self-hosted runners in a group for an enterprise", + "description": "Replaces the list of self-hosted runners that are part of an enterprise runner group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/set-self-hosted-runners-in-group-for-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#set-self-hosted-runners-in-a-group-for-an-enterprise" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "runners": { + "description": "

    Required. List of runner IDs to add to the runner group.

    ", + "type": "array of integers", + "items": { + "type": "integer", + "description": "Unique identifier of the runner." + }, + "name": "runners", + "in": "body", + "rawType": "array", + "rawDescription": "List of runner IDs to add to the runner group.", + "childParamsGroups": [] + } + }, + "required": [ + "runners" + ] + }, + "example": { + "runners": [ + 9, + 2 + ] + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [], + "category": "enterprise-admin", + "subcategory": "actions" + }, + "slug": "set-self-hosted-runners-in-a-group-for-an-enterprise", + "category": "enterprise-admin", + "categoryLabel": "Enterprise admin", + "subcategory": "actions", + "subcategoryLabel": "Actions", + "notes": [], + "responses": [ + { + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Response" + } + ], + "descriptionHTML": "

    Replaces the list of self-hosted runners that are part of an enterprise runner group.

    \n

    You must authenticate using an access token with the admin:enterprise scope to use this endpoint.

    ", + "bodyParameters": [ + { + "description": "

    Required. List of runner IDs to add to the runner group.

    ", + "type": "array of integers", + "items": { + "type": "integer", + "description": "Unique identifier of the runner." + }, + "name": "runners", + "in": "body", + "rawType": "array", + "rawDescription": "List of runner IDs to add to the runner group.", + "childParamsGroups": [] + } + ] + }, + { + "verb": "put", + "requestPath": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    The slug version of the enterprise name. You can also substitute this value with the enterprise id.

    " + }, + { + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

    Unique identifier of the self-hosted runner group.

    " + }, + { + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

    Unique identifier of the self-hosted runner.

    " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/enterprises/ENTERPRISE/actions/runner-groups/42/runners/42", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/enterprises/ENTERPRISE/actions/runner-groups/42/runners/42
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('PUT /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}', {\n enterprise: 'enterprise',\n runner_group_id: 42,\n runner_id: 42\n})", + "html": "
    await octokit.request('PUT /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}', {\n  enterprise: 'enterprise',\n  runner_group_id: 42,\n  runner_id: 42\n})\n
    " + } + ], + "summary": "Add a self-hosted runner to a group for an enterprise", + "description": "Adds a self-hosted runner to a runner group configured in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise`\nscope to use this endpoint.", + "operationId": "enterprise-admin/add-self-hosted-runner-to-group-for-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#add-a-self-hosted-runner-to-a-group-for-an-enterprise" + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [], + "category": "enterprise-admin", + "subcategory": "actions" + }, + "slug": "add-a-self-hosted-runner-to-a-group-for-an-enterprise", + "category": "enterprise-admin", + "categoryLabel": "Enterprise admin", + "subcategory": "actions", + "subcategoryLabel": "Actions", + "notes": [], + "responses": [ + { + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Response" + } + ], + "bodyParameters": [], + "descriptionHTML": "

    Adds a self-hosted runner to a runner group configured in an enterprise.

    \n

    You must authenticate using an access token with the admin:enterprise\nscope to use this endpoint.

    " + }, + { + "verb": "delete", + "requestPath": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    The slug version of the enterprise name. You can also substitute this value with the enterprise id.

    " + }, + { + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

    Unique identifier of the self-hosted runner group.

    " + }, + { + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

    Unique identifier of the self-hosted runner.

    " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/enterprises/ENTERPRISE/actions/runner-groups/42/runners/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/enterprises/ENTERPRISE/actions/runner-groups/42/runners/42
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('DELETE /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}', {\n enterprise: 'enterprise',\n runner_group_id: 42,\n runner_id: 42\n})", + "html": "
    await octokit.request('DELETE /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}', {\n  enterprise: 'enterprise',\n  runner_group_id: 42,\n  runner_id: 42\n})\n
    " + } + ], + "summary": "Remove a self-hosted runner from a group for an enterprise", + "description": "Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#remove-a-self-hosted-runner-from-a-group-for-an-enterprise" + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [], + "category": "enterprise-admin", + "subcategory": "actions" + }, + "slug": "remove-a-self-hosted-runner-from-a-group-for-an-enterprise", + "category": "enterprise-admin", + "categoryLabel": "Enterprise admin", + "subcategory": "actions", + "subcategoryLabel": "Actions", + "notes": [], + "responses": [ + { + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Response" + } + ], + "bodyParameters": [], + "descriptionHTML": "

    Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.

    \n

    You must authenticate using an access token with the admin:enterprise scope to use this endpoint.

    " + }, + { + "verb": "get", + "requestPath": "/enterprises/{enterprise}/actions/runners", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    The slug version of the enterprise name. You can also substitute this value with the enterprise id.

    " + }, + { + "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 http(s)://api.{hostname}/enterprises/ENTERPRISE/actions/runners", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/enterprises/ENTERPRISE/actions/runners
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /enterprises/{enterprise}/actions/runners', {\n enterprise: 'enterprise'\n})", + "html": "
    await octokit.request('GET /enterprises/{enterprise}/actions/runners', {\n  enterprise: 'enterprise'\n})\n
    " + } + ], + "summary": "List self-hosted runners for an enterprise", + "description": "Lists all self-hosted runners configured for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/list-self-hosted-runners-for-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#list-self-hosted-runners-for-an-enterprise" + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [], + "category": "enterprise-admin", + "subcategory": "actions" + }, + "slug": "list-self-hosted-runners-for-an-enterprise", + "category": "enterprise-admin", + "categoryLabel": "Enterprise admin", + "subcategory": "actions", + "subcategoryLabel": "Actions", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

    Lists all self-hosted runners configured for an enterprise.

    \n

    You must authenticate using an access token with the admin:enterprise scope to use this endpoint.

    ", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
    {\n  \"total_count\": 2,\n  \"runners\": [\n    {\n      \"id\": 23,\n      \"name\": \"linux_runner\",\n      \"os\": \"linux\",\n      \"status\": \"online\",\n      \"busy\": true,\n      \"labels\": [\n        {\n          \"id\": 5,\n          \"name\": \"self-hosted\",\n          \"type\": \"read-only\"\n        },\n        {\n          \"id\": 7,\n          \"name\": \"X64\",\n          \"type\": \"read-only\"\n        },\n        {\n          \"id\": 11,\n          \"name\": \"Linux\",\n          \"type\": \"read-only\"\n        }\n      ]\n    },\n    {\n      \"id\": 24,\n      \"name\": \"mac_runner\",\n      \"os\": \"macos\",\n      \"status\": \"offline\",\n      \"busy\": false,\n      \"labels\": [\n        {\n          \"id\": 5,\n          \"name\": \"self-hosted\",\n          \"type\": \"read-only\"\n        },\n        {\n          \"id\": 7,\n          \"name\": \"X64\",\n          \"type\": \"read-only\"\n        },\n        {\n          \"id\": 20,\n          \"name\": \"macOS\",\n          \"type\": \"read-only\"\n        },\n        {\n          \"id\": 21,\n          \"name\": \"no-gpu\",\n          \"type\": \"custom\"\n        }\n      ]\n    }\n  ]\n}\n
    " + } + ] + }, + { + "verb": "get", + "requestPath": "/enterprises/{enterprise}/actions/runners/{runner_id}", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    The slug version of the enterprise name. You can also substitute this value with the enterprise id.

    " + }, + { + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

    Unique identifier of the self-hosted runner.

    " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/enterprises/ENTERPRISE/actions/runners/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/enterprises/ENTERPRISE/actions/runners/42
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /enterprises/{enterprise}/actions/runners/{runner_id}', {\n enterprise: 'enterprise',\n runner_id: 42\n})", + "html": "
    await octokit.request('GET /enterprises/{enterprise}/actions/runners/{runner_id}', {\n  enterprise: 'enterprise',\n  runner_id: 42\n})\n
    " + } + ], + "summary": "Get a self-hosted runner for an enterprise", + "description": "Gets a specific self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/get-self-hosted-runner-for-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#get-a-self-hosted-runner-for-an-enterprise" + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [], + "category": "enterprise-admin", + "subcategory": "actions" + }, + "slug": "get-a-self-hosted-runner-for-an-enterprise", + "category": "enterprise-admin", + "categoryLabel": "Enterprise admin", + "subcategory": "actions", + "subcategoryLabel": "Actions", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

    Gets a specific self-hosted runner configured in an enterprise.

    \n

    You must authenticate using an access token with the admin:enterprise scope to use this endpoint.

    ", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
    {\n  \"id\": 23,\n  \"name\": \"MBP\",\n  \"os\": \"macos\",\n  \"status\": \"online\",\n  \"busy\": true,\n  \"labels\": [\n    {\n      \"id\": 5,\n      \"name\": \"self-hosted\",\n      \"type\": \"read-only\"\n    },\n    {\n      \"id\": 7,\n      \"name\": \"X64\",\n      \"type\": \"read-only\"\n    },\n    {\n      \"id\": 20,\n      \"name\": \"macOS\",\n      \"type\": \"read-only\"\n    },\n    {\n      \"id\": 21,\n      \"name\": \"no-gpu\",\n      \"type\": \"custom\"\n    }\n  ]\n}\n
    " + } + ] + }, + { + "verb": "delete", + "requestPath": "/enterprises/{enterprise}/actions/runners/{runner_id}", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    The slug version of the enterprise name. You can also substitute this value with the enterprise id.

    " + }, + { + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

    Unique identifier of the self-hosted runner.

    " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/enterprises/ENTERPRISE/actions/runners/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/enterprises/ENTERPRISE/actions/runners/42
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('DELETE /enterprises/{enterprise}/actions/runners/{runner_id}', {\n enterprise: 'enterprise',\n runner_id: 42\n})", + "html": "
    await octokit.request('DELETE /enterprises/{enterprise}/actions/runners/{runner_id}', {\n  enterprise: 'enterprise',\n  runner_id: 42\n})\n
    " + } + ], + "summary": "Delete a self-hosted runner from an enterprise", + "description": "Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/delete-self-hosted-runner-from-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#delete-self-hosted-runner-from-an-enterprise" + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [], + "category": "enterprise-admin", + "subcategory": "actions" + }, + "slug": "delete-a-self-hosted-runner-from-an-enterprise", + "category": "enterprise-admin", + "categoryLabel": "Enterprise admin", + "subcategory": "actions", + "subcategoryLabel": "Actions", + "notes": [], + "responses": [ + { + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Response" + } + ], + "bodyParameters": [], + "descriptionHTML": "

    Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.

    \n

    You must authenticate using an access token with the admin:enterprise scope to use this endpoint.

    " + }, { "verb": "get", "requestPath": "/events", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "per_page", @@ -6522,8 +8478,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/events", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/events
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/events", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/events
    " }, { "lang": "JavaScript", @@ -6582,13 +8538,13 @@ { "verb": "get", "requestPath": "/feeds", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/feeds", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/feeds
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/feeds", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/feeds
    " }, { "lang": "JavaScript", @@ -6633,7 +8589,7 @@ { "verb": "get", "requestPath": "/gists", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "since", @@ -6669,8 +8625,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/gists", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/gists
    " }, { "lang": "JavaScript", @@ -6723,13 +8679,13 @@ { "verb": "post", "requestPath": "/gists", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists \\\n -d '{\"files\":{}}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists \\\n  -d '{\"files\":{}}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/gists \\\n -d '{\"files\":{}}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/gists \\\n  -d '{\"files\":{}}'
    " }, { "lang": "JavaScript", @@ -6927,7 +8883,7 @@ { "verb": "get", "requestPath": "/gists/public", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "since", @@ -6963,8 +8919,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/public", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/public
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/gists/public", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/gists/public
    " }, { "lang": "JavaScript", @@ -7022,7 +8978,7 @@ { "verb": "get", "requestPath": "/gists/starred", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "since", @@ -7058,8 +9014,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/starred", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/starred
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/gists/starred", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/gists/starred
    " }, { "lang": "JavaScript", @@ -7117,7 +9073,7 @@ { "verb": "get", "requestPath": "/gists/{gist_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "gist_id", @@ -7133,8 +9089,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/gists/GIST_ID", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/gists/GIST_ID
    " }, { "lang": "JavaScript", @@ -7192,7 +9148,7 @@ { "verb": "patch", "requestPath": "/gists/{gist_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "gist_id", @@ -7208,8 +9164,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID \\\n -d '{\"description\":\"description\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID \\\n  -d '{\"description\":\"description\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/gists/GIST_ID \\\n -d '{\"description\":\"description\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/gists/GIST_ID \\\n  -d '{\"description\":\"description\"}'
    " }, { "lang": "JavaScript", @@ -7399,7 +9355,7 @@ { "verb": "delete", "requestPath": "/gists/{gist_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "gist_id", @@ -7415,8 +9371,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/gists/GIST_ID", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/gists/GIST_ID
    " }, { "lang": "JavaScript", @@ -7449,7 +9405,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -7473,7 +9429,7 @@ { "verb": "get", "requestPath": "/gists/{gist_id}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "gist_id", @@ -7509,8 +9465,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/comments", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/comments
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/gists/GIST_ID/comments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/gists/GIST_ID/comments
    " }, { "lang": "JavaScript", @@ -7570,7 +9526,7 @@ { "verb": "post", "requestPath": "/gists/{gist_id}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "gist_id", @@ -7586,8 +9542,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/comments \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/comments \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/gists/GIST_ID/comments \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/gists/GIST_ID/comments \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -7684,7 +9640,7 @@ { "verb": "get", "requestPath": "/gists/{gist_id}/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "gist_id", @@ -7710,8 +9666,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/comments/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/comments/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/gists/GIST_ID/comments/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/gists/GIST_ID/comments/42
    " }, { "lang": "JavaScript", @@ -7771,7 +9727,7 @@ { "verb": "patch", "requestPath": "/gists/{gist_id}/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "gist_id", @@ -7797,8 +9753,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/comments/42 \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/comments/42 \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/gists/GIST_ID/comments/42 \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/gists/GIST_ID/comments/42 \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -7885,7 +9841,7 @@ { "verb": "delete", "requestPath": "/gists/{gist_id}/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "gist_id", @@ -7911,8 +9867,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/comments/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/comments/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/gists/GIST_ID/comments/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/gists/GIST_ID/comments/42
    " }, { "lang": "JavaScript", @@ -7947,7 +9903,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -7971,7 +9927,7 @@ { "verb": "get", "requestPath": "/gists/{gist_id}/commits", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "gist_id", @@ -8007,8 +9963,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/commits", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/commits
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/gists/GIST_ID/commits", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/gists/GIST_ID/commits
    " }, { "lang": "JavaScript", @@ -8066,7 +10022,7 @@ { "verb": "get", "requestPath": "/gists/{gist_id}/forks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "gist_id", @@ -8102,8 +10058,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/forks", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/forks
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/gists/GIST_ID/forks", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/gists/GIST_ID/forks
    " }, { "lang": "JavaScript", @@ -8161,7 +10117,7 @@ { "verb": "post", "requestPath": "/gists/{gist_id}/forks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "gist_id", @@ -8177,8 +10133,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/forks", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/forks
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/gists/GIST_ID/forks", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/gists/GIST_ID/forks
    " }, { "lang": "JavaScript", @@ -8241,7 +10197,7 @@ { "verb": "get", "requestPath": "/gists/{gist_id}/star", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "gist_id", @@ -8257,8 +10213,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/star", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/star
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/gists/GIST_ID/star", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/gists/GIST_ID/star
    " }, { "lang": "JavaScript", @@ -8315,7 +10271,7 @@ { "verb": "put", "requestPath": "/gists/{gist_id}/star", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "gist_id", @@ -8331,8 +10287,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/star", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/star
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/gists/GIST_ID/star", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/gists/GIST_ID/star
    " }, { "lang": "JavaScript", @@ -8365,7 +10321,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -8389,7 +10345,7 @@ { "verb": "delete", "requestPath": "/gists/{gist_id}/star", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "gist_id", @@ -8405,8 +10361,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/star", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/star
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/gists/GIST_ID/star", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/gists/GIST_ID/star
    " }, { "lang": "JavaScript", @@ -8439,7 +10395,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -8463,7 +10419,7 @@ { "verb": "get", "requestPath": "/gists/{gist_id}/{sha}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "gist_id", @@ -8488,8 +10444,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/SHA", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/SHA
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/gists/GIST_ID/SHA", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/gists/GIST_ID/SHA
    " }, { "lang": "JavaScript", @@ -8547,13 +10503,13 @@ { "verb": "get", "requestPath": "/gitignore/templates", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gitignore/templates", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gitignore/templates
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/gitignore/templates", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/gitignore/templates
    " }, { "lang": "JavaScript", @@ -8601,7 +10557,7 @@ { "verb": "get", "requestPath": "/gitignore/templates/{name}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "name", @@ -8616,8 +10572,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gitignore/templates/NAME", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gitignore/templates/NAME
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/gitignore/templates/NAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/gitignore/templates/NAME
    " }, { "lang": "JavaScript", @@ -8665,7 +10621,7 @@ { "verb": "get", "requestPath": "/installation/repositories", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "per_page", @@ -8691,8 +10647,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/installation/repositories", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/installation/repositories
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/installation/repositories", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/installation/repositories
    " }, { "lang": "JavaScript", @@ -8759,13 +10715,13 @@ { "verb": "delete", "requestPath": "/installation/token", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/installation/token", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/installation/token
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/installation/token", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/installation/token
    " }, { "lang": "JavaScript", @@ -8800,7 +10756,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -8809,7 +10765,7 @@ { "verb": "get", "requestPath": "/issues", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "filter", @@ -8823,6 +10779,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -8956,8 +10913,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/issues", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/issues
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/issues", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/issues
    " }, { "lang": "JavaScript", @@ -9022,7 +10979,7 @@ { "verb": "get", "requestPath": "/licenses", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "featured", @@ -9042,13 +10999,23 @@ "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/licenses", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/licenses
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/licenses", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/licenses
    " }, { "lang": "JavaScript", @@ -9096,7 +11063,7 @@ { "verb": "get", "requestPath": "/licenses/{license}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "license", @@ -9111,8 +11078,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/licenses/LICENSE", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/licenses/LICENSE
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/licenses/LICENSE", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/licenses/LICENSE
    " }, { "lang": "JavaScript", @@ -9170,13 +11137,13 @@ { "verb": "post", "requestPath": "/markdown", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/markdown \\\n -d '{\"text\":\"text\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/markdown \\\n  -d '{\"text\":\"text\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/markdown \\\n -d '{\"text\":\"text\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/markdown \\\n  -d '{\"text\":\"text\"}'
    " }, { "lang": "JavaScript", @@ -9304,13 +11271,13 @@ { "verb": "post", "requestPath": "/markdown/raw", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/markdown/raw", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/markdown/raw
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/markdown/raw", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/markdown/raw
    " }, { "lang": "JavaScript", @@ -9371,13 +11338,13 @@ { "verb": "get", "requestPath": "/meta", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/meta", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/meta
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/meta", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/meta
    " }, { "lang": "JavaScript", @@ -9425,7 +11392,7 @@ { "verb": "get", "requestPath": "/networks/{owner}/{repo}/events", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -9469,8 +11436,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/networks/octocat/hello-world/events", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/networks/octocat/hello-world/events
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/networks/octocat/hello-world/events", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/networks/octocat/hello-world/events
    " }, { "lang": "JavaScript", @@ -9534,7 +11501,7 @@ { "verb": "get", "requestPath": "/notifications", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "all", @@ -9602,8 +11569,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/notifications", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/notifications
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/notifications", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/notifications
    " }, { "lang": "JavaScript", @@ -9668,13 +11635,13 @@ { "verb": "put", "requestPath": "/notifications", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/notifications \\\n -d '{\"last_read_at\":\"last_read_at\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/notifications \\\n  -d '{\"last_read_at\":\"last_read_at\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/notifications \\\n -d '{\"last_read_at\":\"last_read_at\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/notifications \\\n  -d '{\"last_read_at\":\"last_read_at\"}'
    " }, { "lang": "JavaScript", @@ -9788,7 +11755,7 @@ { "verb": "get", "requestPath": "/notifications/threads/{thread_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "thread_id", @@ -9804,8 +11771,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/notifications/threads/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/notifications/threads/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/notifications/threads/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/notifications/threads/42
    " }, { "lang": "JavaScript", @@ -9865,7 +11832,7 @@ { "verb": "patch", "requestPath": "/notifications/threads/{thread_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "thread_id", @@ -9881,8 +11848,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/notifications/threads/42", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/notifications/threads/42
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/notifications/threads/42", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/notifications/threads/42
    " }, { "lang": "JavaScript", @@ -9936,7 +11903,7 @@ { "verb": "get", "requestPath": "/notifications/threads/{thread_id}/subscription", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "thread_id", @@ -9952,8 +11919,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/notifications/threads/42/subscription", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/notifications/threads/42/subscription
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/notifications/threads/42/subscription", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/notifications/threads/42/subscription
    " }, { "lang": "JavaScript", @@ -10013,7 +11980,7 @@ { "verb": "put", "requestPath": "/notifications/threads/{thread_id}/subscription", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "thread_id", @@ -10029,8 +11996,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/notifications/threads/42/subscription \\\n -d '{\"ignored\":true}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/notifications/threads/42/subscription \\\n  -d '{\"ignored\":true}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/notifications/threads/42/subscription \\\n -d '{\"ignored\":true}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/notifications/threads/42/subscription \\\n  -d '{\"ignored\":true}'
    " }, { "lang": "JavaScript", @@ -10122,7 +12089,7 @@ { "verb": "delete", "requestPath": "/notifications/threads/{thread_id}/subscription", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "thread_id", @@ -10138,8 +12105,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/notifications/threads/42/subscription", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/notifications/threads/42/subscription
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/notifications/threads/42/subscription", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/notifications/threads/42/subscription
    " }, { "lang": "JavaScript", @@ -10174,7 +12141,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -10198,7 +12165,7 @@ { "verb": "get", "requestPath": "/octocat", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "s", @@ -10214,8 +12181,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/octocat", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/octocat
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/octocat", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/octocat
    " }, { "lang": "JavaScript", @@ -10252,7 +12219,7 @@ { "verb": "get", "requestPath": "/organizations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "since", @@ -10278,8 +12245,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/organizations", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/organizations
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/organizations", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/organizations
    " }, { "lang": "JavaScript", @@ -10327,7 +12294,7 @@ { "verb": "get", "requestPath": "/orgs/{org}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "org", @@ -10342,8 +12309,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/orgs/ORG
    " }, { "lang": "JavaScript", @@ -10386,13 +12353,7 @@ "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "
    {\n  \"login\": \"github\",\n  \"id\": 1,\n  \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n  \"url\": \"https://api.github.com/orgs/github\",\n  \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n  \"events_url\": \"https://api.github.com/orgs/github/events\",\n  \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n  \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n  \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n  \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n  \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n  \"description\": \"A great organization\",\n  \"name\": \"github\",\n  \"company\": \"GitHub\",\n  \"blog\": \"https://github.com/blog\",\n  \"location\": \"San Francisco\",\n  \"email\": \"octocat@github.com\",\n  \"twitter_username\": \"github\",\n  \"is_verified\": true,\n  \"has_organization_projects\": true,\n  \"has_repository_projects\": true,\n  \"public_repos\": 2,\n  \"public_gists\": 1,\n  \"followers\": 20,\n  \"following\": 0,\n  \"html_url\": \"https://github.com/octocat\",\n  \"created_at\": \"2008-01-14T04:33:35Z\",\n  \"updated_at\": \"2014-03-03T18:58:10Z\",\n  \"type\": \"Organization\",\n  \"total_private_repos\": 100,\n  \"owned_private_repos\": 100,\n  \"private_gists\": 81,\n  \"disk_usage\": 10000,\n  \"collaborators\": 8,\n  \"billing_email\": \"mona@github.com\",\n  \"plan\": {\n    \"name\": \"Medium\",\n    \"space\": 400,\n    \"private_repos\": 20\n  },\n  \"default_repository_permission\": \"read\",\n  \"members_can_create_repositories\": true,\n  \"two_factor_requirement_enabled\": true,\n  \"members_allowed_repository_creation_type\": \"all\",\n  \"members_can_create_public_repositories\": false,\n  \"members_can_create_private_repositories\": false,\n  \"members_can_create_internal_repositories\": false,\n  \"members_can_create_pages\": true\n}\n
    " - }, - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response with GitHub plan information", - "payload": "
    {\n  \"login\": \"github\",\n  \"id\": 1,\n  \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n  \"url\": \"https://api.github.com/orgs/github\",\n  \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n  \"events_url\": \"https://api.github.com/orgs/github/events\",\n  \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n  \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n  \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n  \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n  \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n  \"description\": \"A great organization\",\n  \"name\": \"github\",\n  \"company\": \"GitHub\",\n  \"blog\": \"https://github.com/blog\",\n  \"location\": \"San Francisco\",\n  \"email\": \"octocat@github.com\",\n  \"twitter_username\": \"github\",\n  \"is_verified\": true,\n  \"has_organization_projects\": true,\n  \"has_repository_projects\": true,\n  \"public_repos\": 2,\n  \"public_gists\": 1,\n  \"followers\": 20,\n  \"following\": 0,\n  \"html_url\": \"https://github.com/octocat\",\n  \"created_at\": \"2008-01-14T04:33:35Z\",\n  \"updated_at\": \"2014-03-03T18:58:10Z\",\n  \"type\": \"Organization\",\n  \"plan\": {\n    \"name\": \"team\",\n    \"space\": 976562499,\n    \"private_repos\": 999999,\n    \"filled_seats\": 4,\n    \"seats\": 5\n  }\n}\n
    " + "payload": "
    {\n  \"login\": \"github\",\n  \"id\": 1,\n  \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n  \"url\": \"https://api.github.com/orgs/github\",\n  \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n  \"events_url\": \"https://api.github.com/orgs/github/events\",\n  \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n  \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n  \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n  \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n  \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n  \"description\": \"A great organization\",\n  \"name\": \"github\",\n  \"company\": \"GitHub\",\n  \"blog\": \"https://github.com/blog\",\n  \"location\": \"San Francisco\",\n  \"email\": \"octocat@github.com\",\n  \"twitter_username\": \"github\",\n  \"is_verified\": true,\n  \"has_organization_projects\": true,\n  \"has_repository_projects\": true,\n  \"public_repos\": 2,\n  \"public_gists\": 1,\n  \"followers\": 20,\n  \"following\": 0,\n  \"html_url\": \"https://github.com/octocat\",\n  \"created_at\": \"2008-01-14T04:33:35Z\",\n  \"updated_at\": \"2014-03-03T18:58:10Z\",\n  \"type\": \"Organization\",\n  \"total_private_repos\": 100,\n  \"owned_private_repos\": 100,\n  \"private_gists\": 81,\n  \"disk_usage\": 10000,\n  \"collaborators\": 8,\n  \"billing_email\": \"mona@github.com\",\n  \"plan\": {\n    \"name\": \"Medium\",\n    \"space\": 400,\n    \"private_repos\": 20,\n    \"filled_seats\": 4,\n    \"seats\": 5\n  },\n  \"default_repository_permission\": \"read\",\n  \"members_can_create_repositories\": true,\n  \"two_factor_requirement_enabled\": true,\n  \"members_allowed_repository_creation_type\": \"all\",\n  \"members_can_create_public_repositories\": false,\n  \"members_can_create_private_repositories\": false,\n  \"members_can_create_internal_repositories\": false,\n  \"members_can_create_pages\": true\n}\n
    " }, { "httpStatusCode": "404", @@ -10404,7 +12365,7 @@ { "verb": "patch", "requestPath": "/orgs/{org}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "org", @@ -10419,8 +12380,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG \\\n -d '{\"billing_email\":\"billing_email\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG \\\n  -d '{\"billing_email\":\"billing_email\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG \\\n -d '{\"billing_email\":\"billing_email\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/orgs/ORG \\\n  -d '{\"billing_email\":\"billing_email\"}'
    " }, { "lang": "JavaScript", @@ -10882,8 +12843,204 @@ }, { "verb": "get", - "requestPath": "/orgs/{org}/events", - "serverUrl": "https://api.github.com", + "requestPath": "/orgs/{org}/actions/permissions", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG/actions/permissions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/actions/permissions
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /orgs/{org}/actions/permissions', {\n org: 'org'\n})", + "html": "
    await octokit.request('GET /orgs/{org}/actions/permissions', {\n  org: 'org'\n})\n
    " + } + ], + "summary": "Get GitHub Actions permissions for an organization", + "description": "Gets the GitHub Actions permissions policy for repositories and allowed actions in an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", + "operationId": "actions/get-github-actions-permissions-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#get-github-actions-permissions-for-an-organization" + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [], + "category": "actions", + "subcategory": "permissions" + }, + "slug": "get-github-actions-permissions-for-an-organization", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "permissions", + "subcategoryLabel": "Permissions", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

    Gets the GitHub Actions permissions policy for repositories and allowed actions in an organization.

    \n

    You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.

    ", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
    {\n  \"enabled_repositories\": \"all\",\n  \"allowed_actions\": \"selected\",\n  \"selected_actions_url\": \"https://api.github.com/organizations/42/actions/permissions/selected-actions\"\n}\n
    " + } + ] + }, + { + "verb": "put", + "requestPath": "/orgs/{org}/actions/permissions", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG/actions/permissions \\\n -d '{\"enabled_repositories\":\"enabled_repositories\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/actions/permissions \\\n  -d '{\"enabled_repositories\":\"enabled_repositories\"}'
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('PUT /orgs/{org}/actions/permissions', {\n org: 'org',\n enabled_repositories: 'enabled_repositories'\n})", + "html": "
    await octokit.request('PUT /orgs/{org}/actions/permissions', {\n  org: 'org',\n  enabled_repositories: 'enabled_repositories'\n})\n
    " + } + ], + "summary": "Set GitHub Actions permissions for an organization", + "description": "Sets the GitHub Actions permissions policy for repositories and allowed actions in an organization.\n\nIf the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as `allowed_actions` to `selected` actions, then you cannot override them for the organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", + "operationId": "actions/set-github-actions-permissions-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#set-github-actions-permissions-for-an-organization" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "enabled_repositories": { + "type": "string", + "description": "

    Required. The policy that controls the repositories in the organization that are allowed to run GitHub Actions. Can be one of: all, none, or selected.

    ", + "enum": [ + "all", + "none", + "selected" + ], + "name": "enabled_repositories", + "in": "body", + "rawType": "string", + "rawDescription": "The policy that controls the repositories in the organization that are allowed to run GitHub Actions. Can be one of: `all`, `none`, or `selected`.", + "childParamsGroups": [] + }, + "allowed_actions": { + "type": "string", + "description": "

    The permissions policy that controls the actions that are allowed to run. Can be one of: all, local_only, or selected.

    ", + "enum": [ + "all", + "local_only", + "selected" + ], + "name": "allowed_actions", + "in": "body", + "rawType": "string", + "rawDescription": "The permissions policy that controls the actions that are allowed to run. Can be one of: `all`, `local_only`, or `selected`.", + "childParamsGroups": [] + } + }, + "required": [ + "enabled_repositories" + ] + }, + "example": { + "enabled_repositories": "all", + "allowed_actions": "selected" + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [], + "category": "actions", + "subcategory": "permissions" + }, + "slug": "set-github-actions-permissions-for-an-organization", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "permissions", + "subcategoryLabel": "Permissions", + "notes": [], + "responses": [ + { + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Response" + } + ], + "descriptionHTML": "

    Sets the GitHub Actions permissions policy for repositories and allowed actions in an organization.

    \n

    If the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as allowed_actions to selected actions, then you cannot override them for the organization.

    \n

    You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.

    ", + "bodyParameters": [ + { + "type": "string", + "description": "

    Required. The policy that controls the repositories in the organization that are allowed to run GitHub Actions. Can be one of: all, none, or selected.

    ", + "enum": [ + "all", + "none", + "selected" + ], + "name": "enabled_repositories", + "in": "body", + "rawType": "string", + "rawDescription": "The policy that controls the repositories in the organization that are allowed to run GitHub Actions. Can be one of: `all`, `none`, or `selected`.", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

    The permissions policy that controls the actions that are allowed to run. Can be one of: all, local_only, or selected.

    ", + "enum": [ + "all", + "local_only", + "selected" + ], + "name": "allowed_actions", + "in": "body", + "rawType": "string", + "rawDescription": "The permissions policy that controls the actions that are allowed to run. Can be one of: `all`, `local_only`, or `selected`.", + "childParamsGroups": [] + } + ] + }, + { + "verb": "get", + "requestPath": "/orgs/{org}/actions/permissions/repositories", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "org", @@ -10918,8 +13075,1844 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/events", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/events
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG/actions/permissions/repositories", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/actions/permissions/repositories
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /orgs/{org}/actions/permissions/repositories', {\n org: 'org'\n})", + "html": "
    await octokit.request('GET /orgs/{org}/actions/permissions/repositories', {\n  org: 'org'\n})\n
    " + } + ], + "summary": "List selected repositories enabled for GitHub Actions in an organization", + "description": "Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", + "operationId": "actions/list-selected-repositories-enabled-github-actions-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#list-selected-repositories-enabled-for-github-actions-in-an-organization" + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [], + "category": "actions", + "subcategory": "permissions" + }, + "slug": "list-selected-repositories-enabled-for-github-actions-in-an-organization", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "permissions", + "subcategoryLabel": "Permissions", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

    Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"

    \n

    You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.

    ", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
    {\n  \"total_count\": 1,\n  \"repositories\": [\n    {\n      \"id\": 1296269,\n      \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n      \"name\": \"Hello-World\",\n      \"full_name\": \"octocat/Hello-World\",\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      \"private\": false,\n      \"html_url\": \"https://github.com/octocat/Hello-World\",\n      \"description\": \"This your first repo!\",\n      \"fork\": false,\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n      \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n      \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n      \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n      \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n      \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n      \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n      \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n      \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n      \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n      \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n      \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n      \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n      \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n      \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n      \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n      \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n      \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n      \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n      \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n      \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n      \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n      \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n      \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n      \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n      \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n      \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n      \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n      \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n      \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n      \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n      \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n      \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n      \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n      \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n      \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n      \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n      \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n      \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n      \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n      \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n      \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n      \"homepage\": \"https://github.com\",\n      \"language\": null,\n      \"forks_count\": 9,\n      \"stargazers_count\": 80,\n      \"watchers_count\": 80,\n      \"size\": 108,\n      \"default_branch\": \"master\",\n      \"open_issues_count\": 0,\n      \"is_template\": true,\n      \"topics\": [\n        \"octocat\",\n        \"atom\",\n        \"electron\",\n        \"api\"\n      ],\n      \"has_issues\": true,\n      \"has_projects\": true,\n      \"has_wiki\": true,\n      \"has_pages\": false,\n      \"has_downloads\": true,\n      \"archived\": false,\n      \"disabled\": false,\n      \"visibility\": \"public\",\n      \"pushed_at\": \"2011-01-26T19:06:43Z\",\n      \"created_at\": \"2011-01-26T19:01:12Z\",\n      \"updated_at\": \"2011-01-26T19:14:43Z\",\n      \"permissions\": {\n        \"admin\": false,\n        \"push\": false,\n        \"pull\": true\n      },\n      \"allow_rebase_merge\": true,\n      \"template_repository\": null,\n      \"temp_clone_token\": \"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\n      \"allow_squash_merge\": true,\n      \"delete_branch_on_merge\": true,\n      \"allow_merge_commit\": true,\n      \"subscribers_count\": 42,\n      \"network_count\": 0,\n      \"license\": {\n        \"key\": \"mit\",\n        \"name\": \"MIT License\",\n        \"url\": \"https://api.github.com/licenses/mit\",\n        \"spdx_id\": \"MIT\",\n        \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n        \"html_url\": \"https://github.com/licenses/mit\"\n      },\n      \"forks\": 1,\n      \"open_issues\": 1,\n      \"watchers\": 1\n    }\n  ]\n}\n
    " + } + ] + }, + { + "verb": "put", + "requestPath": "/orgs/{org}/actions/permissions/repositories", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG/actions/permissions/repositories \\\n -d '{\"selected_repository_ids\":[42]}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/actions/permissions/repositories \\\n  -d '{\"selected_repository_ids\":[42]}'
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('PUT /orgs/{org}/actions/permissions/repositories', {\n org: 'org',\n selected_repository_ids: [\n 42\n ]\n})", + "html": "
    await octokit.request('PUT /orgs/{org}/actions/permissions/repositories', {\n  org: 'org',\n  selected_repository_ids: [\n    42\n  ]\n})\n
    " + } + ], + "summary": "Set selected repositories enabled for GitHub Actions in an organization", + "description": "Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", + "operationId": "actions/set-selected-repositories-enabled-github-actions-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#set-selected-repositories-enabled-for-github-actions-in-an-organization" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "selected_repository_ids": { + "description": "

    Required. List of repository IDs to enable for GitHub Actions.

    ", + "type": "array of integers", + "items": { + "type": "integer", + "description": "Unique identifier of the repository." + }, + "name": "selected_repository_ids", + "in": "body", + "rawType": "array", + "rawDescription": "List of repository IDs to enable for GitHub Actions.", + "childParamsGroups": [] + } + }, + "required": [ + "selected_repository_ids" + ] + }, + "example": { + "selected_repository_ids": [ + 32, + 42 + ] + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [], + "category": "actions", + "subcategory": "permissions" + }, + "slug": "set-selected-repositories-enabled-for-github-actions-in-an-organization", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "permissions", + "subcategoryLabel": "Permissions", + "notes": [], + "responses": [ + { + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Response" + } + ], + "descriptionHTML": "

    Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"

    \n

    You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.

    ", + "bodyParameters": [ + { + "description": "

    Required. List of repository IDs to enable for GitHub Actions.

    ", + "type": "array of integers", + "items": { + "type": "integer", + "description": "Unique identifier of the repository." + }, + "name": "selected_repository_ids", + "in": "body", + "rawType": "array", + "rawDescription": "List of repository IDs to enable for GitHub Actions.", + "childParamsGroups": [] + } + ] + }, + { + "verb": "put", + "requestPath": "/orgs/{org}/actions/permissions/repositories/{repository_id}", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repository_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG/actions/permissions/repositories/42", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/actions/permissions/repositories/42
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('PUT /orgs/{org}/actions/permissions/repositories/{repository_id}', {\n org: 'org',\n repository_id: 42\n})", + "html": "
    await octokit.request('PUT /orgs/{org}/actions/permissions/repositories/{repository_id}', {\n  org: 'org',\n  repository_id: 42\n})\n
    " + } + ], + "summary": "Enable a selected repository for GitHub Actions in an organization", + "description": "Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", + "operationId": "actions/enable-selected-repository-github-actions-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#enable-a-selected-repository-for-github-actions-in-an-organization" + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [], + "category": "actions", + "subcategory": "permissions" + }, + "slug": "enable-a-selected-repository-for-github-actions-in-an-organization", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "permissions", + "subcategoryLabel": "Permissions", + "notes": [], + "responses": [ + { + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Response" + } + ], + "bodyParameters": [], + "descriptionHTML": "

    Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories must be must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"

    \n

    You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.

    " + }, + { + "verb": "delete", + "requestPath": "/orgs/{org}/actions/permissions/repositories/{repository_id}", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repository_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG/actions/permissions/repositories/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/actions/permissions/repositories/42
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('DELETE /orgs/{org}/actions/permissions/repositories/{repository_id}', {\n org: 'org',\n repository_id: 42\n})", + "html": "
    await octokit.request('DELETE /orgs/{org}/actions/permissions/repositories/{repository_id}', {\n  org: 'org',\n  repository_id: 42\n})\n
    " + } + ], + "summary": "Disable a selected repository for GitHub Actions in an organization", + "description": "Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", + "operationId": "actions/disable-selected-repository-github-actions-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#disable-a-selected-repository-for-github-actions-in-an-organization" + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [], + "category": "actions", + "subcategory": "permissions" + }, + "slug": "disable-a-selected-repository-for-github-actions-in-an-organization", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "permissions", + "subcategoryLabel": "Permissions", + "notes": [], + "responses": [ + { + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Response" + } + ], + "bodyParameters": [], + "descriptionHTML": "

    Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"

    \n

    You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.

    " + }, + { + "verb": "get", + "requestPath": "/orgs/{org}/actions/permissions/selected-actions", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG/actions/permissions/selected-actions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/actions/permissions/selected-actions
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /orgs/{org}/actions/permissions/selected-actions', {\n org: 'org'\n})", + "html": "
    await octokit.request('GET /orgs/{org}/actions/permissions/selected-actions', {\n  org: 'org'\n})\n
    " + } + ], + "summary": "Get allowed actions for an organization", + "description": "Gets the selected actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", + "operationId": "actions/get-allowed-actions-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#get-allowed-actions-for-an-organization" + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [], + "category": "actions", + "subcategory": "permissions" + }, + "slug": "get-allowed-actions-for-an-organization", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "permissions", + "subcategoryLabel": "Permissions", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

    Gets the selected actions that are allowed in an organization. To use this endpoint, the organization permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"\"

    \n

    You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.

    ", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
    {\n  \"github_owned_allowed\": true,\n  \"verified_allowed\": false,\n  \"patterns_allowed\": [\n    \"monalisa/octocat@*\",\n    \"docker/*\"\n  ]\n}\n
    " + } + ] + }, + { + "verb": "put", + "requestPath": "/orgs/{org}/actions/permissions/selected-actions", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG/actions/permissions/selected-actions \\\n -d '{\"github_owned_allowed\":true,\"patterns_allowed\":[\"patterns_allowed\"],\"verified_allowed\":true}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/actions/permissions/selected-actions \\\n  -d '{\"github_owned_allowed\":true,\"patterns_allowed\":[\"patterns_allowed\"],\"verified_allowed\":true}'
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('PUT /orgs/{org}/actions/permissions/selected-actions', {\n org: 'org',\n github_owned_allowed: true,\n patterns_allowed: [\n 'patterns_allowed'\n ],\n verified_allowed: true\n})", + "html": "
    await octokit.request('PUT /orgs/{org}/actions/permissions/selected-actions', {\n  org: 'org',\n  github_owned_allowed: true,\n  patterns_allowed: [\n    'patterns_allowed'\n  ],\n  verified_allowed: true\n})\n
    " + } + ], + "summary": "Set allowed actions for an organization", + "description": "Sets the actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nIf the organization belongs to an enterprise that has `selected` actions set at the enterprise level, then you cannot override any of the enterprise's allowed actions settings.\n\nTo use the `patterns_allowed` setting for private repositories, the organization must belong to an enterprise. If the organization does not belong to an enterprise, then the `patterns_allowed` setting only applies to public repositories in the organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", + "operationId": "actions/set-allowed-actions-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#set-allowed-actions-for-an-organization" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "github_owned_allowed": { + "type": "boolean", + "description": "

    Required. Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

    ", + "name": "github_owned_allowed", + "in": "body", + "rawType": "boolean", + "rawDescription": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization.", + "childParamsGroups": [] + }, + "verified_allowed": { + "type": "boolean", + "description": "

    Required. Whether actions in GitHub Marketplace from verified creators are allowed. Set to true to allow all GitHub Marketplace actions by verified creators.

    ", + "name": "verified_allowed", + "in": "body", + "rawType": "boolean", + "rawDescription": "Whether actions in GitHub Marketplace from verified creators are allowed. Set to `true` to allow all GitHub Marketplace actions by verified creators.", + "childParamsGroups": [] + }, + "patterns_allowed": { + "type": "array of strings", + "description": "

    Required. Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"

    ", + "items": { + "type": "string" + }, + "name": "patterns_allowed", + "in": "body", + "rawType": "array", + "rawDescription": "Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"", + "childParamsGroups": [] + } + }, + "required": [ + "github_owned_allowed", + "patterns_allowed", + "verified_allowed" + ] + }, + "examples": { + "selected_actions": { + "value": { + "github_owned_allowed": true, + "verified_allowed": false, + "patterns_allowed": [ + "monalisa/octocat@*", + "docker/*" + ] + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [], + "category": "actions", + "subcategory": "permissions" + }, + "slug": "set-allowed-actions-for-an-organization", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "permissions", + "subcategoryLabel": "Permissions", + "notes": [], + "responses": [ + { + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Response" + } + ], + "descriptionHTML": "

    Sets the actions that are allowed in an organization. To use this endpoint, the organization permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"

    \n

    If the organization belongs to an enterprise that has selected actions set at the enterprise level, then you cannot override any of the enterprise's allowed actions settings.

    \n

    To use the patterns_allowed setting for private repositories, the organization must belong to an enterprise. If the organization does not belong to an enterprise, then the patterns_allowed setting only applies to public repositories in the organization.

    \n

    You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.

    ", + "bodyParameters": [ + { + "type": "boolean", + "description": "

    Required. Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

    ", + "name": "github_owned_allowed", + "in": "body", + "rawType": "boolean", + "rawDescription": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization.", + "childParamsGroups": [] + }, + { + "type": "boolean", + "description": "

    Required. Whether actions in GitHub Marketplace from verified creators are allowed. Set to true to allow all GitHub Marketplace actions by verified creators.

    ", + "name": "verified_allowed", + "in": "body", + "rawType": "boolean", + "rawDescription": "Whether actions in GitHub Marketplace from verified creators are allowed. Set to `true` to allow all GitHub Marketplace actions by verified creators.", + "childParamsGroups": [] + }, + { + "type": "array of strings", + "description": "

    Required. Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"

    ", + "items": { + "type": "string" + }, + "name": "patterns_allowed", + "in": "body", + "rawType": "array", + "rawDescription": "Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"", + "childParamsGroups": [] + } + ] + }, + { + "verb": "post", + "requestPath": "/orgs/{org}/actions/runner-groups", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG/actions/runner-groups \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/actions/runner-groups \\\n  -d '{\"name\":\"name\"}'
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('POST /orgs/{org}/actions/runner-groups', {\n org: 'org',\n name: 'name'\n})", + "html": "
    await octokit.request('POST /orgs/{org}/actions/runner-groups', {\n  org: 'org',\n  name: 'name'\n})\n
    " + } + ], + "summary": "Create a self-hosted runner group for an organization", + "description": "The self-hosted runner groups REST API is available with GitHub Enterprise Cloud and GitHub Enterprise Server. For more information, see \"[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products).\"\n\nCreates a new self-hosted runner group for an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", + "operationId": "actions/create-self-hosted-runner-group-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#create-a-self-hosted-runner-group-for-an-organization" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "description": "

    Required. Name of the runner group.

    ", + "type": "string", + "name": "name", + "in": "body", + "rawType": "string", + "rawDescription": "Name of the runner group.", + "childParamsGroups": [] + }, + "visibility": { + "description": "

    Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories. Can be one of: all, selected, or private.

    ", + "type": "string", + "enum": [ + "selected", + "all", + "private" + ], + "default": "all", + "name": "visibility", + "in": "body", + "rawType": "string", + "rawDescription": "Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories. Can be one of: `all`, `selected`, or `private`.", + "childParamsGroups": [] + }, + "selected_repository_ids": { + "description": "

    List of repository IDs that can access the runner group.

    ", + "type": "array of integers", + "items": { + "type": "integer", + "description": "Unique identifier of the repository." + }, + "name": "selected_repository_ids", + "in": "body", + "rawType": "array", + "rawDescription": "List of repository IDs that can access the runner group.", + "childParamsGroups": [] + }, + "runners": { + "description": "

    List of runner IDs to add to the runner group.

    ", + "type": "array of integers", + "items": { + "type": "integer", + "description": "Unique identifier of the runner." + }, + "name": "runners", + "in": "body", + "rawType": "array", + "rawDescription": "List of runner IDs to add to the runner group.", + "childParamsGroups": [] + } + }, + "required": [ + "name" + ] + }, + "example": { + "name": "Expensive hardware runners", + "visibility": "selected", + "selected_repository_ids": [ + 32, + 91 + ], + "runners": [ + 9, + 2 + ] + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [], + "category": "actions", + "subcategory": "self-hosted-runner-groups" + }, + "slug": "create-a-self-hosted-runner-group-for-an-organization", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "self-hosted-runner-groups", + "subcategoryLabel": "Self hosted runner groups", + "notes": [], + "descriptionHTML": "

    The self-hosted runner groups REST API is available with GitHub Enterprise Cloud and GitHub Enterprise Server. For more information, see \"GitHub's products.\"

    \n

    Creates a new self-hosted runner group for an organization.

    \n

    You must authenticate using an access token with the admin:org scope to use this endpoint.

    ", + "bodyParameters": [ + { + "description": "

    Required. Name of the runner group.

    ", + "type": "string", + "name": "name", + "in": "body", + "rawType": "string", + "rawDescription": "Name of the runner group.", + "childParamsGroups": [] + }, + { + "description": "

    Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories. Can be one of: all, selected, or private.

    ", + "type": "string", + "enum": [ + "selected", + "all", + "private" + ], + "default": "all", + "name": "visibility", + "in": "body", + "rawType": "string", + "rawDescription": "Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories. Can be one of: `all`, `selected`, or `private`.", + "childParamsGroups": [] + }, + { + "description": "

    List of repository IDs that can access the runner group.

    ", + "type": "array of integers", + "items": { + "type": "integer", + "description": "Unique identifier of the repository." + }, + "name": "selected_repository_ids", + "in": "body", + "rawType": "array", + "rawDescription": "List of repository IDs that can access the runner group.", + "childParamsGroups": [] + }, + { + "description": "

    List of runner IDs to add to the runner group.

    ", + "type": "array of integers", + "items": { + "type": "integer", + "description": "Unique identifier of the runner." + }, + "name": "runners", + "in": "body", + "rawType": "array", + "rawDescription": "List of runner IDs to add to the runner group.", + "childParamsGroups": [] + } + ], + "responses": [ + { + "httpStatusCode": "201", + "httpStatusMessage": "Created", + "description": "Default response", + "payload": "
    {\n  \"id\": 2,\n  \"name\": \"octo-runner-group\",\n  \"visibility\": \"selected\",\n  \"default\": false,\n  \"selected_repositories_url\": \"https://api.github.com/orgs/octo-org/actions/runner-groups/2/repositories\",\n  \"runners_url\": \"https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners\",\n  \"inherited\": false,\n  \"allows_public_repositories\": true\n}\n
    " + } + ] + }, + { + "verb": "patch", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

    Unique identifier of the self-hosted runner group.

    " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG/actions/runner-groups/42 \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/actions/runner-groups/42 \\\n  -d '{\"name\":\"name\"}'
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('PATCH /orgs/{org}/actions/runner-groups/{runner_group_id}', {\n org: 'org',\n runner_group_id: 42,\n name: 'name'\n})", + "html": "
    await octokit.request('PATCH /orgs/{org}/actions/runner-groups/{runner_group_id}', {\n  org: 'org',\n  runner_group_id: 42,\n  name: 'name'\n})\n
    " + } + ], + "summary": "Update a self-hosted runner group for an organization", + "description": "The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products).\"\n\nUpdates the `name` and `visibility` of a self-hosted runner group in an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", + "operationId": "actions/update-self-hosted-runner-group-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#update-a-self-hosted-runner-group-for-an-organization" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "description": "

    Name of the runner group.

    ", + "type": "string", + "name": "name", + "in": "body", + "rawType": "string", + "rawDescription": "Name of the runner group.", + "childParamsGroups": [] + }, + "visibility": { + "description": "

    Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories. Can be one of: all, selected, or private.

    ", + "type": "string", + "enum": [ + "selected", + "all", + "private" + ], + "name": "visibility", + "in": "body", + "rawType": "string", + "rawDescription": "Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories. Can be one of: `all`, `selected`, or `private`.", + "childParamsGroups": [] + } + } + }, + "example": { + "name": "Expensive hardware runners", + "visibility": "selected" + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [], + "category": "actions", + "subcategory": "self-hosted-runner-groups" + }, + "slug": "update-a-self-hosted-runner-group-for-an-organization", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "self-hosted-runner-groups", + "subcategoryLabel": "Self hosted runner groups", + "notes": [], + "descriptionHTML": "

    The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see \"GitHub's products.\"

    \n

    Updates the name and visibility of a self-hosted runner group in an organization.

    \n

    You must authenticate using an access token with the admin:org scope to use this endpoint.

    ", + "bodyParameters": [ + { + "description": "

    Name of the runner group.

    ", + "type": "string", + "name": "name", + "in": "body", + "rawType": "string", + "rawDescription": "Name of the runner group.", + "childParamsGroups": [] + }, + { + "description": "

    Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories. Can be one of: all, selected, or private.

    ", + "type": "string", + "enum": [ + "selected", + "all", + "private" + ], + "name": "visibility", + "in": "body", + "rawType": "string", + "rawDescription": "Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories. Can be one of: `all`, `selected`, or `private`.", + "childParamsGroups": [] + } + ], + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
    {\n  \"id\": 2,\n  \"name\": \"octo-runner-group\",\n  \"visibility\": \"selected\",\n  \"default\": false,\n  \"selected_repositories_url\": \"https://api.github.com/orgs/octo-org/actions/runner-groups/2/repositories\",\n  \"runners_url\": \"https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners\",\n  \"inherited\": false,\n  \"allows_public_repositories\": true\n}\n
    " + } + ] + }, + { + "verb": "delete", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

    Unique identifier of the self-hosted runner group.

    " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG/actions/runner-groups/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/actions/runner-groups/42
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('DELETE /orgs/{org}/actions/runner-groups/{runner_group_id}', {\n org: 'org',\n runner_group_id: 42\n})", + "html": "
    await octokit.request('DELETE /orgs/{org}/actions/runner-groups/{runner_group_id}', {\n  org: 'org',\n  runner_group_id: 42\n})\n
    " + } + ], + "summary": "Delete a self-hosted runner group from an organization", + "description": "The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products).\"\n\nDeletes a self-hosted runner group for an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", + "operationId": "actions/delete-self-hosted-runner-group-from-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#delete-a-self-hosted-runner-group-from-an-organization" + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [], + "category": "actions", + "subcategory": "self-hosted-runner-groups" + }, + "slug": "delete-a-self-hosted-runner-group-from-an-organization", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "self-hosted-runner-groups", + "subcategoryLabel": "Self hosted runner groups", + "notes": [], + "responses": [ + { + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Response" + } + ], + "bodyParameters": [], + "descriptionHTML": "

    The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see \"GitHub's products.\"

    \n

    Deletes a self-hosted runner group for an organization.

    \n

    You must authenticate using an access token with the admin:org scope to use this endpoint.

    " + }, + { + "verb": "delete", + "requestPath": "/orgs/{org}/actions/runners/{runner_id}", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

    Unique identifier of the self-hosted runner.

    " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG/actions/runners/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/actions/runners/42
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('DELETE /orgs/{org}/actions/runners/{runner_id}', {\n org: 'org',\n runner_id: 42\n})", + "html": "
    await octokit.request('DELETE /orgs/{org}/actions/runners/{runner_id}', {\n  org: 'org',\n  runner_id: 42\n})\n
    " + } + ], + "summary": "Delete a self-hosted runner from an organization", + "description": "Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-self-hosted-runner-from-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#delete-a-self-hosted-runner-from-an-organization" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "self-hosted-runners" + }, + "slug": "delete-a-self-hosted-runner-from-an-organization", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "self-hosted-runners", + "subcategoryLabel": "Self hosted runners", + "notes": [], + "responses": [ + { + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Response" + } + ], + "bodyParameters": [], + "descriptionHTML": "

    Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.

    \n

    You must authenticate using an access token with the admin:org scope to use this endpoint.

    " + }, + { + "verb": "get", + "requestPath": "/orgs/{org}/actions/secrets", + "serverUrl": "http(s)://api.{hostname}", + "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 http(s)://api.{hostname}/orgs/ORG/actions/secrets", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/actions/secrets
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /orgs/{org}/actions/secrets', {\n org: 'org'\n})", + "html": "
    await octokit.request('GET /orgs/{org}/actions/secrets', {\n  org: 'org'\n})\n
    " + } + ], + "summary": "List organization secrets", + "description": "Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/list-org-secrets", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#list-organization-secrets" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "secrets" + }, + "slug": "list-organization-secrets", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "secrets", + "subcategoryLabel": "Secrets", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

    Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the secrets organization permission to use this endpoint.

    ", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
    {\n  \"total_count\": 3,\n  \"secrets\": [\n    {\n      \"name\": \"GIST_ID\",\n      \"created_at\": \"2019-08-10T14:59:22Z\",\n      \"updated_at\": \"2020-01-10T14:59:22Z\",\n      \"visibility\": \"private\"\n    },\n    {\n      \"name\": \"DEPLOY_TOKEN\",\n      \"created_at\": \"2019-08-10T14:59:22Z\",\n      \"updated_at\": \"2020-01-10T14:59:22Z\",\n      \"visibility\": \"all\"\n    },\n    {\n      \"name\": \"GH_TOKEN\",\n      \"created_at\": \"2019-08-10T14:59:22Z\",\n      \"updated_at\": \"2020-01-10T14:59:22Z\",\n      \"visibility\": \"selected\",\n      \"selected_repositories_url\": \"https://api.github.com/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories\"\n    }\n  ]\n}\n
    " + } + ] + }, + { + "verb": "get", + "requestPath": "/orgs/{org}/actions/secrets/public-key", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG/actions/secrets/public-key", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/actions/secrets/public-key
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /orgs/{org}/actions/secrets/public-key', {\n org: 'org'\n})", + "html": "
    await octokit.request('GET /orgs/{org}/actions/secrets/public-key', {\n  org: 'org'\n})\n
    " + } + ], + "summary": "Get an organization public key", + "description": "Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-org-public-key", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#get-an-organization-public-key" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "secrets" + }, + "slug": "get-an-organization-public-key", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "secrets", + "subcategoryLabel": "Secrets", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

    Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the secrets organization permission to use this endpoint.

    ", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
    {\n  \"key_id\": \"012345678912345678\",\n  \"key\": \"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234\"\n}\n
    " + } + ] + }, + { + "verb": "get", + "requestPath": "/orgs/{org}/actions/secrets/{secret_name}", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "secret_name", + "description": "secret_name parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    secret_name parameter

    " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG/actions/secrets/SECRET_NAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/actions/secrets/SECRET_NAME
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /orgs/{org}/actions/secrets/{secret_name}', {\n org: 'org',\n secret_name: 'secret_name'\n})", + "html": "
    await octokit.request('GET /orgs/{org}/actions/secrets/{secret_name}', {\n  org: 'org',\n  secret_name: 'secret_name'\n})\n
    " + } + ], + "summary": "Get an organization secret", + "description": "Gets a single organization secret without revealing its encrypted value. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#get-an-organization-secret" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "secrets" + }, + "slug": "get-an-organization-secret", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "secrets", + "subcategoryLabel": "Secrets", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

    Gets a single organization secret without revealing its encrypted value. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the secrets organization permission to use this endpoint.

    ", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
    {\n  \"name\": \"GH_TOKEN\",\n  \"created_at\": \"2019-08-10T14:59:22Z\",\n  \"updated_at\": \"2020-01-10T14:59:22Z\",\n  \"visibility\": \"selected\",\n  \"selected_repositories_url\": \"https://api.github.com/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories\"\n}\n
    " + } + ] + }, + { + "verb": "put", + "requestPath": "/orgs/{org}/actions/secrets/{secret_name}", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "secret_name", + "description": "secret_name parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    secret_name parameter

    " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG/actions/secrets/SECRET_NAME \\\n -d '{\"encrypted_value\":\"encrypted_value\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/actions/secrets/SECRET_NAME \\\n  -d '{\"encrypted_value\":\"encrypted_value\"}'
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('PUT /orgs/{org}/actions/secrets/{secret_name}', {\n org: 'org',\n secret_name: 'secret_name',\n encrypted_value: 'encrypted_value'\n})", + "html": "
    await octokit.request('PUT /orgs/{org}/actions/secrets/{secret_name}', {\n  org: 'org',\n  secret_name: 'secret_name',\n  encrypted_value: 'encrypted_value'\n})\n
    " + } + ], + "summary": "Create or update an organization secret", + "description": "Creates or updates an organization secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access\ntoken with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to\nuse this endpoint.\n\n#### Example encrypting a secret using Node.js\n\nEncrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library.\n\n```\nconst sodium = require('tweetsodium');\n\nconst key = \"base64-encoded-public-key\";\nconst value = \"plain-text-secret\";\n\n// Convert the message and key to Uint8Array's (Buffer implements that interface)\nconst messageBytes = Buffer.from(value);\nconst keyBytes = Buffer.from(key, 'base64');\n\n// Encrypt using LibSodium.\nconst encryptedBytes = sodium.seal(messageBytes, keyBytes);\n\n// Base64 the encrypted secret\nconst encrypted = Buffer.from(encryptedBytes).toString('base64');\n\nconsole.log(encrypted);\n```\n\n\n#### Example encrypting a secret using Python\n\nEncrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/stable/public/#nacl-public-sealedbox) with Python 3.\n\n```\nfrom base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n sealed_box = public.SealedBox(public_key)\n encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n return b64encode(encrypted).decode(\"utf-8\")\n```\n\n#### Example encrypting a secret using C#\n\nEncrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.\n\n```\nvar secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\n```\n\n#### Example encrypting a secret using Ruby\n\nEncrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.\n\n```ruby\nrequire \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\n```", + "tags": [ + "actions" + ], + "operationId": "actions/create-or-update-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#create-or-update-an-organization-secret" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "encrypted_value": { + "type": "string", + "description": "

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an organization public key endpoint.

    ", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", + "name": "encrypted_value", + "in": "body", + "rawType": "string", + "rawDescription": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/github-ae@latest/rest/reference/actions#get-an-organization-public-key) endpoint.", + "childParamsGroups": [] + }, + "key_id": { + "type": "string", + "description": "

    ID of the key you used to encrypt the secret.

    ", + "name": "key_id", + "in": "body", + "rawType": "string", + "rawDescription": "ID of the key you used to encrypt the secret.", + "childParamsGroups": [] + }, + "visibility": { + "type": "string", + "description": "

    Configures the access that repositories have to the organization secret. Can be one of:
    \n- all - All repositories in an organization can access the secret.
    \n- private - Private repositories in an organization can access the secret.
    \n- selected - Only specific repositories can access the secret.

    ", + "enum": [ + "all", + "private", + "selected" + ], + "name": "visibility", + "in": "body", + "rawType": "string", + "rawDescription": "Configures the access that repositories have to the organization secret. Can be one of: \n\\- `all` - All repositories in an organization can access the secret. \n\\- `private` - Private repositories in an organization can access the secret. \n\\- `selected` - Only specific repositories can access the secret.", + "childParamsGroups": [] + }, + "selected_repository_ids": { + "type": "array of strings", + "description": "

    An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints.

    ", + "items": { + "type": "string" + }, + "name": "selected_repository_ids", + "in": "body", + "rawType": "array", + "rawDescription": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/github-ae@latest/rest/reference/actions#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/github-ae@latest/rest/reference/actions#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/github-ae@latest/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints.", + "childParamsGroups": [] + } + } + }, + "example": { + "encrypted_value": "c2VjcmV0", + "key_id": "012345678912345678", + "visibility": "selected", + "selected_repository_ids": [ + "1296269", + "1296280" + ] + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "secrets" + }, + "slug": "create-or-update-an-organization-secret", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "secrets", + "subcategoryLabel": "Secrets", + "notes": [], + "responses": [ + { + "httpStatusCode": "201", + "httpStatusMessage": "Created", + "description": "Response when creating a secret" + }, + { + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Response when updating a secret" + } + ], + "descriptionHTML": "

    Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the admin:org scope to use this endpoint. GitHub Apps must have the secrets organization permission to\nuse this endpoint.

    \n

    Example encrypting a secret using Node.js

    \n

    Encrypt your secret using the tweetsodium library.

    \n
    const sodium = require('tweetsodium');\n\nconst key = \"base64-encoded-public-key\";\nconst value = \"plain-text-secret\";\n\n// Convert the message and key to Uint8Array's (Buffer implements that interface)\nconst messageBytes = Buffer.from(value);\nconst keyBytes = Buffer.from(key, 'base64');\n\n// Encrypt using LibSodium.\nconst encryptedBytes = sodium.seal(messageBytes, keyBytes);\n\n// Base64 the encrypted secret\nconst encrypted = Buffer.from(encryptedBytes).toString('base64');\n\nconsole.log(encrypted);\n
    \n

    Example encrypting a secret using Python

    \n

    Encrypt your secret using pynacl with Python 3.

    \n
    from base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n  \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n  public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n  sealed_box = public.SealedBox(public_key)\n  encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n  return b64encode(encrypted).decode(\"utf-8\")\n
    \n

    Example encrypting a secret using C#

    \n

    Encrypt your secret using the Sodium.Core package.

    \n
    var secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\n
    \n

    Example encrypting a secret using Ruby

    \n

    Encrypt your secret using the rbnacl gem.

    \n
    require \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\n
    ", + "bodyParameters": [ + { + "type": "string", + "description": "

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an organization public key endpoint.

    ", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", + "name": "encrypted_value", + "in": "body", + "rawType": "string", + "rawDescription": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/github-ae@latest/rest/reference/actions#get-an-organization-public-key) endpoint.", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

    ID of the key you used to encrypt the secret.

    ", + "name": "key_id", + "in": "body", + "rawType": "string", + "rawDescription": "ID of the key you used to encrypt the secret.", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

    Configures the access that repositories have to the organization secret. Can be one of:
    \n- all - All repositories in an organization can access the secret.
    \n- private - Private repositories in an organization can access the secret.
    \n- selected - Only specific repositories can access the secret.

    ", + "enum": [ + "all", + "private", + "selected" + ], + "name": "visibility", + "in": "body", + "rawType": "string", + "rawDescription": "Configures the access that repositories have to the organization secret. Can be one of: \n\\- `all` - All repositories in an organization can access the secret. \n\\- `private` - Private repositories in an organization can access the secret. \n\\- `selected` - Only specific repositories can access the secret.", + "childParamsGroups": [] + }, + { + "type": "array of strings", + "description": "

    An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints.

    ", + "items": { + "type": "string" + }, + "name": "selected_repository_ids", + "in": "body", + "rawType": "array", + "rawDescription": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/github-ae@latest/rest/reference/actions#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/github-ae@latest/rest/reference/actions#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/github-ae@latest/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints.", + "childParamsGroups": [] + } + ] + }, + { + "verb": "delete", + "requestPath": "/orgs/{org}/actions/secrets/{secret_name}", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "secret_name", + "description": "secret_name parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    secret_name parameter

    " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG/actions/secrets/SECRET_NAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/actions/secrets/SECRET_NAME
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('DELETE /orgs/{org}/actions/secrets/{secret_name}', {\n org: 'org',\n secret_name: 'secret_name'\n})", + "html": "
    await octokit.request('DELETE /orgs/{org}/actions/secrets/{secret_name}', {\n  org: 'org',\n  secret_name: 'secret_name'\n})\n
    " + } + ], + "summary": "Delete an organization secret", + "description": "Deletes a secret in an organization using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#delete-an-organization-secret" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "secrets" + }, + "slug": "delete-an-organization-secret", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "secrets", + "subcategoryLabel": "Secrets", + "notes": [], + "responses": [ + { + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Response" + } + ], + "bodyParameters": [], + "descriptionHTML": "

    Deletes a secret in an organization using the secret name. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the secrets organization permission to use this endpoint.

    " + }, + { + "verb": "get", + "requestPath": "/orgs/{org}/actions/secrets/{secret_name}/repositories", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "secret_name", + "description": "secret_name parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    secret_name parameter

    " + }, + { + "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.

    " + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "descriptionHTML": "

    Results per page (max 100).

    " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG/actions/secrets/SECRET_NAME/repositories", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/actions/secrets/SECRET_NAME/repositories
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /orgs/{org}/actions/secrets/{secret_name}/repositories', {\n org: 'org',\n secret_name: 'secret_name'\n})", + "html": "
    await octokit.request('GET /orgs/{org}/actions/secrets/{secret_name}/repositories', {\n  org: 'org',\n  secret_name: 'secret_name'\n})\n
    " + } + ], + "summary": "List selected repositories for an organization secret", + "description": "Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/list-selected-repos-for-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#list-selected-repositories-for-an-organization-secret" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "secrets" + }, + "slug": "list-selected-repositories-for-an-organization-secret", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "secrets", + "subcategoryLabel": "Secrets", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

    Lists all repositories that have been selected when the visibility for repository access to a secret is set to selected. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the secrets organization permission to use this endpoint.

    ", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
    {\n  \"total_count\": 1,\n  \"repositories\": [\n    {\n      \"id\": 1296269,\n      \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n      \"name\": \"Hello-World\",\n      \"full_name\": \"octocat/Hello-World\",\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      \"private\": false,\n      \"html_url\": \"https://github.com/octocat/Hello-World\",\n      \"description\": \"This your first repo!\",\n      \"fork\": false,\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n      \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n      \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n      \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n      \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n      \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n      \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n      \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n      \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n      \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n      \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n      \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n      \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n      \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n      \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n      \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n      \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n      \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n      \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n      \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n      \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n      \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n      \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n      \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n      \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n      \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n      \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n      \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n      \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n      \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n      \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n      \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n      \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n      \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n      \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n      \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n      \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n      \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n      \"hooks_url\": \"http://api.github.com/repos/octocat/Hello-World/hooks\"\n    }\n  ]\n}\n
    " + } + ] + }, + { + "verb": "put", + "requestPath": "/orgs/{org}/actions/secrets/{secret_name}/repositories", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "secret_name", + "description": "secret_name parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    secret_name parameter

    " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG/actions/secrets/SECRET_NAME/repositories \\\n -d '{\"selected_repository_ids\":[42]}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/actions/secrets/SECRET_NAME/repositories \\\n  -d '{\"selected_repository_ids\":[42]}'
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('PUT /orgs/{org}/actions/secrets/{secret_name}/repositories', {\n org: 'org',\n secret_name: 'secret_name',\n selected_repository_ids: [\n 42\n ]\n})", + "html": "
    await octokit.request('PUT /orgs/{org}/actions/secrets/{secret_name}/repositories', {\n  org: 'org',\n  secret_name: 'secret_name',\n  selected_repository_ids: [\n    42\n  ]\n})\n
    " + } + ], + "summary": "Set selected repositories for an organization secret", + "description": "Replaces all repositories for an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/github-ae@latest/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/set-selected-repos-for-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#set-selected-repositories-for-an-organization-secret" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "selected_repository_ids": { + "type": "array of integers", + "description": "

    An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can add and remove individual repositories using the Set selected repositories for an organization secret and Remove selected repository from an organization secret endpoints.

    ", + "items": { + "type": "integer" + }, + "name": "selected_repository_ids", + "in": "body", + "rawType": "array", + "rawDescription": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/github-ae@latest/rest/reference/actions#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/github-ae@latest/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints.", + "childParamsGroups": [] + } + } + }, + "example": { + "selected_repository_ids": [ + 64780797 + ] + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "secrets" + }, + "slug": "set-selected-repositories-for-an-organization-secret", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "secrets", + "subcategoryLabel": "Secrets", + "notes": [], + "responses": [ + { + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Response" + } + ], + "descriptionHTML": "

    Replaces all repositories for an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the secrets organization permission to use this endpoint.

    ", + "bodyParameters": [ + { + "type": "array of integers", + "description": "

    An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can add and remove individual repositories using the Set selected repositories for an organization secret and Remove selected repository from an organization secret endpoints.

    ", + "items": { + "type": "integer" + }, + "name": "selected_repository_ids", + "in": "body", + "rawType": "array", + "rawDescription": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/github-ae@latest/rest/reference/actions#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/github-ae@latest/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints.", + "childParamsGroups": [] + } + ] + }, + { + "verb": "put", + "requestPath": "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "secret_name", + "description": "secret_name parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    secret_name parameter

    " + }, + { + "name": "repository_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG/actions/secrets/SECRET_NAME/repositories/42", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/actions/secrets/SECRET_NAME/repositories/42
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('PUT /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}', {\n org: 'org',\n secret_name: 'secret_name',\n repository_id: 42\n})", + "html": "
    await octokit.request('PUT /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}', {\n  org: 'org',\n  secret_name: 'secret_name',\n  repository_id: 42\n})\n
    " + } + ], + "summary": "Add selected repository to an organization secret", + "description": "Adds a repository to an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/github-ae@latest/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/add-selected-repo-to-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#add-selected-repository-to-an-organization-secret" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "secrets" + }, + "slug": "add-selected-repository-to-an-organization-secret", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "secrets", + "subcategoryLabel": "Secrets", + "notes": [], + "responses": [ + { + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Response when repository was added to the selected list" + }, + { + "httpStatusCode": "409", + "httpStatusMessage": "Conflict", + "description": "Response when visibility type is not set to selected" + } + ], + "bodyParameters": [], + "descriptionHTML": "

    Adds a repository to an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the secrets organization permission to use this endpoint.

    " + }, + { + "verb": "delete", + "requestPath": "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "secret_name", + "description": "secret_name parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    secret_name parameter

    " + }, + { + "name": "repository_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG/actions/secrets/SECRET_NAME/repositories/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/actions/secrets/SECRET_NAME/repositories/42
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('DELETE /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}', {\n org: 'org',\n secret_name: 'secret_name',\n repository_id: 42\n})", + "html": "
    await octokit.request('DELETE /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}', {\n  org: 'org',\n  secret_name: 'secret_name',\n  repository_id: 42\n})\n
    " + } + ], + "summary": "Remove selected repository from an organization secret", + "description": "Removes a repository from an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/github-ae@latest/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/remove-selected-repo-from-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#remove-selected-repository-from-an-organization-secret" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "secrets" + }, + "slug": "remove-selected-repository-from-an-organization-secret", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "secrets", + "subcategoryLabel": "Secrets", + "notes": [], + "responses": [ + { + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Response when repository was removed from the selected list" + }, + { + "httpStatusCode": "409", + "httpStatusMessage": "Conflict", + "description": "Response when visibility type not set to selected" + } + ], + "bodyParameters": [], + "descriptionHTML": "

    Removes a repository from an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the secrets organization permission to use this endpoint.

    " + }, + { + "verb": "get", + "requestPath": "/orgs/{org}/events", + "serverUrl": "http(s)://api.{hostname}", + "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 http(s)://api.{hostname}/orgs/ORG/events", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/events
    " }, { "lang": "JavaScript", @@ -10963,7 +14956,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/hooks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "org", @@ -10998,8 +14991,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/hooks", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/hooks
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG/hooks", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/hooks
    " }, { "lang": "JavaScript", @@ -11049,7 +15042,7 @@ { "verb": "post", "requestPath": "/orgs/{org}/hooks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "org", @@ -11064,8 +15057,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/hooks \\\n -d '{\"name\":\"name\",\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"username\":\"username\",\"password\":\"password\"}}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/hooks \\\n  -d '{\"name\":\"name\",\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"username\":\"username\",\"password\":\"password\"}}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG/hooks \\\n -d '{\"name\":\"name\",\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"username\":\"username\",\"password\":\"password\"}}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/hooks \\\n  -d '{\"name\":\"name\",\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"username\":\"username\",\"password\":\"password\"}}'
    " }, { "lang": "JavaScript", @@ -11496,7 +15489,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/hooks/{hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "org", @@ -11520,8 +15513,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/hooks/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/hooks/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG/hooks/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/hooks/42
    " }, { "lang": "JavaScript", @@ -11571,7 +15564,7 @@ { "verb": "patch", "requestPath": "/orgs/{org}/hooks/{hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "org", @@ -11595,8 +15588,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/hooks/42 \\\n -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/hooks/42 \\\n  -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG/hooks/42 \\\n -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/hooks/42 \\\n  -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'
    " }, { "lang": "JavaScript", @@ -11945,7 +15938,7 @@ { "verb": "delete", "requestPath": "/orgs/{org}/hooks/{hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "org", @@ -11969,8 +15962,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/hooks/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/hooks/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG/hooks/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/hooks/42
    " }, { "lang": "JavaScript", @@ -12005,7 +15998,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -12019,7 +16012,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/hooks/{hook_id}/config", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "org", @@ -12043,8 +16036,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/hooks/42/config", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/hooks/42/config
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG/hooks/42/config", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/hooks/42/config
    " }, { "lang": "JavaScript", @@ -12089,7 +16082,7 @@ { "verb": "patch", "requestPath": "/orgs/{org}/hooks/{hook_id}/config", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "org", @@ -12113,8 +16106,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/hooks/42/config \\\n -d '{\"url\":\"url\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/hooks/42/config \\\n  -d '{\"url\":\"url\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG/hooks/42/config \\\n -d '{\"url\":\"url\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/hooks/42/config \\\n  -d '{\"url\":\"url\"}'
    " }, { "lang": "JavaScript", @@ -12259,7 +16252,7 @@ { "verb": "post", "requestPath": "/orgs/{org}/hooks/{hook_id}/pings", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "org", @@ -12283,8 +16276,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/hooks/42/pings", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/hooks/42/pings
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG/hooks/42/pings", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/hooks/42/pings
    " }, { "lang": "JavaScript", @@ -12319,7 +16312,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -12333,7 +16326,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/installation", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "org", @@ -12348,8 +16341,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/installation", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/installation
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG/installation", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/installation
    " }, { "lang": "JavaScript", @@ -12392,7 +16385,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/installations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "org", @@ -12427,8 +16420,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/installations", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/installations
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG/installations", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/installations
    " }, { "lang": "JavaScript", @@ -12471,7 +16464,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/issues", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "org", @@ -12494,6 +16487,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -12591,8 +16585,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/issues", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/issues
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG/issues", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/issues
    " }, { "lang": "JavaScript", @@ -12647,7 +16641,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/members", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "org", @@ -12713,8 +16707,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/members", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/members
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG/members", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/members
    " }, { "lang": "JavaScript", @@ -12769,7 +16763,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/members/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "org", @@ -12793,8 +16787,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/members/USERNAME", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/members/USERNAME
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG/members/USERNAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/members/USERNAME
    " }, { "lang": "JavaScript", @@ -12848,7 +16842,7 @@ { "verb": "delete", "requestPath": "/orgs/{org}/members/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "org", @@ -12872,8 +16866,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/members/USERNAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/members/USERNAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG/members/USERNAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/members/USERNAME
    " }, { "lang": "JavaScript", @@ -12908,7 +16902,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -12922,7 +16916,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/memberships/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "org", @@ -12946,8 +16940,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/memberships/USERNAME", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/memberships/USERNAME
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG/memberships/USERNAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/memberships/USERNAME
    " }, { "lang": "JavaScript", @@ -12956,7 +16950,7 @@ } ], "summary": "Get organization membership for a user", - "description": "In order to get a user's membership with an organization, the authenticated user must be an organization member.", + "description": "In order to get a user's membership with an organization, the authenticated user must be an organization member. The `state` parameter in the response can be used to identify the user's membership status.", "tags": [ "orgs" ], @@ -12979,7 +16973,7 @@ "subcategoryLabel": "Members", "notes": [], "bodyParameters": [], - "descriptionHTML": "

    In order to get a user's membership with an organization, the authenticated user must be an organization member.

    ", + "descriptionHTML": "

    In order to get a user's membership with an organization, the authenticated user must be an organization member. The state parameter in the response can be used to identify the user's membership status.

    ", "responses": [ { "httpStatusCode": "200", @@ -12987,18 +16981,6 @@ "description": "Response if user has an active admin membership with organization", "payload": "
    {\n  \"url\": \"https://api.github.com/orgs/octocat/memberships/defunkt\",\n  \"state\": \"active\",\n  \"role\": \"admin\",\n  \"organization_url\": \"https://api.github.com/orgs/octocat\",\n  \"organization\": {\n    \"login\": \"github\",\n    \"id\": 1,\n    \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n    \"url\": \"https://api.github.com/orgs/github\",\n    \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n    \"events_url\": \"https://api.github.com/orgs/github/events\",\n    \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n    \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n    \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n    \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"description\": \"A great organization\"\n  },\n  \"user\": {\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
    " }, - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response if user has an active membership with organization", - "payload": "
    {\n  \"url\": \"https://api.github.com/orgs/octocat/memberships/defunkt\",\n  \"state\": \"active\",\n  \"role\": \"member\",\n  \"organization_url\": \"https://api.github.com/orgs/octocat\",\n  \"organization\": {\n    \"login\": \"github\",\n    \"id\": 1,\n    \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n    \"url\": \"https://api.github.com/orgs/github\",\n    \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n    \"events_url\": \"https://api.github.com/orgs/github/events\",\n    \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n    \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n    \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n    \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"description\": \"A great organization\"\n  },\n  \"user\": {\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
    " - }, - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response if user has a pending membership with organization", - "payload": "
    {\n  \"url\": \"https://api.github.com/orgs/invitocat/memberships/defunkt\",\n  \"state\": \"pending\",\n  \"role\": \"member\",\n  \"organization_url\": \"https://api.github.com/orgs/invitocat\",\n  \"organization\": {\n    \"login\": \"github\",\n    \"id\": 1,\n    \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n    \"url\": \"https://api.github.com/orgs/github\",\n    \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n    \"events_url\": \"https://api.github.com/orgs/github/events\",\n    \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n    \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n    \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n    \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"description\": \"A great organization\"\n  },\n  \"user\": {\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
    " - }, { "httpStatusCode": "403", "httpStatusMessage": "Forbidden", @@ -13014,7 +16996,7 @@ { "verb": "put", "requestPath": "/orgs/{org}/memberships/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "org", @@ -13038,8 +17020,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/memberships/USERNAME \\\n -d '{\"role\":\"role\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/memberships/USERNAME \\\n  -d '{\"role\":\"role\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG/memberships/USERNAME \\\n -d '{\"role\":\"role\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/memberships/USERNAME \\\n  -d '{\"role\":\"role\"}'
    " }, { "lang": "JavaScript", @@ -13116,13 +17098,7 @@ { "httpStatusCode": "200", "httpStatusMessage": "OK", - "description": "Response if user was previously unaffiliated with organization", - "payload": "
    {\n  \"url\": \"https://api.github.com/orgs/invitocat/memberships/defunkt\",\n  \"state\": \"pending\",\n  \"role\": \"admin\",\n  \"organization_url\": \"https://api.github.com/orgs/invitocat\",\n  \"organization\": {\n    \"login\": \"github\",\n    \"id\": 1,\n    \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n    \"url\": \"https://api.github.com/orgs/github\",\n    \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n    \"events_url\": \"https://api.github.com/orgs/github/events\",\n    \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n    \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n    \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n    \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"description\": \"A great organization\"\n  },\n  \"user\": {\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
    " - }, - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response if user already had membership with organization", + "description": "Response if user has an active admin membership with organization", "payload": "
    {\n  \"url\": \"https://api.github.com/orgs/octocat/memberships/defunkt\",\n  \"state\": \"active\",\n  \"role\": \"admin\",\n  \"organization_url\": \"https://api.github.com/orgs/octocat\",\n  \"organization\": {\n    \"login\": \"github\",\n    \"id\": 1,\n    \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n    \"url\": \"https://api.github.com/orgs/github\",\n    \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n    \"events_url\": \"https://api.github.com/orgs/github/events\",\n    \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n    \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n    \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n    \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"description\": \"A great organization\"\n  },\n  \"user\": {\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
    " }, { @@ -13140,7 +17116,7 @@ { "verb": "delete", "requestPath": "/orgs/{org}/memberships/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "org", @@ -13164,8 +17140,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/memberships/USERNAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/memberships/USERNAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG/memberships/USERNAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/memberships/USERNAME
    " }, { "lang": "JavaScript", @@ -13200,7 +17176,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -13219,7 +17195,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/outside_collaborators", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "org", @@ -13269,8 +17245,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/outside_collaborators", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/outside_collaborators
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG/outside_collaborators", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/outside_collaborators
    " }, { "lang": "JavaScript", @@ -13315,7 +17291,7 @@ { "verb": "put", "requestPath": "/orgs/{org}/outside_collaborators/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "org", @@ -13339,8 +17315,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/outside_collaborators/USERNAME", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/outside_collaborators/USERNAME
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG/outside_collaborators/USERNAME", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/outside_collaborators/USERNAME
    " }, { "lang": "JavaScript", @@ -13371,8 +17347,6 @@ "subcategory": "outside-collaborators", "subcategoryLabel": "Outside collaborators", "notes": [], - "bodyParameters": [], - "descriptionHTML": "

    When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"Converting an organization member to an outside collaborator\".

    ", "responses": [ { "httpStatusCode": "202", @@ -13387,26 +17361,21 @@ { "httpStatusCode": "403", "httpStatusMessage": "Forbidden", - "description": "Response if user is the last owner of the organization", - "payload": "
    {\n  \"message\": \"Cannot convert the last owner to an outside collaborator\",\n  \"documentation_url\": \"https://docs.github.com/github-ae@latest/rest/reference/orgs#convert-member-to-outside-collaborator\"\n}\n
    " - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Response if user is not a member of the organization", - "payload": "
    {\n  \"message\": \"<user> is not a member of the <organization> organization.\",\n  \"documentation_url\": \"https://docs.github.com/github-ae@latest/rest/reference/orgs#convert-member-to-outside-collaborator\"\n}\n
    " + "description": "Response if user is the last owner of the organization or not a member of the organization" }, { "httpStatusCode": "404", "httpStatusMessage": "Not Found", "description": "Resource not found" } - ] + ], + "bodyParameters": [], + "descriptionHTML": "

    When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"Converting an organization member to an outside collaborator\".

    " }, { "verb": "delete", "requestPath": "/orgs/{org}/outside_collaborators/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "org", @@ -13430,8 +17399,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/outside_collaborators/USERNAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/outside_collaborators/USERNAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG/outside_collaborators/USERNAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/outside_collaborators/USERNAME
    " }, { "lang": "JavaScript", @@ -13468,7 +17437,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "422", @@ -13481,7 +17450,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/projects", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "org", @@ -13532,8 +17501,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/orgs/ORG/projects", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/orgs/ORG/projects
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://api.{hostname}/orgs/ORG/projects", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/projects
    " }, { "lang": "JavaScript", @@ -13588,7 +17557,7 @@ { "verb": "post", "requestPath": "/orgs/{org}/projects", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "org", @@ -13603,8 +17572,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/orgs/ORG/projects \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/orgs/ORG/projects \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://api.{hostname}/orgs/ORG/projects \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/projects \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -13734,7 +17703,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/public_members", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "org", @@ -13769,8 +17738,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/public_members", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/public_members
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG/public_members", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/public_members
    " }, { "lang": "JavaScript", @@ -13815,7 +17784,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/public_members/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "org", @@ -13839,8 +17808,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/public_members/USERNAME", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/public_members/USERNAME
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG/public_members/USERNAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/public_members/USERNAME
    " }, { "lang": "JavaScript", @@ -13889,7 +17858,7 @@ { "verb": "put", "requestPath": "/orgs/{org}/public_members/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "org", @@ -13913,8 +17882,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/public_members/USERNAME", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/public_members/USERNAME
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG/public_members/USERNAME", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/public_members/USERNAME
    " }, { "lang": "JavaScript", @@ -13949,7 +17918,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -13963,7 +17932,7 @@ { "verb": "delete", "requestPath": "/orgs/{org}/public_members/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "org", @@ -13987,8 +17956,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/public_members/USERNAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/public_members/USERNAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG/public_members/USERNAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/public_members/USERNAME
    " }, { "lang": "JavaScript", @@ -14023,7 +17992,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -14032,7 +18001,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/repos", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "org", @@ -14045,7 +18014,7 @@ }, { "name": "type", - "description": "Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`.", + "description": "Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Note: For GitHub AE, can be one of `all`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`.", "in": "query", "required": false, "schema": { @@ -14060,7 +18029,7 @@ "internal" ] }, - "descriptionHTML": "

    Specifies the types of repositories you want returned. Can be one of all, public, private, forks, sources, member, internal. Default: all. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, type can also be internal.

    " + "descriptionHTML": "

    Specifies the types of repositories you want returned. Can be one of all, public, private, forks, sources, member, internal. Note: For GitHub AE, can be one of all, private, forks, sources, member, internal. Default: all. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, type can also be internal.

    " }, { "name": "sort", @@ -14117,8 +18086,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/repos", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/repos
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG/repos", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/repos
    " }, { "lang": "JavaScript", @@ -14174,7 +18143,7 @@ { "verb": "post", "requestPath": "/orgs/{org}/repos", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "org", @@ -14189,8 +18158,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/repos \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/repos \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG/repos \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/repos \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -14199,7 +18168,7 @@ } ], "summary": "Create an organization repository", - "description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", + "description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository", "tags": [ "repos" ], @@ -14243,17 +18212,17 @@ }, "private": { "type": "boolean", - "description": "

    Either true to create a private repository or false to create a public one.

    ", + "description": "

    Whether the repository is private.

    ", "default": false, "name": "private", "in": "body", "rawType": "boolean", - "rawDescription": "Either `true` to create a private repository or `false` to create a public one.", + "rawDescription": "Whether the repository is private.", "childParamsGroups": [] }, "visibility": { "type": "string", - "description": "

    Can be public or private. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be internal. For more information, see \"Creating an internal repository\" in the GitHub Help documentation.
    \nThe visibility parameter overrides the private parameter when you use both parameters with the nebula-preview preview header.

    ", + "description": "

    Can be public or private. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be internal. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"Creating an internal repository\" in the GitHub Help documentation.
    \nThe visibility parameter overrides the private parameter when you use both parameters with the nebula-preview preview header.

    ", "enum": [ "public", "private", @@ -14263,7 +18232,7 @@ "name": "visibility", "in": "body", "rawType": "string", - "rawDescription": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", + "rawDescription": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", "childParamsGroups": [] }, "has_issues": { @@ -14424,7 +18393,7 @@ "category": "repos", "categoryLabel": "Repos", "notes": [], - "descriptionHTML": "

    Creates a new repository in the specified organization. The authenticated user must be a member of the organization.

    \n

    OAuth scope requirements

    \n

    When using OAuth, authorizations must include:

    \n
      \n
    • public_repo scope or repo scope to create a public repository
    • \n
    • repo scope to create a private repository
    • \n
    ", + "descriptionHTML": "

    Creates a new repository in the specified organization. The authenticated user must be a member of the organization.

    \n

    OAuth scope requirements

    \n

    When using OAuth, authorizations must include:

    \n
      \n
    • public_repo scope or repo scope to create a public repository. Note: For GitHub AE, use repo scope to create an internal repository.
    • \n
    • repo scope to create a private repository
    • \n
    ", "bodyParameters": [ { "type": "string", @@ -14455,17 +18424,17 @@ }, { "type": "boolean", - "description": "

    Either true to create a private repository or false to create a public one.

    ", + "description": "

    Whether the repository is private.

    ", "default": false, "name": "private", "in": "body", "rawType": "boolean", - "rawDescription": "Either `true` to create a private repository or `false` to create a public one.", + "rawDescription": "Whether the repository is private.", "childParamsGroups": [] }, { "type": "string", - "description": "

    Can be public or private. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be internal. For more information, see \"Creating an internal repository\" in the GitHub Help documentation.
    \nThe visibility parameter overrides the private parameter when you use both parameters with the nebula-preview preview header.

    ", + "description": "

    Can be public or private. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be internal. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"Creating an internal repository\" in the GitHub Help documentation.
    \nThe visibility parameter overrides the private parameter when you use both parameters with the nebula-preview preview header.

    ", "enum": [ "public", "private", @@ -14475,7 +18444,7 @@ "name": "visibility", "in": "body", "rawType": "string", - "rawDescription": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", + "rawDescription": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", "childParamsGroups": [] }, { @@ -14618,7 +18587,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/teams", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "org", @@ -14653,8 +18622,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG/teams", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/teams
    " }, { "lang": "JavaScript", @@ -14702,7 +18671,7 @@ { "verb": "post", "requestPath": "/orgs/{org}/teams", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "org", @@ -14717,8 +18686,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG/teams \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/teams \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -14950,7 +18919,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "org", @@ -14975,8 +18944,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG/teams/TEAM_SLUG", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/teams/TEAM_SLUG
    " }, { "lang": "JavaScript", @@ -15024,7 +18993,7 @@ { "verb": "patch", "requestPath": "/orgs/{org}/teams/{team_slug}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "org", @@ -15049,8 +19018,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG/teams/TEAM_SLUG \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/teams/TEAM_SLUG \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -15222,7 +19191,7 @@ { "verb": "delete", "requestPath": "/orgs/{org}/teams/{team_slug}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "org", @@ -15247,8 +19216,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG/teams/TEAM_SLUG", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/teams/TEAM_SLUG
    " }, { "lang": "JavaScript", @@ -15281,7 +19250,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -15290,7 +19259,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "org", @@ -15345,13 +19314,23 @@ "default": 1 }, "descriptionHTML": "

    Page number of the results to fetch.

    " + }, + { + "name": "pinned", + "in": "query", + "required": false, + "description": "Pinned discussions only filter", + "schema": { + "type": "string" + }, + "descriptionHTML": "

    Pinned discussions only filter

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG/teams/TEAM_SLUG/discussions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/teams/TEAM_SLUG/discussions
    " }, { "lang": "JavaScript", @@ -15403,7 +19382,7 @@ { "verb": "post", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "org", @@ -15428,8 +19407,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions \\\n -d '{\"title\":\"title\",\"body\":\"body\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions \\\n  -d '{\"title\":\"title\",\"body\":\"body\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG/teams/TEAM_SLUG/discussions \\\n -d '{\"title\":\"title\",\"body\":\"body\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/teams/TEAM_SLUG/discussions \\\n  -d '{\"title\":\"title\",\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -15558,7 +19537,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "org", @@ -15592,8 +19571,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG/teams/TEAM_SLUG/discussions/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/teams/TEAM_SLUG/discussions/42
    " }, { "lang": "JavaScript", @@ -15645,7 +19624,7 @@ { "verb": "patch", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "org", @@ -15679,8 +19658,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42 \\\n -d '{\"title\":\"title\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42 \\\n  -d '{\"title\":\"title\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG/teams/TEAM_SLUG/discussions/42 \\\n -d '{\"title\":\"title\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/teams/TEAM_SLUG/discussions/42 \\\n  -d '{\"title\":\"title\"}'
    " }, { "lang": "JavaScript", @@ -15783,7 +19762,7 @@ { "verb": "delete", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "org", @@ -15817,8 +19796,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG/teams/TEAM_SLUG/discussions/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/teams/TEAM_SLUG/discussions/42
    " }, { "lang": "JavaScript", @@ -15853,7 +19832,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -15862,7 +19841,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "org", @@ -15931,8 +19910,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments
    " }, { "lang": "JavaScript", @@ -15984,7 +19963,7 @@ { "verb": "post", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "org", @@ -16018,8 +19997,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -16108,7 +20087,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "org", @@ -16151,8 +20130,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42
    " }, { "lang": "JavaScript", @@ -16204,7 +20183,7 @@ { "verb": "patch", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "org", @@ -16247,8 +20226,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42 \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42 \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42 \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42 \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -16336,7 +20315,7 @@ { "verb": "delete", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "org", @@ -16379,8 +20358,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42
    " }, { "lang": "JavaScript", @@ -16415,7 +20394,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -16424,7 +20403,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "org", @@ -16507,8 +20486,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42/reactions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42/reactions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://api.{hostname}/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42/reactions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42/reactions
    " }, { "lang": "JavaScript", @@ -16558,7 +20537,7 @@ { "verb": "post", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "org", @@ -16601,8 +20580,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42/reactions \\\n -d '{\"content\":\"content\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://api.{hostname}/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42/reactions \\\n -d '{\"content\":\"content\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " }, { "lang": "JavaScript", @@ -16708,7 +20687,7 @@ { "verb": "delete", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "org", @@ -16760,8 +20739,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42/reactions/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42/reactions/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://api.{hostname}/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42/reactions/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42/reactions/42
    " }, { "lang": "JavaScript", @@ -16801,7 +20780,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -16810,7 +20789,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "org", @@ -16884,8 +20863,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/reactions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/reactions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://api.{hostname}/orgs/ORG/teams/TEAM_SLUG/discussions/42/reactions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/teams/TEAM_SLUG/discussions/42/reactions
    " }, { "lang": "JavaScript", @@ -16935,7 +20914,7 @@ { "verb": "post", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "org", @@ -16969,8 +20948,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/reactions \\\n -d '{\"content\":\"content\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://api.{hostname}/orgs/ORG/teams/TEAM_SLUG/discussions/42/reactions \\\n -d '{\"content\":\"content\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/teams/TEAM_SLUG/discussions/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " }, { "lang": "JavaScript", @@ -17076,7 +21055,7 @@ { "verb": "delete", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "org", @@ -17119,8 +21098,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/reactions/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/reactions/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://api.{hostname}/orgs/ORG/teams/TEAM_SLUG/discussions/42/reactions/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/teams/TEAM_SLUG/discussions/42/reactions/42
    " }, { "lang": "JavaScript", @@ -17160,7 +21139,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -17169,7 +21148,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/members", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "org", @@ -17230,8 +21209,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/members", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/members
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG/teams/TEAM_SLUG/members", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/teams/TEAM_SLUG/members
    " }, { "lang": "JavaScript", @@ -17276,7 +21255,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/memberships/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "org", @@ -17310,8 +21289,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/memberships/USERNAME", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/memberships/USERNAME
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG/teams/TEAM_SLUG/memberships/USERNAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/teams/TEAM_SLUG/memberships/USERNAME
    " }, { "lang": "JavaScript", @@ -17320,7 +21299,7 @@ } ], "summary": "Get team membership for a user", - "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.\n\n**Note:** The `role` for organization owners returns as `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/github-ae@latest/rest/reference/teams#create-a-team).", + "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.\n\n**Note:**\nThe response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see see [Create a team](https://docs.github.com/github-ae@latest/rest/reference/teams#create-a-team).", "tags": [ "teams" ], @@ -17343,26 +21322,14 @@ "subcategoryLabel": "Members", "notes": [], "bodyParameters": [], - "descriptionHTML": "

    Team members will include the members of child teams.

    \n

    To get a user's membership with a team, the team must be visible to the authenticated user.

    \n

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

    \n

    Note: The role for organization owners returns as maintainer. For more information about maintainer roles, see Create a team.

    ", + "descriptionHTML": "

    Team members will include the members of child teams.

    \n

    To get a user's membership with a team, the team must be visible to the authenticated user.

    \n

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

    \n

    Note:\nThe response contains the state of the membership and the member's role.

    \n

    The role for organization owners is set to maintainer. For more information about maintainer roles, see see Create a team.

    ", "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response if user has an active membership with team", - "payload": "
    {\n  \"url\": \"https://api.github.com/teams/1/memberships/octocat\",\n  \"role\": \"member\",\n  \"state\": \"active\"\n}\n
    " - }, { "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Response if user is a team maintainer", "payload": "
    {\n  \"url\": \"https://api.github.com/teams/1/memberships/octocat\",\n  \"role\": \"maintainer\",\n  \"state\": \"active\"\n}\n
    " }, - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response if user has a pending membership with team", - "payload": "
    {\n  \"url\": \"https://api.github.com/teams/1/memberships/octocat\",\n  \"role\": \"member\",\n  \"state\": \"pending\"\n}\n
    " - }, { "httpStatusCode": "404", "httpStatusMessage": "Not Found", @@ -17373,7 +21340,7 @@ { "verb": "put", "requestPath": "/orgs/{org}/teams/{team_slug}/memberships/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "org", @@ -17407,8 +21374,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/memberships/USERNAME \\\n -d '{\"role\":\"role\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/memberships/USERNAME \\\n  -d '{\"role\":\"role\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG/teams/TEAM_SLUG/memberships/USERNAME \\\n -d '{\"role\":\"role\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/teams/TEAM_SLUG/memberships/USERNAME \\\n  -d '{\"role\":\"role\"}'
    " }, { "lang": "JavaScript", @@ -17482,12 +21449,6 @@ } ], "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response if user's membership with team is now active", - "payload": "
    {\n  \"url\": \"https://api.github.com/teams/1/memberships/octocat\",\n  \"role\": \"member\",\n  \"state\": \"active\"\n}\n
    " - }, { "httpStatusCode": "200", "httpStatusMessage": "OK", @@ -17502,15 +21463,14 @@ { "httpStatusCode": "422", "httpStatusMessage": "Unprocessable Entity", - "description": "Response if you attempt to add an organization to a team", - "payload": "
    {\n  \"message\": \"Cannot add an organization as a member.\",\n  \"errors\": [\n    {\n      \"code\": \"org\",\n      \"field\": \"user\",\n      \"resource\": \"TeamMember\"\n    }\n  ]\n}\n
    " + "description": "Response if you attempt to add an organization to a team" } ] }, { "verb": "delete", "requestPath": "/orgs/{org}/teams/{team_slug}/memberships/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "org", @@ -17544,8 +21504,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/memberships/USERNAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/memberships/USERNAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG/teams/TEAM_SLUG/memberships/USERNAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/teams/TEAM_SLUG/memberships/USERNAME
    " }, { "lang": "JavaScript", @@ -17580,7 +21540,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -17594,7 +21554,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/projects", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "org", @@ -17639,8 +21599,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/projects", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/projects
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://api.{hostname}/orgs/ORG/teams/TEAM_SLUG/projects", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/teams/TEAM_SLUG/projects
    " }, { "lang": "JavaScript", @@ -17690,7 +21650,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/projects/{project_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "org", @@ -17724,8 +21684,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/projects/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/projects/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://api.{hostname}/orgs/ORG/teams/TEAM_SLUG/projects/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/teams/TEAM_SLUG/projects/42
    " }, { "lang": "JavaScript", @@ -17780,7 +21740,7 @@ { "verb": "put", "requestPath": "/orgs/{org}/teams/{team_slug}/projects/{project_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "org", @@ -17814,8 +21774,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/projects/42 \\\n -d '{\"permission\":\"permission\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/projects/42 \\\n  -d '{\"permission\":\"permission\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://api.{hostname}/orgs/ORG/teams/TEAM_SLUG/projects/42 \\\n -d '{\"permission\":\"permission\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/teams/TEAM_SLUG/projects/42 \\\n  -d '{\"permission\":\"permission\"}'
    " }, { "lang": "JavaScript", @@ -17898,7 +21858,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -17911,7 +21871,7 @@ { "verb": "delete", "requestPath": "/orgs/{org}/teams/{team_slug}/projects/{project_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "org", @@ -17945,8 +21905,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/projects/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/projects/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG/teams/TEAM_SLUG/projects/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/teams/TEAM_SLUG/projects/42
    " }, { "lang": "JavaScript", @@ -17979,7 +21939,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -17988,7 +21948,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/repos", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "org", @@ -18033,8 +21993,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/repos", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/repos
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG/teams/TEAM_SLUG/repos", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/teams/TEAM_SLUG/repos
    " }, { "lang": "JavaScript", @@ -18077,7 +22037,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "org", @@ -18120,8 +22080,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/repos/octocat/hello-world", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/repos/octocat/hello-world
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG/teams/TEAM_SLUG/repos/octocat/hello-world", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/teams/TEAM_SLUG/repos/octocat/hello-world
    " }, { "lang": "JavaScript", @@ -18173,7 +22133,7 @@ { "verb": "put", "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "org", @@ -18216,8 +22176,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/repos/octocat/hello-world \\\n -d '{\"permission\":\"permission\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/repos/octocat/hello-world \\\n  -d '{\"permission\":\"permission\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG/teams/TEAM_SLUG/repos/octocat/hello-world \\\n -d '{\"permission\":\"permission\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/teams/TEAM_SLUG/repos/octocat/hello-world \\\n  -d '{\"permission\":\"permission\"}'
    " }, { "lang": "JavaScript", @@ -18277,7 +22237,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "descriptionHTML": "

    To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a 422 Unprocessable Entity status if you attempt to add a repository to a team that is not owned by the organization. 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

    Note: You can also specify a team by org_id and team_id using the route PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}.

    \n

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

    ", @@ -18303,7 +22263,7 @@ { "verb": "delete", "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "org", @@ -18346,8 +22306,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/repos/octocat/hello-world", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/repos/octocat/hello-world
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG/teams/TEAM_SLUG/repos/octocat/hello-world", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/teams/TEAM_SLUG/repos/octocat/hello-world
    " }, { "lang": "JavaScript", @@ -18380,7 +22340,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -18389,7 +22349,7 @@ { "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/teams", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "org", @@ -18434,8 +22394,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/teams", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/teams
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG/teams/TEAM_SLUG/teams", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/orgs/ORG/teams/TEAM_SLUG/teams
    " }, { "lang": "JavaScript", @@ -18478,7 +22438,7 @@ { "verb": "get", "requestPath": "/projects/columns/cards/{card_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "card_id", @@ -18494,8 +22454,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/cards/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/cards/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://api.{hostname}/projects/columns/cards/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://api.{hostname}/projects/columns/cards/42
    " }, { "lang": "JavaScript", @@ -18567,7 +22527,7 @@ { "verb": "patch", "requestPath": "/projects/columns/cards/{card_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "card_id", @@ -18583,8 +22543,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/cards/42 \\\n -d '{\"note\":\"note\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/cards/42 \\\n  -d '{\"note\":\"note\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://api.{hostname}/projects/columns/cards/42 \\\n -d '{\"note\":\"note\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://api.{hostname}/projects/columns/cards/42 \\\n  -d '{\"note\":\"note\"}'
    " }, { "lang": "JavaScript", @@ -18715,7 +22675,7 @@ { "verb": "delete", "requestPath": "/projects/columns/cards/{card_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "card_id", @@ -18731,8 +22691,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/cards/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/cards/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://api.{hostname}/projects/columns/cards/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://api.{hostname}/projects/columns/cards/42
    " }, { "lang": "JavaScript", @@ -18774,7 +22734,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -18803,7 +22763,7 @@ { "verb": "post", "requestPath": "/projects/columns/cards/{card_id}/moves", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "card_id", @@ -18819,8 +22779,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/cards/42/moves \\\n -d '{\"position\":\"position\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/cards/42/moves \\\n  -d '{\"position\":\"position\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://api.{hostname}/projects/columns/cards/42/moves \\\n -d '{\"position\":\"position\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://api.{hostname}/projects/columns/cards/42/moves \\\n  -d '{\"position\":\"position\"}'
    " }, { "lang": "JavaScript", @@ -18953,7 +22913,7 @@ { "verb": "get", "requestPath": "/projects/columns/{column_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "column_id", @@ -18969,8 +22929,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://api.{hostname}/projects/columns/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://api.{hostname}/projects/columns/42
    " }, { "lang": "JavaScript", @@ -19042,7 +23002,7 @@ { "verb": "patch", "requestPath": "/projects/columns/{column_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "column_id", @@ -19058,8 +23018,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/42 \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/42 \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://api.{hostname}/projects/columns/42 \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://api.{hostname}/projects/columns/42 \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -19161,7 +23121,7 @@ { "verb": "delete", "requestPath": "/projects/columns/{column_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "column_id", @@ -19177,8 +23137,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://api.{hostname}/projects/columns/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://api.{hostname}/projects/columns/42
    " }, { "lang": "JavaScript", @@ -19220,7 +23180,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -19244,7 +23204,7 @@ { "verb": "get", "requestPath": "/projects/columns/{column_id}/cards", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "column_id", @@ -19296,8 +23256,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/42/cards", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/42/cards
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://api.{hostname}/projects/columns/42/cards", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://api.{hostname}/projects/columns/42/cards
    " }, { "lang": "JavaScript", @@ -19364,7 +23324,7 @@ { "verb": "post", "requestPath": "/projects/columns/{column_id}/cards", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "column_id", @@ -19380,8 +23340,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/42/cards \\\n -d '{\"note\":\"note\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/42/cards \\\n  -d '{\"note\":\"note\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://api.{hostname}/projects/columns/42/cards \\\n -d '{\"note\":\"note\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://api.{hostname}/projects/columns/42/cards \\\n  -d '{\"note\":\"note\"}'
    " }, { "lang": "JavaScript", @@ -19501,7 +23461,7 @@ { "verb": "post", "requestPath": "/projects/columns/{column_id}/moves", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "column_id", @@ -19517,8 +23477,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/42/moves \\\n -d '{\"position\":\"position\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/42/moves \\\n  -d '{\"position\":\"position\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://api.{hostname}/projects/columns/42/moves \\\n -d '{\"position\":\"position\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://api.{hostname}/projects/columns/42/moves \\\n  -d '{\"position\":\"position\"}'
    " }, { "lang": "JavaScript", @@ -19626,7 +23586,7 @@ { "verb": "get", "requestPath": "/projects/{project_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "project_id", @@ -19641,8 +23601,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://api.{hostname}/projects/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://api.{hostname}/projects/42
    " }, { "lang": "JavaScript", @@ -19707,7 +23667,7 @@ { "verb": "patch", "requestPath": "/projects/{project_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "project_id", @@ -19722,8 +23682,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42 \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/42 \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://api.{hostname}/projects/42 \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://api.{hostname}/projects/42 \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -19925,7 +23885,7 @@ { "verb": "delete", "requestPath": "/projects/{project_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "project_id", @@ -19940,8 +23900,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://api.{hostname}/projects/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://api.{hostname}/projects/42
    " }, { "lang": "JavaScript", @@ -20015,7 +23975,7 @@ { "verb": "get", "requestPath": "/projects/{project_id}/collaborators", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "project_id", @@ -20066,8 +24026,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42/collaborators", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/42/collaborators
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://api.{hostname}/projects/42/collaborators", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://api.{hostname}/projects/42/collaborators
    " }, { "lang": "JavaScript", @@ -20149,7 +24109,7 @@ { "verb": "put", "requestPath": "/projects/{project_id}/collaborators/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "project_id", @@ -20173,8 +24133,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42/collaborators/USERNAME \\\n -d '{\"permission\":\"permission\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/42/collaborators/USERNAME \\\n  -d '{\"permission\":\"permission\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://api.{hostname}/projects/42/collaborators/USERNAME \\\n -d '{\"permission\":\"permission\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://api.{hostname}/projects/42/collaborators/USERNAME \\\n  -d '{\"permission\":\"permission\"}'
    " }, { "lang": "JavaScript", @@ -20243,7 +24203,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -20299,7 +24259,7 @@ { "verb": "delete", "requestPath": "/projects/{project_id}/collaborators/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "project_id", @@ -20323,8 +24283,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42/collaborators/USERNAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/42/collaborators/USERNAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://api.{hostname}/projects/42/collaborators/USERNAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://api.{hostname}/projects/42/collaborators/USERNAME
    " }, { "lang": "JavaScript", @@ -20366,7 +24326,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -20405,7 +24365,7 @@ { "verb": "get", "requestPath": "/projects/{project_id}/collaborators/{username}/permission", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "project_id", @@ -20429,8 +24389,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42/collaborators/USERNAME/permission", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/42/collaborators/USERNAME/permission
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://api.{hostname}/projects/42/collaborators/USERNAME/permission", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://api.{hostname}/projects/42/collaborators/USERNAME/permission
    " }, { "lang": "JavaScript", @@ -20512,7 +24472,7 @@ { "verb": "get", "requestPath": "/projects/{project_id}/columns", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "project_id", @@ -20547,8 +24507,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42/columns", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/42/columns
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://api.{hostname}/projects/42/columns", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://api.{hostname}/projects/42/columns
    " }, { "lang": "JavaScript", @@ -20615,7 +24575,7 @@ { "verb": "post", "requestPath": "/projects/{project_id}/columns", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "project_id", @@ -20630,8 +24590,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42/columns \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/42/columns \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://api.{hostname}/projects/42/columns \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://api.{hostname}/projects/42/columns \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -20738,13 +24698,13 @@ { "verb": "get", "requestPath": "/rate_limit", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/rate_limit", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/rate_limit
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/rate_limit", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/rate_limit
    " }, { "lang": "JavaScript", @@ -20797,7 +24757,7 @@ { "verb": "delete", "requestPath": "/reactions/{reaction_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "reaction_id", @@ -20812,8 +24772,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/reactions/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/reactions/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://api.{hostname}/reactions/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://api.{hostname}/reactions/42
    " }, { "lang": "JavaScript", @@ -20856,7 +24816,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -20890,7 +24850,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -20914,8 +24874,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world
    " }, { "lang": "JavaScript", @@ -20992,7 +24952,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -21016,8 +24976,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -21411,7 +25371,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -21435,8 +25395,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world
    " }, { "lang": "JavaScript", @@ -21471,7 +25431,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -21488,8 +25448,8 @@ }, { "verb": "get", - "requestPath": "/repos/{owner}/{repo}/assignees", - "serverUrl": "https://api.github.com", + "requestPath": "/repos/{owner}/{repo}/actions/artifacts", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -21533,8 +25493,3566 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/assignees", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/assignees
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/actions/artifacts", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/actions/artifacts
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /repos/{owner}/{repo}/actions/artifacts', {\n owner: 'octocat',\n repo: 'hello-world'\n})", + "html": "
    await octokit.request('GET /repos/{owner}/{repo}/actions/artifacts', {\n  owner: 'octocat',\n  repo: 'hello-world'\n})\n
    " + } + ], + "summary": "List artifacts for a repository", + "description": "Lists all artifacts for a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/list-artifacts-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#list-artifacts-for-a-repository" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "artifacts" + }, + "slug": "list-artifacts-for-a-repository", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "artifacts", + "subcategoryLabel": "Artifacts", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

    Lists all artifacts for a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.

    ", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
    {\n  \"total_count\": 2,\n  \"artifacts\": [\n    {\n      \"id\": 11,\n      \"node_id\": \"MDg6QXJ0aWZhY3QxMQ==\",\n      \"name\": \"Rails\",\n      \"size_in_bytes\": 556,\n      \"url\": \"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11\",\n      \"archive_download_url\": \"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11/zip\",\n      \"expired\": false,\n      \"created_at\": \"2020-01-10T14:59:22Z\",\n      \"expires_at\": \"2020-03-21T14:59:22Z\",\n      \"updated_at\": \"2020-02-21T14:59:22Z\"\n    },\n    {\n      \"id\": 13,\n      \"node_id\": \"MDg6QXJ0aWZhY3QxMw==\",\n      \"name\": \"\",\n      \"size_in_bytes\": 453,\n      \"url\": \"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13\",\n      \"archive_download_url\": \"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13/zip\",\n      \"expired\": false,\n      \"created_at\": \"2020-01-10T14:59:22Z\",\n      \"expires_at\": \"2020-03-21T14:59:22Z\",\n      \"updated_at\": \"2020-02-21T14:59:22Z\"\n    }\n  ]\n}\n
    " + } + ] + }, + { + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "artifact_id", + "description": "artifact_id parameter", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

    artifact_id parameter

    " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/actions/artifacts/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/actions/artifacts/42
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /repos/{owner}/{repo}/actions/artifacts/{artifact_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n artifact_id: 42\n})", + "html": "
    await octokit.request('GET /repos/{owner}/{repo}/actions/artifacts/{artifact_id}', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  artifact_id: 42\n})\n
    " + } + ], + "summary": "Get an artifact", + "description": "Gets a specific artifact for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-artifact", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#get-an-artifact" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "artifacts" + }, + "slug": "get-an-artifact", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "artifacts", + "subcategoryLabel": "Artifacts", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

    Gets a specific artifact for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.

    ", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
    {\n  \"id\": 11,\n  \"node_id\": \"MDg6QXJ0aWZhY3QxMQ==\",\n  \"name\": \"Rails\",\n  \"size_in_bytes\": 556,\n  \"url\": \"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11\",\n  \"archive_download_url\": \"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11/zip\",\n  \"expired\": false,\n  \"created_at\": \"2020-01-10T14:59:22Z\",\n  \"expires_at\": \"2020-01-21T14:59:22Z\",\n  \"updated_at\": \"2020-01-21T14:59:22Z\"\n}\n
    " + } + ] + }, + { + "verb": "delete", + "requestPath": "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "artifact_id", + "description": "artifact_id parameter", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

    artifact_id parameter

    " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/actions/artifacts/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/actions/artifacts/42
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('DELETE /repos/{owner}/{repo}/actions/artifacts/{artifact_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n artifact_id: 42\n})", + "html": "
    await octokit.request('DELETE /repos/{owner}/{repo}/actions/artifacts/{artifact_id}', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  artifact_id: 42\n})\n
    " + } + ], + "summary": "Delete an artifact", + "description": "Deletes an artifact for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-artifact", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#delete-an-artifact" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "artifacts" + }, + "slug": "delete-an-artifact", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "artifacts", + "subcategoryLabel": "Artifacts", + "notes": [], + "responses": [ + { + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Response" + } + ], + "bodyParameters": [], + "descriptionHTML": "

    Deletes an artifact for a workflow run. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions:write permission to use this endpoint.

    " + }, + { + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "artifact_id", + "description": "artifact_id parameter", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

    artifact_id parameter

    " + }, + { + "name": "archive_format", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/actions/artifacts/42/ARCHIVE_FORMAT", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/actions/artifacts/42/ARCHIVE_FORMAT
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}', {\n owner: 'octocat',\n repo: 'hello-world',\n artifact_id: 42,\n archive_format: 'archive_format'\n})", + "html": "
    await octokit.request('GET /repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  artifact_id: 42,\n  archive_format: 'archive_format'\n})\n
    " + } + ], + "summary": "Download an artifact", + "description": "Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in\nthe response header to find the URL for the download. The `:archive_format` must be `zip`. Anyone with read access to\nthe repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions:read` permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/download-artifact", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#download-an-artifact" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "artifacts" + }, + "slug": "download-an-artifact", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "artifacts", + "subcategoryLabel": "Artifacts", + "notes": [], + "responses": [ + { + "httpStatusCode": "302", + "httpStatusMessage": "Found", + "description": "Response" + } + ], + "bodyParameters": [], + "descriptionHTML": "

    Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for Location: in\nthe response header to find the URL for the download. The :archive_format must be zip. Anyone with read access to\nthe repository can use this endpoint. If the repository is private you must use an access token with the repo scope.\nGitHub Apps must have the actions:read permission to use this endpoint.

    " + }, + { + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/actions/jobs/{job_id}", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "job_id", + "description": "job_id parameter", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

    job_id parameter

    " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/actions/jobs/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/actions/jobs/42
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /repos/{owner}/{repo}/actions/jobs/{job_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n job_id: 42\n})", + "html": "
    await octokit.request('GET /repos/{owner}/{repo}/actions/jobs/{job_id}', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  job_id: 42\n})\n
    " + } + ], + "summary": "Get a job for a workflow run", + "description": "Gets a specific job in a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-job-for-workflow-run", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#get-a-job-for-a-workflow-run" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "workflow-jobs" + }, + "slug": "get-a-job-for-a-workflow-run", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "workflow-jobs", + "subcategoryLabel": "Workflow jobs", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

    Gets a specific job in a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.

    ", + "responses": [ + { + "httpStatusCode": "202", + "httpStatusMessage": "Accepted", + "description": "Default response", + "payload": "
    {\n  \"id\": 399444496,\n  \"run_id\": 29679449,\n  \"run_url\": \"https://api.github.com/repos/octo-org/octo-repo/actions/runs/29679449\",\n  \"node_id\": \"MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==\",\n  \"head_sha\": \"f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0\",\n  \"url\": \"https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496\",\n  \"html_url\": \"https://github.com/octo-org/octo-repo/runs/399444496\",\n  \"status\": \"completed\",\n  \"conclusion\": \"success\",\n  \"started_at\": \"2020-01-20T17:42:40Z\",\n  \"completed_at\": \"2020-01-20T17:44:39Z\",\n  \"name\": \"build\",\n  \"steps\": [\n    {\n      \"name\": \"Set up job\",\n      \"status\": \"completed\",\n      \"conclusion\": \"success\",\n      \"number\": 1,\n      \"started_at\": \"2020-01-20T09:42:40.000-08:00\",\n      \"completed_at\": \"2020-01-20T09:42:41.000-08:00\"\n    },\n    {\n      \"name\": \"Run actions/checkout@v2\",\n      \"status\": \"completed\",\n      \"conclusion\": \"success\",\n      \"number\": 2,\n      \"started_at\": \"2020-01-20T09:42:41.000-08:00\",\n      \"completed_at\": \"2020-01-20T09:42:45.000-08:00\"\n    },\n    {\n      \"name\": \"Set up Ruby\",\n      \"status\": \"completed\",\n      \"conclusion\": \"success\",\n      \"number\": 3,\n      \"started_at\": \"2020-01-20T09:42:45.000-08:00\",\n      \"completed_at\": \"2020-01-20T09:42:45.000-08:00\"\n    },\n    {\n      \"name\": \"Run actions/cache@v2\",\n      \"status\": \"completed\",\n      \"conclusion\": \"success\",\n      \"number\": 4,\n      \"started_at\": \"2020-01-20T09:42:45.000-08:00\",\n      \"completed_at\": \"2020-01-20T09:42:48.000-08:00\"\n    },\n    {\n      \"name\": \"Install Bundler\",\n      \"status\": \"completed\",\n      \"conclusion\": \"success\",\n      \"number\": 5,\n      \"started_at\": \"2020-01-20T09:42:48.000-08:00\",\n      \"completed_at\": \"2020-01-20T09:42:52.000-08:00\"\n    },\n    {\n      \"name\": \"Install Gems\",\n      \"status\": \"completed\",\n      \"conclusion\": \"success\",\n      \"number\": 6,\n      \"started_at\": \"2020-01-20T09:42:52.000-08:00\",\n      \"completed_at\": \"2020-01-20T09:42:53.000-08:00\"\n    },\n    {\n      \"name\": \"Run Tests\",\n      \"status\": \"completed\",\n      \"conclusion\": \"success\",\n      \"number\": 7,\n      \"started_at\": \"2020-01-20T09:42:53.000-08:00\",\n      \"completed_at\": \"2020-01-20T09:42:59.000-08:00\"\n    },\n    {\n      \"name\": \"Deploy to Heroku\",\n      \"status\": \"completed\",\n      \"conclusion\": \"success\",\n      \"number\": 8,\n      \"started_at\": \"2020-01-20T09:42:59.000-08:00\",\n      \"completed_at\": \"2020-01-20T09:44:39.000-08:00\"\n    },\n    {\n      \"name\": \"Post actions/cache@v2\",\n      \"status\": \"completed\",\n      \"conclusion\": \"success\",\n      \"number\": 16,\n      \"started_at\": \"2020-01-20T09:44:39.000-08:00\",\n      \"completed_at\": \"2020-01-20T09:44:39.000-08:00\"\n    },\n    {\n      \"name\": \"Complete job\",\n      \"status\": \"completed\",\n      \"conclusion\": \"success\",\n      \"number\": 17,\n      \"started_at\": \"2020-01-20T09:44:39.000-08:00\",\n      \"completed_at\": \"2020-01-20T09:44:39.000-08:00\"\n    }\n  ],\n  \"check_run_url\": \"https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496\"\n}\n
    " + } + ] + }, + { + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/actions/jobs/{job_id}/logs", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "job_id", + "description": "job_id parameter", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

    job_id parameter

    " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/actions/jobs/42/logs", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/actions/jobs/42/logs
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /repos/{owner}/{repo}/actions/jobs/{job_id}/logs', {\n owner: 'octocat',\n repo: 'hello-world',\n job_id: 42\n})", + "html": "
    await octokit.request('GET /repos/{owner}/{repo}/actions/jobs/{job_id}/logs', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  job_id: 42\n})\n
    " + } + ], + "summary": "Download job logs for a workflow run", + "description": "Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look\nfor `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can\nuse this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must\nhave the `actions:read` permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/download-job-logs-for-workflow-run", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#download-job-logs-for-a-workflow-run" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "workflow-jobs" + }, + "slug": "download-job-logs-for-a-workflow-run", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "workflow-jobs", + "subcategoryLabel": "Workflow jobs", + "notes": [], + "responses": [ + { + "httpStatusCode": "302", + "httpStatusMessage": "Found", + "description": "Response" + } + ], + "bodyParameters": [], + "descriptionHTML": "

    Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look\nfor Location: in the response header to find the URL for the download. Anyone with read access to the repository can\nuse this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must\nhave the actions:read permission to use this endpoint.

    " + }, + { + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/actions/permissions", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/actions/permissions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/actions/permissions
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /repos/{owner}/{repo}/actions/permissions', {\n owner: 'octocat',\n repo: 'hello-world'\n})", + "html": "
    await octokit.request('GET /repos/{owner}/{repo}/actions/permissions', {\n  owner: 'octocat',\n  repo: 'hello-world'\n})\n
    " + } + ], + "summary": "Get GitHub Actions permissions for a repository", + "description": "Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions allowed to run in the repository.\n\nYou must authenticate using an access token with the `repo` scope to use this\nendpoint. GitHub Apps must have the `administration` repository permission to use this API.", + "operationId": "actions/get-github-actions-permissions-repository", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#get-github-actions-permissions-for-a-repository" + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [], + "category": "actions", + "subcategory": "permissions" + }, + "slug": "get-github-actions-permissions-for-a-repository", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "permissions", + "subcategoryLabel": "Permissions", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

    Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions allowed to run in the repository.

    \n

    You must authenticate using an access token with the repo scope to use this\nendpoint. GitHub Apps must have the administration repository permission to use this API.

    ", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
    {\n  \"enabled\": true,\n  \"allowed_actions\": \"selected\",\n  \"selected_actions_url\": \"https://api.github.com/repositories/42/actions/permissions/selected-actions\"\n}\n
    " + } + ] + }, + { + "verb": "put", + "requestPath": "/repos/{owner}/{repo}/actions/permissions", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/actions/permissions \\\n -d '{\"enabled\":true}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/actions/permissions \\\n  -d '{\"enabled\":true}'
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('PUT /repos/{owner}/{repo}/actions/permissions', {\n owner: 'octocat',\n repo: 'hello-world',\n enabled: true\n})", + "html": "
    await octokit.request('PUT /repos/{owner}/{repo}/actions/permissions', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  enabled: true\n})\n
    " + } + ], + "summary": "Set GitHub Actions permissions for a repository", + "description": "Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions in the repository.\n\nIf the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as `allowed_actions` to `selected` actions, then you cannot override them for the repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.", + "operationId": "actions/set-github-actions-permissions-repository", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#set-github-actions-permissions-for-a-repository" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "

    Required. Whether GitHub Actions is enabled on the repository.

    ", + "name": "enabled", + "in": "body", + "rawType": "boolean", + "rawDescription": "Whether GitHub Actions is enabled on the repository.", + "childParamsGroups": [] + }, + "allowed_actions": { + "type": "string", + "description": "

    The permissions policy that controls the actions that are allowed to run. Can be one of: all, local_only, or selected.

    ", + "enum": [ + "all", + "local_only", + "selected" + ], + "name": "allowed_actions", + "in": "body", + "rawType": "string", + "rawDescription": "The permissions policy that controls the actions that are allowed to run. Can be one of: `all`, `local_only`, or `selected`.", + "childParamsGroups": [] + } + }, + "required": [ + "enabled" + ] + }, + "example": { + "enabled": true, + "allowed_actions": "selected" + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [], + "category": "actions", + "subcategory": "permissions" + }, + "slug": "set-github-actions-permissions-for-a-repository", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "permissions", + "subcategoryLabel": "Permissions", + "notes": [], + "responses": [ + { + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Response" + } + ], + "descriptionHTML": "

    Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions in the repository.

    \n

    If the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as allowed_actions to selected actions, then you cannot override them for the repository.

    \n

    You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the administration repository permission to use this API.

    ", + "bodyParameters": [ + { + "type": "boolean", + "description": "

    Required. Whether GitHub Actions is enabled on the repository.

    ", + "name": "enabled", + "in": "body", + "rawType": "boolean", + "rawDescription": "Whether GitHub Actions is enabled on the repository.", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

    The permissions policy that controls the actions that are allowed to run. Can be one of: all, local_only, or selected.

    ", + "enum": [ + "all", + "local_only", + "selected" + ], + "name": "allowed_actions", + "in": "body", + "rawType": "string", + "rawDescription": "The permissions policy that controls the actions that are allowed to run. Can be one of: `all`, `local_only`, or `selected`.", + "childParamsGroups": [] + } + ] + }, + { + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/actions/permissions/selected-actions", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/actions/permissions/selected-actions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/actions/permissions/selected-actions
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /repos/{owner}/{repo}/actions/permissions/selected-actions', {\n owner: 'octocat',\n repo: 'hello-world'\n})", + "html": "
    await octokit.request('GET /repos/{owner}/{repo}/actions/permissions/selected-actions', {\n  owner: 'octocat',\n  repo: 'hello-world'\n})\n
    " + } + ], + "summary": "Get allowed actions for a repository", + "description": "Gets the settings for selected actions that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.", + "operationId": "actions/get-allowed-actions-repository", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#get-allowed-actions-for-a-repository" + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [], + "category": "actions", + "subcategory": "permissions" + }, + "slug": "get-allowed-actions-for-a-repository", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "permissions", + "subcategoryLabel": "Permissions", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

    Gets the settings for selected actions that are allowed in a repository. To use this endpoint, the repository policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for a repository.\"

    \n

    You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the administration repository permission to use this API.

    ", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
    {\n  \"github_owned_allowed\": true,\n  \"verified_allowed\": false,\n  \"patterns_allowed\": [\n    \"monalisa/octocat@*\",\n    \"docker/*\"\n  ]\n}\n
    " + } + ] + }, + { + "verb": "put", + "requestPath": "/repos/{owner}/{repo}/actions/permissions/selected-actions", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/actions/permissions/selected-actions \\\n -d '{\"github_owned_allowed\":true,\"patterns_allowed\":[\"patterns_allowed\"],\"verified_allowed\":true}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/actions/permissions/selected-actions \\\n  -d '{\"github_owned_allowed\":true,\"patterns_allowed\":[\"patterns_allowed\"],\"verified_allowed\":true}'
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('PUT /repos/{owner}/{repo}/actions/permissions/selected-actions', {\n owner: 'octocat',\n repo: 'hello-world',\n github_owned_allowed: true,\n patterns_allowed: [\n 'patterns_allowed'\n ],\n verified_allowed: true\n})", + "html": "
    await octokit.request('PUT /repos/{owner}/{repo}/actions/permissions/selected-actions', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  github_owned_allowed: true,\n  patterns_allowed: [\n    'patterns_allowed'\n  ],\n  verified_allowed: true\n})\n
    " + } + ], + "summary": "Set allowed actions for a repository", + "description": "Sets the actions that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository).\"\n\nIf the repository belongs to an organization or enterprise that has `selected` actions set at the organization or enterprise levels, then you cannot override any of the allowed actions settings.\n\nTo use the `patterns_allowed` setting for private repositories, the repository must belong to an enterprise. If the repository does not belong to an enterprise, then the `patterns_allowed` setting only applies to public repositories.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.", + "operationId": "actions/set-allowed-actions-repository", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#set-allowed-actions-for-a-repository" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "github_owned_allowed": { + "type": "boolean", + "description": "

    Required. Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

    ", + "name": "github_owned_allowed", + "in": "body", + "rawType": "boolean", + "rawDescription": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization.", + "childParamsGroups": [] + }, + "verified_allowed": { + "type": "boolean", + "description": "

    Required. Whether actions in GitHub Marketplace from verified creators are allowed. Set to true to allow all GitHub Marketplace actions by verified creators.

    ", + "name": "verified_allowed", + "in": "body", + "rawType": "boolean", + "rawDescription": "Whether actions in GitHub Marketplace from verified creators are allowed. Set to `true` to allow all GitHub Marketplace actions by verified creators.", + "childParamsGroups": [] + }, + "patterns_allowed": { + "type": "array of strings", + "description": "

    Required. Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"

    ", + "items": { + "type": "string" + }, + "name": "patterns_allowed", + "in": "body", + "rawType": "array", + "rawDescription": "Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"", + "childParamsGroups": [] + } + }, + "required": [ + "github_owned_allowed", + "patterns_allowed", + "verified_allowed" + ] + }, + "examples": { + "selected_actions": { + "value": { + "github_owned_allowed": true, + "verified_allowed": false, + "patterns_allowed": [ + "monalisa/octocat@*", + "docker/*" + ] + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [], + "category": "actions", + "subcategory": "permissions" + }, + "slug": "set-allowed-actions-for-a-repository", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "permissions", + "subcategoryLabel": "Permissions", + "notes": [], + "responses": [ + { + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Response" + } + ], + "descriptionHTML": "

    Sets the actions that are allowed in a repository. To use this endpoint, the repository permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for a repository.\"

    \n

    If the repository belongs to an organization or enterprise that has selected actions set at the organization or enterprise levels, then you cannot override any of the allowed actions settings.

    \n

    To use the patterns_allowed setting for private repositories, the repository must belong to an enterprise. If the repository does not belong to an enterprise, then the patterns_allowed setting only applies to public repositories.

    \n

    You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the administration repository permission to use this API.

    ", + "bodyParameters": [ + { + "type": "boolean", + "description": "

    Required. Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

    ", + "name": "github_owned_allowed", + "in": "body", + "rawType": "boolean", + "rawDescription": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization.", + "childParamsGroups": [] + }, + { + "type": "boolean", + "description": "

    Required. Whether actions in GitHub Marketplace from verified creators are allowed. Set to true to allow all GitHub Marketplace actions by verified creators.

    ", + "name": "verified_allowed", + "in": "body", + "rawType": "boolean", + "rawDescription": "Whether actions in GitHub Marketplace from verified creators are allowed. Set to `true` to allow all GitHub Marketplace actions by verified creators.", + "childParamsGroups": [] + }, + { + "type": "array of strings", + "description": "

    Required. Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"

    ", + "items": { + "type": "string" + }, + "name": "patterns_allowed", + "in": "body", + "rawType": "array", + "rawDescription": "Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"", + "childParamsGroups": [] + } + ] + }, + { + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/actions/runners", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "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 http(s)://api.{hostname}/repos/octocat/hello-world/actions/runners", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/actions/runners
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /repos/{owner}/{repo}/actions/runners', {\n owner: 'octocat',\n repo: 'hello-world'\n})", + "html": "
    await octokit.request('GET /repos/{owner}/{repo}/actions/runners', {\n  owner: 'octocat',\n  repo: 'hello-world'\n})\n
    " + } + ], + "summary": "List self-hosted runners for a repository", + "description": "Lists all self-hosted runners configured in a repository. You must authenticate using an access token with the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/list-self-hosted-runners-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#list-self-hosted-runners-for-a-repository" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "self-hosted-runners" + }, + "slug": "list-self-hosted-runners-for-a-repository", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "self-hosted-runners", + "subcategoryLabel": "Self hosted runners", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

    Lists all self-hosted runners configured in a repository. You must authenticate using an access token with the repo scope to use this endpoint.

    ", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
    {\n  \"total_count\": 2,\n  \"runners\": [\n    {\n      \"id\": 23,\n      \"name\": \"linux_runner\",\n      \"os\": \"linux\",\n      \"status\": \"online\",\n      \"busy\": true,\n      \"labels\": [\n        {\n          \"id\": 5,\n          \"name\": \"self-hosted\",\n          \"type\": \"read-only\"\n        },\n        {\n          \"id\": 7,\n          \"name\": \"X64\",\n          \"type\": \"read-only\"\n        },\n        {\n          \"id\": 11,\n          \"name\": \"Linux\",\n          \"type\": \"read-only\"\n        }\n      ]\n    },\n    {\n      \"id\": 24,\n      \"name\": \"mac_runner\",\n      \"os\": \"macos\",\n      \"status\": \"offline\",\n      \"busy\": false,\n      \"labels\": [\n        {\n          \"id\": 5,\n          \"name\": \"self-hosted\",\n          \"type\": \"read-only\"\n        },\n        {\n          \"id\": 7,\n          \"name\": \"X64\",\n          \"type\": \"read-only\"\n        },\n        {\n          \"id\": 20,\n          \"name\": \"macOS\",\n          \"type\": \"read-only\"\n        },\n        {\n          \"id\": 21,\n          \"name\": \"no-gpu\",\n          \"type\": \"custom\"\n        }\n      ]\n    }\n  ]\n}\n
    " + } + ] + }, + { + "verb": "delete", + "requestPath": "/repos/{owner}/{repo}/actions/runners/{runner_id}", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

    Unique identifier of the self-hosted runner.

    " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/actions/runners/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/actions/runners/42
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('DELETE /repos/{owner}/{repo}/actions/runners/{runner_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n runner_id: 42\n})", + "html": "
    await octokit.request('DELETE /repos/{owner}/{repo}/actions/runners/{runner_id}', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  runner_id: 42\n})\n
    " + } + ], + "summary": "Delete a self-hosted runner from a repository", + "description": "Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `repo`\nscope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-self-hosted-runner-from-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#delete-a-self-hosted-runner-from-a-repository" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "self-hosted-runners" + }, + "slug": "delete-a-self-hosted-runner-from-a-repository", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "self-hosted-runners", + "subcategoryLabel": "Self hosted runners", + "notes": [], + "responses": [ + { + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Response" + } + ], + "bodyParameters": [], + "descriptionHTML": "

    Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.

    \n

    You must authenticate using an access token with the repo\nscope to use this endpoint.

    " + }, + { + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/actions/runs", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "actor", + "description": "Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run.", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    Returns someone's workflow runs. Use the login for the user who created the push associated with the check suite or workflow run.

    " + }, + { + "name": "branch", + "description": "Returns workflow runs associated with a branch. Use the name of the branch of the `push`.", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    Returns workflow runs associated with a branch. Use the name of the branch of the push.

    " + }, + { + "name": "event", + "description": "Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see \"[Events that trigger workflows](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows).\"", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    Returns workflow run triggered by the event you specify. For example, push, pull_request or issue. For more information, see \"Events that trigger workflows.\"

    " + }, + { + "name": "status", + "description": "Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`. For a list of the possible `status` and `conclusion` options, see \"[Create a check run](https://docs.github.com/github-ae@latest/rest/reference/checks#create-a-check-run).\"", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "completed", + "action_required", + "cancelled", + "failure", + "neutral", + "skipped", + "stale", + "success", + "timed_out", + "in_progress", + "queued", + "requested", + "waiting" + ] + }, + "descriptionHTML": "

    Returns workflow runs with the check run status or conclusion that you specify. For example, a conclusion can be success or a status can be in_progress. Only GitHub can set a status of waiting or requested. For a list of the possible status and conclusion options, see \"Create a check run.\"

    " + }, + { + "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 http(s)://api.{hostname}/repos/octocat/hello-world/actions/runs", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/actions/runs
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /repos/{owner}/{repo}/actions/runs', {\n owner: 'octocat',\n repo: 'hello-world'\n})", + "html": "
    await octokit.request('GET /repos/{owner}/{repo}/actions/runs', {\n  owner: 'octocat',\n  repo: 'hello-world'\n})\n
    " + } + ], + "summary": "List workflow runs for a repository", + "description": "Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/list-workflow-runs-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#list-workflow-runs-for-a-repository" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "workflow-runs" + }, + "slug": "list-workflow-runs-for-a-repository", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "workflow-runs", + "subcategoryLabel": "Workflow runs", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

    Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see Parameters.

    \n

    Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.

    ", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
    {\n  \"total_count\": 1,\n  \"workflow_runs\": [\n    {\n      \"id\": 30433642,\n      \"name\": \"Build\",\n      \"node_id\": \"MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==\",\n      \"head_branch\": \"master\",\n      \"head_sha\": \"acb5820ced9479c074f688cc328bf03f341a511d\",\n      \"run_number\": 562,\n      \"event\": \"push\",\n      \"status\": \"queued\",\n      \"conclusion\": null,\n      \"workflow_id\": 159038,\n      \"url\": \"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642\",\n      \"html_url\": \"https://github.com/octo-org/octo-repo/actions/runs/30433642\",\n      \"pull_requests\": [],\n      \"created_at\": \"2020-01-22T19:33:08Z\",\n      \"updated_at\": \"2020-01-22T19:33:08Z\",\n      \"jobs_url\": \"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs\",\n      \"logs_url\": \"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs\",\n      \"check_suite_url\": \"https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374\",\n      \"artifacts_url\": \"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts\",\n      \"cancel_url\": \"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel\",\n      \"rerun_url\": \"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun\",\n      \"workflow_url\": \"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038\",\n      \"head_commit\": {\n        \"id\": \"acb5820ced9479c074f688cc328bf03f341a511d\",\n        \"tree_id\": \"d23f6eedb1e1b9610bbc754ddb5197bfe7271223\",\n        \"message\": \"Create linter.yaml\",\n        \"timestamp\": \"2020-01-22T19:33:05Z\",\n        \"author\": {\n          \"name\": \"Octo Cat\",\n          \"email\": \"octocat@github.com\"\n        },\n        \"committer\": {\n          \"name\": \"GitHub\",\n          \"email\": \"noreply@github.com\"\n        }\n      },\n      \"repository\": {\n        \"id\": 1296269,\n        \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n        \"name\": \"Hello-World\",\n        \"full_name\": \"octocat/Hello-World\",\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        \"private\": false,\n        \"html_url\": \"https://github.com/octocat/Hello-World\",\n        \"description\": \"This your first repo!\",\n        \"fork\": false,\n        \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n        \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n        \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n        \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n        \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n        \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n        \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n        \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n        \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n        \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n        \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n        \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n        \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n        \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n        \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n        \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n        \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n        \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n        \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n        \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n        \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n        \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n        \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n        \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n        \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n        \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n        \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n        \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n        \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n        \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n        \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n        \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n        \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n        \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n        \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n        \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n        \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n        \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n        \"hooks_url\": \"http://api.github.com/repos/octocat/Hello-World/hooks\"\n      },\n      \"head_repository\": {\n        \"id\": 217723378,\n        \"node_id\": \"MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=\",\n        \"name\": \"octo-repo\",\n        \"full_name\": \"octo-org/octo-repo\",\n        \"private\": true,\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        \"html_url\": \"https://github.com/octo-org/octo-repo\",\n        \"description\": null,\n        \"fork\": false,\n        \"url\": \"https://api.github.com/repos/octo-org/octo-repo\",\n        \"forks_url\": \"https://api.github.com/repos/octo-org/octo-repo/forks\",\n        \"keys_url\": \"https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}\",\n        \"collaborators_url\": \"https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}\",\n        \"teams_url\": \"https://api.github.com/repos/octo-org/octo-repo/teams\",\n        \"hooks_url\": \"https://api.github.com/repos/octo-org/octo-repo/hooks\",\n        \"issue_events_url\": \"https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}\",\n        \"events_url\": \"https://api.github.com/repos/octo-org/octo-repo/events\",\n        \"assignees_url\": \"https://api.github.com/repos/octo-org/octo-repo/assignees{/user}\",\n        \"branches_url\": \"https://api.github.com/repos/octo-org/octo-repo/branches{/branch}\",\n        \"tags_url\": \"https://api.github.com/repos/octo-org/octo-repo/tags\",\n        \"blobs_url\": \"https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}\",\n        \"git_tags_url\": \"https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}\",\n        \"git_refs_url\": \"https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}\",\n        \"trees_url\": \"https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}\",\n        \"statuses_url\": \"https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}\",\n        \"languages_url\": \"https://api.github.com/repos/octo-org/octo-repo/languages\",\n        \"stargazers_url\": \"https://api.github.com/repos/octo-org/octo-repo/stargazers\",\n        \"contributors_url\": \"https://api.github.com/repos/octo-org/octo-repo/contributors\",\n        \"subscribers_url\": \"https://api.github.com/repos/octo-org/octo-repo/subscribers\",\n        \"subscription_url\": \"https://api.github.com/repos/octo-org/octo-repo/subscription\",\n        \"commits_url\": \"https://api.github.com/repos/octo-org/octo-repo/commits{/sha}\",\n        \"git_commits_url\": \"https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}\",\n        \"comments_url\": \"https://api.github.com/repos/octo-org/octo-repo/comments{/number}\",\n        \"issue_comment_url\": \"https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}\",\n        \"contents_url\": \"https://api.github.com/repos/octo-org/octo-repo/contents/{+path}\",\n        \"compare_url\": \"https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}\",\n        \"merges_url\": \"https://api.github.com/repos/octo-org/octo-repo/merges\",\n        \"archive_url\": \"https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}\",\n        \"downloads_url\": \"https://api.github.com/repos/octo-org/octo-repo/downloads\",\n        \"issues_url\": \"https://api.github.com/repos/octo-org/octo-repo/issues{/number}\",\n        \"pulls_url\": \"https://api.github.com/repos/octo-org/octo-repo/pulls{/number}\",\n        \"milestones_url\": \"https://api.github.com/repos/octo-org/octo-repo/milestones{/number}\",\n        \"notifications_url\": \"https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}\",\n        \"labels_url\": \"https://api.github.com/repos/octo-org/octo-repo/labels{/name}\",\n        \"releases_url\": \"https://api.github.com/repos/octo-org/octo-repo/releases{/id}\",\n        \"deployments_url\": \"https://api.github.com/repos/octo-org/octo-repo/deployments\"\n      }\n    }\n  ]\n}\n
    " + } + ] + }, + { + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "run_id", + "description": "The id of the workflow run", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

    The id of the workflow run

    " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/actions/runs/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/actions/runs/42
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /repos/{owner}/{repo}/actions/runs/{run_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n run_id: 42\n})", + "html": "
    await octokit.request('GET /repos/{owner}/{repo}/actions/runs/{run_id}', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  run_id: 42\n})\n
    " + } + ], + "summary": "Get a workflow run", + "description": "Gets a specific workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-workflow-run", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#get-a-workflow-run" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "workflow-runs" + }, + "slug": "get-a-workflow-run", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "workflow-runs", + "subcategoryLabel": "Workflow runs", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

    Gets a specific workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.

    ", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
    {\n  \"id\": 30433642,\n  \"name\": \"Build\",\n  \"node_id\": \"MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==\",\n  \"head_branch\": \"master\",\n  \"head_sha\": \"acb5820ced9479c074f688cc328bf03f341a511d\",\n  \"run_number\": 562,\n  \"event\": \"push\",\n  \"status\": \"queued\",\n  \"conclusion\": null,\n  \"workflow_id\": 159038,\n  \"url\": \"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642\",\n  \"html_url\": \"https://github.com/octo-org/octo-repo/actions/runs/30433642\",\n  \"pull_requests\": [],\n  \"created_at\": \"2020-01-22T19:33:08Z\",\n  \"updated_at\": \"2020-01-22T19:33:08Z\",\n  \"jobs_url\": \"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs\",\n  \"logs_url\": \"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs\",\n  \"check_suite_url\": \"https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374\",\n  \"artifacts_url\": \"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts\",\n  \"cancel_url\": \"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel\",\n  \"rerun_url\": \"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun\",\n  \"workflow_url\": \"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038\",\n  \"head_commit\": {\n    \"id\": \"acb5820ced9479c074f688cc328bf03f341a511d\",\n    \"tree_id\": \"d23f6eedb1e1b9610bbc754ddb5197bfe7271223\",\n    \"message\": \"Create linter.yaml\",\n    \"timestamp\": \"2020-01-22T19:33:05Z\",\n    \"author\": {\n      \"name\": \"Octo Cat\",\n      \"email\": \"octocat@github.com\"\n    },\n    \"committer\": {\n      \"name\": \"GitHub\",\n      \"email\": \"noreply@github.com\"\n    }\n  },\n  \"repository\": {\n    \"id\": 1296269,\n    \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n    \"name\": \"Hello-World\",\n    \"full_name\": \"octocat/Hello-World\",\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    \"private\": false,\n    \"html_url\": \"https://github.com/octocat/Hello-World\",\n    \"description\": \"This your first repo!\",\n    \"fork\": false,\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n    \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n    \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n    \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n    \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n    \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n    \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n    \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n    \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n    \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n    \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n    \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n    \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n    \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n    \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n    \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n    \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n    \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n    \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n    \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n    \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n    \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n    \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n    \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n    \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n    \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n    \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n    \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n    \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n    \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n    \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n    \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n    \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n    \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n    \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n    \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n    \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n    \"hooks_url\": \"http://api.github.com/repos/octocat/Hello-World/hooks\"\n  },\n  \"head_repository\": {\n    \"id\": 217723378,\n    \"node_id\": \"MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=\",\n    \"name\": \"octo-repo\",\n    \"full_name\": \"octo-org/octo-repo\",\n    \"private\": true,\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    \"html_url\": \"https://github.com/octo-org/octo-repo\",\n    \"description\": null,\n    \"fork\": false,\n    \"url\": \"https://api.github.com/repos/octo-org/octo-repo\",\n    \"forks_url\": \"https://api.github.com/repos/octo-org/octo-repo/forks\",\n    \"keys_url\": \"https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}\",\n    \"collaborators_url\": \"https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}\",\n    \"teams_url\": \"https://api.github.com/repos/octo-org/octo-repo/teams\",\n    \"hooks_url\": \"https://api.github.com/repos/octo-org/octo-repo/hooks\",\n    \"issue_events_url\": \"https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}\",\n    \"events_url\": \"https://api.github.com/repos/octo-org/octo-repo/events\",\n    \"assignees_url\": \"https://api.github.com/repos/octo-org/octo-repo/assignees{/user}\",\n    \"branches_url\": \"https://api.github.com/repos/octo-org/octo-repo/branches{/branch}\",\n    \"tags_url\": \"https://api.github.com/repos/octo-org/octo-repo/tags\",\n    \"blobs_url\": \"https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}\",\n    \"git_tags_url\": \"https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}\",\n    \"git_refs_url\": \"https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}\",\n    \"trees_url\": \"https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}\",\n    \"statuses_url\": \"https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}\",\n    \"languages_url\": \"https://api.github.com/repos/octo-org/octo-repo/languages\",\n    \"stargazers_url\": \"https://api.github.com/repos/octo-org/octo-repo/stargazers\",\n    \"contributors_url\": \"https://api.github.com/repos/octo-org/octo-repo/contributors\",\n    \"subscribers_url\": \"https://api.github.com/repos/octo-org/octo-repo/subscribers\",\n    \"subscription_url\": \"https://api.github.com/repos/octo-org/octo-repo/subscription\",\n    \"commits_url\": \"https://api.github.com/repos/octo-org/octo-repo/commits{/sha}\",\n    \"git_commits_url\": \"https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}\",\n    \"comments_url\": \"https://api.github.com/repos/octo-org/octo-repo/comments{/number}\",\n    \"issue_comment_url\": \"https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}\",\n    \"contents_url\": \"https://api.github.com/repos/octo-org/octo-repo/contents/{+path}\",\n    \"compare_url\": \"https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}\",\n    \"merges_url\": \"https://api.github.com/repos/octo-org/octo-repo/merges\",\n    \"archive_url\": \"https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}\",\n    \"downloads_url\": \"https://api.github.com/repos/octo-org/octo-repo/downloads\",\n    \"issues_url\": \"https://api.github.com/repos/octo-org/octo-repo/issues{/number}\",\n    \"pulls_url\": \"https://api.github.com/repos/octo-org/octo-repo/pulls{/number}\",\n    \"milestones_url\": \"https://api.github.com/repos/octo-org/octo-repo/milestones{/number}\",\n    \"notifications_url\": \"https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}\",\n    \"labels_url\": \"https://api.github.com/repos/octo-org/octo-repo/labels{/name}\",\n    \"releases_url\": \"https://api.github.com/repos/octo-org/octo-repo/releases{/id}\",\n    \"deployments_url\": \"https://api.github.com/repos/octo-org/octo-repo/deployments\"\n  }\n}\n
    " + } + ] + }, + { + "verb": "delete", + "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "run_id", + "description": "The id of the workflow run", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

    The id of the workflow run

    " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/actions/runs/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/actions/runs/42
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('DELETE /repos/{owner}/{repo}/actions/runs/{run_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n run_id: 42\n})", + "html": "
    await octokit.request('DELETE /repos/{owner}/{repo}/actions/runs/{run_id}', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  run_id: 42\n})\n
    " + } + ], + "summary": "Delete a workflow run", + "description": "Delete a specific workflow run. Anyone with write access to the repository can use this endpoint. If the repository is\nprivate you must use an access token with the `repo` scope. GitHub Apps must have the `actions:write` permission to use\nthis endpoint.", + "operationId": "actions/delete-workflow-run", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#delete-a-workflow-run" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "workflow-runs" + }, + "slug": "delete-a-workflow-run", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "workflow-runs", + "subcategoryLabel": "Workflow runs", + "notes": [], + "responses": [ + { + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Response" + } + ], + "bodyParameters": [], + "descriptionHTML": "

    Delete a specific workflow run. Anyone with write access to the repository can use this endpoint. If the repository is\nprivate you must use an access token with the repo scope. GitHub Apps must have the actions:write permission to use\nthis endpoint.

    " + }, + { + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/approvals", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "run_id", + "description": "The id of the workflow run", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

    The id of the workflow run

    " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/actions/runs/42/approvals", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/actions/runs/42/approvals
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /repos/{owner}/{repo}/actions/runs/{run_id}/approvals', {\n owner: 'octocat',\n repo: 'hello-world',\n run_id: 42\n})", + "html": "
    await octokit.request('GET /repos/{owner}/{repo}/actions/runs/{run_id}/approvals', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  run_id: 42\n})\n
    " + } + ], + "summary": "Get the review history for a workflow run", + "description": "Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-reviews-for-run", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#get-the-review-history-for-a-workflow-run" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "workflow-runs" + }, + "slug": "get-the-review-history-for-a-workflow-run", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "workflow-runs", + "subcategoryLabel": "Workflow runs", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

    Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.

    ", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
    [\n  {\n    \"state\": \"approved\",\n    \"comment\": \"Ship it!\",\n    \"environments\": [\n      {\n        \"id\": 161088068,\n        \"node_id\": \"MDExOkVudmlyb25tZW50MTYxMDg4MDY4\",\n        \"name\": \"staging\",\n        \"url\": \"https://api.github.com/repos/github/hello-world/environments/staging\",\n        \"html_url\": \"https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging\",\n        \"created_at\": \"2020-11-23T22:00:40Z\",\n        \"updated_at\": \"2020-11-23T22:00:40Z\"\n      }\n    ],\n    \"user\": {\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
    " + } + ] + }, + { + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/artifacts", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "run_id", + "description": "The id of the workflow run", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

    The id of the workflow run

    " + }, + { + "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 http(s)://api.{hostname}/repos/octocat/hello-world/actions/runs/42/artifacts", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/actions/runs/42/artifacts
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /repos/{owner}/{repo}/actions/runs/{run_id}/artifacts', {\n owner: 'octocat',\n repo: 'hello-world',\n run_id: 42\n})", + "html": "
    await octokit.request('GET /repos/{owner}/{repo}/actions/runs/{run_id}/artifacts', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  run_id: 42\n})\n
    " + } + ], + "summary": "List workflow run artifacts", + "description": "Lists artifacts for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/list-workflow-run-artifacts", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#list-workflow-run-artifacts" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "artifacts" + }, + "slug": "list-workflow-run-artifacts", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "artifacts", + "subcategoryLabel": "Artifacts", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

    Lists artifacts for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.

    ", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
    {\n  \"total_count\": 2,\n  \"artifacts\": [\n    {\n      \"id\": 11,\n      \"node_id\": \"MDg6QXJ0aWZhY3QxMQ==\",\n      \"name\": \"Rails\",\n      \"size_in_bytes\": 556,\n      \"url\": \"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11\",\n      \"archive_download_url\": \"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11/zip\",\n      \"expired\": false,\n      \"created_at\": \"2020-01-10T14:59:22Z\",\n      \"expires_at\": \"2020-03-21T14:59:22Z\",\n      \"updated_at\": \"2020-02-21T14:59:22Z\"\n    },\n    {\n      \"id\": 13,\n      \"node_id\": \"MDg6QXJ0aWZhY3QxMw==\",\n      \"name\": \"\",\n      \"size_in_bytes\": 453,\n      \"url\": \"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13\",\n      \"archive_download_url\": \"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13/zip\",\n      \"expired\": false,\n      \"created_at\": \"2020-01-10T14:59:22Z\",\n      \"expires_at\": \"2020-03-21T14:59:22Z\",\n      \"updated_at\": \"2020-02-21T14:59:22Z\"\n    }\n  ]\n}\n
    " + } + ] + }, + { + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/cancel", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "run_id", + "description": "The id of the workflow run", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

    The id of the workflow run

    " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/actions/runs/42/cancel", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/actions/runs/42/cancel
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel', {\n owner: 'octocat',\n repo: 'hello-world',\n run_id: 42\n})", + "html": "
    await octokit.request('POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  run_id: 42\n})\n
    " + } + ], + "summary": "Cancel a workflow run", + "description": "Cancels a workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/cancel-workflow-run", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#cancel-a-workflow-run" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "workflow-runs" + }, + "slug": "cancel-a-workflow-run", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "workflow-runs", + "subcategoryLabel": "Workflow runs", + "notes": [], + "responses": [ + { + "httpStatusCode": "202", + "httpStatusMessage": "Accepted", + "description": "Response" + } + ], + "bodyParameters": [], + "descriptionHTML": "

    Cancels a workflow run using its id. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions:write permission to use this endpoint.

    " + }, + { + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/jobs", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "run_id", + "description": "The id of the workflow run", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

    The id of the workflow run

    " + }, + { + "name": "filter", + "description": "Filters jobs by their `completed_at` timestamp. Can be one of: \n\\* `latest`: Returns jobs from the most recent execution of the workflow run. \n\\* `all`: Returns all jobs for a workflow run, including from old executions of the workflow run.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "latest", + "all" + ], + "default": "latest" + }, + "descriptionHTML": "

    Filters jobs by their completed_at timestamp. Can be one of:
    \n* latest: Returns jobs from the most recent execution of the workflow run.
    \n* all: Returns all jobs for a workflow run, including from old executions of the workflow run.

    " + }, + { + "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 http(s)://api.{hostname}/repos/octocat/hello-world/actions/runs/42/jobs", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/actions/runs/42/jobs
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /repos/{owner}/{repo}/actions/runs/{run_id}/jobs', {\n owner: 'octocat',\n repo: 'hello-world',\n run_id: 42\n})", + "html": "
    await octokit.request('GET /repos/{owner}/{repo}/actions/runs/{run_id}/jobs', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  run_id: 42\n})\n
    " + } + ], + "summary": "List jobs for a workflow run", + "description": "Lists jobs for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#parameters).", + "tags": [ + "actions" + ], + "operationId": "actions/list-jobs-for-workflow-run", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#list-jobs-for-a-workflow-run" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "workflow-jobs" + }, + "slug": "list-jobs-for-a-workflow-run", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "workflow-jobs", + "subcategoryLabel": "Workflow jobs", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

    Lists jobs for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see Parameters.

    ", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
    {\n  \"total_count\": 1,\n  \"jobs\": [\n    {\n      \"id\": 399444496,\n      \"run_id\": 29679449,\n      \"run_url\": \"https://api.github.com/repos/octo-org/octo-repo/actions/runs/29679449\",\n      \"node_id\": \"MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==\",\n      \"head_sha\": \"f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0\",\n      \"url\": \"https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496\",\n      \"html_url\": \"https://github.com/octo-org/octo-repo/runs/399444496\",\n      \"status\": \"completed\",\n      \"conclusion\": \"success\",\n      \"started_at\": \"2020-01-20T17:42:40Z\",\n      \"completed_at\": \"2020-01-20T17:44:39Z\",\n      \"name\": \"build\",\n      \"steps\": [\n        {\n          \"name\": \"Set up job\",\n          \"status\": \"completed\",\n          \"conclusion\": \"success\",\n          \"number\": 1,\n          \"started_at\": \"2020-01-20T09:42:40.000-08:00\",\n          \"completed_at\": \"2020-01-20T09:42:41.000-08:00\"\n        },\n        {\n          \"name\": \"Run actions/checkout@v2\",\n          \"status\": \"completed\",\n          \"conclusion\": \"success\",\n          \"number\": 2,\n          \"started_at\": \"2020-01-20T09:42:41.000-08:00\",\n          \"completed_at\": \"2020-01-20T09:42:45.000-08:00\"\n        },\n        {\n          \"name\": \"Set up Ruby\",\n          \"status\": \"completed\",\n          \"conclusion\": \"success\",\n          \"number\": 3,\n          \"started_at\": \"2020-01-20T09:42:45.000-08:00\",\n          \"completed_at\": \"2020-01-20T09:42:45.000-08:00\"\n        },\n        {\n          \"name\": \"Run actions/cache@v2\",\n          \"status\": \"completed\",\n          \"conclusion\": \"success\",\n          \"number\": 4,\n          \"started_at\": \"2020-01-20T09:42:45.000-08:00\",\n          \"completed_at\": \"2020-01-20T09:42:48.000-08:00\"\n        },\n        {\n          \"name\": \"Install Bundler\",\n          \"status\": \"completed\",\n          \"conclusion\": \"success\",\n          \"number\": 5,\n          \"started_at\": \"2020-01-20T09:42:48.000-08:00\",\n          \"completed_at\": \"2020-01-20T09:42:52.000-08:00\"\n        },\n        {\n          \"name\": \"Install Gems\",\n          \"status\": \"completed\",\n          \"conclusion\": \"success\",\n          \"number\": 6,\n          \"started_at\": \"2020-01-20T09:42:52.000-08:00\",\n          \"completed_at\": \"2020-01-20T09:42:53.000-08:00\"\n        },\n        {\n          \"name\": \"Run Tests\",\n          \"status\": \"completed\",\n          \"conclusion\": \"success\",\n          \"number\": 7,\n          \"started_at\": \"2020-01-20T09:42:53.000-08:00\",\n          \"completed_at\": \"2020-01-20T09:42:59.000-08:00\"\n        },\n        {\n          \"name\": \"Deploy to Heroku\",\n          \"status\": \"completed\",\n          \"conclusion\": \"success\",\n          \"number\": 8,\n          \"started_at\": \"2020-01-20T09:42:59.000-08:00\",\n          \"completed_at\": \"2020-01-20T09:44:39.000-08:00\"\n        },\n        {\n          \"name\": \"Post actions/cache@v2\",\n          \"status\": \"completed\",\n          \"conclusion\": \"success\",\n          \"number\": 16,\n          \"started_at\": \"2020-01-20T09:44:39.000-08:00\",\n          \"completed_at\": \"2020-01-20T09:44:39.000-08:00\"\n        },\n        {\n          \"name\": \"Complete job\",\n          \"status\": \"completed\",\n          \"conclusion\": \"success\",\n          \"number\": 17,\n          \"started_at\": \"2020-01-20T09:44:39.000-08:00\",\n          \"completed_at\": \"2020-01-20T09:44:39.000-08:00\"\n        }\n      ],\n      \"check_run_url\": \"https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496\"\n    }\n  ]\n}\n
    " + } + ] + }, + { + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/logs", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "run_id", + "description": "The id of the workflow run", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

    The id of the workflow run

    " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/actions/runs/42/logs", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/actions/runs/42/logs
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /repos/{owner}/{repo}/actions/runs/{run_id}/logs', {\n owner: 'octocat',\n repo: 'hello-world',\n run_id: 42\n})", + "html": "
    await octokit.request('GET /repos/{owner}/{repo}/actions/runs/{run_id}/logs', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  run_id: 42\n})\n
    " + } + ], + "summary": "Download workflow run logs", + "description": "Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for\n`Location:` in the response header to find the URL for the download. Anyone with read access to the repository can use\nthis endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have\nthe `actions:read` permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/download-workflow-run-logs", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#download-workflow-run-logs" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "workflow-runs" + }, + "slug": "download-workflow-run-logs", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "workflow-runs", + "subcategoryLabel": "Workflow runs", + "notes": [], + "responses": [ + { + "httpStatusCode": "302", + "httpStatusMessage": "Found", + "description": "Response" + } + ], + "bodyParameters": [], + "descriptionHTML": "

    Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for\nLocation: in the response header to find the URL for the download. Anyone with read access to the repository can use\nthis endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have\nthe actions:read permission to use this endpoint.

    " + }, + { + "verb": "delete", + "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/logs", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "run_id", + "description": "The id of the workflow run", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

    The id of the workflow run

    " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/actions/runs/42/logs", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/actions/runs/42/logs
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('DELETE /repos/{owner}/{repo}/actions/runs/{run_id}/logs', {\n owner: 'octocat',\n repo: 'hello-world',\n run_id: 42\n})", + "html": "
    await octokit.request('DELETE /repos/{owner}/{repo}/actions/runs/{run_id}/logs', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  run_id: 42\n})\n
    " + } + ], + "summary": "Delete workflow run logs", + "description": "Deletes all logs for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-workflow-run-logs", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#delete-workflow-run-logs" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "workflow-runs" + }, + "slug": "delete-workflow-run-logs", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "workflow-runs", + "subcategoryLabel": "Workflow runs", + "notes": [], + "responses": [ + { + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Response" + } + ], + "bodyParameters": [], + "descriptionHTML": "

    Deletes all logs for a workflow run. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions:write permission to use this endpoint.

    " + }, + { + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "run_id", + "description": "The id of the workflow run", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

    The id of the workflow run

    " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/actions/runs/42/pending_deployments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/actions/runs/42/pending_deployments
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments', {\n owner: 'octocat',\n repo: 'hello-world',\n run_id: 42\n})", + "html": "
    await octokit.request('GET /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  run_id: 42\n})\n
    " + } + ], + "summary": "Get pending deployments for a workflow run", + "description": "Get all deployment environments for a workflow run that are waiting for protection rules to pass.\n\nAnyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-pending-deployments-for-run", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#get-pending-deployments-for-a-workflow-run" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "workflow-runs" + }, + "slug": "get-pending-deployments-for-a-workflow-run", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "workflow-runs", + "subcategoryLabel": "Workflow runs", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

    Get all deployment environments for a workflow run that are waiting for protection rules to pass.

    \n

    Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.

    ", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
    [\n  {\n    \"environment\": {\n      \"id\": 161088068,\n      \"node_id\": \"MDExOkVudmlyb25tZW50MTYxMDg4MDY4\",\n      \"name\": \"staging\",\n      \"url\": \"https://api.github.com/repos/github/hello-world/environments/staging\",\n      \"html_url\": \"https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging\"\n    },\n    \"wait_timer\": 30,\n    \"wait_timer_started_at\": \"2020-11-23T22:00:40Z\",\n    \"current_user_can_approve\": true,\n    \"reviewers\": [\n      {\n        \"type\": \"User\",\n        \"reviewer\": {\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        \"type\": \"Team\",\n        \"reviewer\": {\n          \"id\": 1,\n          \"node_id\": \"MDQ6VGVhbTE=\",\n          \"url\": \"https://api.github.com/teams/1\",\n          \"html_url\": \"https://github.com/orgs/github/teams/justice-league\",\n          \"name\": \"Justice League\",\n          \"slug\": \"justice-league\",\n          \"description\": \"A great team.\",\n          \"privacy\": \"closed\",\n          \"permission\": \"admin\",\n          \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n          \"repositories_url\": \"https://api.github.com/teams/1/repos\"\n        }\n      }\n    ]\n  }\n]\n
    " + } + ] + }, + { + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "run_id", + "description": "The id of the workflow run", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

    The id of the workflow run

    " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/actions/runs/42/pending_deployments \\\n -d '{\"environment_ids\":[42],\"state\":\"state\",\"comment\":\"comment\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/actions/runs/42/pending_deployments \\\n  -d '{\"environment_ids\":[42],\"state\":\"state\",\"comment\":\"comment\"}'
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments', {\n owner: 'octocat',\n repo: 'hello-world',\n run_id: 42,\n environment_ids: [\n 42\n ],\n state: 'state',\n comment: 'comment'\n})", + "html": "
    await octokit.request('POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  run_id: 42,\n  environment_ids: [\n    42\n  ],\n  state: 'state',\n  comment: 'comment'\n})\n
    " + } + ], + "summary": "Review pending deployments for a workflow run", + "description": "Approve or reject pending deployments that are waiting on approval by a required reviewer.\n\nAnyone with read access to the repository contents and deployments can use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/review-pending-deployments-for-run", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#review-pending-deployments-for-a-workflow-run" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "environment_ids": { + "type": "array of integers", + "description": "

    Required. The list of environment ids to approve or reject

    ", + "example": [ + 161171787, + 161171795 + ], + "items": { + "type": "integer", + "example": 161171787 + }, + "name": "environment_ids", + "in": "body", + "rawType": "array", + "rawDescription": "The list of environment ids to approve or reject", + "childParamsGroups": [] + }, + "state": { + "type": "string", + "description": "

    Required. Whether to approve or reject deployment to the specified environments. Must be one of: approved or rejected

    ", + "enum": [ + "approved", + "rejected" + ], + "example": "approved", + "name": "state", + "in": "body", + "rawType": "string", + "rawDescription": "Whether to approve or reject deployment to the specified environments. Must be one of: `approved` or `rejected`", + "childParamsGroups": [] + }, + "comment": { + "type": "string", + "description": "

    Required. A comment to accompany the deployment review

    ", + "example": "Ship it!", + "name": "comment", + "in": "body", + "rawType": "string", + "rawDescription": "A comment to accompany the deployment review", + "childParamsGroups": [] + } + }, + "required": [ + "environment_ids", + "state", + "comment" + ] + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "workflow-runs" + }, + "slug": "review-pending-deployments-for-a-workflow-run", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "workflow-runs", + "subcategoryLabel": "Workflow runs", + "notes": [], + "descriptionHTML": "

    Approve or reject pending deployments that are waiting on approval by a required reviewer.

    \n

    Anyone with read access to the repository contents and deployments can use this endpoint.

    ", + "bodyParameters": [ + { + "type": "array of integers", + "description": "

    Required. The list of environment ids to approve or reject

    ", + "example": [ + 161171787, + 161171795 + ], + "items": { + "type": "integer", + "example": 161171787 + }, + "name": "environment_ids", + "in": "body", + "rawType": "array", + "rawDescription": "The list of environment ids to approve or reject", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

    Required. Whether to approve or reject deployment to the specified environments. Must be one of: approved or rejected

    ", + "enum": [ + "approved", + "rejected" + ], + "example": "approved", + "name": "state", + "in": "body", + "rawType": "string", + "rawDescription": "Whether to approve or reject deployment to the specified environments. Must be one of: `approved` or `rejected`", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

    Required. A comment to accompany the deployment review

    ", + "example": "Ship it!", + "name": "comment", + "in": "body", + "rawType": "string", + "rawDescription": "A comment to accompany the deployment review", + "childParamsGroups": [] + } + ], + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
    [\n  {\n    \"url\": \"https://api.github.com/repos/octocat/example/deployments/1\",\n    \"id\": 1,\n    \"node_id\": \"MDEwOkRlcGxveW1lbnQx\",\n    \"sha\": \"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\n    \"ref\": \"topic-branch\",\n    \"task\": \"deploy\",\n    \"payload\": {},\n    \"original_environment\": \"staging\",\n    \"environment\": \"production\",\n    \"description\": \"Deploy request from hubot\",\n    \"creator\": {\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    \"created_at\": \"2012-07-20T01:19:13Z\",\n    \"updated_at\": \"2012-07-20T01:19:13Z\",\n    \"statuses_url\": \"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\n    \"repository_url\": \"https://api.github.com/repos/octocat/example\",\n    \"transient_environment\": false,\n    \"production_environment\": true\n  }\n]\n
    " + } + ] + }, + { + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "run_id", + "description": "The id of the workflow run", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

    The id of the workflow run

    " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/actions/runs/42/rerun", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/actions/runs/42/rerun
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('POST /repos/{owner}/{repo}/actions/runs/{run_id}/rerun', {\n owner: 'octocat',\n repo: 'hello-world',\n run_id: 42\n})", + "html": "
    await octokit.request('POST /repos/{owner}/{repo}/actions/runs/{run_id}/rerun', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  run_id: 42\n})\n
    " + } + ], + "summary": "Re-run a workflow", + "description": "Re-runs your workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/re-run-workflow", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#re-run-a-workflow" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "actions", + "subcategory": "workflow-runs" + }, + "slug": "re-run-a-workflow", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "workflow-runs", + "subcategoryLabel": "Workflow runs", + "notes": [], + "responses": [ + { + "httpStatusCode": "201", + "httpStatusMessage": "Created", + "description": "Response" + } + ], + "bodyParameters": [], + "descriptionHTML": "

    Re-runs your workflow run using its id. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions:write permission to use this endpoint.

    " + }, + { + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/timing", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "run_id", + "description": "The id of the workflow run", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

    The id of the workflow run

    " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/actions/runs/42/timing", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/actions/runs/42/timing
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /repos/{owner}/{repo}/actions/runs/{run_id}/timing', {\n owner: 'octocat',\n repo: 'hello-world',\n run_id: 42\n})", + "html": "
    await octokit.request('GET /repos/{owner}/{repo}/actions/runs/{run_id}/timing', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  run_id: 42\n})\n
    " + } + ], + "summary": "Get workflow run usage", + "description": "Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub AE-hosted runners. Usage is listed for each GitHub AE-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nAnyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-workflow-run-usage", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#get-workflow-run-usage" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "actions", + "subcategory": "workflow-runs" + }, + "slug": "get-workflow-run-usage", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "workflow-runs", + "subcategoryLabel": "Workflow runs", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

    Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub AE-hosted runners. Usage is listed for each GitHub AE-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"Managing billing for GitHub Actions\".

    \n

    Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.

    ", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
    {\n  \"billable\": {\n    \"UBUNTU\": {\n      \"total_ms\": 180000,\n      \"jobs\": 1\n    },\n    \"MACOS\": {\n      \"total_ms\": 240000,\n      \"jobs\": 4\n    },\n    \"WINDOWS\": {\n      \"total_ms\": 300000,\n      \"jobs\": 2\n    }\n  },\n  \"run_duration_ms\": 500000\n}\n
    " + } + ] + }, + { + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/actions/secrets", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "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 http(s)://api.{hostname}/repos/octocat/hello-world/actions/secrets", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/actions/secrets
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /repos/{owner}/{repo}/actions/secrets', {\n owner: 'octocat',\n repo: 'hello-world'\n})", + "html": "
    await octokit.request('GET /repos/{owner}/{repo}/actions/secrets', {\n  owner: 'octocat',\n  repo: 'hello-world'\n})\n
    " + } + ], + "summary": "List repository secrets", + "description": "Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/list-repo-secrets", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#list-repository-secrets" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "secrets" + }, + "slug": "list-repository-secrets", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "secrets", + "subcategoryLabel": "Secrets", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

    Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use this endpoint.

    ", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
    {\n  \"total_count\": 2,\n  \"secrets\": [\n    {\n      \"name\": \"GH_TOKEN\",\n      \"created_at\": \"2019-08-10T14:59:22Z\",\n      \"updated_at\": \"2020-01-10T14:59:22Z\"\n    },\n    {\n      \"name\": \"GIST_ID\",\n      \"created_at\": \"2020-01-10T10:59:22Z\",\n      \"updated_at\": \"2020-01-11T11:59:22Z\"\n    }\n  ]\n}\n
    " + } + ] + }, + { + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/actions/secrets/public-key", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/actions/secrets/public-key", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/actions/secrets/public-key
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /repos/{owner}/{repo}/actions/secrets/public-key', {\n owner: 'octocat',\n repo: 'hello-world'\n})", + "html": "
    await octokit.request('GET /repos/{owner}/{repo}/actions/secrets/public-key', {\n  owner: 'octocat',\n  repo: 'hello-world'\n})\n
    " + } + ], + "summary": "Get a repository public key", + "description": "Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `secrets` repository permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-repo-public-key", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#get-a-repository-public-key" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "secrets" + }, + "slug": "get-a-repository-public-key", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "secrets", + "subcategoryLabel": "Secrets", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

    Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the secrets repository permission to use this endpoint.

    ", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
    {\n  \"key_id\": \"012345678912345678\",\n  \"key\": \"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234\"\n}\n
    " + } + ] + }, + { + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/actions/secrets/{secret_name}", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "secret_name", + "description": "secret_name parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    secret_name parameter

    " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/actions/secrets/SECRET_NAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/actions/secrets/SECRET_NAME
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /repos/{owner}/{repo}/actions/secrets/{secret_name}', {\n owner: 'octocat',\n repo: 'hello-world',\n secret_name: 'secret_name'\n})", + "html": "
    await octokit.request('GET /repos/{owner}/{repo}/actions/secrets/{secret_name}', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  secret_name: 'secret_name'\n})\n
    " + } + ], + "summary": "Get a repository secret", + "description": "Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-repo-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#get-a-repository-secret" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "secrets" + }, + "slug": "get-a-repository-secret", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "secrets", + "subcategoryLabel": "Secrets", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

    Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use this endpoint.

    ", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
    {\n  \"name\": \"GH_TOKEN\",\n  \"created_at\": \"2019-08-10T14:59:22Z\",\n  \"updated_at\": \"2020-01-10T14:59:22Z\"\n}\n
    " + } + ] + }, + { + "verb": "put", + "requestPath": "/repos/{owner}/{repo}/actions/secrets/{secret_name}", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "secret_name", + "description": "secret_name parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    secret_name parameter

    " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/actions/secrets/SECRET_NAME \\\n -d '{\"encrypted_value\":\"encrypted_value\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/actions/secrets/SECRET_NAME \\\n  -d '{\"encrypted_value\":\"encrypted_value\"}'
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('PUT /repos/{owner}/{repo}/actions/secrets/{secret_name}', {\n owner: 'octocat',\n repo: 'hello-world',\n secret_name: 'secret_name',\n encrypted_value: 'encrypted_value'\n})", + "html": "
    await octokit.request('PUT /repos/{owner}/{repo}/actions/secrets/{secret_name}', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  secret_name: 'secret_name',\n  encrypted_value: 'encrypted_value'\n})\n
    " + } + ], + "summary": "Create or update a repository secret", + "description": "Creates or updates a repository secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access\ntoken with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use\nthis endpoint.\n\n#### Example encrypting a secret using Node.js\n\nEncrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library.\n\n```\nconst sodium = require('tweetsodium');\n\nconst key = \"base64-encoded-public-key\";\nconst value = \"plain-text-secret\";\n\n// Convert the message and key to Uint8Array's (Buffer implements that interface)\nconst messageBytes = Buffer.from(value);\nconst keyBytes = Buffer.from(key, 'base64');\n\n// Encrypt using LibSodium.\nconst encryptedBytes = sodium.seal(messageBytes, keyBytes);\n\n// Base64 the encrypted secret\nconst encrypted = Buffer.from(encryptedBytes).toString('base64');\n\nconsole.log(encrypted);\n```\n\n\n#### Example encrypting a secret using Python\n\nEncrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/stable/public/#nacl-public-sealedbox) with Python 3.\n\n```\nfrom base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n sealed_box = public.SealedBox(public_key)\n encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n return b64encode(encrypted).decode(\"utf-8\")\n```\n\n#### Example encrypting a secret using C#\n\nEncrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.\n\n```\nvar secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\n```\n\n#### Example encrypting a secret using Ruby\n\nEncrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.\n\n```ruby\nrequire \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\n```", + "tags": [ + "actions" + ], + "operationId": "actions/create-or-update-repo-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#create-or-update-a-repository-secret" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "encrypted_value": { + "type": "string", + "description": "

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.

    ", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", + "name": "encrypted_value", + "in": "body", + "rawType": "string", + "rawDescription": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/github-ae@latest/rest/reference/actions#get-a-repository-public-key) endpoint.", + "childParamsGroups": [] + }, + "key_id": { + "type": "string", + "description": "

    ID of the key you used to encrypt the secret.

    ", + "name": "key_id", + "in": "body", + "rawType": "string", + "rawDescription": "ID of the key you used to encrypt the secret.", + "childParamsGroups": [] + } + } + }, + "example": { + "encrypted_value": "c2VjcmV0", + "key_id": "012345678912345678" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "secrets" + }, + "slug": "create-or-update-a-repository-secret", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "secrets", + "subcategoryLabel": "Secrets", + "notes": [], + "responses": [ + { + "httpStatusCode": "201", + "httpStatusMessage": "Created", + "description": "Response when creating a secret" + }, + { + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Response when updating a secret" + } + ], + "descriptionHTML": "

    Creates or updates a repository secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use\nthis endpoint.

    \n

    Example encrypting a secret using Node.js

    \n

    Encrypt your secret using the tweetsodium library.

    \n
    const sodium = require('tweetsodium');\n\nconst key = \"base64-encoded-public-key\";\nconst value = \"plain-text-secret\";\n\n// Convert the message and key to Uint8Array's (Buffer implements that interface)\nconst messageBytes = Buffer.from(value);\nconst keyBytes = Buffer.from(key, 'base64');\n\n// Encrypt using LibSodium.\nconst encryptedBytes = sodium.seal(messageBytes, keyBytes);\n\n// Base64 the encrypted secret\nconst encrypted = Buffer.from(encryptedBytes).toString('base64');\n\nconsole.log(encrypted);\n
    \n

    Example encrypting a secret using Python

    \n

    Encrypt your secret using pynacl with Python 3.

    \n
    from base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n  \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n  public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n  sealed_box = public.SealedBox(public_key)\n  encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n  return b64encode(encrypted).decode(\"utf-8\")\n
    \n

    Example encrypting a secret using C#

    \n

    Encrypt your secret using the Sodium.Core package.

    \n
    var secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\n
    \n

    Example encrypting a secret using Ruby

    \n

    Encrypt your secret using the rbnacl gem.

    \n
    require \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\n
    ", + "bodyParameters": [ + { + "type": "string", + "description": "

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.

    ", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", + "name": "encrypted_value", + "in": "body", + "rawType": "string", + "rawDescription": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/github-ae@latest/rest/reference/actions#get-a-repository-public-key) endpoint.", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

    ID of the key you used to encrypt the secret.

    ", + "name": "key_id", + "in": "body", + "rawType": "string", + "rawDescription": "ID of the key you used to encrypt the secret.", + "childParamsGroups": [] + } + ] + }, + { + "verb": "delete", + "requestPath": "/repos/{owner}/{repo}/actions/secrets/{secret_name}", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "secret_name", + "description": "secret_name parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    secret_name parameter

    " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/actions/secrets/SECRET_NAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/actions/secrets/SECRET_NAME
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('DELETE /repos/{owner}/{repo}/actions/secrets/{secret_name}', {\n owner: 'octocat',\n repo: 'hello-world',\n secret_name: 'secret_name'\n})", + "html": "
    await octokit.request('DELETE /repos/{owner}/{repo}/actions/secrets/{secret_name}', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  secret_name: 'secret_name'\n})\n
    " + } + ], + "summary": "Delete a repository secret", + "description": "Deletes a secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-repo-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#delete-a-repository-secret" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "secrets" + }, + "slug": "delete-a-repository-secret", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "secrets", + "subcategoryLabel": "Secrets", + "notes": [], + "responses": [ + { + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Response" + } + ], + "bodyParameters": [], + "descriptionHTML": "

    Deletes a secret in a repository using the secret name. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use this endpoint.

    " + }, + { + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/actions/workflows", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "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 http(s)://api.{hostname}/repos/octocat/hello-world/actions/workflows", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/actions/workflows
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /repos/{owner}/{repo}/actions/workflows', {\n owner: 'octocat',\n repo: 'hello-world'\n})", + "html": "
    await octokit.request('GET /repos/{owner}/{repo}/actions/workflows', {\n  owner: 'octocat',\n  repo: 'hello-world'\n})\n
    " + } + ], + "summary": "List repository workflows", + "description": "Lists the workflows in a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/list-repo-workflows", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#list-repository-workflows" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "workflows" + }, + "slug": "list-repository-workflows", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "workflows", + "subcategoryLabel": "Workflows", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

    Lists the workflows in a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.

    ", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
    {\n  \"total_count\": 2,\n  \"workflows\": [\n    {\n      \"id\": 161335,\n      \"node_id\": \"MDg6V29ya2Zsb3cxNjEzMzU=\",\n      \"name\": \"CI\",\n      \"path\": \".github/workflows/blank.yaml\",\n      \"state\": \"active\",\n      \"created_at\": \"2020-01-08T23:48:37.000-08:00\",\n      \"updated_at\": \"2020-01-08T23:50:21.000-08:00\",\n      \"url\": \"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/161335\",\n      \"html_url\": \"https://github.com/octo-org/octo-repo/blob/master/.github/workflows/161335\",\n      \"badge_url\": \"https://github.com/octo-org/octo-repo/workflows/CI/badge.svg\"\n    },\n    {\n      \"id\": 269289,\n      \"node_id\": \"MDE4OldvcmtmbG93IFNlY29uZGFyeTI2OTI4OQ==\",\n      \"name\": \"Linter\",\n      \"path\": \".github/workflows/linter.yaml\",\n      \"state\": \"active\",\n      \"created_at\": \"2020-01-08T23:48:37.000-08:00\",\n      \"updated_at\": \"2020-01-08T23:50:21.000-08:00\",\n      \"url\": \"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/269289\",\n      \"html_url\": \"https://github.com/octo-org/octo-repo/blob/master/.github/workflows/269289\",\n      \"badge_url\": \"https://github.com/octo-org/octo-repo/workflows/Linter/badge.svg\"\n    }\n  ]\n}\n
    " + } + ] + }, + { + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "workflow_id", + "in": "path", + "description": "The ID of the workflow. You can also pass the workflow file name as a string.", + "required": true, + "schema": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string" + } + ] + }, + "descriptionHTML": "

    The ID of the workflow. You can also pass the workflow file name as a string.

    " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/actions/workflows/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/actions/workflows/42
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n workflow_id: 42\n})", + "html": "
    await octokit.request('GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  workflow_id: 42\n})\n
    " + } + ], + "summary": "Get a workflow", + "description": "Gets a specific workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-workflow", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#get-a-workflow" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "workflows" + }, + "slug": "get-a-workflow", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "workflows", + "subcategoryLabel": "Workflows", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

    Gets a specific workflow. You can replace workflow_id with the workflow file name. For example, you could use main.yaml. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.

    ", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
    {\n  \"id\": 161335,\n  \"node_id\": \"MDg6V29ya2Zsb3cxNjEzMzU=\",\n  \"name\": \"CI\",\n  \"path\": \".github/workflows/blank.yaml\",\n  \"state\": \"active\",\n  \"created_at\": \"2020-01-08T23:48:37.000-08:00\",\n  \"updated_at\": \"2020-01-08T23:50:21.000-08:00\",\n  \"url\": \"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/161335\",\n  \"html_url\": \"https://github.com/octo-org/octo-repo/blob/master/.github/workflows/161335\",\n  \"badge_url\": \"https://github.com/octo-org/octo-repo/workflows/CI/badge.svg\"\n}\n
    " + } + ] + }, + { + "verb": "put", + "requestPath": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "workflow_id", + "in": "path", + "description": "The ID of the workflow. You can also pass the workflow file name as a string.", + "required": true, + "schema": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string" + } + ] + }, + "descriptionHTML": "

    The ID of the workflow. You can also pass the workflow file name as a string.

    " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/actions/workflows/42/disable", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/actions/workflows/42/disable
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('PUT /repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable', {\n owner: 'octocat',\n repo: 'hello-world',\n workflow_id: 42\n})", + "html": "
    await octokit.request('PUT /repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  workflow_id: 42\n})\n
    " + } + ], + "summary": "Disable a workflow", + "description": "Disables a workflow and sets the `state` of the workflow to `disabled_manually`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/disable-workflow", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#disable-a-workflow" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "workflows" + }, + "slug": "disable-a-workflow", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "workflows", + "subcategoryLabel": "Workflows", + "notes": [], + "responses": [ + { + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Response" + } + ], + "bodyParameters": [], + "descriptionHTML": "

    Disables a workflow and sets the state of the workflow to disabled_manually. You can replace workflow_id with the workflow file name. For example, you could use main.yaml.

    \n

    You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions:write permission to use this endpoint.

    " + }, + { + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "workflow_id", + "in": "path", + "description": "The ID of the workflow. You can also pass the workflow file name as a string.", + "required": true, + "schema": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string" + } + ] + }, + "descriptionHTML": "

    The ID of the workflow. You can also pass the workflow file name as a string.

    " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/actions/workflows/42/dispatches \\\n -d '{\"ref\":\"ref\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/actions/workflows/42/dispatches \\\n  -d '{\"ref\":\"ref\"}'
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('POST /repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches', {\n owner: 'octocat',\n repo: 'hello-world',\n workflow_id: 42,\n ref: 'ref'\n})", + "html": "
    await octokit.request('POST /repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  workflow_id: 42,\n  ref: 'ref'\n})\n
    " + } + ], + "summary": "Create a workflow dispatch event", + "description": "You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.\n\nYou must configure your GitHub Actions workflow to run when the [`workflow_dispatch` webhook](/developers/webhooks-and-events/webhook-events-and-payloads#workflow_dispatch) event occurs. The `inputs` are configured in the workflow file. For more information about how to configure the `workflow_dispatch` event in the workflow file, see \"[Events that trigger workflows](/actions/reference/events-that-trigger-workflows#workflow_dispatch).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see \"[Creating a personal access token for the command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line).\"", + "operationId": "actions/create-workflow-dispatch", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#create-a-workflow-dispatch-event" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "ref": { + "type": "string", + "description": "

    Required. The git reference for the workflow. The reference can be a branch or tag name.

    ", + "name": "ref", + "in": "body", + "rawType": "string", + "rawDescription": "The git reference for the workflow. The reference can be a branch or tag name.", + "childParamsGroups": [] + }, + "inputs": { + "type": "object", + "description": "

    Input keys and values configured in the workflow file. The maximum number of properties is 10. Any default properties configured in the workflow file will be used when inputs are omitted.

    ", + "additionalProperties": { + "type": "string" + }, + "maxProperties": 10, + "name": "inputs", + "in": "body", + "rawType": "object", + "rawDescription": "Input keys and values configured in the workflow file. The maximum number of properties is 10. Any default properties configured in the workflow file will be used when `inputs` are omitted.", + "childParamsGroups": [] + } + }, + "required": [ + "ref" + ] + }, + "example": { + "ref": "topic-branch", + "inputs": { + "name": "Mona the Octocat", + "home": "San Francisco, CA" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "workflows" + }, + "slug": "create-a-workflow-dispatch-event", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "workflows", + "subcategoryLabel": "Workflows", + "notes": [], + "responses": [ + { + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Response" + } + ], + "descriptionHTML": "

    You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace workflow_id with the workflow file name. For example, you could use main.yaml.

    \n

    You must configure your GitHub Actions workflow to run when the workflow_dispatch webhook event occurs. The inputs are configured in the workflow file. For more information about how to configure the workflow_dispatch event in the workflow file, see \"Events that trigger workflows.\"

    \n

    You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions:write permission to use this endpoint. For more information, see \"Creating a personal access token for the command line.\"

    ", + "bodyParameters": [ + { + "type": "string", + "description": "

    Required. The git reference for the workflow. The reference can be a branch or tag name.

    ", + "name": "ref", + "in": "body", + "rawType": "string", + "rawDescription": "The git reference for the workflow. The reference can be a branch or tag name.", + "childParamsGroups": [] + }, + { + "type": "object", + "description": "

    Input keys and values configured in the workflow file. The maximum number of properties is 10. Any default properties configured in the workflow file will be used when inputs are omitted.

    ", + "additionalProperties": { + "type": "string" + }, + "maxProperties": 10, + "name": "inputs", + "in": "body", + "rawType": "object", + "rawDescription": "Input keys and values configured in the workflow file. The maximum number of properties is 10. Any default properties configured in the workflow file will be used when `inputs` are omitted.", + "childParamsGroups": [] + } + ] + }, + { + "verb": "put", + "requestPath": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "workflow_id", + "in": "path", + "description": "The ID of the workflow. You can also pass the workflow file name as a string.", + "required": true, + "schema": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string" + } + ] + }, + "descriptionHTML": "

    The ID of the workflow. You can also pass the workflow file name as a string.

    " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/actions/workflows/42/enable", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/actions/workflows/42/enable
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('PUT /repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable', {\n owner: 'octocat',\n repo: 'hello-world',\n workflow_id: 42\n})", + "html": "
    await octokit.request('PUT /repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  workflow_id: 42\n})\n
    " + } + ], + "summary": "Enable a workflow", + "description": "Enables a workflow and sets the `state` of the workflow to `active`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/enable-workflow", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#enable-a-workflow" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "workflows" + }, + "slug": "enable-a-workflow", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "workflows", + "subcategoryLabel": "Workflows", + "notes": [], + "responses": [ + { + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Response" + } + ], + "bodyParameters": [], + "descriptionHTML": "

    Enables a workflow and sets the state of the workflow to active. You can replace workflow_id with the workflow file name. For example, you could use main.yaml.

    \n

    You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions:write permission to use this endpoint.

    " + }, + { + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "workflow_id", + "in": "path", + "description": "The ID of the workflow. You can also pass the workflow file name as a string.", + "required": true, + "schema": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string" + } + ] + }, + "descriptionHTML": "

    The ID of the workflow. You can also pass the workflow file name as a string.

    " + }, + { + "name": "actor", + "description": "Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run.", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    Returns someone's workflow runs. Use the login for the user who created the push associated with the check suite or workflow run.

    " + }, + { + "name": "branch", + "description": "Returns workflow runs associated with a branch. Use the name of the branch of the `push`.", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    Returns workflow runs associated with a branch. Use the name of the branch of the push.

    " + }, + { + "name": "event", + "description": "Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see \"[Events that trigger workflows](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows).\"", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    Returns workflow run triggered by the event you specify. For example, push, pull_request or issue. For more information, see \"Events that trigger workflows.\"

    " + }, + { + "name": "status", + "description": "Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`. For a list of the possible `status` and `conclusion` options, see \"[Create a check run](https://docs.github.com/github-ae@latest/rest/reference/checks#create-a-check-run).\"", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "completed", + "action_required", + "cancelled", + "failure", + "neutral", + "skipped", + "stale", + "success", + "timed_out", + "in_progress", + "queued", + "requested", + "waiting" + ] + }, + "descriptionHTML": "

    Returns workflow runs with the check run status or conclusion that you specify. For example, a conclusion can be success or a status can be in_progress. Only GitHub can set a status of waiting or requested. For a list of the possible status and conclusion options, see \"Create a check run.\"

    " + }, + { + "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 http(s)://api.{hostname}/repos/octocat/hello-world/actions/workflows/42/runs", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/actions/workflows/42/runs
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs', {\n owner: 'octocat',\n repo: 'hello-world',\n workflow_id: 42\n})", + "html": "
    await octokit.request('GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  workflow_id: 42\n})\n
    " + } + ], + "summary": "List workflow runs", + "description": "List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope.", + "tags": [ + "actions" + ], + "operationId": "actions/list-workflow-runs", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#list-workflow-runs" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "workflow-runs" + }, + "slug": "list-workflow-runs", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "workflow-runs", + "subcategoryLabel": "Workflow runs", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

    List all workflow runs for a workflow. You can replace workflow_id with the workflow file name. For example, you could use main.yaml. You can use parameters to narrow the list of results. For more information about using parameters, see Parameters.

    \n

    Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope.

    ", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
    {\n  \"total_count\": 1,\n  \"workflow_runs\": [\n    {\n      \"id\": 30433642,\n      \"name\": \"Build\",\n      \"node_id\": \"MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==\",\n      \"head_branch\": \"master\",\n      \"head_sha\": \"acb5820ced9479c074f688cc328bf03f341a511d\",\n      \"run_number\": 562,\n      \"event\": \"push\",\n      \"status\": \"queued\",\n      \"conclusion\": null,\n      \"workflow_id\": 159038,\n      \"url\": \"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642\",\n      \"html_url\": \"https://github.com/octo-org/octo-repo/actions/runs/30433642\",\n      \"pull_requests\": [],\n      \"created_at\": \"2020-01-22T19:33:08Z\",\n      \"updated_at\": \"2020-01-22T19:33:08Z\",\n      \"jobs_url\": \"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs\",\n      \"logs_url\": \"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs\",\n      \"check_suite_url\": \"https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374\",\n      \"artifacts_url\": \"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts\",\n      \"cancel_url\": \"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel\",\n      \"rerun_url\": \"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun\",\n      \"workflow_url\": \"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038\",\n      \"head_commit\": {\n        \"id\": \"acb5820ced9479c074f688cc328bf03f341a511d\",\n        \"tree_id\": \"d23f6eedb1e1b9610bbc754ddb5197bfe7271223\",\n        \"message\": \"Create linter.yaml\",\n        \"timestamp\": \"2020-01-22T19:33:05Z\",\n        \"author\": {\n          \"name\": \"Octo Cat\",\n          \"email\": \"octocat@github.com\"\n        },\n        \"committer\": {\n          \"name\": \"GitHub\",\n          \"email\": \"noreply@github.com\"\n        }\n      },\n      \"repository\": {\n        \"id\": 1296269,\n        \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n        \"name\": \"Hello-World\",\n        \"full_name\": \"octocat/Hello-World\",\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        \"private\": false,\n        \"html_url\": \"https://github.com/octocat/Hello-World\",\n        \"description\": \"This your first repo!\",\n        \"fork\": false,\n        \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n        \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n        \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n        \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n        \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n        \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n        \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n        \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n        \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n        \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n        \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n        \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n        \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n        \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n        \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n        \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n        \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n        \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n        \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n        \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n        \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n        \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n        \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n        \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n        \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n        \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n        \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n        \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n        \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n        \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n        \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n        \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n        \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n        \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n        \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n        \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n        \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n        \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n        \"hooks_url\": \"http://api.github.com/repos/octocat/Hello-World/hooks\"\n      },\n      \"head_repository\": {\n        \"id\": 217723378,\n        \"node_id\": \"MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=\",\n        \"name\": \"octo-repo\",\n        \"full_name\": \"octo-org/octo-repo\",\n        \"private\": true,\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        \"html_url\": \"https://github.com/octo-org/octo-repo\",\n        \"description\": null,\n        \"fork\": false,\n        \"url\": \"https://api.github.com/repos/octo-org/octo-repo\",\n        \"forks_url\": \"https://api.github.com/repos/octo-org/octo-repo/forks\",\n        \"keys_url\": \"https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}\",\n        \"collaborators_url\": \"https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}\",\n        \"teams_url\": \"https://api.github.com/repos/octo-org/octo-repo/teams\",\n        \"hooks_url\": \"https://api.github.com/repos/octo-org/octo-repo/hooks\",\n        \"issue_events_url\": \"https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}\",\n        \"events_url\": \"https://api.github.com/repos/octo-org/octo-repo/events\",\n        \"assignees_url\": \"https://api.github.com/repos/octo-org/octo-repo/assignees{/user}\",\n        \"branches_url\": \"https://api.github.com/repos/octo-org/octo-repo/branches{/branch}\",\n        \"tags_url\": \"https://api.github.com/repos/octo-org/octo-repo/tags\",\n        \"blobs_url\": \"https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}\",\n        \"git_tags_url\": \"https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}\",\n        \"git_refs_url\": \"https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}\",\n        \"trees_url\": \"https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}\",\n        \"statuses_url\": \"https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}\",\n        \"languages_url\": \"https://api.github.com/repos/octo-org/octo-repo/languages\",\n        \"stargazers_url\": \"https://api.github.com/repos/octo-org/octo-repo/stargazers\",\n        \"contributors_url\": \"https://api.github.com/repos/octo-org/octo-repo/contributors\",\n        \"subscribers_url\": \"https://api.github.com/repos/octo-org/octo-repo/subscribers\",\n        \"subscription_url\": \"https://api.github.com/repos/octo-org/octo-repo/subscription\",\n        \"commits_url\": \"https://api.github.com/repos/octo-org/octo-repo/commits{/sha}\",\n        \"git_commits_url\": \"https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}\",\n        \"comments_url\": \"https://api.github.com/repos/octo-org/octo-repo/comments{/number}\",\n        \"issue_comment_url\": \"https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}\",\n        \"contents_url\": \"https://api.github.com/repos/octo-org/octo-repo/contents/{+path}\",\n        \"compare_url\": \"https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}\",\n        \"merges_url\": \"https://api.github.com/repos/octo-org/octo-repo/merges\",\n        \"archive_url\": \"https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}\",\n        \"downloads_url\": \"https://api.github.com/repos/octo-org/octo-repo/downloads\",\n        \"issues_url\": \"https://api.github.com/repos/octo-org/octo-repo/issues{/number}\",\n        \"pulls_url\": \"https://api.github.com/repos/octo-org/octo-repo/pulls{/number}\",\n        \"milestones_url\": \"https://api.github.com/repos/octo-org/octo-repo/milestones{/number}\",\n        \"notifications_url\": \"https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}\",\n        \"labels_url\": \"https://api.github.com/repos/octo-org/octo-repo/labels{/name}\",\n        \"releases_url\": \"https://api.github.com/repos/octo-org/octo-repo/releases{/id}\",\n        \"deployments_url\": \"https://api.github.com/repos/octo-org/octo-repo/deployments\"\n      }\n    }\n  ]\n}\n
    " + } + ] + }, + { + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "workflow_id", + "in": "path", + "description": "The ID of the workflow. You can also pass the workflow file name as a string.", + "required": true, + "schema": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string" + } + ] + }, + "descriptionHTML": "

    The ID of the workflow. You can also pass the workflow file name as a string.

    " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/actions/workflows/42/timing", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/actions/workflows/42/timing
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing', {\n owner: 'octocat',\n repo: 'hello-world',\n workflow_id: 42\n})", + "html": "
    await octokit.request('GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  workflow_id: 42\n})\n
    " + } + ], + "summary": "Get workflow usage", + "description": "Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub AE-hosted runners. Usage is listed for each GitHub AE-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nYou can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-workflow-usage", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#get-workflow-usage" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "actions", + "subcategory": "workflows" + }, + "slug": "get-workflow-usage", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "workflows", + "subcategoryLabel": "Workflows", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

    Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub AE-hosted runners. Usage is listed for each GitHub AE-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"Managing billing for GitHub Actions\".

    \n

    You can replace workflow_id with the workflow file name. For example, you could use main.yaml. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.

    ", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
    {\n  \"billable\": {\n    \"UBUNTU\": {\n      \"total_ms\": 180000\n    },\n    \"MACOS\": {\n      \"total_ms\": 240000\n    },\n    \"WINDOWS\": {\n      \"total_ms\": 300000\n    }\n  }\n}\n
    " + } + ] + }, + { + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/assignees", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "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 http(s)://api.{hostname}/repos/octocat/hello-world/assignees", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/assignees
    " }, { "lang": "JavaScript", @@ -21584,7 +29102,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/assignees/{assignee}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -21617,8 +29135,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/assignees/ASSIGNEE", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/assignees/ASSIGNEE
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/assignees/ASSIGNEE", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/assignees/ASSIGNEE
    " }, { "lang": "JavaScript", @@ -21667,7 +29185,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -21721,8 +29239,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/branches", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/branches
    " }, { "lang": "JavaScript", @@ -21760,12 +29278,6 @@ "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "
    [\n  {\n    \"name\": \"master\",\n    \"commit\": {\n      \"sha\": \"c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc\",\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc\"\n    },\n    \"protected\": true\n  }\n]\n
    " - }, - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "With protection", "payload": "
    [\n  {\n    \"name\": \"master\",\n    \"commit\": {\n      \"sha\": \"c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc\",\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc\"\n    },\n    \"protected\": true,\n    \"protection\": {\n      \"enabled\": true,\n      \"required_status_checks\": {\n        \"enforcement_level\": \"non_admins\",\n        \"contexts\": [\n          \"ci-test\",\n          \"linter\"\n        ]\n      }\n    },\n    \"protection_url\": \"https://api.github.com/repos/octocat/hello-world/branches/master/protection\"\n  }\n]\n
    " }, { @@ -21778,7 +29290,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -21813,8 +29325,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/branches/BRANCH", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/branches/BRANCH
    " }, { "lang": "JavaScript", @@ -21869,7 +29381,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -21904,8 +29416,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/branches/BRANCH/protection", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/branches/BRANCH/protection
    " }, { "lang": "JavaScript", @@ -21962,7 +29474,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -21997,8 +29509,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection \\\n -d '{\"required_status_checks\":{\"strict\":true,\"contexts\":[\"contexts\"]},\"enforce_admins\":true,\"required_pull_request_reviews\":{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":42},\"restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"],\"apps\":[\"apps\"]}}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection \\\n  -d '{\"required_status_checks\":{\"strict\":true,\"contexts\":[\"contexts\"]},\"enforce_admins\":true,\"required_pull_request_reviews\":{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":42},\"restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"],\"apps\":[\"apps\"]}}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/branches/BRANCH/protection \\\n -d '{\"required_status_checks\":{\"strict\":true,\"contexts\":[\"contexts\"]},\"enforce_admins\":true,\"required_pull_request_reviews\":{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":42},\"restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"],\"apps\":[\"apps\"]}}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/branches/BRANCH/protection \\\n  -d '{\"required_status_checks\":{\"strict\":true,\"contexts\":[\"contexts\"]},\"enforce_admins\":true,\"required_pull_request_reviews\":{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":42},\"restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"],\"apps\":[\"apps\"]}}'
    " }, { "lang": "JavaScript", @@ -23001,7 +30513,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -23036,8 +30548,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/branches/BRANCH/protection", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/branches/BRANCH/protection
    " }, { "lang": "JavaScript", @@ -23072,7 +30584,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -23086,7 +30598,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -23121,8 +30633,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins
    " }, { "lang": "JavaScript", @@ -23167,7 +30679,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -23202,8 +30714,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins
    " }, { "lang": "JavaScript", @@ -23248,7 +30760,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -23283,8 +30795,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins
    " }, { "lang": "JavaScript", @@ -23333,7 +30845,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -23368,8 +30880,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews
    " }, { "lang": "JavaScript", @@ -23420,7 +30932,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -23455,8 +30967,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews \\\n -d '{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]}}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews \\\n  -d '{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]}}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews \\\n -d '{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]}}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews \\\n  -d '{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]}}'
    " }, { "lang": "JavaScript", @@ -23726,7 +31238,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -23761,8 +31273,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews
    " }, { "lang": "JavaScript", @@ -23811,7 +31323,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -23846,8 +31358,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures
    " }, { "lang": "JavaScript", @@ -23904,7 +31416,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -23939,8 +31451,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures
    " }, { "lang": "JavaScript", @@ -23997,7 +31509,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -24032,8 +31544,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures
    " }, { "lang": "JavaScript", @@ -24089,7 +31601,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -24124,8 +31636,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks
    " }, { "lang": "JavaScript", @@ -24175,7 +31687,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -24210,8 +31722,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks \\\n -d '{\"strict\":true}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks \\\n  -d '{\"strict\":true}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks \\\n -d '{\"strict\":true}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks \\\n  -d '{\"strict\":true}'
    " }, { "lang": "JavaScript", @@ -24326,7 +31838,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -24361,8 +31873,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks
    " }, { "lang": "JavaScript", @@ -24406,7 +31918,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -24441,8 +31953,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts
    " }, { "lang": "JavaScript", @@ -24492,7 +32004,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -24527,8 +32039,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n  -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n  -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'
    " }, { "lang": "JavaScript", @@ -24633,7 +32145,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -24668,8 +32180,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n  -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n  -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'
    " }, { "lang": "JavaScript", @@ -24769,7 +32281,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -24804,8 +32316,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n  -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n  -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'
    " }, { "lang": "JavaScript", @@ -24905,7 +32417,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -24940,8 +32452,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/branches/BRANCH/protection/restrictions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/branches/BRANCH/protection/restrictions
    " }, { "lang": "JavaScript", @@ -24991,7 +32503,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -25026,8 +32538,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/branches/BRANCH/protection/restrictions", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/branches/BRANCH/protection/restrictions
    " }, { "lang": "JavaScript", @@ -25071,7 +32583,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -25106,8 +32618,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps
    " }, { "lang": "JavaScript", @@ -25157,7 +32669,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -25192,8 +32704,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps \\\n -d '{\"apps\":{\"apps\":[\"apps\"]}}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps \\\n  -d '{\"apps\":{\"apps\":[\"apps\"]}}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps \\\n -d '{\"apps\":{\"apps\":[\"apps\"]}}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps \\\n  -d '{\"apps\":{\"apps\":[\"apps\"]}}'
    " }, { "lang": "JavaScript", @@ -25288,7 +32800,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -25323,8 +32835,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps \\\n -d '{\"apps\":{\"apps\":[\"apps\"]}}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps \\\n  -d '{\"apps\":{\"apps\":[\"apps\"]}}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps \\\n -d '{\"apps\":{\"apps\":[\"apps\"]}}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps \\\n  -d '{\"apps\":{\"apps\":[\"apps\"]}}'
    " }, { "lang": "JavaScript", @@ -25419,7 +32931,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -25454,8 +32966,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps \\\n -d '{\"apps\":{\"apps\":[\"apps\"]}}'", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps \\\n  -d '{\"apps\":{\"apps\":[\"apps\"]}}'
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps \\\n -d '{\"apps\":{\"apps\":[\"apps\"]}}'", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps \\\n  -d '{\"apps\":{\"apps\":[\"apps\"]}}'
    " }, { "lang": "JavaScript", @@ -25550,7 +33062,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -25585,8 +33097,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams
    " }, { "lang": "JavaScript", @@ -25636,7 +33148,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -25671,8 +33183,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n -d '{\"teams\":{\"teams\":[\"teams\"]}}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n  -d '{\"teams\":{\"teams\":[\"teams\"]}}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n -d '{\"teams\":{\"teams\":[\"teams\"]}}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n  -d '{\"teams\":{\"teams\":[\"teams\"]}}'
    " }, { "lang": "JavaScript", @@ -25767,7 +33279,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -25802,8 +33314,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n -d '{\"teams\":{\"teams\":[\"teams\"]}}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n  -d '{\"teams\":{\"teams\":[\"teams\"]}}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n -d '{\"teams\":{\"teams\":[\"teams\"]}}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n  -d '{\"teams\":{\"teams\":[\"teams\"]}}'
    " }, { "lang": "JavaScript", @@ -25898,7 +33410,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -25933,8 +33445,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n -d '{\"teams\":{\"teams\":[\"teams\"]}}'", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n  -d '{\"teams\":{\"teams\":[\"teams\"]}}'
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n -d '{\"teams\":{\"teams\":[\"teams\"]}}'", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n  -d '{\"teams\":{\"teams\":[\"teams\"]}}'
    " }, { "lang": "JavaScript", @@ -26029,7 +33541,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -26064,8 +33576,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users
    " }, { "lang": "JavaScript", @@ -26115,7 +33627,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -26150,8 +33662,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n -d '{\"users\":{\"users\":[\"users\"]}}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n  -d '{\"users\":{\"users\":[\"users\"]}}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n -d '{\"users\":{\"users\":[\"users\"]}}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n  -d '{\"users\":{\"users\":[\"users\"]}}'
    " }, { "lang": "JavaScript", @@ -26246,7 +33758,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -26281,8 +33793,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n -d '{\"users\":{\"users\":[\"users\"]}}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n  -d '{\"users\":{\"users\":[\"users\"]}}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n -d '{\"users\":{\"users\":[\"users\"]}}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n  -d '{\"users\":{\"users\":[\"users\"]}}'
    " }, { "lang": "JavaScript", @@ -26377,7 +33889,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -26412,8 +33924,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n -d '{\"users\":{\"users\":[\"users\"]}}'", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n  -d '{\"users\":{\"users\":[\"users\"]}}'
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n -d '{\"users\":{\"users\":[\"users\"]}}'", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n  -d '{\"users\":{\"users\":[\"users\"]}}'
    " }, { "lang": "JavaScript", @@ -26508,7 +34020,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/check-runs", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -26532,8 +34044,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-runs \\\n -d '{\"name\":\"name\",\"head_sha\":\"head_sha\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/check-runs \\\n  -d '{\"name\":\"name\",\"head_sha\":\"head_sha\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/check-runs \\\n -d '{\"name\":\"name\",\"head_sha\":\"head_sha\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/check-runs \\\n  -d '{\"name\":\"name\",\"head_sha\":\"head_sha\"}'
    " }, { "lang": "JavaScript", @@ -27510,7 +35022,7 @@ "name", "head_sha" ], - "anyOf": [ + "oneOf": [ { "properties": { "status": { @@ -27520,6 +35032,7 @@ } }, "required": [ + "status", "conclusion" ], "additionalProperties": true @@ -27539,7 +35052,7 @@ }, "examples": { "example-of-in-progress-conclusion": { - "summary": "Example of in_progress conclusion", + "summary": "Response for in_progress conclusion", "value": { "name": "mighty_readme", "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -27554,7 +35067,7 @@ } }, "example-of-completed-conclusion": { - "summary": "Example of completed conclusion", + "summary": "Response for completed conclusion", "value": { "name": "mighty_readme", "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -27621,12 +35134,6 @@ "notes": [], "descriptionHTML": "

    Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

    \n

    Creates a new check run for a specific commit in a repository. Your GitHub App must have the checks:write permission to create check runs.

    \n

    In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.

    ", "responses": [ - { - "httpStatusCode": "201", - "httpStatusMessage": "Created", - "description": "Response for in_progress conclusion", - "payload": "
    {\n  \"id\": 4,\n  \"head_sha\": \"ce587453ced02b1526dfb4cb910479d431683101\",\n  \"node_id\": \"MDg6Q2hlY2tSdW40\",\n  \"external_id\": \"42\",\n  \"url\": \"https://api.github.com/repos/github/hello-world/check-runs/4\",\n  \"html_url\": \"https://github.com/github/hello-world/runs/4\",\n  \"details_url\": \"https://example.com\",\n  \"status\": \"in_progress\",\n  \"conclusion\": \"neutral\",\n  \"started_at\": \"2018-05-04T01:14:52Z\",\n  \"completed_at\": null,\n  \"output\": {\n    \"title\": \"Mighty Readme Report\",\n    \"summary\": \"\",\n    \"text\": \"\",\n    \"annotations_count\": 1,\n    \"annotations_url\": \"https://api.github.com/repos/github/hello-world/check-runs/4/annotations\"\n  },\n  \"name\": \"mighty_readme\",\n  \"check_suite\": {\n    \"id\": 5\n  },\n  \"app\": {\n    \"id\": 1,\n    \"slug\": \"octoapp\",\n    \"node_id\": \"MDExOkludGVncmF0aW9uMQ==\",\n    \"owner\": {\n      \"login\": \"github\",\n      \"id\": 1,\n      \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n      \"url\": \"https://api.github.com/orgs/github\",\n      \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n      \"events_url\": \"https://api.github.com/orgs/github/events\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\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      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": true\n    },\n    \"name\": \"Octocat App\",\n    \"description\": \"\",\n    \"external_url\": \"https://example.com\",\n    \"html_url\": \"https://github.com/apps/octoapp\",\n    \"created_at\": \"2017-07-08T16:18:44-04:00\",\n    \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n    \"permissions\": {\n      \"metadata\": \"read\",\n      \"contents\": \"read\",\n      \"issues\": \"write\",\n      \"single_file\": \"write\"\n    },\n    \"events\": [\n      \"push\",\n      \"pull_request\"\n    ]\n  },\n  \"pull_requests\": [\n    {\n      \"url\": \"https://api.github.com/repos/github/hello-world/pulls/1\",\n      \"id\": 1934,\n      \"number\": 3956,\n      \"head\": {\n        \"ref\": \"say-hello\",\n        \"sha\": \"3dca65fa3e8d4b3da3f3d056c59aee1c50f41390\",\n        \"repo\": {\n          \"id\": 526,\n          \"url\": \"https://api.github.com/repos/github/hello-world\",\n          \"name\": \"hello-world\"\n        }\n      },\n      \"base\": {\n        \"ref\": \"master\",\n        \"sha\": \"e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f\",\n        \"repo\": {\n          \"id\": 526,\n          \"url\": \"https://api.github.com/repos/github/hello-world\",\n          \"name\": \"hello-world\"\n        }\n      }\n    }\n  ]\n}\n
    " - }, { "httpStatusCode": "201", "httpStatusMessage": "Created", @@ -28588,7 +36095,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/check-runs/{check_run_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -28622,8 +36129,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-runs/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/check-runs/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/check-runs/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/check-runs/42
    " }, { "lang": "JavaScript", @@ -28668,7 +36175,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/check-runs/{check_run_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -28702,8 +36209,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-runs/42 \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/check-runs/42 \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/check-runs/42 \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/check-runs/42 \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -30698,7 +38205,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/check-runs/{check_run_id}/annotations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -30752,8 +38259,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-runs/42/annotations", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/check-runs/42/annotations
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/check-runs/42/annotations", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/check-runs/42/annotations
    " }, { "lang": "JavaScript", @@ -30798,7 +38305,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/check-suites", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -30822,8 +38329,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-suites \\\n -d '{\"head_sha\":\"head_sha\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/check-suites \\\n  -d '{\"head_sha\":\"head_sha\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/check-suites \\\n -d '{\"head_sha\":\"head_sha\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/check-suites \\\n  -d '{\"head_sha\":\"head_sha\"}'
    " }, { "lang": "JavaScript", @@ -30904,7 +38411,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/check-suites/preferences", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -30928,8 +38435,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-suites/preferences \\\n -d '{\"auto_trigger_checks\":[{\"app_id\":42,\"setting\":true}]}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/check-suites/preferences \\\n  -d '{\"auto_trigger_checks\":[{\"app_id\":42,\"setting\":true}]}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/check-suites/preferences \\\n -d '{\"auto_trigger_checks\":[{\"app_id\":42,\"setting\":true}]}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/check-suites/preferences \\\n  -d '{\"auto_trigger_checks\":[{\"app_id\":42,\"setting\":true}]}'
    " }, { "lang": "JavaScript", @@ -31122,7 +38629,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/check-suites/{check_suite_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -31156,8 +38663,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-suites/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/check-suites/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/check-suites/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/check-suites/42
    " }, { "lang": "JavaScript", @@ -31202,7 +38709,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -31296,8 +38803,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-suites/42/check-runs", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/check-suites/42/check-runs
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/check-suites/42/check-runs", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/check-suites/42/check-runs
    " }, { "lang": "JavaScript", @@ -31342,7 +38849,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -31376,8 +38883,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-suites/42/rerequest", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/check-suites/42/rerequest
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/check-suites/42/rerequest", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/check-suites/42/rerequest
    " }, { "lang": "JavaScript", @@ -31418,10 +38925,1137 @@ "bodyParameters": [], "descriptionHTML": "

    Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the check_suite webhook event with the action rerequested. When a check suite is rerequested, its status is reset to queued and the conclusion is cleared.

    \n

    To rerequest a check suite, your GitHub App must have the checks:read permission on a private repository or pull access to a public repository.

    " }, + { + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/code-scanning/alerts", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "tool_name", + "description": "The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "description": "The name of the tool used to generate the code scanning analysis." + }, + "descriptionHTML": "

    The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either tool_name or tool_guid, but not both.

    " + }, + { + "name": "tool_guid", + "description": "The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both.", + "in": "query", + "required": false, + "schema": { + "nullable": true, + "type": "string", + "description": "The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data." + }, + "descriptionHTML": "

    The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either tool_guid or tool_name, but not both.

    " + }, + { + "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.

    " + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "descriptionHTML": "

    Results per page (max 100).

    " + }, + { + "name": "ref", + "description": "The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." + }, + "descriptionHTML": "

    The Git reference for the results you want to list. The ref for a branch can be formatted either as refs/heads/<branch name> or simply <branch name>. To reference a pull request use refs/pull/<number>/merge.

    " + }, + { + "name": "state", + "description": "Set to `open`, `fixed`, or `dismissed` to list code scanning alerts in a specific state.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "description": "State of a code scanning alert.", + "enum": [ + "open", + "closed", + "dismissed", + "fixed" + ] + }, + "descriptionHTML": "

    Set to open, fixed, or dismissed to list code scanning alerts in a specific state.

    " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/code-scanning/alerts", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/code-scanning/alerts
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /repos/{owner}/{repo}/code-scanning/alerts', {\n owner: 'octocat',\n repo: 'hello-world'\n})", + "html": "
    await octokit.request('GET /repos/{owner}/{repo}/code-scanning/alerts', {\n  owner: 'octocat',\n  repo: 'hello-world'\n})\n
    " + } + ], + "summary": "List code scanning alerts for a repository", + "description": "Lists all open code scanning alerts for the default branch (usually `main`\nor `master`). You must use an access token with the `security_events` scope to use\nthis endpoint. GitHub Apps must have the `security_events` read permission to use\nthis endpoint.\n\nThe response includes a `most_recent_instance` object.\nThis provides details of the most recent instance of this alert\nfor the default branch or for the specified Git reference\n(if you used `ref` in the request).", + "tags": [ + "code-scanning" + ], + "operationId": "code-scanning/list-alerts-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/code-scanning#list-code-scanning-alerts-for-a-repository" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "code-scanning", + "subcategory": null + }, + "slug": "list-code-scanning-alerts-for-a-repository", + "category": "code-scanning", + "categoryLabel": "Code scanning", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

    Lists all open code scanning alerts for the default branch (usually main\nor master). You must use an access token with the security_events scope to use\nthis endpoint. GitHub Apps must have the security_events read permission to use\nthis endpoint.

    \n

    The response includes a most_recent_instance object.\nThis provides details of the most recent instance of this alert\nfor the default branch or for the specified Git reference\n(if you used ref in the request).

    ", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
    [\n  {\n    \"number\": 4,\n    \"created_at\": \"2020-02-13T12:29:18Z\",\n    \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4\",\n    \"html_url\": \"https://github.com/octocat/hello-world/code-scanning/4\",\n    \"state\": \"open\",\n    \"dismissed_by\": null,\n    \"dismissed_at\": null,\n    \"dismissed_reason\": null,\n    \"rule\": {\n      \"id\": \"js/zipslip\",\n      \"severity\": \"error\",\n      \"description\": \"Arbitrary file write during zip extraction\",\n      \"name\": \"js/zipslip\"\n    },\n    \"tool\": {\n      \"name\": \"CodeQL\",\n      \"guid\": null,\n      \"version\": \"2.4.0\"\n    },\n    \"most_recent_instance\": {\n      \"ref\": \"refs/heads/main\",\n      \"analysis_key\": \".github/workflows/codeql-analysis.yml:CodeQL-Build\",\n      \"environment\": \"{}\",\n      \"state\": \"open\",\n      \"commit_sha\": \"39406e42cb832f683daa691dd652a8dc36ee8930\",\n      \"message\": {\n        \"text\": \"This path depends on a user-provided value.\"\n      },\n      \"location\": {\n        \"path\": \"spec-main/api-session-spec.ts\",\n        \"start_line\": 917,\n        \"end_line\": 917,\n        \"start_column\": 7,\n        \"end_column\": 18\n      },\n      \"classifications\": [\n        \"test\"\n      ]\n    },\n    \"instances_url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4/instances\"\n  },\n  {\n    \"number\": 3,\n    \"created_at\": \"2020-02-13T12:29:18Z\",\n    \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3\",\n    \"html_url\": \"https://github.com/octocat/hello-world/code-scanning/3\",\n    \"state\": \"dismissed\",\n    \"dismissed_by\": {\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    \"dismissed_at\": \"2020-02-14T12:29:18Z\",\n    \"dismissed_reason\": \"false positive\",\n    \"rule\": {\n      \"id\": \"js/zipslip\",\n      \"severity\": \"error\",\n      \"description\": \"Arbitrary file write during zip extraction\",\n      \"name\": \"js/zipslip\"\n    },\n    \"tool\": {\n      \"name\": \"CodeQL\",\n      \"guid\": null,\n      \"version\": \"2.4.0\"\n    },\n    \"most_recent_instance\": {\n      \"ref\": \"refs/heads/main\",\n      \"analysis_key\": \".github/workflows/codeql-analysis.yml:CodeQL-Build\",\n      \"environment\": \"{}\",\n      \"state\": \"open\",\n      \"commit_sha\": \"39406e42cb832f683daa691dd652a8dc36ee8930\",\n      \"message\": {\n        \"text\": \"This path depends on a user-provided value.\"\n      },\n      \"location\": {\n        \"path\": \"lib/ab12-gen.js\",\n        \"start_line\": 917,\n        \"end_line\": 917,\n        \"start_column\": 7,\n        \"end_column\": 18\n      },\n      \"classifications\": []\n    },\n    \"instances_url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances\"\n  }\n]\n
    " + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Response if git hub advanced security is not enabled for this repository" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "503", + "httpStatusMessage": "Service Unavailable", + "description": "Service unavailable" + } + ] + }, + { + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "alert_number", + "in": "path", + "description": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation.", + "required": true, + "schema": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true, + "nullable": false + }, + "descriptionHTML": "

    The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the number field in the response from the GET /repos/{owner}/{repo}/code-scanning/alerts operation.

    " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/code-scanning/alerts/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/code-scanning/alerts/42
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}', {\n owner: 'octocat',\n repo: 'hello-world',\n alert_number: 42\n})", + "html": "
    await octokit.request('GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  alert_number: 42\n})\n
    " + } + ], + "summary": "Get a code scanning alert", + "description": "Gets a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` read permission to use this endpoint.\n\n**Deprecation notice**:\nThe instances field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The same information can now be retrieved via a GET request to the URL specified by `instances_url`.", + "tags": [ + "code-scanning" + ], + "operationId": "code-scanning/get-alert", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/code-scanning#get-a-code-scanning-alert" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "code-scanning", + "subcategory": null + }, + "slug": "get-a-code-scanning-alert", + "category": "code-scanning", + "categoryLabel": "Code scanning", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

    Gets a single code scanning alert. You must use an access token with the security_events scope to use this endpoint. GitHub Apps must have the security_events read permission to use this endpoint.

    \n

    Deprecation notice:\nThe instances field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The same information can now be retrieved via a GET request to the URL specified by instances_url.

    ", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
    {\n  \"number\": 42,\n  \"created_at\": \"2020-06-19T11:21:34Z\",\n  \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42\",\n  \"html_url\": \"https://github.com/octocat/hello-world/code-scanning/42\",\n  \"state\": \"dismissed\",\n  \"dismissed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 54933897,\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  \"dismissed_at\": \"2020-02-14T12:29:18Z\",\n  \"dismissed_reason\": \"false positive\",\n  \"rule\": {\n    \"id\": \"js/zipslip\",\n    \"severity\": \"error\",\n    \"description\": \"Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\",\n    \"name\": \"js/zipslip\",\n    \"full_description\": \"Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.\",\n    \"tags\": [\n      \"security\",\n      \"external/cwe/cwe-022\"\n    ],\n    \"help\": \"# Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\\\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...\"\n  },\n  \"tool\": {\n    \"name\": \"CodeQL\",\n    \"guid\": null,\n    \"version\": \"2.4.0\"\n  },\n  \"most_recent_instance\": {\n    \"ref\": \"refs/heads/main\",\n    \"analysis_key\": \".github/workflows/codeql-analysis.yml:CodeQL-Build\",\n    \"environment\": \"{}\",\n    \"state\": \"dismissed\",\n    \"commit_sha\": \"39406e42cb832f683daa691dd652a8dc36ee8930\",\n    \"message\": {\n      \"text\": \"This path depends on a user-provided value.\"\n    },\n    \"location\": {\n      \"path\": \"spec-main/api-session-spec.ts\",\n      \"start_line\": 917,\n      \"end_line\": 917,\n      \"start_column\": 7,\n      \"end_column\": 18\n    },\n    \"classifications\": [\n      \"test\"\n    ]\n  },\n  \"instances_url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances\"\n}\n
    " + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Response if git hub advanced security is not enabled for this repository" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "503", + "httpStatusMessage": "Service Unavailable", + "description": "Service unavailable" + } + ] + }, + { + "verb": "patch", + "requestPath": "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "alert_number", + "in": "path", + "description": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation.", + "required": true, + "schema": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true, + "nullable": false + }, + "descriptionHTML": "

    The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the number field in the response from the GET /repos/{owner}/{repo}/code-scanning/alerts operation.

    " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/code-scanning/alerts/42 \\\n -d '{\"state\":\"state\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/code-scanning/alerts/42 \\\n  -d '{\"state\":\"state\"}'
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('PATCH /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}', {\n owner: 'octocat',\n repo: 'hello-world',\n alert_number: 42,\n state: 'state'\n})", + "html": "
    await octokit.request('PATCH /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  alert_number: 42,\n  state: 'state'\n})\n
    " + } + ], + "summary": "Update a code scanning alert", + "description": "Updates the status of a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint.", + "operationId": "code-scanning/update-alert", + "tags": [ + "code-scanning" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/code-scanning#update-a-code-scanning-alert" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "state": { + "description": "

    Required. Sets the state of the code scanning alert. Can be one of open or dismissed. You must provide dismissed_reason when you set the state to dismissed.

    ", + "type": "string", + "enum": [ + "open", + "dismissed" + ], + "name": "state", + "in": "body", + "rawType": "string", + "rawDescription": "Sets the state of the code scanning alert. Can be one of `open` or `dismissed`. You must provide `dismissed_reason` when you set the state to `dismissed`.", + "childParamsGroups": [] + }, + "dismissed_reason": { + "type": "string or null", + "description": "

    Required when the state is dismissed. The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.

    ", + "nullable": true, + "oneOf": [ + { + "enum": [ + "false positive", + "won't fix", + "used in tests" + ] + }, + { + "enum": [ + null + ] + } + ], + "name": "dismissed_reason", + "in": "body", + "rawType": "string", + "rawDescription": "**Required when the state is dismissed.** The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "childParamsGroups": [] + } + }, + "required": [ + "state" + ] + }, + "example": { + "state": "dismissed", + "dismissed_reason": "false positive" + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [], + "category": "code-scanning" + }, + "slug": "update-a-code-scanning-alert", + "category": "code-scanning", + "categoryLabel": "Code scanning", + "notes": [], + "descriptionHTML": "

    Updates the status of a single code scanning alert. You must use an access token with the security_events scope to use this endpoint. GitHub Apps must have the security_events write permission to use this endpoint.

    ", + "bodyParameters": [ + { + "description": "

    Required. Sets the state of the code scanning alert. Can be one of open or dismissed. You must provide dismissed_reason when you set the state to dismissed.

    ", + "type": "string", + "enum": [ + "open", + "dismissed" + ], + "name": "state", + "in": "body", + "rawType": "string", + "rawDescription": "Sets the state of the code scanning alert. Can be one of `open` or `dismissed`. You must provide `dismissed_reason` when you set the state to `dismissed`.", + "childParamsGroups": [] + }, + { + "type": "string or null", + "description": "

    Required when the state is dismissed. The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.

    ", + "nullable": true, + "oneOf": [ + { + "enum": [ + "false positive", + "won't fix", + "used in tests" + ] + }, + { + "enum": [ + null + ] + } + ], + "name": "dismissed_reason", + "in": "body", + "rawType": "string", + "rawDescription": "**Required when the state is dismissed.** The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "childParamsGroups": [] + } + ], + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
    {\n  \"number\": 42,\n  \"created_at\": \"2020-08-25T21:28:36Z\",\n  \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42\",\n  \"html_url\": \"https://github.com/octocat/hello-world/code-scanning/42\",\n  \"state\": \"dismissed\",\n  \"dismissed_by\": {\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  \"dismissed_at\": \"2020-09-02T22:34:56Z\",\n  \"dismissed_reason\": \"false positive\",\n  \"rule\": {\n    \"id\": \"js/zipslip\",\n    \"severity\": \"error\",\n    \"description\": \"Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\",\n    \"name\": \"js/zipslip\",\n    \"full_description\": \"Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.\",\n    \"tags\": [\n      \"security\",\n      \"external/cwe/cwe-022\"\n    ],\n    \"help\": \"# Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\\\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...\"\n  },\n  \"tool\": {\n    \"name\": \"CodeQL\",\n    \"guid\": null,\n    \"version\": \"2.4.0\"\n  },\n  \"most_recent_instance\": {\n    \"ref\": \"refs/heads/main\",\n    \"analysis_key\": \".github/workflows/codeql-analysis.yml:CodeQL-Build\",\n    \"environment\": \"{}\",\n    \"state\": \"dismissed\",\n    \"commit_sha\": \"39406e42cb832f683daa691dd652a8dc36ee8930\",\n    \"message\": {\n      \"text\": \"This path depends on a user-provided value.\"\n    },\n    \"location\": {\n      \"path\": \"spec-main/api-session-spec.ts\",\n      \"start_line\": 917,\n      \"end_line\": 917,\n      \"start_column\": 7,\n      \"end_column\": 18\n    },\n    \"classifications\": [\n      \"test\"\n    ]\n  },\n  \"instances_url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances\"\n}\n
    " + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Response if the repository is archived or if github advanced security is not enabled for this repository" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "503", + "httpStatusMessage": "Service Unavailable", + "description": "Service unavailable" + } + ] + }, + { + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "alert_number", + "in": "path", + "description": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation.", + "required": true, + "schema": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true, + "nullable": false + }, + "descriptionHTML": "

    The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the number field in the response from the GET /repos/{owner}/{repo}/code-scanning/alerts operation.

    " + }, + { + "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.

    " + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "descriptionHTML": "

    Results per page (max 100).

    " + }, + { + "name": "ref", + "description": "The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." + }, + "descriptionHTML": "

    The Git reference for the results you want to list. The ref for a branch can be formatted either as refs/heads/<branch name> or simply <branch name>. To reference a pull request use refs/pull/<number>/merge.

    " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/code-scanning/alerts/42/instances", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/code-scanning/alerts/42/instances
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances', {\n owner: 'octocat',\n repo: 'hello-world',\n alert_number: 42\n})", + "html": "
    await octokit.request('GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  alert_number: 42\n})\n
    " + } + ], + "summary": "List instances of a code scanning alert", + "description": "Lists all instances of the specified code scanning alert. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` read permission to use this endpoint.", + "tags": [ + "code-scanning" + ], + "operationId": "code-scanning/list-alerts-instances", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/code-scanning#list-instances-of-a-code-scanning-alert" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "code-scanning", + "subcategory": null + }, + "slug": "list-instances-of-a-code-scanning-alert", + "category": "code-scanning", + "categoryLabel": "Code scanning", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

    Lists all instances of the specified code scanning alert. You must use an access token with the security_events scope to use this endpoint. GitHub Apps must have the security_events read permission to use this endpoint.

    ", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
    [\n  {\n    \"ref\": \"refs/heads/main\",\n    \"analysis_key\": \".github/workflows/codeql-analysis.yml:CodeQL-Build\",\n    \"environment\": \"\",\n    \"state\": \"open\",\n    \"commit_sha\": \"39406e42cb832f683daa691dd652a8dc36ee8930\",\n    \"message\": {\n      \"text\": \"This path depends on a user-provided value.\"\n    },\n    \"location\": {\n      \"path\": \"lib/ab12-gen.js\",\n      \"start_line\": 917,\n      \"end_line\": 917,\n      \"start_column\": 7,\n      \"end_column\": 18\n    },\n    \"classifications\": [\n      \"library\"\n    ]\n  },\n  {\n    \"ref\": \"refs/pull/3740/merge\",\n    \"analysis_key\": \".github/workflows/codeql-analysis.yml:CodeQL-Build\",\n    \"environment\": \"\",\n    \"state\": \"fixed\",\n    \"commit_sha\": \"b09da05606e27f463a2b49287684b4ae777092f2\",\n    \"message\": {\n      \"text\": \"This suffix check is missing a length comparison to correctly handle lastIndexOf returning -1.\"\n    },\n    \"location\": {\n      \"path\": \"app/script.js\",\n      \"start_line\": 2,\n      \"end_line\": 2,\n      \"start_column\": 10,\n      \"end_column\": 50\n    },\n    \"classifications\": [\n      \"source\"\n    ]\n  }\n]\n
    " + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Response if git hub advanced security is not enabled for this repository" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "503", + "httpStatusMessage": "Service Unavailable", + "description": "Service unavailable" + } + ] + }, + { + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/code-scanning/analyses", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "tool_name", + "description": "The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "description": "The name of the tool used to generate the code scanning analysis." + }, + "descriptionHTML": "

    The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either tool_name or tool_guid, but not both.

    " + }, + { + "name": "tool_guid", + "description": "The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both.", + "in": "query", + "required": false, + "schema": { + "nullable": true, + "type": "string", + "description": "The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data." + }, + "descriptionHTML": "

    The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either tool_guid or tool_name, but not both.

    " + }, + { + "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.

    " + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "descriptionHTML": "

    Results per page (max 100).

    " + }, + { + "name": "ref", + "in": "query", + "description": "The Git reference for the analyses you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`.", + "required": false, + "schema": { + "type": "string", + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." + }, + "descriptionHTML": "

    The Git reference for the analyses you want to list. The ref for a branch can be formatted either as refs/heads/<branch name> or simply <branch name>. To reference a pull request use refs/pull/<number>/merge.

    " + }, + { + "name": "sarif_id", + "in": "query", + "description": "Filter analyses belonging to the same SARIF upload.", + "required": false, + "schema": { + "type": "string", + "description": "An identifier for the upload.", + "example": "6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53", + "nullable": false + }, + "descriptionHTML": "

    Filter analyses belonging to the same SARIF upload.

    " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/code-scanning/analyses", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/code-scanning/analyses
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /repos/{owner}/{repo}/code-scanning/analyses', {\n owner: 'octocat',\n repo: 'hello-world'\n})", + "html": "
    await octokit.request('GET /repos/{owner}/{repo}/code-scanning/analyses', {\n  owner: 'octocat',\n  repo: 'hello-world'\n})\n
    " + } + ], + "summary": "List code scanning analyses for a repository", + "description": "Lists the details of all code scanning analyses for a repository,\nstarting with the most recent.\nThe response is paginated and you can use the `page` and `per_page` parameters\nto list the analyses you're interested in.\nBy default 30 analyses are listed per page.\n\nThe `rules_count` field in the response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand `0` is returned in this field.\n\nYou must use an access token with the `security_events` scope to use this endpoint.\nGitHub Apps must have the `security_events` read permission to use this endpoint.\n\n**Deprecation notice**:\nThe `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field.", + "operationId": "code-scanning/list-recent-analyses", + "tags": [ + "code-scanning" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/code-scanning#list-code-scanning-analyses-for-a-repository" + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [], + "category": "code-scanning" + }, + "slug": "list-code-scanning-analyses-for-a-repository", + "category": "code-scanning", + "categoryLabel": "Code scanning", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

    Lists the details of all code scanning analyses for a repository,\nstarting with the most recent.\nThe response is paginated and you can use the page and per_page parameters\nto list the analyses you're interested in.\nBy default 30 analyses are listed per page.

    \n

    The rules_count field in the response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand 0 is returned in this field.

    \n

    You must use an access token with the security_events scope to use this endpoint.\nGitHub Apps must have the security_events read permission to use this endpoint.

    \n

    Deprecation notice:\nThe tool_name field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the tool field.

    ", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
    [\n  {\n    \"ref\": \"refs/heads/main\",\n    \"commit_sha\": \"d99612c3e1f2970085cfbaeadf8f010ef69bad83\",\n    \"analysis_key\": \".github/workflows/codeql-analysis.yml:analyze\",\n    \"environment\": \"{\\\"language\\\":\\\"python\\\"}\",\n    \"error\": \"\",\n    \"created_at\": \"2020-08-27T15:05:21Z\",\n    \"results_count\": 17,\n    \"rules_count\": 49,\n    \"id\": 201,\n    \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/201\",\n    \"sarif_id\": \"6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53\",\n    \"tool\": {\n      \"name\": \"CodeQL\",\n      \"guid\": null,\n      \"version\": \"2.4.0\"\n    },\n    \"deletable\": true\n  },\n  {\n    \"ref\": \"refs/heads/my-branch\",\n    \"commit_sha\": \"c8cff6510d4d084fb1b4aa13b64b97ca12b07321\",\n    \"analysis_key\": \".github/workflows/shiftleft.yml:build\",\n    \"environment\": \"{}\",\n    \"error\": \"\",\n    \"created_at\": \"2020-08-31T22:46:44Z\",\n    \"results_count\": 17,\n    \"rules_count\": 32,\n    \"id\": 200,\n    \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/200\",\n    \"sarif_id\": \"8981cd8e-b078-4ac3-a3be-1dad7dbd0b582\",\n    \"tool\": {\n      \"name\": \"Python Security Analysis\",\n      \"guid\": null,\n      \"version\": \"1.2.0\"\n    },\n    \"deletable\": true\n  }\n]\n
    " + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Response if git hub advanced security is not enabled for this repository" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "503", + "httpStatusMessage": "Service Unavailable", + "description": "Service unavailable" + } + ] + }, + { + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "analysis_id", + "in": "path", + "description": "The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` operation.", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

    The ID of the analysis, as returned from the GET /repos/{owner}/{repo}/code-scanning/analyses operation.

    " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/code-scanning/analyses/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/code-scanning/analyses/42
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n analysis_id: 42\n})", + "html": "
    await octokit.request('GET /repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  analysis_id: 42\n})\n
    " + } + ], + "summary": "Get a code scanning analysis for a repository", + "description": "Gets a specified code scanning analysis for a repository.\nYou must use an access token with the `security_events` scope to use this endpoint.\nGitHub Apps must have the `security_events` read permission to use this endpoint.\n\nThe default JSON response contains fields that describe the analysis.\nThis includes the Git reference and commit SHA to which the analysis relates,\nthe datetime of the analysis, the name of the code scanning tool,\nand the number of alerts.\n\nThe `rules_count` field in the default response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand `0` is returned in this field.\n\nIf you use the Accept header `application/sarif+json`,\nthe response contains the analysis data that was uploaded.\nThis is formatted as\n[SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html).\nFor an example response, see \"[Custom media type for code scanning](#custom-media-type-for-code-scanning).\"\n\n**Deprecation notice**:\nThe `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field.", + "operationId": "code-scanning/get-analysis", + "tags": [ + "code-scanning" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/code-scanning#get-a-code-scanning-analysis-for-a-repository" + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [], + "category": "code-scanning" + }, + "slug": "get-a-code-scanning-analysis-for-a-repository", + "category": "code-scanning", + "categoryLabel": "Code scanning", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

    Gets a specified code scanning analysis for a repository.\nYou must use an access token with the security_events scope to use this endpoint.\nGitHub Apps must have the security_events read permission to use this endpoint.

    \n

    The default JSON response contains fields that describe the analysis.\nThis includes the Git reference and commit SHA to which the analysis relates,\nthe datetime of the analysis, the name of the code scanning tool,\nand the number of alerts.

    \n

    The rules_count field in the default response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand 0 is returned in this field.

    \n

    If you use the Accept header application/sarif+json,\nthe response contains the analysis data that was uploaded.\nThis is formatted as\nSARIF version 2.1.0.\nFor an example response, see \"Custom media type for code scanning.\"

    \n

    Deprecation notice:\nThe tool_name field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the tool field.

    ", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
    {\n  \"ref\": \"refs/heads/main\",\n  \"commit_sha\": \"c18c69115654ff0166991962832dc2bd7756e655\",\n  \"analysis_key\": \".github/workflows/codeql-analysis.yml:analyze\",\n  \"environment\": \"{\\\"language\\\":\\\"javascript\\\"}\",\n  \"error\": \"\",\n  \"created_at\": \"2021-01-13T11:55:49Z\",\n  \"results_count\": 3,\n  \"rules_count\": 67,\n  \"id\": 3602840,\n  \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/201\",\n  \"sarif_id\": \"47177e22-5596-11eb-80a1-c1e54ef945c6\",\n  \"tool\": {\n    \"name\": \"CodeQL\",\n    \"guid\": null,\n    \"version\": \"2.4.0\"\n  },\n  \"deletable\": true\n}\n
    " + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Response if git hub advanced security is not enabled for this repository" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "503", + "httpStatusMessage": "Service Unavailable", + "description": "Service unavailable" + } + ] + }, + { + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/code-scanning/sarifs", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/code-scanning/sarifs \\\n -d '{\"commit_sha\":\"commit_sha\",\"ref\":\"ref\",\"sarif\":\"sarif\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/code-scanning/sarifs \\\n  -d '{\"commit_sha\":\"commit_sha\",\"ref\":\"ref\",\"sarif\":\"sarif\"}'
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('POST /repos/{owner}/{repo}/code-scanning/sarifs', {\n owner: 'octocat',\n repo: 'hello-world',\n commit_sha: 'commit_sha',\n ref: 'ref',\n sarif: 'sarif'\n})", + "html": "
    await octokit.request('POST /repos/{owner}/{repo}/code-scanning/sarifs', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  commit_sha: 'commit_sha',\n  ref: 'ref',\n  sarif: 'sarif'\n})\n
    " + } + ], + "summary": "Upload an analysis as SARIF data", + "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint.\n\nThere are two places where you can upload code scanning results.\n - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see \"[Triaging code scanning alerts in pull requests](/github/finding-security-vulnerabilities-and-errors-in-your-code/triaging-code-scanning-alerts-in-pull-requests).\"\n - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see \"[Managing code scanning alerts for your repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository).\"\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64\n```\n\nSARIF upload supports a maximum of 1000 results per analysis run. Any results over this limit are ignored. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.\n\nThe `202 Accepted`, response includes an `id` value.\nYou can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload).\"", + "operationId": "code-scanning/upload-sarif", + "tags": [ + "code-scanning" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/code-scanning#upload-an-analysis-as-sarif-data" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "commit_sha": { + "description": "

    Required. The SHA of the commit to which the analysis you are uploading relates.

    ", + "type": "string", + "minLength": 40, + "maxLength": 40, + "pattern": "^[0-9a-fA-F]+$", + "name": "commit_sha", + "in": "body", + "rawType": "string", + "rawDescription": "The SHA of the commit to which the analysis you are uploading relates.", + "childParamsGroups": [] + }, + "ref": { + "type": "string", + "description": "

    Required. The full Git reference, formatted as refs/heads/<branch name>,\nrefs/pull/<number>/merge, or refs/pull/<number>/head.

    ", + "name": "ref", + "in": "body", + "rawType": "string", + "rawDescription": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`.", + "childParamsGroups": [] + }, + "sarif": { + "description": "

    Required. A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using gzip and then translate the contents of the file into a Base64 encoding string. For more information, see \"SARIF support for code scanning.\"

    ", + "type": "string", + "name": "sarif", + "in": "body", + "rawType": "string", + "rawDescription": "A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using [`gzip`](http://www.gnu.org/software/gzip/manual/gzip.html) and then translate the contents of the file into a Base64 encoding string. For more information, see \"[SARIF support for code scanning](https://docs.github.com/github-ae@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/sarif-support-for-code-scanning).\"", + "childParamsGroups": [] + }, + "checkout_uri": { + "description": "

    The base directory used in the analysis, as it appears in the SARIF file.\nThis property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository.

    ", + "example": "file:///github/workspace/", + "type": "string", + "format": "uri", + "name": "checkout_uri", + "in": "body", + "rawType": "string", + "rawDescription": "The base directory used in the analysis, as it appears in the SARIF file.\nThis property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository.", + "childParamsGroups": [] + }, + "started_at": { + "description": "

    The time that the analysis run began. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", + "format": "date", + "type": "string", + "name": "started_at", + "in": "body", + "rawType": "string", + "rawDescription": "The time that the analysis run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "childParamsGroups": [] + }, + "tool_name": { + "description": "

    The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to \"API\". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the tool_guid parameter of operations such as GET /repos/{owner}/{repo}/code-scanning/alerts.

    ", + "type": "string", + "name": "tool_name", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to \"API\". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the `tool_guid` parameter of operations such as `GET /repos/{owner}/{repo}/code-scanning/alerts`.", + "childParamsGroups": [] + } + }, + "required": [ + "commit_sha", + "ref", + "sarif" + ] + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [], + "category": "code-scanning" + }, + "slug": "upload-an-analysis-as-sarif-data", + "category": "code-scanning", + "categoryLabel": "Code scanning", + "notes": [], + "descriptionHTML": "

    Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the security_events scope to use this endpoint. GitHub Apps must have the security_events write permission to use this endpoint.

    \n

    There are two places where you can upload code scanning results.

    \n\n

    You must compress the SARIF-formatted analysis data that you want to upload, using gzip, and then encode it as a Base64 format string. For example:

    \n
    gzip -c analysis-data.sarif | base64\n
    \n

    SARIF upload supports a maximum of 1000 results per analysis run. Any results over this limit are ignored. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.

    \n

    The 202 Accepted, response includes an id value.\nYou can use this ID to check the status of the upload by using this for the /sarifs/{sarif_id} endpoint.\nFor more information, see \"Get information about a SARIF upload.\"

    ", + "bodyParameters": [ + { + "description": "

    Required. The SHA of the commit to which the analysis you are uploading relates.

    ", + "type": "string", + "minLength": 40, + "maxLength": 40, + "pattern": "^[0-9a-fA-F]+$", + "name": "commit_sha", + "in": "body", + "rawType": "string", + "rawDescription": "The SHA of the commit to which the analysis you are uploading relates.", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

    Required. The full Git reference, formatted as refs/heads/<branch name>,\nrefs/pull/<number>/merge, or refs/pull/<number>/head.

    ", + "name": "ref", + "in": "body", + "rawType": "string", + "rawDescription": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`.", + "childParamsGroups": [] + }, + { + "description": "

    Required. A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using gzip and then translate the contents of the file into a Base64 encoding string. For more information, see \"SARIF support for code scanning.\"

    ", + "type": "string", + "name": "sarif", + "in": "body", + "rawType": "string", + "rawDescription": "A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using [`gzip`](http://www.gnu.org/software/gzip/manual/gzip.html) and then translate the contents of the file into a Base64 encoding string. For more information, see \"[SARIF support for code scanning](https://docs.github.com/github-ae@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/sarif-support-for-code-scanning).\"", + "childParamsGroups": [] + }, + { + "description": "

    The base directory used in the analysis, as it appears in the SARIF file.\nThis property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository.

    ", + "example": "file:///github/workspace/", + "type": "string", + "format": "uri", + "name": "checkout_uri", + "in": "body", + "rawType": "string", + "rawDescription": "The base directory used in the analysis, as it appears in the SARIF file.\nThis property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository.", + "childParamsGroups": [] + }, + { + "description": "

    The time that the analysis run began. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", + "format": "date", + "type": "string", + "name": "started_at", + "in": "body", + "rawType": "string", + "rawDescription": "The time that the analysis run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "childParamsGroups": [] + }, + { + "description": "

    The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to \"API\". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the tool_guid parameter of operations such as GET /repos/{owner}/{repo}/code-scanning/alerts.

    ", + "type": "string", + "name": "tool_name", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to \"API\". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the `tool_guid` parameter of operations such as `GET /repos/{owner}/{repo}/code-scanning/alerts`.", + "childParamsGroups": [] + } + ], + "responses": [ + { + "httpStatusCode": "202", + "httpStatusMessage": "Accepted", + "description": "Default response", + "payload": "
    {\n  \"id\": \"47177e22-5596-11eb-80a1-c1e54ef945c6\",\n  \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/sarifs/47177e22-5596-11eb-80a1-c1e54ef945c6\"\n}\n
    " + }, + { + "httpStatusCode": "400", + "httpStatusMessage": "Bad Request", + "description": "Response if the sarif field is invalid" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Response if the repository is archived or if github advanced security is not enabled for this repository" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "413", + "httpStatusMessage": "Payload Too Large", + "description": "Response if the sarif field is too large" + }, + { + "httpStatusCode": "503", + "httpStatusMessage": "Service Unavailable", + "description": "Service unavailable" + } + ] + }, + { + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "sarif_id", + "description": "The SARIF ID obtained after uploading.", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "descriptionHTML": "

    The SARIF ID obtained after uploading.

    " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/code-scanning/sarifs/SARIF_ID", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/code-scanning/sarifs/SARIF_ID
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n sarif_id: 'sarif_id'\n})", + "html": "
    await octokit.request('GET /repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  sarif_id: 'sarif_id'\n})\n
    " + } + ], + "summary": "Get information about a SARIF upload", + "description": "Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see \"[Get a code scanning analysis for a repository](/rest/reference/code-scanning#get-a-code-scanning-analysis-for-a-repository).\" You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` read permission to use this endpoint.", + "operationId": "code-scanning/get-sarif", + "tags": [ + "code-scanning" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/code-scanning#get-information-about-a-sarif-upload" + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [], + "category": "code-scanning" + }, + "slug": "get-information-about-a-sarif-upload", + "category": "code-scanning", + "categoryLabel": "Code scanning", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

    Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see \"Get a code scanning analysis for a repository.\" You must use an access token with the security_events scope to use this endpoint. GitHub Apps must have the security_events read permission to use this endpoint.

    ", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
    {\n  \"processing_status\": \"complete\",\n  \"analyses_url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses?sarif_id=47177e22-5596-11eb-80a1-c1e54ef945c6\"\n}\n
    " + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Response if git hub advanced security is not enabled for this repository" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Response if the sarif id does not match any upload" + }, + { + "httpStatusCode": "503", + "httpStatusMessage": "Service Unavailable", + "description": "Service unavailable" + } + ] + }, { "verb": "get", "requestPath": "/repos/{owner}/{repo}/collaborators", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -31481,8 +40115,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/collaborators", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/collaborators
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/collaborators", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/collaborators
    " }, { "lang": "JavaScript", @@ -31532,7 +40166,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -31565,8 +40199,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/collaborators/USERNAME", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/collaborators/USERNAME
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/collaborators/USERNAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/collaborators/USERNAME
    " }, { "lang": "JavaScript", @@ -31615,7 +40249,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -31648,8 +40282,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/collaborators/USERNAME \\\n -d '{\"permission\":\"permission\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/collaborators/USERNAME \\\n  -d '{\"permission\":\"permission\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/collaborators/USERNAME \\\n -d '{\"permission\":\"permission\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/collaborators/USERNAME \\\n  -d '{\"permission\":\"permission\"}'
    " }, { "lang": "JavaScript", @@ -31774,7 +40408,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -31807,8 +40441,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/collaborators/USERNAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/collaborators/USERNAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/collaborators/USERNAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/collaborators/USERNAME
    " }, { "lang": "JavaScript", @@ -31843,7 +40477,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -31852,7 +40486,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/collaborators/{username}/permission", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -31885,8 +40519,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/collaborators/USERNAME/permission", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/collaborators/USERNAME/permission
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/collaborators/USERNAME/permission", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/collaborators/USERNAME/permission
    " }, { "lang": "JavaScript", @@ -31936,7 +40570,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -31980,8 +40614,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/comments", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/comments
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/comments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/comments
    " }, { "lang": "JavaScript", @@ -32033,7 +40667,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -32067,8 +40701,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/comments/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/comments/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/comments/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/comments/42
    " }, { "lang": "JavaScript", @@ -32125,7 +40759,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -32159,8 +40793,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/comments/42 \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/comments/42 \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/comments/42 \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/comments/42 \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -32246,7 +40880,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -32280,8 +40914,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/comments/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/comments/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/comments/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/comments/42
    " }, { "lang": "JavaScript", @@ -32316,7 +40950,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -32330,7 +40964,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -32404,8 +41038,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/comments/42/reactions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/comments/42/reactions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/comments/42/reactions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/comments/42/reactions
    " }, { "lang": "JavaScript", @@ -32465,7 +41099,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -32499,8 +41133,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/comments/42/reactions \\\n -d '{\"content\":\"content\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/comments/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/comments/42/reactions \\\n -d '{\"content\":\"content\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/comments/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " }, { "lang": "JavaScript", @@ -32622,7 +41256,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -32665,8 +41299,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/comments/42/reactions/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/comments/42/reactions/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/comments/42/reactions/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/comments/42/reactions/42
    " }, { "lang": "JavaScript", @@ -32706,7 +41340,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -32715,7 +41349,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/commits", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -32804,13 +41438,35 @@ "default": 1 }, "descriptionHTML": "

    Page number of the results to fetch.

    " + }, + { + "name": "top", + "description": "legacy parameter for pagination.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    legacy parameter for pagination.

    " + }, + { + "name": "last_sha", + "description": "legacy parameter for pagination.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    legacy parameter for pagination.

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/commits
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/commits", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/commits
    " }, { "lang": "JavaScript", @@ -32875,7 +41531,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -32910,8 +41566,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.groot-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits/COMMIT_SHA/branches-where-head", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.groot-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/commits/COMMIT_SHA/branches-where-head
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.groot-preview+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/commits/COMMIT_SHA/branches-where-head", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.groot-preview+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/commits/COMMIT_SHA/branches-where-head
    " }, { "lang": "JavaScript", @@ -32973,7 +41629,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -33028,8 +41684,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits/COMMIT_SHA/comments", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/commits/COMMIT_SHA/comments
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/commits/COMMIT_SHA/comments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/commits/COMMIT_SHA/comments
    " }, { "lang": "JavaScript", @@ -33081,7 +41737,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -33116,8 +41772,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits/COMMIT_SHA/comments \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/commits/COMMIT_SHA/comments \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/commits/COMMIT_SHA/comments \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/commits/COMMIT_SHA/comments \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -33266,7 +41922,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/pulls", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -33321,8 +41977,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.groot-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits/COMMIT_SHA/pulls", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.groot-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/commits/COMMIT_SHA/pulls
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.groot-preview+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/commits/COMMIT_SHA/pulls", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.groot-preview+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/commits/COMMIT_SHA/pulls
    " }, { "lang": "JavaScript", @@ -33379,7 +42035,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/commits/{ref}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -33399,23 +42055,43 @@ }, "descriptionHTML": "" }, + { + "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.

    " + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "descriptionHTML": "

    Results per page (max 100).

    " + }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    ref+ parameter

    " + "descriptionHTML": "

    ref parameter

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits/REF", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/commits/REF
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/commits/REF", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/commits/REF
    " }, { "lang": "JavaScript", @@ -33475,7 +42151,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/commits/{ref}/check-runs", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -33497,14 +42173,14 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    ref+ parameter

    " + "descriptionHTML": "

    ref parameter

    " }, { "name": "check_name", @@ -33565,13 +42241,22 @@ "default": 1 }, "descriptionHTML": "

    Page number of the results to fetch.

    " + }, + { + "name": "app_id", + "in": "query", + "required": false, + "schema": { + "type": "integer" + }, + "descriptionHTML": "" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits/REF/check-runs", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/commits/REF/check-runs
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/commits/REF/check-runs", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/commits/REF/check-runs
    " }, { "lang": "JavaScript", @@ -33616,7 +42301,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/commits/{ref}/check-suites", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -33638,14 +42323,14 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    ref+ parameter

    " + "descriptionHTML": "

    ref parameter

    " }, { "name": "app_id", @@ -33692,8 +42377,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits/REF/check-suites", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/commits/REF/check-suites
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/commits/REF/check-suites", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/commits/REF/check-suites
    " }, { "lang": "JavaScript", @@ -33738,7 +42423,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/commits/{ref}/status", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -33760,21 +42445,41 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    ref+ parameter

    " + "descriptionHTML": "

    ref parameter

    " + }, + { + "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/repos/octocat/hello-world/commits/REF/status", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/commits/REF/status
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/commits/REF/status", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/commits/REF/status
    " }, { "lang": "JavaScript", @@ -33824,7 +42529,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/commits/{ref}/statuses", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -33846,14 +42551,14 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    ref+ parameter

    " + "descriptionHTML": "

    ref parameter

    " }, { "name": "per_page", @@ -33879,8 +42584,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits/REF/statuses", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/commits/REF/statuses
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/commits/REF/statuses", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/commits/REF/statuses
    " }, { "lang": "JavaScript", @@ -33930,7 +42635,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/compare/{base}...{head}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -33972,8 +42677,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/compare/BASE...HEAD", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/compare/BASE...HEAD
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/compare/BASE...HEAD", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/compare/BASE...HEAD
    " }, { "lang": "JavaScript", @@ -34028,7 +42733,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/contents/{path}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -34050,14 +42755,14 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    path+ parameter

    " + "descriptionHTML": "

    path parameter

    " }, { "name": "ref", @@ -34073,8 +42778,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/contents/PATH", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/contents/PATH
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/contents/PATH", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/contents/PATH
    " }, { "lang": "JavaScript", @@ -34152,7 +42857,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/contents/{path}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -34174,21 +42879,21 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    path+ parameter

    " + "descriptionHTML": "

    path parameter

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/contents/PATH \\\n -d '{\"message\":\"message\",\"content\":\"content\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/contents/PATH \\\n  -d '{\"message\":\"message\",\"content\":\"content\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/contents/PATH \\\n -d '{\"message\":\"message\",\"content\":\"content\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/contents/PATH \\\n  -d '{\"message\":\"message\",\"content\":\"content\"}'
    " }, { "lang": "JavaScript", @@ -34675,7 +43380,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/contents/{path}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -34697,21 +43402,21 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    path+ parameter

    " + "descriptionHTML": "

    path parameter

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/contents/PATH \\\n -d '{\"message\":\"message\",\"sha\":\"sha\"}'", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/contents/PATH \\\n  -d '{\"message\":\"message\",\"sha\":\"sha\"}'
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/contents/PATH \\\n -d '{\"message\":\"message\",\"sha\":\"sha\"}'", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/contents/PATH \\\n  -d '{\"message\":\"message\",\"sha\":\"sha\"}'
    " }, { "lang": "JavaScript", @@ -35074,7 +43779,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/contributors", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -35128,8 +43833,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/contributors", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/contributors
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/contributors", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/contributors
    " }, { "lang": "JavaScript", @@ -35187,7 +43892,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/deployments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -35247,7 +43952,8 @@ "required": false, "schema": { "type": "string", - "default": "none" + "default": "none", + "nullable": true }, "descriptionHTML": "

    The name of the environment that was deployed to (e.g., staging or production).

    " }, @@ -35275,8 +43981,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/deployments", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/deployments
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/deployments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/deployments
    " }, { "lang": "JavaScript", @@ -35328,7 +44034,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/deployments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -35352,8 +44058,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/deployments \\\n -d '{\"ref\":\"ref\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/deployments \\\n  -d '{\"ref\":\"ref\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/deployments \\\n -d '{\"ref\":\"ref\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/deployments \\\n  -d '{\"ref\":\"ref\"}'
    " }, { "lang": "JavaScript", @@ -35652,12 +44358,6 @@ "description": "Simple example", "payload": "
    {\n  \"url\": \"https://api.github.com/repos/octocat/example/deployments/1\",\n  \"id\": 1,\n  \"node_id\": \"MDEwOkRlcGxveW1lbnQx\",\n  \"sha\": \"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\n  \"ref\": \"topic-branch\",\n  \"task\": \"deploy\",\n  \"payload\": {},\n  \"original_environment\": \"staging\",\n  \"environment\": \"production\",\n  \"description\": \"Deploy request from hubot\",\n  \"creator\": {\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  \"created_at\": \"2012-07-20T01:19:13Z\",\n  \"updated_at\": \"2012-07-20T01:19:13Z\",\n  \"statuses_url\": \"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/example\",\n  \"transient_environment\": false,\n  \"production_environment\": true\n}\n
    " }, - { - "httpStatusCode": "201", - "httpStatusMessage": "Created", - "description": "Advanced example", - "payload": "
    {\n  \"url\": \"https://api.github.com/repos/octocat/example/deployments/1\",\n  \"id\": 1,\n  \"node_id\": \"MDEwOkRlcGxveW1lbnQx\",\n  \"sha\": \"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\n  \"ref\": \"topic-branch\",\n  \"task\": \"deploy\",\n  \"payload\": {},\n  \"original_environment\": \"staging\",\n  \"environment\": \"production\",\n  \"description\": \"Deploy request from hubot\",\n  \"creator\": {\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  \"created_at\": \"2012-07-20T01:19:13Z\",\n  \"updated_at\": \"2012-07-20T01:19:13Z\",\n  \"statuses_url\": \"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/example\",\n  \"transient_environment\": false,\n  \"production_environment\": true\n}\n
    " - }, { "httpStatusCode": "202", "httpStatusMessage": "Accepted", @@ -35667,14 +44367,7 @@ { "httpStatusCode": "409", "httpStatusMessage": "Conflict", - "description": "Merge conflict response", - "payload": "
    {\n  \"message\": \"Conflict merging master into topic-branch\"\n}\n
    " - }, - { - "httpStatusCode": "409", - "httpStatusMessage": "Conflict", - "description": "Failed commit status checks", - "payload": "
    {\n  \"message\": \"Conflict: Commit status checks failed for topic-branch.\"\n}\n
    " + "description": "Response when there is a merge conflict or the commit s status checks failed" }, { "httpStatusCode": "422", @@ -35686,7 +44379,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -35720,8 +44413,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/deployments/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/deployments/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/deployments/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/deployments/42
    " }, { "lang": "JavaScript", @@ -35778,7 +44471,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -35812,8 +44505,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/deployments/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/deployments/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/deployments/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/deployments/42
    " }, { "lang": "JavaScript", @@ -35848,7 +44541,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -35867,7 +44560,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -35921,8 +44614,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/deployments/42/statuses", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/deployments/42/statuses
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/deployments/42/statuses", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/deployments/42/statuses
    " }, { "lang": "JavaScript", @@ -35985,7 +44678,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -36019,8 +44712,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/deployments/42/statuses \\\n -d '{\"state\":\"state\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/deployments/42/statuses \\\n  -d '{\"state\":\"state\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/deployments/42/statuses \\\n -d '{\"state\":\"state\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/deployments/42/statuses \\\n  -d '{\"state\":\"state\"}'
    " }, { "lang": "JavaScript", @@ -36266,7 +44959,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -36309,8 +45002,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/deployments/42/statuses/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/deployments/42/statuses/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/deployments/42/statuses/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/deployments/42/statuses/42
    " }, { "lang": "JavaScript", @@ -36375,10 +45068,620 @@ } ] }, + { + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/environments", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/environments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/environments
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /repos/{owner}/{repo}/environments', {\n owner: 'octocat',\n repo: 'hello-world'\n})", + "html": "
    await octokit.request('GET /repos/{owner}/{repo}/environments', {\n  owner: 'octocat',\n  repo: 'hello-world'\n})\n
    " + } + ], + "summary": "Get all environments", + "description": "Get all environments for a repository.\n\nAnyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "tags": [ + "repos" + ], + "operationId": "repos/get-all-environments", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/repos#get-all-environments" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "environments" + }, + "slug": "get-all-environments", + "category": "repos", + "categoryLabel": "Repos", + "subcategory": "environments", + "subcategoryLabel": "Environments", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

    Get all environments for a repository.

    \n

    Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.

    ", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
    {\n  \"total_count\": 1,\n  \"environments\": [\n    {\n      \"id\": 161088068,\n      \"node_id\": \"MDExOkVudmlyb25tZW50MTYxMDg4MDY4\",\n      \"name\": \"staging\",\n      \"url\": \"https://api.github.com/repos/github/hello-world/environments/staging\",\n      \"html_url\": \"https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging\",\n      \"created_at\": \"2020-11-23T22:00:40Z\",\n      \"updated_at\": \"2020-11-23T22:00:40Z\",\n      \"protection_rules\": [\n        {\n          \"id\": 3736,\n          \"node_id\": \"MDQ6R2F0ZTM3MzY=\",\n          \"type\": \"wait_timer\",\n          \"wait_timer\": 30\n        },\n        {\n          \"id\": 3755,\n          \"node_id\": \"MDQ6R2F0ZTM3NTU=\",\n          \"type\": \"required_reviewers\",\n          \"reviewers\": [\n            {\n              \"type\": \"User\",\n              \"reviewer\": {\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              \"type\": \"Team\",\n              \"reviewer\": {\n                \"id\": 1,\n                \"node_id\": \"MDQ6VGVhbTE=\",\n                \"url\": \"https://api.github.com/teams/1\",\n                \"html_url\": \"https://github.com/orgs/github/teams/justice-league\",\n                \"name\": \"Justice League\",\n                \"slug\": \"justice-league\",\n                \"description\": \"A great team.\",\n                \"privacy\": \"closed\",\n                \"permission\": \"admin\",\n                \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n                \"repositories_url\": \"https://api.github.com/teams/1/repos\"\n              }\n            }\n          ]\n        },\n        {\n          \"id\": 3756,\n          \"node_id\": \"MDQ6R2F0ZTM3NTY=\",\n          \"type\": \"branch_policy\"\n        }\n      ],\n      \"deployment_branch_policy\": {\n        \"protected_branches\": false,\n        \"custom_branch_policies\": true\n      }\n    }\n  ]\n}\n
    " + } + ] + }, + { + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "environment_name", + "in": "path", + "required": true, + "description": "The name of the environment", + "schema": { + "type": "string" + }, + "descriptionHTML": "

    The name of the environment

    " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/environments/ENVIRONMENT_NAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/environments/ENVIRONMENT_NAME
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /repos/{owner}/{repo}/environments/{environment_name}', {\n owner: 'octocat',\n repo: 'hello-world',\n environment_name: 'environment_name'\n})", + "html": "
    await octokit.request('GET /repos/{owner}/{repo}/environments/{environment_name}', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  environment_name: 'environment_name'\n})\n
    " + } + ], + "summary": "Get an environment", + "description": "Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "tags": [ + "repos" + ], + "operationId": "repos/get-environment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/repos#get-an-environment" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "environments" + }, + "slug": "get-an-environment", + "category": "repos", + "categoryLabel": "Repos", + "subcategory": "environments", + "subcategoryLabel": "Environments", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

    Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.

    ", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
    {\n  \"id\": 161088068,\n  \"node_id\": \"MDExOkVudmlyb25tZW50MTYxMDg4MDY4\",\n  \"name\": \"staging\",\n  \"url\": \"https://api.github.com/repos/github/hello-world/environments/staging\",\n  \"html_url\": \"https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging\",\n  \"created_at\": \"2020-11-23T22:00:40Z\",\n  \"updated_at\": \"2020-11-23T22:00:40Z\",\n  \"protection_rules\": [\n    {\n      \"id\": 3736,\n      \"node_id\": \"MDQ6R2F0ZTM3MzY=\",\n      \"type\": \"wait_timer\",\n      \"wait_timer\": 30\n    },\n    {\n      \"id\": 3755,\n      \"node_id\": \"MDQ6R2F0ZTM3NTU=\",\n      \"type\": \"required_reviewers\",\n      \"reviewers\": [\n        {\n          \"type\": \"User\",\n          \"reviewer\": {\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          \"type\": \"Team\",\n          \"reviewer\": {\n            \"id\": 1,\n            \"node_id\": \"MDQ6VGVhbTE=\",\n            \"url\": \"https://api.github.com/teams/1\",\n            \"html_url\": \"https://github.com/orgs/github/teams/justice-league\",\n            \"name\": \"Justice League\",\n            \"slug\": \"justice-league\",\n            \"description\": \"A great team.\",\n            \"privacy\": \"closed\",\n            \"permission\": \"admin\",\n            \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n            \"repositories_url\": \"https://api.github.com/teams/1/repos\"\n          }\n        }\n      ]\n    },\n    {\n      \"id\": 3756,\n      \"node_id\": \"MDQ6R2F0ZTM3NTY=\",\n      \"type\": \"branch_policy\"\n    }\n  ],\n  \"deployment_branch_policy\": {\n    \"protected_branches\": false,\n    \"custom_branch_policies\": true\n  }\n}\n
    " + } + ] + }, + { + "verb": "put", + "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "environment_name", + "in": "path", + "required": true, + "description": "The name of the environment", + "schema": { + "type": "string" + }, + "descriptionHTML": "

    The name of the environment

    " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/environments/ENVIRONMENT_NAME \\\n -d '{\"wait_timer\":42}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/environments/ENVIRONMENT_NAME \\\n  -d '{\"wait_timer\":42}'
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('PUT /repos/{owner}/{repo}/environments/{environment_name}', {\n owner: 'octocat',\n repo: 'hello-world',\n environment_name: 'environment_name',\n wait_timer: 42\n})", + "html": "
    await octokit.request('PUT /repos/{owner}/{repo}/environments/{environment_name}', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  environment_name: 'environment_name',\n  wait_timer: 42\n})\n
    " + } + ], + "summary": "Create or update an environment", + "description": "Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see \"[Environments](/actions/reference/environments#environment-protection-rules).\"\n\n**Note:** Although you can use this operation to specify that only branches that match specified name patterns can deploy to this environment, you must use the UI to set the name patterns. For more information, see \"[Environments](/actions/reference/environments#deployment-branches).\"\n\n**Note:** To create or update secrets for an environment, see \"[Secrets](/rest/reference/actions#secrets).\"\n\nYou must authenticate using an access token with the repo scope to use this endpoint.", + "tags": [ + "repos" + ], + "operationId": "repos/create-or-update-environment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/repos#create-or-update-an-environment" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "nullable": true, + "properties": { + "wait_timer": { + "type": "integer", + "example": 30, + "description": "

    The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days).

    ", + "name": "wait_timer", + "in": "body", + "rawType": "integer", + "rawDescription": "The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days).", + "childParamsGroups": [] + }, + "reviewers": { + "type": "array of objects or null", + "nullable": true, + "description": "

    The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.

    ", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "

    The type of reviewer. Must be one of: User or Team

    ", + "enum": [ + "User", + "Team" + ], + "example": "User", + "name": "type", + "in": "body", + "rawType": "string", + "rawDescription": "The type of reviewer. Must be one of: `User` or `Team`", + "childParamsGroups": [] + }, + "id": { + "type": "integer", + "description": "

    The id of the user or team who can review the deployment

    ", + "example": 4532992, + "name": "id", + "in": "body", + "rawType": "integer", + "rawDescription": "The id of the user or team who can review the deployment", + "childParamsGroups": [] + } + } + }, + "name": "reviewers", + "in": "body", + "rawType": "array", + "rawDescription": "The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.", + "childParamsGroups": [ + { + "parentName": "reviewers", + "parentType": "items", + "id": "reviewers-items", + "params": [ + { + "type": "string", + "description": "

    The type of reviewer. Must be one of: User or Team

    ", + "enum": [ + "User", + "Team" + ], + "example": "User", + "name": "type", + "in": "body", + "rawType": "string", + "rawDescription": "The type of reviewer. Must be one of: `User` or `Team`", + "childParamsGroups": [] + }, + { + "type": "integer", + "description": "

    The id of the user or team who can review the deployment

    ", + "example": 4532992, + "name": "id", + "in": "body", + "rawType": "integer", + "rawDescription": "The id of the user or team who can review the deployment", + "childParamsGroups": [] + } + ] + } + ] + }, + "deployment_branch_policy": { + "type": "object or null", + "description": "

    The type of deployment branch policy for this environment. To allow all branches to deploy, set to null.

    ", + "properties": { + "protected_branches": { + "type": "boolean", + "description": "

    Required. Whether only branches with branch protection rules can deploy to this environment. If protected_branches is true, custom_branch_policies must be false; if protected_branches is false, custom_branch_policies must be true.

    ", + "name": "protected_branches", + "in": "body", + "rawType": "boolean", + "rawDescription": "Whether only branches with branch protection rules can deploy to this environment. If `protected_branches` is `true`, `custom_branch_policies` must be `false`; if `protected_branches` is `false`, `custom_branch_policies` must be `true`.", + "childParamsGroups": [] + }, + "custom_branch_policies": { + "type": "boolean", + "description": "

    Required. Whether only branches that match the specified name patterns can deploy to this environment. If custom_branch_policies is true, protected_branches must be false; if custom_branch_policies is false, protected_branches must be true.

    ", + "name": "custom_branch_policies", + "in": "body", + "rawType": "boolean", + "rawDescription": "Whether only branches that match the specified name patterns can deploy to this environment. If `custom_branch_policies` is `true`, `protected_branches` must be `false`; if `custom_branch_policies` is `false`, `protected_branches` must be `true`.", + "childParamsGroups": [] + } + }, + "nullable": true, + "required": [ + "protected_branches", + "custom_branch_policies" + ], + "name": "deployment_branch_policy", + "in": "body", + "rawType": "object", + "rawDescription": "The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`.", + "childParamsGroups": [ + { + "parentName": "deployment_branch_policy", + "parentType": "object", + "id": "deployment_branch_policy-object", + "params": [ + { + "type": "boolean", + "description": "

    Required. Whether only branches with branch protection rules can deploy to this environment. If protected_branches is true, custom_branch_policies must be false; if protected_branches is false, custom_branch_policies must be true.

    ", + "name": "protected_branches", + "in": "body", + "rawType": "boolean", + "rawDescription": "Whether only branches with branch protection rules can deploy to this environment. If `protected_branches` is `true`, `custom_branch_policies` must be `false`; if `protected_branches` is `false`, `custom_branch_policies` must be `true`.", + "childParamsGroups": [] + }, + { + "type": "boolean", + "description": "

    Required. Whether only branches that match the specified name patterns can deploy to this environment. If custom_branch_policies is true, protected_branches must be false; if custom_branch_policies is false, protected_branches must be true.

    ", + "name": "custom_branch_policies", + "in": "body", + "rawType": "boolean", + "rawDescription": "Whether only branches that match the specified name patterns can deploy to this environment. If `custom_branch_policies` is `true`, `protected_branches` must be `false`; if `custom_branch_policies` is `false`, `protected_branches` must be `true`.", + "childParamsGroups": [] + } + ] + } + ] + } + }, + "additionalProperties": false + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "environments" + }, + "slug": "create-or-update-an-environment", + "category": "repos", + "categoryLabel": "Repos", + "subcategory": "environments", + "subcategoryLabel": "Environments", + "notes": [], + "descriptionHTML": "

    Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see \"Environments.\"

    \n

    Note: Although you can use this operation to specify that only branches that match specified name patterns can deploy to this environment, you must use the UI to set the name patterns. For more information, see \"Environments.\"

    \n

    Note: To create or update secrets for an environment, see \"Secrets.\"

    \n

    You must authenticate using an access token with the repo scope to use this endpoint.

    ", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
    {\n  \"id\": 161088068,\n  \"node_id\": \"MDExOkVudmlyb25tZW50MTYxMDg4MDY4\",\n  \"name\": \"staging\",\n  \"url\": \"https://api.github.com/repos/github/hello-world/environments/staging\",\n  \"html_url\": \"https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging\",\n  \"created_at\": \"2020-11-23T22:00:40Z\",\n  \"updated_at\": \"2020-11-23T22:00:40Z\",\n  \"protection_rules\": [\n    {\n      \"id\": 3736,\n      \"node_id\": \"MDQ6R2F0ZTM3MzY=\",\n      \"type\": \"wait_timer\",\n      \"wait_timer\": 30\n    },\n    {\n      \"id\": 3755,\n      \"node_id\": \"MDQ6R2F0ZTM3NTU=\",\n      \"type\": \"required_reviewers\",\n      \"reviewers\": [\n        {\n          \"type\": \"User\",\n          \"reviewer\": {\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          \"type\": \"Team\",\n          \"reviewer\": {\n            \"id\": 1,\n            \"node_id\": \"MDQ6VGVhbTE=\",\n            \"url\": \"https://api.github.com/teams/1\",\n            \"html_url\": \"https://github.com/orgs/github/teams/justice-league\",\n            \"name\": \"Justice League\",\n            \"slug\": \"justice-league\",\n            \"description\": \"A great team.\",\n            \"privacy\": \"closed\",\n            \"permission\": \"admin\",\n            \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n            \"repositories_url\": \"https://api.github.com/teams/1/repos\"\n          }\n        }\n      ]\n    },\n    {\n      \"id\": 3756,\n      \"node_id\": \"MDQ6R2F0ZTM3NTY=\",\n      \"type\": \"branch_policy\"\n    }\n  ],\n  \"deployment_branch_policy\": {\n    \"protected_branches\": false,\n    \"custom_branch_policies\": true\n  }\n}\n
    " + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation error when the environment name is invalid or when protected branches and custom branch policies in deployment branch policy are set to the same value" + } + ], + "bodyParameters": [ + { + "type": "integer", + "example": 30, + "description": "

    The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days).

    ", + "name": "wait_timer", + "in": "body", + "rawType": "integer", + "rawDescription": "The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days).", + "childParamsGroups": [] + }, + { + "type": "array of objects or null", + "nullable": true, + "description": "

    The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.

    ", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "

    The type of reviewer. Must be one of: User or Team

    ", + "enum": [ + "User", + "Team" + ], + "example": "User", + "name": "type", + "in": "body", + "rawType": "string", + "rawDescription": "The type of reviewer. Must be one of: `User` or `Team`", + "childParamsGroups": [] + }, + "id": { + "type": "integer", + "description": "

    The id of the user or team who can review the deployment

    ", + "example": 4532992, + "name": "id", + "in": "body", + "rawType": "integer", + "rawDescription": "The id of the user or team who can review the deployment", + "childParamsGroups": [] + } + } + }, + "name": "reviewers", + "in": "body", + "rawType": "array", + "rawDescription": "The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.", + "childParamsGroups": [ + { + "parentName": "reviewers", + "parentType": "items", + "id": "reviewers-items", + "params": [ + { + "type": "string", + "description": "

    The type of reviewer. Must be one of: User or Team

    ", + "enum": [ + "User", + "Team" + ], + "example": "User", + "name": "type", + "in": "body", + "rawType": "string", + "rawDescription": "The type of reviewer. Must be one of: `User` or `Team`", + "childParamsGroups": [] + }, + { + "type": "integer", + "description": "

    The id of the user or team who can review the deployment

    ", + "example": 4532992, + "name": "id", + "in": "body", + "rawType": "integer", + "rawDescription": "The id of the user or team who can review the deployment", + "childParamsGroups": [] + } + ] + } + ] + }, + { + "type": "object or null", + "description": "

    The type of deployment branch policy for this environment. To allow all branches to deploy, set to null.

    ", + "properties": { + "protected_branches": { + "type": "boolean", + "description": "

    Required. Whether only branches with branch protection rules can deploy to this environment. If protected_branches is true, custom_branch_policies must be false; if protected_branches is false, custom_branch_policies must be true.

    ", + "name": "protected_branches", + "in": "body", + "rawType": "boolean", + "rawDescription": "Whether only branches with branch protection rules can deploy to this environment. If `protected_branches` is `true`, `custom_branch_policies` must be `false`; if `protected_branches` is `false`, `custom_branch_policies` must be `true`.", + "childParamsGroups": [] + }, + "custom_branch_policies": { + "type": "boolean", + "description": "

    Required. Whether only branches that match the specified name patterns can deploy to this environment. If custom_branch_policies is true, protected_branches must be false; if custom_branch_policies is false, protected_branches must be true.

    ", + "name": "custom_branch_policies", + "in": "body", + "rawType": "boolean", + "rawDescription": "Whether only branches that match the specified name patterns can deploy to this environment. If `custom_branch_policies` is `true`, `protected_branches` must be `false`; if `custom_branch_policies` is `false`, `protected_branches` must be `true`.", + "childParamsGroups": [] + } + }, + "nullable": true, + "required": [ + "protected_branches", + "custom_branch_policies" + ], + "name": "deployment_branch_policy", + "in": "body", + "rawType": "object", + "rawDescription": "The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`.", + "childParamsGroups": [ + { + "parentName": "deployment_branch_policy", + "parentType": "object", + "id": "deployment_branch_policy-object", + "params": [ + { + "type": "boolean", + "description": "

    Required. Whether only branches with branch protection rules can deploy to this environment. If protected_branches is true, custom_branch_policies must be false; if protected_branches is false, custom_branch_policies must be true.

    ", + "name": "protected_branches", + "in": "body", + "rawType": "boolean", + "rawDescription": "Whether only branches with branch protection rules can deploy to this environment. If `protected_branches` is `true`, `custom_branch_policies` must be `false`; if `protected_branches` is `false`, `custom_branch_policies` must be `true`.", + "childParamsGroups": [] + }, + { + "type": "boolean", + "description": "

    Required. Whether only branches that match the specified name patterns can deploy to this environment. If custom_branch_policies is true, protected_branches must be false; if custom_branch_policies is false, protected_branches must be true.

    ", + "name": "custom_branch_policies", + "in": "body", + "rawType": "boolean", + "rawDescription": "Whether only branches that match the specified name patterns can deploy to this environment. If `custom_branch_policies` is `true`, `protected_branches` must be `false`; if `custom_branch_policies` is `false`, `protected_branches` must be `true`.", + "childParamsGroups": [] + } + ] + } + ] + } + ] + }, + { + "verb": "delete", + "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "environment_name", + "in": "path", + "required": true, + "description": "The name of the environment", + "schema": { + "type": "string" + }, + "descriptionHTML": "

    The name of the environment

    " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/environments/ENVIRONMENT_NAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/environments/ENVIRONMENT_NAME
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('DELETE /repos/{owner}/{repo}/environments/{environment_name}', {\n owner: 'octocat',\n repo: 'hello-world',\n environment_name: 'environment_name'\n})", + "html": "
    await octokit.request('DELETE /repos/{owner}/{repo}/environments/{environment_name}', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  environment_name: 'environment_name'\n})\n
    " + } + ], + "summary": "Delete an environment", + "description": "You must authenticate using an access token with the repo scope to use this endpoint.", + "tags": [ + "repos" + ], + "operationId": "repos/delete-an-environment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/repos#delete-an-environment" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "environments" + }, + "slug": "delete-an-environment", + "category": "repos", + "categoryLabel": "Repos", + "subcategory": "environments", + "subcategoryLabel": "Environments", + "notes": [], + "responses": [ + { + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Default Response" + } + ], + "bodyParameters": [], + "descriptionHTML": "

    You must authenticate using an access token with the repo scope to use this endpoint.

    " + }, { "verb": "get", "requestPath": "/repos/{owner}/{repo}/events", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -36422,8 +45725,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/events", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/events
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/events", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/events
    " }, { "lang": "JavaScript", @@ -36467,7 +45770,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/forks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -36497,7 +45800,8 @@ "enum": [ "newest", "oldest", - "stargazers" + "stargazers", + "watchers" ], "default": "newest" }, @@ -36522,13 +45826,35 @@ "default": 1 }, "descriptionHTML": "

    Page number of the results to fetch.

    " + }, + { + "name": "org", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    legacy query parameter for specifying the org.

    " + }, + { + "name": "organization", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    legacy query parameter for specifying the org.

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/forks", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/forks
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/forks", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/forks
    " }, { "lang": "JavaScript", @@ -36578,7 +45904,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/forks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -36597,13 +45923,35 @@ "type": "string" }, "descriptionHTML": "" + }, + { + "name": "org", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    legacy query parameter for specifying the org.

    " + }, + { + "name": "organization", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    legacy query parameter for specifying the org.

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/forks \\\n -d '{\"organization\":\"organization\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/forks \\\n  -d '{\"organization\":\"organization\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/forks \\\n -d '{\"organization\":\"organization\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/forks \\\n  -d '{\"organization\":\"organization\"}'
    " }, { "lang": "JavaScript", @@ -36626,6 +45974,7 @@ "application/json": { "schema": { "type": "object", + "nullable": true, "properties": { "organization": { "type": "string", @@ -36698,7 +46047,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/git/blobs", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -36722,8 +46071,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/blobs \\\n -d '{\"content\":\"content\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/blobs \\\n  -d '{\"content\":\"content\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/git/blobs \\\n -d '{\"content\":\"content\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/git/blobs \\\n  -d '{\"content\":\"content\"}'
    " }, { "lang": "JavaScript", @@ -36845,7 +46194,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/git/blobs/{file_sha}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -36878,8 +46227,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/blobs/FILE_SHA", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/blobs/FILE_SHA
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/git/blobs/FILE_SHA", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/git/blobs/FILE_SHA
    " }, { "lang": "JavaScript", @@ -36939,7 +46288,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/git/commits", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -36963,8 +46312,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/commits \\\n -d '{\"message\":\"message\",\"tree\":\"tree\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/commits \\\n  -d '{\"message\":\"message\",\"tree\":\"tree\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/git/commits \\\n -d '{\"message\":\"message\",\"tree\":\"tree\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/git/commits \\\n  -d '{\"message\":\"message\",\"tree\":\"tree\"}'
    " }, { "lang": "JavaScript", @@ -37418,7 +46767,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/git/commits/{commit_sha}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -37453,8 +46802,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/commits/COMMIT_SHA", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/commits/COMMIT_SHA
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/git/commits/COMMIT_SHA", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/git/commits/COMMIT_SHA
    " }, { "lang": "JavaScript", @@ -37504,7 +46853,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/git/matching-refs/{ref}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -37526,14 +46875,14 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    ref+ parameter

    " + "descriptionHTML": "

    ref parameter

    " }, { "name": "per_page", @@ -37559,8 +46908,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/matching-refs/REF", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/matching-refs/REF
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/git/matching-refs/REF", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/git/matching-refs/REF
    " }, { "lang": "JavaScript", @@ -37605,7 +46954,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/git/ref/{ref}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -37627,21 +46976,21 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    ref+ parameter

    " + "descriptionHTML": "

    ref parameter

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/ref/REF", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/ref/REF
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/git/ref/REF", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/git/ref/REF
    " }, { "lang": "JavaScript", @@ -37691,7 +47040,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/git/refs", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -37715,8 +47064,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/refs \\\n -d '{\"ref\":\"ref\",\"sha\":\"sha\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/refs \\\n  -d '{\"ref\":\"ref\",\"sha\":\"sha\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/git/refs \\\n -d '{\"ref\":\"ref\",\"sha\":\"sha\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/git/refs \\\n  -d '{\"ref\":\"ref\",\"sha\":\"sha\"}'
    " }, { "lang": "JavaScript", @@ -37840,7 +47189,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/git/refs/{ref}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -37862,21 +47211,21 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    ref+ parameter

    " + "descriptionHTML": "

    ref parameter

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/refs/REF \\\n -d '{\"sha\":\"sha\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/refs/REF \\\n  -d '{\"sha\":\"sha\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/git/refs/REF \\\n -d '{\"sha\":\"sha\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/git/refs/REF \\\n  -d '{\"sha\":\"sha\"}'
    " }, { "lang": "JavaScript", @@ -37983,7 +47332,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/git/refs/{ref}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -38005,21 +47354,21 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    ref+ parameter

    " + "descriptionHTML": "

    ref parameter

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/refs/REF", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/refs/REF
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/git/refs/REF", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/git/refs/REF
    " }, { "lang": "JavaScript", @@ -38054,7 +47403,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "422", @@ -38068,7 +47417,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/git/tags", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -38092,8 +47441,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/tags \\\n -d '{\"tag\":\"tag\",\"message\":\"message\",\"object\":\"object\",\"type\":\"type\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/tags \\\n  -d '{\"tag\":\"tag\",\"message\":\"message\",\"object\":\"object\",\"type\":\"type\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/git/tags \\\n -d '{\"tag\":\"tag\",\"message\":\"message\",\"object\":\"object\",\"type\":\"type\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/git/tags \\\n  -d '{\"tag\":\"tag\",\"message\":\"message\",\"object\":\"object\",\"type\":\"type\"}'
    " }, { "lang": "JavaScript", @@ -38400,7 +47749,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/git/tags/{tag_sha}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -38433,8 +47782,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/tags/TAG_SHA", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/tags/TAG_SHA
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/git/tags/TAG_SHA", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/git/tags/TAG_SHA
    " }, { "lang": "JavaScript", @@ -38484,7 +47833,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/git/trees", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -38508,8 +47857,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/trees \\\n -d '{\"tree\":[{\"path\":\"path\",\"mode\":\"mode\",\"type\":\"type\",\"sha\":\"sha\",\"content\":\"content\"}]}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/trees \\\n  -d '{\"tree\":[{\"path\":\"path\",\"mode\":\"mode\",\"type\":\"type\",\"sha\":\"sha\",\"content\":\"content\"}]}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/git/trees \\\n -d '{\"tree\":[{\"path\":\"path\",\"mode\":\"mode\",\"type\":\"type\",\"sha\":\"sha\",\"content\":\"content\"}]}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/git/trees \\\n  -d '{\"tree\":[{\"path\":\"path\",\"mode\":\"mode\",\"type\":\"type\",\"sha\":\"sha\",\"content\":\"content\"}]}'
    " }, { "lang": "JavaScript", @@ -38889,7 +48238,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/git/trees/{tree_sha}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -38916,6 +48265,7 @@ "schema": { "type": "string" }, + "x-multi-segment": true, "descriptionHTML": "" }, { @@ -38932,8 +48282,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/trees/TREE_SHA", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/git/trees/TREE_SHA
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/git/trees/TREE_SHA", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/git/trees/TREE_SHA
    " }, { "lang": "JavaScript", @@ -38994,7 +48344,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/hooks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -39038,8 +48388,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/hooks", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/hooks
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/hooks", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/hooks
    " }, { "lang": "JavaScript", @@ -39089,7 +48439,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/hooks", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -39113,8 +48463,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/hooks \\\n -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"token\":\"token\",\"digest\":\"digest\"}}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/hooks \\\n  -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"token\":\"token\",\"digest\":\"digest\"}}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/hooks \\\n -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"token\":\"token\",\"digest\":\"digest\"}}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/hooks \\\n  -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"token\":\"token\",\"digest\":\"digest\"}}'
    " }, { "lang": "JavaScript", @@ -39550,7 +48900,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -39583,8 +48933,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/hooks/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/hooks/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/hooks/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/hooks/42
    " }, { "lang": "JavaScript", @@ -39634,7 +48984,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -39667,8 +49017,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/hooks/42 \\\n -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"address\":\"address\",\"room\":\"room\"}}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/hooks/42 \\\n  -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"address\":\"address\",\"room\":\"room\"}}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/hooks/42 \\\n -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"address\":\"address\",\"room\":\"room\"}}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/hooks/42 \\\n  -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"address\":\"address\",\"room\":\"room\"}}'
    " }, { "lang": "JavaScript", @@ -40119,7 +49469,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -40152,8 +49502,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/hooks/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/hooks/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/hooks/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/hooks/42
    " }, { "lang": "JavaScript", @@ -40188,7 +49538,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -40202,7 +49552,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}/config", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -40235,8 +49585,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/hooks/42/config", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/hooks/42/config
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/hooks/42/config", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/hooks/42/config
    " }, { "lang": "JavaScript", @@ -40281,7 +49631,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}/config", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -40314,8 +49664,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/hooks/42/config \\\n -d '{\"url\":\"url\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/hooks/42/config \\\n  -d '{\"url\":\"url\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/hooks/42/config \\\n -d '{\"url\":\"url\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/hooks/42/config \\\n  -d '{\"url\":\"url\"}'
    " }, { "lang": "JavaScript", @@ -40460,7 +49810,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}/pings", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -40493,8 +49843,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/hooks/42/pings", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/hooks/42/pings
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/hooks/42/pings", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/hooks/42/pings
    " }, { "lang": "JavaScript", @@ -40529,7 +49879,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -40543,7 +49893,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}/tests", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -40576,8 +49926,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/hooks/42/tests", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/hooks/42/tests
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/hooks/42/tests", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/hooks/42/tests
    " }, { "lang": "JavaScript", @@ -40612,7 +49962,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -40626,7 +49976,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/installation", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -40650,8 +50000,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/installation", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/installation
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/installation", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/installation
    " }, { "lang": "JavaScript", @@ -40704,7 +50054,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/invitations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -40748,8 +50098,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/invitations", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/invitations
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/invitations", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/invitations
    " }, { "lang": "JavaScript", @@ -40794,7 +50144,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/invitations/{invitation_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -40828,8 +50178,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/invitations/42 \\\n -d '{\"permissions\":\"permissions\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/invitations/42 \\\n  -d '{\"permissions\":\"permissions\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/invitations/42 \\\n -d '{\"permissions\":\"permissions\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/invitations/42 \\\n  -d '{\"permissions\":\"permissions\"}'
    " }, { "lang": "JavaScript", @@ -40918,7 +50268,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/invitations/{invitation_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -40952,8 +50302,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/invitations/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/invitations/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/invitations/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/invitations/42
    " }, { "lang": "JavaScript", @@ -40988,7 +50338,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -40997,7 +50347,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -41148,8 +50498,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/issues", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/issues
    " }, { "lang": "JavaScript", @@ -41214,7 +50564,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/issues", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -41238,8 +50588,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues \\\n -d '{\"title\":\"title\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues \\\n  -d '{\"title\":\"title\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/issues \\\n -d '{\"title\":\"title\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/issues \\\n  -d '{\"title\":\"title\"}'
    " }, { "lang": "JavaScript", @@ -41530,7 +50880,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -41613,8 +50963,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/comments", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/comments
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/issues/comments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/issues/comments
    " }, { "lang": "JavaScript", @@ -41676,7 +51026,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -41710,8 +51060,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/comments/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/comments/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/issues/comments/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/issues/comments/42
    " }, { "lang": "JavaScript", @@ -41768,7 +51118,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -41802,8 +51152,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/comments/42 \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/comments/42 \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/issues/comments/42 \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/issues/comments/42 \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -41889,7 +51239,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -41923,8 +51273,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/comments/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/comments/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/issues/comments/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/issues/comments/42
    " }, { "lang": "JavaScript", @@ -41959,7 +51309,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -41968,7 +51318,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -42042,8 +51392,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/comments/42/reactions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/comments/42/reactions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/issues/comments/42/reactions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/issues/comments/42/reactions
    " }, { "lang": "JavaScript", @@ -42103,7 +51453,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -42137,8 +51487,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/comments/42/reactions \\\n -d '{\"content\":\"content\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/comments/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/issues/comments/42/reactions \\\n -d '{\"content\":\"content\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/issues/comments/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " }, { "lang": "JavaScript", @@ -42260,7 +51610,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -42303,8 +51653,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/comments/42/reactions/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/comments/42/reactions/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/issues/comments/42/reactions/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/issues/comments/42/reactions/42
    " }, { "lang": "JavaScript", @@ -42344,7 +51694,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -42353,7 +51703,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/events", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -42397,8 +51747,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/events", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/events
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/issues/events", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/issues/events
    " }, { "lang": "JavaScript", @@ -42455,7 +51805,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/events/{event_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -42488,8 +51838,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/events/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/events/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/issues/events/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/issues/events/42
    " }, { "lang": "JavaScript", @@ -42556,7 +51906,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -42590,8 +51940,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/issues/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/issues/42
    " }, { "lang": "JavaScript", @@ -42661,7 +52011,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -42695,8 +52045,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42 \\\n -d '{\"title\":\"title\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42 \\\n  -d '{\"title\":\"title\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/issues/42 \\\n -d '{\"title\":\"title\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/issues/42 \\\n  -d '{\"title\":\"title\"}'
    " }, { "lang": "JavaScript", @@ -43021,7 +52371,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/assignees", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -43055,8 +52405,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/assignees \\\n -d '{\"assignees\":[\"assignees\"]}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/assignees \\\n  -d '{\"assignees\":[\"assignees\"]}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/issues/42/assignees \\\n -d '{\"assignees\":[\"assignees\"]}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/issues/42/assignees \\\n  -d '{\"assignees\":[\"assignees\"]}'
    " }, { "lang": "JavaScript", @@ -43143,7 +52493,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/assignees", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -43177,8 +52527,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/assignees \\\n -d '{\"assignees\":[\"assignees\"]}'", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/assignees \\\n  -d '{\"assignees\":[\"assignees\"]}'
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/issues/42/assignees \\\n -d '{\"assignees\":[\"assignees\"]}'", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/issues/42/assignees \\\n  -d '{\"assignees\":[\"assignees\"]}'
    " }, { "lang": "JavaScript", @@ -43265,7 +52615,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -43329,8 +52679,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/comments", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/comments
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/issues/42/comments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/issues/42/comments
    " }, { "lang": "JavaScript", @@ -43392,7 +52742,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -43426,8 +52776,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/comments \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/comments \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/issues/42/comments \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/issues/42/comments \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -43529,7 +52879,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/events", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -43583,8 +52933,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/events", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/events
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/issues/42/events", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/issues/42/events
    " }, { "lang": "JavaScript", @@ -43641,7 +52991,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -43695,8 +53045,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/labels", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/labels
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/issues/42/labels", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/issues/42/labels
    " }, { "lang": "JavaScript", @@ -43746,7 +53096,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -43780,8 +53130,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/labels \\\n -d '{\"labels\":[\"labels\"]}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/labels \\\n  -d '{\"labels\":[\"labels\"]}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/issues/42/labels \\\n -d '{\"labels\":[\"labels\"]}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/issues/42/labels \\\n  -d '{\"labels\":[\"labels\"]}'
    " }, { "lang": "JavaScript", @@ -43881,7 +53231,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -43915,8 +53265,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/labels \\\n -d '{\"labels\":[\"labels\"]}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/labels \\\n  -d '{\"labels\":[\"labels\"]}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/issues/42/labels \\\n -d '{\"labels\":[\"labels\"]}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/issues/42/labels \\\n  -d '{\"labels\":[\"labels\"]}'
    " }, { "lang": "JavaScript", @@ -44013,7 +53363,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -44047,8 +53397,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/labels", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/labels
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/issues/42/labels", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/issues/42/labels
    " }, { "lang": "JavaScript", @@ -44083,7 +53433,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "410", @@ -44097,7 +53447,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels/{name}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -44140,8 +53490,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/labels/NAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/labels/NAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/issues/42/labels/NAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/issues/42/labels/NAME
    " }, { "lang": "JavaScript", @@ -44196,7 +53546,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/lock", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -44230,8 +53580,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/lock \\\n -d '{\"lock_reason\":\"lock_reason\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/lock \\\n  -d '{\"lock_reason\":\"lock_reason\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/issues/42/lock \\\n -d '{\"lock_reason\":\"lock_reason\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/issues/42/lock \\\n  -d '{\"lock_reason\":\"lock_reason\"}'
    " }, { "lang": "JavaScript", @@ -44291,7 +53641,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -44336,7 +53686,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/lock", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -44370,8 +53720,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/lock", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/lock
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/issues/42/lock", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/issues/42/lock
    " }, { "lang": "JavaScript", @@ -44404,7 +53754,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -44423,7 +53773,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -44497,8 +53847,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/reactions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/reactions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/issues/42/reactions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/issues/42/reactions
    " }, { "lang": "JavaScript", @@ -44563,7 +53913,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -44597,8 +53947,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/reactions \\\n -d '{\"content\":\"content\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/issues/42/reactions \\\n -d '{\"content\":\"content\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/issues/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " }, { "lang": "JavaScript", @@ -44714,7 +54064,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -44757,8 +54107,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/reactions/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/reactions/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/issues/42/reactions/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/issues/42/reactions/42
    " }, { "lang": "JavaScript", @@ -44798,7 +54148,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -44807,7 +54157,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/timeline", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -44861,8 +54211,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.mockingbird-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/timeline", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.mockingbird-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/issues/42/timeline
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.mockingbird-preview+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/issues/42/timeline", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.mockingbird-preview+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/issues/42/timeline
    " }, { "lang": "JavaScript", @@ -44935,7 +54285,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/keys", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -44979,8 +54329,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/keys", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/keys
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/keys", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/keys
    " }, { "lang": "JavaScript", @@ -45025,7 +54375,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/keys", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -45049,8 +54399,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/keys \\\n -d '{\"key\":\"key\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/keys \\\n  -d '{\"key\":\"key\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/keys \\\n -d '{\"key\":\"key\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/keys \\\n  -d '{\"key\":\"key\"}'
    " }, { "lang": "JavaScript", @@ -45174,7 +54524,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/keys/{key_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -45208,8 +54558,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/keys/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/keys/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/keys/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/keys/42
    " }, { "lang": "JavaScript", @@ -45259,7 +54609,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/keys/{key_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -45293,8 +54643,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/keys/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/keys/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/keys/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/keys/42
    " }, { "lang": "JavaScript", @@ -45329,7 +54679,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -45338,7 +54688,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/labels", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -45382,8 +54732,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/labels", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/labels
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/labels", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/labels
    " }, { "lang": "JavaScript", @@ -45433,7 +54783,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/labels", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -45457,8 +54807,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/labels \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/labels \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/labels \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/labels \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -45587,7 +54937,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/labels/{name}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -45620,8 +54970,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/labels/NAME", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/labels/NAME
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/labels/NAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/labels/NAME
    " }, { "lang": "JavaScript", @@ -45671,7 +55021,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/labels/{name}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -45704,8 +55054,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/labels/NAME \\\n -d '{\"new_name\":\"new_name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/labels/NAME \\\n  -d '{\"new_name\":\"new_name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/labels/NAME \\\n -d '{\"new_name\":\"new_name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/labels/NAME \\\n  -d '{\"new_name\":\"new_name\"}'
    " }, { "lang": "JavaScript", @@ -45821,7 +55171,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/labels/{name}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -45854,8 +55204,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/labels/NAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/labels/NAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/labels/NAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/labels/NAME
    " }, { "lang": "JavaScript", @@ -45890,7 +55240,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -45899,7 +55249,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/languages", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -45923,8 +55273,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/languages", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/languages
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/languages", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/languages
    " }, { "lang": "JavaScript", @@ -45967,7 +55317,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/license", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -45991,8 +55341,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/license", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/license
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/license", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/license
    " }, { "lang": "JavaScript", @@ -46035,7 +55385,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/merges", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -46059,8 +55409,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/merges \\\n -d '{\"base\":\"base\",\"head\":\"head\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/merges \\\n  -d '{\"base\":\"base\",\"head\":\"head\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/merges \\\n -d '{\"base\":\"base\",\"head\":\"head\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/merges \\\n  -d '{\"base\":\"base\",\"head\":\"head\"}'
    " }, { "lang": "JavaScript", @@ -46183,20 +55533,12 @@ { "httpStatusCode": "404", "httpStatusMessage": "Not Found", - "description": "Missing base response", - "payload": "
    {\n  \"message\": \"Base does not exist\"\n}\n
    " - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Missing head response", - "payload": "
    {\n  \"message\": \"Head does not exist\"\n}\n
    " + "description": "Response when the base or head does not exist" }, { "httpStatusCode": "409", "httpStatusMessage": "Conflict", - "description": "Merge conflict response", - "payload": "
    {\n  \"message\": \"Merge Conflict\"\n}\n
    " + "description": "Response when there is a merge conflict" }, { "httpStatusCode": "422", @@ -46208,7 +55550,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/milestones", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -46298,8 +55640,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/milestones", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/milestones
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/milestones", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/milestones
    " }, { "lang": "JavaScript", @@ -46349,7 +55691,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/milestones", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -46373,8 +55715,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/milestones \\\n -d '{\"title\":\"title\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/milestones \\\n  -d '{\"title\":\"title\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/milestones \\\n -d '{\"title\":\"title\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/milestones \\\n  -d '{\"title\":\"title\"}'
    " }, { "lang": "JavaScript", @@ -46532,7 +55874,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/milestones/{milestone_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -46566,8 +55908,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/milestones/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/milestones/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/milestones/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/milestones/42
    " }, { "lang": "JavaScript", @@ -46617,7 +55959,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/milestones/{milestone_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -46651,8 +55993,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/milestones/42 \\\n -d '{\"title\":\"title\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/milestones/42 \\\n  -d '{\"title\":\"title\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/milestones/42 \\\n -d '{\"title\":\"title\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/milestones/42 \\\n  -d '{\"title\":\"title\"}'
    " }, { "lang": "JavaScript", @@ -46797,7 +56139,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/milestones/{milestone_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -46831,8 +56173,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/milestones/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/milestones/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/milestones/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/milestones/42
    " }, { "lang": "JavaScript", @@ -46867,7 +56209,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -46881,7 +56223,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/milestones/{milestone_number}/labels", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -46935,8 +56277,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/milestones/42/labels", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/milestones/42/labels
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/milestones/42/labels", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/milestones/42/labels
    " }, { "lang": "JavaScript", @@ -46981,7 +56323,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/notifications", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -47067,8 +56409,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/notifications", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/notifications
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/notifications", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/notifications
    " }, { "lang": "JavaScript", @@ -47113,7 +56455,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/notifications", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -47137,8 +56479,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/notifications \\\n -d '{\"last_read_at\":\"last_read_at\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/notifications \\\n  -d '{\"last_read_at\":\"last_read_at\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/notifications \\\n -d '{\"last_read_at\":\"last_read_at\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/notifications \\\n  -d '{\"last_read_at\":\"last_read_at\"}'
    " }, { "lang": "JavaScript", @@ -47212,7 +56554,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pages", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -47236,8 +56578,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pages
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/pages", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/pages
    " }, { "lang": "JavaScript", @@ -47287,7 +56629,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/pages", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -47311,8 +56653,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages \\\n -d '{\"source\":{\"branch\":\"branch\",\"path\":\"path\"}}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pages \\\n  -d '{\"source\":{\"branch\":\"branch\",\"path\":\"path\"}}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/pages \\\n -d '{\"source\":{\"branch\":\"branch\",\"path\":\"path\"}}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/pages \\\n  -d '{\"source\":{\"branch\":\"branch\",\"path\":\"path\"}}'
    " }, { "lang": "JavaScript", @@ -47537,7 +56879,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/pages", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -47561,8 +56903,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages \\\n -d '{\"source\":\"source\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pages \\\n  -d '{\"source\":\"source\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/pages \\\n -d '{\"source\":\"source\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/pages \\\n  -d '{\"source\":\"source\"}'
    " }, { "lang": "JavaScript", @@ -47676,7 +57018,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "400", @@ -47754,7 +57096,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/pages", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -47778,8 +57120,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pages
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/pages", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/pages
    " }, { "lang": "JavaScript", @@ -47821,7 +57163,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -47845,7 +57187,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pages/builds", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -47889,8 +57231,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages/builds", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pages/builds
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/pages/builds", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/pages/builds
    " }, { "lang": "JavaScript", @@ -47935,7 +57277,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/pages/builds", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -47959,8 +57301,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages/builds", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pages/builds
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/pages/builds", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/pages/builds
    " }, { "lang": "JavaScript", @@ -48005,7 +57347,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pages/builds/latest", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -48029,8 +57371,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages/builds/latest", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pages/builds/latest
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/pages/builds/latest", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/pages/builds/latest
    " }, { "lang": "JavaScript", @@ -48075,7 +57417,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pages/builds/{build_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -48108,8 +57450,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages/builds/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pages/builds/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/pages/builds/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/pages/builds/42
    " }, { "lang": "JavaScript", @@ -48154,7 +57496,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/projects", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -48214,8 +57556,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/projects", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/projects
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/projects", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/projects
    " }, { "lang": "JavaScript", @@ -48290,7 +57632,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/projects", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -48314,8 +57656,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/projects \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/projects \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/projects \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/projects \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -48445,7 +57787,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -48556,8 +57898,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/pulls", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/pulls
    " }, { "lang": "JavaScript", @@ -48610,7 +57952,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/pulls", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -48634,8 +57976,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls \\\n -d '{\"head\":\"head\",\"base\":\"base\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls \\\n  -d '{\"head\":\"head\",\"base\":\"base\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/pulls \\\n -d '{\"head\":\"head\",\"base\":\"base\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/pulls \\\n  -d '{\"head\":\"head\",\"base\":\"base\"}'
    " }, { "lang": "JavaScript", @@ -48837,7 +58179,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -48859,18 +58201,17 @@ }, { "name": "sort", - "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to).", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "created", - "updated" - ], - "default": "created" + "updated", + "created_at" + ] }, - "descriptionHTML": "

    One of created (when the repository was starred) or updated (when it was last pushed to).

    " + "descriptionHTML": "" }, { "name": "direction", @@ -48920,8 +58261,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/comments", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/comments
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/pulls/comments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/pulls/comments
    " }, { "lang": "JavaScript", @@ -48979,7 +58320,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -49013,8 +58354,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/comments/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/comments/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/pulls/comments/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/pulls/comments/42
    " }, { "lang": "JavaScript", @@ -49077,7 +58418,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -49111,8 +58452,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/comments/42 \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/comments/42 \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/pulls/comments/42 \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/pulls/comments/42 \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -49200,7 +58541,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -49234,8 +58575,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/comments/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/comments/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/pulls/comments/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/pulls/comments/42
    " }, { "lang": "JavaScript", @@ -49270,7 +58611,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -49284,7 +58625,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -49358,8 +58699,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/comments/42/reactions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/comments/42/reactions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/pulls/comments/42/reactions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/pulls/comments/42/reactions
    " }, { "lang": "JavaScript", @@ -49419,7 +58760,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -49453,8 +58794,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/comments/42/reactions \\\n -d '{\"content\":\"content\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/comments/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/pulls/comments/42/reactions \\\n -d '{\"content\":\"content\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/pulls/comments/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " }, { "lang": "JavaScript", @@ -49576,7 +58917,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -49619,8 +58960,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/comments/42/reactions/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/comments/42/reactions/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/pulls/comments/42/reactions/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/pulls/comments/42/reactions/42
    " }, { "lang": "JavaScript", @@ -49660,7 +59001,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -49669,7 +59010,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -49702,8 +59043,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/pulls/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/pulls/42
    " }, { "lang": "JavaScript", @@ -49761,7 +59102,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -49794,8 +59135,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42 \\\n -d '{\"title\":\"title\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42 \\\n  -d '{\"title\":\"title\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/pulls/42 \\\n -d '{\"title\":\"title\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/pulls/42 \\\n  -d '{\"title\":\"title\"}'
    " }, { "lang": "JavaScript", @@ -49964,7 +59305,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -50056,8 +59397,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/comments", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/comments
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/pulls/42/comments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/pulls/42/comments
    " }, { "lang": "JavaScript", @@ -50115,7 +59456,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -50148,8 +59489,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/comments \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/comments \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/pulls/42/comments \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/pulls/42/comments \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -50431,7 +59772,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -50474,8 +59815,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/comments/42/replies \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/comments/42/replies \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/pulls/42/comments/42/replies \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/pulls/42/comments/42/replies \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -50562,7 +59903,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/commits", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -50615,8 +59956,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/commits", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/commits
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/pulls/42/commits", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/pulls/42/commits
    " }, { "lang": "JavaScript", @@ -50659,7 +60000,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/files", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -50712,8 +60053,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/files", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/files
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/pulls/42/files", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/pulls/42/files
    " }, { "lang": "JavaScript", @@ -50766,7 +60107,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/merge", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -50799,8 +60140,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/merge", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/merge
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/pulls/42/merge", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/pulls/42/merge
    " }, { "lang": "JavaScript", @@ -50847,7 +60188,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/merge", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -50880,8 +60221,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/merge \\\n -d '{\"commit_title\":\"commit_title\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/merge \\\n  -d '{\"commit_title\":\"commit_title\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/pulls/42/merge \\\n -d '{\"commit_title\":\"commit_title\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/pulls/42/merge \\\n  -d '{\"commit_title\":\"commit_title\"}'
    " }, { "lang": "JavaScript", @@ -51047,7 +60388,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -51100,8 +60441,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/requested_reviewers", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/requested_reviewers
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/pulls/42/requested_reviewers", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/pulls/42/requested_reviewers
    " }, { "lang": "JavaScript", @@ -51146,7 +60487,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -51179,8 +60520,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/requested_reviewers \\\n -d '{\"reviewers\":[\"reviewers\"]}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/requested_reviewers \\\n  -d '{\"reviewers\":[\"reviewers\"]}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/pulls/42/requested_reviewers \\\n -d '{\"reviewers\":[\"reviewers\"]}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/pulls/42/requested_reviewers \\\n  -d '{\"reviewers\":[\"reviewers\"]}'
    " }, { "lang": "JavaScript", @@ -51318,7 +60659,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -51351,8 +60692,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/requested_reviewers \\\n -d '{\"reviewers\":[\"reviewers\"]}'", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/requested_reviewers \\\n  -d '{\"reviewers\":[\"reviewers\"]}'
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/pulls/42/requested_reviewers \\\n -d '{\"reviewers\":[\"reviewers\"]}'", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/pulls/42/requested_reviewers \\\n  -d '{\"reviewers\":[\"reviewers\"]}'
    " }, { "lang": "JavaScript", @@ -51474,7 +60815,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -51527,8 +60868,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/reviews
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/pulls/42/reviews", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/pulls/42/reviews
    " }, { "lang": "JavaScript", @@ -51573,7 +60914,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -51606,8 +60947,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews \\\n -d '{\"commit_id\":\"commit_id\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/reviews \\\n  -d '{\"commit_id\":\"commit_id\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/pulls/42/reviews \\\n -d '{\"commit_id\":\"commit_id\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/pulls/42/reviews \\\n  -d '{\"commit_id\":\"commit_id\"}'
    " }, { "lang": "JavaScript", @@ -52055,7 +61396,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -52098,8 +61439,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/pulls/42/reviews/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/pulls/42/reviews/42
    " }, { "lang": "JavaScript", @@ -52149,7 +61490,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -52192,8 +61533,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42 \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42 \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/pulls/42/reviews/42 \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/pulls/42/reviews/42 \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -52279,7 +61620,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -52322,8 +61663,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/pulls/42/reviews/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/pulls/42/reviews/42
    " }, { "lang": "JavaScript", @@ -52378,7 +61719,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -52441,8 +61782,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42/comments", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42/comments
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/pulls/42/reviews/42/comments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/pulls/42/reviews/42/comments
    " }, { "lang": "JavaScript", @@ -52492,7 +61833,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -52535,8 +61876,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42/dismissals \\\n -d '{\"message\":\"message\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42/dismissals \\\n  -d '{\"message\":\"message\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/pulls/42/reviews/42/dismissals \\\n -d '{\"message\":\"message\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/pulls/42/reviews/42/dismissals \\\n  -d '{\"message\":\"message\"}'
    " }, { "lang": "JavaScript", @@ -52642,7 +61983,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -52685,8 +62026,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42/events \\\n -d '{\"event\":\"event\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42/events \\\n  -d '{\"event\":\"event\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/pulls/42/reviews/42/events \\\n -d '{\"event\":\"event\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/pulls/42/reviews/42/events \\\n  -d '{\"event\":\"event\"}'
    " }, { "lang": "JavaScript", @@ -52807,7 +62148,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/update-branch", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -52840,8 +62181,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.lydian-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/update-branch \\\n -d '{\"expected_head_sha\":\"expected_head_sha\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.lydian-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/pulls/42/update-branch \\\n  -d '{\"expected_head_sha\":\"expected_head_sha\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.lydian-preview+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/pulls/42/update-branch \\\n -d '{\"expected_head_sha\":\"expected_head_sha\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.lydian-preview+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/pulls/42/update-branch \\\n  -d '{\"expected_head_sha\":\"expected_head_sha\"}'
    " }, { "lang": "JavaScript", @@ -52940,7 +62281,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/readme", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -52974,8 +62315,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/readme", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/readme
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/readme", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/readme
    " }, { "lang": "JavaScript", @@ -53027,10 +62368,111 @@ } ] }, + { + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/readme/{dir}", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "dir", + "description": "The alternate path to look for a README file", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true, + "descriptionHTML": "

    The alternate path to look for a README file

    " + }, + { + "name": "ref", + "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    The name of the commit/branch/tag. Default: the repository’s default branch (usually master)

    " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/readme/DIR", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/readme/DIR
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /repos/{owner}/{repo}/readme/{dir}', {\n owner: 'octocat',\n repo: 'hello-world',\n dir: 'dir'\n})", + "html": "
    await octokit.request('GET /repos/{owner}/{repo}/readme/{dir}', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  dir: 'dir'\n})\n
    " + } + ], + "summary": "Get a repository README", + "description": "Gets the preferred README for a repository.\n\nREADMEs support [custom media types](https://docs.github.com/github-ae@latest/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML.", + "tags": [ + "repos" + ], + "operationId": "repos/get-readme-from-alt-path", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/repos#get-a-repository-readme" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "contents" + }, + "slug": "get-a-repository-readme", + "category": "repos", + "categoryLabel": "Repos", + "subcategory": "contents", + "subcategoryLabel": "Contents", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

    Gets the preferred README for a repository.

    \n

    READMEs support custom media types for retrieving the raw content or rendered HTML.

    ", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
    {\n  \"type\": \"file\",\n  \"encoding\": \"base64\",\n  \"size\": 5362,\n  \"name\": \"README.md\",\n  \"path\": \"README.md\",\n  \"content\": \"encoded content ...\",\n  \"sha\": \"3d21ec53a331a6f037a91c368710b99387d012c1\",\n  \"url\": \"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\n  \"git_url\": \"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\n  \"html_url\": \"https://github.com/octokit/octokit.rb/blob/master/README.md\",\n  \"download_url\": \"https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md\",\n  \"_links\": {\n    \"git\": \"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\n    \"self\": \"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\n    \"html\": \"https://github.com/octokit/octokit.rb/blob/master/README.md\"\n  }\n}\n
    " + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + } + ] + }, { "verb": "get", "requestPath": "/repos/{owner}/{repo}/releases", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -53074,8 +62516,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/releases", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/releases
    " }, { "lang": "JavaScript", @@ -53125,7 +62567,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/releases", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -53149,8 +62591,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases \\\n -d '{\"tag_name\":\"tag_name\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases \\\n  -d '{\"tag_name\":\"tag_name\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/releases \\\n -d '{\"tag_name\":\"tag_name\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/releases \\\n  -d '{\"tag_name\":\"tag_name\"}'
    " }, { "lang": "JavaScript", @@ -53336,7 +62778,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/releases/assets/{asset_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -53370,8 +62812,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/assets/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases/assets/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/releases/assets/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/releases/assets/42
    " }, { "lang": "JavaScript", @@ -53431,7 +62873,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/releases/assets/{asset_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -53465,8 +62907,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/assets/42 \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases/assets/42 \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/releases/assets/42 \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/releases/assets/42 \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -53581,7 +63023,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/releases/assets/{asset_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -53615,8 +63057,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/assets/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases/assets/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/releases/assets/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/releases/assets/42
    " }, { "lang": "JavaScript", @@ -53651,7 +63093,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -53660,7 +63102,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/releases/latest", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -53684,8 +63126,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/latest", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases/latest
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/releases/latest", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/releases/latest
    " }, { "lang": "JavaScript", @@ -53730,7 +63172,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/releases/tags/{tag}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -53752,21 +63194,21 @@ }, { "name": "tag", - "description": "tag+ parameter", + "description": "tag parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, - "descriptionHTML": "

    tag+ parameter

    " + "descriptionHTML": "

    tag parameter

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/tags/TAG", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases/tags/TAG
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/releases/tags/TAG", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/releases/tags/TAG
    " }, { "lang": "JavaScript", @@ -53816,7 +63258,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/releases/{release_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -53850,8 +63292,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/releases/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/releases/42
    " }, { "lang": "JavaScript", @@ -53901,7 +63343,7 @@ { "verb": "patch", "requestPath": "/repos/{owner}/{repo}/releases/{release_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -53935,8 +63377,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/42 \\\n -d '{\"tag_name\":\"tag_name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases/42 \\\n  -d '{\"tag_name\":\"tag_name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/releases/42 \\\n -d '{\"tag_name\":\"tag_name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/releases/42 \\\n  -d '{\"tag_name\":\"tag_name\"}'
    " }, { "lang": "JavaScript", @@ -54109,7 +63551,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/releases/{release_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -54143,8 +63585,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/releases/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/releases/42
    " }, { "lang": "JavaScript", @@ -54179,7 +63621,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -54188,7 +63630,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/releases/{release_id}/assets", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -54242,8 +63684,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/42/assets", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases/42/assets
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/releases/42/assets", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/releases/42/assets
    " }, { "lang": "JavaScript", @@ -54288,7 +63730,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/releases/{release_id}/assets", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -54338,8 +63780,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/42/assets", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/releases/42/assets
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/releases/42/assets", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/releases/42/assets
    " }, { "lang": "JavaScript", @@ -54405,7 +63847,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/stargazers", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -54449,8 +63891,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/stargazers", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/stargazers
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/stargazers", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/stargazers
    " }, { "lang": "JavaScript", @@ -54500,7 +63942,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/stats/code_frequency", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -54524,8 +63966,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/stats/code_frequency", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/stats/code_frequency
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/stats/code_frequency", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/stats/code_frequency
    " }, { "lang": "JavaScript", @@ -54570,7 +64012,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/stats/commit_activity", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -54594,8 +64036,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/stats/commit_activity", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/stats/commit_activity
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/stats/commit_activity", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/stats/commit_activity
    " }, { "lang": "JavaScript", @@ -54640,7 +64082,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/stats/contributors", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -54664,8 +64106,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/stats/contributors", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/stats/contributors
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/stats/contributors", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/stats/contributors
    " }, { "lang": "JavaScript", @@ -54710,7 +64152,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/stats/participation", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -54734,8 +64176,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/stats/participation", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/stats/participation
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/stats/participation", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/stats/participation
    " }, { "lang": "JavaScript", @@ -54785,7 +64227,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/stats/punch_card", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -54809,8 +64251,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/stats/punch_card", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/stats/punch_card
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/stats/punch_card", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/stats/punch_card
    " }, { "lang": "JavaScript", @@ -54855,7 +64297,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/statuses/{sha}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -54889,8 +64331,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/statuses/SHA \\\n -d '{\"state\":\"state\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/statuses/SHA \\\n  -d '{\"state\":\"state\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/statuses/SHA \\\n -d '{\"state\":\"state\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/statuses/SHA \\\n  -d '{\"state\":\"state\"}'
    " }, { "lang": "JavaScript", @@ -55042,7 +64484,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/subscribers", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -55086,8 +64528,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/subscribers", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/subscribers
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/subscribers", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/subscribers
    " }, { "lang": "JavaScript", @@ -55132,7 +64574,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/subscription", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -55156,8 +64598,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/subscription", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/subscription
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/subscription", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/subscription
    " }, { "lang": "JavaScript", @@ -55212,7 +64654,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/subscription", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -55236,8 +64678,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/subscription \\\n -d '{\"subscribed\":true}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/subscription \\\n  -d '{\"subscribed\":true}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/subscription \\\n -d '{\"subscribed\":true}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/subscription \\\n  -d '{\"subscribed\":true}'
    " }, { "lang": "JavaScript", @@ -55330,7 +64772,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/subscription", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -55354,8 +64796,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/subscription", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/subscription
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/subscription", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/subscription
    " }, { "lang": "JavaScript", @@ -55390,7 +64832,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -55399,7 +64841,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/tags", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -55443,8 +64885,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/tags", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/tags
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/tags", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/tags
    " }, { "lang": "JavaScript", @@ -55487,7 +64929,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/tarball/{ref}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -55520,8 +64962,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/tarball/REF", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/tarball/REF
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/tarball/REF", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/tarball/REF
    " }, { "lang": "JavaScript", @@ -55565,7 +65007,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/teams", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -55609,8 +65051,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/teams", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/teams
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/teams", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/teams
    " }, { "lang": "JavaScript", @@ -55653,7 +65095,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/topics", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -55672,13 +65114,33 @@ "type": "string" }, "descriptionHTML": "" + }, + { + "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.

    " + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "descriptionHTML": "

    Results per page (max 100).

    " } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/topics", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/topics
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/topics", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/topics
    " }, { "lang": "JavaScript", @@ -55738,7 +65200,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/topics", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -55762,8 +65224,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/topics \\\n -d '{\"names\":[\"names\"]}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/topics \\\n  -d '{\"names\":[\"names\"]}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/topics \\\n -d '{\"names\":[\"names\"]}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/topics \\\n  -d '{\"names\":[\"names\"]}'
    " }, { "lang": "JavaScript", @@ -55875,7 +65337,7 @@ { "verb": "post", "requestPath": "/repos/{owner}/{repo}/transfer", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -55899,8 +65361,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/transfer \\\n -d '{\"new_owner\":\"new_owner\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/transfer \\\n  -d '{\"new_owner\":\"new_owner\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/transfer \\\n -d '{\"new_owner\":\"new_owner\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/transfer \\\n  -d '{\"new_owner\":\"new_owner\"}'
    " }, { "lang": "JavaScript", @@ -56007,7 +65469,7 @@ { "verb": "put", "requestPath": "/repos/{owner}/{repo}/vulnerability-alerts", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -56031,8 +65493,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/vulnerability-alerts", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/vulnerability-alerts
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/vulnerability-alerts", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/vulnerability-alerts
    " }, { "lang": "JavaScript", @@ -56072,7 +65534,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -56081,7 +65543,7 @@ { "verb": "delete", "requestPath": "/repos/{owner}/{repo}/vulnerability-alerts", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -56105,8 +65567,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/vulnerability-alerts", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/vulnerability-alerts
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/vulnerability-alerts", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/vulnerability-alerts
    " }, { "lang": "JavaScript", @@ -56146,7 +65608,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -56155,7 +65617,7 @@ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/zipball/{ref}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -56188,8 +65650,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/zipball/REF", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/zipball/REF
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/zipball/REF", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/zipball/REF
    " }, { "lang": "JavaScript", @@ -56233,7 +65695,7 @@ { "verb": "post", "requestPath": "/repos/{template_owner}/{template_repo}/generate", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "template_owner", @@ -56257,8 +65719,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.baptiste-preview+json\" \\\n https://api.github.com/repos/TEMPLATE_OWNER/TEMPLATE_REPO/generate \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.baptiste-preview+json\" \\\n  https://api.github.com/repos/TEMPLATE_OWNER/TEMPLATE_REPO/generate \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.baptiste-preview+json\" \\\n http(s)://api.{hostname}/repos/TEMPLATE_OWNER/TEMPLATE_REPO/generate \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.baptiste-preview+json\" \\\n  http(s)://api.{hostname}/repos/TEMPLATE_OWNER/TEMPLATE_REPO/generate \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -56267,7 +65729,7 @@ } ], "summary": "Create a repository using a template", - "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/github-ae@latest/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", + "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/github-ae@latest/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository", "tags": [ "repos" ], @@ -56362,7 +65824,7 @@ "category": "repos", "categoryLabel": "Repos", "notes": [], - "descriptionHTML": "

    Creates a new repository using a repository template. Use the template_owner and template_repo route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the Get a repository endpoint and check that the is_template key is true.

    \n

    OAuth scope requirements

    \n

    When using OAuth, authorizations must include:

    \n
      \n
    • public_repo scope or repo scope to create a public repository
    • \n
    • repo scope to create a private repository
    • \n
    ", + "descriptionHTML": "

    Creates a new repository using a repository template. Use the template_owner and template_repo route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the Get a repository endpoint and check that the is_template key is true.

    \n

    OAuth scope requirements

    \n

    When using OAuth, authorizations must include:

    \n
      \n
    • public_repo scope or repo scope to create a public repository. Note: For GitHub AE, use repo scope to create an internal repository.
    • \n
    • repo scope to create a private repository
    • \n
    ", "bodyParameters": [ { "type": "string", @@ -56424,7 +65886,7 @@ { "verb": "get", "requestPath": "/repositories", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "since", @@ -56440,8 +65902,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repositories", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repositories
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repositories", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repositories
    " }, { "lang": "JavaScript", @@ -56450,7 +65912,7 @@ } ], "summary": "List public repositories", - "description": "Lists all public repositories in the order that they were created.\n\nNote: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.", + "description": "Lists all public repositories in the order that they were created.\n\nNotes:\n- For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise.\n- Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.", "tags": [ "repos" ], @@ -56471,7 +65933,7 @@ "categoryLabel": "Repos", "notes": [], "bodyParameters": [], - "descriptionHTML": "

    Lists all public repositories in the order that they were created.

    \n

    Note: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of repositories.

    ", + "descriptionHTML": "

    Lists all public repositories in the order that they were created.

    \n

    Notes:

    \n
      \n
    • For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise.
    • \n
    • Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of repositories.
    • \n
    ", "responses": [ { "httpStatusCode": "200", @@ -56491,10 +65953,1517 @@ } ] }, + { + "verb": "get", + "requestPath": "/repositories/{repository_id}/environments/{environment_name}/secrets", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "repository_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "" + }, + { + "name": "environment_name", + "in": "path", + "required": true, + "description": "The name of the environment", + "schema": { + "type": "string" + }, + "descriptionHTML": "

    The name of the environment

    " + }, + { + "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 http(s)://api.{hostname}/repositories/42/environments/ENVIRONMENT_NAME/secrets", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repositories/42/environments/ENVIRONMENT_NAME/secrets
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /repositories/{repository_id}/environments/{environment_name}/secrets', {\n repository_id: 42,\n environment_name: 'environment_name'\n})", + "html": "
    await octokit.request('GET /repositories/{repository_id}/environments/{environment_name}/secrets', {\n  repository_id: 42,\n  environment_name: 'environment_name'\n})\n
    " + } + ], + "summary": "List environment secrets", + "description": "Lists all secrets available in an environment without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/list-environment-secrets", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#list-environment-secrets" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "secrets" + }, + "slug": "list-environment-secrets", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "secrets", + "subcategoryLabel": "Secrets", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

    Lists all secrets available in an environment without revealing their encrypted values. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use this endpoint.

    ", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
    {\n  \"total_count\": 2,\n  \"secrets\": [\n    {\n      \"name\": \"GH_TOKEN\",\n      \"created_at\": \"2019-08-10T14:59:22Z\",\n      \"updated_at\": \"2020-01-10T14:59:22Z\"\n    },\n    {\n      \"name\": \"GIST_ID\",\n      \"created_at\": \"2020-01-10T10:59:22Z\",\n      \"updated_at\": \"2020-01-11T11:59:22Z\"\n    }\n  ]\n}\n
    " + } + ] + }, + { + "verb": "get", + "requestPath": "/repositories/{repository_id}/environments/{environment_name}/secrets/public-key", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "repository_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "" + }, + { + "name": "environment_name", + "in": "path", + "required": true, + "description": "The name of the environment", + "schema": { + "type": "string" + }, + "descriptionHTML": "

    The name of the environment

    " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repositories/42/environments/ENVIRONMENT_NAME/secrets/public-key", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repositories/42/environments/ENVIRONMENT_NAME/secrets/public-key
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /repositories/{repository_id}/environments/{environment_name}/secrets/public-key', {\n repository_id: 42,\n environment_name: 'environment_name'\n})", + "html": "
    await octokit.request('GET /repositories/{repository_id}/environments/{environment_name}/secrets/public-key', {\n  repository_id: 42,\n  environment_name: 'environment_name'\n})\n
    " + } + ], + "summary": "Get an environment public key", + "description": "Get the public key for an environment, which you need to encrypt environment secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `secrets` repository permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-environment-public-key", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#get-an-environment-public-key" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "secrets" + }, + "slug": "get-an-environment-public-key", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "secrets", + "subcategoryLabel": "Secrets", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

    Get the public key for an environment, which you need to encrypt environment secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the secrets repository permission to use this endpoint.

    ", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
    {\n  \"key_id\": \"012345678912345678\",\n  \"key\": \"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234\"\n}\n
    " + } + ] + }, + { + "verb": "get", + "requestPath": "/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "repository_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "" + }, + { + "name": "environment_name", + "in": "path", + "required": true, + "description": "The name of the environment", + "schema": { + "type": "string" + }, + "descriptionHTML": "

    The name of the environment

    " + }, + { + "name": "secret_name", + "description": "secret_name parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    secret_name parameter

    " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repositories/42/environments/ENVIRONMENT_NAME/secrets/SECRET_NAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repositories/42/environments/ENVIRONMENT_NAME/secrets/SECRET_NAME
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}', {\n repository_id: 42,\n environment_name: 'environment_name',\n secret_name: 'secret_name'\n})", + "html": "
    await octokit.request('GET /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}', {\n  repository_id: 42,\n  environment_name: 'environment_name',\n  secret_name: 'secret_name'\n})\n
    " + } + ], + "summary": "Get an environment secret", + "description": "Gets a single environment secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-environment-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#get-an-environment-secret" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "secrets" + }, + "slug": "get-an-environment-secret", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "secrets", + "subcategoryLabel": "Secrets", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

    Gets a single environment secret without revealing its encrypted value. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use this endpoint.

    ", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
    {\n  \"name\": \"GH_TOKEN\",\n  \"created_at\": \"2019-08-10T14:59:22Z\",\n  \"updated_at\": \"2020-01-10T14:59:22Z\"\n}\n
    " + } + ] + }, + { + "verb": "put", + "requestPath": "/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "repository_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "" + }, + { + "name": "environment_name", + "in": "path", + "required": true, + "description": "The name of the environment", + "schema": { + "type": "string" + }, + "descriptionHTML": "

    The name of the environment

    " + }, + { + "name": "secret_name", + "description": "secret_name parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    secret_name parameter

    " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repositories/42/environments/ENVIRONMENT_NAME/secrets/SECRET_NAME \\\n -d '{\"encrypted_value\":\"encrypted_value\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repositories/42/environments/ENVIRONMENT_NAME/secrets/SECRET_NAME \\\n  -d '{\"encrypted_value\":\"encrypted_value\"}'
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('PUT /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}', {\n repository_id: 42,\n environment_name: 'environment_name',\n secret_name: 'secret_name',\n encrypted_value: 'encrypted_value'\n})", + "html": "
    await octokit.request('PUT /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}', {\n  repository_id: 42,\n  environment_name: 'environment_name',\n  secret_name: 'secret_name',\n  encrypted_value: 'encrypted_value'\n})\n
    " + } + ], + "summary": "Create or update an environment secret", + "description": "Creates or updates an environment secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access\ntoken with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use\nthis endpoint.\n\n#### Example encrypting a secret using Node.js\n\nEncrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library.\n\n```\nconst sodium = require('tweetsodium');\n\nconst key = \"base64-encoded-public-key\";\nconst value = \"plain-text-secret\";\n\n// Convert the message and key to Uint8Array's (Buffer implements that interface)\nconst messageBytes = Buffer.from(value);\nconst keyBytes = Buffer.from(key, 'base64');\n\n// Encrypt using LibSodium.\nconst encryptedBytes = sodium.seal(messageBytes, keyBytes);\n\n// Base64 the encrypted secret\nconst encrypted = Buffer.from(encryptedBytes).toString('base64');\n\nconsole.log(encrypted);\n```\n\n\n#### Example encrypting a secret using Python\n\nEncrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/stable/public/#nacl-public-sealedbox) with Python 3.\n\n```\nfrom base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n sealed_box = public.SealedBox(public_key)\n encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n return b64encode(encrypted).decode(\"utf-8\")\n```\n\n#### Example encrypting a secret using C#\n\nEncrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.\n\n```\nvar secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\n```\n\n#### Example encrypting a secret using Ruby\n\nEncrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.\n\n```ruby\nrequire \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\n```", + "tags": [ + "actions" + ], + "operationId": "actions/create-or-update-environment-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#create-or-update-an-environment-secret" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "encrypted_value": { + "type": "string", + "description": "

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an environment public key endpoint.

    ", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", + "name": "encrypted_value", + "in": "body", + "rawType": "string", + "rawDescription": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/github-ae@latest/rest/reference/actions#get-an-environment-public-key) endpoint.", + "childParamsGroups": [] + }, + "key_id": { + "type": "string", + "description": "

    ID of the key you used to encrypt the secret.

    ", + "name": "key_id", + "in": "body", + "rawType": "string", + "rawDescription": "ID of the key you used to encrypt the secret.", + "childParamsGroups": [] + } + } + }, + "example": { + "encrypted_value": "c2VjcmV0", + "key_id": "012345678912345678" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "secrets" + }, + "slug": "create-or-update-an-environment-secret", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "secrets", + "subcategoryLabel": "Secrets", + "notes": [], + "responses": [ + { + "httpStatusCode": "201", + "httpStatusMessage": "Created", + "description": "Response when creating a secret" + }, + { + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Response when updating a secret" + } + ], + "descriptionHTML": "

    Creates or updates an environment secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use\nthis endpoint.

    \n

    Example encrypting a secret using Node.js

    \n

    Encrypt your secret using the tweetsodium library.

    \n
    const sodium = require('tweetsodium');\n\nconst key = \"base64-encoded-public-key\";\nconst value = \"plain-text-secret\";\n\n// Convert the message and key to Uint8Array's (Buffer implements that interface)\nconst messageBytes = Buffer.from(value);\nconst keyBytes = Buffer.from(key, 'base64');\n\n// Encrypt using LibSodium.\nconst encryptedBytes = sodium.seal(messageBytes, keyBytes);\n\n// Base64 the encrypted secret\nconst encrypted = Buffer.from(encryptedBytes).toString('base64');\n\nconsole.log(encrypted);\n
    \n

    Example encrypting a secret using Python

    \n

    Encrypt your secret using pynacl with Python 3.

    \n
    from base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n  \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n  public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n  sealed_box = public.SealedBox(public_key)\n  encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n  return b64encode(encrypted).decode(\"utf-8\")\n
    \n

    Example encrypting a secret using C#

    \n

    Encrypt your secret using the Sodium.Core package.

    \n
    var secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\n
    \n

    Example encrypting a secret using Ruby

    \n

    Encrypt your secret using the rbnacl gem.

    \n
    require \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\n
    ", + "bodyParameters": [ + { + "type": "string", + "description": "

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an environment public key endpoint.

    ", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", + "name": "encrypted_value", + "in": "body", + "rawType": "string", + "rawDescription": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/github-ae@latest/rest/reference/actions#get-an-environment-public-key) endpoint.", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

    ID of the key you used to encrypt the secret.

    ", + "name": "key_id", + "in": "body", + "rawType": "string", + "rawDescription": "ID of the key you used to encrypt the secret.", + "childParamsGroups": [] + } + ] + }, + { + "verb": "delete", + "requestPath": "/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "repository_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "" + }, + { + "name": "environment_name", + "in": "path", + "required": true, + "description": "The name of the environment", + "schema": { + "type": "string" + }, + "descriptionHTML": "

    The name of the environment

    " + }, + { + "name": "secret_name", + "description": "secret_name parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    secret_name parameter

    " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/repositories/42/environments/ENVIRONMENT_NAME/secrets/SECRET_NAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/repositories/42/environments/ENVIRONMENT_NAME/secrets/SECRET_NAME
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('DELETE /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}', {\n repository_id: 42,\n environment_name: 'environment_name',\n secret_name: 'secret_name'\n})", + "html": "
    await octokit.request('DELETE /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}', {\n  repository_id: 42,\n  environment_name: 'environment_name',\n  secret_name: 'secret_name'\n})\n
    " + } + ], + "summary": "Delete an environment secret", + "description": "Deletes a secret in an environment using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-environment-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#delete-an-environment-secret" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "secrets" + }, + "slug": "delete-an-environment-secret", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "secrets", + "subcategoryLabel": "Secrets", + "notes": [], + "responses": [ + { + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Default Response" + } + ], + "bodyParameters": [], + "descriptionHTML": "

    Deletes a secret in an environment using the secret name. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use this endpoint.

    " + }, + { + "verb": "get", + "requestPath": "/scim/v2/enterprises/{enterprise}/Groups", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    The slug version of the enterprise name. You can also substitute this value with the enterprise id.

    " + }, + { + "name": "startIndex", + "description": "Used for pagination: the index of the first result to return.", + "in": "query", + "required": false, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

    Used for pagination: the index of the first result to return.

    " + }, + { + "name": "count", + "description": "Used for pagination: the number of results to return.", + "in": "query", + "required": false, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

    Used for pagination: the number of results to return.

    " + }, + { + "name": "filter", + "description": "filter results", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    filter results

    " + }, + { + "name": "excludedAttributes", + "description": "attributes to exclude", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    attributes to exclude

    " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/scim/v2/enterprises/ENTERPRISE/Groups", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/scim/v2/enterprises/ENTERPRISE/Groups
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /scim/v2/enterprises/{enterprise}/Groups', {\n enterprise: 'enterprise'\n})", + "html": "
    await octokit.request('GET /scim/v2/enterprises/{enterprise}/Groups', {\n  enterprise: 'enterprise'\n})\n
    " + } + ], + "summary": "List provisioned SCIM groups for an enterprise", + "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.", + "operationId": "enterprise-admin/list-provisioned-groups-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#list-provisioned-scim-groups-for-an-enterprise" + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": true, + "previews": [], + "category": "enterprise-admin", + "subcategory": "scim" + }, + "slug": "list-provisioned-scim-groups-for-an-enterprise", + "category": "enterprise-admin", + "categoryLabel": "Enterprise admin", + "subcategory": "scim", + "subcategoryLabel": "Scim", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

    Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.

    ", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
    {\n  \"schemas\": [\n    \"urn:ietf:params:scim:api:messages:2.0:ListResponse\"\n  ],\n  \"totalResults\": 2,\n  \"itemsPerPage\": 2,\n  \"startIndex\": 1,\n  \"Resources\": [\n    {\n      \"schemas\": [\n        \"urn:ietf:params:scim:schemas:core:2.0:Group\"\n      ],\n      \"id\": \"abcd27f8-a9aa-11ea-8221-f59b2be9cccc\",\n      \"externalId\": null,\n      \"displayName\": \"octo-org\",\n      \"members\": [\n        {\n          \"value\": \"92b58aaa-a1d6-11ea-8227-b9ce9e023ccc\",\n          \"$ref\": \"https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc\",\n          \"display\": \"octocat@github.com\"\n        },\n        {\n          \"value\": \"aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5\",\n          \"$ref\": \"https://api.github.com/scim/v2/enterprises/octo-corp/Users/aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5\",\n          \"display\": \"hubot@example.com\"\n        }\n      ],\n      \"meta\": {\n        \"resourceType\": \"Group\",\n        \"created\": \"2020-06-09T03:10:17.000+10:00\",\n        \"lastModified\": \"2020-06-09T03:10:17.000+10:00\",\n        \"location\": \"https://api.github.com/scim/v2/enterprises/octo-corp/Groups/abcd27f8-a9aa-11ea-8221-f59b2be9cccc\"\n      }\n    },\n    {\n      \"schemas\": [\n        \"urn:ietf:params:scim:schemas:core:2.0:Group\"\n      ],\n      \"id\": \"5e75bbbb-aa1a-11ea-8644-75ff655cdddd\",\n      \"externalId\": null,\n      \"displayName\": \"octo-docs-org\",\n      \"members\": [\n        {\n          \"value\": \"92b58aaa-a1d6-11ea-8227-b9ce9e023ccc\",\n          \"$ref\": \"https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc\",\n          \"display\": \"octocat@github.com\"\n        }\n      ],\n      \"meta\": {\n        \"resourceType\": \"Group\",\n        \"created\": \"2020-06-09T16:28:01.000+10:00\",\n        \"lastModified\": \"2020-06-09T16:28:01.000+10:00\",\n        \"location\": \"https://api.github.com/scim/v2/enterprises/octo-corp/Groups/5e75bbbb-aa1a-11ea-8644-75ff655cdddd\"\n      }\n    }\n  ]\n}\n
    " + } + ] + }, + { + "verb": "post", + "requestPath": "/scim/v2/enterprises/{enterprise}/Groups", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    The slug version of the enterprise name. You can also substitute this value with the enterprise id.

    " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/scim/v2/enterprises/ENTERPRISE/Groups \\\n -d '{\"schemas\":[\"schemas\"],\"displayName\":\"displayName\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/scim/v2/enterprises/ENTERPRISE/Groups \\\n  -d '{\"schemas\":[\"schemas\"],\"displayName\":\"displayName\"}'
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('POST /scim/v2/enterprises/{enterprise}/Groups', {\n enterprise: 'enterprise',\n schemas: [\n 'schemas'\n ],\n displayName: 'displayName'\n})", + "html": "
    await octokit.request('POST /scim/v2/enterprises/{enterprise}/Groups', {\n  enterprise: 'enterprise',\n  schemas: [\n    'schemas'\n  ],\n  displayName: 'displayName'\n})\n
    " + } + ], + "summary": "Provision a SCIM enterprise group and invite users", + "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.\n\nProvision an enterprise group, and invite users to the group. This sends invitation emails to the email address of the invited users to join the GitHub organization that the SCIM group corresponds to.", + "operationId": "enterprise-admin/provision-and-invite-enterprise-group", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#provision-a-scim-enterprise-group-and-invite-users" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "schemas": { + "type": "array of strings", + "description": "

    Required. The SCIM schema URIs.

    ", + "items": { + "type": "string" + }, + "name": "schemas", + "in": "body", + "rawType": "array", + "rawDescription": "The SCIM schema URIs.", + "childParamsGroups": [] + }, + "displayName": { + "type": "string", + "description": "

    Required. The name of the SCIM group. This must match the GitHub organization that the group maps to.

    ", + "name": "displayName", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the SCIM group. This must match the GitHub organization that the group maps to.", + "childParamsGroups": [] + }, + "members": { + "type": "array of objects", + "items": { + "type": "object", + "properties": { + "value": { + "type": "string", + "description": "

    Required. The SCIM user ID for a user.

    ", + "name": "value", + "in": "body", + "rawType": "string", + "rawDescription": "The SCIM user ID for a user.", + "childParamsGroups": [] + } + }, + "required": [ + "value" + ] + }, + "name": "members", + "in": "body", + "rawType": "array", + "description": "

    undefined

    ", + "childParamsGroups": [ + { + "parentName": "members", + "parentType": "items", + "id": "members-items", + "params": [ + { + "type": "string", + "description": "

    Required. The SCIM user ID for a user.

    ", + "name": "value", + "in": "body", + "rawType": "string", + "rawDescription": "The SCIM user ID for a user.", + "childParamsGroups": [] + } + ] + } + ] + } + }, + "required": [ + "schemas", + "displayName" + ] + }, + "example": { + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ], + "displayName": "octo-org", + "members": [ + { + "value": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc" + }, + { + "value": "aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5" + } + ] + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": true, + "previews": [], + "category": "enterprise-admin", + "subcategory": "scim" + }, + "slug": "provision-a-scim-enterprise-group-and-invite-users", + "category": "enterprise-admin", + "categoryLabel": "Enterprise admin", + "subcategory": "scim", + "subcategoryLabel": "Scim", + "notes": [], + "descriptionHTML": "

    Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.

    \n

    Provision an enterprise group, and invite users to the group. This sends invitation emails to the email address of the invited users to join the GitHub organization that the SCIM group corresponds to.

    ", + "responses": [ + { + "httpStatusCode": "201", + "httpStatusMessage": "Created", + "description": "Default response", + "payload": "
    {\n  \"schemas\": [\n    \"urn:ietf:params:scim:schemas:core:2.0:Group\"\n  ],\n  \"id\": \"abcd27f8-a9aa-11ea-8221-f59b2be9cccc\",\n  \"externalId\": null,\n  \"displayName\": \"octo-org\",\n  \"members\": [\n    {\n      \"value\": \"92b58aaa-a1d6-11ea-8227-b9ce9e023ccc\",\n      \"$ref\": \"https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc\",\n      \"display\": \"octocat@github.com\"\n    },\n    {\n      \"value\": \"aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5\",\n      \"$ref\": \"https://api.github.com/scim/v2/enterprises/octo-corp/Users/aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5\",\n      \"display\": \"hubot@example.com\"\n    }\n  ],\n  \"meta\": {\n    \"resourceType\": \"Group\",\n    \"created\": \"2020-06-09T03:10:17.000+10:0\",\n    \"lastModified\": \"2020-06-09T03:10:17.000+10:00\",\n    \"location\": \"https://api.github.com/scim/v2/enterprises/octo-corp/Groups/abcd27f8-a9aa-11ea-8221-f59b2be9cccc\"\n  }\n}\n
    " + } + ], + "bodyParameters": [ + { + "type": "array of strings", + "description": "

    Required. The SCIM schema URIs.

    ", + "items": { + "type": "string" + }, + "name": "schemas", + "in": "body", + "rawType": "array", + "rawDescription": "The SCIM schema URIs.", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

    Required. The name of the SCIM group. This must match the GitHub organization that the group maps to.

    ", + "name": "displayName", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the SCIM group. This must match the GitHub organization that the group maps to.", + "childParamsGroups": [] + }, + { + "type": "array of objects", + "items": { + "type": "object", + "properties": { + "value": { + "type": "string", + "description": "

    Required. The SCIM user ID for a user.

    ", + "name": "value", + "in": "body", + "rawType": "string", + "rawDescription": "The SCIM user ID for a user.", + "childParamsGroups": [] + } + }, + "required": [ + "value" + ] + }, + "name": "members", + "in": "body", + "rawType": "array", + "description": "

    undefined

    ", + "childParamsGroups": [ + { + "parentName": "members", + "parentType": "items", + "id": "members-items", + "params": [ + { + "type": "string", + "description": "

    Required. The SCIM user ID for a user.

    ", + "name": "value", + "in": "body", + "rawType": "string", + "rawDescription": "The SCIM user ID for a user.", + "childParamsGroups": [] + } + ] + } + ] + } + ] + }, + { + "verb": "get", + "requestPath": "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    The slug version of the enterprise name. You can also substitute this value with the enterprise id.

    " + }, + { + "name": "scim_group_id", + "description": "Identifier generated by the GitHub SCIM endpoint.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    Identifier generated by the GitHub SCIM endpoint.

    " + }, + { + "name": "excludedAttributes", + "description": "Attributes to exclude.", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    Attributes to exclude.

    " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/scim/v2/enterprises/ENTERPRISE/Groups/SCIM_GROUP_ID", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/scim/v2/enterprises/ENTERPRISE/Groups/SCIM_GROUP_ID
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}', {\n enterprise: 'enterprise',\n scim_group_id: 'scim_group_id'\n})", + "html": "
    await octokit.request('GET /scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}', {\n  enterprise: 'enterprise',\n  scim_group_id: 'scim_group_id'\n})\n
    " + } + ], + "summary": "Get SCIM provisioning information for an enterprise group", + "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.", + "operationId": "enterprise-admin/get-provisioning-information-for-enterprise-group", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#get-scim-provisioning-information-for-an-enterprise-group" + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": true, + "previews": [], + "category": "enterprise-admin", + "subcategory": "scim" + }, + "slug": "get-scim-provisioning-information-for-an-enterprise-group", + "category": "enterprise-admin", + "categoryLabel": "Enterprise admin", + "subcategory": "scim", + "subcategoryLabel": "Scim", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

    Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.

    ", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
    {\n  \"schemas\": [\n    \"urn:ietf:params:scim:schemas:core:2.0:Group\"\n  ],\n  \"id\": \"abcd27f8-a9aa-11ea-8221-f59b2be9cccc\",\n  \"externalId\": null,\n  \"displayName\": \"octo-org\",\n  \"members\": [\n    {\n      \"value\": \"92b58aaa-a1d6-11ea-8227-b9ce9e023ccc\",\n      \"$ref\": \"https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc\",\n      \"display\": \"octocat@github.com\"\n    },\n    {\n      \"value\": \"aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5\",\n      \"$ref\": \"https://api.github.com/scim/v2/enterprises/octo-corp/Users/aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5\",\n      \"display\": \"hubot@example.com\"\n    }\n  ],\n  \"meta\": {\n    \"resourceType\": \"Group\",\n    \"created\": \"2020-06-09T03:10:17.000+10:0\",\n    \"lastModified\": \"2020-06-09T03:10:17.000+10:00\",\n    \"location\": \"https://api.github.com/scim/v2/enterprises/octo-corp/Groups/abcd27f8-a9aa-11ea-8221-f59b2be9cccc\"\n  }\n}\n
    " + } + ] + }, + { + "verb": "put", + "requestPath": "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    The slug version of the enterprise name. You can also substitute this value with the enterprise id.

    " + }, + { + "name": "scim_group_id", + "description": "Identifier generated by the GitHub SCIM endpoint.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    Identifier generated by the GitHub SCIM endpoint.

    " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/scim/v2/enterprises/ENTERPRISE/Groups/SCIM_GROUP_ID \\\n -d '{\"schemas\":[\"schemas\"],\"displayName\":\"displayName\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/scim/v2/enterprises/ENTERPRISE/Groups/SCIM_GROUP_ID \\\n  -d '{\"schemas\":[\"schemas\"],\"displayName\":\"displayName\"}'
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('PUT /scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}', {\n enterprise: 'enterprise',\n scim_group_id: 'scim_group_id',\n schemas: [\n 'schemas'\n ],\n displayName: 'displayName'\n})", + "html": "
    await octokit.request('PUT /scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}', {\n  enterprise: 'enterprise',\n  scim_group_id: 'scim_group_id',\n  schemas: [\n    'schemas'\n  ],\n  displayName: 'displayName'\n})\n
    " + } + ], + "summary": "Set SCIM information for a provisioned enterprise group", + "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.\n\nReplaces an existing provisioned group’s information. You must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the [Update an attribute for a SCIM enterprise group](#update-an-attribute-for-a-scim-enterprise-group) endpoint instead.", + "operationId": "enterprise-admin/set-information-for-provisioned-enterprise-group", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#set-scim-information-for-a-provisioned-enterprise-group" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "schemas": { + "type": "array of strings", + "description": "

    Required. The SCIM schema URIs.

    ", + "items": { + "type": "string" + }, + "name": "schemas", + "in": "body", + "rawType": "array", + "rawDescription": "The SCIM schema URIs.", + "childParamsGroups": [] + }, + "displayName": { + "type": "string", + "description": "

    Required. The name of the SCIM group. This must match the GitHub organization that the group maps to.

    ", + "name": "displayName", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the SCIM group. This must match the GitHub organization that the group maps to.", + "childParamsGroups": [] + }, + "members": { + "type": "array of objects", + "items": { + "type": "object", + "properties": { + "value": { + "type": "string", + "description": "

    Required. The SCIM user ID for a user.

    ", + "name": "value", + "in": "body", + "rawType": "string", + "rawDescription": "The SCIM user ID for a user.", + "childParamsGroups": [] + } + }, + "required": [ + "value" + ] + }, + "name": "members", + "in": "body", + "rawType": "array", + "description": "

    undefined

    ", + "childParamsGroups": [ + { + "parentName": "members", + "parentType": "items", + "id": "members-items", + "params": [ + { + "type": "string", + "description": "

    Required. The SCIM user ID for a user.

    ", + "name": "value", + "in": "body", + "rawType": "string", + "rawDescription": "The SCIM user ID for a user.", + "childParamsGroups": [] + } + ] + } + ] + } + }, + "required": [ + "schemas", + "displayName" + ] + }, + "example": { + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ], + "displayName": "octo-org", + "members": [ + { + "value": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc" + }, + { + "value": "aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5" + } + ] + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": true, + "previews": [], + "category": "enterprise-admin", + "subcategory": "scim" + }, + "slug": "set-scim-information-for-a-provisioned-enterprise-group", + "category": "enterprise-admin", + "categoryLabel": "Enterprise admin", + "subcategory": "scim", + "subcategoryLabel": "Scim", + "notes": [], + "descriptionHTML": "

    Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.

    \n

    Replaces an existing provisioned group’s information. You must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the Update an attribute for a SCIM enterprise group endpoint instead.

    ", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
    {\n  \"schemas\": [\n    \"urn:ietf:params:scim:schemas:core:2.0:Group\"\n  ],\n  \"id\": \"abcd27f8-a9aa-11ea-8221-f59b2be9cccc\",\n  \"externalId\": null,\n  \"displayName\": \"octo-org\",\n  \"members\": [\n    {\n      \"value\": \"92b58aaa-a1d6-11ea-8227-b9ce9e023ccc\",\n      \"$ref\": \"https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc\",\n      \"display\": \"octocat@github.com\"\n    },\n    {\n      \"value\": \"aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5\",\n      \"$ref\": \"https://api.github.com/scim/v2/enterprises/octo-corp/Users/aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5\",\n      \"display\": \"hubot@example.com\"\n    }\n  ],\n  \"meta\": {\n    \"resourceType\": \"Group\",\n    \"created\": \"2020-06-09T03:10:17.000+10:0\",\n    \"lastModified\": \"2020-06-09T03:10:17.000+10:00\",\n    \"location\": \"https://api.github.com/scim/v2/enterprises/octo-corp/Groups/abcd27f8-a9aa-11ea-8221-f59b2be9cccc\"\n  }\n}\n
    " + } + ], + "bodyParameters": [ + { + "type": "array of strings", + "description": "

    Required. The SCIM schema URIs.

    ", + "items": { + "type": "string" + }, + "name": "schemas", + "in": "body", + "rawType": "array", + "rawDescription": "The SCIM schema URIs.", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

    Required. The name of the SCIM group. This must match the GitHub organization that the group maps to.

    ", + "name": "displayName", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the SCIM group. This must match the GitHub organization that the group maps to.", + "childParamsGroups": [] + }, + { + "type": "array of objects", + "items": { + "type": "object", + "properties": { + "value": { + "type": "string", + "description": "

    Required. The SCIM user ID for a user.

    ", + "name": "value", + "in": "body", + "rawType": "string", + "rawDescription": "The SCIM user ID for a user.", + "childParamsGroups": [] + } + }, + "required": [ + "value" + ] + }, + "name": "members", + "in": "body", + "rawType": "array", + "description": "

    undefined

    ", + "childParamsGroups": [ + { + "parentName": "members", + "parentType": "items", + "id": "members-items", + "params": [ + { + "type": "string", + "description": "

    Required. The SCIM user ID for a user.

    ", + "name": "value", + "in": "body", + "rawType": "string", + "rawDescription": "The SCIM user ID for a user.", + "childParamsGroups": [] + } + ] + } + ] + } + ] + }, + { + "verb": "patch", + "requestPath": "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    The slug version of the enterprise name. You can also substitute this value with the enterprise id.

    " + }, + { + "name": "scim_group_id", + "description": "Identifier generated by the GitHub SCIM endpoint.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    Identifier generated by the GitHub SCIM endpoint.

    " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/scim/v2/enterprises/ENTERPRISE/Groups/SCIM_GROUP_ID \\\n -d '{\"schemas\":[\"schemas\"],\"Operations\":[{\"op\":\"op\",\"path\":\"path\",\"value\":\"value\"}]}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/scim/v2/enterprises/ENTERPRISE/Groups/SCIM_GROUP_ID \\\n  -d '{\"schemas\":[\"schemas\"],\"Operations\":[{\"op\":\"op\",\"path\":\"path\",\"value\":\"value\"}]}'
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('PATCH /scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}', {\n enterprise: 'enterprise',\n scim_group_id: 'scim_group_id',\n schemas: [\n 'schemas'\n ],\n Operations: [\n {\n op: 'op',\n path: 'path',\n value: 'value'\n }\n ]\n})", + "html": "
    await octokit.request('PATCH /scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}', {\n  enterprise: 'enterprise',\n  scim_group_id: 'scim_group_id',\n  schemas: [\n    'schemas'\n  ],\n  Operations: [\n    {\n      op: 'op',\n      path: 'path',\n      value: 'value'\n    }\n  ]\n})\n
    " + } + ], + "summary": "Update an attribute for a SCIM enterprise group", + "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.\n\nAllows you to change a provisioned group’s individual attributes. To change a group’s values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2).", + "operationId": "enterprise-admin/update-attribute-for-enterprise-group", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#update-an-attribute-for-a-scim-enterprise-group" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "schemas": { + "type": "array of strings", + "description": "

    Required. The SCIM schema URIs.

    ", + "items": { + "type": "string" + }, + "name": "schemas", + "in": "body", + "rawType": "array", + "rawDescription": "The SCIM schema URIs.", + "childParamsGroups": [] + }, + "Operations": { + "type": "array of objects", + "description": "

    Required. Array of SCIM operations.

    ", + "minItems": 1, + "items": { + "type": "object", + "properties": { + "op": { + "type": "string", + "enum": [ + "add", + "Add", + "remove", + "Remove", + "replace", + "Replace" + ], + "name": "op", + "in": "body", + "rawType": "string", + "description": "

    Required. undefined

    ", + "childParamsGroups": [] + }, + "path": { + "type": "string", + "name": "path", + "in": "body", + "rawType": "string", + "description": "

    undefined

    ", + "childParamsGroups": [] + }, + "value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object" + }, + { + "type": "array" + } + ], + "name": "value", + "in": "body", + "description": "

    undefined

    ", + "childParamsGroups": [] + } + }, + "required": [ + "op" + ] + }, + "name": "Operations", + "in": "body", + "rawType": "array", + "rawDescription": "Array of [SCIM operations](https://tools.ietf.org/html/rfc7644#section-3.5.2).", + "childParamsGroups": [ + { + "parentName": "Operations", + "parentType": "items", + "id": "operations-items", + "params": [ + { + "type": "string", + "enum": [ + "add", + "Add", + "remove", + "Remove", + "replace", + "Replace" + ], + "name": "op", + "in": "body", + "rawType": "string", + "description": "

    Required. undefined

    ", + "childParamsGroups": [] + }, + { + "type": "string", + "name": "path", + "in": "body", + "rawType": "string", + "description": "

    undefined

    ", + "childParamsGroups": [] + }, + { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object" + }, + { + "type": "array" + } + ], + "name": "value", + "in": "body", + "description": "

    undefined

    ", + "childParamsGroups": [] + } + ] + } + ] + } + }, + "required": [ + "schemas", + "Operations" + ] + }, + "example": { + "schemas": [ + "urn:ietf:params:scim:api:messages:2.0:PatchOp" + ], + "Operations": [ + { + "op": "remove", + "path": "members", + "value": [ + { + "value": "aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5" + } + ] + } + ] + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": true, + "previews": [], + "category": "enterprise-admin", + "subcategory": "scim" + }, + "slug": "update-an-attribute-for-a-scim-enterprise-group", + "category": "enterprise-admin", + "categoryLabel": "Enterprise admin", + "subcategory": "scim", + "subcategoryLabel": "Scim", + "notes": [], + "descriptionHTML": "

    Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.

    \n

    Allows you to change a provisioned group’s individual attributes. To change a group’s values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the SCIM specification.

    ", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
    {\n  \"schemas\": [\n    \"urn:ietf:params:scim:schemas:core:2.0:Group\"\n  ],\n  \"id\": \"abcd27f8-a9aa-11ea-8221-f59b2be9cccc\",\n  \"externalId\": null,\n  \"displayName\": \"octo-org\",\n  \"members\": [\n    {\n      \"value\": \"92b58aaa-a1d6-11ea-8227-b9ce9e023ccc\",\n      \"$ref\": \"https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc\",\n      \"display\": \"octocat@github.com\"\n    }\n  ],\n  \"meta\": {\n    \"resourceType\": \"Group\",\n    \"created\": \"2020-06-09T03:10:17.000+10:00\",\n    \"lastModified\": \"2020-06-09T03:10:17.000+10:00\",\n    \"location\": \"https://api.github.com/scim/v2/enterprises/octo-corp/Groups/abcd27f8-a9aa-11ea-8221-f59b2be9cccc\"\n  }\n}\n
    " + } + ], + "bodyParameters": [ + { + "type": "array of strings", + "description": "

    Required. The SCIM schema URIs.

    ", + "items": { + "type": "string" + }, + "name": "schemas", + "in": "body", + "rawType": "array", + "rawDescription": "The SCIM schema URIs.", + "childParamsGroups": [] + }, + { + "type": "array of objects", + "description": "

    Required. Array of SCIM operations.

    ", + "minItems": 1, + "items": { + "type": "object", + "properties": { + "op": { + "type": "string", + "enum": [ + "add", + "Add", + "remove", + "Remove", + "replace", + "Replace" + ], + "name": "op", + "in": "body", + "rawType": "string", + "description": "

    Required. undefined

    ", + "childParamsGroups": [] + }, + "path": { + "type": "string", + "name": "path", + "in": "body", + "rawType": "string", + "description": "

    undefined

    ", + "childParamsGroups": [] + }, + "value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object" + }, + { + "type": "array" + } + ], + "name": "value", + "in": "body", + "description": "

    undefined

    ", + "childParamsGroups": [] + } + }, + "required": [ + "op" + ] + }, + "name": "Operations", + "in": "body", + "rawType": "array", + "rawDescription": "Array of [SCIM operations](https://tools.ietf.org/html/rfc7644#section-3.5.2).", + "childParamsGroups": [ + { + "parentName": "Operations", + "parentType": "items", + "id": "operations-items", + "params": [ + { + "type": "string", + "enum": [ + "add", + "Add", + "remove", + "Remove", + "replace", + "Replace" + ], + "name": "op", + "in": "body", + "rawType": "string", + "description": "

    Required. undefined

    ", + "childParamsGroups": [] + }, + { + "type": "string", + "name": "path", + "in": "body", + "rawType": "string", + "description": "

    undefined

    ", + "childParamsGroups": [] + }, + { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object" + }, + { + "type": "array" + } + ], + "name": "value", + "in": "body", + "description": "

    undefined

    ", + "childParamsGroups": [] + } + ] + } + ] + } + ] + }, + { + "verb": "delete", + "requestPath": "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    The slug version of the enterprise name. You can also substitute this value with the enterprise id.

    " + }, + { + "name": "scim_group_id", + "description": "Identifier generated by the GitHub SCIM endpoint.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

    Identifier generated by the GitHub SCIM endpoint.

    " + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/scim/v2/enterprises/ENTERPRISE/Groups/SCIM_GROUP_ID", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/scim/v2/enterprises/ENTERPRISE/Groups/SCIM_GROUP_ID
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('DELETE /scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}', {\n enterprise: 'enterprise',\n scim_group_id: 'scim_group_id'\n})", + "html": "
    await octokit.request('DELETE /scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}', {\n  enterprise: 'enterprise',\n  scim_group_id: 'scim_group_id'\n})\n
    " + } + ], + "summary": "Delete a SCIM group from an enterprise", + "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.", + "operationId": "enterprise-admin/delete-scim-group-from-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#delete-a-scim-group-from-an-enterprise" + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": true, + "previews": [], + "category": "enterprise-admin", + "subcategory": "scim" + }, + "slug": "delete-a-scim-group-from-an-enterprise", + "category": "enterprise-admin", + "categoryLabel": "Enterprise admin", + "subcategory": "scim", + "subcategoryLabel": "Scim", + "notes": [], + "responses": [ + { + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Response" + } + ], + "bodyParameters": [], + "descriptionHTML": "

    Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.

    " + }, { "verb": "get", "requestPath": "/search/code", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "q", @@ -56558,8 +67527,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/search/code", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/search/code
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/search/code", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/search/code
    " }, { "lang": "JavaScript", @@ -56622,7 +67591,7 @@ { "verb": "get", "requestPath": "/search/commits", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "q", @@ -56687,8 +67656,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.cloak-preview+json\" \\\n https://api.github.com/search/commits", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.cloak-preview+json\" \\\n  https://api.github.com/search/commits
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.cloak-preview+json\" \\\n http(s)://api.{hostname}/search/commits", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.cloak-preview+json\" \\\n  http(s)://api.{hostname}/search/commits
    " }, { "lang": "JavaScript", @@ -56748,7 +67717,7 @@ { "verb": "get", "requestPath": "/search/issues", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "q", @@ -56822,8 +67791,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/search/issues", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/search/issues
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/search/issues", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/search/issues
    " }, { "lang": "JavaScript", @@ -56886,7 +67855,7 @@ { "verb": "get", "requestPath": "/search/labels", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "repository_id", @@ -56941,8 +67910,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/search/labels", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/search/labels
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/search/labels", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/search/labels
    " }, { "lang": "JavaScript", @@ -57005,7 +67974,7 @@ { "verb": "get", "requestPath": "/search/repositories", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "q", @@ -57072,8 +68041,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/search/repositories", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/search/repositories
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/search/repositories", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/search/repositories
    " }, { "lang": "JavaScript", @@ -57138,7 +68107,7 @@ { "verb": "get", "requestPath": "/search/topics", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "q", @@ -57154,8 +68123,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n https://api.github.com/search/topics", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n  https://api.github.com/search/topics
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n http(s)://api.{hostname}/search/topics", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n  http(s)://api.{hostname}/search/topics
    " }, { "lang": "JavaScript", @@ -57215,7 +68184,7 @@ { "verb": "get", "requestPath": "/search/users", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "q", @@ -57281,8 +68250,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/search/users", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/search/users
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/search/users", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/search/users
    " }, { "lang": "JavaScript", @@ -57340,7 +68309,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "team_id", @@ -57355,8 +68324,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/teams/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/teams/42
    " }, { "lang": "JavaScript", @@ -57407,7 +68376,7 @@ { "verb": "patch", "requestPath": "/teams/{team_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "team_id", @@ -57422,8 +68391,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42 \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42 \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/teams/42 \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/teams/42 \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -57616,7 +68585,7 @@ { "verb": "delete", "requestPath": "/teams/{team_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "team_id", @@ -57631,8 +68600,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/teams/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/teams/42
    " }, { "lang": "JavaScript", @@ -57668,7 +68637,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -57687,7 +68656,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/discussions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "team_id", @@ -57737,8 +68706,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/discussions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/teams/42/discussions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/teams/42/discussions
    " }, { "lang": "JavaScript", @@ -57793,7 +68762,7 @@ { "verb": "post", "requestPath": "/teams/{team_id}/discussions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "team_id", @@ -57808,8 +68777,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions \\\n -d '{\"title\":\"title\",\"body\":\"body\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/discussions \\\n  -d '{\"title\":\"title\",\"body\":\"body\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/teams/42/discussions \\\n -d '{\"title\":\"title\",\"body\":\"body\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/teams/42/discussions \\\n  -d '{\"title\":\"title\",\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -57941,7 +68910,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/discussions/{discussion_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "team_id", @@ -57965,8 +68934,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/discussions/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/teams/42/discussions/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/teams/42/discussions/42
    " }, { "lang": "JavaScript", @@ -58021,7 +68990,7 @@ { "verb": "patch", "requestPath": "/teams/{team_id}/discussions/{discussion_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "team_id", @@ -58045,8 +69014,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions/42 \\\n -d '{\"title\":\"title\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/discussions/42 \\\n  -d '{\"title\":\"title\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/teams/42/discussions/42 \\\n -d '{\"title\":\"title\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/teams/42/discussions/42 \\\n  -d '{\"title\":\"title\"}'
    " }, { "lang": "JavaScript", @@ -58152,7 +69121,7 @@ { "verb": "delete", "requestPath": "/teams/{team_id}/discussions/{discussion_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "team_id", @@ -58176,8 +69145,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/discussions/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/teams/42/discussions/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/teams/42/discussions/42
    " }, { "lang": "JavaScript", @@ -58215,7 +69184,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -58224,7 +69193,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "team_id", @@ -58283,8 +69252,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions/42/comments", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/discussions/42/comments
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/teams/42/discussions/42/comments", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/teams/42/discussions/42/comments
    " }, { "lang": "JavaScript", @@ -58339,7 +69308,7 @@ { "verb": "post", "requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "team_id", @@ -58363,8 +69332,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions/42/comments \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/discussions/42/comments \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/teams/42/discussions/42/comments \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/teams/42/discussions/42/comments \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -58456,7 +69425,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "team_id", @@ -58489,8 +69458,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions/42/comments/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/discussions/42/comments/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/teams/42/discussions/42/comments/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/teams/42/discussions/42/comments/42
    " }, { "lang": "JavaScript", @@ -58545,7 +69514,7 @@ { "verb": "patch", "requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "team_id", @@ -58578,8 +69547,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions/42/comments/42 \\\n -d '{\"body\":\"body\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/discussions/42/comments/42 \\\n  -d '{\"body\":\"body\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/teams/42/discussions/42/comments/42 \\\n -d '{\"body\":\"body\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/teams/42/discussions/42/comments/42 \\\n  -d '{\"body\":\"body\"}'
    " }, { "lang": "JavaScript", @@ -58670,7 +69639,7 @@ { "verb": "delete", "requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "team_id", @@ -58703,8 +69672,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions/42/comments/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/discussions/42/comments/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/teams/42/discussions/42/comments/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/teams/42/discussions/42/comments/42
    " }, { "lang": "JavaScript", @@ -58742,7 +69711,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -58751,7 +69720,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "team_id", @@ -58824,8 +69793,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/teams/42/discussions/42/comments/42/reactions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/teams/42/discussions/42/comments/42/reactions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://api.{hostname}/teams/42/discussions/42/comments/42/reactions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://api.{hostname}/teams/42/discussions/42/comments/42/reactions
    " }, { "lang": "JavaScript", @@ -58878,7 +69847,7 @@ { "verb": "post", "requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "team_id", @@ -58911,8 +69880,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/teams/42/discussions/42/comments/42/reactions \\\n -d '{\"content\":\"content\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/teams/42/discussions/42/comments/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://api.{hostname}/teams/42/discussions/42/comments/42/reactions \\\n -d '{\"content\":\"content\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://api.{hostname}/teams/42/discussions/42/comments/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " }, { "lang": "JavaScript", @@ -59021,7 +69990,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/discussions/{discussion_number}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "team_id", @@ -59085,8 +70054,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/teams/42/discussions/42/reactions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/teams/42/discussions/42/reactions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://api.{hostname}/teams/42/discussions/42/reactions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://api.{hostname}/teams/42/discussions/42/reactions
    " }, { "lang": "JavaScript", @@ -59139,7 +70108,7 @@ { "verb": "post", "requestPath": "/teams/{team_id}/discussions/{discussion_number}/reactions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "team_id", @@ -59163,8 +70132,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/teams/42/discussions/42/reactions \\\n -d '{\"content\":\"content\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/teams/42/discussions/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n http(s)://api.{hostname}/teams/42/discussions/42/reactions \\\n -d '{\"content\":\"content\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  http(s)://api.{hostname}/teams/42/discussions/42/reactions \\\n  -d '{\"content\":\"content\"}'
    " }, { "lang": "JavaScript", @@ -59273,7 +70242,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/members", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "team_id", @@ -59324,8 +70293,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/members", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/members
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/teams/42/members", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/teams/42/members
    " }, { "lang": "JavaScript", @@ -59378,7 +70347,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/members/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "team_id", @@ -59402,8 +70371,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/members/USERNAME", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/members/USERNAME
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/teams/42/members/USERNAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/teams/42/members/USERNAME
    " }, { "lang": "JavaScript", @@ -59455,7 +70424,7 @@ { "verb": "put", "requestPath": "/teams/{team_id}/members/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "team_id", @@ -59479,8 +70448,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/members/USERNAME", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/members/USERNAME
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/teams/42/members/USERNAME", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/teams/42/members/USERNAME
    " }, { "lang": "JavaScript", @@ -59514,13 +70483,11 @@ "subcategory": "members", "subcategoryLabel": "Members", "notes": [], - "bodyParameters": [], - "descriptionHTML": "

    The \"Add team member\" endpoint (described below) is deprecated.

    \n

    We recommend using the Add or update team membership for a user endpoint instead. It allows you to invite new organization members to your teams.

    \n

    Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

    \n

    To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.

    \n

    Note: When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub AE team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub AE.\"

    \n

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

    ", "responses": [ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -59535,21 +70502,16 @@ { "httpStatusCode": "422", "httpStatusMessage": "Unprocessable Entity", - "description": "Response if you attempt to add an organization to a team", - "payload": "
    {\n  \"message\": \"Cannot add an organization as a member.\",\n  \"errors\": [\n    {\n      \"code\": \"org\",\n      \"field\": \"user\",\n      \"resource\": \"TeamMember\"\n    }\n  ]\n}\n
    " - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Response if you attempt to add a user to a team when they are not a member of at least one other team in the same organization", - "payload": "
    {\n  \"message\": \"User isn't a member of this organization. Please invite them first.\",\n  \"errors\": [\n    {\n      \"code\": \"unaffiliated\",\n      \"field\": \"user\",\n      \"resource\": \"TeamMember\"\n    }\n  ]\n}\n
    " + "description": "Response if you attempt to add an organization to a team or you attempt to add a user to a team when they are not a member of at least one other team in the same organization" } - ] + ], + "bodyParameters": [], + "descriptionHTML": "

    The \"Add team member\" endpoint (described below) is deprecated.

    \n

    We recommend using the Add or update team membership for a user endpoint instead. It allows you to invite new organization members to your teams.

    \n

    Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

    \n

    To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.

    \n

    Note: When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub AE team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub AE.\"

    \n

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

    " }, { "verb": "delete", "requestPath": "/teams/{team_id}/members/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "team_id", @@ -59573,8 +70535,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/members/USERNAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/members/USERNAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/teams/42/members/USERNAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/teams/42/members/USERNAME
    " }, { "lang": "JavaScript", @@ -59612,7 +70574,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -59626,7 +70588,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/memberships/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "team_id", @@ -59650,8 +70612,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/memberships/USERNAME", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/memberships/USERNAME
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/teams/42/memberships/USERNAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/teams/42/memberships/USERNAME
    " }, { "lang": "JavaScript", @@ -59660,7 +70622,7 @@ } ], "summary": "Get team membership for a user (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 [Get team membership for a user](https://docs.github.com/github-ae@latest/rest/reference/teams#get-team-membership-for-a-user) endpoint.\n\nTeam members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:** The `role` for organization owners returns as `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/github-ae@latest/rest/reference/teams#create-a-team).", + "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 [Get team membership for a user](https://docs.github.com/github-ae@latest/rest/reference/teams#get-team-membership-for-a-user) endpoint.\n\nTeam members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:**\nThe response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/github-ae@latest/rest/reference/teams#create-a-team).", "tags": [ "teams" ], @@ -59686,26 +70648,14 @@ "subcategoryLabel": "Members", "notes": [], "bodyParameters": [], - "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 Get team membership for a user endpoint.

    \n

    Team members will include the members of child teams.

    \n

    To get a user's membership with a team, the team must be visible to the authenticated user.

    \n

    Note: The role for organization owners returns as maintainer. For more information about maintainer roles, see Create a team.

    ", + "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 Get team membership for a user endpoint.

    \n

    Team members will include the members of child teams.

    \n

    To get a user's membership with a team, the team must be visible to the authenticated user.

    \n

    Note:\nThe response contains the state of the membership and the member's role.

    \n

    The role for organization owners is set to maintainer. For more information about maintainer roles, see Create a team.

    ", "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response if user has an active membership with team", - "payload": "
    {\n  \"url\": \"https://api.github.com/teams/1/memberships/octocat\",\n  \"role\": \"member\",\n  \"state\": \"active\"\n}\n
    " - }, { "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Response if user is a team maintainer", "payload": "
    {\n  \"url\": \"https://api.github.com/teams/1/memberships/octocat\",\n  \"role\": \"maintainer\",\n  \"state\": \"active\"\n}\n
    " }, - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response if user has a pending membership with team", - "payload": "
    {\n  \"url\": \"https://api.github.com/teams/1/memberships/octocat\",\n  \"role\": \"member\",\n  \"state\": \"pending\"\n}\n
    " - }, { "httpStatusCode": "404", "httpStatusMessage": "Not Found", @@ -59716,7 +70666,7 @@ { "verb": "put", "requestPath": "/teams/{team_id}/memberships/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "team_id", @@ -59740,8 +70690,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/memberships/USERNAME \\\n -d '{\"role\":\"role\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/memberships/USERNAME \\\n  -d '{\"role\":\"role\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/teams/42/memberships/USERNAME \\\n -d '{\"role\":\"role\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/teams/42/memberships/USERNAME \\\n  -d '{\"role\":\"role\"}'
    " }, { "lang": "JavaScript", @@ -59818,12 +70768,6 @@ } ], "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response if user's membership with team is now active", - "payload": "
    {\n  \"url\": \"https://api.github.com/teams/1/memberships/octocat\",\n  \"role\": \"member\",\n  \"state\": \"active\"\n}\n
    " - }, { "httpStatusCode": "200", "httpStatusMessage": "OK", @@ -59843,15 +70787,14 @@ { "httpStatusCode": "422", "httpStatusMessage": "Unprocessable Entity", - "description": "Response if you attempt to add an organization to a team", - "payload": "
    {\n  \"message\": \"Cannot add an organization as a member.\",\n  \"errors\": [\n    {\n      \"code\": \"org\",\n      \"field\": \"user\",\n      \"resource\": \"TeamMember\"\n    }\n  ]\n}\n
    " + "description": "Response if you attempt to add an organization to a team" } ] }, { "verb": "delete", "requestPath": "/teams/{team_id}/memberships/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "team_id", @@ -59875,8 +70818,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/memberships/USERNAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/memberships/USERNAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/teams/42/memberships/USERNAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/teams/42/memberships/USERNAME
    " }, { "lang": "JavaScript", @@ -59914,7 +70857,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -59928,7 +70871,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/projects", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "team_id", @@ -59963,8 +70906,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/teams/42/projects", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/teams/42/projects
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://api.{hostname}/teams/42/projects", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://api.{hostname}/teams/42/projects
    " }, { "lang": "JavaScript", @@ -60027,7 +70970,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/projects/{project_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "team_id", @@ -60051,8 +70994,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/teams/42/projects/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/teams/42/projects/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://api.{hostname}/teams/42/projects/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://api.{hostname}/teams/42/projects/42
    " }, { "lang": "JavaScript", @@ -60115,7 +71058,7 @@ { "verb": "put", "requestPath": "/teams/{team_id}/projects/{project_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "team_id", @@ -60139,8 +71082,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/teams/42/projects/42 \\\n -d '{\"permission\":\"permission\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/teams/42/projects/42 \\\n  -d '{\"permission\":\"permission\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://api.{hostname}/teams/42/projects/42 \\\n -d '{\"permission\":\"permission\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://api.{hostname}/teams/42/projects/42 \\\n  -d '{\"permission\":\"permission\"}'
    " }, { "lang": "JavaScript", @@ -60225,7 +71168,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -60253,7 +71196,7 @@ { "verb": "delete", "requestPath": "/teams/{team_id}/projects/{project_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "team_id", @@ -60277,8 +71220,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/projects/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/projects/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/teams/42/projects/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/teams/42/projects/42
    " }, { "lang": "JavaScript", @@ -60314,7 +71257,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "404", @@ -60338,7 +71281,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/repos", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "team_id", @@ -60373,8 +71316,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/repos", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/repos
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/teams/42/repos", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/teams/42/repos
    " }, { "lang": "JavaScript", @@ -60425,7 +71368,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/repos/{owner}/{repo}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "team_id", @@ -60458,8 +71401,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/repos/octocat/hello-world", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/repos/octocat/hello-world
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/teams/42/repos/octocat/hello-world", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/teams/42/repos/octocat/hello-world
    " }, { "lang": "JavaScript", @@ -60514,7 +71457,7 @@ { "verb": "put", "requestPath": "/teams/{team_id}/repos/{owner}/{repo}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "team_id", @@ -60547,8 +71490,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/repos/octocat/hello-world \\\n -d '{\"permission\":\"permission\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/repos/octocat/hello-world \\\n  -d '{\"permission\":\"permission\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/teams/42/repos/octocat/hello-world \\\n -d '{\"permission\":\"permission\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/teams/42/repos/octocat/hello-world \\\n  -d '{\"permission\":\"permission\"}'
    " }, { "lang": "JavaScript", @@ -60609,7 +71552,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "403", @@ -60643,7 +71586,7 @@ { "verb": "delete", "requestPath": "/teams/{team_id}/repos/{owner}/{repo}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "team_id", @@ -60676,8 +71619,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/repos/octocat/hello-world", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/repos/octocat/hello-world
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/teams/42/repos/octocat/hello-world", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/teams/42/repos/octocat/hello-world
    " }, { "lang": "JavaScript", @@ -60713,7 +71656,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "bodyParameters": [], @@ -60722,7 +71665,7 @@ { "verb": "get", "requestPath": "/teams/{team_id}/teams", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "team_id", @@ -60757,8 +71700,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/teams", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/teams/42/teams
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/teams/42/teams", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/teams/42/teams
    " }, { "lang": "JavaScript", @@ -60819,13 +71762,13 @@ { "verb": "get", "requestPath": "/user", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/user", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/user
    " }, { "lang": "JavaScript", @@ -60889,13 +71832,13 @@ { "verb": "patch", "requestPath": "/user", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/user \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/user \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -61133,7 +72076,7 @@ { "verb": "get", "requestPath": "/user/followers", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "per_page", @@ -61159,8 +72102,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/followers", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/followers
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/user/followers", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/user/followers
    " }, { "lang": "JavaScript", @@ -61220,7 +72163,7 @@ { "verb": "get", "requestPath": "/user/following", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "per_page", @@ -61246,8 +72189,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/following", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/following
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/user/following", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/user/following
    " }, { "lang": "JavaScript", @@ -61307,7 +72250,7 @@ { "verb": "get", "requestPath": "/user/following/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "username", @@ -61322,8 +72265,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/following/USERNAME", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/following/USERNAME
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/user/following/USERNAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/user/following/USERNAME
    " }, { "lang": "JavaScript", @@ -61387,7 +72330,7 @@ { "verb": "put", "requestPath": "/user/following/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "username", @@ -61402,8 +72345,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/following/USERNAME", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/following/USERNAME
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/user/following/USERNAME", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/user/following/USERNAME
    " }, { "lang": "JavaScript", @@ -61438,7 +72381,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -61467,7 +72410,7 @@ { "verb": "delete", "requestPath": "/user/following/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "username", @@ -61482,8 +72425,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/following/USERNAME", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/following/USERNAME
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/user/following/USERNAME", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/user/following/USERNAME
    " }, { "lang": "JavaScript", @@ -61518,7 +72461,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -61547,7 +72490,7 @@ { "verb": "get", "requestPath": "/user/gpg_keys", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "per_page", @@ -61573,8 +72516,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/gpg_keys", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/gpg_keys
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/user/gpg_keys", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/user/gpg_keys
    " }, { "lang": "JavaScript", @@ -61639,13 +72582,13 @@ { "verb": "post", "requestPath": "/user/gpg_keys", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/gpg_keys \\\n -d '{\"armored_public_key\":\"armored_public_key\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/gpg_keys \\\n  -d '{\"armored_public_key\":\"armored_public_key\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/user/gpg_keys \\\n -d '{\"armored_public_key\":\"armored_public_key\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/user/gpg_keys \\\n  -d '{\"armored_public_key\":\"armored_public_key\"}'
    " }, { "lang": "JavaScript", @@ -61748,7 +72691,7 @@ { "verb": "get", "requestPath": "/user/gpg_keys/{gpg_key_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "gpg_key_id", @@ -61764,8 +72707,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/gpg_keys/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/gpg_keys/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/user/gpg_keys/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/user/gpg_keys/42
    " }, { "lang": "JavaScript", @@ -61830,7 +72773,7 @@ { "verb": "delete", "requestPath": "/user/gpg_keys/{gpg_key_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "gpg_key_id", @@ -61846,8 +72789,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/gpg_keys/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/gpg_keys/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/user/gpg_keys/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/user/gpg_keys/42
    " }, { "lang": "JavaScript", @@ -61882,7 +72825,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -61916,7 +72859,7 @@ { "verb": "get", "requestPath": "/user/installations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "per_page", @@ -61942,8 +72885,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/installations", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/installations
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/user/installations", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/user/installations
    " }, { "lang": "JavaScript", @@ -62008,7 +72951,7 @@ { "verb": "get", "requestPath": "/user/installations/{installation_id}/repositories", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "installation_id", @@ -62044,8 +72987,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/installations/42/repositories", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/installations/42/repositories
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/user/installations/42/repositories", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/user/installations/42/repositories
    " }, { "lang": "JavaScript", @@ -62112,7 +73055,7 @@ { "verb": "put", "requestPath": "/user/installations/{installation_id}/repositories/{repository_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "installation_id", @@ -62137,8 +73080,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/installations/42/repositories/42", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/installations/42/repositories/42
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/user/installations/42/repositories/42", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/user/installations/42/repositories/42
    " }, { "lang": "JavaScript", @@ -62173,7 +73116,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -62197,7 +73140,7 @@ { "verb": "delete", "requestPath": "/user/installations/{installation_id}/repositories/{repository_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "installation_id", @@ -62222,8 +73165,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/installations/42/repositories/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/installations/42/repositories/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/user/installations/42/repositories/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/user/installations/42/repositories/42
    " }, { "lang": "JavaScript", @@ -62258,7 +73201,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -62282,7 +73225,7 @@ { "verb": "get", "requestPath": "/user/issues", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "filter", @@ -62296,6 +73239,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -62393,8 +73337,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/issues", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/issues
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/user/issues", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/user/issues
    " }, { "lang": "JavaScript", @@ -62454,7 +73398,7 @@ { "verb": "get", "requestPath": "/user/keys", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "per_page", @@ -62480,8 +73424,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/keys", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/keys
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/user/keys", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/user/keys
    " }, { "lang": "JavaScript", @@ -62546,13 +73490,13 @@ { "verb": "post", "requestPath": "/user/keys", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/keys \\\n -d '{\"key\":\"key\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/keys \\\n  -d '{\"key\":\"key\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/user/keys \\\n -d '{\"key\":\"key\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/user/keys \\\n  -d '{\"key\":\"key\"}'
    " }, { "lang": "JavaScript", @@ -62677,7 +73621,7 @@ { "verb": "get", "requestPath": "/user/keys/{key_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "key_id", @@ -62693,8 +73637,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/keys/42", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/keys/42
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/user/keys/42", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/user/keys/42
    " }, { "lang": "JavaScript", @@ -62759,7 +73703,7 @@ { "verb": "delete", "requestPath": "/user/keys/{key_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "key_id", @@ -62775,8 +73719,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/keys/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/keys/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/user/keys/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/user/keys/42
    " }, { "lang": "JavaScript", @@ -62811,7 +73755,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -62840,7 +73784,7 @@ { "verb": "get", "requestPath": "/user/memberships/orgs", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "state", @@ -62880,8 +73824,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/memberships/orgs", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/memberships/orgs
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/user/memberships/orgs", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/user/memberships/orgs
    " }, { "lang": "JavaScript", @@ -62946,7 +73890,7 @@ { "verb": "get", "requestPath": "/user/memberships/orgs/{org}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "org", @@ -62961,8 +73905,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/memberships/orgs/ORG", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/memberships/orgs/ORG
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/user/memberships/orgs/ORG", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/user/memberships/orgs/ORG
    " }, { "lang": "JavaScript", @@ -63017,7 +73961,7 @@ { "verb": "patch", "requestPath": "/user/memberships/orgs/{org}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "org", @@ -63032,8 +73976,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/memberships/orgs/ORG \\\n -d '{\"state\":\"state\"}'", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/memberships/orgs/ORG \\\n  -d '{\"state\":\"state\"}'
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/user/memberships/orgs/ORG \\\n -d '{\"state\":\"state\"}'", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/user/memberships/orgs/ORG \\\n  -d '{\"state\":\"state\"}'
    " }, { "lang": "JavaScript", @@ -63135,7 +74079,7 @@ { "verb": "get", "requestPath": "/user/orgs", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "per_page", @@ -63161,8 +74105,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/orgs", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/orgs
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/user/orgs", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/user/orgs
    " }, { "lang": "JavaScript", @@ -63220,13 +74164,13 @@ { "verb": "post", "requestPath": "/user/projects", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/user/projects \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/user/projects \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://api.{hostname}/user/projects \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://api.{hostname}/user/projects \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -63358,11 +74302,11 @@ { "verb": "get", "requestPath": "/user/repos", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "visibility", - "description": "Can be one of `all`, `public`, or `private`.", + "description": "Can be one of `all`, `public`, or `private`. Note: For GitHub AE, can be one of `all`, `internal`, or `private`.", "in": "query", "required": false, "schema": { @@ -63374,7 +74318,7 @@ ], "default": "all" }, - "descriptionHTML": "

    Can be one of all, public, or private.

    " + "descriptionHTML": "

    Can be one of all, public, or private. Note: For GitHub AE, can be one of all, internal, or private.

    " }, { "name": "affiliation", @@ -63389,7 +74333,7 @@ }, { "name": "type", - "description": "Can be one of `all`, `owner`, `public`, `private`, `member`. Default: `all` \n \nWill cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.", + "description": "Can be one of `all`, `owner`, `public`, `private`, `member`. Note: For GitHub AE, can be one of `all`, `owner`, `internal`, `private`, `member`. Default: `all` \n \nWill cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.", "in": "query", "required": false, "schema": { @@ -63403,7 +74347,7 @@ ], "default": "all" }, - "descriptionHTML": "

    Can be one of all, owner, public, private, member. Default: all

    \n

    Will cause a 422 error if used in the same request as visibility or affiliation. Will cause a 422 error if used in the same request as visibility or affiliation.

    " + "descriptionHTML": "

    Can be one of all, owner, public, private, member. Note: For GitHub AE, can be one of all, owner, internal, private, member. Default: all

    \n

    Will cause a 422 error if used in the same request as visibility or affiliation. Will cause a 422 error if used in the same request as visibility or affiliation.

    " }, { "name": "sort", @@ -63480,8 +74424,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/repos", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/repos
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/user/repos", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/user/repos
    " }, { "lang": "JavaScript", @@ -63544,13 +74488,13 @@ { "verb": "post", "requestPath": "/user/repos", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/repos \\\n -d '{\"name\":\"name\"}'", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/repos \\\n  -d '{\"name\":\"name\"}'
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/user/repos \\\n -d '{\"name\":\"name\"}'", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/user/repos \\\n  -d '{\"name\":\"name\"}'
    " }, { "lang": "JavaScript", @@ -63559,7 +74503,7 @@ } ], "summary": "Create a repository for the authenticated user", - "description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", + "description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository.", "tags": [ "repos" ], @@ -63602,13 +74546,13 @@ "childParamsGroups": [] }, "private": { - "description": "

    Whether the repository is private or public.

    ", + "description": "

    Whether the repository is private.

    ", "default": false, "type": "boolean", "name": "private", "in": "body", "rawType": "boolean", - "rawDescription": "Whether the repository is private or public.", + "rawDescription": "Whether the repository is private.", "childParamsGroups": [] }, "has_issues": { @@ -63782,7 +74726,7 @@ "category": "repos", "categoryLabel": "Repos", "notes": [], - "descriptionHTML": "

    Creates a new repository for the authenticated user.

    \n

    OAuth scope requirements

    \n

    When using OAuth, authorizations must include:

    \n
      \n
    • public_repo scope or repo scope to create a public repository
    • \n
    • repo scope to create a private repository
    • \n
    ", + "descriptionHTML": "

    Creates a new repository for the authenticated user.

    \n

    OAuth scope requirements

    \n

    When using OAuth, authorizations must include:

    \n
      \n
    • public_repo scope or repo scope to create a public repository. Note: For GitHub AE, use repo scope to create an internal repository.
    • \n
    • repo scope to create a private repository.
    • \n
    ", "bodyParameters": [ { "description": "

    Required. The name of the repository.

    ", @@ -63813,13 +74757,13 @@ "childParamsGroups": [] }, { - "description": "

    Whether the repository is private or public.

    ", + "description": "

    Whether the repository is private.

    ", "default": false, "type": "boolean", "name": "private", "in": "body", "rawType": "boolean", - "rawDescription": "Whether the repository is private or public.", + "rawDescription": "Whether the repository is private.", "childParamsGroups": [] }, { @@ -64003,7 +74947,7 @@ { "verb": "get", "requestPath": "/user/repository_invitations", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "per_page", @@ -64029,8 +74973,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/repository_invitations", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/repository_invitations
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/user/repository_invitations", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/user/repository_invitations
    " }, { "lang": "JavaScript", @@ -64095,7 +75039,7 @@ { "verb": "patch", "requestPath": "/user/repository_invitations/{invitation_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "invitation_id", @@ -64111,8 +75055,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/repository_invitations/42", - "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/repository_invitations/42
    " + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/user/repository_invitations/42", + "html": "
    curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/user/repository_invitations/42
    " }, { "lang": "JavaScript", @@ -64147,7 +75091,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -64176,7 +75120,7 @@ { "verb": "delete", "requestPath": "/user/repository_invitations/{invitation_id}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "invitation_id", @@ -64192,8 +75136,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/repository_invitations/42", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/repository_invitations/42
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/user/repository_invitations/42", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/user/repository_invitations/42
    " }, { "lang": "JavaScript", @@ -64228,7 +75172,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -64257,7 +75201,7 @@ { "verb": "get", "requestPath": "/user/starred", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "sort", @@ -64313,8 +75257,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/starred", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/starred
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/user/starred", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/user/starred
    " }, { "lang": "JavaScript", @@ -64374,7 +75318,7 @@ { "verb": "get", "requestPath": "/user/starred/{owner}/{repo}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -64398,8 +75342,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/starred/octocat/hello-world", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/starred/octocat/hello-world
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/user/starred/octocat/hello-world", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/user/starred/octocat/hello-world
    " }, { "lang": "JavaScript", @@ -64463,7 +75407,7 @@ { "verb": "put", "requestPath": "/user/starred/{owner}/{repo}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -64487,8 +75431,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/starred/octocat/hello-world", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/starred/octocat/hello-world
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/user/starred/octocat/hello-world", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/user/starred/octocat/hello-world
    " }, { "lang": "JavaScript", @@ -64523,7 +75467,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -64552,7 +75496,7 @@ { "verb": "delete", "requestPath": "/user/starred/{owner}/{repo}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "owner", @@ -64576,8 +75520,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/starred/octocat/hello-world", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/starred/octocat/hello-world
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/user/starred/octocat/hello-world", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/user/starred/octocat/hello-world
    " }, { "lang": "JavaScript", @@ -64612,7 +75556,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" }, { "httpStatusCode": "304", @@ -64641,7 +75585,7 @@ { "verb": "get", "requestPath": "/user/subscriptions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "per_page", @@ -64667,8 +75611,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/subscriptions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/subscriptions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/user/subscriptions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/user/subscriptions
    " }, { "lang": "JavaScript", @@ -64728,7 +75672,7 @@ { "verb": "get", "requestPath": "/user/teams", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "per_page", @@ -64754,8 +75698,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/teams", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/user/teams
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/user/teams", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/user/teams
    " }, { "lang": "JavaScript", @@ -64813,7 +75757,7 @@ { "verb": "get", "requestPath": "/users", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "since", @@ -64839,8 +75783,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/users", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/users
    " }, { "lang": "JavaScript", @@ -64888,7 +75832,7 @@ { "verb": "get", "requestPath": "/users/{username}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "username", @@ -64903,8 +75847,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/users/USERNAME", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/users/USERNAME
    " }, { "lang": "JavaScript", @@ -64958,7 +75902,7 @@ { "verb": "get", "requestPath": "/users/{username}/events", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "username", @@ -64993,8 +75937,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/events", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/events
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/users/USERNAME/events", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/users/USERNAME/events
    " }, { "lang": "JavaScript", @@ -65038,7 +75982,7 @@ { "verb": "get", "requestPath": "/users/{username}/events/orgs/{org}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "username", @@ -65082,8 +76026,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/events/orgs/ORG", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/events/orgs/ORG
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/users/USERNAME/events/orgs/ORG", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/users/USERNAME/events/orgs/ORG
    " }, { "lang": "JavaScript", @@ -65127,7 +76071,7 @@ { "verb": "get", "requestPath": "/users/{username}/events/public", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "username", @@ -65162,8 +76106,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/events/public", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/events/public
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/users/USERNAME/events/public", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/users/USERNAME/events/public
    " }, { "lang": "JavaScript", @@ -65207,7 +76151,7 @@ { "verb": "get", "requestPath": "/users/{username}/followers", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "username", @@ -65242,8 +76186,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/followers", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/followers
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/users/USERNAME/followers", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/users/USERNAME/followers
    " }, { "lang": "JavaScript", @@ -65288,7 +76232,7 @@ { "verb": "get", "requestPath": "/users/{username}/following", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "username", @@ -65323,8 +76267,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/following", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/following
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/users/USERNAME/following", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/users/USERNAME/following
    " }, { "lang": "JavaScript", @@ -65369,7 +76313,7 @@ { "verb": "get", "requestPath": "/users/{username}/following/{target_user}", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "username", @@ -65393,8 +76337,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/following/TARGET_USER", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/following/TARGET_USER
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/users/USERNAME/following/TARGET_USER", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/users/USERNAME/following/TARGET_USER
    " }, { "lang": "JavaScript", @@ -65443,7 +76387,7 @@ { "verb": "get", "requestPath": "/users/{username}/gists", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "username", @@ -65488,8 +76432,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/gists", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/gists
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/users/USERNAME/gists", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/users/USERNAME/gists
    " }, { "lang": "JavaScript", @@ -65537,7 +76481,7 @@ { "verb": "get", "requestPath": "/users/{username}/gpg_keys", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "username", @@ -65572,8 +76516,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/gpg_keys", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/gpg_keys
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/users/USERNAME/gpg_keys", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/users/USERNAME/gpg_keys
    " }, { "lang": "JavaScript", @@ -65618,7 +76562,7 @@ { "verb": "get", "requestPath": "/users/{username}/hovercard", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "username", @@ -65659,8 +76603,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/hovercard", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/hovercard
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/users/USERNAME/hovercard", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/users/USERNAME/hovercard
    " }, { "lang": "JavaScript", @@ -65713,7 +76657,7 @@ { "verb": "get", "requestPath": "/users/{username}/installation", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "username", @@ -65728,8 +76672,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/installation", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/installation
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/users/USERNAME/installation", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/users/USERNAME/installation
    " }, { "lang": "JavaScript", @@ -65772,7 +76716,7 @@ { "verb": "get", "requestPath": "/users/{username}/keys", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "username", @@ -65807,8 +76751,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/keys", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/keys
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/users/USERNAME/keys", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/users/USERNAME/keys
    " }, { "lang": "JavaScript", @@ -65853,7 +76797,7 @@ { "verb": "get", "requestPath": "/users/{username}/orgs", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "username", @@ -65888,8 +76832,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/orgs", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/orgs
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/users/USERNAME/orgs", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/users/USERNAME/orgs
    " }, { "lang": "JavaScript", @@ -65932,7 +76876,7 @@ { "verb": "get", "requestPath": "/users/{username}/projects", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "username", @@ -65983,8 +76927,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/users/USERNAME/projects", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/users/USERNAME/projects
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n http(s)://api.{hostname}/users/USERNAME/projects", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  http(s)://api.{hostname}/users/USERNAME/projects
    " }, { "lang": "JavaScript", @@ -66044,7 +76988,7 @@ { "verb": "get", "requestPath": "/users/{username}/received_events", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "username", @@ -66079,8 +77023,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/received_events", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/received_events
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/users/USERNAME/received_events", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/users/USERNAME/received_events
    " }, { "lang": "JavaScript", @@ -66124,7 +77068,7 @@ { "verb": "get", "requestPath": "/users/{username}/received_events/public", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "username", @@ -66159,8 +77103,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/received_events/public", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/received_events/public
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/users/USERNAME/received_events/public", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/users/USERNAME/received_events/public
    " }, { "lang": "JavaScript", @@ -66204,7 +77148,7 @@ { "verb": "get", "requestPath": "/users/{username}/repos", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "username", @@ -66286,8 +77230,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/repos", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/repos
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/users/USERNAME/repos", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/users/USERNAME/repos
    " }, { "lang": "JavaScript", @@ -66296,7 +77240,7 @@ } ], "summary": "List repositories for a user", - "description": "Lists public repositories for the specified user.", + "description": "Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user.", "tags": [ "repos" ], @@ -66324,7 +77268,7 @@ "categoryLabel": "Repos", "notes": [], "bodyParameters": [], - "descriptionHTML": "

    Lists public repositories for the specified user.

    ", + "descriptionHTML": "

    Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user.

    ", "responses": [ { "httpStatusCode": "200", @@ -66337,7 +77281,7 @@ { "verb": "get", "requestPath": "/users/{username}/starred", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "username", @@ -66402,8 +77346,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/starred", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/starred
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/users/USERNAME/starred", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/users/USERNAME/starred
    " }, { "lang": "JavaScript", @@ -66448,7 +77392,7 @@ { "verb": "get", "requestPath": "/users/{username}/subscriptions", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "username", @@ -66483,8 +77427,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/subscriptions", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/subscriptions
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/users/USERNAME/subscriptions", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/users/USERNAME/subscriptions
    " }, { "lang": "JavaScript", @@ -66529,7 +77473,7 @@ { "verb": "put", "requestPath": "/users/{username}/suspended", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "username", @@ -66544,8 +77488,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/suspended \\\n -d '{\"reason\":\"reason\"}'", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/suspended \\\n  -d '{\"reason\":\"reason\"}'
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/users/USERNAME/suspended \\\n -d '{\"reason\":\"reason\"}'", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/users/USERNAME/suspended \\\n  -d '{\"reason\":\"reason\"}'
    " }, { "lang": "JavaScript", @@ -66600,7 +77544,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "descriptionHTML": "

    If your GitHub instance uses LDAP Sync with Active Directory LDAP servers, Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a 403 response.

    \n

    You can suspend any user account except your own.

    \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.\"

    ", @@ -66619,7 +77563,7 @@ { "verb": "delete", "requestPath": "/users/{username}/suspended", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [ { "name": "username", @@ -66634,8 +77578,8 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/suspended \\\n -d '{\"reason\":\"reason\"}'", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/users/USERNAME/suspended \\\n  -d '{\"reason\":\"reason\"}'
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/users/USERNAME/suspended \\\n -d '{\"reason\":\"reason\"}'", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/users/USERNAME/suspended \\\n  -d '{\"reason\":\"reason\"}'
    " }, { "lang": "JavaScript", @@ -66690,7 +77634,7 @@ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response" } ], "descriptionHTML": "

    If your GitHub instance uses LDAP Sync with Active Directory LDAP servers, this API is disabled and will return a 403 response. Active Directory LDAP-authenticated users cannot be unsuspended using the API.

    ", @@ -66709,13 +77653,13 @@ { "verb": "get", "requestPath": "/zen", - "serverUrl": "https://api.github.com", + "serverUrl": "http(s)://api.{hostname}", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/zen", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/zen
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/zen", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/zen
    " }, { "lang": "JavaScript", diff --git a/lib/rest/static/dereferenced/api.github.com.deref.json b/lib/rest/static/dereferenced/api.github.com.deref.json index cff15a6e64..df63eb4274 100644 --- a/lib/rest/static/dereferenced/api.github.com.deref.json +++ b/lib/rest/static/dereferenced/api.github.com.deref.json @@ -152,7 +152,7 @@ "operationId": "meta/root", "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -357,7 +357,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -686,7 +686,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -1012,7 +1012,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -1032,7 +1032,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -1087,7 +1087,7 @@ }, "responses": { "200": { - "description": "Default response", + "description": "Response", "content": { "application/json": { "schema": { @@ -1193,7 +1193,7 @@ }, "responses": { "200": { - "description": "Default response", + "description": "Response", "content": { "application/json": { "schema": { @@ -1856,7 +1856,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -2363,7 +2363,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -2383,7 +2383,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -2439,10 +2439,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -2779,7 +2779,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -3969,7 +3969,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -3991,7 +3991,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -4011,7 +4011,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -4031,7 +4031,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -4136,10 +4136,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -4193,10 +4193,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -4257,11 +4257,20 @@ "type": "integer", "default": 1 } + }, + { + "name": "client_id", + "in": "query", + "required": false, + "description": "The client ID of your GitHub app.", + "schema": { + "type": "string" + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -4479,7 +4488,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -4502,7 +4511,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -4522,7 +4531,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -4581,7 +4590,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -4786,7 +4795,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -4809,7 +4818,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -4866,10 +4875,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -4892,7 +4901,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -4969,10 +4978,10 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -5085,7 +5094,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -5145,7 +5154,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -5816,7 +5825,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -5885,7 +5894,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -5957,7 +5966,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -6628,7 +6637,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -6739,7 +6748,10 @@ "type": "string", "description": "The OAuth access token used to authenticate to the GitHub API." } - } + }, + "required": [ + "access_token" + ] }, "example": { "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a" @@ -6749,10 +6761,10 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -6877,7 +6889,7 @@ "type": "integer" }, "repositories": { - "description": "The list of repository IDs to scope the user-to-server access token to. `repositories` may not be specified if `repository_ids` is specified.", + "description": "The list of repository names to scope the user-to-server access token to. `repositories` may not be specified if `repository_ids` is specified.", "type": "array", "items": { "type": "string", @@ -6885,7 +6897,7 @@ } }, "repository_ids": { - "description": "The list of repository names to scope the user-to-server access token to. `repository_ids` may not be specified if `repositories` is specified.", + "description": "The list of repository IDs to scope the user-to-server access token to. `repository_ids` may not be specified if `repositories` is specified.", "example": [ 1 ], @@ -7146,14 +7158,17 @@ "single_file": "read" } } - } + }, + "required": [ + "access_token" + ] } } } }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -7857,7 +7872,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -7897,7 +7912,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -7917,7 +7932,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -8030,7 +8045,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -8706,7 +8721,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -8771,7 +8786,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -9487,7 +9502,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -9528,7 +9543,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -9842,7 +9857,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -9862,7 +9877,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -9925,11 +9940,20 @@ "type": "integer", "default": 1 } + }, + { + "name": "client_id", + "in": "query", + "required": false, + "description": "The client ID of your GitHub app.", + "schema": { + "type": "string" + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -10592,7 +10616,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -10615,7 +10639,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -10635,7 +10659,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -10730,7 +10754,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -11388,7 +11412,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -11477,7 +11501,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -11500,7 +11524,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -12919,7 +12943,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -12988,7 +13012,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -13011,7 +13035,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -14434,7 +14458,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -14542,7 +14566,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -15192,7 +15216,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -15215,7 +15239,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -15322,7 +15346,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -15972,7 +15996,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -16078,10 +16102,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -16104,7 +16128,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -16155,7 +16179,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -16218,10 +16242,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -16282,7 +16306,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -16335,7 +16359,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -16355,10 +16379,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -16446,7 +16470,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -16496,7 +16520,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -16565,7 +16589,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -16605,7 +16629,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -16627,7 +16651,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -16692,10 +16716,10 @@ } } }, - "description": "response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -16734,7 +16758,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -16819,7 +16843,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "requestBody": { @@ -16912,7 +16936,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -17064,7 +17088,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "requestBody": { @@ -17140,7 +17164,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -17186,7 +17210,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -17225,7 +17249,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -17303,7 +17327,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "requestBody": { @@ -17403,7 +17427,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -17581,7 +17605,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -17680,7 +17704,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -17805,7 +17829,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -17902,7 +17926,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -17968,7 +17992,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -18157,7 +18181,7 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -18214,7 +18238,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -18269,7 +18293,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -18335,7 +18359,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -18560,7 +18584,7 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -18617,7 +18641,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -18672,7 +18696,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -18729,7 +18753,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -18915,7 +18939,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -19022,7 +19046,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -20081,7 +20105,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -21149,7 +21173,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -21294,7 +21318,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -21384,6 +21408,15 @@ ] } }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, { "name": "per_page", "description": "Results per page (max 100).", @@ -21594,7 +21627,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -21691,7 +21724,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -21765,7 +21798,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -21848,7 +21881,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -24516,7 +24549,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -24539,7 +24572,7 @@ } }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -24588,7 +24621,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -24899,7 +24932,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -25317,7 +25350,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -25426,7 +25459,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -25659,7 +25692,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -25728,10 +25761,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -25825,7 +25858,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -26243,7 +26276,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -26312,7 +26345,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -26389,7 +26422,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -26807,7 +26840,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -26827,7 +26860,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -26886,7 +26919,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -27144,7 +27177,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -27164,7 +27197,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -27271,7 +27304,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -27496,7 +27529,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -27565,7 +27598,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -27619,10 +27652,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -27642,7 +27675,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -27719,7 +27752,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -27951,10 +27984,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -28048,7 +28081,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -28275,10 +28308,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -28363,7 +28396,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -28582,10 +28615,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -28701,7 +28734,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -28920,7 +28953,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -28983,13 +29016,13 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -29083,7 +29116,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -29296,7 +29329,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -29316,7 +29349,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -29393,7 +29426,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -29662,7 +29695,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -29682,7 +29715,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -29739,7 +29772,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -30152,7 +30185,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -30172,7 +30205,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -30241,7 +30274,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -30316,7 +30349,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -30373,10 +30406,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -30396,7 +30429,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -30453,13 +30486,13 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -30543,7 +30576,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -30768,7 +30801,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -30837,7 +30870,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -30905,7 +30938,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -30927,7 +30960,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -30965,7 +30998,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -30999,7 +31032,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -31047,7 +31080,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -32189,10 +32222,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -32244,7 +32277,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -32283,6 +32316,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -32403,7 +32437,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -34846,7 +34880,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -34915,10 +34949,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -34982,11 +35016,20 @@ "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", + "description": "Response", "content": { "application/json": { "schema": { @@ -35092,7 +35135,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -35130,7 +35173,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -35283,7 +35326,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -35303,7 +35346,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -35366,7 +35409,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "headers": { "Content-Type": { "example": "text/html", @@ -35396,7 +35439,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -35441,7 +35484,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "headers": { "X-CommonMarker-Version": { "example": "0.17.4", @@ -35459,7 +35502,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -35498,7 +35541,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -35826,7 +35869,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -35891,7 +35934,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -36015,7 +36058,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -36035,7 +36078,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -36136,7 +36179,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -36457,7 +36500,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -36477,7 +36520,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -36546,7 +36589,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -36602,7 +36645,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -36913,7 +36956,7 @@ "description": "Response when the account has not purchased the listing" }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -36978,7 +37021,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -37102,7 +37145,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -37203,7 +37246,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -37524,7 +37567,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -37572,7 +37615,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -37707,7 +37750,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -37771,7 +37814,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -40439,7 +40482,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -40479,10 +40522,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "301": { - "description": "Moved Permanently" + "description": "Moved permanently" } }, "x-github": { @@ -40568,7 +40611,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -42227,7 +42270,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -42250,7 +42293,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -42270,7 +42313,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -42385,7 +42428,7 @@ }, "responses": { "202": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -42400,10 +42443,10 @@ } }, "205": { - "description": "response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -42426,7 +42469,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -42482,7 +42525,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -44128,7 +44171,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -44151,7 +44194,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -44205,10 +44248,10 @@ ], "responses": { "205": { - "description": "response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -44267,7 +44310,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -44332,7 +44375,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -44355,7 +44398,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -44425,7 +44468,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -44490,7 +44533,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -44513,7 +44556,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -44567,10 +44610,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -44593,7 +44636,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -44645,7 +44688,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/octocat-stream": { "schema": { @@ -44699,7 +44742,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -44810,7 +44853,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -44848,7 +44891,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -45137,7 +45180,9 @@ "plan": { "name": "Medium", "space": 400, - "private_repos": 20 + "private_repos": 20, + "filled_seats": 4, + "seats": 5 }, "default_repository_permission": "read", "members_can_create_repositories": true, @@ -45148,54 +45193,13 @@ "members_can_create_internal_repositories": false, "members_can_create_pages": true } - }, - "response-with-git-hub-plan-information": { - "summary": "Response with GitHub plan information", - "value": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization", - "name": "github", - "company": "GitHub", - "blog": "https://github.com/blog", - "location": "San Francisco", - "email": "octocat@github.com", - "twitter_username": "github", - "is_verified": true, - "has_organization_projects": true, - "has_repository_projects": true, - "public_repos": 2, - "public_gists": 1, - "followers": 20, - "following": 0, - "html_url": "https://github.com/octocat", - "created_at": "2008-01-14T04:33:35Z", - "updated_at": "2014-03-03T18:58:10Z", - "type": "Organization", - "plan": { - "name": "team", - "space": 976562499, - "private_repos": 999999, - "filled_seats": 4, - "seats": 5 - } - } } } } } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -45367,7 +45371,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -45672,7 +45676,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -45788,7 +45792,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -45849,7 +45853,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -45933,7 +45937,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "requestBody": { @@ -46025,7 +46029,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -47173,7 +47177,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "requestBody": { @@ -47247,7 +47251,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -47291,7 +47295,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -47329,7 +47333,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -47406,7 +47410,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "requestBody": { @@ -47505,7 +47509,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -47695,7 +47699,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -47802,7 +47806,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -47935,7 +47939,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -48040,7 +48044,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -48083,11 +48087,29 @@ "schema": { "type": "integer" } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -49272,7 +49294,7 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -49327,7 +49349,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -49380,7 +49402,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -49445,7 +49467,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -49669,7 +49691,7 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -49725,7 +49747,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -49779,7 +49801,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -49835,7 +49857,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -50024,7 +50046,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -50130,7 +50152,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -51188,7 +51210,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -52255,7 +52277,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -52399,7 +52421,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -52455,7 +52477,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -52588,7 +52610,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -52684,7 +52706,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -52790,7 +52812,8 @@ "properties": { "encrypted_value": { "type": "string", - "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/reference/actions#get-an-organization-public-key) endpoint." + "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/reference/actions#get-an-organization-public-key) endpoint.", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" }, "key_id": { "type": "string", @@ -52815,7 +52838,7 @@ } }, "example": { - "encrypted_value": "****************************************************************************************", + "encrypted_value": "c2VjcmV0", "key_id": "012345678912345678", "visibility": "selected", "selected_repository_ids": [ @@ -52876,7 +52899,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -52919,11 +52942,29 @@ "schema": { "type": "string" } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -54575,7 +54616,7 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -54786,6 +54827,15 @@ "type": "integer", "default": 30 } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } } ], "responses": { @@ -54987,7 +55037,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -55135,7 +55185,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -55264,10 +55314,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -55377,7 +55427,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -55415,7 +55465,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -55574,10 +55624,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -55650,7 +55700,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -58371,7 +58421,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -58594,7 +58644,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -58667,7 +58717,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -58794,7 +58844,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -58931,7 +58981,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -59053,7 +59103,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -59122,7 +59172,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -59185,7 +59235,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -59299,7 +59349,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -59426,7 +59476,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -59539,7 +59589,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -59608,7 +59658,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -59669,10 +59719,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -59735,7 +59785,7 @@ ], "responses": { "200": { - "description": "Default response", + "description": "Response", "content": { "application/json": { "schema": { @@ -59859,7 +59909,7 @@ }, "responses": { "200": { - "description": "Default response", + "description": "Response", "content": { "application/json": { "schema": { @@ -59947,10 +59997,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -60005,7 +60055,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -60565,7 +60615,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -61136,7 +61186,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -61254,7 +61304,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -61301,7 +61351,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -61403,7 +61453,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -61459,7 +61509,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -61682,7 +61732,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -61779,7 +61829,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -61987,7 +62037,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -62056,7 +62106,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -62121,10 +62171,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -62193,7 +62243,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -62276,7 +62326,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -62455,7 +62505,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -62519,6 +62569,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -62607,7 +62658,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -65050,7 +65101,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -65156,7 +65207,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -65323,7 +65374,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -65493,7 +65544,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -65530,7 +65581,7 @@ "/orgs/{org}/memberships/{username}": { "get": { "summary": "Get organization membership for a user", - "description": "In order to get a user's membership with an organization, the authenticated user must be an organization member.", + "description": "In order to get a user's membership with an organization, the authenticated user must be an organization member. The `state` parameter in the response can be used to identify the user's membership status.", "tags": [ "orgs" ], @@ -65559,7 +65610,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -65574,11 +65625,21 @@ }, "state": { "type": "string", - "example": "active" + "description": "The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.", + "example": "active", + "enum": [ + "active", + "pending" + ] }, "role": { "type": "string", - "example": "admin" + "description": "The user's membership type in the organization.", + "example": "admin", + "enum": [ + "admin", + "member" + ] }, "organization_url": { "type": "string", @@ -65839,99 +65900,13 @@ "site_admin": false } } - }, - "response-if-user-has-an-active-membership-with-organization": { - "summary": "Response if user has an active membership with organization", - "value": { - "url": "https://api.github.com/orgs/octocat/memberships/defunkt", - "state": "active", - "role": "member", - "organization_url": "https://api.github.com/orgs/octocat", - "organization": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization" - }, - "user": { - "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 - } - } - }, - "response-if-user-has-a-pending-membership-with-organization": { - "summary": "Response if user has a pending membership with organization", - "value": { - "url": "https://api.github.com/orgs/invitocat/memberships/defunkt", - "state": "pending", - "role": "member", - "organization_url": "https://api.github.com/orgs/invitocat", - "organization": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization" - }, - "user": { - "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 - } - } } } } } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -66032,7 +66007,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -66047,11 +66022,21 @@ }, "state": { "type": "string", - "example": "active" + "description": "The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.", + "example": "active", + "enum": [ + "active", + "pending" + ] }, "role": { "type": "string", - "example": "admin" + "description": "The user's membership type in the organization.", + "example": "admin", + "enum": [ + "admin", + "member" + ] }, "organization_url": { "type": "string", @@ -66270,51 +66255,8 @@ ] }, "examples": { - "response-if-user-was-previously-unaffiliated-with-organization": { - "summary": "Response if user was previously unaffiliated with organization", - "value": { - "url": "https://api.github.com/orgs/invitocat/memberships/defunkt", - "state": "pending", - "role": "admin", - "organization_url": "https://api.github.com/orgs/invitocat", - "organization": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization" - }, - "user": { - "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 - } - } - }, "response-if-user-already-had-membership-with-organization": { - "summary": "Response if user already had membership with organization", + "summary": "Response if user has an active admin membership with organization", "value": { "url": "https://api.github.com/orgs/octocat/memberships/defunkt", "state": "active", @@ -66361,7 +66303,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -66491,7 +66433,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -66514,7 +66456,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -66583,11 +66525,27 @@ "type": "integer", "default": 1 } + }, + { + "name": "exclude", + "description": "Exclude attributes from the API response to improve performance", + "in": "query", + "schema": { + "type": "array", + "items": { + "description": "Allowed values that can be passed to the exclude param.", + "enum": [ + "repositories" + ], + "example": "repositories", + "type": "string" + } + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -67994,7 +67952,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -69308,7 +69266,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -69328,7 +69286,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -69437,6 +69395,22 @@ "schema": { "type": "integer" } + }, + { + "name": "exclude", + "description": "Exclude attributes from the API response to improve performance", + "in": "query", + "schema": { + "type": "array", + "items": { + "description": "Allowed values that can be passed to the exclude param.", + "enum": [ + "repositories" + ], + "example": "repositories", + "type": "string" + } + } } ], "responses": { @@ -70755,7 +70729,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -70823,10 +70797,10 @@ ], "responses": { "302": { - "description": "response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -70892,10 +70866,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -70972,10 +70946,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -71061,7 +71035,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -72796,7 +72770,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -72887,7 +72861,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -73092,41 +73066,10 @@ "description": "User was converted" }, "403": { - "description": "response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - }, - "examples": { - "response-if-user-is-the-last-owner-of-the-organization": { - "summary": "Response if user is the last owner of the organization", - "value": { - "message": "Cannot convert the last owner to an outside collaborator", - "documentation_url": "https://docs.github.com/rest/reference/orgs#convert-member-to-outside-collaborator" - } - }, - "response-if-user-is-not-a-member-of-the-organization": { - "summary": "Response if user is not a member of the organization", - "value": { - "message": " is not a member of the organization.", - "documentation_url": "https://docs.github.com/rest/reference/orgs#convert-member-to-outside-collaborator" - } - } - } - } - } + "description": "Response if user is the last owner of the organization or not a member of the organization" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -73187,7 +73130,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "422": { "description": "Response if user is a member of the organization", @@ -75056,10 +74999,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -75099,7 +75042,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -75176,14 +75119,23 @@ "schema": { "type": "string" } + }, + { + "name": "token", + "description": "package token", + "schema": { + "type": "string" + }, + "required": false, + "in": "query" } ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -75223,7 +75175,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -75261,7 +75213,7 @@ "tags": [ "packages" ], - "operationId": "packages/get-all-package-versions-for-a-package-owned-by-an-org", + "operationId": "packages/get-all-package-versions-for-package-owned-by-org", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/reference/packages#get-all-package-versions-for-a-package-owned-by-the-authenticated-user" @@ -75300,6 +75252,38 @@ "schema": { "type": "string" } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "state", + "in": "query", + "required": false, + "description": "The state of the package, either active or deleted.", + "schema": { + "type": "string", + "enum": [ + "active", + "deleted" + ], + "default": "active" + } } ], "responses": { @@ -75448,7 +75432,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -75488,7 +75472,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -75778,10 +75762,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -75821,7 +75805,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -75911,10 +75895,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -75954,7 +75938,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -76042,7 +76026,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -76311,7 +76295,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -76404,7 +76388,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -76660,7 +76644,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -76700,7 +76684,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -76740,7 +76724,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -76827,7 +76811,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -77073,7 +77057,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -77137,7 +77121,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -77174,7 +77158,7 @@ }, { "name": "type", - "description": "Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`.", + "description": "Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Note: For GitHub AE, can be one of `all`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`.", "in": "query", "required": false, "schema": { @@ -77240,7 +77224,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -78996,7 +78980,7 @@ }, "post": { "summary": "Create an organization repository", - "description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", + "description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository", "tags": [ "repos" ], @@ -79035,12 +79019,12 @@ }, "private": { "type": "boolean", - "description": "Either `true` to create a private repository or `false` to create a public one.", + "description": "Whether the repository is private.", "default": false }, "visibility": { "type": "string", - "description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", + "description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", "enum": [ "public", "private", @@ -79124,7 +79108,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -80247,7 +80231,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -80339,7 +80323,7 @@ "/orgs/{org}/settings/billing/actions": { "get": { "summary": "Get GitHub Actions billing for an organization", - "description": "Gets the summary of the free and paid GitHub Actions minutes used.\n\nPaid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nAccess tokens must have the `repo` or `admin:org` scope.", + "description": "Gets the summary of the free and paid GitHub Actions minutes used.\n\nPaid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nAccess tokens must have the `repo` or `admin:org` scope.", "operationId": "billing/get-github-actions-billing-org", "tags": [ "billing" @@ -80360,7 +80344,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -80456,7 +80440,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -80529,7 +80513,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -80610,17 +80594,16 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "Page token", "in": "query", "schema": { - "type": "integer", - "default": 1 + "type": "string" } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -80764,7 +80747,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -81060,7 +81043,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -81551,7 +81534,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -81684,7 +81667,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -82175,7 +82158,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -82284,7 +82267,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -82817,7 +82800,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -82892,11 +82875,20 @@ "type": "integer", "default": 1 } + }, + { + "name": "pinned", + "in": "query", + "required": false, + "description": "Pinned discussions only filter", + "schema": { + "type": "string" + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -83317,7 +83309,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -83704,7 +83696,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -84110,7 +84102,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -84494,7 +84486,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -84581,7 +84573,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -84965,7 +84957,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -85326,7 +85318,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -85705,7 +85697,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -86063,7 +86055,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -86163,7 +86155,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -86465,7 +86457,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -86733,7 +86725,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -86829,7 +86821,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -87123,7 +87115,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -87383,7 +87375,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -87452,7 +87444,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -87752,7 +87744,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -87922,7 +87914,7 @@ "/orgs/{org}/teams/{team_slug}/memberships/{username}": { "get": { "summary": "Get team membership for a user", - "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.\n\n**Note:** The `role` for organization owners returns as `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/reference/teams#create-a-team).", + "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.\n\n**Note:**\nThe response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see see [Create a team](https://docs.github.com/rest/reference/teams#create-a-team).", "tags": [ "teams" ], @@ -87960,7 +87952,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -87983,7 +87975,12 @@ "type": "string" }, "state": { - "type": "string" + "description": "The state of the user's membership in the team.", + "type": "string", + "enum": [ + "active", + "pending" + ] } }, "required": [ @@ -87993,14 +87990,6 @@ ] }, "examples": { - "response-if-user-has-an-active-membership-with-team": { - "summary": "Response if user has an active membership with team", - "value": { - "url": "https://api.github.com/teams/1/memberships/octocat", - "role": "member", - "state": "active" - } - }, "response-if-user-is-a-team-maintainer": { "summary": "Response if user is a team maintainer", "value": { @@ -88008,14 +87997,6 @@ "role": "maintainer", "state": "active" } - }, - "response-if-user-has-a-pending-membership-with-team": { - "summary": "Response if user has a pending membership with team", - "value": { - "url": "https://api.github.com/teams/1/memberships/octocat", - "role": "member", - "state": "pending" - } } } } @@ -88095,7 +88076,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -88118,7 +88099,12 @@ "type": "string" }, "state": { - "type": "string" + "description": "The state of the user's membership in the team.", + "type": "string", + "enum": [ + "active", + "pending" + ] } }, "required": [ @@ -88128,14 +88114,6 @@ ] }, "examples": { - "response-if-users-membership-with-team-is-now-active": { - "summary": "Response if user's membership with team is now active", - "value": { - "url": "https://api.github.com/teams/1/memberships/octocat", - "role": "member", - "state": "active" - } - }, "response-if-users-membership-with-team-is-now-pending": { "summary": "Response if user's membership with team is now pending", "value": { @@ -88152,50 +88130,7 @@ "description": "Response if team synchronization is set up" }, "422": { - "description": "Response if you attempt to add an organization to a team", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "field": { - "type": "string" - }, - "resource": { - "type": "string" - } - } - } - } - } - }, - "examples": { - "response-if-you-attempt-to-add-an-organization-to-a-team": { - "value": { - "message": "Cannot add an organization as a member.", - "errors": [ - { - "code": "org", - "field": "user", - "resource": "TeamMember" - } - ] - } - } - } - } - } + "description": "Response if you attempt to add an organization to a team" } }, "x-github": { @@ -88248,7 +88183,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Response if team synchronization is set up" @@ -88316,7 +88251,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -88636,7 +88571,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -88965,7 +88900,7 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Response if the project is not owned by the organization", @@ -89048,7 +88983,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -89113,7 +89048,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -92857,7 +92792,7 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -92918,7 +92853,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -92965,7 +92900,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -93139,7 +93074,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -93511,7 +93446,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -93738,7 +93673,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -93761,7 +93696,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -93781,7 +93716,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -93861,7 +93796,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -94088,7 +94023,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -94111,7 +94046,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -94131,7 +94066,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -94151,7 +94086,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -94219,10 +94154,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -94249,7 +94184,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -94269,7 +94204,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -94354,7 +94289,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -94367,7 +94302,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -94408,7 +94343,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -94428,7 +94363,7 @@ } }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -94463,7 +94398,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -94572,7 +94507,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -94649,7 +94584,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -94672,7 +94607,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -94692,7 +94627,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -94769,7 +94704,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -94846,7 +94781,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -94869,7 +94804,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -94927,10 +94862,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -94953,7 +94888,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -95046,7 +94981,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -95286,7 +95221,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -95309,7 +95244,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -95410,7 +95345,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -95637,7 +95572,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -95660,7 +95595,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -95680,7 +95615,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -95776,7 +95711,7 @@ } }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -95871,7 +95806,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -95884,7 +95819,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -95907,7 +95842,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -95937,7 +95872,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -95996,7 +95931,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -96252,7 +96187,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -96275,7 +96210,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -96373,7 +96308,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -96632,7 +96567,7 @@ "description": "Response if the authenticated user does not have access to the project" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -96659,7 +96594,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -96699,7 +96634,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -96769,7 +96704,7 @@ "description": "Delete Success" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -96796,7 +96731,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -96836,7 +96771,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -96928,7 +96863,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -97084,7 +97019,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -97104,7 +97039,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -97126,7 +97061,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -97195,7 +97130,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -97218,7 +97153,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -97307,10 +97242,10 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -97330,7 +97265,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -97352,7 +97287,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -97421,7 +97356,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -97444,7 +97379,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -97509,13 +97444,13 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -97535,7 +97470,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -97577,7 +97512,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -97646,7 +97581,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -97713,7 +97648,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -97878,7 +97813,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -97898,7 +97833,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -97920,7 +97855,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -97989,7 +97924,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -98012,7 +97947,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -98089,7 +98024,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -98179,7 +98114,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -98202,7 +98137,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -98278,7 +98213,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -98351,7 +98286,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -98374,7 +98309,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -98404,7 +98339,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -98456,7 +98391,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -98682,10 +98617,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -98740,10 +98675,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -98766,7 +98701,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -98806,7 +98741,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -98878,7 +98813,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -103590,7 +103525,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -103610,7 +103545,7 @@ } }, "301": { - "description": "Moved Permanently" + "description": "Moved permanently" } }, "x-github": { @@ -103759,7 +103694,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -107959,7 +107894,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -108028,7 +107963,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -108098,7 +108033,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "If an organization owner has configured the organization to prevent members from deleting organization-owned repositories, a member will get this response:", @@ -108123,7 +108058,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -108204,7 +108139,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -108382,7 +108317,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -108518,7 +108453,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -108581,7 +108516,7 @@ ], "responses": { "302": { - "description": "response", + "description": "Response", "headers": { "Location": { "example": "https://pipelines.actions.githubusercontent.com/OhgS4QRKqmgx7bKC27GKU83jnQjyeqG8oIMTge8eqtheppcmw8/_apis/pipelines/1/runs/176/signedlogcontent?urlExpires=2020-01-24T18%3A10%3A31.5729946Z&urlSigningMethod=HMACV1&urlSignature=agG73JakPYkHrh06seAkvmH7rBR4Ji4c2%2B6a2ejYh3E%3D", @@ -108644,7 +108579,7 @@ ], "responses": { "202": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -108950,7 +108885,7 @@ ], "responses": { "302": { - "description": "response", + "description": "Response", "headers": { "Location": { "example": "https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/jobs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D", @@ -109004,7 +108939,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -109087,7 +109022,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "requestBody": { @@ -109164,7 +109099,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -109249,7 +109184,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "requestBody": { @@ -109356,7 +109291,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -109553,7 +109488,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -109667,7 +109602,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -110733,7 +110668,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -111808,7 +111743,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -111960,7 +111895,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -112075,7 +112010,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -115609,7 +115544,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -119113,7 +119048,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -119471,7 +119406,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -119649,7 +119584,7 @@ ], "responses": { "202": { - "description": "response" + "description": "Response" } }, "x-github": { @@ -119736,7 +119671,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -120070,7 +120005,7 @@ ], "responses": { "302": { - "description": "response", + "description": "Response", "headers": { "Location": { "example": "https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/runs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D", @@ -120131,7 +120066,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -121189,7 +121124,7 @@ ], "responses": { "201": { - "description": "response" + "description": "Response" } }, "x-github": { @@ -121244,7 +121179,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -121397,7 +121332,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -121514,7 +121449,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -121618,7 +121553,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -121715,7 +121650,8 @@ "properties": { "encrypted_value": { "type": "string", - "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/reference/actions#get-a-repository-public-key) endpoint." + "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/reference/actions#get-a-repository-public-key) endpoint.", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" }, "key_id": { "type": "string", @@ -121724,7 +121660,7 @@ } }, "example": { - "encrypted_value": "****************************************************************************************", + "encrypted_value": "c2VjcmV0", "key_id": "012345678912345678" } } @@ -121788,7 +121724,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -121852,7 +121788,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -122044,7 +121980,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -122196,7 +122132,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -122258,7 +122194,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "requestBody": { @@ -122353,7 +122289,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -122484,7 +122420,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -126025,7 +125961,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -126149,7 +126085,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -126305,7 +126241,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -126442,7 +126378,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -126490,7 +126426,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -126567,7 +126503,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -127293,18 +127229,6 @@ }, "examples": { "default": { - "value": [ - { - "name": "master", - "commit": { - "sha": "c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc", - "url": "https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc" - }, - "protected": true - } - ] - }, - "with-protection": { "value": [ { "name": "master", @@ -127340,7 +127264,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -127413,7 +127337,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -128731,7 +128655,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -128753,7 +128677,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -128826,7 +128750,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -129672,7 +129596,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -129911,7 +129835,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -130642,7 +130566,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -130664,7 +130588,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -130694,7 +130618,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -130769,7 +130693,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -130845,7 +130769,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -130931,7 +130855,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -131020,7 +130944,7 @@ "description": "No Content" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -131093,7 +131017,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/vnd.github.luke-cage-preview+json": { "schema": { @@ -131572,7 +131496,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -131940,7 +131864,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -132067,7 +131991,7 @@ "description": "No Content" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -132140,7 +132064,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -132175,7 +132099,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -132250,7 +132174,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -132285,7 +132209,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -132363,7 +132287,7 @@ "description": "No Content" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -132440,7 +132364,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -132495,7 +132419,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -132594,7 +132518,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -132649,7 +132573,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -132669,7 +132593,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -132845,7 +132769,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -132861,7 +132785,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -132958,7 +132882,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -132975,7 +132899,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -133064,7 +132988,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -133162,7 +133086,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -133178,7 +133102,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -133247,7 +133171,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -133345,7 +133269,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -133361,7 +133285,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -133381,7 +133305,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -133504,7 +133428,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -133875,7 +133799,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -134002,7 +133926,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -134301,7 +134225,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -134398,7 +134322,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -134697,7 +134621,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -134844,7 +134768,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -135143,7 +135067,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -135290,7 +135214,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -135589,7 +135513,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -135712,7 +135636,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -135883,7 +135807,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -135980,7 +135904,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -136151,7 +136075,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -136298,7 +136222,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -136469,7 +136393,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -136616,7 +136540,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -136787,7 +136711,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -136910,7 +136834,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -137058,7 +136982,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -137155,7 +137079,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -137303,7 +137227,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -137450,7 +137374,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -137598,7 +137522,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -137745,7 +137669,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -137893,7 +137817,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -138037,7 +137961,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -139375,7 +139299,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -139395,7 +139319,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -139701,7 +139625,7 @@ "name", "head_sha" ], - "anyOf": [ + "oneOf": [ { "properties": { "status": { @@ -139711,6 +139635,7 @@ } }, "required": [ + "status", "conclusion" ], "additionalProperties": true @@ -139730,7 +139655,7 @@ }, "examples": { "example-of-in-progress-conclusion": { - "summary": "Example of in_progress conclusion", + "summary": "Response for in_progress conclusion", "value": { "name": "mighty_readme", "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -139745,7 +139670,7 @@ } }, "example-of-completed-conclusion": { - "summary": "Example of completed conclusion", + "summary": "Response for completed conclusion", "value": { "name": "mighty_readme", "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -139799,7 +139724,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -140615,101 +140540,8 @@ ] }, "examples": { - "example-of-in-progress-conclusion": { - "summary": "Example of in_progress conclusion", - "value": { - "id": 4, - "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", - "node_id": "MDg6Q2hlY2tSdW40", - "external_id": "42", - "url": "https://api.github.com/repos/github/hello-world/check-runs/4", - "html_url": "https://github.com/github/hello-world/runs/4", - "details_url": "https://example.com", - "status": "in_progress", - "conclusion": "neutral", - "started_at": "2018-05-04T01:14:52Z", - "completed_at": null, - "output": { - "title": "Mighty Readme Report", - "summary": "", - "text": "", - "annotations_count": 1, - "annotations_url": "https://api.github.com/repos/github/hello-world/check-runs/4/annotations" - }, - "name": "mighty_readme", - "check_suite": { - "id": 5 - }, - "app": { - "id": 1, - "slug": "octoapp", - "node_id": "MDExOkludGVncmF0aW9uMQ==", - "owner": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "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", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": true - }, - "name": "Octocat App", - "description": "", - "external_url": "https://example.com", - "html_url": "https://github.com/apps/octoapp", - "created_at": "2017-07-08T16:18:44-04:00", - "updated_at": "2017-07-08T16:18:44-04:00", - "permissions": { - "metadata": "read", - "contents": "read", - "issues": "write", - "single_file": "write" - }, - "events": [ - "push", - "pull_request" - ] - }, - "pull_requests": [ - { - "url": "https://api.github.com/repos/github/hello-world/pulls/1", - "id": 1934, - "number": 3956, - "head": { - "ref": "say-hello", - "sha": "3dca65fa3e8d4b3da3f3d056c59aee1c50f41390", - "repo": { - "id": 526, - "url": "https://api.github.com/repos/github/hello-world", - "name": "hello-world" - } - }, - "base": { - "ref": "master", - "sha": "e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f", - "repo": { - "id": 526, - "url": "https://api.github.com/repos/github/hello-world", - "name": "hello-world" - } - } - } - ] - } - }, "example-of-completed-conclusion": { - "summary": "Example of completed conclusion", + "summary": "Response for completed conclusion", "value": { "id": 4, "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -140858,7 +140690,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -142075,7 +141907,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -143058,7 +142890,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -143222,7 +143054,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -145607,7 +145439,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -146802,7 +146634,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -149210,7 +149042,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -150203,7 +150035,7 @@ ], "responses": { "201": { - "description": "response" + "description": "Response" } }, "x-github": { @@ -150220,7 +150052,7 @@ "/repos/{owner}/{repo}/code-scanning/alerts": { "get": { "summary": "List code scanning alerts for a repository", - "description": "Lists all open code scanning alerts for the default branch (usually `main`\nor `master`). You must use an access token with the `security_events` scope to use\nthis endpoint. GitHub Apps must have the `security_events` read permission to use\nthis endpoint.\n\nThe response includes a `most_recent_instance` object.\nThis provides details of the most recent instance of this alert\nfor the the default branch or for the specified Git reference\n(if you used `ref` in the request).", + "description": "Lists all open code scanning alerts for the default branch (usually `main`\nor `master`). You must use an access token with the `security_events` scope to use\nthis endpoint. GitHub Apps must have the `security_events` read permission to use\nthis endpoint.\n\nThe response includes a `most_recent_instance` object.\nThis provides details of the most recent instance of this alert\nfor the default branch or for the specified Git reference\n(if you used `ref` in the request).", "tags": [ "code-scanning" ], @@ -150292,7 +150124,7 @@ "required": false, "schema": { "type": "string", - "description": "The full Git reference, formatted as `refs/heads/`." + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." } }, { @@ -150305,6 +150137,7 @@ "description": "State of a code scanning alert.", "enum": [ "open", + "closed", "dismissed", "fixed" ] @@ -150313,7 +150146,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -150360,6 +150193,7 @@ "description": "State of a code scanning alert.", "enum": [ "open", + "closed", "dismissed", "fixed" ] @@ -150555,7 +150389,7 @@ "properties": { "ref": { "type": "string", - "description": "The full Git reference, formatted as `refs/heads/`." + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." }, "analysis_key": { "type": "string", @@ -150570,6 +150404,7 @@ "description": "State of a code scanning alert.", "enum": [ "open", + "closed", "dismissed", "fixed" ] @@ -150756,7 +150591,7 @@ } }, "403": { - "description": "Response if github advanced security is not enabled for this repository", + "description": "Response if GitHub Advanced Security is not enabled for this repository", "content": { "application/json": { "schema": { @@ -150776,7 +150611,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -150796,7 +150631,7 @@ } }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -150872,7 +150707,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -150917,6 +150752,7 @@ "description": "State of a code scanning alert.", "enum": [ "open", + "closed", "dismissed", "fixed" ] @@ -151127,7 +150963,7 @@ "properties": { "ref": { "type": "string", - "description": "The full Git reference, formatted as `refs/heads/`." + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." }, "analysis_key": { "type": "string", @@ -151142,6 +150978,7 @@ "description": "State of a code scanning alert.", "enum": [ "open", + "closed", "dismissed", "fixed" ] @@ -151289,7 +151126,7 @@ } }, "403": { - "description": "Response if github advanced security is not enabled for this repository", + "description": "Response if GitHub Advanced Security is not enabled for this repository", "content": { "application/json": { "schema": { @@ -151309,7 +151146,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -151329,7 +151166,7 @@ } }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -151448,7 +151285,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -151493,6 +151330,7 @@ "description": "State of a code scanning alert.", "enum": [ "open", + "closed", "dismissed", "fixed" ] @@ -151703,7 +151541,7 @@ "properties": { "ref": { "type": "string", - "description": "The full Git reference, formatted as `refs/heads/`." + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." }, "analysis_key": { "type": "string", @@ -151718,6 +151556,7 @@ "description": "State of a code scanning alert.", "enum": [ "open", + "closed", "dismissed", "fixed" ] @@ -151885,7 +151724,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -151905,7 +151744,7 @@ } }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -152002,13 +151841,13 @@ "required": false, "schema": { "type": "string", - "description": "The full Git reference, formatted as `refs/heads/`." + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -152018,7 +151857,7 @@ "properties": { "ref": { "type": "string", - "description": "The full Git reference, formatted as `refs/heads/`." + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." }, "analysis_key": { "type": "string", @@ -152033,6 +151872,7 @@ "description": "State of a code scanning alert.", "enum": [ "open", + "closed", "dismissed", "fixed" ] @@ -152140,7 +151980,7 @@ } }, "403": { - "description": "Response if github advanced security is not enabled for this repository", + "description": "Response if GitHub Advanced Security is not enabled for this repository", "content": { "application/json": { "schema": { @@ -152160,7 +152000,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -152180,7 +152020,7 @@ } }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -152287,7 +152127,7 @@ "required": false, "schema": { "type": "string", - "description": "The full Git reference, formatted as `refs/heads/`." + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." } }, { @@ -152305,7 +152145,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -152315,7 +152155,7 @@ "properties": { "ref": { "type": "string", - "description": "The full Git reference, formatted as `refs/heads/`." + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." }, "commit_sha": { "description": "The SHA of the commit to which the analysis you are uploading relates.", @@ -152456,7 +152296,7 @@ } }, "403": { - "description": "Response if github advanced security is not enabled for this repository", + "description": "Response if GitHub Advanced Security is not enabled for this repository", "content": { "application/json": { "schema": { @@ -152476,7 +152316,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -152496,7 +152336,7 @@ } }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -152568,7 +152408,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -152576,7 +152416,7 @@ "properties": { "ref": { "type": "string", - "description": "The full Git reference, formatted as `refs/heads/`." + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." }, "commit_sha": { "description": "The SHA of the commit to which the analysis you are uploading relates.", @@ -152696,7 +152536,7 @@ } }, "403": { - "description": "Response if github advanced security is not enabled for this repository", + "description": "Response if GitHub Advanced Security is not enabled for this repository", "content": { "application/json": { "schema": { @@ -152716,7 +152556,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -152736,7 +152576,7 @@ } }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -152809,13 +152649,14 @@ "description": "Allow deletion if the specified analysis is the last in a set. The parameter can be used without a value as the parameter value is not considered. If you attempt to delete the final analysis in a set without using this parameter you'll get a 400 response with the message: `Analysis is last of its type and deletion may result in the loss of historical alert data. Please specify confirm_delete.`", "required": false, "schema": { - "type": "string" + "type": "string", + "nullable": true } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -152930,7 +152771,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -152950,7 +152791,7 @@ } }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -152984,7 +152825,7 @@ "/repos/{owner}/{repo}/code-scanning/sarifs": { "post": { "summary": "Upload an analysis as SARIF data", - "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint.\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64\n```\n\nSARIF upload supports a maximum of 1000 results per analysis run. Any results over this limit are ignored. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.\n\nThe `202 Accepted`, response includes an `id` value.\nYou can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload).\"", + "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint.\n\nThere are two places where you can upload code scanning results.\n - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see \"[Triaging code scanning alerts in pull requests](/github/finding-security-vulnerabilities-and-errors-in-your-code/triaging-code-scanning-alerts-in-pull-requests).\"\n - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see \"[Managing code scanning alerts for your repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository).\"\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64\n```\n\nSARIF upload supports a maximum of 1000 results per analysis run. Any results over this limit are ignored. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.\n\nThe `202 Accepted`, response includes an `id` value.\nYou can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload).\"", "operationId": "code-scanning/upload-sarif", "tags": [ "code-scanning" @@ -153026,7 +152867,7 @@ }, "ref": { "type": "string", - "description": "The full Git reference, formatted as `refs/heads/`." + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." }, "sarif": { "description": "A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using [`gzip`](http://www.gnu.org/software/gzip/manual/gzip.html) and then translate the contents of the file into a Base64 encoding string. For more information, see \"[SARIF support for code scanning](https://docs.github.com/github/finding-security-vulnerabilities-and-errors-in-your-code/sarif-support-for-code-scanning).\"", @@ -153059,7 +152900,7 @@ }, "responses": { "202": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -153116,7 +152957,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -153139,7 +152980,7 @@ "description": "Response if the sarif field is too large" }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -153211,7 +153052,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -153247,7 +153088,7 @@ } }, "403": { - "description": "Response if github advanced security is not enabled for this repository", + "description": "Response if GitHub Advanced Security is not enabled for this repository", "content": { "application/json": { "schema": { @@ -153270,7 +153111,7 @@ "description": "Response if the sarif id does not match any upload" }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -153366,7 +153207,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -153541,7 +153382,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -155600,7 +155441,7 @@ "description": "Response when person is already a collaborator" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -155739,7 +155580,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -155958,7 +155799,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -156039,7 +155880,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -156397,7 +156238,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -156686,7 +156527,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -156781,7 +156622,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -157070,7 +156911,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -157140,10 +156981,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -157252,7 +157093,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -157461,7 +157302,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -157481,7 +157322,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -157980,7 +157821,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -158002,7 +157843,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -158135,7 +157976,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -158244,11 +158085,31 @@ "type": "integer", "default": 1 } + }, + { + "name": "top", + "description": "legacy parameter for pagination.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "last_sha", + "description": "legacy parameter for pagination.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -158901,7 +158762,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -158994,7 +158855,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -159051,7 +158912,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -159073,7 +158934,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -159217,7 +159078,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -159610,7 +159471,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -159927,7 +159788,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -160068,7 +159929,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -164043,7 +163904,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -164109,9 +163970,27 @@ "type": "string" } }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -164122,7 +164001,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -164705,7 +164584,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -164774,7 +164653,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -164856,7 +164735,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -164918,11 +164797,19 @@ "type": "integer", "default": 1 } + }, + { + "name": "app_id", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -165905,7 +165792,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -165953,7 +165840,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -168203,18 +168090,36 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true + }, + { + "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", + "description": "Response", "content": { "application/json": { "schema": { @@ -169909,7 +169814,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -169971,7 +169876,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -170000,7 +169905,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -170219,7 +170124,7 @@ } }, "301": { - "description": "Moved Permanently" + "description": "Moved permanently" } }, "x-github": { @@ -170265,7 +170170,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -170365,7 +170270,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -170697,7 +170602,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -172560,7 +172465,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -172622,7 +172527,7 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { @@ -172642,7 +172547,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/vnd.github.v3.object": { "schema": { @@ -173254,7 +173159,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -173337,7 +173242,7 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { @@ -173448,7 +173353,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -173664,7 +173569,7 @@ } }, "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -173880,7 +173785,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -173900,7 +173805,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -174029,7 +173934,7 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { @@ -174103,7 +174008,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -174304,7 +174209,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -174373,7 +174278,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -174413,7 +174318,7 @@ } }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -174655,7 +174560,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -174752,7 +174657,8 @@ "required": false, "schema": { "type": "string", - "default": "none" + "default": "none", + "nullable": true } }, { @@ -174776,7 +174682,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -175443,7 +175349,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -175952,48 +175858,6 @@ "transient_environment": false, "production_environment": true } - }, - "advanced-example": { - "summary": "Advanced example", - "value": { - "url": "https://api.github.com/repos/octocat/example/deployments/1", - "id": 1, - "node_id": "MDEwOkRlcGxveW1lbnQx", - "sha": "a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d", - "ref": "topic-branch", - "task": "deploy", - "payload": { - }, - "original_environment": "staging", - "environment": "production", - "description": "Deploy request from hubot", - "creator": { - "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 - }, - "created_at": "2012-07-20T01:19:13Z", - "updated_at": "2012-07-20T01:19:13Z", - "statuses_url": "https://api.github.com/repos/octocat/example/deployments/1/statuses", - "repository_url": "https://api.github.com/repos/octocat/example", - "transient_environment": false, - "production_environment": true - } } } } @@ -176022,40 +175886,10 @@ } }, "409": { - "description": "response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string", - "example": "\"https://docs.github.com/rest/reference/repos#create-a-deployment\"" - } - } - }, - "examples": { - "merge-conflict-response": { - "summary": "Merge conflict response", - "value": { - "message": "Conflict merging master into topic-branch" - } - }, - "failed-commit-status-checks": { - "summary": "Failed commit status checks", - "value": { - "message": "Conflict: Commit status checks failed for topic-branch." - } - } - } - } - } + "description": "Response when there is a merge conflict or the commit's status checks failed" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -176180,7 +176014,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -176694,7 +176528,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -176768,10 +176602,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -176791,7 +176625,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -176891,7 +176725,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -177415,7 +177249,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -177560,7 +177394,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -178079,7 +177913,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -178217,7 +178051,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -178728,7 +178562,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -178748,7 +178582,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -178852,10 +178686,10 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -179933,450 +179767,16 @@ "subcategory": "environments" } }, - "post": { - "summary": "Create an environment", - "description": "Create an environment for a repository. If an environment with the specified name already exists, the existing environment will be returned.\n\nThe created environment will not have any protection rules configured. To configure protection rules for the created environment, see \"[Set protection rules for an environment](#set-protection-rules-for-an-environment)\".\n\nYou must authenticate using an access token with the repo scope to use this endpoint.", - "tags": [ - "repos" - ], - "operationId": "repos/create-an-environment", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/reference/repos#create-an-environment" - }, - "parameters": [ - { - "name": "owner", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "environment_name", - "in": "path", - "required": true, - "description": "The name of the environment", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "response", - "content": { - "application/json": { - "schema": { - "title": "Environment", - "description": "Details of a deployment environment", - "type": "object", - "properties": { - "id": { - "description": "The id of the environment.", - "example": 56780428, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDExOkVudmlyb25tZW50NTY3ODA0Mjg=" - }, - "name": { - "description": "The name of the environment.", - "example": "staging", - "type": "string" - }, - "url": { - "type": "string", - "example": "https://api.github.com/repos/github/hello-world/environments/staging" - }, - "html_url": { - "type": "string", - "example": "https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging" - }, - "created_at": { - "description": "The time that the environment was created, in ISO 8601 format.", - "example": "2020-11-23T22:00:40Z", - "format": "date-time", - "type": "string" - }, - "updated_at": { - "description": "The time that the environment was last updated, in ISO 8601 format.", - "example": "2020-11-23T22:00:40Z", - "format": "date-time", - "type": "string" - }, - "protection_rules": { - "type": "array", - "items": { - "anyOf": [ - { - "type": "object", - "properties": { - "id": { - "type": "integer", - "example": 3515 - }, - "node_id": { - "type": "string", - "example": "MDQ6R2F0ZTM1MTU=" - }, - "type": { - "type": "string", - "example": "wait_timer" - }, - "wait_timer": { - "type": "integer", - "example": 30, - "description": "The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days)." - } - }, - "required": [ - "id", - "node_id", - "type" - ] - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer", - "example": 3755 - }, - "node_id": { - "type": "string", - "example": "MDQ6R2F0ZTM3NTU=" - }, - "type": { - "type": "string", - "example": "required_reviewers" - }, - "reviewers": { - "type": "array", - "description": "The people or teams that may approve jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type of reviewer. Must be one of: `User` or `Team`", - "enum": [ - "User", - "Team" - ], - "example": "User" - }, - "reviewer": { - "anyOf": [ - { - "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 - }, - { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VGVhbTE=" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/organizations/1/team/1/members{/member}" - }, - "name": { - "description": "Name of the team", - "type": "string", - "example": "Justice League" - }, - "description": { - "description": "Description of the team", - "type": "string", - "nullable": true, - "example": "A great team." - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "example": "admin" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "example": "closed" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1/repos" - }, - "slug": { - "type": "string", - "example": "justice-league" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "example": "uid=example,ou=users,dc=github,dc=com", - "type": "string" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ], - "nullable": true - } - ] - } - } - } - } - }, - "required": [ - "id", - "node_id", - "type" - ] - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer", - "example": 3515 - }, - "node_id": { - "type": "string", - "example": "MDQ6R2F0ZTM1MTU=" - }, - "type": { - "type": "string", - "example": "branch_policy" - } - }, - "required": [ - "id", - "node_id", - "type" - ] - } - ] - } - }, - "deployment_branch_policy": { - "type": "object", - "description": "The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`.", - "properties": { - "protected_branches": { - "type": "boolean", - "description": "Whether only branches with branch protection rules can deploy to this environment. If `protected_branches` is `true`, `custom_branch_policies` must be `false`; if `protected_branches` is `false`, `custom_branch_policies` must be `true`." - }, - "custom_branch_policies": { - "type": "boolean", - "description": "Whether only branches that match the specified name patterns can deploy to this environment. If `custom_branch_policies` is `true`, `protected_branches` must be `false`; if `custom_branch_policies` is `false`, `protected_branches` must be `true`." - } - }, - "nullable": true, - "required": [ - "protected_branches", - "custom_branch_policies" - ] - } - }, - "required": [ - "id", - "node_id", - "name", - "url", - "html_url", - "created_at", - "updated_at" - ] - }, - "examples": { - "default": { - "value": { - "id": 161088068, - "node_id": "MDExOkVudmlyb25tZW50MTYxMDg4MDY4", - "name": "staging", - "url": "https://api.github.com/repos/github/hello-world/environments/staging", - "html_url": "https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging", - "created_at": "2020-11-23T22:00:40Z", - "updated_at": "2020-11-23T22:00:40Z", - "protection_rules": [ - - ], - "deployment_branch_policy": null - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [ - - ], - "category": "repos", - "subcategory": "environments" - } - }, "put": { - "summary": "Set protection rules for an environment", - "description": "Set protection rules, such as required reviewers, for an environment. For more information about environment protection rules, see \"[Environments](/actions/reference/environments#environment-protection-rules).\"\n\n**Note:** Although you can use this operation to specify that only branches that match specified name patterns can deploy to this environment, you must use the UI to set the name patterns. For more information, see \"[Environments](/actions/reference/environments#deployment-branches).\"\n\nYou must authenticate using an access token with the repo scope to use this endpoint.", + "summary": "Create or update an environment", + "description": "Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see \"[Environments](/actions/reference/environments#environment-protection-rules).\"\n\n**Note:** Although you can use this operation to specify that only branches that match specified name patterns can deploy to this environment, you must use the UI to set the name patterns. For more information, see \"[Environments](/actions/reference/environments#deployment-branches).\"\n\n**Note:** To create or update secrets for an environment, see \"[Secrets](/rest/reference/actions#secrets).\"\n\nYou must authenticate using an access token with the repo scope to use this endpoint.", "tags": [ "repos" ], - "operationId": "repos/set-environment-protection-rules", + "operationId": "repos/create-or-update-environment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reference/repos#set-protection-rules-for-an-environment" + "url": "https://docs.github.com/rest/reference/repos#create-or-update-an-environment" }, "parameters": [ { @@ -180410,6 +179810,7 @@ "application/json": { "schema": { "type": "object", + "nullable": true, "properties": { "wait_timer": { "type": "integer", @@ -180418,7 +179819,8 @@ }, "reviewers": { "type": "array", - "description": "The people or teams that may jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.", + "nullable": true, + "description": "The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.", "items": { "type": "object", "properties": { @@ -180458,7 +179860,8 @@ "custom_branch_policies" ] } - } + }, + "additionalProperties": false } } } @@ -180908,7 +180311,7 @@ } }, "422": { - "description": "Response when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` are set to the same value", + "description": "Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` are set to the same value", "content": { "application/json": { "schema": { @@ -181042,7 +180445,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -183760,7 +183163,8 @@ "enum": [ "newest", "oldest", - "stargazers" + "stargazers", + "watchers" ], "default": "newest" } @@ -183782,11 +183186,31 @@ "type": "integer", "default": 1 } + }, + { + "name": "org", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "organization", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -185502,6 +184926,26 @@ "schema": { "type": "string" } + }, + { + "name": "org", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "organization", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } } ], "requestBody": { @@ -185509,6 +184953,7 @@ "application/json": { "schema": { "type": "object", + "nullable": true, "properties": { "organization": { "type": "string", @@ -185521,7 +184966,7 @@ }, "responses": { "202": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -186670,7 +186115,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -186759,7 +186204,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -186849,7 +186294,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -186889,7 +186334,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -186949,7 +186394,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -187069,7 +186514,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -187126,7 +186571,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -187146,7 +186591,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -187361,7 +186806,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -187577,7 +187022,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -187646,7 +187091,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -187719,7 +187164,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -187927,7 +187372,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -187989,7 +187434,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -188018,7 +187463,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -188151,7 +187596,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -188162,7 +187607,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -188230,7 +187675,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -188324,7 +187769,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -188400,7 +187845,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -188511,7 +187956,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -188549,7 +187994,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -188617,7 +188062,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -188726,7 +188171,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -188737,10 +188182,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -188919,7 +188364,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -189066,7 +188511,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -189186,7 +188631,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -189325,7 +188770,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -189459,7 +188904,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -189587,7 +189032,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -189656,7 +189101,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -189742,7 +189187,8 @@ "required": true, "schema": { "type": "string" - } + }, + "x-multi-segment": true }, { "name": "recursive", @@ -189756,7 +189202,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -189910,7 +189356,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -189979,7 +189425,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -190060,7 +189506,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -190257,7 +189703,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -190402,7 +189848,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -190594,7 +190040,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -190614,7 +190060,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -190754,7 +190200,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -190938,7 +190384,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -191091,7 +190537,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -191275,7 +190721,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -191344,7 +190790,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -191413,10 +190859,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -191487,7 +190933,7 @@ ], "responses": { "200": { - "description": "Default response", + "description": "Response", "content": { "application/json": { "schema": { @@ -191619,7 +191065,7 @@ }, "responses": { "200": { - "description": "Default response", + "description": "Response", "content": { "application/json": { "schema": { @@ -191715,10 +191161,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -191789,10 +191235,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -191855,7 +191301,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -192011,7 +191457,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -192118,7 +191564,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -192283,7 +191729,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -192352,7 +191798,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -192449,7 +191895,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -192681,7 +192127,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -192736,7 +192182,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -192818,7 +192264,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -192916,7 +192362,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -192975,7 +192421,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -193044,7 +192490,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -193107,7 +192553,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -193234,7 +192680,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -193390,7 +192836,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -193502,7 +192948,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -194009,10 +193455,10 @@ } }, "301": { - "description": "Moved Permanently" + "description": "Moved permanently" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -194075,7 +193521,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -194201,7 +193647,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -194292,7 +193738,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "409": { "description": "Conflict" @@ -194359,7 +193805,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -196349,7 +195795,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -198303,7 +197749,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -198465,7 +197911,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -200635,10 +200081,10 @@ } }, "301": { - "description": "Moved Permanently" + "description": "Moved permanently" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -200707,7 +200153,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -200866,7 +200312,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -203222,7 +202668,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -203291,7 +202737,7 @@ } }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -203312,7 +202758,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -203450,7 +202896,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -203995,7 +203441,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -204064,7 +203510,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -204140,7 +203586,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -204672,7 +204118,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -204767,7 +204213,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -205299,7 +204745,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -205418,7 +204864,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -205510,7 +204956,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -205719,7 +205165,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -205739,7 +205185,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -206238,7 +205684,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -206260,7 +205706,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -206393,7 +205839,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -206461,7 +205907,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -209563,7 +209009,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -209687,7 +209133,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -212776,7 +212222,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -212892,7 +212338,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -215220,10 +214666,10 @@ } }, "301": { - "description": "Moved Permanently" + "description": "Moved permanently" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -215263,7 +214709,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -215422,7 +214868,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -217750,7 +217196,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -217819,7 +217265,7 @@ } }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -217860,10 +217306,10 @@ } }, "301": { - "description": "Moved Permanently" + "description": "Moved permanently" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -217979,7 +217425,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -220250,7 +219696,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -222526,7 +221972,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -223071,7 +222517,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -223186,7 +222632,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -223766,7 +223212,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -223835,7 +223281,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -223926,7 +223372,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -224279,7 +223725,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -224467,7 +223913,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -224570,7 +224016,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -224713,7 +224159,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -224816,7 +224262,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -224935,7 +224381,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "410": { "description": "Gone", @@ -225018,7 +224464,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -225092,7 +224538,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -225206,7 +224652,7 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -225249,7 +224695,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -225269,7 +224715,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -225388,7 +224834,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -225411,7 +224857,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -225520,7 +224966,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -225729,7 +225175,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -225769,7 +225215,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -225876,7 +225322,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -226072,7 +225518,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -226094,7 +225540,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -226227,7 +225673,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -226304,7 +225750,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -226563,7 +226009,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -226603,7 +226049,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -226695,7 +226141,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -226837,7 +226283,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -226902,7 +226348,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -227023,7 +226469,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -227080,7 +226526,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -227150,7 +226596,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -227214,7 +226660,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -227305,7 +226751,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -227397,7 +226843,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -227474,7 +226920,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -227543,7 +226989,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -227614,7 +227060,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -227683,7 +227129,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -227780,7 +227226,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -227898,7 +227344,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -227944,7 +227390,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -228010,7 +227456,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -228836,63 +228282,10 @@ } }, "404": { - "description": "response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string", - "example": "\"https://docs.github.com/rest/reference/repos#perform-a-merge\"" - } - } - }, - "examples": { - "missing-base-response": { - "summary": "Missing base response", - "value": { - "message": "Base does not exist" - } - }, - "missing-head-response": { - "summary": "Missing head response", - "value": { - "message": "Head does not exist" - } - } - } - } - } + "description": "Response when the base or head does not exist" }, "409": { - "description": "Merge conflict response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string", - "example": "\"https://docs.github.com/rest/reference/repos#perform-a-merge\"" - } - } - }, - "examples": { - "merge-conflict-response": { - "value": { - "message": "Merge Conflict" - } - } - } - } - } + "description": "Response when there is a merge conflict" }, "403": { "description": "Forbidden", @@ -228915,7 +228308,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -229088,7 +228481,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -229369,7 +228762,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -229471,7 +228864,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -229747,7 +229140,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -229767,7 +229160,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -229888,7 +229281,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -230156,7 +229549,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -230264,7 +229657,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -230582,10 +229975,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -230675,7 +230068,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -230865,7 +230258,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -232580,7 +231973,7 @@ }, "responses": { "202": { - "description": "response" + "description": "Response" } }, "x-github": { @@ -232626,7 +232019,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -232719,7 +232112,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -232823,7 +232216,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -232916,7 +232309,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -232985,7 +232378,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -233137,10 +232530,10 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -233304,10 +232697,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -233376,7 +232769,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -233398,7 +232791,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -233483,7 +232876,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -233746,7 +233139,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -233824,7 +233217,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -234084,7 +233477,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -234369,7 +233762,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -234638,7 +234031,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -234678,7 +234071,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -234718,7 +234111,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -234819,7 +234212,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -235075,7 +234468,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -235115,7 +234508,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -235155,7 +234548,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -235312,7 +234705,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -239287,10 +238680,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -239449,7 +238842,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -242625,7 +242018,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -242737,16 +242130,15 @@ }, { "name": "sort", - "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to).", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "created", - "updated" - ], - "default": "created" + "updated", + "created_at" + ] } }, { @@ -242792,7 +242184,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -243318,7 +242710,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -243770,7 +243162,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -243870,7 +243262,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -244376,10 +243768,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -244488,7 +243880,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -244697,7 +244089,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -244717,7 +244109,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -245216,7 +244608,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -245238,7 +244630,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -245371,7 +244763,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -248577,7 +247969,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "500": { "description": "Internal Error", @@ -248600,7 +247992,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -248710,7 +248102,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -251858,7 +251250,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -252052,7 +251444,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -252658,7 +252050,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -253118,7 +252510,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -253293,7 +252685,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -253753,7 +253145,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -253843,7 +253235,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -254491,7 +253883,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -254592,7 +253984,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -254907,7 +254299,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -254996,7 +254388,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -255086,7 +254478,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -255448,7 +254840,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -259561,10 +258953,10 @@ }, "responses": { "200": { - "description": "response" + "description": "Response" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -260121,7 +259513,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -260397,7 +259789,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -260508,7 +259900,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -260784,7 +260176,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -260883,7 +260275,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -261159,7 +260551,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -261247,7 +260639,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -261523,7 +260915,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -261553,7 +260945,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -261651,7 +261043,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -262052,7 +261444,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -262154,7 +261546,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -262430,7 +261822,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -262450,7 +261842,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -262567,7 +261959,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -262843,7 +262235,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -262863,7 +262255,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -262983,7 +262375,7 @@ }, "responses": { "202": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -263005,7 +262397,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -263094,7 +262486,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -263170,6 +262562,279 @@ } } ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Content File", + "description": "Content File", + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "encoding": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "path": { + "type": "string" + }, + "content": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "git_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "download_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "_links": { + "type": "object", + "properties": { + "git": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html": { + "type": "string", + "format": "uri", + "nullable": true + }, + "self": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "git", + "html", + "self" + ] + }, + "target": { + "type": "string", + "example": "\"actual/actual.md\"" + }, + "submodule_git_url": { + "type": "string", + "example": "\"git://example.com/defunkt/dotjs.git\"" + } + }, + "required": [ + "_links", + "git_url", + "html_url", + "download_url", + "name", + "path", + "sha", + "size", + "type", + "url", + "content", + "encoding" + ] + }, + "examples": { + "default": { + "value": { + "type": "file", + "encoding": "base64", + "size": 5362, + "name": "README.md", + "path": "README.md", + "content": "encoded content ...", + "sha": "3d21ec53a331a6f037a91c368710b99387d012c1", + "url": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md", + "git_url": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1", + "html_url": "https://github.com/octokit/octokit.rb/blob/master/README.md", + "download_url": "https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md", + "_links": { + "git": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1", + "self": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md", + "html": "https://github.com/octokit/octokit.rb/blob/master/README.md" + } + } + } + } + } + } + }, + "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" + } + } + } + } + } + }, + "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" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "repos", + "subcategory": "contents" + } + } + }, + "/repos/{owner}/{repo}/readme/{dir}": { + "get": { + "summary": "Get a repository README", + "description": "Gets the preferred README for a repository.\n\nREADMEs support [custom media types](https://docs.github.com/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML.", + "tags": [ + "repos" + ], + "operationId": "repos/get-readme-from-alt-path", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#get-a-repository-readme" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "dir", + "description": "The alternate path to look for a README file", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + }, + { + "name": "ref", + "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], "responses": { "200": { "description": "response", @@ -263294,7 +262959,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -263314,7 +262979,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -263444,7 +263109,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -263944,7 +263609,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -264053,7 +263718,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -264548,7 +264213,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -264902,7 +264567,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -264922,7 +264587,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -265024,7 +264689,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -265306,7 +264971,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -265352,7 +265017,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -265881,7 +265546,7 @@ }, { "name": "tag", - "description": "tag+ parameter", + "description": "tag parameter", "in": "path", "required": true, "schema": { @@ -265892,7 +265557,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -266379,7 +266044,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -266938,7 +266603,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -267051,7 +266716,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -267588,7 +267253,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -267661,7 +267326,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -268545,7 +268210,7 @@ "description": "Repository is public or secret scanning is disabled for the repository" }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -268621,7 +268286,7 @@ ], "responses": { "200": { - "description": "Default response", + "description": "Response", "content": { "application/json": { "schema": { @@ -268833,7 +268498,7 @@ "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found" }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -268953,7 +268618,7 @@ }, "responses": { "200": { - "description": "Default response", + "description": "Response", "content": { "application/json": { "schema": { @@ -269187,7 +268852,7 @@ "description": "State does not match the resolution" }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -269268,7 +268933,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -269592,7 +269257,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -269776,7 +269441,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -270277,7 +269942,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -270474,7 +270139,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -270749,7 +270414,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -271093,7 +270758,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -271196,7 +270861,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -271260,7 +270925,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -271392,7 +271057,7 @@ ], "responses": { "302": { - "description": "response", + "description": "Response", "headers": { "Location": { "example": "https://codeload.github.com/me/myprivate/legacy.zip/master?login=me&token=thistokenexpires", @@ -271464,7 +271129,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -271682,11 +271347,29 @@ "schema": { "type": "string" } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -271721,7 +271404,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -271743,7 +271426,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -271837,7 +271520,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -271872,7 +271555,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -271894,7 +271577,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -271914,7 +271597,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -271996,6 +271679,7 @@ "schema": { "type": "string", "enum": [ + "", "day", "week" ], @@ -272005,7 +271689,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -272204,7 +271888,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -272372,7 +272056,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -272500,6 +272184,7 @@ "schema": { "type": "string", "enum": [ + "", "day", "week" ], @@ -272509,7 +272194,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -272740,7 +272425,7 @@ }, "responses": { "202": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -273929,7 +273614,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -273977,7 +273662,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -274035,7 +273720,7 @@ ], "responses": { "302": { - "description": "response", + "description": "Response", "headers": { "Location": { "example": "https://codeload.github.com/me/myprivate/legacy.zip/master?login=me&token=thistokenexpires", @@ -274060,7 +273745,7 @@ "/repos/{template_owner}/{template_repo}/generate": { "post": { "summary": "Create a repository using a template", - "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", + "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository", "tags": [ "repos" ], @@ -274132,7 +273817,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -275246,7 +274931,7 @@ "/repositories": { "get": { "summary": "List public repositories", - "description": "Lists all public repositories in the order that they were created.\n\nNote: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.", + "description": "Lists all public repositories in the order that they were created.\n\nNotes:\n- For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise.\n- Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.", "tags": [ "repos" ], @@ -275268,7 +274953,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -276848,7 +276533,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -276917,7 +276602,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -277303,7 +276988,8 @@ "properties": { "encrypted_value": { "type": "string", - "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/rest/reference/actions#get-an-environment-public-key) endpoint." + "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/rest/reference/actions#get-an-environment-public-key) endpoint.", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" }, "key_id": { "type": "string", @@ -277312,7 +276998,7 @@ } }, "example": { - "encrypted_value": "****************************************************************************************", + "encrypted_value": "c2VjcmV0", "key_id": "012345678912345678" } } @@ -277430,11 +277116,29 @@ "schema": { "type": "integer" } + }, + { + "name": "filter", + "description": "filter results", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "excludedAttributes", + "description": "attributes to exclude", + "in": "query", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -277680,7 +277384,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -277817,11 +277521,20 @@ "schema": { "type": "string" } + }, + { + "name": "excludedAttributes", + "description": "Attributes to exclude.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -278015,7 +277728,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -278168,8 +277881,41 @@ "Operations": { "type": "array", "description": "Array of [SCIM operations](https://tools.ietf.org/html/rfc7644#section-3.5.2).", + "minItems": 1, "items": { - "type": "object" + "type": "object", + "properties": { + "op": { + "type": "string", + "enum": [ + "add", + "Add", + "remove", + "Remove", + "replace", + "Replace" + ] + }, + "path": { + "type": "string" + }, + "value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object" + }, + { + "type": "array" + } + ] + } + }, + "required": [ + "op" + ] } } }, @@ -278199,7 +277945,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -278333,7 +278079,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -278386,11 +278132,20 @@ "schema": { "type": "integer" } + }, + { + "name": "filter", + "description": "filter results", + "in": "query", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -278723,7 +278478,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -278893,7 +278648,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -279166,7 +278921,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -279385,7 +279140,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -279557,7 +279312,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -279622,7 +279377,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/scim+json": { "schema": { @@ -279973,10 +279728,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -280228,7 +279983,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/scim+json": { "schema": { @@ -280466,10 +280221,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -280976,7 +280731,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/scim+json": { "schema": { @@ -281214,7 +280969,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -281360,7 +281115,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -281405,7 +281160,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/scim+json": { "schema": { @@ -281643,10 +281398,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -281932,7 +281687,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/scim+json": { "schema": { @@ -282170,10 +281925,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -282552,10 +282307,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -282701,7 +282456,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -282784,7 +282539,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -284484,10 +284239,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -284508,7 +284263,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -284678,7 +284433,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -286671,10 +286426,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -286790,7 +286545,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -288936,7 +288691,7 @@ } }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -288957,7 +288712,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -289026,7 +288781,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -289121,7 +288876,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -289259,10 +289014,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -289302,7 +289057,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -289454,7 +289209,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -290163,7 +289918,7 @@ } }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -290184,7 +289939,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -290253,7 +290008,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -290296,7 +290051,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -290570,10 +290325,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -290681,7 +290436,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -290925,10 +290680,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -290949,7 +290704,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -291053,7 +290808,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -291544,7 +291299,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -291650,7 +291405,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -292141,7 +291896,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -292161,7 +291916,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -292286,10 +292041,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -292309,7 +292064,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -292448,7 +292203,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -292863,7 +292618,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -293244,7 +292999,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -293644,7 +293399,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -294022,7 +293777,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -294103,7 +293858,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -294481,7 +294236,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -294836,7 +294591,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -295209,7 +294964,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -295561,7 +295316,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -295655,7 +295410,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -295951,7 +295706,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -296234,7 +295989,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -296522,7 +296277,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -296778,7 +296533,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -297072,7 +296827,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -297228,7 +296983,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -297344,74 +297099,13 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { "description": "Response if team synchronization is set up" }, "422": { - "description": "response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "field": { - "type": "string" - }, - "resource": { - "type": "string" - } - } - } - }, - "documentation_url": { - "type": "string", - "example": "\"https://docs.github.com/rest\"" - } - } - }, - "examples": { - "response-if-you-attempt-to-add-an-organization-to-a-team": { - "summary": "Response if you attempt to add an organization to a team", - "value": { - "message": "Cannot add an organization as a member.", - "errors": [ - { - "code": "org", - "field": "user", - "resource": "TeamMember" - } - ] - } - }, - "response-if-you-attempt-to-add-a-user-to-a-team-when-they-are-not-a-member-of-at-least-one-other-team-in-the-same-organization": { - "summary": "Response if you attempt to add a user to a team when they are not a member of at least one other team in the same organization", - "value": { - "message": "User isn't a member of this organization. Please invite them first.", - "errors": [ - { - "code": "unaffiliated", - "field": "user", - "resource": "TeamMember" - } - ] - } - } - } - } - } + "description": "Response if you attempt to add an organization to a team or you attempt to add a user to a team when they are not a member of at least one other team in the same organization" }, "403": { "description": "Forbidden", @@ -297478,7 +297172,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { "description": "Response if team synchronization is setup" @@ -297501,7 +297195,7 @@ "/teams/{team_id}/memberships/{username}": { "get": { "summary": "Get team membership for a user (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 [Get team membership for a user](https://docs.github.com/rest/reference/teams#get-team-membership-for-a-user) endpoint.\n\nTeam members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:** The `role` for organization owners returns as `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/reference/teams#create-a-team).", + "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 [Get team membership for a user](https://docs.github.com/rest/reference/teams#get-team-membership-for-a-user) endpoint.\n\nTeam members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:**\nThe response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/reference/teams#create-a-team).", "tags": [ "teams" ], @@ -297530,7 +297224,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -297553,7 +297247,12 @@ "type": "string" }, "state": { - "type": "string" + "description": "The state of the user's membership in the team.", + "type": "string", + "enum": [ + "active", + "pending" + ] } }, "required": [ @@ -297563,14 +297262,6 @@ ] }, "examples": { - "response-if-user-has-an-active-membership-with-team": { - "summary": "Response if user has an active membership with team", - "value": { - "url": "https://api.github.com/teams/1/memberships/octocat", - "role": "member", - "state": "active" - } - }, "response-if-user-is-a-team-maintainer": { "summary": "Response if user is a team maintainer", "value": { @@ -297578,21 +297269,13 @@ "role": "maintainer", "state": "active" } - }, - "response-if-user-has-a-pending-membership-with-team": { - "summary": "Response if user has a pending membership with team", - "value": { - "url": "https://api.github.com/teams/1/memberships/octocat", - "role": "member", - "state": "pending" - } } } } } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -297676,7 +297359,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -297699,7 +297382,12 @@ "type": "string" }, "state": { - "type": "string" + "description": "The state of the user's membership in the team.", + "type": "string", + "enum": [ + "active", + "pending" + ] } }, "required": [ @@ -297709,14 +297397,6 @@ ] }, "examples": { - "response-if-users-membership-with-team-is-now-active": { - "summary": "Response if user's membership with team is now active", - "value": { - "url": "https://api.github.com/teams/1/memberships/octocat", - "role": "member", - "state": "active" - } - }, "response-if-users-membership-with-team-is-now-pending": { "summary": "Response if user's membership with team is now pending", "value": { @@ -297733,57 +297413,10 @@ "description": "Response if team synchronization is set up" }, "422": { - "description": "Response if you attempt to add an organization to a team", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "field": { - "type": "string" - }, - "resource": { - "type": "string" - } - } - } - }, - "documentation_url": { - "type": "string", - "example": "\"https://help.github.com/articles/github-and-trade-controls\"" - } - } - }, - "examples": { - "response-if-you-attempt-to-add-an-organization-to-a-team": { - "value": { - "message": "Cannot add an organization as a member.", - "errors": [ - { - "code": "org", - "field": "user", - "resource": "TeamMember" - } - ] - } - } - } - } - } + "description": "Response if you attempt to add an organization to a team" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -297847,7 +297480,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Response if team synchronization is set up" @@ -297909,7 +297542,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -298173,7 +297806,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -298193,7 +297826,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -298265,7 +297898,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -298519,7 +298152,7 @@ "description": "Response if project is not managed by this team" }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -298609,7 +298242,7 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Response if the project is not owned by the organization", @@ -298638,7 +298271,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -298658,7 +298291,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -298680,7 +298313,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -298797,10 +298430,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -298820,7 +298453,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -298842,7 +298475,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -298967,7 +298600,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -300702,7 +300335,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -302717,7 +302350,7 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -302740,7 +302373,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -302861,7 +302494,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -302902,7 +302535,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -303005,7 +302638,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -303127,7 +302760,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -303205,7 +302838,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -303541,7 +303174,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -303581,7 +303214,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -303681,7 +303314,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -304235,7 +303868,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -304258,7 +303891,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -304354,7 +303987,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -304661,10 +304294,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -304704,7 +304337,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -304724,7 +304357,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -304821,7 +304454,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -304969,10 +304602,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -305012,7 +304645,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -305032,7 +304665,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -305112,7 +304745,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -305135,7 +304768,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -305188,13 +304821,13 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -305234,7 +304867,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -305254,7 +304887,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -305356,10 +304989,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -305382,7 +305015,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -305402,7 +305035,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -305478,7 +305111,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -305531,10 +305164,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -305574,7 +305207,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -305594,7 +305227,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -305708,7 +305341,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -305769,10 +305402,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -305812,7 +305445,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -305905,7 +305538,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -305970,7 +305603,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -306039,10 +305672,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -306082,7 +305715,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -306173,13 +305806,13 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -306219,7 +305852,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -306239,7 +305872,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -306353,7 +305986,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -306509,7 +306142,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -306532,7 +306165,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -306597,7 +306230,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -306753,7 +306386,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -306776,7 +306409,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -306854,7 +306487,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -306877,7 +306510,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -306930,13 +306563,13 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -306976,7 +306609,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -307029,13 +306662,13 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -307075,7 +306708,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -307140,7 +306773,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -307362,10 +306995,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -307405,7 +307038,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -307469,7 +307102,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -307678,7 +307311,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -307747,10 +307380,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -307790,7 +307423,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -307846,7 +307479,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -308055,7 +307688,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -308075,7 +307708,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -308098,7 +307731,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -308152,10 +307785,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -308175,7 +307808,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -308244,7 +307877,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -308267,7 +307900,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -308915,7 +308548,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -308938,7 +308571,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -308958,7 +308591,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -310160,7 +309793,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -310200,7 +309833,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -310251,7 +309884,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -310274,10 +309907,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -310339,7 +309972,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -310362,10 +309995,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -310410,7 +310043,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -310518,7 +310151,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -310565,7 +310198,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -310657,7 +310290,7 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -310696,6 +310329,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -310784,7 +310418,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -313227,7 +312861,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -313247,7 +312881,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -313299,7 +312933,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -313385,10 +313019,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -313428,7 +313062,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -313498,7 +313132,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -313561,7 +313195,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -313630,10 +313264,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -313673,7 +313307,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -313729,7 +313363,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -313792,7 +313426,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -313812,7 +313446,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -313835,7 +313469,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -313889,13 +313523,13 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -313935,7 +313569,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -314000,7 +313634,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -314226,10 +313860,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -314249,7 +313883,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -314314,7 +313948,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -314540,10 +314174,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -314621,7 +314255,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -314638,11 +314272,21 @@ }, "state": { "type": "string", - "example": "active" + "description": "The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.", + "example": "active", + "enum": [ + "active", + "pending" + ] }, "role": { "type": "string", - "example": "admin" + "description": "The user's membership type in the organization.", + "example": "admin", + "enum": [ + "admin", + "member" + ] }, "organization_url": { "type": "string", @@ -314959,7 +314603,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -314982,7 +314626,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -315002,7 +314646,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -315106,7 +314750,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -315121,11 +314765,21 @@ }, "state": { "type": "string", - "example": "active" + "description": "The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.", + "example": "active", + "enum": [ + "active", + "pending" + ] }, "role": { "type": "string", - "example": "admin" + "description": "The user's membership type in the organization.", + "example": "admin", + "enum": [ + "admin", + "member" + ] }, "organization_url": { "type": "string", @@ -315411,7 +315065,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -315488,7 +315142,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -315503,11 +315157,21 @@ }, "state": { "type": "string", - "example": "active" + "description": "The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.", + "example": "active", + "enum": [ + "active", + "pending" + ] }, "role": { "type": "string", - "example": "admin" + "description": "The user's membership type in the organization.", + "example": "admin", + "enum": [ + "admin", + "member" + ] }, "organization_url": { "type": "string", @@ -315793,7 +315457,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -315813,7 +315477,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -315927,7 +315591,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -317254,7 +316918,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -317277,7 +316941,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -317377,7 +317041,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -318691,7 +318355,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -318760,7 +318424,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -318783,7 +318447,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -318850,7 +318514,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -320164,7 +319828,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -320184,7 +319848,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -320207,7 +319871,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -320267,10 +319931,10 @@ ], "responses": { "302": { - "description": "response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -320293,7 +319957,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -320351,10 +320015,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -320374,7 +320038,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -320397,7 +320061,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -320466,13 +320130,13 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -320512,7 +320176,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -320590,7 +320254,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -322325,7 +321989,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -322394,7 +322058,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -322505,7 +322169,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -322528,7 +322192,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -324439,10 +324103,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -324482,7 +324146,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -324551,14 +324215,23 @@ "schema": { "type": "string" } + }, + { + "name": "token", + "description": "package token", + "schema": { + "type": "string" + }, + "required": false, + "in": "query" } ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -324598,7 +324271,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -324636,7 +324309,7 @@ "tags": [ "packages" ], - "operationId": "packages/get-all-package-versions-for-a-package-owned-by-the-authenticated-user", + "operationId": "packages/get-all-package-versions-for-package-owned-by-authenticated-user", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/reference/packages#get-all-package-versions-for-a-package-owned-by-the-authenticated-user" @@ -324667,6 +324340,38 @@ "schema": { "type": "string" } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "state", + "in": "query", + "required": false, + "description": "The state of the package, either active or deleted.", + "schema": { + "type": "string", + "enum": [ + "active", + "deleted" + ], + "default": "active" + } } ], "responses": { @@ -324825,7 +324530,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -324865,7 +324570,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -325139,10 +324844,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -325182,7 +324887,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -325264,10 +324969,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -325307,7 +325012,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -325380,7 +325085,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -325636,7 +325341,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -325659,7 +325364,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -325679,7 +325384,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -325701,7 +325406,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -325780,7 +325485,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -325841,10 +325546,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -325884,7 +325589,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -325930,7 +325635,7 @@ "parameters": [ { "name": "visibility", - "description": "Can be one of `all`, `public`, or `private`.", + "description": "Can be one of `all`, `public`, or `private`. Note: For GitHub AE, can be one of `all`, `internal`, or `private`.", "in": "query", "required": false, "schema": { @@ -325955,7 +325660,7 @@ }, { "name": "type", - "description": "Can be one of `all`, `owner`, `public`, `private`, `member`. Default: `all` \n \nWill cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.", + "description": "Can be one of `all`, `owner`, `public`, `private`, `member`. Note: For GitHub AE, can be one of `all`, `owner`, `internal`, `private`, `member`. Default: `all` \n \nWill cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.", "in": "query", "required": false, "schema": { @@ -326038,7 +325743,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -327139,7 +326844,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -327208,7 +326913,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -327231,7 +326936,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -327263,7 +326968,7 @@ }, "post": { "summary": "Create a repository for the authenticated user", - "description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", + "description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository.", "tags": [ "repos" ], @@ -327294,7 +326999,7 @@ "type": "string" }, "private": { - "description": "Whether the repository is private or public.", + "description": "Whether the repository is private.", "default": false, "type": "boolean" }, @@ -327382,7 +327087,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -328485,7 +328190,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -328505,10 +328210,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -328548,7 +328253,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -328725,7 +328430,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -330641,10 +330346,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -330684,7 +330389,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -330740,7 +330445,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -330783,7 +330488,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -330803,7 +330508,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -330840,7 +330545,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "409": { "description": "Conflict", @@ -330863,10 +330568,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -330979,7 +330684,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -333202,7 +332907,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -333225,7 +332930,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -333311,7 +333016,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -333331,7 +333036,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -333395,7 +333100,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -333418,7 +333123,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -333438,7 +333143,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -333458,7 +333163,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -333502,10 +333207,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -333525,7 +333230,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -333545,7 +333250,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -333613,7 +333318,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -335348,7 +335053,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -335371,7 +335076,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -335436,7 +335141,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -335940,10 +335645,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -336028,7 +335733,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -336184,7 +335889,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -336222,7 +335927,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -336770,7 +336475,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -336843,7 +336548,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -339572,7 +339277,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -342293,7 +341998,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -345014,7 +344719,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -345223,7 +344928,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -345490,7 +345195,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -345908,7 +345613,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -346030,7 +345735,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -346311,7 +346016,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -346358,7 +346063,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -346378,7 +346083,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -346482,7 +346187,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -347042,7 +346747,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -347140,7 +346845,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -349321,7 +349026,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -349361,7 +349066,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -349648,7 +349353,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -349917,7 +349622,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -349939,7 +349644,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -350065,7 +349770,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -352786,7 +352491,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -355468,7 +355173,7 @@ "/users/{username}/repos": { "get": { "summary": "List repositories for a user", - "description": "Lists public repositories for the specified user.", + "description": "Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user.", "tags": [ "repos" ], @@ -355551,7 +355256,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -357304,7 +357009,7 @@ "/users/{username}/settings/billing/actions": { "get": { "summary": "Get GitHub Actions billing for a user", - "description": "Gets the summary of the free and paid GitHub Actions minutes used.\n\nPaid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nAccess tokens must have the `user` scope.", + "description": "Gets the summary of the free and paid GitHub Actions minutes used.\n\nPaid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nAccess tokens must have the `user` scope.", "operationId": "billing/get-github-actions-billing-user", "tags": [ "billing" @@ -357325,7 +357030,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -357421,7 +357126,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -357494,7 +357199,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -357613,7 +357318,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -359889,7 +359594,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -361645,7 +361350,7 @@ "operationId": "meta/get-zen", "responses": { "200": { - "description": "response", + "description": "Response", "content": { "text/plain": { "schema": { diff --git a/lib/rest/static/dereferenced/ghes-2.18.deref.json b/lib/rest/static/dereferenced/ghes-2.18.deref.json index 98d31cf026..6c95b5d1ef 100644 --- a/lib/rest/static/dereferenced/ghes-2.18.deref.json +++ b/lib/rest/static/dereferenced/ghes-2.18.deref.json @@ -134,7 +134,7 @@ ], "servers": [ { - "url": "{protocol}://{hostname}", + "url": "{protocol}://{hostname}/api/v3", "variables": { "hostname": { "description": "Self-hosted Enterprise Server or Enterprise Cloud hostname", @@ -162,7 +162,7 @@ "operationId": "meta/root", "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -394,7 +394,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -529,7 +529,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -729,7 +729,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -859,7 +859,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -1040,7 +1040,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -1092,7 +1092,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -1140,11 +1140,48 @@ "type": "integer", "default": 1 } + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "accessed" + ], + "default": "created" + } + }, + { + "name": "since", + "description": "Only show public keys accessed after the given time.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -1242,7 +1279,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -1280,7 +1317,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -1407,7 +1444,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -1460,7 +1497,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -1607,7 +1644,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -1650,7 +1687,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -1815,7 +1852,7 @@ ], "responses": { "202": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -1899,11 +1936,39 @@ "type": "integer", "default": 1 } + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -2026,7 +2091,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -2166,7 +2231,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -2277,7 +2342,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -2454,7 +2519,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "422": { "description": "Client Errors", @@ -2542,7 +2607,7 @@ ], "responses": { "202": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -2663,7 +2728,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -2744,11 +2809,40 @@ "type": "integer", "default": 1 } + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "sort", + "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to) or `name`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -2905,7 +2999,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -3128,7 +3222,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -3290,7 +3384,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -3500,7 +3594,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -3552,7 +3646,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -4262,7 +4356,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -4290,7 +4384,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -4494,7 +4588,7 @@ ], "responses": { "202": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -4570,7 +4664,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -4608,7 +4702,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -5309,7 +5403,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -5340,7 +5434,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -5666,7 +5760,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -5987,7 +6081,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -6007,7 +6101,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -6642,7 +6736,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -7130,7 +7224,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -7150,7 +7244,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -7219,10 +7313,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -7577,7 +7671,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -8736,7 +8830,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -8758,7 +8852,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -8778,7 +8872,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -8798,7 +8892,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -8911,11 +9005,20 @@ "type": "integer", "default": 1 } + }, + { + "name": "client_id", + "in": "query", + "required": false, + "description": "The client ID of your GitHub app.", + "schema": { + "type": "string" + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -9133,7 +9236,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -9156,7 +9259,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -9176,7 +9279,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -9235,7 +9338,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -9440,7 +9543,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -9463,7 +9566,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -9520,10 +9623,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -9546,7 +9649,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -9613,7 +9716,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -9660,7 +9763,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -9868,7 +9971,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -10076,7 +10179,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -10114,7 +10217,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -10422,7 +10525,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -10442,7 +10545,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -10508,11 +10611,20 @@ "type": "integer", "default": 1 } + }, + { + "name": "client_id", + "in": "query", + "required": false, + "description": "The client ID of your GitHub app.", + "schema": { + "type": "string" + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -11187,7 +11299,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -11210,7 +11322,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -11230,7 +11342,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -11325,7 +11437,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -11983,7 +12095,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -12072,7 +12184,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -12095,7 +12207,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -13514,7 +13626,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -13583,7 +13695,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -13606,7 +13718,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -15029,7 +15141,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -15137,7 +15249,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -15787,7 +15899,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -15810,7 +15922,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -15917,7 +16029,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -16567,7 +16679,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -16673,10 +16785,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -16699,7 +16811,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -16750,7 +16862,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -16813,10 +16925,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -16877,7 +16989,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -16930,7 +17042,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -16950,10 +17062,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -17041,7 +17153,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -17091,7 +17203,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -17160,7 +17272,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -17200,7 +17312,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -17222,7 +17334,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -17287,10 +17399,10 @@ } } }, - "description": "response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -17318,7 +17430,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -17395,7 +17507,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -17664,7 +17776,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -20305,7 +20417,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -20328,7 +20440,7 @@ } }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -20377,7 +20489,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -20679,7 +20791,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -21097,7 +21209,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -21206,7 +21318,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -21439,7 +21551,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -21508,10 +21620,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -21605,7 +21717,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -22023,7 +22135,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -22092,7 +22204,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -22169,7 +22281,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -22587,7 +22699,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -22607,7 +22719,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -22666,7 +22778,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -22924,7 +23036,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -22944,7 +23056,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -23051,7 +23163,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -23276,7 +23388,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -23345,7 +23457,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -23399,10 +23511,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -23422,7 +23534,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -23499,7 +23611,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -23731,10 +23843,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -23828,7 +23940,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -24055,10 +24167,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -24143,7 +24255,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -24362,10 +24474,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -24481,7 +24593,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -24700,7 +24812,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -24763,13 +24875,13 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -24863,7 +24975,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -25076,7 +25188,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -25096,7 +25208,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -25173,7 +25285,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -25442,7 +25554,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -25462,7 +25574,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -25519,7 +25631,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -25932,7 +26044,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -25952,7 +26064,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -26021,7 +26133,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -26096,7 +26208,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -26153,10 +26265,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -26176,7 +26288,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -26233,13 +26345,13 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -26323,7 +26435,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -26548,7 +26660,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -26617,7 +26729,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -26685,7 +26797,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -26707,7 +26819,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -26745,7 +26857,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -26779,7 +26891,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -26837,7 +26949,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -27949,10 +28061,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -28017,6 +28129,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -28137,7 +28250,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -30544,7 +30657,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -30613,10 +30726,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -30679,11 +30792,20 @@ "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", + "description": "Response", "content": { "application/json": { "schema": { @@ -30789,7 +30911,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -30827,7 +30949,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -30980,7 +31102,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -31000,7 +31122,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -31063,7 +31185,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "headers": { "Content-Type": { "example": "text/html", @@ -31093,7 +31215,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -31138,7 +31260,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "headers": { "X-CommonMarker-Version": { "example": "0.17.4", @@ -31156,7 +31278,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -31187,7 +31309,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -31225,7 +31347,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -31289,7 +31411,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -33930,7 +34052,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -33970,10 +34092,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "301": { - "description": "Moved Permanently" + "description": "Moved permanently" } }, "x-github": { @@ -34059,7 +34181,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -35695,7 +35817,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -35718,7 +35840,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -35738,7 +35860,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -35853,7 +35975,7 @@ }, "responses": { "202": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -35868,10 +35990,10 @@ } }, "205": { - "description": "response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -35894,7 +36016,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -35950,7 +36072,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -37573,7 +37695,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -37596,7 +37718,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -37650,10 +37772,10 @@ ], "responses": { "205": { - "description": "response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -37712,7 +37834,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -37777,7 +37899,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -37800,7 +37922,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -37870,7 +37992,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -37935,7 +38057,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -37958,7 +38080,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -38012,10 +38134,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -38038,7 +38160,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -38090,7 +38212,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/octocat-stream": { "schema": { @@ -38144,7 +38266,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -38255,7 +38377,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -38293,7 +38415,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -38561,7 +38683,9 @@ "plan": { "name": "Medium", "space": 400, - "private_repos": 20 + "private_repos": 20, + "filled_seats": 4, + "seats": 5 }, "default_repository_permission": "read", "members_can_create_repositories": true, @@ -38572,54 +38696,13 @@ "members_can_create_internal_repositories": false, "members_can_create_pages": true } - }, - "response-with-git-hub-plan-information": { - "summary": "Response with GitHub plan information", - "value": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization", - "name": "github", - "company": "GitHub", - "blog": "https://github.com/blog", - "location": "San Francisco", - "email": "octocat@github.com", - "twitter_username": "github", - "is_verified": true, - "has_organization_projects": true, - "has_repository_projects": true, - "public_repos": 2, - "public_gists": 1, - "followers": 20, - "following": 0, - "html_url": "https://github.com/octocat", - "created_at": "2008-01-14T04:33:35Z", - "updated_at": "2014-03-03T18:58:10Z", - "type": "Organization", - "plan": { - "name": "team", - "space": 976562499, - "private_repos": 999999, - "filled_seats": 4, - "seats": 5 - } - } } } } } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -38776,7 +38859,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -39055,7 +39138,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -39171,7 +39254,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -39250,7 +39333,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -41944,7 +42027,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -42071,7 +42154,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -42208,7 +42291,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -42330,7 +42413,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -42399,7 +42482,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -42462,7 +42545,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -42576,7 +42659,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -42703,7 +42786,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -42816,7 +42899,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -42885,7 +42968,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -42946,10 +43029,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -43012,10 +43095,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -43080,7 +43163,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -43615,6 +43698,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -43703,7 +43787,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -46110,7 +46194,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -46215,7 +46299,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -46382,7 +46466,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -46552,7 +46636,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -46589,7 +46673,7 @@ "/orgs/{org}/memberships/{username}": { "get": { "summary": "Get organization membership for a user", - "description": "In order to get a user's membership with an organization, the authenticated user must be an organization member.", + "description": "In order to get a user's membership with an organization, the authenticated user must be an organization member. The `state` parameter in the response can be used to identify the user's membership status.", "tags": [ "orgs" ], @@ -46618,7 +46702,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -46633,11 +46717,21 @@ }, "state": { "type": "string", - "example": "active" + "description": "The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.", + "example": "active", + "enum": [ + "active", + "pending" + ] }, "role": { "type": "string", - "example": "admin" + "description": "The user's membership type in the organization.", + "example": "admin", + "enum": [ + "admin", + "member" + ] }, "organization_url": { "type": "string", @@ -46898,99 +46992,13 @@ "site_admin": false } } - }, - "response-if-user-has-an-active-membership-with-organization": { - "summary": "Response if user has an active membership with organization", - "value": { - "url": "https://api.github.com/orgs/octocat/memberships/defunkt", - "state": "active", - "role": "member", - "organization_url": "https://api.github.com/orgs/octocat", - "organization": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization" - }, - "user": { - "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 - } - } - }, - "response-if-user-has-a-pending-membership-with-organization": { - "summary": "Response if user has a pending membership with organization", - "value": { - "url": "https://api.github.com/orgs/invitocat/memberships/defunkt", - "state": "pending", - "role": "member", - "organization_url": "https://api.github.com/orgs/invitocat", - "organization": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization" - }, - "user": { - "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 - } - } } } } } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -47091,7 +47099,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -47106,11 +47114,21 @@ }, "state": { "type": "string", - "example": "active" + "description": "The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.", + "example": "active", + "enum": [ + "active", + "pending" + ] }, "role": { "type": "string", - "example": "admin" + "description": "The user's membership type in the organization.", + "example": "admin", + "enum": [ + "admin", + "member" + ] }, "organization_url": { "type": "string", @@ -47329,51 +47347,8 @@ ] }, "examples": { - "response-if-user-was-previously-unaffiliated-with-organization": { - "summary": "Response if user was previously unaffiliated with organization", - "value": { - "url": "https://api.github.com/orgs/invitocat/memberships/defunkt", - "state": "pending", - "role": "admin", - "organization_url": "https://api.github.com/orgs/invitocat", - "organization": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization" - }, - "user": { - "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 - } - } - }, "response-if-user-already-had-membership-with-organization": { - "summary": "Response if user already had membership with organization", + "summary": "Response if user has an active admin membership with organization", "value": { "url": "https://api.github.com/orgs/octocat/memberships/defunkt", "state": "active", @@ -47420,7 +47395,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -47550,7 +47525,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -47573,7 +47548,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -47660,7 +47635,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -47865,41 +47840,10 @@ "description": "User was converted" }, "403": { - "description": "response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - }, - "examples": { - "response-if-user-is-the-last-owner-of-the-organization": { - "summary": "Response if user is the last owner of the organization", - "value": { - "message": "Cannot convert the last owner to an outside collaborator", - "documentation_url": "https://docs.github.com/enterprise-server@2.18/rest/reference/orgs#convert-member-to-outside-collaborator" - } - }, - "response-if-user-is-not-a-member-of-the-organization": { - "summary": "Response if user is not a member of the organization", - "value": { - "message": " is not a member of the organization.", - "documentation_url": "https://docs.github.com/enterprise-server@2.18/rest/reference/orgs#convert-member-to-outside-collaborator" - } - } - } - } - } + "description": "Response if user is the last owner of the organization or not a member of the organization" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -47960,7 +47904,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "422": { "description": "Response if user is a member of the organization", @@ -48038,11 +47982,40 @@ "type": "integer", "default": 1 } + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "sort", + "description": "The sort order for the response collection.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -48132,7 +48105,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -48215,7 +48188,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -48321,7 +48294,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -48431,7 +48404,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -48700,7 +48673,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -48793,7 +48766,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -49049,7 +49022,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -49089,7 +49062,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -49129,7 +49102,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -49216,7 +49189,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -49462,7 +49435,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -49526,7 +49499,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -49563,7 +49536,7 @@ }, { "name": "type", - "description": "Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`.", + "description": "Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Note: For GitHub AE, can be one of `all`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`.", "in": "query", "required": false, "schema": { @@ -49629,7 +49602,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -51251,7 +51224,7 @@ }, "post": { "summary": "Create an organization repository", - "description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", + "description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository", "tags": [ "repos" ], @@ -51290,12 +51263,12 @@ }, "private": { "type": "boolean", - "description": "Either `true` to create a private repository or `false` to create a public one.", + "description": "Whether the repository is private.", "default": false }, "visibility": { "type": "string", - "description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", + "description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", "enum": [ "public", "private", @@ -51379,7 +51352,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -52481,7 +52454,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -52612,7 +52585,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -52908,7 +52881,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -53377,7 +53350,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -53510,7 +53483,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -53979,7 +53952,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -54035,7 +54008,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -54262,7 +54235,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -54285,7 +54258,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -54305,7 +54278,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -54385,7 +54358,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -54612,7 +54585,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -54635,7 +54608,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -54655,7 +54628,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -54675,7 +54648,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -54743,10 +54716,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -54773,7 +54746,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -54793,7 +54766,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -54878,7 +54851,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -54891,7 +54864,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -54932,7 +54905,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -54952,7 +54925,7 @@ } }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -54987,7 +54960,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -55096,7 +55069,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -55173,7 +55146,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -55196,7 +55169,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -55216,7 +55189,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -55293,7 +55266,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -55370,7 +55343,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -55393,7 +55366,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -55451,10 +55424,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -55477,7 +55450,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -55570,7 +55543,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -55810,7 +55783,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -55833,7 +55806,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -55934,7 +55907,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -56161,7 +56134,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -56184,7 +56157,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -56204,7 +56177,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -56300,7 +56273,7 @@ } }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -56395,7 +56368,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -56408,7 +56381,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -56431,7 +56404,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -56461,7 +56434,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -56520,7 +56493,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -56776,7 +56749,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -56799,7 +56772,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -56897,7 +56870,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -57156,7 +57129,7 @@ "description": "Response if the authenticated user does not have access to the project" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -57183,7 +57156,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -57223,7 +57196,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -57293,7 +57266,7 @@ "description": "Delete Success" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -57320,7 +57293,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -57360,7 +57333,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -57452,7 +57425,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -57608,7 +57581,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -57628,7 +57601,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -57650,7 +57623,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -57719,7 +57692,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -57742,7 +57715,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -57831,10 +57804,10 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -57854,7 +57827,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -57876,7 +57849,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -57945,7 +57918,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -57968,7 +57941,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -58033,13 +58006,13 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -58059,7 +58032,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -58101,7 +58074,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -58170,7 +58143,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -58237,7 +58210,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -58402,7 +58375,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -58422,7 +58395,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -58444,7 +58417,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -58513,7 +58486,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -58536,7 +58509,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -58613,7 +58586,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -58703,7 +58676,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -58726,7 +58699,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -58802,7 +58775,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -58875,7 +58848,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -58898,7 +58871,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -58928,7 +58901,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -58980,7 +58953,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -59206,10 +59179,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -59274,7 +59247,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -59329,7 +59302,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -63959,7 +63932,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -63979,7 +63952,7 @@ } }, "301": { - "description": "Moved Permanently" + "description": "Moved permanently" } }, "x-github": { @@ -64128,7 +64101,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -68255,7 +68228,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -68324,7 +68297,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -68394,7 +68367,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "If an organization owner has configured the organization to prevent members from deleting organization-owned repositories, a member will get this response:", @@ -68419,7 +68392,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -68500,7 +68473,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -68656,7 +68629,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -68820,7 +68793,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -69645,18 +69618,6 @@ }, "examples": { "default": { - "value": [ - { - "name": "master", - "commit": { - "sha": "c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc", - "url": "https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc" - }, - "protected": true - } - ] - }, - "with-protection": { "value": [ { "name": "master", @@ -69692,7 +69653,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -69765,7 +69726,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -71182,7 +71143,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -71204,7 +71165,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -71277,7 +71238,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -72177,7 +72138,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -72416,7 +72377,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -73270,7 +73231,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -73292,7 +73253,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -73322,7 +73283,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -73397,7 +73358,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -73473,7 +73434,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -73559,7 +73520,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -73648,7 +73609,7 @@ "description": "No Content" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -73721,7 +73682,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/vnd.github.luke-cage-preview+json": { "schema": { @@ -74200,7 +74161,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -74568,7 +74529,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -74695,7 +74656,7 @@ "description": "No Content" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -74768,7 +74729,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -74803,7 +74764,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -74878,7 +74839,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -74913,7 +74874,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -74991,7 +74952,7 @@ "description": "No Content" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -75068,7 +75029,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -75123,7 +75084,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -75222,7 +75183,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -75277,7 +75238,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -75297,7 +75258,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -75473,7 +75434,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -75489,7 +75450,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -75586,7 +75547,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -75603,7 +75564,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -75692,7 +75653,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -75790,7 +75751,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -75806,7 +75767,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -75875,7 +75836,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -75973,7 +75934,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -75989,7 +75950,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -76009,7 +75970,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -76132,7 +76093,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -76588,7 +76549,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -76715,7 +76676,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -76886,7 +76847,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -76983,7 +76944,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -77154,7 +77115,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -77301,7 +77262,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -77472,7 +77433,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -77619,7 +77580,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -77790,7 +77751,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -77913,7 +77874,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -78061,7 +78022,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -78158,7 +78119,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -78306,7 +78267,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -78453,7 +78414,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -78601,7 +78562,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -78748,7 +78709,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -78896,7 +78857,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -79203,7 +79164,7 @@ "name", "head_sha" ], - "anyOf": [ + "oneOf": [ { "properties": { "status": { @@ -79213,6 +79174,7 @@ } }, "required": [ + "status", "conclusion" ], "additionalProperties": true @@ -79232,7 +79194,7 @@ }, "examples": { "example-of-in-progress-conclusion": { - "summary": "Example of in_progress conclusion", + "summary": "Response for in_progress conclusion", "value": { "name": "mighty_readme", "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -79247,7 +79209,7 @@ } }, "example-of-completed-conclusion": { - "summary": "Example of completed conclusion", + "summary": "Response for completed conclusion", "value": { "name": "mighty_readme", "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -79301,7 +79263,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -80107,101 +80069,8 @@ ] }, "examples": { - "example-of-in-progress-conclusion": { - "summary": "Example of in_progress conclusion", - "value": { - "id": 4, - "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", - "node_id": "MDg6Q2hlY2tSdW40", - "external_id": "42", - "url": "https://api.github.com/repos/github/hello-world/check-runs/4", - "html_url": "https://github.com/github/hello-world/runs/4", - "details_url": "https://example.com", - "status": "in_progress", - "conclusion": "neutral", - "started_at": "2018-05-04T01:14:52Z", - "completed_at": null, - "output": { - "title": "Mighty Readme Report", - "summary": "", - "text": "", - "annotations_count": 1, - "annotations_url": "https://api.github.com/repos/github/hello-world/check-runs/4/annotations" - }, - "name": "mighty_readme", - "check_suite": { - "id": 5 - }, - "app": { - "id": 1, - "slug": "octoapp", - "node_id": "MDExOkludGVncmF0aW9uMQ==", - "owner": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "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", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": true - }, - "name": "Octocat App", - "description": "", - "external_url": "https://example.com", - "html_url": "https://github.com/apps/octoapp", - "created_at": "2017-07-08T16:18:44-04:00", - "updated_at": "2017-07-08T16:18:44-04:00", - "permissions": { - "metadata": "read", - "contents": "read", - "issues": "write", - "single_file": "write" - }, - "events": [ - "push", - "pull_request" - ] - }, - "pull_requests": [ - { - "url": "https://api.github.com/repos/github/hello-world/pulls/1", - "id": 1934, - "number": 3956, - "head": { - "ref": "say-hello", - "sha": "3dca65fa3e8d4b3da3f3d056c59aee1c50f41390", - "repo": { - "id": 526, - "url": "https://api.github.com/repos/github/hello-world", - "name": "hello-world" - } - }, - "base": { - "ref": "master", - "sha": "e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f", - "repo": { - "id": 526, - "url": "https://api.github.com/repos/github/hello-world", - "name": "hello-world" - } - } - } - ] - } - }, "example-of-completed-conclusion": { - "summary": "Example of completed conclusion", + "summary": "Response for completed conclusion", "value": { "id": 4, "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -80354,7 +80223,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -81565,7 +81434,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -82542,7 +82411,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -82710,7 +82579,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -85068,7 +84937,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -86246,7 +86115,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -88627,7 +88496,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -89614,7 +89483,7 @@ ], "responses": { "201": { - "description": "response" + "description": "Response" } }, "x-github": { @@ -89697,7 +89566,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -89872,7 +89741,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -91908,7 +91777,7 @@ "description": "Response when person is already a collaborator" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -92047,7 +91916,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -92266,7 +92135,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -92347,7 +92216,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -92705,7 +92574,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -92994,7 +92863,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -93089,7 +92958,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -93378,7 +93247,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -93448,10 +93317,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -93560,7 +93429,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -93769,7 +93638,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -93789,7 +93658,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -94288,7 +94157,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -94310,7 +94179,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -94485,11 +94354,31 @@ "type": "integer", "default": 1 } + }, + { + "name": "top", + "description": "legacy parameter for pagination.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "last_sha", + "description": "legacy parameter for pagination.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -95142,7 +95031,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -95235,7 +95124,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -95292,7 +95181,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -95314,7 +95203,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -95458,7 +95347,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -95851,7 +95740,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -96168,7 +96057,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -96309,7 +96198,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -100080,7 +99969,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -100146,9 +100035,27 @@ "type": "string" } }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -100159,7 +100066,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -100742,7 +100649,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -100811,7 +100718,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -100893,7 +100800,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -100955,11 +100862,19 @@ "type": "integer", "default": 1 } + }, + { + "name": "app_id", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -101936,7 +101851,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -101984,7 +101899,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -104188,18 +104103,36 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true + }, + { + "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", + "description": "Response", "content": { "application/json": { "schema": { @@ -105871,7 +105804,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -105933,7 +105866,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -105962,7 +105895,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -106181,7 +106114,7 @@ } }, "301": { - "description": "Moved Permanently" + "description": "Moved permanently" } }, "x-github": { @@ -106243,7 +106176,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -108106,7 +108039,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -108168,7 +108101,7 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { @@ -108188,7 +108121,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/vnd.github.v3.object": { "schema": { @@ -108800,7 +108733,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -108883,7 +108816,7 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { @@ -108994,7 +108927,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -109210,7 +109143,7 @@ } }, "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -109426,7 +109359,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -109446,7 +109379,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -109575,7 +109508,7 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { @@ -109649,7 +109582,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -109850,7 +109783,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -109919,7 +109852,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -109959,7 +109892,7 @@ } }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -110201,7 +110134,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -110298,7 +110231,8 @@ "required": false, "schema": { "type": "string", - "default": "none" + "default": "none", + "nullable": true } }, { @@ -110322,7 +110256,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -110984,7 +110918,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -111488,48 +111422,6 @@ "transient_environment": false, "production_environment": true } - }, - "advanced-example": { - "summary": "Advanced example", - "value": { - "url": "https://api.github.com/repos/octocat/example/deployments/1", - "id": 1, - "node_id": "MDEwOkRlcGxveW1lbnQx", - "sha": "a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d", - "ref": "topic-branch", - "task": "deploy", - "payload": { - }, - "original_environment": "staging", - "environment": "production", - "description": "Deploy request from hubot", - "creator": { - "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 - }, - "created_at": "2012-07-20T01:19:13Z", - "updated_at": "2012-07-20T01:19:13Z", - "statuses_url": "https://api.github.com/repos/octocat/example/deployments/1/statuses", - "repository_url": "https://api.github.com/repos/octocat/example", - "transient_environment": false, - "production_environment": true - } } } } @@ -111558,40 +111450,10 @@ } }, "409": { - "description": "response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string", - "example": "\"https://docs.github.com/enterprise-server@2.18/rest/reference/repos#create-a-deployment\"" - } - } - }, - "examples": { - "merge-conflict-response": { - "summary": "Merge conflict response", - "value": { - "message": "Conflict merging master into topic-branch" - } - }, - "failed-commit-status-checks": { - "summary": "Failed commit status checks", - "value": { - "message": "Conflict: Commit status checks failed for topic-branch." - } - } - } - } - } + "description": "Response when there is a merge conflict or the commit's status checks failed" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -111716,7 +111578,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -112225,7 +112087,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -112324,7 +112186,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -112843,7 +112705,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -112988,7 +112850,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -113502,7 +113364,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -113640,7 +113502,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -114146,7 +114008,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -114166,7 +114028,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -114263,7 +114125,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -116954,7 +116816,8 @@ "enum": [ "newest", "oldest", - "stargazers" + "stargazers", + "watchers" ], "default": "newest" } @@ -116976,11 +116839,31 @@ "type": "integer", "default": 1 } + }, + { + "name": "org", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "organization", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -118672,6 +118555,26 @@ "schema": { "type": "string" } + }, + { + "name": "org", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "organization", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } } ], "requestBody": { @@ -118679,6 +118582,7 @@ "application/json": { "schema": { "type": "object", + "nullable": true, "properties": { "organization": { "type": "string", @@ -118691,7 +118595,7 @@ }, "responses": { "202": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -119819,7 +119723,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -119908,7 +119812,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -119998,7 +119902,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -120038,7 +119942,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -120098,7 +120002,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -120218,7 +120122,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -120275,7 +120179,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -120295,7 +120199,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -120510,7 +120414,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -120726,7 +120630,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -120795,7 +120699,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -120868,7 +120772,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -121076,7 +120980,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -121170,7 +121074,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -121246,7 +121150,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -121376,7 +121280,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -121475,7 +121379,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -121513,7 +121417,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -121581,7 +121485,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -121690,7 +121594,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -121701,10 +121605,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -121883,7 +121787,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -122030,7 +121934,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -122150,7 +122054,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -122289,7 +122193,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -122423,7 +122327,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -122551,7 +122455,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -122620,7 +122524,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -122706,7 +122610,8 @@ "required": true, "schema": { "type": "string" - } + }, + "x-multi-segment": true }, { "name": "recursive", @@ -122720,7 +122625,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -122874,7 +122779,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -122943,7 +122848,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -123024,7 +122929,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -123221,7 +123126,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -123366,7 +123271,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -123558,7 +123463,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -123578,7 +123483,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -123718,7 +123623,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -123902,7 +123807,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -124055,7 +123960,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -124239,7 +124144,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -124308,7 +124213,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -124377,10 +124282,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -124451,10 +124356,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -124525,10 +124430,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -124601,7 +124506,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -125089,10 +124994,10 @@ } }, "301": { - "description": "Moved Permanently" + "description": "Moved permanently" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -125176,7 +125081,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -127143,7 +127048,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -129074,7 +128979,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -129236,7 +129141,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -131384,10 +131289,10 @@ } }, "301": { - "description": "Moved Permanently" + "description": "Moved permanently" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -131456,7 +131361,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -131614,7 +131519,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -133948,7 +133853,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -134017,7 +133922,7 @@ } }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -134038,7 +133943,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -134176,7 +134081,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -134716,7 +134621,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -134785,7 +134690,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -134861,7 +134766,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -135388,7 +135293,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -135483,7 +135388,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -136010,7 +135915,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -136129,7 +136034,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -136221,7 +136126,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -136430,7 +136335,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -136450,7 +136355,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -136949,7 +136854,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -136971,7 +136876,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -137105,7 +137010,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -140185,7 +140090,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -140314,7 +140219,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -143381,7 +143286,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -143507,7 +143412,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -145813,10 +145718,10 @@ } }, "301": { - "description": "Moved Permanently" + "description": "Moved permanently" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -145856,7 +145761,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -146015,7 +145920,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -148321,7 +148226,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -148390,7 +148295,7 @@ } }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -148431,10 +148336,10 @@ } }, "301": { - "description": "Moved Permanently" + "description": "Moved permanently" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -148550,7 +148455,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -150799,7 +150704,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -153053,7 +152958,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -153593,7 +153498,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -153708,7 +153613,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -154283,7 +154188,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -154352,7 +154257,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -154443,7 +154348,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -154801,7 +154706,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -154989,7 +154894,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -155092,7 +154997,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -155235,7 +155140,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -155338,7 +155243,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -155457,7 +155362,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "410": { "description": "Gone", @@ -155540,7 +155445,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -155614,7 +155519,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -155728,7 +155633,7 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -155771,7 +155676,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -155791,7 +155696,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -155913,7 +155818,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -155936,7 +155841,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -156045,7 +155950,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -156254,7 +156159,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -156294,7 +156199,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -156401,7 +156306,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -156597,7 +156502,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -156619,7 +156524,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -156762,7 +156667,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -157021,7 +156926,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -157061,7 +156966,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -157153,7 +157058,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -157295,7 +157200,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -157360,7 +157265,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -157481,7 +157386,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -157538,7 +157443,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -157608,7 +157513,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -157672,7 +157577,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -157763,7 +157668,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -157855,7 +157760,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -157932,7 +157837,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -158001,7 +157906,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -158072,7 +157977,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -158141,7 +158046,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -158210,7 +158115,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -158256,7 +158161,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -158322,7 +158227,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -159148,63 +159053,10 @@ } }, "404": { - "description": "response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string", - "example": "\"https://docs.github.com/enterprise-server@2.18/rest/reference/repos#perform-a-merge\"" - } - } - }, - "examples": { - "missing-base-response": { - "summary": "Missing base response", - "value": { - "message": "Base does not exist" - } - }, - "missing-head-response": { - "summary": "Missing head response", - "value": { - "message": "Head does not exist" - } - } - } - } - } + "description": "Response when the base or head does not exist" }, "409": { - "description": "Merge conflict response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string", - "example": "\"https://docs.github.com/enterprise-server@2.18/rest/reference/repos#perform-a-merge\"" - } - } - }, - "examples": { - "merge-conflict-response": { - "value": { - "message": "Merge Conflict" - } - } - } - } - } + "description": "Response when there is a merge conflict" }, "403": { "description": "Forbidden", @@ -159227,7 +159079,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -159400,7 +159252,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -159681,7 +159533,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -159783,7 +159635,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -160059,7 +159911,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -160079,7 +159931,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -160200,7 +160052,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -160468,7 +160320,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -160576,7 +160428,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -160894,10 +160746,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -160987,7 +160839,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -161177,7 +161029,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -162869,7 +162721,7 @@ }, "responses": { "202": { - "description": "response" + "description": "Response" } }, "x-github": { @@ -162915,7 +162767,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -163008,7 +162860,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -163116,7 +162968,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -163209,7 +163061,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -163278,7 +163130,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -163430,10 +163282,10 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -163601,10 +163453,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -163673,7 +163525,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -163695,7 +163547,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -163780,7 +163632,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -164043,7 +163895,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -164121,7 +163973,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -164381,7 +164233,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -164647,11 +164499,39 @@ "type": "integer", "default": 1 } + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -164745,7 +164625,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -164832,7 +164712,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -165051,7 +164931,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -165320,7 +165200,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -165360,7 +165240,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -165400,7 +165280,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -165501,7 +165381,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -165757,7 +165637,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -165797,7 +165677,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -165837,7 +165717,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -165994,7 +165874,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -169765,10 +169645,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -169935,7 +169815,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -172964,7 +172844,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -173084,16 +172964,15 @@ }, { "name": "sort", - "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to).", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "created", - "updated" - ], - "default": "created" + "updated", + "created_at" + ] } }, { @@ -173139,7 +173018,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -173618,7 +173497,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -174023,7 +173902,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -174123,7 +174002,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -174582,10 +174461,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -174694,7 +174573,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -174903,7 +174782,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -174923,7 +174802,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -175422,7 +175301,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -175444,7 +175323,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -178569,7 +178448,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "500": { "description": "Internal Error", @@ -178592,7 +178471,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -178702,7 +178581,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -181703,7 +181582,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -181905,7 +181784,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -182381,7 +182260,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -182701,7 +182580,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -183114,7 +182993,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -183204,7 +183083,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -183852,7 +183731,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -183953,7 +183832,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -184267,7 +184146,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -184356,7 +184235,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -184446,7 +184325,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -184807,7 +184686,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -188733,10 +188612,10 @@ }, "responses": { "200": { - "description": "response" + "description": "Response" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -189293,7 +189172,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -189569,7 +189448,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -189680,7 +189559,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -189956,7 +189835,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -190055,7 +189934,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -190331,7 +190210,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -190419,7 +190298,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -190695,7 +190574,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -190725,7 +190604,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -190823,7 +190702,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -191224,7 +191103,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -191326,7 +191205,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -191602,7 +191481,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -191622,7 +191501,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -191739,7 +191618,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -192015,7 +191894,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -192035,7 +191914,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -192155,7 +192034,7 @@ }, "responses": { "202": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -192177,7 +192056,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -192266,7 +192145,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -192342,6 +192221,279 @@ } } ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Content File", + "description": "Content File", + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "encoding": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "path": { + "type": "string" + }, + "content": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "git_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "download_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "_links": { + "type": "object", + "properties": { + "git": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html": { + "type": "string", + "format": "uri", + "nullable": true + }, + "self": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "git", + "html", + "self" + ] + }, + "target": { + "type": "string", + "example": "\"actual/actual.md\"" + }, + "submodule_git_url": { + "type": "string", + "example": "\"git://example.com/defunkt/dotjs.git\"" + } + }, + "required": [ + "_links", + "git_url", + "html_url", + "download_url", + "name", + "path", + "sha", + "size", + "type", + "url", + "content", + "encoding" + ] + }, + "examples": { + "default": { + "value": { + "type": "file", + "encoding": "base64", + "size": 5362, + "name": "README.md", + "path": "README.md", + "content": "encoded content ...", + "sha": "3d21ec53a331a6f037a91c368710b99387d012c1", + "url": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md", + "git_url": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1", + "html_url": "https://github.com/octokit/octokit.rb/blob/master/README.md", + "download_url": "https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md", + "_links": { + "git": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1", + "self": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md", + "html": "https://github.com/octokit/octokit.rb/blob/master/README.md" + } + } + } + } + } + } + }, + "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" + } + } + } + } + } + }, + "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" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "repos", + "subcategory": "contents" + } + } + }, + "/repos/{owner}/{repo}/readme/{dir}": { + "get": { + "summary": "Get a repository README", + "description": "Gets the preferred README for a repository.\n\nREADMEs support [custom media types](https://docs.github.com/enterprise-server@2.18/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML.", + "tags": [ + "repos" + ], + "operationId": "repos/get-readme-from-alt-path", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#get-a-repository-readme" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "dir", + "description": "The alternate path to look for a README file", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + }, + { + "name": "ref", + "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], "responses": { "200": { "description": "response", @@ -192466,7 +192618,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -192486,7 +192638,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -192616,7 +192768,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -193116,7 +193268,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -193225,7 +193377,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -193720,7 +193872,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -194074,7 +194226,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -194094,7 +194246,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -194196,7 +194348,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -194478,7 +194630,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -194524,7 +194676,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -195053,7 +195205,7 @@ }, { "name": "tag", - "description": "tag+ parameter", + "description": "tag parameter", "in": "path", "required": true, "schema": { @@ -195064,7 +195216,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -195551,7 +195703,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -196110,7 +196262,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -196223,7 +196375,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -196760,7 +196912,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -196833,7 +196985,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -197456,7 +197608,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -197780,7 +197932,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -197964,7 +198116,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -198465,7 +198617,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -198662,7 +198814,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -198937,7 +199089,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -199281,7 +199433,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -199384,7 +199536,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -199448,7 +199600,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -199580,7 +199732,7 @@ ], "responses": { "302": { - "description": "response", + "description": "Response", "headers": { "Location": { "example": "https://codeload.github.com/me/myprivate/legacy.zip/master?login=me&token=thistokenexpires", @@ -199652,7 +199804,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -199870,11 +200022,29 @@ "schema": { "type": "string" } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -199909,7 +200079,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -199931,7 +200101,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -200025,7 +200195,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -200060,7 +200230,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -200082,7 +200252,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -200102,7 +200272,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -200211,7 +200381,7 @@ }, "responses": { "202": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -201328,7 +201498,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -201376,7 +201546,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -201434,7 +201604,7 @@ ], "responses": { "302": { - "description": "response", + "description": "Response", "headers": { "Location": { "example": "https://codeload.github.com/me/myprivate/legacy.zip/master?login=me&token=thistokenexpires", @@ -201459,7 +201629,7 @@ "/repos/{template_owner}/{template_repo}/generate": { "post": { "summary": "Create a repository using a template", - "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@2.18/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", + "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@2.18/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository", "tags": [ "repos" ], @@ -201531,7 +201701,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -202630,7 +202800,7 @@ "/repositories": { "get": { "summary": "List public repositories", - "description": "Lists all public repositories in the order that they were created.\n\nNote: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.", + "description": "Lists all public repositories in the order that they were created.\n\nNotes:\n- For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise.\n- Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.", "tags": [ "repos" ], @@ -202651,7 +202821,7 @@ }, { "name": "visibility", - "description": "Specifies the types of repositories to return. Can be one of `all` or `public`. Default: `public`.", + "description": "Specifies the types of repositories to return. Can be one of `all` or `public`. Default: `public`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise.", "in": "query", "required": false, "schema": { @@ -202667,7 +202837,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -204224,7 +204394,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -204293,7 +204463,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -204376,7 +204546,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -206053,10 +206223,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -206077,7 +206247,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -206247,7 +206417,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -208217,10 +208387,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -208336,7 +208506,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -210460,7 +210630,7 @@ } }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -210481,7 +210651,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -210550,7 +210720,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -210645,7 +210815,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -210783,10 +210953,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -210826,7 +210996,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -210978,7 +211148,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -211687,7 +211857,7 @@ } }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -211708,7 +211878,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -211777,7 +211947,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -211820,7 +211990,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -212094,10 +212264,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -212205,7 +212375,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -212449,10 +212619,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -212473,7 +212643,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -212567,7 +212737,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -212654,7 +212824,7 @@ }, "responses": { "202": { - "description": "response" + "description": "Response" } }, "x-github": { @@ -212682,7 +212852,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -212763,7 +212933,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -212864,7 +213034,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -213473,7 +213643,7 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "requestBody": { @@ -213519,7 +213689,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -213577,7 +213747,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -213653,7 +213823,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -213731,7 +213901,7 @@ }, "responses": { "202": { - "description": "response" + "description": "Response" } }, "requestBody": { @@ -213785,7 +213955,7 @@ }, "responses": { "202": { - "description": "response" + "description": "Response" } }, "requestBody": { @@ -213838,7 +214008,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -214344,7 +214514,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -214897,7 +215067,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -214981,7 +215151,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -215376,7 +215546,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -215801,7 +215971,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -216191,7 +216361,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -216603,7 +216773,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -216695,7 +216865,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -217064,7 +217234,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -217452,7 +217622,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -217816,7 +217986,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -218201,7 +218371,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -218306,7 +218476,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -218583,7 +218753,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -218909,7 +219079,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -219178,7 +219348,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -219482,7 +219652,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -219735,74 +219905,13 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { "description": "Response if team synchronization is set up" }, "422": { - "description": "response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "field": { - "type": "string" - }, - "resource": { - "type": "string" - } - } - } - }, - "documentation_url": { - "type": "string", - "example": "\"https://docs.github.com/enterprise-server@2.18/rest\"" - } - } - }, - "examples": { - "response-if-you-attempt-to-add-an-organization-to-a-team": { - "summary": "Response if you attempt to add an organization to a team", - "value": { - "message": "Cannot add an organization as a member.", - "errors": [ - { - "code": "org", - "field": "user", - "resource": "TeamMember" - } - ] - } - }, - "response-if-you-attempt-to-add-a-user-to-a-team-when-they-are-not-a-member-of-at-least-one-other-team-in-the-same-organization": { - "summary": "Response if you attempt to add a user to a team when they are not a member of at least one other team in the same organization", - "value": { - "message": "User isn't a member of this organization. Please invite them first.", - "errors": [ - { - "code": "unaffiliated", - "field": "user", - "resource": "TeamMember" - } - ] - } - } - } - } - } + "description": "Response if you attempt to add an organization to a team or you attempt to add a user to a team when they are not a member of at least one other team in the same organization" }, "403": { "description": "Forbidden", @@ -219869,7 +219978,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { "description": "Response if team synchronization is setup" @@ -219892,7 +220001,7 @@ "/teams/{team_id}/memberships/{username}": { "get": { "summary": "Get team membership for a user", - "description": "If you pass the `hellcat-preview` media type, team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:** The `role` for organization owners returns as `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@2.18/rest/reference/teams#create-a-team).", + "description": "If you pass the `hellcat-preview` media type, team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:**\nThe response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@2.18/rest/reference/teams#create-a-team).", "operationId": "teams/get-membership-for-user", "tags": [ "teams" @@ -219921,7 +220030,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -219944,7 +220053,12 @@ "type": "string" }, "state": { - "type": "string" + "description": "The state of the user's membership in the team.", + "type": "string", + "enum": [ + "active", + "pending" + ] } }, "required": [ @@ -219954,14 +220068,6 @@ ] }, "examples": { - "response-if-user-has-an-active-membership-with-team": { - "summary": "Response if user has an active membership with team", - "value": { - "url": "https://api.github.com/teams/1/memberships/octocat", - "role": "member", - "state": "active" - } - }, "response-if-user-is-a-team-maintainer": { "summary": "Response if user is a team maintainer", "value": { @@ -219969,14 +220075,6 @@ "role": "maintainer", "state": "active" } - }, - "response-if-user-has-a-pending-membership-with-team": { - "summary": "Response if user has a pending membership with team", - "value": { - "url": "https://api.github.com/teams/1/memberships/octocat", - "role": "member", - "state": "pending" - } } } } @@ -220028,7 +220126,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -220051,7 +220149,12 @@ "type": "string" }, "state": { - "type": "string" + "description": "The state of the user's membership in the team.", + "type": "string", + "enum": [ + "active", + "pending" + ] } }, "required": [ @@ -220061,14 +220164,6 @@ ] }, "examples": { - "response-if-users-membership-with-team-is-now-active": { - "summary": "Response if user's membership with team is now active", - "value": { - "url": "https://api.github.com/teams/1/memberships/octocat", - "role": "member", - "state": "active" - } - }, "response-if-users-membership-with-team-is-now-pending": { "summary": "Response if user's membership with team is now pending", "value": { @@ -220082,50 +220177,7 @@ } }, "422": { - "description": "Response if you attempt to add an organization to a team", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "field": { - "type": "string" - }, - "resource": { - "type": "string" - } - } - } - } - } - }, - "examples": { - "response-if-you-attempt-to-add-an-organization-to-a-team": { - "value": { - "message": "Cannot add an organization as a member.", - "errors": [ - { - "code": "org", - "field": "user", - "resource": "TeamMember" - } - ] - } - } - } - } - } + "description": "Response if you attempt to add an organization to a team" } }, "requestBody": { @@ -220189,7 +220241,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -220255,7 +220307,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -220581,7 +220633,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -220895,7 +220947,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Response if the project is not owned by the organization", @@ -220995,7 +221047,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -221051,7 +221103,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -228211,7 +228263,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "requestBody": { @@ -228287,7 +228339,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -228498,7 +228550,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -229041,7 +229093,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -229064,7 +229116,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -229160,7 +229212,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -229461,10 +229513,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -229504,7 +229556,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -229524,7 +229576,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -229638,7 +229690,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -229699,10 +229751,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -229742,7 +229794,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -229835,7 +229887,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -229900,7 +229952,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -229969,10 +230021,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -230012,7 +230064,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -230103,13 +230155,13 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -230149,7 +230201,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -230169,7 +230221,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -230283,7 +230335,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -230439,7 +230491,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -230462,7 +230514,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -230527,7 +230579,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -230683,7 +230735,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -230706,7 +230758,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -230784,7 +230836,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -230807,7 +230859,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -230860,13 +230912,13 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -230906,7 +230958,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -230959,13 +231011,13 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -231005,7 +231057,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -231070,7 +231122,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -231292,10 +231344,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -231335,7 +231387,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -231399,7 +231451,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -231608,7 +231660,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -231677,10 +231729,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -231720,7 +231772,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -231776,7 +231828,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -231985,7 +232037,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -232005,7 +232057,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -232028,7 +232080,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -232082,10 +232134,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -232105,7 +232157,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -232174,7 +232226,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -232197,7 +232249,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -232831,7 +232883,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -232854,7 +232906,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -232874,7 +232926,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -234060,7 +234112,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -234100,7 +234152,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -234156,7 +234208,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -234179,10 +234231,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -234248,7 +234300,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -234271,10 +234323,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -234334,6 +234386,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -234422,7 +234475,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -236829,7 +236882,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -236849,7 +236902,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -236900,7 +236953,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -236986,10 +237039,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -237029,7 +237082,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -237099,7 +237152,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -237162,7 +237215,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -237231,10 +237284,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -237274,7 +237327,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -237330,7 +237383,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -237393,7 +237446,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -237413,7 +237466,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -237436,7 +237489,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -237490,13 +237543,13 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -237536,7 +237589,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -237614,7 +237667,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -237631,11 +237684,21 @@ }, "state": { "type": "string", - "example": "active" + "description": "The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.", + "example": "active", + "enum": [ + "active", + "pending" + ] }, "role": { "type": "string", - "example": "admin" + "description": "The user's membership type in the organization.", + "example": "admin", + "enum": [ + "admin", + "member" + ] }, "organization_url": { "type": "string", @@ -237952,7 +238015,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -237975,7 +238038,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -237995,7 +238058,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -238099,7 +238162,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -238114,11 +238177,21 @@ }, "state": { "type": "string", - "example": "active" + "description": "The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.", + "example": "active", + "enum": [ + "active", + "pending" + ] }, "role": { "type": "string", - "example": "admin" + "description": "The user's membership type in the organization.", + "example": "admin", + "enum": [ + "admin", + "member" + ] }, "organization_url": { "type": "string", @@ -238404,7 +238477,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -238481,7 +238554,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -238496,11 +238569,21 @@ }, "state": { "type": "string", - "example": "active" + "description": "The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.", + "example": "active", + "enum": [ + "active", + "pending" + ] }, "role": { "type": "string", - "example": "admin" + "description": "The user's membership type in the organization.", + "example": "admin", + "enum": [ + "admin", + "member" + ] }, "organization_url": { "type": "string", @@ -238786,7 +238869,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -238806,7 +238889,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -238920,7 +239003,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -239031,7 +239114,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -239054,7 +239137,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -239127,7 +239210,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -239383,7 +239466,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -239406,7 +239489,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -239426,7 +239509,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -239448,7 +239531,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -239527,7 +239610,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -239588,10 +239671,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -239631,7 +239714,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -239677,7 +239760,7 @@ "parameters": [ { "name": "visibility", - "description": "Can be one of `all`, `public`, or `private`.", + "description": "Can be one of `all`, `public`, or `private`. Note: For GitHub AE, can be one of `all`, `internal`, or `private`.", "in": "query", "required": false, "schema": { @@ -239702,7 +239785,7 @@ }, { "name": "type", - "description": "Can be one of `all`, `owner`, `public`, `private`, `member`. Default: `all` \n \nWill cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.", + "description": "Can be one of `all`, `owner`, `public`, `private`, `member`. Note: For GitHub AE, can be one of `all`, `owner`, `internal`, `private`, `member`. Default: `all` \n \nWill cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.", "in": "query", "required": false, "schema": { @@ -239785,7 +239868,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -240856,7 +240939,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -240925,7 +241008,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -240948,7 +241031,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -240980,7 +241063,7 @@ }, "post": { "summary": "Create a repository for the authenticated user", - "description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", + "description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository.", "tags": [ "repos" ], @@ -241011,7 +241094,7 @@ "type": "string" }, "private": { - "description": "Whether the repository is private or public.", + "description": "Whether the repository is private.", "default": false, "type": "boolean" }, @@ -241099,7 +241182,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -242181,7 +242264,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -242201,10 +242284,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -242244,7 +242327,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -242421,7 +242504,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -244314,10 +244397,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -244357,7 +244440,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -244413,7 +244496,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -244456,7 +244539,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -244476,7 +244559,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -244513,7 +244596,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "409": { "description": "Conflict", @@ -244536,10 +244619,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -244652,7 +244735,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -246815,7 +246898,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -246838,7 +246921,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -246924,7 +247007,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -246944,7 +247027,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -247008,7 +247091,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -247031,7 +247114,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -247051,7 +247134,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -247071,7 +247154,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -247115,10 +247198,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -247138,7 +247221,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -247158,7 +247241,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -247226,7 +247309,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -248827,7 +248910,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -248850,7 +248933,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -248915,7 +248998,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -249397,10 +249480,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -249485,7 +249568,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -249641,7 +249724,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -249679,7 +249762,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -250218,7 +250301,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -250291,7 +250374,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -252993,7 +253076,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -255687,7 +255770,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -258381,7 +258464,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -258590,7 +258673,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -258857,7 +258940,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -259275,7 +259358,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -259397,7 +259480,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -259678,7 +259761,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -259725,7 +259808,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -259745,7 +259828,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -259859,7 +259942,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -260403,7 +260486,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -260501,7 +260584,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -260680,7 +260763,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -260949,7 +261032,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -260971,7 +261054,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -261097,7 +261180,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -263791,7 +263874,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -266446,7 +266529,7 @@ "/users/{username}/repos": { "get": { "summary": "List repositories for a user", - "description": "Lists public repositories for the specified user.", + "description": "Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user.", "tags": [ "repos" ], @@ -266529,7 +266612,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -268169,7 +268252,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -268205,7 +268288,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -268289,7 +268372,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -270505,7 +270588,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -272141,7 +272224,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "requestBody": { @@ -272192,7 +272275,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "requestBody": { @@ -272231,7 +272314,7 @@ "operationId": "meta/get-zen", "responses": { "200": { - "description": "response", + "description": "Response", "content": { "text/plain": { "schema": { diff --git a/lib/rest/static/dereferenced/ghes-2.19.deref.json b/lib/rest/static/dereferenced/ghes-2.19.deref.json index c52215602e..dbbf913b66 100644 --- a/lib/rest/static/dereferenced/ghes-2.19.deref.json +++ b/lib/rest/static/dereferenced/ghes-2.19.deref.json @@ -134,7 +134,7 @@ ], "servers": [ { - "url": "{protocol}://{hostname}", + "url": "{protocol}://{hostname}/api/v3", "variables": { "hostname": { "description": "Self-hosted Enterprise Server or Enterprise Cloud hostname", @@ -162,7 +162,7 @@ "operationId": "meta/root", "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -394,7 +394,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -529,7 +529,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -729,7 +729,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -859,7 +859,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -1040,7 +1040,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -1092,7 +1092,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -1140,11 +1140,48 @@ "type": "integer", "default": 1 } + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "accessed" + ], + "default": "created" + } + }, + { + "name": "since", + "description": "Only show public keys accessed after the given time.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -1242,7 +1279,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -1280,7 +1317,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -1407,7 +1444,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -1460,7 +1497,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -1607,7 +1644,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -1650,7 +1687,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -1815,7 +1852,7 @@ ], "responses": { "202": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -1899,11 +1936,39 @@ "type": "integer", "default": 1 } + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -2026,7 +2091,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -2167,7 +2232,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -2279,7 +2344,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -2456,7 +2521,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "422": { "description": "Client Errors", @@ -2544,7 +2609,7 @@ ], "responses": { "202": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -2665,7 +2730,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -2746,11 +2811,40 @@ "type": "integer", "default": 1 } + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "sort", + "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to) or `name`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -2907,7 +3001,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -3130,7 +3224,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -3292,7 +3386,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -3502,7 +3596,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -3554,7 +3648,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -4264,7 +4358,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -4292,7 +4386,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -4496,7 +4590,7 @@ ], "responses": { "202": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -4572,7 +4666,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -4610,7 +4704,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -5311,7 +5405,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -5342,7 +5436,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -5674,7 +5768,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -6000,7 +6094,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -6020,7 +6114,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -6655,7 +6749,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -7143,7 +7237,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -7163,7 +7257,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -7232,10 +7326,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -7590,7 +7684,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -8750,7 +8844,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -8772,7 +8866,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -8792,7 +8886,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -8812,7 +8906,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -8925,11 +9019,20 @@ "type": "integer", "default": 1 } + }, + { + "name": "client_id", + "in": "query", + "required": false, + "description": "The client ID of your GitHub app.", + "schema": { + "type": "string" + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -9147,7 +9250,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -9170,7 +9273,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -9190,7 +9293,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -9249,7 +9352,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -9454,7 +9557,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -9477,7 +9580,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -9534,10 +9637,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -9560,7 +9663,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -9627,7 +9730,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -9674,7 +9777,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -9882,7 +9985,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -10090,7 +10193,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -10128,7 +10231,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -10442,7 +10545,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -10462,7 +10565,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -10528,11 +10631,20 @@ "type": "integer", "default": 1 } + }, + { + "name": "client_id", + "in": "query", + "required": false, + "description": "The client ID of your GitHub app.", + "schema": { + "type": "string" + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -11207,7 +11319,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -11230,7 +11342,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -11250,7 +11362,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -11345,7 +11457,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -12003,7 +12115,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -12092,7 +12204,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -12115,7 +12227,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -13534,7 +13646,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -13603,7 +13715,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -13626,7 +13738,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -15049,7 +15161,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -15157,7 +15269,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -15807,7 +15919,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -15830,7 +15942,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -15937,7 +16049,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -16587,7 +16699,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -16693,10 +16805,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -16719,7 +16831,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -16770,7 +16882,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -16833,10 +16945,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -16897,7 +17009,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -16950,7 +17062,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -16970,10 +17082,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -17061,7 +17173,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -17111,7 +17223,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -17180,7 +17292,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -17220,7 +17332,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -17242,7 +17354,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -17307,10 +17419,10 @@ } } }, - "description": "response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -17338,7 +17450,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -17415,7 +17527,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -17684,7 +17796,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -20335,7 +20447,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -20358,7 +20470,7 @@ } }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -20407,7 +20519,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -20709,7 +20821,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -21127,7 +21239,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -21236,7 +21348,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -21469,7 +21581,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -21538,10 +21650,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -21635,7 +21747,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -22053,7 +22165,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -22122,7 +22234,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -22199,7 +22311,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -22617,7 +22729,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -22637,7 +22749,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -22696,7 +22808,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -22954,7 +23066,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -22974,7 +23086,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -23081,7 +23193,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -23306,7 +23418,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -23375,7 +23487,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -23429,10 +23541,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -23452,7 +23564,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -23529,7 +23641,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -23761,10 +23873,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -23858,7 +23970,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -24085,10 +24197,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -24173,7 +24285,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -24392,10 +24504,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -24511,7 +24623,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -24730,7 +24842,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -24793,13 +24905,13 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -24893,7 +25005,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -25106,7 +25218,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -25126,7 +25238,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -25203,7 +25315,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -25472,7 +25584,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -25492,7 +25604,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -25549,7 +25661,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -25962,7 +26074,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -25982,7 +26094,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -26051,7 +26163,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -26126,7 +26238,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -26183,10 +26295,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -26206,7 +26318,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -26263,13 +26375,13 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -26353,7 +26465,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -26578,7 +26690,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -26647,7 +26759,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -26715,7 +26827,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -26737,7 +26849,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -26775,7 +26887,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -26809,7 +26921,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -26867,7 +26979,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -27979,10 +28091,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -28047,6 +28159,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -28167,7 +28280,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -30579,7 +30692,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -30648,10 +30761,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -30714,11 +30827,20 @@ "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", + "description": "Response", "content": { "application/json": { "schema": { @@ -30824,7 +30946,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -30862,7 +30984,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -31015,7 +31137,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -31035,7 +31157,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -31098,7 +31220,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "headers": { "Content-Type": { "example": "text/html", @@ -31128,7 +31250,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -31173,7 +31295,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "headers": { "X-CommonMarker-Version": { "example": "0.17.4", @@ -31191,7 +31313,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -31222,7 +31344,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -31260,7 +31382,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -31324,7 +31446,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -33975,7 +34097,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -34015,10 +34137,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "301": { - "description": "Moved Permanently" + "description": "Moved permanently" } }, "x-github": { @@ -34104,7 +34226,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -35740,7 +35862,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -35763,7 +35885,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -35783,7 +35905,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -35898,7 +36020,7 @@ }, "responses": { "202": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -35913,10 +36035,10 @@ } }, "205": { - "description": "response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -35939,7 +36061,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -35995,7 +36117,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -37618,7 +37740,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -37641,7 +37763,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -37695,10 +37817,10 @@ ], "responses": { "205": { - "description": "response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -37757,7 +37879,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -37822,7 +37944,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -37845,7 +37967,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -37915,7 +38037,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -37980,7 +38102,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -38003,7 +38125,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -38057,10 +38179,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -38083,7 +38205,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -38135,7 +38257,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/octocat-stream": { "schema": { @@ -38189,7 +38311,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -38300,7 +38422,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -38338,7 +38460,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -38606,7 +38728,9 @@ "plan": { "name": "Medium", "space": 400, - "private_repos": 20 + "private_repos": 20, + "filled_seats": 4, + "seats": 5 }, "default_repository_permission": "read", "members_can_create_repositories": true, @@ -38617,54 +38741,13 @@ "members_can_create_internal_repositories": false, "members_can_create_pages": true } - }, - "response-with-git-hub-plan-information": { - "summary": "Response with GitHub plan information", - "value": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization", - "name": "github", - "company": "GitHub", - "blog": "https://github.com/blog", - "location": "San Francisco", - "email": "octocat@github.com", - "twitter_username": "github", - "is_verified": true, - "has_organization_projects": true, - "has_repository_projects": true, - "public_repos": 2, - "public_gists": 1, - "followers": 20, - "following": 0, - "html_url": "https://github.com/octocat", - "created_at": "2008-01-14T04:33:35Z", - "updated_at": "2014-03-03T18:58:10Z", - "type": "Organization", - "plan": { - "name": "team", - "space": 976562499, - "private_repos": 999999, - "filled_seats": 4, - "seats": 5 - } - } } } } } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -38821,7 +38904,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -39100,7 +39183,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -39216,7 +39299,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -39295,7 +39378,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -41999,7 +42082,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -42126,7 +42209,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -42263,7 +42346,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -42385,7 +42468,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -42454,7 +42537,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -42517,7 +42600,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -42631,7 +42714,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -42758,7 +42841,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -42871,7 +42954,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -42940,7 +43023,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -43001,10 +43084,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -43067,10 +43150,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -43135,7 +43218,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -43689,7 +43772,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -44253,6 +44336,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -44341,7 +44425,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -46753,7 +46837,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -46858,7 +46942,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -47025,7 +47109,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -47195,7 +47279,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -47232,7 +47316,7 @@ "/orgs/{org}/memberships/{username}": { "get": { "summary": "Get organization membership for a user", - "description": "In order to get a user's membership with an organization, the authenticated user must be an organization member.", + "description": "In order to get a user's membership with an organization, the authenticated user must be an organization member. The `state` parameter in the response can be used to identify the user's membership status.", "tags": [ "orgs" ], @@ -47261,7 +47345,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -47276,11 +47360,21 @@ }, "state": { "type": "string", - "example": "active" + "description": "The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.", + "example": "active", + "enum": [ + "active", + "pending" + ] }, "role": { "type": "string", - "example": "admin" + "description": "The user's membership type in the organization.", + "example": "admin", + "enum": [ + "admin", + "member" + ] }, "organization_url": { "type": "string", @@ -47541,99 +47635,13 @@ "site_admin": false } } - }, - "response-if-user-has-an-active-membership-with-organization": { - "summary": "Response if user has an active membership with organization", - "value": { - "url": "https://api.github.com/orgs/octocat/memberships/defunkt", - "state": "active", - "role": "member", - "organization_url": "https://api.github.com/orgs/octocat", - "organization": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization" - }, - "user": { - "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 - } - } - }, - "response-if-user-has-a-pending-membership-with-organization": { - "summary": "Response if user has a pending membership with organization", - "value": { - "url": "https://api.github.com/orgs/invitocat/memberships/defunkt", - "state": "pending", - "role": "member", - "organization_url": "https://api.github.com/orgs/invitocat", - "organization": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization" - }, - "user": { - "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 - } - } } } } } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -47734,7 +47742,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -47749,11 +47757,21 @@ }, "state": { "type": "string", - "example": "active" + "description": "The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.", + "example": "active", + "enum": [ + "active", + "pending" + ] }, "role": { "type": "string", - "example": "admin" + "description": "The user's membership type in the organization.", + "example": "admin", + "enum": [ + "admin", + "member" + ] }, "organization_url": { "type": "string", @@ -47972,51 +47990,8 @@ ] }, "examples": { - "response-if-user-was-previously-unaffiliated-with-organization": { - "summary": "Response if user was previously unaffiliated with organization", - "value": { - "url": "https://api.github.com/orgs/invitocat/memberships/defunkt", - "state": "pending", - "role": "admin", - "organization_url": "https://api.github.com/orgs/invitocat", - "organization": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization" - }, - "user": { - "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 - } - } - }, "response-if-user-already-had-membership-with-organization": { - "summary": "Response if user already had membership with organization", + "summary": "Response if user has an active admin membership with organization", "value": { "url": "https://api.github.com/orgs/octocat/memberships/defunkt", "state": "active", @@ -48063,7 +48038,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -48193,7 +48168,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -48216,7 +48191,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -48303,7 +48278,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -48508,41 +48483,10 @@ "description": "User was converted" }, "403": { - "description": "response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - }, - "examples": { - "response-if-user-is-the-last-owner-of-the-organization": { - "summary": "Response if user is the last owner of the organization", - "value": { - "message": "Cannot convert the last owner to an outside collaborator", - "documentation_url": "https://docs.github.com/enterprise-server@2.19/rest/reference/orgs#convert-member-to-outside-collaborator" - } - }, - "response-if-user-is-not-a-member-of-the-organization": { - "summary": "Response if user is not a member of the organization", - "value": { - "message": " is not a member of the organization.", - "documentation_url": "https://docs.github.com/enterprise-server@2.19/rest/reference/orgs#convert-member-to-outside-collaborator" - } - } - } - } - } + "description": "Response if user is the last owner of the organization or not a member of the organization" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -48603,7 +48547,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "422": { "description": "Response if user is a member of the organization", @@ -48681,11 +48625,40 @@ "type": "integer", "default": 1 } + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "sort", + "description": "The sort order for the response collection.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -48775,7 +48748,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -48858,7 +48831,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -48964,7 +48937,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -49074,7 +49047,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -49343,7 +49316,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -49436,7 +49409,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -49692,7 +49665,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -49732,7 +49705,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -49772,7 +49745,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -49859,7 +49832,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -50105,7 +50078,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -50169,7 +50142,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -50206,7 +50179,7 @@ }, { "name": "type", - "description": "Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`.", + "description": "Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Note: For GitHub AE, can be one of `all`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`.", "in": "query", "required": false, "schema": { @@ -50272,7 +50245,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -51894,7 +51867,7 @@ }, "post": { "summary": "Create an organization repository", - "description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.19/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", + "description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.19/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository", "tags": [ "repos" ], @@ -51933,12 +51906,12 @@ }, "private": { "type": "boolean", - "description": "Either `true` to create a private repository or `false` to create a public one.", + "description": "Whether the repository is private.", "default": false }, "visibility": { "type": "string", - "description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", + "description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", "enum": [ "public", "private", @@ -52022,7 +51995,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -53124,7 +53097,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -53255,7 +53228,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -53551,7 +53524,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -54020,7 +53993,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -54153,7 +54126,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -54622,7 +54595,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -54678,7 +54651,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -54905,7 +54878,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -54928,7 +54901,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -54948,7 +54921,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -55028,7 +55001,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -55255,7 +55228,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -55278,7 +55251,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -55298,7 +55271,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -55318,7 +55291,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -55386,10 +55359,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -55416,7 +55389,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -55436,7 +55409,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -55521,7 +55494,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -55534,7 +55507,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -55575,7 +55548,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -55595,7 +55568,7 @@ } }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -55630,7 +55603,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -55739,7 +55712,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -55816,7 +55789,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -55839,7 +55812,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -55859,7 +55832,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -55936,7 +55909,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -56013,7 +55986,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -56036,7 +56009,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -56094,10 +56067,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -56120,7 +56093,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -56213,7 +56186,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -56453,7 +56426,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -56476,7 +56449,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -56577,7 +56550,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -56804,7 +56777,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -56827,7 +56800,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -56847,7 +56820,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -56943,7 +56916,7 @@ } }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -57038,7 +57011,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -57051,7 +57024,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -57074,7 +57047,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -57104,7 +57077,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -57163,7 +57136,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -57419,7 +57392,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -57442,7 +57415,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -57540,7 +57513,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -57799,7 +57772,7 @@ "description": "Response if the authenticated user does not have access to the project" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -57826,7 +57799,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -57866,7 +57839,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -57936,7 +57909,7 @@ "description": "Delete Success" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -57963,7 +57936,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -58003,7 +57976,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -58095,7 +58068,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -58251,7 +58224,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -58271,7 +58244,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -58293,7 +58266,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -58362,7 +58335,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -58385,7 +58358,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -58474,10 +58447,10 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -58497,7 +58470,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -58519,7 +58492,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -58588,7 +58561,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -58611,7 +58584,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -58676,13 +58649,13 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -58702,7 +58675,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -58744,7 +58717,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -58813,7 +58786,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -58880,7 +58853,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -59045,7 +59018,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -59065,7 +59038,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -59087,7 +59060,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -59156,7 +59129,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -59179,7 +59152,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -59256,7 +59229,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -59346,7 +59319,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -59369,7 +59342,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -59445,7 +59418,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -59518,7 +59491,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -59541,7 +59514,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -59571,7 +59544,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -59623,7 +59596,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -59849,10 +59822,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -59917,7 +59890,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -59965,7 +59938,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -64595,7 +64568,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -64615,7 +64588,7 @@ } }, "301": { - "description": "Moved Permanently" + "description": "Moved permanently" } }, "x-github": { @@ -64764,7 +64737,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -68891,7 +68864,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -68960,7 +68933,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -69030,7 +69003,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "If an organization owner has configured the organization to prevent members from deleting organization-owned repositories, a member will get this response:", @@ -69055,7 +69028,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -69136,7 +69109,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -69292,7 +69265,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -69456,7 +69429,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -70383,18 +70356,6 @@ }, "examples": { "default": { - "value": [ - { - "name": "master", - "commit": { - "sha": "c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc", - "url": "https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc" - }, - "protected": true - } - ] - }, - "with-protection": { "value": [ { "name": "master", @@ -70430,7 +70391,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -70503,7 +70464,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -72022,7 +71983,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -72044,7 +72005,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -72117,7 +72078,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -73157,7 +73118,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -73396,7 +73357,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -74352,7 +74313,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -74374,7 +74335,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -74404,7 +74365,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -74479,7 +74440,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -74555,7 +74516,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -74641,7 +74602,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -74730,7 +74691,7 @@ "description": "No Content" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -74803,7 +74764,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/vnd.github.luke-cage-preview+json": { "schema": { @@ -75282,7 +75243,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -75650,7 +75611,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -75777,7 +75738,7 @@ "description": "No Content" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -75850,7 +75811,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -75885,7 +75846,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -75960,7 +75921,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -75995,7 +75956,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -76073,7 +76034,7 @@ "description": "No Content" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -76150,7 +76111,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -76205,7 +76166,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -76304,7 +76265,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -76359,7 +76320,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -76379,7 +76340,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -76555,7 +76516,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -76571,7 +76532,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -76668,7 +76629,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -76685,7 +76646,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -76774,7 +76735,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -76872,7 +76833,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -76888,7 +76849,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -76957,7 +76918,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -77055,7 +77016,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -77071,7 +77032,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -77091,7 +77052,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -77214,7 +77175,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -77810,7 +77771,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -77937,7 +77898,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -78236,7 +78197,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -78333,7 +78294,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -78632,7 +78593,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -78779,7 +78740,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -79078,7 +79039,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -79225,7 +79186,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -79524,7 +79485,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -79647,7 +79608,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -79818,7 +79779,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -79915,7 +79876,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -80086,7 +80047,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -80233,7 +80194,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -80404,7 +80365,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -80551,7 +80512,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -80722,7 +80683,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -80845,7 +80806,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -80993,7 +80954,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -81090,7 +81051,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -81238,7 +81199,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -81385,7 +81346,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -81533,7 +81494,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -81680,7 +81641,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -81828,7 +81789,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -82135,7 +82096,7 @@ "name", "head_sha" ], - "anyOf": [ + "oneOf": [ { "properties": { "status": { @@ -82145,6 +82106,7 @@ } }, "required": [ + "status", "conclusion" ], "additionalProperties": true @@ -82164,7 +82126,7 @@ }, "examples": { "example-of-in-progress-conclusion": { - "summary": "Example of in_progress conclusion", + "summary": "Response for in_progress conclusion", "value": { "name": "mighty_readme", "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -82179,7 +82141,7 @@ } }, "example-of-completed-conclusion": { - "summary": "Example of completed conclusion", + "summary": "Response for completed conclusion", "value": { "name": "mighty_readme", "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -82233,7 +82195,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -83049,101 +83011,8 @@ ] }, "examples": { - "example-of-in-progress-conclusion": { - "summary": "Example of in_progress conclusion", - "value": { - "id": 4, - "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", - "node_id": "MDg6Q2hlY2tSdW40", - "external_id": "42", - "url": "https://api.github.com/repos/github/hello-world/check-runs/4", - "html_url": "https://github.com/github/hello-world/runs/4", - "details_url": "https://example.com", - "status": "in_progress", - "conclusion": "neutral", - "started_at": "2018-05-04T01:14:52Z", - "completed_at": null, - "output": { - "title": "Mighty Readme Report", - "summary": "", - "text": "", - "annotations_count": 1, - "annotations_url": "https://api.github.com/repos/github/hello-world/check-runs/4/annotations" - }, - "name": "mighty_readme", - "check_suite": { - "id": 5 - }, - "app": { - "id": 1, - "slug": "octoapp", - "node_id": "MDExOkludGVncmF0aW9uMQ==", - "owner": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "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", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": true - }, - "name": "Octocat App", - "description": "", - "external_url": "https://example.com", - "html_url": "https://github.com/apps/octoapp", - "created_at": "2017-07-08T16:18:44-04:00", - "updated_at": "2017-07-08T16:18:44-04:00", - "permissions": { - "metadata": "read", - "contents": "read", - "issues": "write", - "single_file": "write" - }, - "events": [ - "push", - "pull_request" - ] - }, - "pull_requests": [ - { - "url": "https://api.github.com/repos/github/hello-world/pulls/1", - "id": 1934, - "number": 3956, - "head": { - "ref": "say-hello", - "sha": "3dca65fa3e8d4b3da3f3d056c59aee1c50f41390", - "repo": { - "id": 526, - "url": "https://api.github.com/repos/github/hello-world", - "name": "hello-world" - } - }, - "base": { - "ref": "master", - "sha": "e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f", - "repo": { - "id": 526, - "url": "https://api.github.com/repos/github/hello-world", - "name": "hello-world" - } - } - } - ] - } - }, "example-of-completed-conclusion": { - "summary": "Example of completed conclusion", + "summary": "Response for completed conclusion", "value": { "id": 4, "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -83296,7 +83165,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -84517,7 +84386,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -85504,7 +85373,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -85672,7 +85541,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -88035,7 +87904,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -89213,7 +89082,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -91599,7 +91468,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -92596,7 +92465,7 @@ ], "responses": { "201": { - "description": "response" + "description": "Response" } }, "x-github": { @@ -92679,7 +92548,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -92854,7 +92723,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -94890,7 +94759,7 @@ "description": "Response when person is already a collaborator" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -95029,7 +94898,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -95248,7 +95117,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -95329,7 +95198,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -95687,7 +95556,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -95976,7 +95845,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -96071,7 +95940,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -96360,7 +96229,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -96430,10 +96299,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -96542,7 +96411,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -96751,7 +96620,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -96771,7 +96640,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -97270,7 +97139,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -97292,7 +97161,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -97467,11 +97336,31 @@ "type": "integer", "default": 1 } + }, + { + "name": "top", + "description": "legacy parameter for pagination.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "last_sha", + "description": "legacy parameter for pagination.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -98124,7 +98013,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -98217,7 +98106,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -98274,7 +98163,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -98296,7 +98185,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -98440,7 +98329,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -98833,7 +98722,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -99150,7 +99039,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -99291,7 +99180,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -103062,7 +102951,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -103128,9 +103017,27 @@ "type": "string" } }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -103141,7 +103048,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -103724,7 +103631,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -103793,7 +103700,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -103875,7 +103782,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -103937,11 +103844,19 @@ "type": "integer", "default": 1 } + }, + { + "name": "app_id", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -104928,7 +104843,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -104976,7 +104891,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -107185,18 +107100,36 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true + }, + { + "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", + "description": "Response", "content": { "application/json": { "schema": { @@ -108868,7 +108801,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -108930,7 +108863,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -108959,7 +108892,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -109178,7 +109111,7 @@ } }, "301": { - "description": "Moved Permanently" + "description": "Moved permanently" } }, "x-github": { @@ -109240,7 +109173,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -111103,7 +111036,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -111165,7 +111098,7 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { @@ -111185,7 +111118,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/vnd.github.v3.object": { "schema": { @@ -111797,7 +111730,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -111880,7 +111813,7 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { @@ -111991,7 +111924,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -112207,7 +112140,7 @@ } }, "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -112423,7 +112356,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -112443,7 +112376,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -112572,7 +112505,7 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { @@ -112646,7 +112579,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -112847,7 +112780,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -112916,7 +112849,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -112956,7 +112889,7 @@ } }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -113198,7 +113131,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -113295,7 +113228,8 @@ "required": false, "schema": { "type": "string", - "default": "none" + "default": "none", + "nullable": true } }, { @@ -113319,7 +113253,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -113986,7 +113920,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -114495,48 +114429,6 @@ "transient_environment": false, "production_environment": true } - }, - "advanced-example": { - "summary": "Advanced example", - "value": { - "url": "https://api.github.com/repos/octocat/example/deployments/1", - "id": 1, - "node_id": "MDEwOkRlcGxveW1lbnQx", - "sha": "a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d", - "ref": "topic-branch", - "task": "deploy", - "payload": { - }, - "original_environment": "staging", - "environment": "production", - "description": "Deploy request from hubot", - "creator": { - "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 - }, - "created_at": "2012-07-20T01:19:13Z", - "updated_at": "2012-07-20T01:19:13Z", - "statuses_url": "https://api.github.com/repos/octocat/example/deployments/1/statuses", - "repository_url": "https://api.github.com/repos/octocat/example", - "transient_environment": false, - "production_environment": true - } } } } @@ -114565,40 +114457,10 @@ } }, "409": { - "description": "response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string", - "example": "\"https://docs.github.com/enterprise-server@2.19/rest/reference/repos#create-a-deployment\"" - } - } - }, - "examples": { - "merge-conflict-response": { - "summary": "Merge conflict response", - "value": { - "message": "Conflict merging master into topic-branch" - } - }, - "failed-commit-status-checks": { - "summary": "Failed commit status checks", - "value": { - "message": "Conflict: Commit status checks failed for topic-branch." - } - } - } - } - } + "description": "Response when there is a merge conflict or the commit's status checks failed" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -114723,7 +114585,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -115237,7 +115099,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -115336,7 +115198,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -115860,7 +115722,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -116005,7 +115867,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -116524,7 +116386,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -116662,7 +116524,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -117173,7 +117035,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -117193,7 +117055,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -117290,7 +117152,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -119991,7 +119853,8 @@ "enum": [ "newest", "oldest", - "stargazers" + "stargazers", + "watchers" ], "default": "newest" } @@ -120013,11 +119876,31 @@ "type": "integer", "default": 1 } + }, + { + "name": "org", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "organization", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -121709,6 +121592,26 @@ "schema": { "type": "string" } + }, + { + "name": "org", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "organization", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } } ], "requestBody": { @@ -121716,6 +121619,7 @@ "application/json": { "schema": { "type": "object", + "nullable": true, "properties": { "organization": { "type": "string", @@ -121728,7 +121632,7 @@ }, "responses": { "202": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -122856,7 +122760,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -122945,7 +122849,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -123035,7 +122939,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -123075,7 +122979,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -123135,7 +123039,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -123255,7 +123159,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -123312,7 +123216,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -123332,7 +123236,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -123547,7 +123451,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -123763,7 +123667,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -123832,7 +123736,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -123905,7 +123809,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -124113,7 +124017,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -124175,7 +124079,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -124204,7 +124108,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -124337,7 +124241,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -124348,7 +124252,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -124416,7 +124320,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -124510,7 +124414,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -124586,7 +124490,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -124697,7 +124601,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -124735,7 +124639,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -124803,7 +124707,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -124912,7 +124816,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -124923,10 +124827,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -125105,7 +125009,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -125252,7 +125156,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -125372,7 +125276,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -125511,7 +125415,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -125645,7 +125549,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -125773,7 +125677,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -125842,7 +125746,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -125928,7 +125832,8 @@ "required": true, "schema": { "type": "string" - } + }, + "x-multi-segment": true }, { "name": "recursive", @@ -125942,7 +125847,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -126096,7 +126001,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -126165,7 +126070,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -126246,7 +126151,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -126443,7 +126348,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -126588,7 +126493,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -126780,7 +126685,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -126800,7 +126705,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -126940,7 +126845,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -127124,7 +127029,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -127277,7 +127182,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -127461,7 +127366,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -127530,7 +127435,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -127599,10 +127504,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -127673,10 +127578,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -127747,10 +127652,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -127823,7 +127728,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -128311,10 +128216,10 @@ } }, "301": { - "description": "Moved Permanently" + "description": "Moved permanently" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -128398,7 +128303,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -130365,7 +130270,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -132296,7 +132201,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -132458,7 +132363,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -134611,10 +134516,10 @@ } }, "301": { - "description": "Moved Permanently" + "description": "Moved permanently" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -134683,7 +134588,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -134841,7 +134746,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -137180,7 +137085,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -137249,7 +137154,7 @@ } }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -137270,7 +137175,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -137408,7 +137313,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -137953,7 +137858,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -138022,7 +137927,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -138098,7 +138003,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -138630,7 +138535,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -138725,7 +138630,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -139257,7 +139162,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -139376,7 +139281,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -139468,7 +139373,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -139677,7 +139582,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -139697,7 +139602,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -140196,7 +140101,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -140218,7 +140123,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -140352,7 +140257,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -143437,7 +143342,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -143566,7 +143471,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -146638,7 +146543,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -146764,7 +146669,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -149075,10 +148980,10 @@ } }, "301": { - "description": "Moved Permanently" + "description": "Moved permanently" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -149118,7 +149023,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -149277,7 +149182,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -151588,7 +151493,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -151657,7 +151562,7 @@ } }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -151698,10 +151603,10 @@ } }, "301": { - "description": "Moved Permanently" + "description": "Moved permanently" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -151817,7 +151722,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -154071,7 +153976,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -156330,7 +156235,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -156875,7 +156780,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -156990,7 +156895,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -157570,7 +157475,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -157639,7 +157544,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -157730,7 +157635,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -158088,7 +157993,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -158276,7 +158181,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -158379,7 +158284,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -158522,7 +158427,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -158625,7 +158530,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -158744,7 +158649,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "410": { "description": "Gone", @@ -158827,7 +158732,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -158901,7 +158806,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -159015,7 +158920,7 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -159058,7 +158963,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -159078,7 +158983,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -159200,7 +159105,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -159223,7 +159128,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -159332,7 +159237,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -159541,7 +159446,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -159581,7 +159486,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -159688,7 +159593,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -159884,7 +159789,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -159906,7 +159811,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -160049,7 +159954,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -160308,7 +160213,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -160348,7 +160253,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -160440,7 +160345,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -160582,7 +160487,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -160647,7 +160552,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -160768,7 +160673,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -160825,7 +160730,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -160895,7 +160800,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -160959,7 +160864,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -161050,7 +160955,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -161142,7 +161047,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -161219,7 +161124,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -161288,7 +161193,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -161359,7 +161264,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -161428,7 +161333,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -161525,7 +161430,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -161643,7 +161548,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -161689,7 +161594,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -161755,7 +161660,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -162581,63 +162486,10 @@ } }, "404": { - "description": "response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string", - "example": "\"https://docs.github.com/enterprise-server@2.19/rest/reference/repos#perform-a-merge\"" - } - } - }, - "examples": { - "missing-base-response": { - "summary": "Missing base response", - "value": { - "message": "Base does not exist" - } - }, - "missing-head-response": { - "summary": "Missing head response", - "value": { - "message": "Head does not exist" - } - } - } - } - } + "description": "Response when the base or head does not exist" }, "409": { - "description": "Merge conflict response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string", - "example": "\"https://docs.github.com/enterprise-server@2.19/rest/reference/repos#perform-a-merge\"" - } - } - }, - "examples": { - "merge-conflict-response": { - "value": { - "message": "Merge Conflict" - } - } - } - } - } + "description": "Response when there is a merge conflict" }, "403": { "description": "Forbidden", @@ -162660,7 +162512,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -162833,7 +162685,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -163114,7 +162966,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -163216,7 +163068,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -163492,7 +163344,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -163512,7 +163364,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -163633,7 +163485,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -163901,7 +163753,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -164009,7 +163861,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -164327,10 +164179,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -164420,7 +164272,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -164610,7 +164462,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -166302,7 +166154,7 @@ }, "responses": { "202": { - "description": "response" + "description": "Response" } }, "x-github": { @@ -166348,7 +166200,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -166441,7 +166293,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -166549,7 +166401,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -166642,7 +166494,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -166711,7 +166563,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -166858,10 +166710,10 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -167025,10 +166877,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -167097,7 +166949,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -167119,7 +166971,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -167204,7 +167056,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -167467,7 +167319,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -167545,7 +167397,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -167805,7 +167657,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -168071,11 +167923,39 @@ "type": "integer", "default": 1 } + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -168169,7 +168049,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -168256,7 +168136,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -168475,7 +168355,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -168744,7 +168624,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -168784,7 +168664,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -168824,7 +168704,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -168925,7 +168805,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -169181,7 +169061,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -169221,7 +169101,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -169261,7 +169141,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -169418,7 +169298,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -173189,10 +173069,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -173359,7 +173239,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -176388,7 +176268,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -176508,16 +176388,15 @@ }, { "name": "sort", - "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to).", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "created", - "updated" - ], - "default": "created" + "updated", + "created_at" + ] } }, { @@ -176563,7 +176442,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -177042,7 +176921,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -177447,7 +177326,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -177547,7 +177426,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -178006,10 +177885,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -178118,7 +177997,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -178327,7 +178206,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -178347,7 +178226,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -178846,7 +178725,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -178868,7 +178747,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -181993,7 +181872,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "500": { "description": "Internal Error", @@ -182016,7 +181895,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -182126,7 +182005,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -185127,7 +185006,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -185329,7 +185208,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -185805,7 +185684,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -186125,7 +186004,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -186538,7 +186417,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -186628,7 +186507,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -187276,7 +187155,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -187377,7 +187256,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -187691,7 +187570,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -187780,7 +187659,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -187870,7 +187749,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -188231,7 +188110,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -192157,10 +192036,10 @@ }, "responses": { "200": { - "description": "response" + "description": "Response" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -192717,7 +192596,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -192993,7 +192872,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -193104,7 +192983,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -193380,7 +193259,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -193479,7 +193358,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -193755,7 +193634,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -193843,7 +193722,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -194119,7 +193998,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -194149,7 +194028,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -194247,7 +194126,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -194648,7 +194527,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -194750,7 +194629,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -195026,7 +194905,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -195046,7 +194925,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -195163,7 +195042,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -195439,7 +195318,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -195459,7 +195338,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -195579,7 +195458,7 @@ }, "responses": { "202": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -195601,7 +195480,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -195690,7 +195569,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -195766,6 +195645,279 @@ } } ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Content File", + "description": "Content File", + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "encoding": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "path": { + "type": "string" + }, + "content": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "git_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "download_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "_links": { + "type": "object", + "properties": { + "git": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html": { + "type": "string", + "format": "uri", + "nullable": true + }, + "self": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "git", + "html", + "self" + ] + }, + "target": { + "type": "string", + "example": "\"actual/actual.md\"" + }, + "submodule_git_url": { + "type": "string", + "example": "\"git://example.com/defunkt/dotjs.git\"" + } + }, + "required": [ + "_links", + "git_url", + "html_url", + "download_url", + "name", + "path", + "sha", + "size", + "type", + "url", + "content", + "encoding" + ] + }, + "examples": { + "default": { + "value": { + "type": "file", + "encoding": "base64", + "size": 5362, + "name": "README.md", + "path": "README.md", + "content": "encoded content ...", + "sha": "3d21ec53a331a6f037a91c368710b99387d012c1", + "url": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md", + "git_url": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1", + "html_url": "https://github.com/octokit/octokit.rb/blob/master/README.md", + "download_url": "https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md", + "_links": { + "git": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1", + "self": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md", + "html": "https://github.com/octokit/octokit.rb/blob/master/README.md" + } + } + } + } + } + } + }, + "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" + } + } + } + } + } + }, + "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" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "repos", + "subcategory": "contents" + } + } + }, + "/repos/{owner}/{repo}/readme/{dir}": { + "get": { + "summary": "Get a repository README", + "description": "Gets the preferred README for a repository.\n\nREADMEs support [custom media types](https://docs.github.com/enterprise-server@2.19/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML.", + "tags": [ + "repos" + ], + "operationId": "repos/get-readme-from-alt-path", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#get-a-repository-readme" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "dir", + "description": "The alternate path to look for a README file", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + }, + { + "name": "ref", + "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], "responses": { "200": { "description": "response", @@ -195890,7 +196042,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -195910,7 +196062,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -196040,7 +196192,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -196540,7 +196692,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -196649,7 +196801,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -197144,7 +197296,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -197498,7 +197650,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -197518,7 +197670,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -197620,7 +197772,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -197902,7 +198054,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -197948,7 +198100,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -198477,7 +198629,7 @@ }, { "name": "tag", - "description": "tag+ parameter", + "description": "tag parameter", "in": "path", "required": true, "schema": { @@ -198488,7 +198640,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -198975,7 +199127,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -199534,7 +199686,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -199647,7 +199799,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -200184,7 +200336,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -200257,7 +200409,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -200880,7 +201032,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -201204,7 +201356,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -201388,7 +201540,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -201889,7 +202041,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -202086,7 +202238,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -202361,7 +202513,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -202705,7 +202857,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -202808,7 +202960,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -202872,7 +203024,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -203004,7 +203156,7 @@ ], "responses": { "302": { - "description": "response", + "description": "Response", "headers": { "Location": { "example": "https://codeload.github.com/me/myprivate/legacy.zip/master?login=me&token=thistokenexpires", @@ -203076,7 +203228,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -203294,11 +203446,29 @@ "schema": { "type": "string" } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -203333,7 +203503,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -203355,7 +203525,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -203449,7 +203619,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -203484,7 +203654,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -203506,7 +203676,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -203526,7 +203696,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -203635,7 +203805,7 @@ }, "responses": { "202": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -204752,7 +204922,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -204800,7 +204970,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -204858,7 +205028,7 @@ ], "responses": { "302": { - "description": "response", + "description": "Response", "headers": { "Location": { "example": "https://codeload.github.com/me/myprivate/legacy.zip/master?login=me&token=thistokenexpires", @@ -204883,7 +205053,7 @@ "/repos/{template_owner}/{template_repo}/generate": { "post": { "summary": "Create a repository using a template", - "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@2.19/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.19/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", + "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@2.19/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.19/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository", "tags": [ "repos" ], @@ -204955,7 +205125,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -206054,7 +206224,7 @@ "/repositories": { "get": { "summary": "List public repositories", - "description": "Lists all public repositories in the order that they were created.\n\nNote: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@2.19/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.", + "description": "Lists all public repositories in the order that they were created.\n\nNotes:\n- For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise.\n- Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@2.19/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.", "tags": [ "repos" ], @@ -206075,7 +206245,7 @@ }, { "name": "visibility", - "description": "Specifies the types of repositories to return. Can be one of `all` or `public`. Default: `public`.", + "description": "Specifies the types of repositories to return. Can be one of `all` or `public`. Default: `public`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise.", "in": "query", "required": false, "schema": { @@ -206091,7 +206261,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -207648,7 +207818,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -207717,7 +207887,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -207800,7 +207970,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -209477,10 +209647,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -209501,7 +209671,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -209671,7 +209841,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -211641,10 +211811,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -211760,7 +211930,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -213889,7 +214059,7 @@ } }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -213910,7 +214080,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -213979,7 +214149,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -214074,7 +214244,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -214212,10 +214382,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -214255,7 +214425,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -214407,7 +214577,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -215116,7 +215286,7 @@ } }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -215137,7 +215307,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -215206,7 +215376,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -215249,7 +215419,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -215523,10 +215693,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -215634,7 +215804,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -215878,10 +216048,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -215902,7 +216072,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -215996,7 +216166,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -216083,7 +216253,7 @@ }, "responses": { "202": { - "description": "response" + "description": "Response" } }, "x-github": { @@ -216111,7 +216281,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -216192,7 +216362,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -216293,7 +216463,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -216902,7 +217072,7 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "requestBody": { @@ -216948,7 +217118,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -217006,7 +217176,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -217086,7 +217256,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -217164,7 +217334,7 @@ }, "responses": { "202": { - "description": "response" + "description": "Response" } }, "requestBody": { @@ -217218,7 +217388,7 @@ }, "responses": { "202": { - "description": "response" + "description": "Response" } }, "requestBody": { @@ -217271,7 +217441,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -217777,7 +217947,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -218330,7 +218500,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -218404,7 +218574,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -218783,7 +218953,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -219192,7 +219362,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -219566,7 +219736,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -219962,7 +220132,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -220040,7 +220210,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -220393,7 +220563,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -220765,7 +220935,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -221113,7 +221283,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -221482,7 +221652,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -221583,7 +221753,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -221853,7 +222023,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -222172,7 +222342,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -222434,7 +222604,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -222731,7 +222901,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -222984,74 +223154,13 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { "description": "Response if team synchronization is set up" }, "422": { - "description": "response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "field": { - "type": "string" - }, - "resource": { - "type": "string" - } - } - } - }, - "documentation_url": { - "type": "string", - "example": "\"https://docs.github.com/enterprise-server@2.19/rest\"" - } - } - }, - "examples": { - "response-if-you-attempt-to-add-an-organization-to-a-team": { - "summary": "Response if you attempt to add an organization to a team", - "value": { - "message": "Cannot add an organization as a member.", - "errors": [ - { - "code": "org", - "field": "user", - "resource": "TeamMember" - } - ] - } - }, - "response-if-you-attempt-to-add-a-user-to-a-team-when-they-are-not-a-member-of-at-least-one-other-team-in-the-same-organization": { - "summary": "Response if you attempt to add a user to a team when they are not a member of at least one other team in the same organization", - "value": { - "message": "User isn't a member of this organization. Please invite them first.", - "errors": [ - { - "code": "unaffiliated", - "field": "user", - "resource": "TeamMember" - } - ] - } - } - } - } - } + "description": "Response if you attempt to add an organization to a team or you attempt to add a user to a team when they are not a member of at least one other team in the same organization" }, "403": { "description": "Forbidden", @@ -223118,7 +223227,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { "description": "Response if team synchronization is setup" @@ -223141,7 +223250,7 @@ "/teams/{team_id}/memberships/{username}": { "get": { "summary": "Get team membership for a user", - "description": "If you pass the `hellcat-preview` media type, team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:** The `role` for organization owners returns as `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@2.19/rest/reference/teams#create-a-team).", + "description": "If you pass the `hellcat-preview` media type, team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:**\nThe response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@2.19/rest/reference/teams#create-a-team).", "operationId": "teams/get-membership-for-user", "tags": [ "teams" @@ -223170,7 +223279,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -223193,7 +223302,12 @@ "type": "string" }, "state": { - "type": "string" + "description": "The state of the user's membership in the team.", + "type": "string", + "enum": [ + "active", + "pending" + ] } }, "required": [ @@ -223203,14 +223317,6 @@ ] }, "examples": { - "response-if-user-has-an-active-membership-with-team": { - "summary": "Response if user has an active membership with team", - "value": { - "url": "https://api.github.com/teams/1/memberships/octocat", - "role": "member", - "state": "active" - } - }, "response-if-user-is-a-team-maintainer": { "summary": "Response if user is a team maintainer", "value": { @@ -223218,14 +223324,6 @@ "role": "maintainer", "state": "active" } - }, - "response-if-user-has-a-pending-membership-with-team": { - "summary": "Response if user has a pending membership with team", - "value": { - "url": "https://api.github.com/teams/1/memberships/octocat", - "role": "member", - "state": "pending" - } } } } @@ -223277,7 +223375,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -223300,7 +223398,12 @@ "type": "string" }, "state": { - "type": "string" + "description": "The state of the user's membership in the team.", + "type": "string", + "enum": [ + "active", + "pending" + ] } }, "required": [ @@ -223310,14 +223413,6 @@ ] }, "examples": { - "response-if-users-membership-with-team-is-now-active": { - "summary": "Response if user's membership with team is now active", - "value": { - "url": "https://api.github.com/teams/1/memberships/octocat", - "role": "member", - "state": "active" - } - }, "response-if-users-membership-with-team-is-now-pending": { "summary": "Response if user's membership with team is now pending", "value": { @@ -223331,50 +223426,7 @@ } }, "422": { - "description": "Response if you attempt to add an organization to a team", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "field": { - "type": "string" - }, - "resource": { - "type": "string" - } - } - } - } - } - }, - "examples": { - "response-if-you-attempt-to-add-an-organization-to-a-team": { - "value": { - "message": "Cannot add an organization as a member.", - "errors": [ - { - "code": "org", - "field": "user", - "resource": "TeamMember" - } - ] - } - } - } - } - } + "description": "Response if you attempt to add an organization to a team" } }, "requestBody": { @@ -223438,7 +223490,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -223504,7 +223556,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -223830,7 +223882,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -224144,7 +224196,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Response if the project is not owned by the organization", @@ -224244,7 +224296,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -224300,7 +224352,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -231460,7 +231512,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "requestBody": { @@ -231536,7 +231588,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -231747,7 +231799,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -232290,7 +232342,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -232313,7 +232365,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -232409,7 +232461,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -232710,10 +232762,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -232753,7 +232805,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -232773,7 +232825,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -232887,7 +232939,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -232948,10 +233000,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -232991,7 +233043,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -233084,7 +233136,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -233149,7 +233201,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -233218,10 +233270,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -233261,7 +233313,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -233352,13 +233404,13 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -233398,7 +233450,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -233418,7 +233470,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -233532,7 +233584,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -233688,7 +233740,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -233711,7 +233763,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -233776,7 +233828,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -233932,7 +233984,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -233955,7 +234007,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -234033,7 +234085,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -234056,7 +234108,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -234109,13 +234161,13 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -234155,7 +234207,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -234208,13 +234260,13 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -234254,7 +234306,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -234319,7 +234371,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -234541,10 +234593,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -234584,7 +234636,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -234648,7 +234700,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -234857,7 +234909,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -234926,10 +234978,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -234969,7 +235021,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -235025,7 +235077,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -235234,7 +235286,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -235254,7 +235306,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -235277,7 +235329,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -235331,10 +235383,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -235354,7 +235406,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -235423,7 +235475,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -235446,7 +235498,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -236080,7 +236132,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -236103,7 +236155,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -236123,7 +236175,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -237309,7 +237361,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -237349,7 +237401,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -237405,7 +237457,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -237428,10 +237480,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -237497,7 +237549,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -237520,10 +237572,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -237583,6 +237635,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -237671,7 +237724,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -240083,7 +240136,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -240103,7 +240156,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -240154,7 +240207,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -240240,10 +240293,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -240283,7 +240336,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -240353,7 +240406,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -240416,7 +240469,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -240485,10 +240538,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -240528,7 +240581,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -240584,7 +240637,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -240647,7 +240700,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -240667,7 +240720,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -240690,7 +240743,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -240744,13 +240797,13 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -240790,7 +240843,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -240868,7 +240921,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -240885,11 +240938,21 @@ }, "state": { "type": "string", - "example": "active" + "description": "The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.", + "example": "active", + "enum": [ + "active", + "pending" + ] }, "role": { "type": "string", - "example": "admin" + "description": "The user's membership type in the organization.", + "example": "admin", + "enum": [ + "admin", + "member" + ] }, "organization_url": { "type": "string", @@ -241206,7 +241269,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -241229,7 +241292,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -241249,7 +241312,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -241353,7 +241416,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -241368,11 +241431,21 @@ }, "state": { "type": "string", - "example": "active" + "description": "The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.", + "example": "active", + "enum": [ + "active", + "pending" + ] }, "role": { "type": "string", - "example": "admin" + "description": "The user's membership type in the organization.", + "example": "admin", + "enum": [ + "admin", + "member" + ] }, "organization_url": { "type": "string", @@ -241658,7 +241731,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -241735,7 +241808,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -241750,11 +241823,21 @@ }, "state": { "type": "string", - "example": "active" + "description": "The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.", + "example": "active", + "enum": [ + "active", + "pending" + ] }, "role": { "type": "string", - "example": "admin" + "description": "The user's membership type in the organization.", + "example": "admin", + "enum": [ + "admin", + "member" + ] }, "organization_url": { "type": "string", @@ -242040,7 +242123,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -242060,7 +242143,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -242174,7 +242257,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -242285,7 +242368,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -242308,7 +242391,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -242381,7 +242464,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -242637,7 +242720,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -242660,7 +242743,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -242680,7 +242763,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -242702,7 +242785,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -242781,7 +242864,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -242842,10 +242925,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -242885,7 +242968,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -242931,7 +243014,7 @@ "parameters": [ { "name": "visibility", - "description": "Can be one of `all`, `public`, or `private`.", + "description": "Can be one of `all`, `public`, or `private`. Note: For GitHub AE, can be one of `all`, `internal`, or `private`.", "in": "query", "required": false, "schema": { @@ -242956,7 +243039,7 @@ }, { "name": "type", - "description": "Can be one of `all`, `owner`, `public`, `private`, `member`. Default: `all` \n \nWill cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.", + "description": "Can be one of `all`, `owner`, `public`, `private`, `member`. Note: For GitHub AE, can be one of `all`, `owner`, `internal`, `private`, `member`. Default: `all` \n \nWill cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.", "in": "query", "required": false, "schema": { @@ -243039,7 +243122,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -244110,7 +244193,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -244179,7 +244262,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -244202,7 +244285,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -244234,7 +244317,7 @@ }, "post": { "summary": "Create a repository for the authenticated user", - "description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.19/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", + "description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.19/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository.", "tags": [ "repos" ], @@ -244265,7 +244348,7 @@ "type": "string" }, "private": { - "description": "Whether the repository is private or public.", + "description": "Whether the repository is private.", "default": false, "type": "boolean" }, @@ -244353,7 +244436,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -245435,7 +245518,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -245455,10 +245538,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -245498,7 +245581,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -245675,7 +245758,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -247568,10 +247651,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -247611,7 +247694,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -247667,7 +247750,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -247710,7 +247793,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -247730,7 +247813,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -247767,7 +247850,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "409": { "description": "Conflict", @@ -247790,10 +247873,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -247906,7 +247989,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -250069,7 +250152,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -250092,7 +250175,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -250178,7 +250261,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -250198,7 +250281,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -250262,7 +250345,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -250285,7 +250368,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -250305,7 +250388,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -250325,7 +250408,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -250369,10 +250452,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -250392,7 +250475,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -250412,7 +250495,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -250480,7 +250563,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -252081,7 +252164,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -252104,7 +252187,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -252169,7 +252252,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -252651,10 +252734,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -252739,7 +252822,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -252895,7 +252978,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -252933,7 +253016,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -253472,7 +253555,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -253545,7 +253628,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -256257,7 +256340,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -258961,7 +259044,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -261665,7 +261748,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -261874,7 +261957,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -262141,7 +262224,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -262559,7 +262642,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -262681,7 +262764,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -262962,7 +263045,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -263009,7 +263092,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -263029,7 +263112,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -263143,7 +263226,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -263687,7 +263770,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -263785,7 +263868,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -263964,7 +264047,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -264233,7 +264316,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -264255,7 +264338,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -264381,7 +264464,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -267085,7 +267168,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -269750,7 +269833,7 @@ "/users/{username}/repos": { "get": { "summary": "List repositories for a user", - "description": "Lists public repositories for the specified user.", + "description": "Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user.", "tags": [ "repos" ], @@ -269833,7 +269916,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -271473,7 +271556,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -271509,7 +271592,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -271593,7 +271676,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -273809,7 +273892,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -275445,7 +275528,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "requestBody": { @@ -275496,7 +275579,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "requestBody": { @@ -275535,7 +275618,7 @@ "operationId": "meta/get-zen", "responses": { "200": { - "description": "response", + "description": "Response", "content": { "text/plain": { "schema": { diff --git a/lib/rest/static/dereferenced/ghes-2.20.deref.json b/lib/rest/static/dereferenced/ghes-2.20.deref.json index 9f3bd5a355..b9b0e3dc23 100644 --- a/lib/rest/static/dereferenced/ghes-2.20.deref.json +++ b/lib/rest/static/dereferenced/ghes-2.20.deref.json @@ -134,7 +134,7 @@ ], "servers": [ { - "url": "{protocol}://{hostname}", + "url": "{protocol}://{hostname}/api/v3", "variables": { "hostname": { "description": "Self-hosted Enterprise Server or Enterprise Cloud hostname", @@ -162,7 +162,7 @@ "operationId": "meta/root", "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -394,7 +394,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -529,7 +529,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -729,7 +729,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -859,7 +859,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -1040,7 +1040,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -1092,7 +1092,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -1140,11 +1140,48 @@ "type": "integer", "default": 1 } + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "accessed" + ], + "default": "created" + } + }, + { + "name": "since", + "description": "Only show public keys accessed after the given time.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -1242,7 +1279,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -1280,7 +1317,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -1403,7 +1440,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -1456,7 +1493,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -1603,7 +1640,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -1646,7 +1683,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -1811,7 +1848,7 @@ ], "responses": { "202": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -1895,11 +1932,39 @@ "type": "integer", "default": 1 } + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -2022,7 +2087,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -2163,7 +2228,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -2275,7 +2340,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -2452,7 +2517,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "422": { "description": "Client Errors", @@ -2540,7 +2605,7 @@ ], "responses": { "202": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -2661,7 +2726,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -2742,11 +2807,40 @@ "type": "integer", "default": 1 } + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "sort", + "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to) or `name`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -2903,7 +2997,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -3126,7 +3220,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -3288,7 +3382,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -3498,7 +3592,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -3550,7 +3644,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -4260,7 +4354,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -4288,7 +4382,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -4492,7 +4586,7 @@ ], "responses": { "202": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -4568,7 +4662,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -4606,7 +4700,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -5307,7 +5401,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -5338,7 +5432,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -5670,7 +5764,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -5996,7 +6090,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -6016,7 +6110,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -6651,7 +6745,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -7139,7 +7233,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -7159,7 +7253,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -7228,10 +7322,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -7586,7 +7680,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -8755,7 +8849,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -8777,7 +8871,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -8797,7 +8891,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -8817,7 +8911,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -8930,11 +9024,20 @@ "type": "integer", "default": 1 } + }, + { + "name": "client_id", + "in": "query", + "required": false, + "description": "The client ID of your GitHub app.", + "schema": { + "type": "string" + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -9152,7 +9255,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -9175,7 +9278,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -9195,7 +9298,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -9254,7 +9357,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -9459,7 +9562,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -9482,7 +9585,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -9539,10 +9642,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -9565,7 +9668,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -9642,10 +9745,10 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -9758,7 +9861,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -9818,7 +9921,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -10489,7 +10592,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -10558,7 +10661,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -10630,7 +10733,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -11301,7 +11404,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -11412,7 +11515,10 @@ "type": "string", "description": "The OAuth access token used to authenticate to the GitHub API." } - } + }, + "required": [ + "access_token" + ] }, "example": { "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a" @@ -11422,10 +11528,10 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -11538,7 +11644,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -12214,7 +12320,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -12279,7 +12385,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -12995,7 +13101,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -13036,7 +13142,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -13350,7 +13456,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -13370,7 +13476,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -13436,11 +13542,20 @@ "type": "integer", "default": 1 } + }, + { + "name": "client_id", + "in": "query", + "required": false, + "description": "The client ID of your GitHub app.", + "schema": { + "type": "string" + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -14115,7 +14230,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -14138,7 +14253,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -14158,7 +14273,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -14253,7 +14368,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -14911,7 +15026,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -15000,7 +15115,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -15023,7 +15138,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -16442,7 +16557,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -16511,7 +16626,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -16534,7 +16649,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -17957,7 +18072,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -18065,7 +18180,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -18715,7 +18830,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -18738,7 +18853,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -18845,7 +18960,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -19495,7 +19610,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -19601,10 +19716,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -19627,7 +19742,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -19678,7 +19793,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -19741,10 +19856,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -19805,7 +19920,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -19858,7 +19973,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -19878,10 +19993,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -19969,7 +20084,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -20019,7 +20134,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -20088,7 +20203,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -20128,7 +20243,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -20150,7 +20265,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -20215,10 +20330,10 @@ } } }, - "description": "response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -20246,7 +20361,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -20323,7 +20438,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -20592,7 +20707,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -23251,7 +23366,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -23274,7 +23389,7 @@ } }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -23323,7 +23438,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -23625,7 +23740,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -24043,7 +24158,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -24152,7 +24267,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -24385,7 +24500,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -24454,10 +24569,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -24551,7 +24666,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -24969,7 +25084,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -25038,7 +25153,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -25115,7 +25230,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -25533,7 +25648,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -25553,7 +25668,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -25612,7 +25727,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -25870,7 +25985,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -25890,7 +26005,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -25997,7 +26112,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -26222,7 +26337,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -26291,7 +26406,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -26345,10 +26460,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -26368,7 +26483,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -26445,7 +26560,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -26677,10 +26792,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -26774,7 +26889,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -27001,10 +27116,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -27089,7 +27204,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -27308,10 +27423,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -27427,7 +27542,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -27646,7 +27761,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -27709,13 +27824,13 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -27809,7 +27924,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -28022,7 +28137,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -28042,7 +28157,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -28119,7 +28234,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -28388,7 +28503,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -28408,7 +28523,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -28465,7 +28580,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -28878,7 +28993,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -28898,7 +29013,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -28967,7 +29082,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -29042,7 +29157,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -29099,10 +29214,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -29122,7 +29237,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -29179,13 +29294,13 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -29269,7 +29384,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -29494,7 +29609,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -29563,7 +29678,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -29631,7 +29746,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -29653,7 +29768,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -29691,7 +29806,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -29725,7 +29840,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -29783,7 +29898,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -30904,10 +31019,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -30964,7 +31079,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -31003,6 +31118,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -31123,7 +31239,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -33544,7 +33660,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -33613,10 +33729,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -33679,11 +33795,20 @@ "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", + "description": "Response", "content": { "application/json": { "schema": { @@ -33789,7 +33914,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -33827,7 +33952,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -33980,7 +34105,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -34000,7 +34125,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -34063,7 +34188,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "headers": { "Content-Type": { "example": "text/html", @@ -34093,7 +34218,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -34138,7 +34263,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "headers": { "X-CommonMarker-Version": { "example": "0.17.4", @@ -34156,7 +34281,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -34187,7 +34312,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -34220,7 +34345,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -34284,7 +34409,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -36943,7 +37068,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -36983,10 +37108,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "301": { - "description": "Moved Permanently" + "description": "Moved permanently" } }, "x-github": { @@ -37072,7 +37197,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -38719,7 +38844,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -38742,7 +38867,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -38762,7 +38887,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -38877,7 +39002,7 @@ }, "responses": { "202": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -38892,10 +39017,10 @@ } }, "205": { - "description": "response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -38918,7 +39043,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -38974,7 +39099,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -40608,7 +40733,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -40631,7 +40756,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -40685,10 +40810,10 @@ ], "responses": { "205": { - "description": "response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -40747,7 +40872,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -40812,7 +40937,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -40835,7 +40960,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -40905,7 +41030,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -40970,7 +41095,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -40993,7 +41118,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -41047,10 +41172,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -41073,7 +41198,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -41125,7 +41250,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/octocat-stream": { "schema": { @@ -41179,7 +41304,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -41290,7 +41415,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -41328,7 +41453,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -41608,7 +41733,9 @@ "plan": { "name": "Medium", "space": 400, - "private_repos": 20 + "private_repos": 20, + "filled_seats": 4, + "seats": 5 }, "default_repository_permission": "read", "members_can_create_repositories": true, @@ -41619,54 +41746,13 @@ "members_can_create_internal_repositories": false, "members_can_create_pages": true } - }, - "response-with-git-hub-plan-information": { - "summary": "Response with GitHub plan information", - "value": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization", - "name": "github", - "company": "GitHub", - "blog": "https://github.com/blog", - "location": "San Francisco", - "email": "octocat@github.com", - "twitter_username": "github", - "is_verified": true, - "has_organization_projects": true, - "has_repository_projects": true, - "public_repos": 2, - "public_gists": 1, - "followers": 20, - "following": 0, - "html_url": "https://github.com/octocat", - "created_at": "2008-01-14T04:33:35Z", - "updated_at": "2014-03-03T18:58:10Z", - "type": "Organization", - "plan": { - "name": "team", - "space": 976562499, - "private_repos": 999999, - "filled_seats": 4, - "seats": 5 - } - } } } } } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -41823,7 +41909,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -42117,7 +42203,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -42233,7 +42319,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -42312,7 +42398,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -45024,7 +45110,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -45151,7 +45237,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -45288,7 +45374,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -45410,7 +45496,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -45479,7 +45565,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -45542,7 +45628,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -45656,7 +45742,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -45783,7 +45869,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -45896,7 +45982,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -45965,7 +46051,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -46026,10 +46112,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -46092,10 +46178,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -46160,7 +46246,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -46714,7 +46800,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -47278,6 +47364,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -47366,7 +47453,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -49787,7 +49874,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -49892,7 +49979,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -50059,7 +50146,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -50229,7 +50316,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -50266,7 +50353,7 @@ "/orgs/{org}/memberships/{username}": { "get": { "summary": "Get organization membership for a user", - "description": "In order to get a user's membership with an organization, the authenticated user must be an organization member.", + "description": "In order to get a user's membership with an organization, the authenticated user must be an organization member. The `state` parameter in the response can be used to identify the user's membership status.", "tags": [ "orgs" ], @@ -50295,7 +50382,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -50310,11 +50397,21 @@ }, "state": { "type": "string", - "example": "active" + "description": "The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.", + "example": "active", + "enum": [ + "active", + "pending" + ] }, "role": { "type": "string", - "example": "admin" + "description": "The user's membership type in the organization.", + "example": "admin", + "enum": [ + "admin", + "member" + ] }, "organization_url": { "type": "string", @@ -50575,99 +50672,13 @@ "site_admin": false } } - }, - "response-if-user-has-an-active-membership-with-organization": { - "summary": "Response if user has an active membership with organization", - "value": { - "url": "https://api.github.com/orgs/octocat/memberships/defunkt", - "state": "active", - "role": "member", - "organization_url": "https://api.github.com/orgs/octocat", - "organization": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization" - }, - "user": { - "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 - } - } - }, - "response-if-user-has-a-pending-membership-with-organization": { - "summary": "Response if user has a pending membership with organization", - "value": { - "url": "https://api.github.com/orgs/invitocat/memberships/defunkt", - "state": "pending", - "role": "member", - "organization_url": "https://api.github.com/orgs/invitocat", - "organization": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization" - }, - "user": { - "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 - } - } } } } } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -50768,7 +50779,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -50783,11 +50794,21 @@ }, "state": { "type": "string", - "example": "active" + "description": "The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.", + "example": "active", + "enum": [ + "active", + "pending" + ] }, "role": { "type": "string", - "example": "admin" + "description": "The user's membership type in the organization.", + "example": "admin", + "enum": [ + "admin", + "member" + ] }, "organization_url": { "type": "string", @@ -51006,51 +51027,8 @@ ] }, "examples": { - "response-if-user-was-previously-unaffiliated-with-organization": { - "summary": "Response if user was previously unaffiliated with organization", - "value": { - "url": "https://api.github.com/orgs/invitocat/memberships/defunkt", - "state": "pending", - "role": "admin", - "organization_url": "https://api.github.com/orgs/invitocat", - "organization": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization" - }, - "user": { - "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 - } - } - }, "response-if-user-already-had-membership-with-organization": { - "summary": "Response if user already had membership with organization", + "summary": "Response if user has an active admin membership with organization", "value": { "url": "https://api.github.com/orgs/octocat/memberships/defunkt", "state": "active", @@ -51097,7 +51075,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -51227,7 +51205,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -51250,7 +51228,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -51337,7 +51315,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -51542,41 +51520,10 @@ "description": "User was converted" }, "403": { - "description": "response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - }, - "examples": { - "response-if-user-is-the-last-owner-of-the-organization": { - "summary": "Response if user is the last owner of the organization", - "value": { - "message": "Cannot convert the last owner to an outside collaborator", - "documentation_url": "https://docs.github.com/enterprise-server@2.20/rest/reference/orgs#convert-member-to-outside-collaborator" - } - }, - "response-if-user-is-not-a-member-of-the-organization": { - "summary": "Response if user is not a member of the organization", - "value": { - "message": " is not a member of the organization.", - "documentation_url": "https://docs.github.com/enterprise-server@2.20/rest/reference/orgs#convert-member-to-outside-collaborator" - } - } - } - } - } + "description": "Response if user is the last owner of the organization or not a member of the organization" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -51637,7 +51584,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "422": { "description": "Response if user is a member of the organization", @@ -51715,11 +51662,40 @@ "type": "integer", "default": 1 } + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "sort", + "description": "The sort order for the response collection.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -51809,7 +51785,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -51892,7 +51868,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -51998,7 +51974,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -52108,7 +52084,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -52377,7 +52353,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -52470,7 +52446,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -52726,7 +52702,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -52766,7 +52742,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -52806,7 +52782,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -52893,7 +52869,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -53139,7 +53115,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -53203,7 +53179,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -53240,7 +53216,7 @@ }, { "name": "type", - "description": "Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`.", + "description": "Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Note: For GitHub AE, can be one of `all`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`.", "in": "query", "required": false, "schema": { @@ -53306,7 +53282,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -54940,7 +54916,7 @@ }, "post": { "summary": "Create an organization repository", - "description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.20/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", + "description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.20/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository", "tags": [ "repos" ], @@ -54979,12 +54955,12 @@ }, "private": { "type": "boolean", - "description": "Either `true` to create a private repository or `false` to create a public one.", + "description": "Whether the repository is private.", "default": false }, "visibility": { "type": "string", - "description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", + "description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", "enum": [ "public", "private", @@ -55068,7 +55044,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -56179,7 +56155,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -56310,7 +56286,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -56606,7 +56582,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -57087,7 +57063,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -57220,7 +57196,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -57701,7 +57677,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -57757,7 +57733,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -57984,7 +57960,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -58007,7 +57983,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -58027,7 +58003,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -58107,7 +58083,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -58334,7 +58310,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -58357,7 +58333,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -58377,7 +58353,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -58397,7 +58373,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -58465,10 +58441,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -58495,7 +58471,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -58515,7 +58491,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -58600,7 +58576,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -58613,7 +58589,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -58654,7 +58630,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -58674,7 +58650,7 @@ } }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -58709,7 +58685,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -58818,7 +58794,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -58895,7 +58871,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -58918,7 +58894,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -58938,7 +58914,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -59015,7 +58991,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -59092,7 +59068,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -59115,7 +59091,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -59173,10 +59149,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -59199,7 +59175,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -59292,7 +59268,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -59532,7 +59508,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -59555,7 +59531,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -59656,7 +59632,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -59883,7 +59859,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -59906,7 +59882,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -59926,7 +59902,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -60022,7 +59998,7 @@ } }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -60117,7 +60093,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -60130,7 +60106,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -60153,7 +60129,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -60183,7 +60159,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -60242,7 +60218,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -60498,7 +60474,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -60521,7 +60497,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -60619,7 +60595,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -60878,7 +60854,7 @@ "description": "Response if the authenticated user does not have access to the project" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -60905,7 +60881,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -60945,7 +60921,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -61015,7 +60991,7 @@ "description": "Delete Success" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -61042,7 +61018,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -61082,7 +61058,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -61174,7 +61150,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -61330,7 +61306,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -61350,7 +61326,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -61372,7 +61348,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -61441,7 +61417,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -61464,7 +61440,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -61553,10 +61529,10 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -61576,7 +61552,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -61598,7 +61574,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -61667,7 +61643,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -61690,7 +61666,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -61755,13 +61731,13 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -61781,7 +61757,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -61823,7 +61799,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -61892,7 +61868,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -61959,7 +61935,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -62124,7 +62100,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -62144,7 +62120,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -62166,7 +62142,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -62235,7 +62211,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -62258,7 +62234,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -62335,7 +62311,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -62425,7 +62401,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -62448,7 +62424,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -62524,7 +62500,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -62597,7 +62573,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -62620,7 +62596,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -62650,7 +62626,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -62702,7 +62678,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -62928,10 +62904,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -62996,7 +62972,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -63044,7 +63020,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -67713,7 +67689,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -67733,7 +67709,7 @@ } }, "301": { - "description": "Moved Permanently" + "description": "Moved permanently" } }, "x-github": { @@ -67882,7 +67858,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -72043,7 +72019,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -72112,7 +72088,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -72182,7 +72158,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "If an organization owner has configured the organization to prevent members from deleting organization-owned repositories, a member will get this response:", @@ -72207,7 +72183,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -72288,7 +72264,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -72444,7 +72420,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -72608,7 +72584,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -73334,18 +73310,6 @@ }, "examples": { "default": { - "value": [ - { - "name": "master", - "commit": { - "sha": "c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc", - "url": "https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc" - }, - "protected": true - } - ] - }, - "with-protection": { "value": [ { "name": "master", @@ -73381,7 +73345,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -73454,7 +73418,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -74772,7 +74736,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -74794,7 +74758,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -74867,7 +74831,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -75713,7 +75677,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -75952,7 +75916,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -76683,7 +76647,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -76705,7 +76669,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -76735,7 +76699,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -76810,7 +76774,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -76886,7 +76850,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -76972,7 +76936,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -77061,7 +77025,7 @@ "description": "No Content" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -77134,7 +77098,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/vnd.github.luke-cage-preview+json": { "schema": { @@ -77613,7 +77577,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -77981,7 +77945,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -78108,7 +78072,7 @@ "description": "No Content" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -78181,7 +78145,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -78216,7 +78180,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -78291,7 +78255,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -78326,7 +78290,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -78404,7 +78368,7 @@ "description": "No Content" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -78481,7 +78445,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -78536,7 +78500,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -78635,7 +78599,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -78690,7 +78654,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -78710,7 +78674,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -78886,7 +78850,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -78902,7 +78866,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -78999,7 +78963,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -79016,7 +78980,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -79105,7 +79069,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -79203,7 +79167,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -79219,7 +79183,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -79288,7 +79252,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -79386,7 +79350,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -79402,7 +79366,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -79422,7 +79386,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -79545,7 +79509,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -79916,7 +79880,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -80043,7 +80007,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -80342,7 +80306,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -80439,7 +80403,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -80738,7 +80702,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -80885,7 +80849,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -81184,7 +81148,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -81331,7 +81295,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -81630,7 +81594,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -81753,7 +81717,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -81924,7 +81888,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -82021,7 +81985,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -82192,7 +82156,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -82339,7 +82303,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -82510,7 +82474,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -82657,7 +82621,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -82828,7 +82792,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -82951,7 +82915,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -83099,7 +83063,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -83196,7 +83160,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -83344,7 +83308,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -83491,7 +83455,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -83639,7 +83603,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -83786,7 +83750,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -83934,7 +83898,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -84241,7 +84205,7 @@ "name", "head_sha" ], - "anyOf": [ + "oneOf": [ { "properties": { "status": { @@ -84251,6 +84215,7 @@ } }, "required": [ + "status", "conclusion" ], "additionalProperties": true @@ -84270,7 +84235,7 @@ }, "examples": { "example-of-in-progress-conclusion": { - "summary": "Example of in_progress conclusion", + "summary": "Response for in_progress conclusion", "value": { "name": "mighty_readme", "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -84285,7 +84250,7 @@ } }, "example-of-completed-conclusion": { - "summary": "Example of completed conclusion", + "summary": "Response for completed conclusion", "value": { "name": "mighty_readme", "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -84339,7 +84304,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -85155,101 +85120,8 @@ ] }, "examples": { - "example-of-in-progress-conclusion": { - "summary": "Example of in_progress conclusion", - "value": { - "id": 4, - "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", - "node_id": "MDg6Q2hlY2tSdW40", - "external_id": "42", - "url": "https://api.github.com/repos/github/hello-world/check-runs/4", - "html_url": "https://github.com/github/hello-world/runs/4", - "details_url": "https://example.com", - "status": "in_progress", - "conclusion": "neutral", - "started_at": "2018-05-04T01:14:52Z", - "completed_at": null, - "output": { - "title": "Mighty Readme Report", - "summary": "", - "text": "", - "annotations_count": 1, - "annotations_url": "https://api.github.com/repos/github/hello-world/check-runs/4/annotations" - }, - "name": "mighty_readme", - "check_suite": { - "id": 5 - }, - "app": { - "id": 1, - "slug": "octoapp", - "node_id": "MDExOkludGVncmF0aW9uMQ==", - "owner": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "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", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": true - }, - "name": "Octocat App", - "description": "", - "external_url": "https://example.com", - "html_url": "https://github.com/apps/octoapp", - "created_at": "2017-07-08T16:18:44-04:00", - "updated_at": "2017-07-08T16:18:44-04:00", - "permissions": { - "metadata": "read", - "contents": "read", - "issues": "write", - "single_file": "write" - }, - "events": [ - "push", - "pull_request" - ] - }, - "pull_requests": [ - { - "url": "https://api.github.com/repos/github/hello-world/pulls/1", - "id": 1934, - "number": 3956, - "head": { - "ref": "say-hello", - "sha": "3dca65fa3e8d4b3da3f3d056c59aee1c50f41390", - "repo": { - "id": 526, - "url": "https://api.github.com/repos/github/hello-world", - "name": "hello-world" - } - }, - "base": { - "ref": "master", - "sha": "e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f", - "repo": { - "id": 526, - "url": "https://api.github.com/repos/github/hello-world", - "name": "hello-world" - } - } - } - ] - } - }, "example-of-completed-conclusion": { - "summary": "Example of completed conclusion", + "summary": "Response for completed conclusion", "value": { "id": 4, "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -85402,7 +85274,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -86623,7 +86495,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -87610,7 +87482,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -87778,7 +87650,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -90153,7 +90025,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -91340,7 +91212,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -93738,7 +93610,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -94735,7 +94607,7 @@ ], "responses": { "201": { - "description": "response" + "description": "Response" } }, "x-github": { @@ -94818,7 +94690,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -94993,7 +94865,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -97040,7 +96912,7 @@ "description": "Response when person is already a collaborator" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -97179,7 +97051,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -97398,7 +97270,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -97479,7 +97351,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -97837,7 +97709,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -98126,7 +97998,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -98221,7 +98093,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -98510,7 +98382,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -98580,10 +98452,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -98692,7 +98564,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -98901,7 +98773,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -98921,7 +98793,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -99420,7 +99292,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -99442,7 +99314,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -99617,11 +99489,31 @@ "type": "integer", "default": 1 } + }, + { + "name": "top", + "description": "legacy parameter for pagination.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "last_sha", + "description": "legacy parameter for pagination.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -100274,7 +100166,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -100367,7 +100259,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -100424,7 +100316,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -100446,7 +100338,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -100590,7 +100482,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -100983,7 +100875,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -101300,7 +101192,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -101441,7 +101333,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -105230,7 +105122,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -105296,9 +105188,27 @@ "type": "string" } }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -105309,7 +105219,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -105892,7 +105802,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -105961,7 +105871,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -106043,7 +105953,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -106105,11 +106015,19 @@ "type": "integer", "default": 1 } + }, + { + "name": "app_id", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -107096,7 +107014,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -107144,7 +107062,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -109365,18 +109283,36 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true + }, + { + "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", + "description": "Response", "content": { "application/json": { "schema": { @@ -111059,7 +110995,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -111121,7 +111057,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -111150,7 +111086,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -111369,7 +111305,7 @@ } }, "301": { - "description": "Moved Permanently" + "description": "Moved permanently" } }, "x-github": { @@ -111431,7 +111367,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -113294,7 +113230,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -113356,7 +113292,7 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { @@ -113376,7 +113312,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/vnd.github.v3.object": { "schema": { @@ -113988,7 +113924,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -114071,7 +114007,7 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { @@ -114182,7 +114118,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -114398,7 +114334,7 @@ } }, "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -114614,7 +114550,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -114634,7 +114570,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -114763,7 +114699,7 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { @@ -114837,7 +114773,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -115038,7 +114974,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -115107,7 +115043,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -115147,7 +115083,7 @@ } }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -115389,7 +115325,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -115486,7 +115422,8 @@ "required": false, "schema": { "type": "string", - "default": "none" + "default": "none", + "nullable": true } }, { @@ -115510,7 +115447,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -116177,7 +116114,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -116686,48 +116623,6 @@ "transient_environment": false, "production_environment": true } - }, - "advanced-example": { - "summary": "Advanced example", - "value": { - "url": "https://api.github.com/repos/octocat/example/deployments/1", - "id": 1, - "node_id": "MDEwOkRlcGxveW1lbnQx", - "sha": "a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d", - "ref": "topic-branch", - "task": "deploy", - "payload": { - }, - "original_environment": "staging", - "environment": "production", - "description": "Deploy request from hubot", - "creator": { - "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 - }, - "created_at": "2012-07-20T01:19:13Z", - "updated_at": "2012-07-20T01:19:13Z", - "statuses_url": "https://api.github.com/repos/octocat/example/deployments/1/statuses", - "repository_url": "https://api.github.com/repos/octocat/example", - "transient_environment": false, - "production_environment": true - } } } } @@ -116756,40 +116651,10 @@ } }, "409": { - "description": "response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string", - "example": "\"https://docs.github.com/enterprise-server@2.20/rest/reference/repos#create-a-deployment\"" - } - } - }, - "examples": { - "merge-conflict-response": { - "summary": "Merge conflict response", - "value": { - "message": "Conflict merging master into topic-branch" - } - }, - "failed-commit-status-checks": { - "summary": "Failed commit status checks", - "value": { - "message": "Conflict: Commit status checks failed for topic-branch." - } - } - } - } - } + "description": "Response when there is a merge conflict or the commit's status checks failed" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -116914,7 +116779,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -117428,7 +117293,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -117527,7 +117392,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -118051,7 +117916,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -118196,7 +118061,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -118715,7 +118580,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -118853,7 +118718,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -119364,7 +119229,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -119384,7 +119249,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -119481,7 +119346,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -122190,7 +122055,8 @@ "enum": [ "newest", "oldest", - "stargazers" + "stargazers", + "watchers" ], "default": "newest" } @@ -122212,11 +122078,31 @@ "type": "integer", "default": 1 } + }, + { + "name": "org", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "organization", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -123920,6 +123806,26 @@ "schema": { "type": "string" } + }, + { + "name": "org", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "organization", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } } ], "requestBody": { @@ -123927,6 +123833,7 @@ "application/json": { "schema": { "type": "object", + "nullable": true, "properties": { "organization": { "type": "string", @@ -123939,7 +123846,7 @@ }, "responses": { "202": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -125076,7 +124983,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -125165,7 +125072,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -125255,7 +125162,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -125295,7 +125202,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -125355,7 +125262,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -125475,7 +125382,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -125532,7 +125439,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -125552,7 +125459,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -125767,7 +125674,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -125983,7 +125890,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -126052,7 +125959,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -126125,7 +126032,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -126333,7 +126240,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -126395,7 +126302,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -126424,7 +126331,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -126557,7 +126464,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -126568,7 +126475,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -126636,7 +126543,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -126730,7 +126637,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -126806,7 +126713,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -126917,7 +126824,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -126955,7 +126862,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -127023,7 +126930,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -127132,7 +127039,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -127143,10 +127050,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -127325,7 +127232,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -127472,7 +127379,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -127592,7 +127499,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -127731,7 +127638,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -127865,7 +127772,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -127993,7 +127900,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -128062,7 +127969,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -128148,7 +128055,8 @@ "required": true, "schema": { "type": "string" - } + }, + "x-multi-segment": true }, { "name": "recursive", @@ -128162,7 +128070,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -128316,7 +128224,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -128385,7 +128293,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -128466,7 +128374,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -128663,7 +128571,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -128808,7 +128716,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -129000,7 +128908,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -129020,7 +128928,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -129160,7 +129068,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -129344,7 +129252,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -129497,7 +129405,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -129681,7 +129589,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -129750,7 +129658,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -129819,10 +129727,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -129893,10 +129801,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -129967,10 +129875,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -130043,7 +129951,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -130531,10 +130439,10 @@ } }, "301": { - "description": "Moved Permanently" + "description": "Moved permanently" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -130618,7 +130526,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -132596,7 +132504,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -134538,7 +134446,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -134700,7 +134608,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -136861,10 +136769,10 @@ } }, "301": { - "description": "Moved Permanently" + "description": "Moved permanently" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -136933,7 +136841,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -137091,7 +136999,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -139438,7 +139346,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -139507,7 +139415,7 @@ } }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -139528,7 +139436,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -139666,7 +139574,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -140211,7 +140119,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -140280,7 +140188,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -140356,7 +140264,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -140888,7 +140796,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -140983,7 +140891,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -141515,7 +141423,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -141634,7 +141542,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -141726,7 +141634,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -141935,7 +141843,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -141955,7 +141863,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -142454,7 +142362,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -142476,7 +142384,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -142610,7 +142518,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -145703,7 +145611,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -145832,7 +145740,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -148912,7 +148820,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -149038,7 +148946,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -151357,10 +151265,10 @@ } }, "301": { - "description": "Moved Permanently" + "description": "Moved permanently" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -151400,7 +151308,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -151559,7 +151467,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -153878,7 +153786,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -153947,7 +153855,7 @@ } }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -153988,10 +153896,10 @@ } }, "301": { - "description": "Moved Permanently" + "description": "Moved permanently" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -154107,7 +154015,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -156369,7 +156277,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -158636,7 +158544,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -159181,7 +159089,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -159296,7 +159204,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -159876,7 +159784,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -159945,7 +159853,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -160036,7 +159944,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -160394,7 +160302,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -160582,7 +160490,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -160685,7 +160593,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -160828,7 +160736,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -160931,7 +160839,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -161050,7 +160958,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "410": { "description": "Gone", @@ -161133,7 +161041,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -161207,7 +161115,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -161321,7 +161229,7 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -161364,7 +161272,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -161384,7 +161292,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -161506,7 +161414,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -161529,7 +161437,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -161638,7 +161546,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -161847,7 +161755,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -161887,7 +161795,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -161994,7 +161902,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -162190,7 +162098,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -162212,7 +162120,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -162355,7 +162263,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -162614,7 +162522,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -162654,7 +162562,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -162746,7 +162654,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -162888,7 +162796,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -162953,7 +162861,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -163074,7 +162982,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -163131,7 +163039,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -163201,7 +163109,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -163265,7 +163173,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -163356,7 +163264,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -163448,7 +163356,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -163525,7 +163433,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -163594,7 +163502,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -163665,7 +163573,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -163734,7 +163642,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -163831,7 +163739,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -163949,7 +163857,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -163995,7 +163903,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -164061,7 +163969,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -164887,63 +164795,10 @@ } }, "404": { - "description": "response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string", - "example": "\"https://docs.github.com/enterprise-server@2.20/rest/reference/repos#perform-a-merge\"" - } - } - }, - "examples": { - "missing-base-response": { - "summary": "Missing base response", - "value": { - "message": "Base does not exist" - } - }, - "missing-head-response": { - "summary": "Missing head response", - "value": { - "message": "Head does not exist" - } - } - } - } - } + "description": "Response when the base or head does not exist" }, "409": { - "description": "Merge conflict response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string", - "example": "\"https://docs.github.com/enterprise-server@2.20/rest/reference/repos#perform-a-merge\"" - } - } - }, - "examples": { - "merge-conflict-response": { - "value": { - "message": "Merge Conflict" - } - } - } - } - } + "description": "Response when there is a merge conflict" }, "403": { "description": "Forbidden", @@ -164966,7 +164821,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -165139,7 +164994,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -165420,7 +165275,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -165522,7 +165377,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -165798,7 +165653,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -165818,7 +165673,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -165939,7 +165794,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -166207,7 +166062,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -166315,7 +166170,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -166633,10 +166488,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -166726,7 +166581,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -166916,7 +166771,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -168619,7 +168474,7 @@ }, "responses": { "202": { - "description": "response" + "description": "Response" } }, "x-github": { @@ -168665,7 +168520,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -168758,7 +168613,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -168866,7 +168721,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -168959,7 +168814,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -169028,7 +168883,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -169175,10 +169030,10 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -169342,10 +169197,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -169414,7 +169269,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -169436,7 +169291,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -169521,7 +169376,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -169784,7 +169639,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -169862,7 +169717,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -170122,7 +169977,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -170388,11 +170243,39 @@ "type": "integer", "default": 1 } + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -170486,7 +170369,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -170573,7 +170456,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -170792,7 +170675,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -171061,7 +170944,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -171101,7 +170984,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -171141,7 +171024,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -171242,7 +171125,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -171498,7 +171381,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -171538,7 +171421,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -171578,7 +171461,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -171735,7 +171618,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -175524,10 +175407,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -175694,7 +175577,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -178723,7 +178606,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -178843,16 +178726,15 @@ }, { "name": "sort", - "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to).", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "created", - "updated" - ], - "default": "created" + "updated", + "created_at" + ] } }, { @@ -178898,7 +178780,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -179424,7 +179306,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -179876,7 +179758,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -179976,7 +179858,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -180482,10 +180364,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -180594,7 +180476,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -180803,7 +180685,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -180823,7 +180705,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -181322,7 +181204,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -181344,7 +181226,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -184469,7 +184351,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "500": { "description": "Internal Error", @@ -184492,7 +184374,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -184602,7 +184484,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -187603,7 +187485,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -187805,7 +187687,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -188411,7 +188293,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -188871,7 +188753,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -189046,7 +188928,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -189506,7 +189388,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -189596,7 +189478,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -190244,7 +190126,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -190345,7 +190227,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -190659,7 +190541,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -190748,7 +190630,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -190838,7 +190720,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -191199,7 +191081,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -195143,10 +195025,10 @@ }, "responses": { "200": { - "description": "response" + "description": "Response" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -195703,7 +195585,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -195979,7 +195861,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -196090,7 +195972,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -196366,7 +196248,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -196465,7 +196347,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -196741,7 +196623,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -196829,7 +196711,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -197105,7 +196987,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -197135,7 +197017,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -197233,7 +197115,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -197634,7 +197516,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -197736,7 +197618,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -198012,7 +197894,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -198032,7 +197914,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -198149,7 +198031,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -198425,7 +198307,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -198445,7 +198327,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -198565,7 +198447,7 @@ }, "responses": { "202": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -198587,7 +198469,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -198676,7 +198558,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -198752,6 +198634,279 @@ } } ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Content File", + "description": "Content File", + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "encoding": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "path": { + "type": "string" + }, + "content": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "git_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "download_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "_links": { + "type": "object", + "properties": { + "git": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html": { + "type": "string", + "format": "uri", + "nullable": true + }, + "self": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "git", + "html", + "self" + ] + }, + "target": { + "type": "string", + "example": "\"actual/actual.md\"" + }, + "submodule_git_url": { + "type": "string", + "example": "\"git://example.com/defunkt/dotjs.git\"" + } + }, + "required": [ + "_links", + "git_url", + "html_url", + "download_url", + "name", + "path", + "sha", + "size", + "type", + "url", + "content", + "encoding" + ] + }, + "examples": { + "default": { + "value": { + "type": "file", + "encoding": "base64", + "size": 5362, + "name": "README.md", + "path": "README.md", + "content": "encoded content ...", + "sha": "3d21ec53a331a6f037a91c368710b99387d012c1", + "url": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md", + "git_url": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1", + "html_url": "https://github.com/octokit/octokit.rb/blob/master/README.md", + "download_url": "https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md", + "_links": { + "git": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1", + "self": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md", + "html": "https://github.com/octokit/octokit.rb/blob/master/README.md" + } + } + } + } + } + } + }, + "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" + } + } + } + } + } + }, + "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" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "repos", + "subcategory": "contents" + } + } + }, + "/repos/{owner}/{repo}/readme/{dir}": { + "get": { + "summary": "Get a repository README", + "description": "Gets the preferred README for a repository.\n\nREADMEs support [custom media types](https://docs.github.com/enterprise-server@2.20/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML.", + "tags": [ + "repos" + ], + "operationId": "repos/get-readme-from-alt-path", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@2.20/rest/reference/repos#get-a-repository-readme" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "dir", + "description": "The alternate path to look for a README file", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + }, + { + "name": "ref", + "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], "responses": { "200": { "description": "response", @@ -198876,7 +199031,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -198896,7 +199051,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -199026,7 +199181,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -199526,7 +199681,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -199635,7 +199790,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -200130,7 +200285,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -200484,7 +200639,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -200504,7 +200659,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -200606,7 +200761,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -200888,7 +201043,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -200934,7 +201089,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -201463,7 +201618,7 @@ }, { "name": "tag", - "description": "tag+ parameter", + "description": "tag parameter", "in": "path", "required": true, "schema": { @@ -201474,7 +201629,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -201961,7 +202116,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -202520,7 +202675,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -202633,7 +202788,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -203170,7 +203325,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -203243,7 +203398,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -203866,7 +204021,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -204190,7 +204345,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -204374,7 +204529,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -204875,7 +205030,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -205072,7 +205227,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -205347,7 +205502,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -205691,7 +205846,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -205794,7 +205949,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -205858,7 +206013,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -205990,7 +206145,7 @@ ], "responses": { "302": { - "description": "response", + "description": "Response", "headers": { "Location": { "example": "https://codeload.github.com/me/myprivate/legacy.zip/master?login=me&token=thistokenexpires", @@ -206062,7 +206217,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -206280,11 +206435,29 @@ "schema": { "type": "string" } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -206319,7 +206492,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -206341,7 +206514,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -206435,7 +206608,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -206470,7 +206643,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -206492,7 +206665,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -206512,7 +206685,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -206621,7 +206794,7 @@ }, "responses": { "202": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -207747,7 +207920,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -207795,7 +207968,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -207853,7 +208026,7 @@ ], "responses": { "302": { - "description": "response", + "description": "Response", "headers": { "Location": { "example": "https://codeload.github.com/me/myprivate/legacy.zip/master?login=me&token=thistokenexpires", @@ -207878,7 +208051,7 @@ "/repos/{template_owner}/{template_repo}/generate": { "post": { "summary": "Create a repository using a template", - "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@2.20/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.20/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", + "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@2.20/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.20/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository", "tags": [ "repos" ], @@ -207950,7 +208123,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -209058,7 +209231,7 @@ "/repositories": { "get": { "summary": "List public repositories", - "description": "Lists all public repositories in the order that they were created.\n\nNote: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@2.20/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.", + "description": "Lists all public repositories in the order that they were created.\n\nNotes:\n- For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise.\n- Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@2.20/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.", "tags": [ "repos" ], @@ -209079,7 +209252,7 @@ }, { "name": "visibility", - "description": "Specifies the types of repositories to return. Can be one of `all` or `public`. Default: `public`.", + "description": "Specifies the types of repositories to return. Can be one of `all` or `public`. Default: `public`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise.", "in": "query", "required": false, "schema": { @@ -209095,7 +209268,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -210663,7 +210836,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -210732,7 +210905,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -210815,7 +210988,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -212503,10 +212676,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -212527,7 +212700,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -212697,7 +212870,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -214678,10 +214851,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -214797,7 +214970,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -216934,7 +217107,7 @@ } }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -216955,7 +217128,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -217024,7 +217197,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -217119,7 +217292,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -217257,10 +217430,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -217300,7 +217473,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -217452,7 +217625,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -218161,7 +218334,7 @@ } }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -218182,7 +218355,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -218251,7 +218424,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -218294,7 +218467,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -218568,10 +218741,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -218679,7 +218852,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -218923,10 +219096,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -218947,7 +219120,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -219041,7 +219214,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -219128,7 +219301,7 @@ }, "responses": { "202": { - "description": "response" + "description": "Response" } }, "x-github": { @@ -219156,7 +219329,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -219237,7 +219410,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -219338,7 +219511,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -219947,7 +220120,7 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "requestBody": { @@ -219993,7 +220166,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -220051,7 +220224,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -220131,7 +220304,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -220209,7 +220382,7 @@ }, "responses": { "202": { - "description": "response" + "description": "Response" } }, "requestBody": { @@ -220263,7 +220436,7 @@ }, "responses": { "202": { - "description": "response" + "description": "Response" } }, "requestBody": { @@ -220316,7 +220489,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -220829,7 +221002,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -221389,7 +221562,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -221458,7 +221631,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -221837,7 +222010,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -222246,7 +222419,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -222620,7 +222793,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -223016,7 +223189,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -223094,7 +223267,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -223447,7 +223620,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -223819,7 +223992,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -224167,7 +224340,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -224536,7 +224709,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -224637,7 +224810,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -224907,7 +225080,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -225226,7 +225399,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -225488,7 +225661,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -225785,7 +225958,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -226034,74 +226207,13 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { "description": "Response if team synchronization is set up" }, "422": { - "description": "response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "field": { - "type": "string" - }, - "resource": { - "type": "string" - } - } - } - }, - "documentation_url": { - "type": "string", - "example": "\"https://docs.github.com/enterprise-server@2.20/rest\"" - } - } - }, - "examples": { - "response-if-you-attempt-to-add-an-organization-to-a-team": { - "summary": "Response if you attempt to add an organization to a team", - "value": { - "message": "Cannot add an organization as a member.", - "errors": [ - { - "code": "org", - "field": "user", - "resource": "TeamMember" - } - ] - } - }, - "response-if-you-attempt-to-add-a-user-to-a-team-when-they-are-not-a-member-of-at-least-one-other-team-in-the-same-organization": { - "summary": "Response if you attempt to add a user to a team when they are not a member of at least one other team in the same organization", - "value": { - "message": "User isn't a member of this organization. Please invite them first.", - "errors": [ - { - "code": "unaffiliated", - "field": "user", - "resource": "TeamMember" - } - ] - } - } - } - } - } + "description": "Response if you attempt to add an organization to a team or you attempt to add a user to a team when they are not a member of at least one other team in the same organization" }, "403": { "description": "Forbidden", @@ -226168,7 +226280,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { "description": "Response if team synchronization is setup" @@ -226220,7 +226332,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -226243,7 +226355,12 @@ "type": "string" }, "state": { - "type": "string" + "description": "The state of the user's membership in the team.", + "type": "string", + "enum": [ + "active", + "pending" + ] } }, "required": [ @@ -226253,14 +226370,6 @@ ] }, "examples": { - "response-if-user-has-an-active-membership-with-team": { - "summary": "Response if user has an active membership with team", - "value": { - "url": "https://api.github.com/teams/1/memberships/octocat", - "role": "member", - "state": "active" - } - }, "response-if-user-is-a-team-maintainer": { "summary": "Response if user is a team maintainer", "value": { @@ -226268,14 +226377,6 @@ "role": "maintainer", "state": "active" } - }, - "response-if-user-has-a-pending-membership-with-team": { - "summary": "Response if user has a pending membership with team", - "value": { - "url": "https://api.github.com/teams/1/memberships/octocat", - "role": "member", - "state": "pending" - } } } } @@ -226323,7 +226424,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -226346,7 +226447,12 @@ "type": "string" }, "state": { - "type": "string" + "description": "The state of the user's membership in the team.", + "type": "string", + "enum": [ + "active", + "pending" + ] } }, "required": [ @@ -226356,14 +226462,6 @@ ] }, "examples": { - "response-if-users-membership-with-team-is-now-active": { - "summary": "Response if user's membership with team is now active", - "value": { - "url": "https://api.github.com/teams/1/memberships/octocat", - "role": "member", - "state": "active" - } - }, "response-if-users-membership-with-team-is-now-pending": { "summary": "Response if user's membership with team is now pending", "value": { @@ -226377,50 +226475,7 @@ } }, "422": { - "description": "Response if you attempt to add an organization to a team", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "field": { - "type": "string" - }, - "resource": { - "type": "string" - } - } - } - } - } - }, - "examples": { - "response-if-you-attempt-to-add-an-organization-to-a-team": { - "value": { - "message": "Cannot add an organization as a member.", - "errors": [ - { - "code": "org", - "field": "user", - "resource": "TeamMember" - } - ] - } - } - } - } - } + "description": "Response if you attempt to add an organization to a team" } }, "requestBody": { @@ -226484,7 +226539,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -226550,7 +226605,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -226869,7 +226924,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -227176,7 +227231,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Response if the project is not owned by the organization", @@ -227269,7 +227324,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -227325,7 +227380,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -234527,7 +234582,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "requestBody": { @@ -234598,7 +234653,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -234804,7 +234859,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -235347,7 +235402,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -235370,7 +235425,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -235466,7 +235521,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -235767,10 +235822,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -235810,7 +235865,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -235830,7 +235885,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -235944,7 +235999,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -236005,10 +236060,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -236048,7 +236103,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -236141,7 +236196,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -236206,7 +236261,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -236275,10 +236330,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -236318,7 +236373,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -236409,13 +236464,13 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -236455,7 +236510,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -236475,7 +236530,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -236589,7 +236644,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -236745,7 +236800,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -236768,7 +236823,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -236833,7 +236888,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -236989,7 +237044,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -237012,7 +237067,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -237090,7 +237145,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -237113,7 +237168,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -237166,13 +237221,13 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -237212,7 +237267,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -237265,13 +237320,13 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -237311,7 +237366,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -237376,7 +237431,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -237598,10 +237653,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -237641,7 +237696,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -237705,7 +237760,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -237914,7 +237969,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -237983,10 +238038,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -238026,7 +238081,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -238082,7 +238137,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -238291,7 +238346,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -238311,7 +238366,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -238334,7 +238389,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -238388,10 +238443,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -238411,7 +238466,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -238480,7 +238535,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -238503,7 +238558,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -239137,7 +239192,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -239160,7 +239215,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -239180,7 +239235,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -240375,7 +240430,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -240415,7 +240470,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -240471,7 +240526,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -240494,10 +240549,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -240563,7 +240618,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -240586,10 +240641,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -240649,6 +240704,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -240737,7 +240793,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -243158,7 +243214,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -243178,7 +243234,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -243229,7 +243285,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -243315,10 +243371,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -243358,7 +243414,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -243428,7 +243484,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -243491,7 +243547,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -243560,10 +243616,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -243603,7 +243659,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -243659,7 +243715,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -243722,7 +243778,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -243742,7 +243798,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -243765,7 +243821,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -243819,13 +243875,13 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -243865,7 +243921,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -243943,7 +243999,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -243960,11 +244016,21 @@ }, "state": { "type": "string", - "example": "active" + "description": "The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.", + "example": "active", + "enum": [ + "active", + "pending" + ] }, "role": { "type": "string", - "example": "admin" + "description": "The user's membership type in the organization.", + "example": "admin", + "enum": [ + "admin", + "member" + ] }, "organization_url": { "type": "string", @@ -244281,7 +244347,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -244304,7 +244370,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -244324,7 +244390,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -244428,7 +244494,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -244443,11 +244509,21 @@ }, "state": { "type": "string", - "example": "active" + "description": "The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.", + "example": "active", + "enum": [ + "active", + "pending" + ] }, "role": { "type": "string", - "example": "admin" + "description": "The user's membership type in the organization.", + "example": "admin", + "enum": [ + "admin", + "member" + ] }, "organization_url": { "type": "string", @@ -244733,7 +244809,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -244810,7 +244886,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -244825,11 +244901,21 @@ }, "state": { "type": "string", - "example": "active" + "description": "The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.", + "example": "active", + "enum": [ + "active", + "pending" + ] }, "role": { "type": "string", - "example": "admin" + "description": "The user's membership type in the organization.", + "example": "admin", + "enum": [ + "admin", + "member" + ] }, "organization_url": { "type": "string", @@ -245115,7 +245201,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -245135,7 +245221,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -245249,7 +245335,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -245360,7 +245446,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -245383,7 +245469,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -245456,7 +245542,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -245712,7 +245798,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -245735,7 +245821,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -245755,7 +245841,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -245777,7 +245863,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -245856,7 +245942,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -245917,10 +246003,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -245960,7 +246046,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -246006,7 +246092,7 @@ "parameters": [ { "name": "visibility", - "description": "Can be one of `all`, `public`, or `private`.", + "description": "Can be one of `all`, `public`, or `private`. Note: For GitHub AE, can be one of `all`, `internal`, or `private`.", "in": "query", "required": false, "schema": { @@ -246031,7 +246117,7 @@ }, { "name": "type", - "description": "Can be one of `all`, `owner`, `public`, `private`, `member`. Default: `all` \n \nWill cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.", + "description": "Can be one of `all`, `owner`, `public`, `private`, `member`. Note: For GitHub AE, can be one of `all`, `owner`, `internal`, `private`, `member`. Default: `all` \n \nWill cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.", "in": "query", "required": false, "schema": { @@ -246114,7 +246200,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -247194,7 +247280,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -247263,7 +247349,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -247286,7 +247372,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -247318,7 +247404,7 @@ }, "post": { "summary": "Create a repository for the authenticated user", - "description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.20/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", + "description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.20/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository.", "tags": [ "repos" ], @@ -247349,7 +247435,7 @@ "type": "string" }, "private": { - "description": "Whether the repository is private or public.", + "description": "Whether the repository is private.", "default": false, "type": "boolean" }, @@ -247437,7 +247523,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -248528,7 +248614,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -248548,10 +248634,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -248591,7 +248677,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -248768,7 +248854,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -250672,10 +250758,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -250715,7 +250801,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -250771,7 +250857,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -250814,7 +250900,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -250834,7 +250920,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -250871,7 +250957,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "409": { "description": "Conflict", @@ -250894,10 +250980,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -251010,7 +251096,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -253191,7 +253277,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -253214,7 +253300,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -253300,7 +253386,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -253320,7 +253406,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -253384,7 +253470,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -253407,7 +253493,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -253427,7 +253513,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -253447,7 +253533,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -253491,10 +253577,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -253514,7 +253600,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -253534,7 +253620,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -253602,7 +253688,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -255215,7 +255301,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -255238,7 +255324,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -255303,7 +255389,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -255797,10 +255883,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -255885,7 +255971,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -256041,7 +256127,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -256079,7 +256165,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -256618,7 +256704,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -256691,7 +256777,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -259411,7 +259497,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -262123,7 +262209,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -264835,7 +264921,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -265044,7 +265130,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -265311,7 +265397,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -265729,7 +265815,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -265851,7 +265937,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -266132,7 +266218,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -266179,7 +266265,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -266199,7 +266285,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -266313,7 +266399,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -266857,7 +266943,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -266955,7 +267041,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -267134,7 +267220,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -267403,7 +267489,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -267425,7 +267511,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -267551,7 +267637,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -270263,7 +270349,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -272936,7 +273022,7 @@ "/users/{username}/repos": { "get": { "summary": "List repositories for a user", - "description": "Lists public repositories for the specified user.", + "description": "Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user.", "tags": [ "repos" ], @@ -273019,7 +273105,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -274671,7 +274757,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -274707,7 +274793,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -274791,7 +274877,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -277025,7 +277111,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -278673,7 +278759,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "requestBody": { @@ -278724,7 +278810,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "requestBody": { @@ -278763,7 +278849,7 @@ "operationId": "meta/get-zen", "responses": { "200": { - "description": "response", + "description": "Response", "content": { "text/plain": { "schema": { diff --git a/lib/rest/static/dereferenced/ghes-2.21.deref.json b/lib/rest/static/dereferenced/ghes-2.21.deref.json index 023000e1a4..56ed438104 100644 --- a/lib/rest/static/dereferenced/ghes-2.21.deref.json +++ b/lib/rest/static/dereferenced/ghes-2.21.deref.json @@ -134,7 +134,7 @@ ], "servers": [ { - "url": "{protocol}://{hostname}", + "url": "{protocol}://{hostname}/api/v3", "variables": { "hostname": { "description": "Self-hosted Enterprise Server or Enterprise Cloud hostname", @@ -162,7 +162,7 @@ "operationId": "meta/root", "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -394,7 +394,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -529,7 +529,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -729,7 +729,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -859,7 +859,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -1040,7 +1040,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -1092,7 +1092,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -1140,11 +1140,48 @@ "type": "integer", "default": 1 } + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "accessed" + ], + "default": "created" + } + }, + { + "name": "since", + "description": "Only show public keys accessed after the given time.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -1242,7 +1279,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -1280,7 +1317,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -1403,7 +1440,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -1456,7 +1493,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -1603,7 +1640,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -1646,7 +1683,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -1811,7 +1848,7 @@ ], "responses": { "202": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -1895,11 +1932,39 @@ "type": "integer", "default": 1 } + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -2022,7 +2087,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -2163,7 +2228,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -2275,7 +2340,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -2452,7 +2517,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "422": { "description": "Client Errors", @@ -2540,7 +2605,7 @@ ], "responses": { "202": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -2661,7 +2726,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -2742,11 +2807,40 @@ "type": "integer", "default": 1 } + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "sort", + "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to) or `name`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -2903,7 +2997,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -3126,7 +3220,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -3288,7 +3382,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -3498,7 +3592,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -3550,7 +3644,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -4260,7 +4354,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -4288,7 +4382,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -4492,7 +4586,7 @@ ], "responses": { "202": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -4568,7 +4662,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -4606,7 +4700,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -5307,7 +5401,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -5338,7 +5432,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -5670,7 +5764,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -5996,7 +6090,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -6016,7 +6110,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -6651,7 +6745,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -7139,7 +7233,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -7159,7 +7253,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -7228,10 +7322,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -7581,7 +7675,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -8760,7 +8854,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -8782,7 +8876,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -8802,7 +8896,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -8822,7 +8916,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -8935,11 +9029,20 @@ "type": "integer", "default": 1 } + }, + { + "name": "client_id", + "in": "query", + "required": false, + "description": "The client ID of your GitHub app.", + "schema": { + "type": "string" + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -9157,7 +9260,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -9180,7 +9283,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -9200,7 +9303,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -9259,7 +9362,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -9464,7 +9567,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -9487,7 +9590,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -9544,10 +9647,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -9570,7 +9673,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -9647,10 +9750,10 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -9763,7 +9866,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -9823,7 +9926,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -10494,7 +10597,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -10563,7 +10666,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -10635,7 +10738,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -11306,7 +11409,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -11417,7 +11520,10 @@ "type": "string", "description": "The OAuth access token used to authenticate to the GitHub API." } - } + }, + "required": [ + "access_token" + ] }, "example": { "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a" @@ -11427,10 +11533,10 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -11543,7 +11649,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -12219,7 +12325,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -12284,7 +12390,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -13000,7 +13106,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -13041,7 +13147,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -13355,7 +13461,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -13375,7 +13481,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -13441,11 +13547,20 @@ "type": "integer", "default": 1 } + }, + { + "name": "client_id", + "in": "query", + "required": false, + "description": "The client ID of your GitHub app.", + "schema": { + "type": "string" + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -14120,7 +14235,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -14143,7 +14258,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -14163,7 +14278,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -14258,7 +14373,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -14916,7 +15031,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -15005,7 +15120,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -15028,7 +15143,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -16447,7 +16562,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -16516,7 +16631,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -16539,7 +16654,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -17962,7 +18077,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -18070,7 +18185,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -18720,7 +18835,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -18743,7 +18858,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -18850,7 +18965,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -19500,7 +19615,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -19606,10 +19721,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -19632,7 +19747,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -19683,7 +19798,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -19746,10 +19861,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -19810,7 +19925,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -19863,7 +19978,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -19883,10 +19998,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -19974,7 +20089,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -20024,7 +20139,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -20093,7 +20208,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -20133,7 +20248,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -20155,7 +20270,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -20220,10 +20335,10 @@ } } }, - "description": "response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -20251,7 +20366,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -20328,7 +20443,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -20597,7 +20712,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -23265,7 +23380,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -23288,7 +23403,7 @@ } }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -23337,7 +23452,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -23639,7 +23754,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -24057,7 +24172,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -24166,7 +24281,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -24399,7 +24514,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -24468,10 +24583,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -24565,7 +24680,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -24983,7 +25098,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -25052,7 +25167,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -25129,7 +25244,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -25547,7 +25662,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -25567,7 +25682,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -25626,7 +25741,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -25884,7 +25999,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -25904,7 +26019,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -26011,7 +26126,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -26236,7 +26351,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -26305,7 +26420,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -26359,10 +26474,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -26382,7 +26497,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -26459,7 +26574,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -26691,10 +26806,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -26788,7 +26903,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -27015,10 +27130,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -27103,7 +27218,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -27322,10 +27437,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -27441,7 +27556,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -27660,7 +27775,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -27723,13 +27838,13 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -27823,7 +27938,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -28036,7 +28151,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -28056,7 +28171,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -28133,7 +28248,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -28402,7 +28517,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -28422,7 +28537,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -28479,7 +28594,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -28892,7 +29007,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -28912,7 +29027,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -28981,7 +29096,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -29056,7 +29171,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -29113,10 +29228,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -29136,7 +29251,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -29193,13 +29308,13 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -29283,7 +29398,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -29508,7 +29623,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -29577,7 +29692,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -29645,7 +29760,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -29667,7 +29782,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -29705,7 +29820,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -29739,7 +29854,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -29797,7 +29912,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -30928,10 +31043,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -30988,7 +31103,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -31027,6 +31142,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -31147,7 +31263,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -33578,7 +33694,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -33647,10 +33763,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -33713,11 +33829,20 @@ "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", + "description": "Response", "content": { "application/json": { "schema": { @@ -33823,7 +33948,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -33861,7 +33986,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -34014,7 +34139,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -34034,7 +34159,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -34097,7 +34222,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "headers": { "Content-Type": { "example": "text/html", @@ -34127,7 +34252,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -34172,7 +34297,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "headers": { "X-CommonMarker-Version": { "example": "0.17.4", @@ -34190,7 +34315,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -34221,7 +34346,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -34254,7 +34379,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -34318,7 +34443,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -36986,7 +37111,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -37026,10 +37151,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "301": { - "description": "Moved Permanently" + "description": "Moved permanently" } }, "x-github": { @@ -37115,7 +37240,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -38774,7 +38899,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -38797,7 +38922,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -38817,7 +38942,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -38932,7 +39057,7 @@ }, "responses": { "202": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -38947,10 +39072,10 @@ } }, "205": { - "description": "response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -38973,7 +39098,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -39029,7 +39154,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -40675,7 +40800,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -40698,7 +40823,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -40752,10 +40877,10 @@ ], "responses": { "205": { - "description": "response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -40814,7 +40939,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -40879,7 +41004,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -40902,7 +41027,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -40972,7 +41097,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -41037,7 +41162,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -41060,7 +41185,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -41114,10 +41239,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -41140,7 +41265,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -41192,7 +41317,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/octocat-stream": { "schema": { @@ -41246,7 +41371,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -41357,7 +41482,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -41395,7 +41520,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -41675,7 +41800,9 @@ "plan": { "name": "Medium", "space": 400, - "private_repos": 20 + "private_repos": 20, + "filled_seats": 4, + "seats": 5 }, "default_repository_permission": "read", "members_can_create_repositories": true, @@ -41686,54 +41813,13 @@ "members_can_create_internal_repositories": false, "members_can_create_pages": true } - }, - "response-with-git-hub-plan-information": { - "summary": "Response with GitHub plan information", - "value": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization", - "name": "github", - "company": "GitHub", - "blog": "https://github.com/blog", - "location": "San Francisco", - "email": "octocat@github.com", - "twitter_username": "github", - "is_verified": true, - "has_organization_projects": true, - "has_repository_projects": true, - "public_repos": 2, - "public_gists": 1, - "followers": 20, - "following": 0, - "html_url": "https://github.com/octocat", - "created_at": "2008-01-14T04:33:35Z", - "updated_at": "2014-03-03T18:58:10Z", - "type": "Organization", - "plan": { - "name": "team", - "space": 976562499, - "private_repos": 999999, - "filled_seats": 4, - "seats": 5 - } - } } } } } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -41890,7 +41976,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -42184,7 +42270,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -42300,7 +42386,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -42379,7 +42465,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -45100,7 +45186,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -45227,7 +45313,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -45364,7 +45450,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -45486,7 +45572,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -45555,7 +45641,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -45618,7 +45704,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -45732,7 +45818,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -45859,7 +45945,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -45972,7 +46058,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -46041,7 +46127,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -46102,10 +46188,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -46168,10 +46254,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -46236,7 +46322,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -46790,7 +46876,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -47354,6 +47440,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -47442,7 +47529,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -49873,7 +49960,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -49978,7 +50065,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -50145,7 +50232,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -50315,7 +50402,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -50352,7 +50439,7 @@ "/orgs/{org}/memberships/{username}": { "get": { "summary": "Get organization membership for a user", - "description": "In order to get a user's membership with an organization, the authenticated user must be an organization member.", + "description": "In order to get a user's membership with an organization, the authenticated user must be an organization member. The `state` parameter in the response can be used to identify the user's membership status.", "tags": [ "orgs" ], @@ -50381,7 +50468,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -50396,11 +50483,21 @@ }, "state": { "type": "string", - "example": "active" + "description": "The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.", + "example": "active", + "enum": [ + "active", + "pending" + ] }, "role": { "type": "string", - "example": "admin" + "description": "The user's membership type in the organization.", + "example": "admin", + "enum": [ + "admin", + "member" + ] }, "organization_url": { "type": "string", @@ -50661,99 +50758,13 @@ "site_admin": false } } - }, - "response-if-user-has-an-active-membership-with-organization": { - "summary": "Response if user has an active membership with organization", - "value": { - "url": "https://api.github.com/orgs/octocat/memberships/defunkt", - "state": "active", - "role": "member", - "organization_url": "https://api.github.com/orgs/octocat", - "organization": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization" - }, - "user": { - "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 - } - } - }, - "response-if-user-has-a-pending-membership-with-organization": { - "summary": "Response if user has a pending membership with organization", - "value": { - "url": "https://api.github.com/orgs/invitocat/memberships/defunkt", - "state": "pending", - "role": "member", - "organization_url": "https://api.github.com/orgs/invitocat", - "organization": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization" - }, - "user": { - "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 - } - } } } } } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -50854,7 +50865,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -50869,11 +50880,21 @@ }, "state": { "type": "string", - "example": "active" + "description": "The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.", + "example": "active", + "enum": [ + "active", + "pending" + ] }, "role": { "type": "string", - "example": "admin" + "description": "The user's membership type in the organization.", + "example": "admin", + "enum": [ + "admin", + "member" + ] }, "organization_url": { "type": "string", @@ -51092,51 +51113,8 @@ ] }, "examples": { - "response-if-user-was-previously-unaffiliated-with-organization": { - "summary": "Response if user was previously unaffiliated with organization", - "value": { - "url": "https://api.github.com/orgs/invitocat/memberships/defunkt", - "state": "pending", - "role": "admin", - "organization_url": "https://api.github.com/orgs/invitocat", - "organization": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization" - }, - "user": { - "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 - } - } - }, "response-if-user-already-had-membership-with-organization": { - "summary": "Response if user already had membership with organization", + "summary": "Response if user has an active admin membership with organization", "value": { "url": "https://api.github.com/orgs/octocat/memberships/defunkt", "state": "active", @@ -51183,7 +51161,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -51313,7 +51291,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -51336,7 +51314,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -51423,7 +51401,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -51628,41 +51606,10 @@ "description": "User was converted" }, "403": { - "description": "response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - }, - "examples": { - "response-if-user-is-the-last-owner-of-the-organization": { - "summary": "Response if user is the last owner of the organization", - "value": { - "message": "Cannot convert the last owner to an outside collaborator", - "documentation_url": "https://docs.github.com/enterprise-server@2.21/rest/reference/orgs#convert-member-to-outside-collaborator" - } - }, - "response-if-user-is-not-a-member-of-the-organization": { - "summary": "Response if user is not a member of the organization", - "value": { - "message": " is not a member of the organization.", - "documentation_url": "https://docs.github.com/enterprise-server@2.21/rest/reference/orgs#convert-member-to-outside-collaborator" - } - } - } - } - } + "description": "Response if user is the last owner of the organization or not a member of the organization" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -51723,7 +51670,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "422": { "description": "Response if user is a member of the organization", @@ -51801,11 +51748,40 @@ "type": "integer", "default": 1 } + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "sort", + "description": "The sort order for the response collection.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -51895,7 +51871,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -51978,7 +51954,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -52084,7 +52060,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -52194,7 +52170,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -52463,7 +52439,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -52556,7 +52532,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -52812,7 +52788,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -52852,7 +52828,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -52892,7 +52868,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -52979,7 +52955,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -53225,7 +53201,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -53289,7 +53265,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -53326,7 +53302,7 @@ }, { "name": "type", - "description": "Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`.", + "description": "Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Note: For GitHub AE, can be one of `all`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`.", "in": "query", "required": false, "schema": { @@ -53392,7 +53368,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -55039,7 +55015,7 @@ }, "post": { "summary": "Create an organization repository", - "description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.21/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", + "description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.21/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository", "tags": [ "repos" ], @@ -55078,12 +55054,12 @@ }, "private": { "type": "boolean", - "description": "Either `true` to create a private repository or `false` to create a public one.", + "description": "Whether the repository is private.", "default": false }, "visibility": { "type": "string", - "description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", + "description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", "enum": [ "public", "private", @@ -55167,7 +55143,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -56288,7 +56264,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -56419,7 +56395,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -56715,7 +56691,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -57196,7 +57172,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -57329,7 +57305,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -57810,7 +57786,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -57919,7 +57895,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -58442,7 +58418,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -58517,11 +58493,20 @@ "type": "integer", "default": 1 } + }, + { + "name": "pinned", + "in": "query", + "required": false, + "description": "Pinned discussions only filter", + "schema": { + "type": "string" + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -58942,7 +58927,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -59329,7 +59314,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -59735,7 +59720,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -60119,7 +60104,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -60206,7 +60191,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -60590,7 +60575,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -60951,7 +60936,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -61330,7 +61315,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -61688,7 +61673,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -61788,7 +61773,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -62090,7 +62075,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -62358,7 +62343,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -62454,7 +62439,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -62748,7 +62733,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -63008,7 +62993,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -63092,7 +63077,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -63262,7 +63247,7 @@ "/orgs/{org}/teams/{team_slug}/memberships/{username}": { "get": { "summary": "Get team membership for a user", - "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.\n\n**Note:** The `role` for organization owners returns as `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@2.21/rest/reference/teams#create-a-team).", + "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.\n\n**Note:**\nThe response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see see [Create a team](https://docs.github.com/enterprise-server@2.21/rest/reference/teams#create-a-team).", "tags": [ "teams" ], @@ -63300,7 +63285,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -63323,7 +63308,12 @@ "type": "string" }, "state": { - "type": "string" + "description": "The state of the user's membership in the team.", + "type": "string", + "enum": [ + "active", + "pending" + ] } }, "required": [ @@ -63333,14 +63323,6 @@ ] }, "examples": { - "response-if-user-has-an-active-membership-with-team": { - "summary": "Response if user has an active membership with team", - "value": { - "url": "https://api.github.com/teams/1/memberships/octocat", - "role": "member", - "state": "active" - } - }, "response-if-user-is-a-team-maintainer": { "summary": "Response if user is a team maintainer", "value": { @@ -63348,14 +63330,6 @@ "role": "maintainer", "state": "active" } - }, - "response-if-user-has-a-pending-membership-with-team": { - "summary": "Response if user has a pending membership with team", - "value": { - "url": "https://api.github.com/teams/1/memberships/octocat", - "role": "member", - "state": "pending" - } } } } @@ -63435,7 +63409,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -63458,7 +63432,12 @@ "type": "string" }, "state": { - "type": "string" + "description": "The state of the user's membership in the team.", + "type": "string", + "enum": [ + "active", + "pending" + ] } }, "required": [ @@ -63468,14 +63447,6 @@ ] }, "examples": { - "response-if-users-membership-with-team-is-now-active": { - "summary": "Response if user's membership with team is now active", - "value": { - "url": "https://api.github.com/teams/1/memberships/octocat", - "role": "member", - "state": "active" - } - }, "response-if-users-membership-with-team-is-now-pending": { "summary": "Response if user's membership with team is now pending", "value": { @@ -63492,50 +63463,7 @@ "description": "Response if team synchronization is set up" }, "422": { - "description": "Response if you attempt to add an organization to a team", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "field": { - "type": "string" - }, - "resource": { - "type": "string" - } - } - } - } - } - }, - "examples": { - "response-if-you-attempt-to-add-an-organization-to-a-team": { - "value": { - "message": "Cannot add an organization as a member.", - "errors": [ - { - "code": "org", - "field": "user", - "resource": "TeamMember" - } - ] - } - } - } - } - } + "description": "Response if you attempt to add an organization to a team" } }, "x-github": { @@ -63588,7 +63516,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Response if team synchronization is set up" @@ -63656,7 +63584,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -63976,7 +63904,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -64305,7 +64233,7 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Response if the project is not owned by the organization", @@ -64388,7 +64316,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -64453,7 +64381,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -68092,7 +68020,7 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -68153,7 +68081,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -68445,7 +68373,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -68672,7 +68600,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -68695,7 +68623,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -68715,7 +68643,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -68795,7 +68723,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -69022,7 +68950,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -69045,7 +68973,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -69065,7 +68993,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -69085,7 +69013,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -69153,10 +69081,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -69183,7 +69111,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -69203,7 +69131,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -69288,7 +69216,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -69301,7 +69229,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -69342,7 +69270,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -69362,7 +69290,7 @@ } }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -69397,7 +69325,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -69506,7 +69434,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -69583,7 +69511,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -69606,7 +69534,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -69626,7 +69554,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -69703,7 +69631,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -69780,7 +69708,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -69803,7 +69731,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -69861,10 +69789,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -69887,7 +69815,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -69980,7 +69908,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -70220,7 +70148,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -70243,7 +70171,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -70344,7 +70272,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -70571,7 +70499,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -70594,7 +70522,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -70614,7 +70542,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -70710,7 +70638,7 @@ } }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -70805,7 +70733,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -70818,7 +70746,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -70841,7 +70769,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -70871,7 +70799,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -70930,7 +70858,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -71186,7 +71114,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -71209,7 +71137,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -71307,7 +71235,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -71566,7 +71494,7 @@ "description": "Response if the authenticated user does not have access to the project" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -71593,7 +71521,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -71633,7 +71561,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -71703,7 +71631,7 @@ "description": "Delete Success" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -71730,7 +71658,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -71770,7 +71698,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -71862,7 +71790,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -72018,7 +71946,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -72038,7 +71966,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -72060,7 +71988,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -72129,7 +72057,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -72152,7 +72080,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -72241,10 +72169,10 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -72264,7 +72192,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -72286,7 +72214,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -72355,7 +72283,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -72378,7 +72306,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -72443,13 +72371,13 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -72469,7 +72397,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -72511,7 +72439,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -72580,7 +72508,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -72647,7 +72575,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -72812,7 +72740,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -72832,7 +72760,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -72854,7 +72782,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -72923,7 +72851,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -72946,7 +72874,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -73023,7 +72951,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -73113,7 +73041,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -73136,7 +73064,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -73212,7 +73140,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -73285,7 +73213,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -73308,7 +73236,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -73338,7 +73266,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -73390,7 +73318,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -73616,10 +73544,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -73674,10 +73602,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -73700,7 +73628,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -73740,7 +73668,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -73812,7 +73740,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -78514,7 +78442,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -78534,7 +78462,7 @@ } }, "301": { - "description": "Moved Permanently" + "description": "Moved permanently" } }, "x-github": { @@ -78683,7 +78611,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -82876,7 +82804,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -82945,7 +82873,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -83015,7 +82943,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "If an organization owner has configured the organization to prevent members from deleting organization-owned repositories, a member will get this response:", @@ -83040,7 +82968,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -83121,7 +83049,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -83277,7 +83205,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -83441,7 +83369,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -84167,18 +84095,6 @@ }, "examples": { "default": { - "value": [ - { - "name": "master", - "commit": { - "sha": "c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc", - "url": "https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc" - }, - "protected": true - } - ] - }, - "with-protection": { "value": [ { "name": "master", @@ -84214,7 +84130,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -84287,7 +84203,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -85605,7 +85521,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -85627,7 +85543,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -85700,7 +85616,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -86546,7 +86462,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -86785,7 +86701,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -87516,7 +87432,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -87538,7 +87454,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -87568,7 +87484,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -87643,7 +87559,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -87719,7 +87635,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -87805,7 +87721,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -87894,7 +87810,7 @@ "description": "No Content" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -87967,7 +87883,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/vnd.github.luke-cage-preview+json": { "schema": { @@ -88446,7 +88362,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -88814,7 +88730,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -88941,7 +88857,7 @@ "description": "No Content" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -89014,7 +88930,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -89049,7 +88965,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -89124,7 +89040,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -89159,7 +89075,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -89237,7 +89153,7 @@ "description": "No Content" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -89314,7 +89230,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -89369,7 +89285,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -89468,7 +89384,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -89523,7 +89439,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -89543,7 +89459,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -89719,7 +89635,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -89735,7 +89651,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -89832,7 +89748,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -89849,7 +89765,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -89938,7 +89854,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -90036,7 +89952,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -90052,7 +89968,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -90121,7 +90037,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -90219,7 +90135,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -90235,7 +90151,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -90255,7 +90171,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -90378,7 +90294,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -90749,7 +90665,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -90876,7 +90792,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -91175,7 +91091,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -91272,7 +91188,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -91571,7 +91487,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -91718,7 +91634,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -92017,7 +91933,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -92164,7 +92080,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -92463,7 +92379,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -92586,7 +92502,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -92757,7 +92673,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -92854,7 +92770,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -93025,7 +92941,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -93172,7 +93088,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -93343,7 +93259,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -93490,7 +93406,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -93661,7 +93577,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -93784,7 +93700,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -93932,7 +93848,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -94029,7 +93945,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -94177,7 +94093,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -94324,7 +94240,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -94472,7 +94388,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -94619,7 +94535,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -94767,7 +94683,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -95074,7 +94990,7 @@ "name", "head_sha" ], - "anyOf": [ + "oneOf": [ { "properties": { "status": { @@ -95084,6 +95000,7 @@ } }, "required": [ + "status", "conclusion" ], "additionalProperties": true @@ -95103,7 +95020,7 @@ }, "examples": { "example-of-in-progress-conclusion": { - "summary": "Example of in_progress conclusion", + "summary": "Response for in_progress conclusion", "value": { "name": "mighty_readme", "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -95118,7 +95035,7 @@ } }, "example-of-completed-conclusion": { - "summary": "Example of completed conclusion", + "summary": "Response for completed conclusion", "value": { "name": "mighty_readme", "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -95172,7 +95089,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -95988,101 +95905,8 @@ ] }, "examples": { - "example-of-in-progress-conclusion": { - "summary": "Example of in_progress conclusion", - "value": { - "id": 4, - "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", - "node_id": "MDg6Q2hlY2tSdW40", - "external_id": "42", - "url": "https://api.github.com/repos/github/hello-world/check-runs/4", - "html_url": "https://github.com/github/hello-world/runs/4", - "details_url": "https://example.com", - "status": "in_progress", - "conclusion": "neutral", - "started_at": "2018-05-04T01:14:52Z", - "completed_at": null, - "output": { - "title": "Mighty Readme Report", - "summary": "", - "text": "", - "annotations_count": 1, - "annotations_url": "https://api.github.com/repos/github/hello-world/check-runs/4/annotations" - }, - "name": "mighty_readme", - "check_suite": { - "id": 5 - }, - "app": { - "id": 1, - "slug": "octoapp", - "node_id": "MDExOkludGVncmF0aW9uMQ==", - "owner": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "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", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": true - }, - "name": "Octocat App", - "description": "", - "external_url": "https://example.com", - "html_url": "https://github.com/apps/octoapp", - "created_at": "2017-07-08T16:18:44-04:00", - "updated_at": "2017-07-08T16:18:44-04:00", - "permissions": { - "metadata": "read", - "contents": "read", - "issues": "write", - "single_file": "write" - }, - "events": [ - "push", - "pull_request" - ] - }, - "pull_requests": [ - { - "url": "https://api.github.com/repos/github/hello-world/pulls/1", - "id": 1934, - "number": 3956, - "head": { - "ref": "say-hello", - "sha": "3dca65fa3e8d4b3da3f3d056c59aee1c50f41390", - "repo": { - "id": 526, - "url": "https://api.github.com/repos/github/hello-world", - "name": "hello-world" - } - }, - "base": { - "ref": "master", - "sha": "e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f", - "repo": { - "id": 526, - "url": "https://api.github.com/repos/github/hello-world", - "name": "hello-world" - } - } - } - ] - } - }, "example-of-completed-conclusion": { - "summary": "Example of completed conclusion", + "summary": "Response for completed conclusion", "value": { "id": 4, "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -96235,7 +96059,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -97456,7 +97280,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -98443,7 +98267,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -98611,7 +98435,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -100999,7 +100823,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -102196,7 +102020,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -104607,7 +104431,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -105604,7 +105428,7 @@ ], "responses": { "201": { - "description": "response" + "description": "Response" } }, "x-github": { @@ -105687,7 +105511,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -105862,7 +105686,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -107921,7 +107745,7 @@ "description": "Response when person is already a collaborator" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -108060,7 +107884,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -108279,7 +108103,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -108360,7 +108184,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -108718,7 +108542,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -109007,7 +108831,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -109102,7 +108926,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -109391,7 +109215,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -109461,10 +109285,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -109573,7 +109397,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -109782,7 +109606,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -109802,7 +109626,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -110301,7 +110125,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -110323,7 +110147,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -110456,7 +110280,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -110565,11 +110389,31 @@ "type": "integer", "default": 1 } + }, + { + "name": "top", + "description": "legacy parameter for pagination.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "last_sha", + "description": "legacy parameter for pagination.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -111222,7 +111066,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -111315,7 +111159,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -111372,7 +111216,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -111394,7 +111238,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -111538,7 +111382,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -111931,7 +111775,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -112248,7 +112092,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -112389,7 +112233,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -116198,7 +116042,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -116264,9 +116108,27 @@ "type": "string" } }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -116277,7 +116139,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -116860,7 +116722,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -116929,7 +116791,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -117011,7 +116873,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -117073,11 +116935,19 @@ "type": "integer", "default": 1 } + }, + { + "name": "app_id", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -118064,7 +117934,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -118112,7 +117982,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -120346,18 +120216,36 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true + }, + { + "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", + "description": "Response", "content": { "application/json": { "schema": { @@ -122052,7 +121940,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -122114,7 +122002,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -122143,7 +122031,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -122362,7 +122250,7 @@ } }, "301": { - "description": "Moved Permanently" + "description": "Moved permanently" } }, "x-github": { @@ -122424,7 +122312,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -124287,7 +124175,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -124349,7 +124237,7 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { @@ -124369,7 +124257,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/vnd.github.v3.object": { "schema": { @@ -124981,7 +124869,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -125064,7 +124952,7 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { @@ -125175,7 +125063,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -125391,7 +125279,7 @@ } }, "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -125607,7 +125495,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -125627,7 +125515,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -125756,7 +125644,7 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { @@ -125830,7 +125718,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -126031,7 +125919,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -126100,7 +125988,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -126140,7 +126028,7 @@ } }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -126382,7 +126270,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -126479,7 +126367,8 @@ "required": false, "schema": { "type": "string", - "default": "none" + "default": "none", + "nullable": true } }, { @@ -126503,7 +126392,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -127170,7 +127059,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -127679,48 +127568,6 @@ "transient_environment": false, "production_environment": true } - }, - "advanced-example": { - "summary": "Advanced example", - "value": { - "url": "https://api.github.com/repos/octocat/example/deployments/1", - "id": 1, - "node_id": "MDEwOkRlcGxveW1lbnQx", - "sha": "a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d", - "ref": "topic-branch", - "task": "deploy", - "payload": { - }, - "original_environment": "staging", - "environment": "production", - "description": "Deploy request from hubot", - "creator": { - "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 - }, - "created_at": "2012-07-20T01:19:13Z", - "updated_at": "2012-07-20T01:19:13Z", - "statuses_url": "https://api.github.com/repos/octocat/example/deployments/1/statuses", - "repository_url": "https://api.github.com/repos/octocat/example", - "transient_environment": false, - "production_environment": true - } } } } @@ -127749,40 +127596,10 @@ } }, "409": { - "description": "response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string", - "example": "\"https://docs.github.com/enterprise-server@2.21/rest/reference/repos#create-a-deployment\"" - } - } - }, - "examples": { - "merge-conflict-response": { - "summary": "Merge conflict response", - "value": { - "message": "Conflict merging master into topic-branch" - } - }, - "failed-commit-status-checks": { - "summary": "Failed commit status checks", - "value": { - "message": "Conflict: Commit status checks failed for topic-branch." - } - } - } - } - } + "description": "Response when there is a merge conflict or the commit's status checks failed" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -127907,7 +127724,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -128421,7 +128238,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -128500,10 +128317,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -128523,7 +128340,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -128623,7 +128440,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -129147,7 +128964,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -129292,7 +129109,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -129811,7 +129628,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -129949,7 +129766,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -130460,7 +130277,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -130480,7 +130297,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -130589,10 +130406,10 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -130722,7 +130539,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -133440,7 +133257,8 @@ "enum": [ "newest", "oldest", - "stargazers" + "stargazers", + "watchers" ], "default": "newest" } @@ -133462,11 +133280,31 @@ "type": "integer", "default": 1 } + }, + { + "name": "org", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "organization", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -135183,6 +135021,26 @@ "schema": { "type": "string" } + }, + { + "name": "org", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "organization", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } } ], "requestBody": { @@ -135190,6 +135048,7 @@ "application/json": { "schema": { "type": "object", + "nullable": true, "properties": { "organization": { "type": "string", @@ -135202,7 +135061,7 @@ }, "responses": { "202": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -136349,7 +136208,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -136438,7 +136297,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -136528,7 +136387,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -136568,7 +136427,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -136628,7 +136487,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -136748,7 +136607,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -136805,7 +136664,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -136825,7 +136684,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -137040,7 +136899,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -137256,7 +137115,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -137325,7 +137184,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -137398,7 +137257,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -137606,7 +137465,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -137668,7 +137527,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -137697,7 +137556,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -137830,7 +137689,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -137841,7 +137700,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -137909,7 +137768,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -138003,7 +137862,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -138079,7 +137938,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -138190,7 +138049,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -138228,7 +138087,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -138296,7 +138155,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -138405,7 +138264,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -138416,10 +138275,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -138598,7 +138457,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -138745,7 +138604,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -138865,7 +138724,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -139004,7 +138863,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -139138,7 +138997,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -139266,7 +139125,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -139335,7 +139194,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -139421,7 +139280,8 @@ "required": true, "schema": { "type": "string" - } + }, + "x-multi-segment": true }, { "name": "recursive", @@ -139435,7 +139295,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -139589,7 +139449,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -139658,7 +139518,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -139739,7 +139599,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -139936,7 +139796,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -140081,7 +139941,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -140273,7 +140133,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -140293,7 +140153,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -140433,7 +140293,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -140617,7 +140477,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -140770,7 +140630,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -140954,7 +140814,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -141023,7 +140883,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -141092,10 +140952,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -141166,10 +141026,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -141240,10 +141100,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -141316,7 +141176,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -141804,10 +141664,10 @@ } }, "301": { - "description": "Moved Permanently" + "description": "Moved permanently" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -141891,7 +141751,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -143881,7 +143741,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -145835,7 +145695,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -145997,7 +145857,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -148167,10 +148027,10 @@ } }, "301": { - "description": "Moved Permanently" + "description": "Moved permanently" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -148239,7 +148099,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -148397,7 +148257,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -150753,7 +150613,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -150822,7 +150682,7 @@ } }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -150843,7 +150703,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -150981,7 +150841,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -151526,7 +151386,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -151595,7 +151455,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -151671,7 +151531,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -152203,7 +152063,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -152298,7 +152158,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -152830,7 +152690,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -152949,7 +152809,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -153041,7 +152901,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -153250,7 +153110,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -153270,7 +153130,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -153769,7 +153629,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -153791,7 +153651,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -153924,7 +153784,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -153992,7 +153852,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -157094,7 +156954,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -157223,7 +157083,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -160312,7 +160172,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -160438,7 +160298,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -162766,10 +162626,10 @@ } }, "301": { - "description": "Moved Permanently" + "description": "Moved permanently" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -162809,7 +162669,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -162968,7 +162828,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -165296,7 +165156,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -165365,7 +165225,7 @@ } }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -165406,10 +165266,10 @@ } }, "301": { - "description": "Moved Permanently" + "description": "Moved permanently" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -165525,7 +165385,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -167796,7 +167656,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -170072,7 +169932,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -170617,7 +170477,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -170732,7 +170592,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -171312,7 +171172,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -171381,7 +171241,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -171472,7 +171332,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -171830,7 +171690,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -172018,7 +171878,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -172121,7 +171981,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -172264,7 +172124,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -172367,7 +172227,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -172486,7 +172346,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "410": { "description": "Gone", @@ -172569,7 +172429,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -172643,7 +172503,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -172757,7 +172617,7 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -172800,7 +172660,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -172820,7 +172680,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -172942,7 +172802,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -172965,7 +172825,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -173074,7 +172934,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -173283,7 +173143,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -173323,7 +173183,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -173430,7 +173290,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -173626,7 +173486,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -173648,7 +173508,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -173781,7 +173641,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -173858,7 +173718,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -174117,7 +173977,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -174157,7 +174017,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -174249,7 +174109,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -174391,7 +174251,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -174456,7 +174316,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -174577,7 +174437,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -174634,7 +174494,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -174704,7 +174564,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -174768,7 +174628,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -174859,7 +174719,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -174951,7 +174811,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -175028,7 +174888,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -175097,7 +174957,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -175168,7 +175028,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -175237,7 +175097,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -175334,7 +175194,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -175452,7 +175312,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -175498,7 +175358,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -175564,7 +175424,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -176390,63 +176250,10 @@ } }, "404": { - "description": "response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string", - "example": "\"https://docs.github.com/enterprise-server@2.21/rest/reference/repos#perform-a-merge\"" - } - } - }, - "examples": { - "missing-base-response": { - "summary": "Missing base response", - "value": { - "message": "Base does not exist" - } - }, - "missing-head-response": { - "summary": "Missing head response", - "value": { - "message": "Head does not exist" - } - } - } - } - } + "description": "Response when the base or head does not exist" }, "409": { - "description": "Merge conflict response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string", - "example": "\"https://docs.github.com/enterprise-server@2.21/rest/reference/repos#perform-a-merge\"" - } - } - }, - "examples": { - "merge-conflict-response": { - "value": { - "message": "Merge Conflict" - } - } - } - } - } + "description": "Response when there is a merge conflict" }, "403": { "description": "Forbidden", @@ -176469,7 +176276,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -176642,7 +176449,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -176923,7 +176730,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -177025,7 +176832,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -177301,7 +177108,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -177321,7 +177128,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -177442,7 +177249,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -177710,7 +177517,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -177818,7 +177625,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -178136,10 +177943,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -178229,7 +178036,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -178419,7 +178226,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -180134,7 +179941,7 @@ }, "responses": { "202": { - "description": "response" + "description": "Response" } }, "x-github": { @@ -180180,7 +179987,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -180273,7 +180080,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -180381,7 +180188,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -180474,7 +180281,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -180543,7 +180350,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -180690,10 +180497,10 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -180857,10 +180664,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -180929,7 +180736,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -180951,7 +180758,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -181036,7 +180843,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -181299,7 +181106,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -181377,7 +181184,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -181637,7 +181444,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -181903,11 +181710,39 @@ "type": "integer", "default": 1 } + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -182001,7 +181836,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -182088,7 +181923,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -182307,7 +182142,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -182576,7 +182411,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -182616,7 +182451,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -182656,7 +182491,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -182757,7 +182592,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -183013,7 +182848,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -183053,7 +182888,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -183093,7 +182928,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -183250,7 +183085,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -187059,10 +186894,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -187224,7 +187059,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -190253,7 +190088,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -190368,16 +190203,15 @@ }, { "name": "sort", - "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to).", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "created", - "updated" - ], - "default": "created" + "updated", + "created_at" + ] } }, { @@ -190423,7 +190257,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -190949,7 +190783,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -191401,7 +191235,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -191501,7 +191335,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -192007,10 +191841,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -192119,7 +191953,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -192328,7 +192162,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -192348,7 +192182,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -192847,7 +192681,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -192869,7 +192703,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -193002,7 +192836,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -196061,7 +195895,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "500": { "description": "Internal Error", @@ -196084,7 +195918,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -196194,7 +196028,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -199195,7 +199029,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -199392,7 +199226,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -199998,7 +199832,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -200458,7 +200292,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -200633,7 +200467,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -201093,7 +200927,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -201183,7 +201017,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -201831,7 +201665,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -201932,7 +201766,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -202247,7 +202081,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -202336,7 +202170,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -202426,7 +202260,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -202788,7 +202622,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -206752,10 +206586,10 @@ }, "responses": { "200": { - "description": "response" + "description": "Response" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -207312,7 +207146,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -207588,7 +207422,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -207699,7 +207533,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -207975,7 +207809,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -208074,7 +207908,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -208350,7 +208184,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -208438,7 +208272,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -208714,7 +208548,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -208744,7 +208578,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -208842,7 +208676,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -209243,7 +209077,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -209345,7 +209179,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -209621,7 +209455,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -209641,7 +209475,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -209758,7 +209592,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -210034,7 +209868,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -210054,7 +209888,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -210174,7 +210008,7 @@ }, "responses": { "202": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -210196,7 +210030,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -210285,7 +210119,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -210361,6 +210195,279 @@ } } ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Content File", + "description": "Content File", + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "encoding": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "path": { + "type": "string" + }, + "content": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "git_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "download_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "_links": { + "type": "object", + "properties": { + "git": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html": { + "type": "string", + "format": "uri", + "nullable": true + }, + "self": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "git", + "html", + "self" + ] + }, + "target": { + "type": "string", + "example": "\"actual/actual.md\"" + }, + "submodule_git_url": { + "type": "string", + "example": "\"git://example.com/defunkt/dotjs.git\"" + } + }, + "required": [ + "_links", + "git_url", + "html_url", + "download_url", + "name", + "path", + "sha", + "size", + "type", + "url", + "content", + "encoding" + ] + }, + "examples": { + "default": { + "value": { + "type": "file", + "encoding": "base64", + "size": 5362, + "name": "README.md", + "path": "README.md", + "content": "encoded content ...", + "sha": "3d21ec53a331a6f037a91c368710b99387d012c1", + "url": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md", + "git_url": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1", + "html_url": "https://github.com/octokit/octokit.rb/blob/master/README.md", + "download_url": "https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md", + "_links": { + "git": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1", + "self": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md", + "html": "https://github.com/octokit/octokit.rb/blob/master/README.md" + } + } + } + } + } + } + }, + "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" + } + } + } + } + } + }, + "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" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "repos", + "subcategory": "contents" + } + } + }, + "/repos/{owner}/{repo}/readme/{dir}": { + "get": { + "summary": "Get a repository README", + "description": "Gets the preferred README for a repository.\n\nREADMEs support [custom media types](https://docs.github.com/enterprise-server@2.21/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML.", + "tags": [ + "repos" + ], + "operationId": "repos/get-readme-from-alt-path", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@2.21/rest/reference/repos#get-a-repository-readme" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "dir", + "description": "The alternate path to look for a README file", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + }, + { + "name": "ref", + "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], "responses": { "200": { "description": "response", @@ -210485,7 +210592,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -210505,7 +210612,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -210635,7 +210742,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -211135,7 +211242,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -211244,7 +211351,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -211739,7 +211846,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -212093,7 +212200,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -212113,7 +212220,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -212215,7 +212322,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -212497,7 +212604,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -212543,7 +212650,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -213072,7 +213179,7 @@ }, { "name": "tag", - "description": "tag+ parameter", + "description": "tag parameter", "in": "path", "required": true, "schema": { @@ -213083,7 +213190,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -213570,7 +213677,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -214129,7 +214236,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -214242,7 +214349,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -214779,7 +214886,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -214852,7 +214959,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -215475,7 +215582,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -215799,7 +215906,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -215983,7 +216090,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -216484,7 +216591,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -216681,7 +216788,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -216956,7 +217063,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -217300,7 +217407,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -217403,7 +217510,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -217467,7 +217574,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -217599,7 +217706,7 @@ ], "responses": { "302": { - "description": "response", + "description": "Response", "headers": { "Location": { "example": "https://codeload.github.com/me/myprivate/legacy.zip/master?login=me&token=thistokenexpires", @@ -217671,7 +217778,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -217889,11 +217996,29 @@ "schema": { "type": "string" } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -217928,7 +218053,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -217950,7 +218075,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -218044,7 +218169,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -218079,7 +218204,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -218101,7 +218226,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -218121,7 +218246,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -218230,7 +218355,7 @@ }, "responses": { "202": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -219366,7 +219491,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -219414,7 +219539,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -219472,7 +219597,7 @@ ], "responses": { "302": { - "description": "response", + "description": "Response", "headers": { "Location": { "example": "https://codeload.github.com/me/myprivate/legacy.zip/master?login=me&token=thistokenexpires", @@ -219497,7 +219622,7 @@ "/repos/{template_owner}/{template_repo}/generate": { "post": { "summary": "Create a repository using a template", - "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@2.21/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.21/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", + "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@2.21/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.21/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository", "tags": [ "repos" ], @@ -219569,7 +219694,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -220686,7 +220811,7 @@ "/repositories": { "get": { "summary": "List public repositories", - "description": "Lists all public repositories in the order that they were created.\n\nNote: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@2.21/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.", + "description": "Lists all public repositories in the order that they were created.\n\nNotes:\n- For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise.\n- Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@2.21/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.", "tags": [ "repos" ], @@ -220707,7 +220832,7 @@ }, { "name": "visibility", - "description": "Specifies the types of repositories to return. Can be one of `all` or `public`. Default: `public`.", + "description": "Specifies the types of repositories to return. Can be one of `all` or `public`. Default: `public`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise.", "in": "query", "required": false, "schema": { @@ -220723,7 +220848,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -222303,7 +222428,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -222372,7 +222497,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -222455,7 +222580,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -224155,10 +224280,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -224179,7 +224304,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -224349,7 +224474,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -226342,10 +226467,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -226461,7 +226586,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -228607,7 +228732,7 @@ } }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -228628,7 +228753,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -228697,7 +228822,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -228792,7 +228917,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -228930,10 +229055,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -228973,7 +229098,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -229125,7 +229250,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -229834,7 +229959,7 @@ } }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -229855,7 +229980,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -229924,7 +230049,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -229967,7 +230092,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -230241,10 +230366,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -230352,7 +230477,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -230596,10 +230721,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -230620,7 +230745,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -230714,7 +230839,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -230801,7 +230926,7 @@ }, "responses": { "202": { - "description": "response" + "description": "Response" } }, "x-github": { @@ -230829,7 +230954,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -230910,7 +231035,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -231011,7 +231136,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -231620,7 +231745,7 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "requestBody": { @@ -231666,7 +231791,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -231724,7 +231849,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -231804,7 +231929,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -231882,7 +232007,7 @@ }, "responses": { "202": { - "description": "response" + "description": "Response" } }, "requestBody": { @@ -231936,7 +232061,7 @@ }, "responses": { "202": { - "description": "response" + "description": "Response" } }, "requestBody": { @@ -231989,7 +232114,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -232470,7 +232595,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -232576,7 +232701,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -233057,7 +233182,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -233077,7 +233202,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -233202,10 +233327,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -233225,7 +233350,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -233364,7 +233489,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -233779,7 +233904,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -234160,7 +234285,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -234560,7 +234685,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -234938,7 +235063,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -235019,7 +235144,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -235397,7 +235522,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -235752,7 +235877,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -236125,7 +236250,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -236477,7 +236602,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -236571,7 +236696,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -236867,7 +236992,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -237150,7 +237275,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -237438,7 +237563,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -237709,7 +237834,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -237865,7 +237990,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -237981,74 +238106,13 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { "description": "Response if team synchronization is set up" }, "422": { - "description": "response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "field": { - "type": "string" - }, - "resource": { - "type": "string" - } - } - } - }, - "documentation_url": { - "type": "string", - "example": "\"https://docs.github.com/enterprise-server@2.21/rest\"" - } - } - }, - "examples": { - "response-if-you-attempt-to-add-an-organization-to-a-team": { - "summary": "Response if you attempt to add an organization to a team", - "value": { - "message": "Cannot add an organization as a member.", - "errors": [ - { - "code": "org", - "field": "user", - "resource": "TeamMember" - } - ] - } - }, - "response-if-you-attempt-to-add-a-user-to-a-team-when-they-are-not-a-member-of-at-least-one-other-team-in-the-same-organization": { - "summary": "Response if you attempt to add a user to a team when they are not a member of at least one other team in the same organization", - "value": { - "message": "User isn't a member of this organization. Please invite them first.", - "errors": [ - { - "code": "unaffiliated", - "field": "user", - "resource": "TeamMember" - } - ] - } - } - } - } - } + "description": "Response if you attempt to add an organization to a team or you attempt to add a user to a team when they are not a member of at least one other team in the same organization" }, "403": { "description": "Forbidden", @@ -238115,7 +238179,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { "description": "Response if team synchronization is setup" @@ -238138,7 +238202,7 @@ "/teams/{team_id}/memberships/{username}": { "get": { "summary": "Get team membership for a user (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 [Get team membership for a user](https://docs.github.com/enterprise-server@2.21/rest/reference/teams#get-team-membership-for-a-user) endpoint.\n\nTeam members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:** The `role` for organization owners returns as `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@2.21/rest/reference/teams#create-a-team).", + "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 [Get team membership for a user](https://docs.github.com/enterprise-server@2.21/rest/reference/teams#get-team-membership-for-a-user) endpoint.\n\nTeam members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:**\nThe response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@2.21/rest/reference/teams#create-a-team).", "tags": [ "teams" ], @@ -238167,7 +238231,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -238190,7 +238254,12 @@ "type": "string" }, "state": { - "type": "string" + "description": "The state of the user's membership in the team.", + "type": "string", + "enum": [ + "active", + "pending" + ] } }, "required": [ @@ -238200,14 +238269,6 @@ ] }, "examples": { - "response-if-user-has-an-active-membership-with-team": { - "summary": "Response if user has an active membership with team", - "value": { - "url": "https://api.github.com/teams/1/memberships/octocat", - "role": "member", - "state": "active" - } - }, "response-if-user-is-a-team-maintainer": { "summary": "Response if user is a team maintainer", "value": { @@ -238215,21 +238276,13 @@ "role": "maintainer", "state": "active" } - }, - "response-if-user-has-a-pending-membership-with-team": { - "summary": "Response if user has a pending membership with team", - "value": { - "url": "https://api.github.com/teams/1/memberships/octocat", - "role": "member", - "state": "pending" - } } } } } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -238313,7 +238366,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -238336,7 +238389,12 @@ "type": "string" }, "state": { - "type": "string" + "description": "The state of the user's membership in the team.", + "type": "string", + "enum": [ + "active", + "pending" + ] } }, "required": [ @@ -238346,14 +238404,6 @@ ] }, "examples": { - "response-if-users-membership-with-team-is-now-active": { - "summary": "Response if user's membership with team is now active", - "value": { - "url": "https://api.github.com/teams/1/memberships/octocat", - "role": "member", - "state": "active" - } - }, "response-if-users-membership-with-team-is-now-pending": { "summary": "Response if user's membership with team is now pending", "value": { @@ -238370,57 +238420,10 @@ "description": "Response if team synchronization is set up" }, "422": { - "description": "Response if you attempt to add an organization to a team", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "field": { - "type": "string" - }, - "resource": { - "type": "string" - } - } - } - }, - "documentation_url": { - "type": "string", - "example": "\"https://help.github.com/articles/github-and-trade-controls\"" - } - } - }, - "examples": { - "response-if-you-attempt-to-add-an-organization-to-a-team": { - "value": { - "message": "Cannot add an organization as a member.", - "errors": [ - { - "code": "org", - "field": "user", - "resource": "TeamMember" - } - ] - } - } - } - } - } + "description": "Response if you attempt to add an organization to a team" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -238484,7 +238487,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Response if team synchronization is set up" @@ -238546,7 +238549,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -238810,7 +238813,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -238830,7 +238833,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -238902,7 +238905,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -239156,7 +239159,7 @@ "description": "Response if project is not managed by this team" }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -239246,7 +239249,7 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Response if the project is not owned by the organization", @@ -239275,7 +239278,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -239295,7 +239298,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -239317,7 +239320,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -239434,10 +239437,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -239457,7 +239460,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -239479,7 +239482,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -239604,7 +239607,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -241230,7 +241233,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -243249,7 +243252,7 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -243272,7 +243275,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -243393,7 +243396,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -243643,7 +243646,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -243683,7 +243686,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -243783,7 +243786,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -244326,7 +244329,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -244349,7 +244352,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -244445,7 +244448,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -244746,10 +244749,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -244789,7 +244792,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -244809,7 +244812,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -244923,7 +244926,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -244984,10 +244987,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -245027,7 +245030,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -245120,7 +245123,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -245185,7 +245188,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -245254,10 +245257,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -245297,7 +245300,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -245388,13 +245391,13 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -245434,7 +245437,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -245454,7 +245457,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -245568,7 +245571,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -245724,7 +245727,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -245747,7 +245750,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -245812,7 +245815,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -245968,7 +245971,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -245991,7 +245994,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -246069,7 +246072,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -246092,7 +246095,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -246145,13 +246148,13 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -246191,7 +246194,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -246244,13 +246247,13 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -246290,7 +246293,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -246355,7 +246358,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -246577,10 +246580,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -246620,7 +246623,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -246684,7 +246687,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -246893,7 +246896,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -246962,10 +246965,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -247005,7 +247008,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -247061,7 +247064,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -247270,7 +247273,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -247290,7 +247293,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -247313,7 +247316,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -247367,10 +247370,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -247390,7 +247393,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -247459,7 +247462,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -247482,7 +247485,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -248116,7 +248119,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -248139,7 +248142,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -248159,7 +248162,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -249364,7 +249367,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -249404,7 +249407,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -249460,7 +249463,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -249483,10 +249486,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -249552,7 +249555,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -249575,10 +249578,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -249638,6 +249641,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -249726,7 +249730,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -252157,7 +252161,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -252177,7 +252181,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -252228,7 +252232,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -252314,10 +252318,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -252357,7 +252361,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -252427,7 +252431,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -252490,7 +252494,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -252559,10 +252563,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -252602,7 +252606,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -252658,7 +252662,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -252721,7 +252725,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -252741,7 +252745,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -252764,7 +252768,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -252818,13 +252822,13 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -252864,7 +252868,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -252942,7 +252946,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -252959,11 +252963,21 @@ }, "state": { "type": "string", - "example": "active" + "description": "The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.", + "example": "active", + "enum": [ + "active", + "pending" + ] }, "role": { "type": "string", - "example": "admin" + "description": "The user's membership type in the organization.", + "example": "admin", + "enum": [ + "admin", + "member" + ] }, "organization_url": { "type": "string", @@ -253280,7 +253294,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -253303,7 +253317,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -253323,7 +253337,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -253427,7 +253441,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -253442,11 +253456,21 @@ }, "state": { "type": "string", - "example": "active" + "description": "The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.", + "example": "active", + "enum": [ + "active", + "pending" + ] }, "role": { "type": "string", - "example": "admin" + "description": "The user's membership type in the organization.", + "example": "admin", + "enum": [ + "admin", + "member" + ] }, "organization_url": { "type": "string", @@ -253732,7 +253756,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -253809,7 +253833,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -253824,11 +253848,21 @@ }, "state": { "type": "string", - "example": "active" + "description": "The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.", + "example": "active", + "enum": [ + "active", + "pending" + ] }, "role": { "type": "string", - "example": "admin" + "description": "The user's membership type in the organization.", + "example": "admin", + "enum": [ + "admin", + "member" + ] }, "organization_url": { "type": "string", @@ -254114,7 +254148,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -254134,7 +254168,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -254248,7 +254282,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -254359,7 +254393,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -254382,7 +254416,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -254455,7 +254489,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -254711,7 +254745,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -254734,7 +254768,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -254754,7 +254788,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -254776,7 +254810,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -254855,7 +254889,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -254916,10 +254950,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -254959,7 +254993,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -255005,7 +255039,7 @@ "parameters": [ { "name": "visibility", - "description": "Can be one of `all`, `public`, or `private`.", + "description": "Can be one of `all`, `public`, or `private`. Note: For GitHub AE, can be one of `all`, `internal`, or `private`.", "in": "query", "required": false, "schema": { @@ -255030,7 +255064,7 @@ }, { "name": "type", - "description": "Can be one of `all`, `owner`, `public`, `private`, `member`. Default: `all` \n \nWill cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.", + "description": "Can be one of `all`, `owner`, `public`, `private`, `member`. Note: For GitHub AE, can be one of `all`, `owner`, `internal`, `private`, `member`. Default: `all` \n \nWill cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.", "in": "query", "required": false, "schema": { @@ -255113,7 +255147,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -256203,7 +256237,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -256272,7 +256306,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -256295,7 +256329,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -256327,7 +256361,7 @@ }, "post": { "summary": "Create a repository for the authenticated user", - "description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.21/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", + "description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.21/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository.", "tags": [ "repos" ], @@ -256358,7 +256392,7 @@ "type": "string" }, "private": { - "description": "Whether the repository is private or public.", + "description": "Whether the repository is private.", "default": false, "type": "boolean" }, @@ -256446,7 +256480,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -257547,7 +257581,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -257567,10 +257601,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -257610,7 +257644,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -257787,7 +257821,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -259703,10 +259737,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -259746,7 +259780,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -259802,7 +259836,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -259845,7 +259879,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -259865,7 +259899,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -259902,7 +259936,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "409": { "description": "Conflict", @@ -259925,10 +259959,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -260041,7 +260075,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -262242,7 +262276,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -262265,7 +262299,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -262351,7 +262385,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -262371,7 +262405,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -262435,7 +262469,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -262458,7 +262492,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -262478,7 +262512,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -262498,7 +262532,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -262542,10 +262576,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -262565,7 +262599,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -262585,7 +262619,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -262653,7 +262687,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -264279,7 +264313,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -264302,7 +264336,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -264367,7 +264401,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -264861,10 +264895,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -264949,7 +264983,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -265105,7 +265139,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -265143,7 +265177,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -265682,7 +265716,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -265755,7 +265789,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -268484,7 +268518,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -271205,7 +271239,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -273926,7 +273960,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -274135,7 +274169,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -274402,7 +274436,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -274820,7 +274854,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -274942,7 +274976,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -275223,7 +275257,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -275270,7 +275304,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -275290,7 +275324,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -275404,7 +275438,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -275948,7 +275982,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -276046,7 +276080,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -276225,7 +276259,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -276494,7 +276528,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -276516,7 +276550,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -276642,7 +276676,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -279363,7 +279397,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -282045,7 +282079,7 @@ "/users/{username}/repos": { "get": { "summary": "List repositories for a user", - "description": "Lists public repositories for the specified user.", + "description": "Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user.", "tags": [ "repos" ], @@ -282128,7 +282162,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -283793,7 +283827,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -283829,7 +283863,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -283913,7 +283947,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -286167,7 +286201,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -287828,7 +287862,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "requestBody": { @@ -287879,7 +287913,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "requestBody": { @@ -287918,7 +287952,7 @@ "operationId": "meta/get-zen", "responses": { "200": { - "description": "response", + "description": "Response", "content": { "text/plain": { "schema": { diff --git a/lib/rest/static/dereferenced/ghes-2.22.deref.json b/lib/rest/static/dereferenced/ghes-2.22.deref.json index b6920c8035..22f007f6df 100644 --- a/lib/rest/static/dereferenced/ghes-2.22.deref.json +++ b/lib/rest/static/dereferenced/ghes-2.22.deref.json @@ -134,7 +134,7 @@ ], "servers": [ { - "url": "{protocol}://{hostname}", + "url": "{protocol}://{hostname}/api/v3", "variables": { "hostname": { "description": "Self-hosted Enterprise Server or Enterprise Cloud hostname", @@ -162,7 +162,7 @@ "operationId": "meta/root", "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -394,7 +394,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -529,7 +529,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -729,7 +729,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -859,7 +859,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -1040,7 +1040,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -1092,7 +1092,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -1140,11 +1140,48 @@ "type": "integer", "default": 1 } + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "accessed" + ], + "default": "created" + } + }, + { + "name": "since", + "description": "Only show public keys accessed after the given time.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -1242,7 +1279,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -1280,7 +1317,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -1407,7 +1444,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -1460,7 +1497,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -1607,7 +1644,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -1650,7 +1687,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -1815,7 +1852,7 @@ ], "responses": { "202": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -1899,11 +1936,39 @@ "type": "integer", "default": 1 } + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -2026,7 +2091,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -2167,7 +2232,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -2279,7 +2344,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -2456,7 +2521,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "422": { "description": "Client Errors", @@ -2544,7 +2609,7 @@ ], "responses": { "202": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -2665,7 +2730,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -2746,11 +2811,40 @@ "type": "integer", "default": 1 } + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "sort", + "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to) or `name`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -2907,7 +3001,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -3130,7 +3224,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -3292,7 +3386,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -3502,7 +3596,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -3554,7 +3648,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -4264,7 +4358,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -4292,7 +4386,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -4496,7 +4590,7 @@ ], "responses": { "202": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -4572,7 +4666,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -4610,7 +4704,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -5311,7 +5405,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -5342,7 +5436,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -5671,7 +5765,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -5997,7 +6091,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -6017,7 +6111,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -6646,7 +6740,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -7134,7 +7228,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -7154,7 +7248,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -7210,10 +7304,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -7550,7 +7644,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -8740,7 +8834,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -8762,7 +8856,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -8782,7 +8876,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -8802,7 +8896,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -8907,10 +9001,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -8964,10 +9058,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -9028,11 +9122,20 @@ "type": "integer", "default": 1 } + }, + { + "name": "client_id", + "in": "query", + "required": false, + "description": "The client ID of your GitHub app.", + "schema": { + "type": "string" + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -9250,7 +9353,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -9273,7 +9376,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -9293,7 +9396,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -9352,7 +9455,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -9557,7 +9660,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -9580,7 +9683,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -9637,10 +9740,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -9663,7 +9766,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -9740,10 +9843,10 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -9856,7 +9959,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -9916,7 +10019,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -10587,7 +10690,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -10656,7 +10759,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -10728,7 +10831,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -11399,7 +11502,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -11510,7 +11613,10 @@ "type": "string", "description": "The OAuth access token used to authenticate to the GitHub API." } - } + }, + "required": [ + "access_token" + ] }, "example": { "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a" @@ -11520,10 +11626,10 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -11636,7 +11742,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -12312,7 +12418,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -12377,7 +12483,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -13093,7 +13199,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -13134,7 +13240,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -13448,7 +13554,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -13468,7 +13574,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -13531,11 +13637,20 @@ "type": "integer", "default": 1 } + }, + { + "name": "client_id", + "in": "query", + "required": false, + "description": "The client ID of your GitHub app.", + "schema": { + "type": "string" + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -14210,7 +14325,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -14233,7 +14348,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -14253,7 +14368,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -14348,7 +14463,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -15006,7 +15121,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -15095,7 +15210,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -15118,7 +15233,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -16537,7 +16652,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -16606,7 +16721,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -16629,7 +16744,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -18052,7 +18167,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -18160,7 +18275,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -18810,7 +18925,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -18833,7 +18948,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -18940,7 +19055,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -19590,7 +19705,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -19696,10 +19811,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -19722,7 +19837,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -19773,7 +19888,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -19836,10 +19951,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -19900,7 +20015,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -19953,7 +20068,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -19973,10 +20088,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -20064,7 +20179,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -20114,7 +20229,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -20183,7 +20298,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -20223,7 +20338,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -20245,7 +20360,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -20310,10 +20425,10 @@ } } }, - "description": "response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -20341,7 +20456,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -20418,7 +20533,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -20696,7 +20811,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -20874,7 +20989,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -20973,7 +21088,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -21098,7 +21213,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -21195,7 +21310,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -21261,7 +21376,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -21450,7 +21565,7 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -21507,7 +21622,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -21562,7 +21677,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -21628,7 +21743,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -21772,7 +21887,7 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -21829,7 +21944,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -21884,7 +21999,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -21941,7 +22056,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -22046,7 +22161,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -22153,7 +22268,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -23212,7 +23327,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -24280,7 +24395,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -24361,7 +24476,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -24409,7 +24524,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -27077,7 +27192,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -27100,7 +27215,7 @@ } }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -27149,7 +27264,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -27451,7 +27566,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -27869,7 +27984,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -27978,7 +28093,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -28211,7 +28326,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -28280,10 +28395,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -28377,7 +28492,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -28795,7 +28910,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -28864,7 +28979,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -28941,7 +29056,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -29359,7 +29474,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -29379,7 +29494,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -29438,7 +29553,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -29696,7 +29811,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -29716,7 +29831,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -29823,7 +29938,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -30048,7 +30163,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -30117,7 +30232,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -30171,10 +30286,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -30194,7 +30309,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -30271,7 +30386,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -30503,10 +30618,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -30600,7 +30715,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -30827,10 +30942,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -30915,7 +31030,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -31134,10 +31249,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -31253,7 +31368,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -31472,7 +31587,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -31535,13 +31650,13 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -31635,7 +31750,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -31848,7 +31963,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -31868,7 +31983,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -31945,7 +32060,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -32214,7 +32329,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -32234,7 +32349,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -32291,7 +32406,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -32704,7 +32819,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -32724,7 +32839,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -32793,7 +32908,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -32868,7 +32983,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -32925,10 +33040,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -32948,7 +33063,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -33005,13 +33120,13 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -33095,7 +33210,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -33320,7 +33435,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -33389,7 +33504,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -33457,7 +33572,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -33479,7 +33594,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -33517,7 +33632,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -33551,7 +33666,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -33599,7 +33714,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -34741,10 +34856,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -34796,7 +34911,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -34835,6 +34950,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -34955,7 +35071,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -37398,7 +37514,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -37467,10 +37583,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -37534,11 +37650,20 @@ "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", + "description": "Response", "content": { "application/json": { "schema": { @@ -37644,7 +37769,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -37682,7 +37807,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -37835,7 +37960,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -37855,7 +37980,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -37918,7 +38043,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "headers": { "Content-Type": { "example": "text/html", @@ -37948,7 +38073,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -37993,7 +38118,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "headers": { "X-CommonMarker-Version": { "example": "0.17.4", @@ -38011,7 +38136,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -38042,7 +38167,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -38075,7 +38200,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -38139,7 +38264,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -40807,7 +40932,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -40847,10 +40972,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "301": { - "description": "Moved Permanently" + "description": "Moved permanently" } }, "x-github": { @@ -40936,7 +41061,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -42595,7 +42720,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -42618,7 +42743,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -42638,7 +42763,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -42753,7 +42878,7 @@ }, "responses": { "202": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -42768,10 +42893,10 @@ } }, "205": { - "description": "response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -42794,7 +42919,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -42850,7 +42975,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -44496,7 +44621,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -44519,7 +44644,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -44573,10 +44698,10 @@ ], "responses": { "205": { - "description": "response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -44635,7 +44760,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -44700,7 +44825,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -44723,7 +44848,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -44793,7 +44918,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -44858,7 +44983,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -44881,7 +45006,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -44935,10 +45060,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -44961,7 +45086,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -45013,7 +45138,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/octocat-stream": { "schema": { @@ -45067,7 +45192,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -45178,7 +45303,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -45216,7 +45341,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -45505,7 +45630,9 @@ "plan": { "name": "Medium", "space": 400, - "private_repos": 20 + "private_repos": 20, + "filled_seats": 4, + "seats": 5 }, "default_repository_permission": "read", "members_can_create_repositories": true, @@ -45516,54 +45643,13 @@ "members_can_create_internal_repositories": false, "members_can_create_pages": true } - }, - "response-with-git-hub-plan-information": { - "summary": "Response with GitHub plan information", - "value": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization", - "name": "github", - "company": "GitHub", - "blog": "https://github.com/blog", - "location": "San Francisco", - "email": "octocat@github.com", - "twitter_username": "github", - "is_verified": true, - "has_organization_projects": true, - "has_repository_projects": true, - "public_repos": 2, - "public_gists": 1, - "followers": 20, - "following": 0, - "html_url": "https://github.com/octocat", - "created_at": "2008-01-14T04:33:35Z", - "updated_at": "2014-03-03T18:58:10Z", - "type": "Organization", - "plan": { - "name": "team", - "space": 976562499, - "private_repos": 999999, - "filled_seats": 4, - "seats": 5 - } - } } } } } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -45720,7 +45806,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -46025,7 +46111,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -46141,7 +46227,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -46220,7 +46306,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -46410,7 +46496,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -46517,7 +46603,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -46650,7 +46736,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -46755,7 +46841,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -46798,11 +46884,29 @@ "schema": { "type": "integer" } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -47987,7 +48091,7 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -48042,7 +48146,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -48095,7 +48199,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -48160,7 +48264,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -48303,7 +48407,7 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -48359,7 +48463,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -48413,7 +48517,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -48469,7 +48573,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -48577,7 +48681,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -48683,7 +48787,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -49741,7 +49845,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -50808,7 +50912,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -50888,7 +50992,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -50944,7 +51048,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -51077,7 +51181,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -51173,7 +51277,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -51279,7 +51383,8 @@ "properties": { "encrypted_value": { "type": "string", - "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/enterprise-server@2.22/rest/reference/actions#get-an-organization-public-key) endpoint." + "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/enterprise-server@2.22/rest/reference/actions#get-an-organization-public-key) endpoint.", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" }, "key_id": { "type": "string", @@ -51304,7 +51409,7 @@ } }, "example": { - "encrypted_value": "****************************************************************************************", + "encrypted_value": "c2VjcmV0", "key_id": "012345678912345678", "visibility": "selected", "selected_repository_ids": [ @@ -51365,7 +51470,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -51408,11 +51513,29 @@ "schema": { "type": "string" } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -53064,7 +53187,7 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -53234,7 +53357,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -55955,7 +56078,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -56082,7 +56205,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -56219,7 +56342,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -56341,7 +56464,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -56410,7 +56533,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -56473,7 +56596,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -56587,7 +56710,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -56714,7 +56837,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -56827,7 +56950,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -56896,7 +57019,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -56957,10 +57080,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -57023,10 +57146,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -57081,7 +57204,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -57622,7 +57745,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -58183,6 +58306,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -58271,7 +58395,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -60714,7 +60838,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -60820,7 +60944,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -60987,7 +61111,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -61157,7 +61281,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -61194,7 +61318,7 @@ "/orgs/{org}/memberships/{username}": { "get": { "summary": "Get organization membership for a user", - "description": "In order to get a user's membership with an organization, the authenticated user must be an organization member.", + "description": "In order to get a user's membership with an organization, the authenticated user must be an organization member. The `state` parameter in the response can be used to identify the user's membership status.", "tags": [ "orgs" ], @@ -61223,7 +61347,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -61238,11 +61362,21 @@ }, "state": { "type": "string", - "example": "active" + "description": "The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.", + "example": "active", + "enum": [ + "active", + "pending" + ] }, "role": { "type": "string", - "example": "admin" + "description": "The user's membership type in the organization.", + "example": "admin", + "enum": [ + "admin", + "member" + ] }, "organization_url": { "type": "string", @@ -61503,99 +61637,13 @@ "site_admin": false } } - }, - "response-if-user-has-an-active-membership-with-organization": { - "summary": "Response if user has an active membership with organization", - "value": { - "url": "https://api.github.com/orgs/octocat/memberships/defunkt", - "state": "active", - "role": "member", - "organization_url": "https://api.github.com/orgs/octocat", - "organization": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization" - }, - "user": { - "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 - } - } - }, - "response-if-user-has-a-pending-membership-with-organization": { - "summary": "Response if user has a pending membership with organization", - "value": { - "url": "https://api.github.com/orgs/invitocat/memberships/defunkt", - "state": "pending", - "role": "member", - "organization_url": "https://api.github.com/orgs/invitocat", - "organization": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization" - }, - "user": { - "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 - } - } } } } } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -61696,7 +61744,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -61711,11 +61759,21 @@ }, "state": { "type": "string", - "example": "active" + "description": "The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.", + "example": "active", + "enum": [ + "active", + "pending" + ] }, "role": { "type": "string", - "example": "admin" + "description": "The user's membership type in the organization.", + "example": "admin", + "enum": [ + "admin", + "member" + ] }, "organization_url": { "type": "string", @@ -61934,51 +61992,8 @@ ] }, "examples": { - "response-if-user-was-previously-unaffiliated-with-organization": { - "summary": "Response if user was previously unaffiliated with organization", - "value": { - "url": "https://api.github.com/orgs/invitocat/memberships/defunkt", - "state": "pending", - "role": "admin", - "organization_url": "https://api.github.com/orgs/invitocat", - "organization": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization" - }, - "user": { - "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 - } - } - }, "response-if-user-already-had-membership-with-organization": { - "summary": "Response if user already had membership with organization", + "summary": "Response if user has an active admin membership with organization", "value": { "url": "https://api.github.com/orgs/octocat/memberships/defunkt", "state": "active", @@ -62025,7 +62040,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -62155,7 +62170,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -62178,7 +62193,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -62265,7 +62280,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -62470,41 +62485,10 @@ "description": "User was converted" }, "403": { - "description": "response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - }, - "examples": { - "response-if-user-is-the-last-owner-of-the-organization": { - "summary": "Response if user is the last owner of the organization", - "value": { - "message": "Cannot convert the last owner to an outside collaborator", - "documentation_url": "https://docs.github.com/enterprise-server@2.22/rest/reference/orgs#convert-member-to-outside-collaborator" - } - }, - "response-if-user-is-not-a-member-of-the-organization": { - "summary": "Response if user is not a member of the organization", - "value": { - "message": " is not a member of the organization.", - "documentation_url": "https://docs.github.com/enterprise-server@2.22/rest/reference/orgs#convert-member-to-outside-collaborator" - } - } - } - } - } + "description": "Response if user is the last owner of the organization or not a member of the organization" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -62565,7 +62549,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "422": { "description": "Response if user is a member of the organization", @@ -62643,11 +62627,40 @@ "type": "integer", "default": 1 } + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "sort", + "description": "The sort order for the response collection.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -62737,7 +62750,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -62820,7 +62833,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -62926,7 +62939,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -63036,7 +63049,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -63305,7 +63318,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -63398,7 +63411,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -63654,7 +63667,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -63694,7 +63707,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -63734,7 +63747,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -63821,7 +63834,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -64067,7 +64080,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -64131,7 +64144,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -64168,7 +64181,7 @@ }, { "name": "type", - "description": "Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`.", + "description": "Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Note: For GitHub AE, can be one of `all`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`.", "in": "query", "required": false, "schema": { @@ -64234,7 +64247,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -65990,7 +66003,7 @@ }, "post": { "summary": "Create an organization repository", - "description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", + "description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository", "tags": [ "repos" ], @@ -66029,12 +66042,12 @@ }, "private": { "type": "boolean", - "description": "Either `true` to create a private repository or `false` to create a public one.", + "description": "Whether the repository is private.", "default": false }, "visibility": { "type": "string", - "description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", + "description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", "enum": [ "public", "private", @@ -66118,7 +66131,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -67241,7 +67254,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -67372,7 +67385,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -67668,7 +67681,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -68158,7 +68171,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -68291,7 +68304,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -68781,7 +68794,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -68890,7 +68903,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -69422,7 +69435,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -69497,11 +69510,20 @@ "type": "integer", "default": 1 } + }, + { + "name": "pinned", + "in": "query", + "required": false, + "description": "Pinned discussions only filter", + "schema": { + "type": "string" + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -69922,7 +69944,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -70309,7 +70331,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -70715,7 +70737,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -71099,7 +71121,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -71186,7 +71208,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -71570,7 +71592,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -71931,7 +71953,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -72310,7 +72332,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -72668,7 +72690,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -72768,7 +72790,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -73070,7 +73092,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -73338,7 +73360,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -73434,7 +73456,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -73728,7 +73750,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -73988,7 +74010,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -74072,7 +74094,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -74242,7 +74264,7 @@ "/orgs/{org}/teams/{team_slug}/memberships/{username}": { "get": { "summary": "Get team membership for a user", - "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.\n\n**Note:** The `role` for organization owners returns as `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@2.22/rest/reference/teams#create-a-team).", + "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.\n\n**Note:**\nThe response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see see [Create a team](https://docs.github.com/enterprise-server@2.22/rest/reference/teams#create-a-team).", "tags": [ "teams" ], @@ -74280,7 +74302,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -74303,7 +74325,12 @@ "type": "string" }, "state": { - "type": "string" + "description": "The state of the user's membership in the team.", + "type": "string", + "enum": [ + "active", + "pending" + ] } }, "required": [ @@ -74313,14 +74340,6 @@ ] }, "examples": { - "response-if-user-has-an-active-membership-with-team": { - "summary": "Response if user has an active membership with team", - "value": { - "url": "https://api.github.com/teams/1/memberships/octocat", - "role": "member", - "state": "active" - } - }, "response-if-user-is-a-team-maintainer": { "summary": "Response if user is a team maintainer", "value": { @@ -74328,14 +74347,6 @@ "role": "maintainer", "state": "active" } - }, - "response-if-user-has-a-pending-membership-with-team": { - "summary": "Response if user has a pending membership with team", - "value": { - "url": "https://api.github.com/teams/1/memberships/octocat", - "role": "member", - "state": "pending" - } } } } @@ -74415,7 +74426,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -74438,7 +74449,12 @@ "type": "string" }, "state": { - "type": "string" + "description": "The state of the user's membership in the team.", + "type": "string", + "enum": [ + "active", + "pending" + ] } }, "required": [ @@ -74448,14 +74464,6 @@ ] }, "examples": { - "response-if-users-membership-with-team-is-now-active": { - "summary": "Response if user's membership with team is now active", - "value": { - "url": "https://api.github.com/teams/1/memberships/octocat", - "role": "member", - "state": "active" - } - }, "response-if-users-membership-with-team-is-now-pending": { "summary": "Response if user's membership with team is now pending", "value": { @@ -74472,50 +74480,7 @@ "description": "Response if team synchronization is set up" }, "422": { - "description": "Response if you attempt to add an organization to a team", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "field": { - "type": "string" - }, - "resource": { - "type": "string" - } - } - } - } - } - }, - "examples": { - "response-if-you-attempt-to-add-an-organization-to-a-team": { - "value": { - "message": "Cannot add an organization as a member.", - "errors": [ - { - "code": "org", - "field": "user", - "resource": "TeamMember" - } - ] - } - } - } - } - } + "description": "Response if you attempt to add an organization to a team" } }, "x-github": { @@ -74568,7 +74533,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Response if team synchronization is set up" @@ -74636,7 +74601,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -74956,7 +74921,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -75285,7 +75250,7 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Response if the project is not owned by the organization", @@ -75368,7 +75333,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -75433,7 +75398,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -79177,7 +79142,7 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -79238,7 +79203,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -79530,7 +79495,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -79757,7 +79722,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -79780,7 +79745,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -79800,7 +79765,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -79880,7 +79845,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -80107,7 +80072,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -80130,7 +80095,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -80150,7 +80115,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -80170,7 +80135,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -80238,10 +80203,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -80268,7 +80233,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -80288,7 +80253,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -80373,7 +80338,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -80386,7 +80351,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -80427,7 +80392,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -80447,7 +80412,7 @@ } }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -80482,7 +80447,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -80591,7 +80556,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -80668,7 +80633,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -80691,7 +80656,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -80711,7 +80676,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -80788,7 +80753,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -80865,7 +80830,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -80888,7 +80853,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -80946,10 +80911,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -80972,7 +80937,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -81065,7 +81030,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -81305,7 +81270,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -81328,7 +81293,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -81429,7 +81394,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -81656,7 +81621,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -81679,7 +81644,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -81699,7 +81664,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -81795,7 +81760,7 @@ } }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -81890,7 +81855,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -81903,7 +81868,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -81926,7 +81891,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -81956,7 +81921,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -82015,7 +81980,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -82271,7 +82236,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -82294,7 +82259,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -82392,7 +82357,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -82651,7 +82616,7 @@ "description": "Response if the authenticated user does not have access to the project" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -82678,7 +82643,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -82718,7 +82683,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -82788,7 +82753,7 @@ "description": "Delete Success" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -82815,7 +82780,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -82855,7 +82820,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -82947,7 +82912,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -83103,7 +83068,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -83123,7 +83088,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -83145,7 +83110,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -83214,7 +83179,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -83237,7 +83202,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -83326,10 +83291,10 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -83349,7 +83314,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -83371,7 +83336,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -83440,7 +83405,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -83463,7 +83428,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -83528,13 +83493,13 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -83554,7 +83519,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -83596,7 +83561,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -83665,7 +83630,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -83732,7 +83697,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -83897,7 +83862,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -83917,7 +83882,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -83939,7 +83904,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -84008,7 +83973,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -84031,7 +83996,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -84108,7 +84073,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -84198,7 +84163,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -84221,7 +84186,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -84297,7 +84262,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -84370,7 +84335,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -84393,7 +84358,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -84423,7 +84388,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -84475,7 +84440,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -84701,10 +84666,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -84759,10 +84724,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -84785,7 +84750,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -84825,7 +84790,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -84897,7 +84862,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -89609,7 +89574,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -89629,7 +89594,7 @@ } }, "301": { - "description": "Moved Permanently" + "description": "Moved permanently" } }, "x-github": { @@ -89778,7 +89743,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -93978,7 +93943,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -94047,7 +94012,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -94117,7 +94082,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "If an organization owner has configured the organization to prevent members from deleting organization-owned repositories, a member will get this response:", @@ -94142,7 +94107,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -94223,7 +94188,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -94401,7 +94366,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -94537,7 +94502,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -94600,7 +94565,7 @@ ], "responses": { "302": { - "description": "response", + "description": "Response", "headers": { "Location": { "example": "https://pipelines.actions.githubusercontent.com/OhgS4QRKqmgx7bKC27GKU83jnQjyeqG8oIMTge8eqtheppcmw8/_apis/pipelines/1/runs/176/signedlogcontent?urlExpires=2020-01-24T18%3A10%3A31.5729946Z&urlSigningMethod=HMACV1&urlSignature=agG73JakPYkHrh06seAkvmH7rBR4Ji4c2%2B6a2ejYh3E%3D", @@ -94663,7 +94628,7 @@ ], "responses": { "202": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -94969,7 +94934,7 @@ ], "responses": { "302": { - "description": "response", + "description": "Response", "headers": { "Location": { "example": "https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/jobs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D", @@ -95041,7 +95006,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -95157,7 +95122,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -95271,7 +95236,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -96337,7 +96302,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -97412,7 +97377,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -97500,7 +97465,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -97615,7 +97580,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -101149,7 +101114,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -104653,7 +104618,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -104726,7 +104691,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -104904,7 +104869,7 @@ ], "responses": { "202": { - "description": "response" + "description": "Response" } }, "x-github": { @@ -104991,7 +104956,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -105325,7 +105290,7 @@ ], "responses": { "302": { - "description": "response", + "description": "Response", "headers": { "Location": { "example": "https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/runs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D", @@ -105386,7 +105351,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -105441,7 +105406,7 @@ ], "responses": { "201": { - "description": "response" + "description": "Response" } }, "x-github": { @@ -105505,7 +105470,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -105622,7 +105587,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -105726,7 +105691,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -105823,7 +105788,8 @@ "properties": { "encrypted_value": { "type": "string", - "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/enterprise-server@2.22/rest/reference/actions#get-a-repository-public-key) endpoint." + "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/enterprise-server@2.22/rest/reference/actions#get-a-repository-public-key) endpoint.", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" }, "key_id": { "type": "string", @@ -105832,7 +105798,7 @@ } }, "example": { - "encrypted_value": "****************************************************************************************", + "encrypted_value": "c2VjcmV0", "key_id": "012345678912345678" } } @@ -105896,7 +105862,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -105960,7 +105926,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -106152,7 +106118,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -106304,7 +106270,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "requestBody": { @@ -106468,7 +106434,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -110011,7 +109977,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -110167,7 +110133,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -110331,7 +110297,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -111057,18 +111023,6 @@ }, "examples": { "default": { - "value": [ - { - "name": "master", - "commit": { - "sha": "c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc", - "url": "https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc" - }, - "protected": true - } - ] - }, - "with-protection": { "value": [ { "name": "master", @@ -111104,7 +111058,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -111177,7 +111131,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -112495,7 +112449,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -112517,7 +112471,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -112590,7 +112544,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -113436,7 +113390,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -113675,7 +113629,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -114406,7 +114360,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -114428,7 +114382,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -114458,7 +114412,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -114533,7 +114487,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -114609,7 +114563,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -114695,7 +114649,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -114784,7 +114738,7 @@ "description": "No Content" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -114857,7 +114811,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/vnd.github.luke-cage-preview+json": { "schema": { @@ -115336,7 +115290,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -115704,7 +115658,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -115831,7 +115785,7 @@ "description": "No Content" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -115904,7 +115858,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -115939,7 +115893,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -116014,7 +115968,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -116049,7 +116003,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -116127,7 +116081,7 @@ "description": "No Content" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -116204,7 +116158,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -116259,7 +116213,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -116358,7 +116312,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -116413,7 +116367,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -116433,7 +116387,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -116609,7 +116563,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -116625,7 +116579,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -116722,7 +116676,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -116739,7 +116693,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -116828,7 +116782,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -116926,7 +116880,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -116942,7 +116896,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -117011,7 +116965,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -117109,7 +117063,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -117125,7 +117079,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -117145,7 +117099,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -117268,7 +117222,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -117639,7 +117593,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -117766,7 +117720,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -118065,7 +118019,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -118162,7 +118116,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -118461,7 +118415,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -118608,7 +118562,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -118907,7 +118861,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -119054,7 +119008,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -119353,7 +119307,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -119476,7 +119430,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -119647,7 +119601,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -119744,7 +119698,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -119915,7 +119869,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -120062,7 +120016,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -120233,7 +120187,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -120380,7 +120334,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -120551,7 +120505,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -120674,7 +120628,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -120822,7 +120776,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -120919,7 +120873,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -121067,7 +121021,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -121214,7 +121168,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -121362,7 +121316,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -121509,7 +121463,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -121657,7 +121611,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -121964,7 +121918,7 @@ "name", "head_sha" ], - "anyOf": [ + "oneOf": [ { "properties": { "status": { @@ -121974,6 +121928,7 @@ } }, "required": [ + "status", "conclusion" ], "additionalProperties": true @@ -121993,7 +121948,7 @@ }, "examples": { "example-of-in-progress-conclusion": { - "summary": "Example of in_progress conclusion", + "summary": "Response for in_progress conclusion", "value": { "name": "mighty_readme", "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -122008,7 +121963,7 @@ } }, "example-of-completed-conclusion": { - "summary": "Example of completed conclusion", + "summary": "Response for completed conclusion", "value": { "name": "mighty_readme", "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -122062,7 +122017,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -122878,101 +122833,8 @@ ] }, "examples": { - "example-of-in-progress-conclusion": { - "summary": "Example of in_progress conclusion", - "value": { - "id": 4, - "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", - "node_id": "MDg6Q2hlY2tSdW40", - "external_id": "42", - "url": "https://api.github.com/repos/github/hello-world/check-runs/4", - "html_url": "https://github.com/github/hello-world/runs/4", - "details_url": "https://example.com", - "status": "in_progress", - "conclusion": "neutral", - "started_at": "2018-05-04T01:14:52Z", - "completed_at": null, - "output": { - "title": "Mighty Readme Report", - "summary": "", - "text": "", - "annotations_count": 1, - "annotations_url": "https://api.github.com/repos/github/hello-world/check-runs/4/annotations" - }, - "name": "mighty_readme", - "check_suite": { - "id": 5 - }, - "app": { - "id": 1, - "slug": "octoapp", - "node_id": "MDExOkludGVncmF0aW9uMQ==", - "owner": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "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", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": true - }, - "name": "Octocat App", - "description": "", - "external_url": "https://example.com", - "html_url": "https://github.com/apps/octoapp", - "created_at": "2017-07-08T16:18:44-04:00", - "updated_at": "2017-07-08T16:18:44-04:00", - "permissions": { - "metadata": "read", - "contents": "read", - "issues": "write", - "single_file": "write" - }, - "events": [ - "push", - "pull_request" - ] - }, - "pull_requests": [ - { - "url": "https://api.github.com/repos/github/hello-world/pulls/1", - "id": 1934, - "number": 3956, - "head": { - "ref": "say-hello", - "sha": "3dca65fa3e8d4b3da3f3d056c59aee1c50f41390", - "repo": { - "id": 526, - "url": "https://api.github.com/repos/github/hello-world", - "name": "hello-world" - } - }, - "base": { - "ref": "master", - "sha": "e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f", - "repo": { - "id": 526, - "url": "https://api.github.com/repos/github/hello-world", - "name": "hello-world" - } - } - } - ] - } - }, "example-of-completed-conclusion": { - "summary": "Example of completed conclusion", + "summary": "Response for completed conclusion", "value": { "id": 4, "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -123125,7 +122987,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -124346,7 +124208,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -125333,7 +125195,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -125501,7 +125363,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -127890,7 +127752,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -129089,7 +128951,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -131501,7 +131363,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -132498,7 +132360,7 @@ ], "responses": { "201": { - "description": "response" + "description": "Response" } }, "x-github": { @@ -132519,7 +132381,7 @@ "/repos/{owner}/{repo}/code-scanning/alerts": { "get": { "summary": "List code scanning alerts for a repository", - "description": "Lists all open code scanning alerts for the default branch (usually `main`\nor `master`). You must use an access token with the `security_events` scope to use\nthis endpoint. GitHub Apps must have the `security_events` read permission to use\nthis endpoint.\n\nThe response includes a `most_recent_instance` object.\nThis provides details of the most recent instance of this alert\nfor the the default branch or for the specified Git reference\n(if you used `ref` in the request).", + "description": "Lists all open code scanning alerts for the default branch (usually `main`\nor `master`). You must use an access token with the `security_events` scope to use\nthis endpoint. GitHub Apps must have the `security_events` read permission to use\nthis endpoint.\n\nThe response includes a `most_recent_instance` object.\nThis provides details of the most recent instance of this alert\nfor the default branch or for the specified Git reference\n(if you used `ref` in the request).", "tags": [ "code-scanning" ], @@ -132591,7 +132453,7 @@ "required": false, "schema": { "type": "string", - "description": "The full Git reference, formatted as `refs/heads/`." + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." } }, { @@ -132604,6 +132466,7 @@ "description": "State of a code scanning alert.", "enum": [ "open", + "closed", "dismissed", "fixed" ] @@ -132612,7 +132475,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -132659,6 +132522,7 @@ "description": "State of a code scanning alert.", "enum": [ "open", + "closed", "dismissed", "fixed" ] @@ -132854,7 +132718,7 @@ "properties": { "ref": { "type": "string", - "description": "The full Git reference, formatted as `refs/heads/`." + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." }, "analysis_key": { "type": "string", @@ -132869,6 +132733,7 @@ "description": "State of a code scanning alert.", "enum": [ "open", + "closed", "dismissed", "fixed" ] @@ -133075,7 +132940,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -133095,7 +132960,7 @@ } }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -133171,7 +133036,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -133216,6 +133081,7 @@ "description": "State of a code scanning alert.", "enum": [ "open", + "closed", "dismissed", "fixed" ] @@ -133426,7 +133292,7 @@ "properties": { "ref": { "type": "string", - "description": "The full Git reference, formatted as `refs/heads/`." + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." }, "analysis_key": { "type": "string", @@ -133441,6 +133307,7 @@ "description": "State of a code scanning alert.", "enum": [ "open", + "closed", "dismissed", "fixed" ] @@ -133608,7 +133475,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -133628,7 +133495,7 @@ } }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -133747,7 +133614,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -133792,6 +133659,7 @@ "description": "State of a code scanning alert.", "enum": [ "open", + "closed", "dismissed", "fixed" ] @@ -134002,7 +133870,7 @@ "properties": { "ref": { "type": "string", - "description": "The full Git reference, formatted as `refs/heads/`." + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." }, "analysis_key": { "type": "string", @@ -134017,6 +133885,7 @@ "description": "State of a code scanning alert.", "enum": [ "open", + "closed", "dismissed", "fixed" ] @@ -134184,7 +134053,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -134204,7 +134073,7 @@ } }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -134310,7 +134179,7 @@ "required": false, "schema": { "type": "string", - "description": "The full Git reference, formatted as `refs/heads/`." + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." } }, { @@ -134328,7 +134197,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -134338,7 +134207,7 @@ "properties": { "ref": { "type": "string", - "description": "The full Git reference, formatted as `refs/heads/`." + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." }, "commit_sha": { "description": "The SHA of the commit to which the analysis you are uploading relates.", @@ -134499,7 +134368,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -134519,7 +134388,7 @@ } }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -134553,7 +134422,7 @@ "/repos/{owner}/{repo}/code-scanning/sarifs": { "post": { "summary": "Upload an analysis as SARIF data", - "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint.\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64\n```\n\nSARIF upload supports a maximum of 1000 results per analysis run. Any results over this limit are ignored. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.\n\nThe `202 Accepted`, response includes an `id` value.\nYou can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload).\"", + "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint.\n\nThere are two places where you can upload code scanning results.\n - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see \"[Triaging code scanning alerts in pull requests](/github/finding-security-vulnerabilities-and-errors-in-your-code/triaging-code-scanning-alerts-in-pull-requests).\"\n - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see \"[Managing code scanning alerts for your repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository).\"\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64\n```\n\nSARIF upload supports a maximum of 1000 results per analysis run. Any results over this limit are ignored. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.\n\nThe `202 Accepted`, response includes an `id` value.\nYou can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload).\"", "operationId": "code-scanning/upload-sarif", "tags": [ "code-scanning" @@ -134595,7 +134464,7 @@ }, "ref": { "type": "string", - "description": "The full Git reference, formatted as `refs/heads/`." + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." }, "sarif": { "description": "A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using [`gzip`](http://www.gnu.org/software/gzip/manual/gzip.html) and then translate the contents of the file into a Base64 encoding string. For more information, see \"[SARIF support for code scanning](https://docs.github.com/enterprise-server@2.22/github/finding-security-vulnerabilities-and-errors-in-your-code/sarif-support-for-code-scanning).\"", @@ -134628,7 +134497,7 @@ }, "responses": { "202": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -134685,7 +134554,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -134708,7 +134577,7 @@ "description": "Response if the sarif field is too large" }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -134804,7 +134673,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -134979,7 +134848,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -137038,7 +136907,7 @@ "description": "Response when person is already a collaborator" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -137177,7 +137046,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -137396,7 +137265,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -137477,7 +137346,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -137835,7 +137704,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -138124,7 +137993,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -138219,7 +138088,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -138508,7 +138377,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -138578,10 +138447,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -138690,7 +138559,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -138899,7 +138768,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -138919,7 +138788,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -139418,7 +139287,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -139440,7 +139309,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -139573,7 +139442,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -139682,11 +139551,31 @@ "type": "integer", "default": 1 } + }, + { + "name": "top", + "description": "legacy parameter for pagination.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "last_sha", + "description": "legacy parameter for pagination.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -140339,7 +140228,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -140432,7 +140321,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -140489,7 +140378,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -140511,7 +140400,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -140655,7 +140544,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -141048,7 +140937,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -141365,7 +141254,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -141506,7 +141395,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -145336,7 +145225,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -145402,9 +145291,27 @@ "type": "string" } }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -145415,7 +145322,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -145998,7 +145905,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -146067,7 +145974,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -146149,7 +146056,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -146211,11 +146118,19 @@ "type": "integer", "default": 1 } + }, + { + "name": "app_id", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -147202,7 +147117,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -147250,7 +147165,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -149504,18 +149419,36 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true + }, + { + "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", + "description": "Response", "content": { "application/json": { "schema": { @@ -151210,7 +151143,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -151272,7 +151205,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -151301,7 +151234,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -151520,7 +151453,7 @@ } }, "301": { - "description": "Moved Permanently" + "description": "Moved permanently" } }, "x-github": { @@ -151582,7 +151515,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -153445,7 +153378,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -153507,7 +153440,7 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { @@ -153527,7 +153460,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/vnd.github.v3.object": { "schema": { @@ -154139,7 +154072,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -154222,7 +154155,7 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { @@ -154333,7 +154266,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -154549,7 +154482,7 @@ } }, "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -154765,7 +154698,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -154785,7 +154718,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -154914,7 +154847,7 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { @@ -154988,7 +154921,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -155189,7 +155122,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -155258,7 +155191,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -155298,7 +155231,7 @@ } }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -155540,7 +155473,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -155637,7 +155570,8 @@ "required": false, "schema": { "type": "string", - "default": "none" + "default": "none", + "nullable": true } }, { @@ -155661,7 +155595,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -156328,7 +156262,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -156837,48 +156771,6 @@ "transient_environment": false, "production_environment": true } - }, - "advanced-example": { - "summary": "Advanced example", - "value": { - "url": "https://api.github.com/repos/octocat/example/deployments/1", - "id": 1, - "node_id": "MDEwOkRlcGxveW1lbnQx", - "sha": "a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d", - "ref": "topic-branch", - "task": "deploy", - "payload": { - }, - "original_environment": "staging", - "environment": "production", - "description": "Deploy request from hubot", - "creator": { - "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 - }, - "created_at": "2012-07-20T01:19:13Z", - "updated_at": "2012-07-20T01:19:13Z", - "statuses_url": "https://api.github.com/repos/octocat/example/deployments/1/statuses", - "repository_url": "https://api.github.com/repos/octocat/example", - "transient_environment": false, - "production_environment": true - } } } } @@ -156907,40 +156799,10 @@ } }, "409": { - "description": "response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string", - "example": "\"https://docs.github.com/enterprise-server@2.22/rest/reference/repos#create-a-deployment\"" - } - } - }, - "examples": { - "merge-conflict-response": { - "summary": "Merge conflict response", - "value": { - "message": "Conflict merging master into topic-branch" - } - }, - "failed-commit-status-checks": { - "summary": "Failed commit status checks", - "value": { - "message": "Conflict: Commit status checks failed for topic-branch." - } - } - } - } - } + "description": "Response when there is a merge conflict or the commit's status checks failed" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -157065,7 +156927,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -157579,7 +157441,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -157653,10 +157515,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -157676,7 +157538,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -157776,7 +157638,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -158300,7 +158162,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -158445,7 +158307,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -158964,7 +158826,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -159102,7 +158964,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -159613,7 +159475,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -159633,7 +159495,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -159737,10 +159599,10 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -159870,7 +159732,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -162588,7 +162450,8 @@ "enum": [ "newest", "oldest", - "stargazers" + "stargazers", + "watchers" ], "default": "newest" } @@ -162610,11 +162473,31 @@ "type": "integer", "default": 1 } + }, + { + "name": "org", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "organization", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -164330,6 +164213,26 @@ "schema": { "type": "string" } + }, + { + "name": "org", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "organization", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } } ], "requestBody": { @@ -164337,6 +164240,7 @@ "application/json": { "schema": { "type": "object", + "nullable": true, "properties": { "organization": { "type": "string", @@ -164349,7 +164253,7 @@ }, "responses": { "202": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -165498,7 +165402,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -165587,7 +165491,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -165677,7 +165581,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -165717,7 +165621,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -165777,7 +165681,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -165897,7 +165801,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -165954,7 +165858,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -165974,7 +165878,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -166189,7 +166093,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -166405,7 +166309,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -166474,7 +166378,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -166547,7 +166451,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -166755,7 +166659,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -166817,7 +166721,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -166846,7 +166750,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -166979,7 +166883,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -166990,7 +166894,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -167058,7 +166962,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -167152,7 +167056,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -167228,7 +167132,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -167339,7 +167243,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -167377,7 +167281,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -167445,7 +167349,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -167554,7 +167458,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -167565,10 +167469,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -167747,7 +167651,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -167894,7 +167798,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -168014,7 +167918,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -168153,7 +168057,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -168287,7 +168191,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -168415,7 +168319,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -168484,7 +168388,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -168570,7 +168474,8 @@ "required": true, "schema": { "type": "string" - } + }, + "x-multi-segment": true }, { "name": "recursive", @@ -168584,7 +168489,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -168738,7 +168643,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -168807,7 +168712,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -168888,7 +168793,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -169085,7 +168990,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -169230,7 +169135,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -169422,7 +169327,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -169442,7 +169347,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -169582,7 +169487,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -169766,7 +169671,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -169919,7 +169824,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -170103,7 +170008,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -170172,7 +170077,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -170241,10 +170146,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -170315,10 +170220,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -170389,10 +170294,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -170455,7 +170360,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -170943,10 +170848,10 @@ } }, "301": { - "description": "Moved Permanently" + "description": "Moved permanently" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -171027,7 +170932,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -173017,7 +172922,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -174971,7 +174876,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -175133,7 +175038,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -177303,10 +177208,10 @@ } }, "301": { - "description": "Moved Permanently" + "description": "Moved permanently" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -177375,7 +177280,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -177534,7 +177439,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -179890,7 +179795,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -179959,7 +179864,7 @@ } }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -179980,7 +179885,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -180118,7 +180023,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -180663,7 +180568,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -180732,7 +180637,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -180808,7 +180713,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -181340,7 +181245,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -181435,7 +181340,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -181967,7 +181872,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -182086,7 +181991,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -182178,7 +182083,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -182387,7 +182292,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -182407,7 +182312,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -182906,7 +182811,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -182928,7 +182833,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -183061,7 +182966,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -183129,7 +183034,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -186231,7 +186136,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -186355,7 +186260,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -189444,7 +189349,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -189560,7 +189465,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -191888,10 +191793,10 @@ } }, "301": { - "description": "Moved Permanently" + "description": "Moved permanently" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -191931,7 +191836,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -192090,7 +191995,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -194418,7 +194323,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -194487,7 +194392,7 @@ } }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -194528,10 +194433,10 @@ } }, "301": { - "description": "Moved Permanently" + "description": "Moved permanently" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -194647,7 +194552,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -196918,7 +196823,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -199194,7 +199099,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -199739,7 +199644,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -199854,7 +199759,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -200434,7 +200339,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -200503,7 +200408,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -200594,7 +200499,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -200947,7 +200852,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -201135,7 +201040,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -201238,7 +201143,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -201381,7 +201286,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -201484,7 +201389,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -201603,7 +201508,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "410": { "description": "Gone", @@ -201686,7 +201591,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -201760,7 +201665,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -201874,7 +201779,7 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -201917,7 +201822,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -201937,7 +201842,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -202056,7 +201961,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -202079,7 +201984,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -202188,7 +202093,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -202397,7 +202302,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -202437,7 +202342,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -202544,7 +202449,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -202740,7 +202645,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -202762,7 +202667,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -202895,7 +202800,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -202972,7 +202877,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -203231,7 +203136,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -203271,7 +203176,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -203363,7 +203268,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -203505,7 +203410,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -203570,7 +203475,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -203691,7 +203596,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -203748,7 +203653,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -203818,7 +203723,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -203882,7 +203787,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -203973,7 +203878,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -204065,7 +203970,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -204142,7 +204047,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -204211,7 +204116,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -204282,7 +204187,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -204351,7 +204256,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -204448,7 +204353,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -204566,7 +204471,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -204612,7 +204517,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -204678,7 +204583,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -205504,63 +205409,10 @@ } }, "404": { - "description": "response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string", - "example": "\"https://docs.github.com/enterprise-server@2.22/rest/reference/repos#perform-a-merge\"" - } - } - }, - "examples": { - "missing-base-response": { - "summary": "Missing base response", - "value": { - "message": "Base does not exist" - } - }, - "missing-head-response": { - "summary": "Missing head response", - "value": { - "message": "Head does not exist" - } - } - } - } - } + "description": "Response when the base or head does not exist" }, "409": { - "description": "Merge conflict response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string", - "example": "\"https://docs.github.com/enterprise-server@2.22/rest/reference/repos#perform-a-merge\"" - } - } - }, - "examples": { - "merge-conflict-response": { - "value": { - "message": "Merge Conflict" - } - } - } - } - } + "description": "Response when there is a merge conflict" }, "403": { "description": "Forbidden", @@ -205583,7 +205435,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -205756,7 +205608,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -206037,7 +205889,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -206139,7 +205991,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -206415,7 +206267,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -206435,7 +206287,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -206556,7 +206408,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -206824,7 +206676,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -206932,7 +206784,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -207250,10 +207102,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -207343,7 +207195,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -207533,7 +207385,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -209248,7 +209100,7 @@ }, "responses": { "202": { - "description": "response" + "description": "Response" } }, "x-github": { @@ -209294,7 +209146,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -209387,7 +209239,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -209491,7 +209343,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -209584,7 +209436,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -209653,7 +209505,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -209805,10 +209657,10 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -209972,10 +209824,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -210044,7 +209896,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -210066,7 +209918,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -210151,7 +210003,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -210414,7 +210266,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -210492,7 +210344,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -210752,7 +210604,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -211018,11 +210870,39 @@ "type": "integer", "default": 1 } + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -211116,7 +210996,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -211203,7 +211083,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -211422,7 +211302,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -211691,7 +211571,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -211731,7 +211611,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -211771,7 +211651,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -211872,7 +211752,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -212128,7 +212008,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -212168,7 +212048,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -212208,7 +212088,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -212365,7 +212245,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -216195,10 +216075,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -216357,7 +216237,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -219388,7 +219268,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -219500,16 +219380,15 @@ }, { "name": "sort", - "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to).", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "created", - "updated" - ], - "default": "created" + "updated", + "created_at" + ] } }, { @@ -219555,7 +219434,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -220081,7 +219960,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -220533,7 +220412,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -220633,7 +220512,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -221139,10 +221018,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -221251,7 +221130,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -221460,7 +221339,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -221480,7 +221359,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -221979,7 +221858,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -222001,7 +221880,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -222134,7 +222013,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -225195,7 +225074,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "500": { "description": "Internal Error", @@ -225218,7 +225097,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -225328,7 +225207,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -228331,7 +228210,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -228525,7 +228404,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -229131,7 +229010,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -229591,7 +229470,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -229766,7 +229645,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -230226,7 +230105,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -230316,7 +230195,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -230964,7 +230843,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -231065,7 +230944,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -231380,7 +231259,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -231469,7 +231348,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -231559,7 +231438,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -231921,7 +231800,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -235889,10 +235768,10 @@ }, "responses": { "200": { - "description": "response" + "description": "Response" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -236449,7 +236328,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -236725,7 +236604,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -236836,7 +236715,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -237112,7 +236991,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -237211,7 +237090,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -237487,7 +237366,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -237575,7 +237454,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -237851,7 +237730,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -237881,7 +237760,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -237979,7 +237858,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -238380,7 +238259,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -238482,7 +238361,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -238758,7 +238637,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -238778,7 +238657,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -238895,7 +238774,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -239171,7 +239050,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -239191,7 +239070,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -239311,7 +239190,7 @@ }, "responses": { "202": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -239333,7 +239212,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -239422,7 +239301,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -239498,6 +239377,279 @@ } } ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Content File", + "description": "Content File", + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "encoding": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "path": { + "type": "string" + }, + "content": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "git_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "download_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "_links": { + "type": "object", + "properties": { + "git": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html": { + "type": "string", + "format": "uri", + "nullable": true + }, + "self": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "git", + "html", + "self" + ] + }, + "target": { + "type": "string", + "example": "\"actual/actual.md\"" + }, + "submodule_git_url": { + "type": "string", + "example": "\"git://example.com/defunkt/dotjs.git\"" + } + }, + "required": [ + "_links", + "git_url", + "html_url", + "download_url", + "name", + "path", + "sha", + "size", + "type", + "url", + "content", + "encoding" + ] + }, + "examples": { + "default": { + "value": { + "type": "file", + "encoding": "base64", + "size": 5362, + "name": "README.md", + "path": "README.md", + "content": "encoded content ...", + "sha": "3d21ec53a331a6f037a91c368710b99387d012c1", + "url": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md", + "git_url": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1", + "html_url": "https://github.com/octokit/octokit.rb/blob/master/README.md", + "download_url": "https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md", + "_links": { + "git": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1", + "self": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md", + "html": "https://github.com/octokit/octokit.rb/blob/master/README.md" + } + } + } + } + } + } + }, + "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" + } + } + } + } + } + }, + "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" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "repos", + "subcategory": "contents" + } + } + }, + "/repos/{owner}/{repo}/readme/{dir}": { + "get": { + "summary": "Get a repository README", + "description": "Gets the preferred README for a repository.\n\nREADMEs support [custom media types](https://docs.github.com/enterprise-server@2.22/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML.", + "tags": [ + "repos" + ], + "operationId": "repos/get-readme-from-alt-path", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@2.22/rest/reference/repos#get-a-repository-readme" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "dir", + "description": "The alternate path to look for a README file", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + }, + { + "name": "ref", + "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], "responses": { "200": { "description": "response", @@ -239622,7 +239774,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -239642,7 +239794,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -239772,7 +239924,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -240272,7 +240424,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -240381,7 +240533,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -240876,7 +241028,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -241230,7 +241382,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -241250,7 +241402,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -241352,7 +241504,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -241634,7 +241786,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -241680,7 +241832,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -242209,7 +242361,7 @@ }, { "name": "tag", - "description": "tag+ parameter", + "description": "tag parameter", "in": "path", "required": true, "schema": { @@ -242220,7 +242372,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -242707,7 +242859,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -243266,7 +243418,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -243379,7 +243531,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -243916,7 +244068,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -243989,7 +244141,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -244612,7 +244764,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -244936,7 +245088,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -245120,7 +245272,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -245621,7 +245773,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -245818,7 +245970,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -246093,7 +246245,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -246437,7 +246589,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -246540,7 +246692,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -246604,7 +246756,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -246736,7 +246888,7 @@ ], "responses": { "302": { - "description": "response", + "description": "Response", "headers": { "Location": { "example": "https://codeload.github.com/me/myprivate/legacy.zip/master?login=me&token=thistokenexpires", @@ -246808,7 +246960,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -247026,11 +247178,29 @@ "schema": { "type": "string" } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -247065,7 +247235,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -247087,7 +247257,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -247181,7 +247351,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -247216,7 +247386,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -247238,7 +247408,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -247258,7 +247428,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -247367,7 +247537,7 @@ }, "responses": { "202": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -248505,7 +248675,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -248553,7 +248723,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -248611,7 +248781,7 @@ ], "responses": { "302": { - "description": "response", + "description": "Response", "headers": { "Location": { "example": "https://codeload.github.com/me/myprivate/legacy.zip/master?login=me&token=thistokenexpires", @@ -248636,7 +248806,7 @@ "/repos/{template_owner}/{template_repo}/generate": { "post": { "summary": "Create a repository using a template", - "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@2.22/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", + "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@2.22/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository", "tags": [ "repos" ], @@ -248708,7 +248878,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -249822,7 +249992,7 @@ "/repositories": { "get": { "summary": "List public repositories", - "description": "Lists all public repositories in the order that they were created.\n\nNote: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@2.22/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.", + "description": "Lists all public repositories in the order that they were created.\n\nNotes:\n- For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise.\n- Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@2.22/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.", "tags": [ "repos" ], @@ -249843,7 +250013,7 @@ }, { "name": "visibility", - "description": "Specifies the types of repositories to return. Can be one of `all` or `public`. Default: `public`.", + "description": "Specifies the types of repositories to return. Can be one of `all` or `public`. Default: `public`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise.", "in": "query", "required": false, "schema": { @@ -249859,7 +250029,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -251439,7 +251609,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -251508,7 +251678,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -251591,7 +251761,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -253291,10 +253461,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -253315,7 +253485,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -253485,7 +253655,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -255478,10 +255648,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -255597,7 +255767,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -257743,7 +257913,7 @@ } }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -257764,7 +257934,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -257833,7 +258003,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -257928,7 +258098,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -258066,10 +258236,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -258109,7 +258279,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -258261,7 +258431,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -258970,7 +259140,7 @@ } }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -258991,7 +259161,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -259060,7 +259230,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -259103,7 +259273,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -259377,10 +259547,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -259488,7 +259658,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -259732,10 +259902,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -259756,7 +259926,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -259850,7 +260020,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -259937,7 +260107,7 @@ }, "responses": { "202": { - "description": "response" + "description": "Response" } }, "x-github": { @@ -259965,7 +260135,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -260046,7 +260216,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -260147,7 +260317,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -260756,7 +260926,7 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "requestBody": { @@ -260802,7 +260972,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -260864,7 +261034,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -260944,7 +261114,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -261026,7 +261196,7 @@ }, "responses": { "202": { - "description": "response" + "description": "Response" } }, "requestBody": { @@ -261080,7 +261250,7 @@ }, "responses": { "202": { - "description": "response" + "description": "Response" } }, "requestBody": { @@ -261133,7 +261303,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -261623,7 +261793,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -261729,7 +261899,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -262219,7 +262389,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -262239,7 +262409,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -262364,10 +262534,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -262387,7 +262557,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -262526,7 +262696,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -262941,7 +263111,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -263322,7 +263492,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -263722,7 +263892,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -264100,7 +264270,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -264181,7 +264351,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -264559,7 +264729,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -264914,7 +265084,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -265287,7 +265457,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -265639,7 +265809,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -265733,7 +265903,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -266029,7 +266199,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -266312,7 +266482,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -266600,7 +266770,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -266871,7 +267041,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -267027,7 +267197,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -267143,74 +267313,13 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { "description": "Response if team synchronization is set up" }, "422": { - "description": "response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "field": { - "type": "string" - }, - "resource": { - "type": "string" - } - } - } - }, - "documentation_url": { - "type": "string", - "example": "\"https://docs.github.com/enterprise-server@2.22/rest\"" - } - } - }, - "examples": { - "response-if-you-attempt-to-add-an-organization-to-a-team": { - "summary": "Response if you attempt to add an organization to a team", - "value": { - "message": "Cannot add an organization as a member.", - "errors": [ - { - "code": "org", - "field": "user", - "resource": "TeamMember" - } - ] - } - }, - "response-if-you-attempt-to-add-a-user-to-a-team-when-they-are-not-a-member-of-at-least-one-other-team-in-the-same-organization": { - "summary": "Response if you attempt to add a user to a team when they are not a member of at least one other team in the same organization", - "value": { - "message": "User isn't a member of this organization. Please invite them first.", - "errors": [ - { - "code": "unaffiliated", - "field": "user", - "resource": "TeamMember" - } - ] - } - } - } - } - } + "description": "Response if you attempt to add an organization to a team or you attempt to add a user to a team when they are not a member of at least one other team in the same organization" }, "403": { "description": "Forbidden", @@ -267277,7 +267386,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { "description": "Response if team synchronization is setup" @@ -267300,7 +267409,7 @@ "/teams/{team_id}/memberships/{username}": { "get": { "summary": "Get team membership for a user (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 [Get team membership for a user](https://docs.github.com/enterprise-server@2.22/rest/reference/teams#get-team-membership-for-a-user) endpoint.\n\nTeam members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:** The `role` for organization owners returns as `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@2.22/rest/reference/teams#create-a-team).", + "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 [Get team membership for a user](https://docs.github.com/enterprise-server@2.22/rest/reference/teams#get-team-membership-for-a-user) endpoint.\n\nTeam members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:**\nThe response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@2.22/rest/reference/teams#create-a-team).", "tags": [ "teams" ], @@ -267329,7 +267438,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -267352,7 +267461,12 @@ "type": "string" }, "state": { - "type": "string" + "description": "The state of the user's membership in the team.", + "type": "string", + "enum": [ + "active", + "pending" + ] } }, "required": [ @@ -267362,14 +267476,6 @@ ] }, "examples": { - "response-if-user-has-an-active-membership-with-team": { - "summary": "Response if user has an active membership with team", - "value": { - "url": "https://api.github.com/teams/1/memberships/octocat", - "role": "member", - "state": "active" - } - }, "response-if-user-is-a-team-maintainer": { "summary": "Response if user is a team maintainer", "value": { @@ -267377,21 +267483,13 @@ "role": "maintainer", "state": "active" } - }, - "response-if-user-has-a-pending-membership-with-team": { - "summary": "Response if user has a pending membership with team", - "value": { - "url": "https://api.github.com/teams/1/memberships/octocat", - "role": "member", - "state": "pending" - } } } } } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -267475,7 +267573,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -267498,7 +267596,12 @@ "type": "string" }, "state": { - "type": "string" + "description": "The state of the user's membership in the team.", + "type": "string", + "enum": [ + "active", + "pending" + ] } }, "required": [ @@ -267508,14 +267611,6 @@ ] }, "examples": { - "response-if-users-membership-with-team-is-now-active": { - "summary": "Response if user's membership with team is now active", - "value": { - "url": "https://api.github.com/teams/1/memberships/octocat", - "role": "member", - "state": "active" - } - }, "response-if-users-membership-with-team-is-now-pending": { "summary": "Response if user's membership with team is now pending", "value": { @@ -267532,57 +267627,10 @@ "description": "Response if team synchronization is set up" }, "422": { - "description": "Response if you attempt to add an organization to a team", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "field": { - "type": "string" - }, - "resource": { - "type": "string" - } - } - } - }, - "documentation_url": { - "type": "string", - "example": "\"https://help.github.com/articles/github-and-trade-controls\"" - } - } - }, - "examples": { - "response-if-you-attempt-to-add-an-organization-to-a-team": { - "value": { - "message": "Cannot add an organization as a member.", - "errors": [ - { - "code": "org", - "field": "user", - "resource": "TeamMember" - } - ] - } - } - } - } - } + "description": "Response if you attempt to add an organization to a team" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -267646,7 +267694,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Response if team synchronization is set up" @@ -267708,7 +267756,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -267972,7 +268020,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -267992,7 +268040,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -268064,7 +268112,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -268318,7 +268366,7 @@ "description": "Response if project is not managed by this team" }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -268408,7 +268456,7 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Response if the project is not owned by the organization", @@ -268437,7 +268485,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -268457,7 +268505,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -268479,7 +268527,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -268596,10 +268644,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -268619,7 +268667,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -268641,7 +268689,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -268766,7 +268814,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -270501,7 +270549,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -272516,7 +272564,7 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -272539,7 +272587,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -272660,7 +272708,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -272910,7 +272958,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -272950,7 +272998,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -273050,7 +273098,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -273593,7 +273641,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -273616,7 +273664,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -273712,7 +273760,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -274013,10 +274061,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -274056,7 +274104,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -274076,7 +274124,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -274190,7 +274238,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -274251,10 +274299,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -274294,7 +274342,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -274387,7 +274435,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -274452,7 +274500,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -274521,10 +274569,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -274564,7 +274612,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -274655,13 +274703,13 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -274701,7 +274749,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -274721,7 +274769,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -274835,7 +274883,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -274991,7 +275039,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -275014,7 +275062,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -275079,7 +275127,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -275235,7 +275283,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -275258,7 +275306,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -275336,7 +275384,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -275359,7 +275407,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -275412,13 +275460,13 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -275458,7 +275506,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -275511,13 +275559,13 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -275557,7 +275605,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -275622,7 +275670,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -275844,10 +275892,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -275887,7 +275935,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -275951,7 +275999,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -276160,7 +276208,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -276229,10 +276277,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -276272,7 +276320,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -276328,7 +276376,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -276537,7 +276585,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -276557,7 +276605,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -276580,7 +276628,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -276634,10 +276682,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -276657,7 +276705,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -276726,7 +276774,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -276749,7 +276797,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -277373,7 +277421,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -277396,7 +277444,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -277416,7 +277464,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -278618,7 +278666,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -278658,7 +278706,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -278709,7 +278757,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -278732,10 +278780,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -278797,7 +278845,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -278820,10 +278868,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -278879,6 +278927,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -278967,7 +279016,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -281410,7 +281459,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -281430,7 +281479,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -281482,7 +281531,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -281568,10 +281617,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -281611,7 +281660,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -281681,7 +281730,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -281744,7 +281793,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -281813,10 +281862,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -281856,7 +281905,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -281912,7 +281961,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -281975,7 +282024,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -281995,7 +282044,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -282018,7 +282067,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -282072,13 +282121,13 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -282118,7 +282167,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -282196,7 +282245,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -282213,11 +282262,21 @@ }, "state": { "type": "string", - "example": "active" + "description": "The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.", + "example": "active", + "enum": [ + "active", + "pending" + ] }, "role": { "type": "string", - "example": "admin" + "description": "The user's membership type in the organization.", + "example": "admin", + "enum": [ + "admin", + "member" + ] }, "organization_url": { "type": "string", @@ -282534,7 +282593,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -282557,7 +282616,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -282577,7 +282636,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -282681,7 +282740,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -282696,11 +282755,21 @@ }, "state": { "type": "string", - "example": "active" + "description": "The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.", + "example": "active", + "enum": [ + "active", + "pending" + ] }, "role": { "type": "string", - "example": "admin" + "description": "The user's membership type in the organization.", + "example": "admin", + "enum": [ + "admin", + "member" + ] }, "organization_url": { "type": "string", @@ -282986,7 +283055,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -283063,7 +283132,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -283078,11 +283147,21 @@ }, "state": { "type": "string", - "example": "active" + "description": "The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.", + "example": "active", + "enum": [ + "active", + "pending" + ] }, "role": { "type": "string", - "example": "admin" + "description": "The user's membership type in the organization.", + "example": "admin", + "enum": [ + "admin", + "member" + ] }, "organization_url": { "type": "string", @@ -283368,7 +283447,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -283388,7 +283467,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -283502,7 +283581,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -283613,7 +283692,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -283636,7 +283715,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -283709,7 +283788,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -283965,7 +284044,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -283988,7 +284067,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -284008,7 +284087,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -284030,7 +284109,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -284109,7 +284188,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -284170,10 +284249,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -284213,7 +284292,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -284259,7 +284338,7 @@ "parameters": [ { "name": "visibility", - "description": "Can be one of `all`, `public`, or `private`.", + "description": "Can be one of `all`, `public`, or `private`. Note: For GitHub AE, can be one of `all`, `internal`, or `private`.", "in": "query", "required": false, "schema": { @@ -284284,7 +284363,7 @@ }, { "name": "type", - "description": "Can be one of `all`, `owner`, `public`, `private`, `member`. Default: `all` \n \nWill cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.", + "description": "Can be one of `all`, `owner`, `public`, `private`, `member`. Note: For GitHub AE, can be one of `all`, `owner`, `internal`, `private`, `member`. Default: `all` \n \nWill cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.", "in": "query", "required": false, "schema": { @@ -284367,7 +284446,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -285468,7 +285547,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -285537,7 +285616,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -285560,7 +285639,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -285592,7 +285671,7 @@ }, "post": { "summary": "Create a repository for the authenticated user", - "description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", + "description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository.", "tags": [ "repos" ], @@ -285623,7 +285702,7 @@ "type": "string" }, "private": { - "description": "Whether the repository is private or public.", + "description": "Whether the repository is private.", "default": false, "type": "boolean" }, @@ -285711,7 +285790,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -286814,7 +286893,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -286834,10 +286913,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -286877,7 +286956,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -287054,7 +287133,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -288970,10 +289049,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -289013,7 +289092,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -289069,7 +289148,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -289112,7 +289191,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -289132,7 +289211,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -289169,7 +289248,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "409": { "description": "Conflict", @@ -289192,10 +289271,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -289308,7 +289387,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -291531,7 +291610,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -291554,7 +291633,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -291640,7 +291719,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -291660,7 +291739,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -291724,7 +291803,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -291747,7 +291826,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -291767,7 +291846,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -291787,7 +291866,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -291831,10 +291910,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -291854,7 +291933,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -291874,7 +291953,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -291942,7 +292021,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -293677,7 +293756,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -293700,7 +293779,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -293765,7 +293844,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -294268,10 +294347,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -294356,7 +294435,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -294512,7 +294591,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -294550,7 +294629,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -295089,7 +295168,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -295162,7 +295241,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -297891,7 +297970,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -300612,7 +300691,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -303333,7 +303412,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -303542,7 +303621,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -303809,7 +303888,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -304227,7 +304306,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -304349,7 +304428,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -304630,7 +304709,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -304677,7 +304756,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -304697,7 +304776,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -304801,7 +304880,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -305342,7 +305421,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -305440,7 +305519,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -305619,7 +305698,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -305888,7 +305967,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -305910,7 +305989,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -306036,7 +306115,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -308757,7 +308836,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -311439,7 +311518,7 @@ "/users/{username}/repos": { "get": { "summary": "List repositories for a user", - "description": "Lists public repositories for the specified user.", + "description": "Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user.", "tags": [ "repos" ], @@ -311522,7 +311601,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -313296,7 +313375,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -313332,7 +313411,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -313416,7 +313495,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -315692,7 +315771,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -317462,7 +317541,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "requestBody": { @@ -317513,7 +317592,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "requestBody": { @@ -317552,7 +317631,7 @@ "operationId": "meta/get-zen", "responses": { "200": { - "description": "response", + "description": "Response", "content": { "text/plain": { "schema": { diff --git a/lib/rest/static/dereferenced/ghes-3.0.deref.json b/lib/rest/static/dereferenced/ghes-3.0.deref.json index 5eb7269244..807870ff17 100644 --- a/lib/rest/static/dereferenced/ghes-3.0.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.0.deref.json @@ -134,7 +134,7 @@ ], "servers": [ { - "url": "{protocol}://{hostname}", + "url": "{protocol}://{hostname}/api/v3", "variables": { "hostname": { "description": "Self-hosted Enterprise Server or Enterprise Cloud hostname", @@ -162,7 +162,7 @@ "operationId": "meta/root", "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -394,7 +394,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -529,7 +529,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -729,7 +729,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -859,7 +859,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -1040,7 +1040,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -1092,7 +1092,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -1140,11 +1140,48 @@ "type": "integer", "default": 1 } + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "accessed" + ], + "default": "created" + } + }, + { + "name": "since", + "description": "Only show public keys accessed after the given time.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -1242,7 +1279,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -1280,7 +1317,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -1407,7 +1444,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -1460,7 +1497,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -1607,7 +1644,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -1650,7 +1687,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -1815,7 +1852,7 @@ ], "responses": { "202": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -1899,11 +1936,39 @@ "type": "integer", "default": 1 } + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -2026,7 +2091,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -2167,7 +2232,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -2279,7 +2344,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -2456,7 +2521,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "422": { "description": "Client Errors", @@ -2544,7 +2609,7 @@ ], "responses": { "202": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -2665,7 +2730,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -2746,11 +2811,40 @@ "type": "integer", "default": 1 } + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "sort", + "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to) or `name`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -2907,7 +3001,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -3130,7 +3224,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -3292,7 +3386,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -3502,7 +3596,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -3554,7 +3648,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -4264,7 +4358,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -4292,7 +4386,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -4496,7 +4590,7 @@ ], "responses": { "202": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -4572,7 +4666,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -4610,7 +4704,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -5311,7 +5405,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -5342,7 +5436,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -5671,7 +5765,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -5997,7 +6091,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -6017,7 +6111,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -6072,7 +6166,7 @@ }, "responses": { "200": { - "description": "Default response", + "description": "Response", "content": { "application/json": { "schema": { @@ -6178,7 +6272,7 @@ }, "responses": { "200": { - "description": "Default response", + "description": "Response", "content": { "application/json": { "schema": { @@ -6841,7 +6935,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -7348,7 +7442,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -7368,7 +7462,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -7424,10 +7518,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -7764,7 +7858,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -8954,7 +9048,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -8976,7 +9070,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -8996,7 +9090,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -9016,7 +9110,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -9121,10 +9215,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -9178,10 +9272,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -9242,11 +9336,20 @@ "type": "integer", "default": 1 } + }, + { + "name": "client_id", + "in": "query", + "required": false, + "description": "The client ID of your GitHub app.", + "schema": { + "type": "string" + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -9464,7 +9567,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -9487,7 +9590,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -9507,7 +9610,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -9566,7 +9669,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -9771,7 +9874,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -9794,7 +9897,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -9851,10 +9954,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -9877,7 +9980,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -9954,10 +10057,10 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -10070,7 +10173,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -10130,7 +10233,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -10801,7 +10904,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -10870,7 +10973,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -10942,7 +11045,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -11613,7 +11716,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -11724,7 +11827,10 @@ "type": "string", "description": "The OAuth access token used to authenticate to the GitHub API." } - } + }, + "required": [ + "access_token" + ] }, "example": { "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a" @@ -11734,10 +11840,10 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -11862,7 +11968,7 @@ "type": "integer" }, "repositories": { - "description": "The list of repository IDs to scope the user-to-server access token to. `repositories` may not be specified if `repository_ids` is specified.", + "description": "The list of repository names to scope the user-to-server access token to. `repositories` may not be specified if `repository_ids` is specified.", "type": "array", "items": { "type": "string", @@ -11870,7 +11976,7 @@ } }, "repository_ids": { - "description": "The list of repository names to scope the user-to-server access token to. `repository_ids` may not be specified if `repositories` is specified.", + "description": "The list of repository IDs to scope the user-to-server access token to. `repository_ids` may not be specified if `repositories` is specified.", "example": [ 1 ], @@ -12131,14 +12237,17 @@ "single_file": "read" } } - } + }, + "required": [ + "access_token" + ] } } } }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -12842,7 +12951,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -12882,7 +12991,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -12902,7 +13011,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -13015,7 +13124,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -13691,7 +13800,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -13756,7 +13865,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -14472,7 +14581,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -14513,7 +14622,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -14827,7 +14936,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -14847,7 +14956,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -14910,11 +15019,20 @@ "type": "integer", "default": 1 } + }, + { + "name": "client_id", + "in": "query", + "required": false, + "description": "The client ID of your GitHub app.", + "schema": { + "type": "string" + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -15589,7 +15707,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -15612,7 +15730,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -15632,7 +15750,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -15727,7 +15845,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -16385,7 +16503,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -16474,7 +16592,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -16497,7 +16615,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -17916,7 +18034,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -17985,7 +18103,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -18008,7 +18126,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -19431,7 +19549,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -19539,7 +19657,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -20189,7 +20307,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -20212,7 +20330,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -20319,7 +20437,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -20969,7 +21087,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -21075,10 +21193,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -21101,7 +21219,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -21152,7 +21270,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -21215,10 +21333,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -21279,7 +21397,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -21332,7 +21450,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -21352,10 +21470,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -21443,7 +21561,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -21493,7 +21611,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -21562,7 +21680,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -21602,7 +21720,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -21624,7 +21742,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -21689,10 +21807,10 @@ } } }, - "description": "response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -21720,7 +21838,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -21807,7 +21925,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -21867,7 +21985,7 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -21895,7 +22013,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -21972,7 +22090,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -22232,7 +22350,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -22317,7 +22435,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "requestBody": { @@ -22410,7 +22528,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -22562,7 +22680,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "requestBody": { @@ -22638,7 +22756,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -22684,7 +22802,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -22723,7 +22841,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -22796,7 +22914,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "requestBody": { @@ -22891,7 +23009,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -23069,7 +23187,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -23168,7 +23286,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -23293,7 +23411,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -23390,7 +23508,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -23456,7 +23574,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -23645,7 +23763,7 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -23702,7 +23820,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -23757,7 +23875,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -23823,7 +23941,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -24048,7 +24166,7 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -24105,7 +24223,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -24160,7 +24278,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -24217,7 +24335,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -24403,7 +24521,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -24510,7 +24628,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -25569,7 +25687,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -26637,7 +26755,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -26782,7 +26900,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -26830,7 +26948,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -29498,7 +29616,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -29521,7 +29639,7 @@ } }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -29570,7 +29688,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -29872,7 +29990,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -30290,7 +30408,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -30399,7 +30517,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -30632,7 +30750,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -30701,10 +30819,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -30798,7 +30916,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -31216,7 +31334,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -31285,7 +31403,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -31362,7 +31480,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -31780,7 +31898,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -31800,7 +31918,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -31859,7 +31977,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -32117,7 +32235,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -32137,7 +32255,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -32244,7 +32362,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -32469,7 +32587,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -32538,7 +32656,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -32592,10 +32710,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -32615,7 +32733,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -32692,7 +32810,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -32924,10 +33042,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -33021,7 +33139,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -33248,10 +33366,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -33336,7 +33454,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -33555,10 +33673,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -33674,7 +33792,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -33893,7 +34011,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -33956,13 +34074,13 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -34056,7 +34174,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -34269,7 +34387,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -34289,7 +34407,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -34366,7 +34484,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -34635,7 +34753,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -34655,7 +34773,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -34712,7 +34830,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -35125,7 +35243,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -35145,7 +35263,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -35214,7 +35332,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -35289,7 +35407,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -35346,10 +35464,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -35369,7 +35487,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -35426,13 +35544,13 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -35516,7 +35634,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -35741,7 +35859,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -35810,7 +35928,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -35878,7 +35996,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -35900,7 +36018,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -35938,7 +36056,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -35972,7 +36090,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -36020,7 +36138,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -37162,10 +37280,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -37217,7 +37335,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -37256,6 +37374,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -37376,7 +37495,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -39819,7 +39938,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -39888,10 +40007,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -39955,11 +40074,20 @@ "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", + "description": "Response", "content": { "application/json": { "schema": { @@ -40065,7 +40193,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -40103,7 +40231,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -40256,7 +40384,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -40276,7 +40404,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -40339,7 +40467,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "headers": { "Content-Type": { "example": "text/html", @@ -40369,7 +40497,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -40414,7 +40542,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "headers": { "X-CommonMarker-Version": { "example": "0.17.4", @@ -40432,7 +40560,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -40463,7 +40591,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -40496,7 +40624,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -40560,7 +40688,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -43228,7 +43356,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -43268,10 +43396,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "301": { - "description": "Moved Permanently" + "description": "Moved permanently" } }, "x-github": { @@ -43357,7 +43485,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -45016,7 +45144,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -45039,7 +45167,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -45059,7 +45187,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -45174,7 +45302,7 @@ }, "responses": { "202": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -45189,10 +45317,10 @@ } }, "205": { - "description": "response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -45215,7 +45343,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -45271,7 +45399,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -46917,7 +47045,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -46940,7 +47068,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -46994,10 +47122,10 @@ ], "responses": { "205": { - "description": "response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -47056,7 +47184,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -47121,7 +47249,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -47144,7 +47272,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -47214,7 +47342,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -47279,7 +47407,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -47302,7 +47430,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -47356,10 +47484,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -47382,7 +47510,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -47434,7 +47562,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/octocat-stream": { "schema": { @@ -47488,7 +47616,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -47599,7 +47727,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -47637,7 +47765,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -47926,7 +48054,9 @@ "plan": { "name": "Medium", "space": 400, - "private_repos": 20 + "private_repos": 20, + "filled_seats": 4, + "seats": 5 }, "default_repository_permission": "read", "members_can_create_repositories": true, @@ -47937,54 +48067,13 @@ "members_can_create_internal_repositories": false, "members_can_create_pages": true } - }, - "response-with-git-hub-plan-information": { - "summary": "Response with GitHub plan information", - "value": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization", - "name": "github", - "company": "GitHub", - "blog": "https://github.com/blog", - "location": "San Francisco", - "email": "octocat@github.com", - "twitter_username": "github", - "is_verified": true, - "has_organization_projects": true, - "has_repository_projects": true, - "public_repos": 2, - "public_gists": 1, - "followers": 20, - "following": 0, - "html_url": "https://github.com/octocat", - "created_at": "2008-01-14T04:33:35Z", - "updated_at": "2014-03-03T18:58:10Z", - "type": "Organization", - "plan": { - "name": "team", - "space": 976562499, - "private_repos": 999999, - "filled_seats": 4, - "seats": 5 - } - } } } } } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -48146,7 +48235,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -48451,7 +48540,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -48567,7 +48656,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -48628,7 +48717,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -48712,7 +48801,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "requestBody": { @@ -48804,7 +48893,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -49952,7 +50041,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "requestBody": { @@ -50026,7 +50115,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -50070,7 +50159,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -50108,7 +50197,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -50180,7 +50269,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "requestBody": { @@ -50274,7 +50363,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -50464,7 +50553,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -50571,7 +50660,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -50704,7 +50793,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -50809,7 +50898,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -50852,11 +50941,29 @@ "schema": { "type": "integer" } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -52041,7 +52148,7 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -52096,7 +52203,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -52149,7 +52256,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -52214,7 +52321,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -52438,7 +52545,7 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -52494,7 +52601,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -52548,7 +52655,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -52604,7 +52711,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -52793,7 +52900,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -52899,7 +53006,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -53957,7 +54064,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -55024,7 +55131,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -55168,7 +55275,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -55224,7 +55331,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -55357,7 +55464,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -55453,7 +55560,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -55559,7 +55666,8 @@ "properties": { "encrypted_value": { "type": "string", - "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/enterprise-server@3.0/rest/reference/actions#get-an-organization-public-key) endpoint." + "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/enterprise-server@3.0/rest/reference/actions#get-an-organization-public-key) endpoint.", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" }, "key_id": { "type": "string", @@ -55584,7 +55692,7 @@ } }, "example": { - "encrypted_value": "****************************************************************************************", + "encrypted_value": "c2VjcmV0", "key_id": "012345678912345678", "visibility": "selected", "selected_repository_ids": [ @@ -55645,7 +55753,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -55688,11 +55796,29 @@ "schema": { "type": "string" } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -57344,7 +57470,7 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -57514,7 +57640,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -60235,7 +60361,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -60362,7 +60488,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -60499,7 +60625,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -60621,7 +60747,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -60690,7 +60816,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -60753,7 +60879,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -60867,7 +60993,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -60994,7 +61120,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -61107,7 +61233,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -61176,7 +61302,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -61237,10 +61363,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -61303,7 +61429,7 @@ ], "responses": { "200": { - "description": "Default response", + "description": "Response", "content": { "application/json": { "schema": { @@ -61427,7 +61553,7 @@ }, "responses": { "200": { - "description": "Default response", + "description": "Response", "content": { "application/json": { "schema": { @@ -61515,10 +61641,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -61573,7 +61699,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -62133,7 +62259,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -62713,6 +62839,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -62801,7 +62928,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -65244,7 +65371,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -65350,7 +65477,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -65517,7 +65644,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -65687,7 +65814,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -65724,7 +65851,7 @@ "/orgs/{org}/memberships/{username}": { "get": { "summary": "Get organization membership for a user", - "description": "In order to get a user's membership with an organization, the authenticated user must be an organization member.", + "description": "In order to get a user's membership with an organization, the authenticated user must be an organization member. The `state` parameter in the response can be used to identify the user's membership status.", "tags": [ "orgs" ], @@ -65753,7 +65880,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -65768,11 +65895,21 @@ }, "state": { "type": "string", - "example": "active" + "description": "The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.", + "example": "active", + "enum": [ + "active", + "pending" + ] }, "role": { "type": "string", - "example": "admin" + "description": "The user's membership type in the organization.", + "example": "admin", + "enum": [ + "admin", + "member" + ] }, "organization_url": { "type": "string", @@ -66033,99 +66170,13 @@ "site_admin": false } } - }, - "response-if-user-has-an-active-membership-with-organization": { - "summary": "Response if user has an active membership with organization", - "value": { - "url": "https://api.github.com/orgs/octocat/memberships/defunkt", - "state": "active", - "role": "member", - "organization_url": "https://api.github.com/orgs/octocat", - "organization": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization" - }, - "user": { - "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 - } - } - }, - "response-if-user-has-a-pending-membership-with-organization": { - "summary": "Response if user has a pending membership with organization", - "value": { - "url": "https://api.github.com/orgs/invitocat/memberships/defunkt", - "state": "pending", - "role": "member", - "organization_url": "https://api.github.com/orgs/invitocat", - "organization": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization" - }, - "user": { - "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 - } - } } } } } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -66226,7 +66277,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -66241,11 +66292,21 @@ }, "state": { "type": "string", - "example": "active" + "description": "The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.", + "example": "active", + "enum": [ + "active", + "pending" + ] }, "role": { "type": "string", - "example": "admin" + "description": "The user's membership type in the organization.", + "example": "admin", + "enum": [ + "admin", + "member" + ] }, "organization_url": { "type": "string", @@ -66464,51 +66525,8 @@ ] }, "examples": { - "response-if-user-was-previously-unaffiliated-with-organization": { - "summary": "Response if user was previously unaffiliated with organization", - "value": { - "url": "https://api.github.com/orgs/invitocat/memberships/defunkt", - "state": "pending", - "role": "admin", - "organization_url": "https://api.github.com/orgs/invitocat", - "organization": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization" - }, - "user": { - "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 - } - } - }, "response-if-user-already-had-membership-with-organization": { - "summary": "Response if user already had membership with organization", + "summary": "Response if user has an active admin membership with organization", "value": { "url": "https://api.github.com/orgs/octocat/memberships/defunkt", "state": "active", @@ -66555,7 +66573,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -66685,7 +66703,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -66708,7 +66726,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -66795,7 +66813,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -67000,41 +67018,10 @@ "description": "User was converted" }, "403": { - "description": "response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - }, - "examples": { - "response-if-user-is-the-last-owner-of-the-organization": { - "summary": "Response if user is the last owner of the organization", - "value": { - "message": "Cannot convert the last owner to an outside collaborator", - "documentation_url": "https://docs.github.com/enterprise-server@3.0/rest/reference/orgs#convert-member-to-outside-collaborator" - } - }, - "response-if-user-is-not-a-member-of-the-organization": { - "summary": "Response if user is not a member of the organization", - "value": { - "message": " is not a member of the organization.", - "documentation_url": "https://docs.github.com/enterprise-server@3.0/rest/reference/orgs#convert-member-to-outside-collaborator" - } - } - } - } - } + "description": "Response if user is the last owner of the organization or not a member of the organization" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -67095,7 +67082,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "422": { "description": "Response if user is a member of the organization", @@ -67173,11 +67160,40 @@ "type": "integer", "default": 1 } + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "sort", + "description": "The sort order for the response collection.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -67267,7 +67283,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -67350,7 +67366,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -67456,7 +67472,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -67566,7 +67582,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -67835,7 +67851,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -67928,7 +67944,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -68184,7 +68200,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -68224,7 +68240,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -68264,7 +68280,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -68351,7 +68367,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -68597,7 +68613,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -68661,7 +68677,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -68698,7 +68714,7 @@ }, { "name": "type", - "description": "Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`.", + "description": "Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Note: For GitHub AE, can be one of `all`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`.", "in": "query", "required": false, "schema": { @@ -68764,7 +68780,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -70520,7 +70536,7 @@ }, "post": { "summary": "Create an organization repository", - "description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", + "description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository", "tags": [ "repos" ], @@ -70559,12 +70575,12 @@ }, "private": { "type": "boolean", - "description": "Either `true` to create a private repository or `false` to create a public one.", + "description": "Whether the repository is private.", "default": false }, "visibility": { "type": "string", - "description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", + "description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", "enum": [ "public", "private", @@ -70648,7 +70664,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -71771,7 +71787,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -71902,7 +71918,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -72198,7 +72214,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -72688,7 +72704,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -72821,7 +72837,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -73311,7 +73327,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -73420,7 +73436,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -73952,7 +73968,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -74027,11 +74043,20 @@ "type": "integer", "default": 1 } + }, + { + "name": "pinned", + "in": "query", + "required": false, + "description": "Pinned discussions only filter", + "schema": { + "type": "string" + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -74452,7 +74477,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -74839,7 +74864,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -75245,7 +75270,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -75629,7 +75654,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -75716,7 +75741,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -76100,7 +76125,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -76461,7 +76486,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -76840,7 +76865,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -77198,7 +77223,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -77298,7 +77323,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -77600,7 +77625,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -77868,7 +77893,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -77964,7 +77989,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -78258,7 +78283,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -78518,7 +78543,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -78602,7 +78627,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -78772,7 +78797,7 @@ "/orgs/{org}/teams/{team_slug}/memberships/{username}": { "get": { "summary": "Get team membership for a user", - "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.\n\n**Note:** The `role` for organization owners returns as `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@3.0/rest/reference/teams#create-a-team).", + "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.\n\n**Note:**\nThe response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see see [Create a team](https://docs.github.com/enterprise-server@3.0/rest/reference/teams#create-a-team).", "tags": [ "teams" ], @@ -78810,7 +78835,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -78833,7 +78858,12 @@ "type": "string" }, "state": { - "type": "string" + "description": "The state of the user's membership in the team.", + "type": "string", + "enum": [ + "active", + "pending" + ] } }, "required": [ @@ -78843,14 +78873,6 @@ ] }, "examples": { - "response-if-user-has-an-active-membership-with-team": { - "summary": "Response if user has an active membership with team", - "value": { - "url": "https://api.github.com/teams/1/memberships/octocat", - "role": "member", - "state": "active" - } - }, "response-if-user-is-a-team-maintainer": { "summary": "Response if user is a team maintainer", "value": { @@ -78858,14 +78880,6 @@ "role": "maintainer", "state": "active" } - }, - "response-if-user-has-a-pending-membership-with-team": { - "summary": "Response if user has a pending membership with team", - "value": { - "url": "https://api.github.com/teams/1/memberships/octocat", - "role": "member", - "state": "pending" - } } } } @@ -78945,7 +78959,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -78968,7 +78982,12 @@ "type": "string" }, "state": { - "type": "string" + "description": "The state of the user's membership in the team.", + "type": "string", + "enum": [ + "active", + "pending" + ] } }, "required": [ @@ -78978,14 +78997,6 @@ ] }, "examples": { - "response-if-users-membership-with-team-is-now-active": { - "summary": "Response if user's membership with team is now active", - "value": { - "url": "https://api.github.com/teams/1/memberships/octocat", - "role": "member", - "state": "active" - } - }, "response-if-users-membership-with-team-is-now-pending": { "summary": "Response if user's membership with team is now pending", "value": { @@ -79002,50 +79013,7 @@ "description": "Response if team synchronization is set up" }, "422": { - "description": "Response if you attempt to add an organization to a team", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "field": { - "type": "string" - }, - "resource": { - "type": "string" - } - } - } - } - } - }, - "examples": { - "response-if-you-attempt-to-add-an-organization-to-a-team": { - "value": { - "message": "Cannot add an organization as a member.", - "errors": [ - { - "code": "org", - "field": "user", - "resource": "TeamMember" - } - ] - } - } - } - } - } + "description": "Response if you attempt to add an organization to a team" } }, "x-github": { @@ -79098,7 +79066,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Response if team synchronization is set up" @@ -79166,7 +79134,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -79486,7 +79454,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -79815,7 +79783,7 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Response if the project is not owned by the organization", @@ -79898,7 +79866,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -79963,7 +79931,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -83707,7 +83675,7 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -83768,7 +83736,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -84060,7 +84028,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -84287,7 +84255,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -84310,7 +84278,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -84330,7 +84298,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -84410,7 +84378,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -84637,7 +84605,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -84660,7 +84628,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -84680,7 +84648,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -84700,7 +84668,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -84768,10 +84736,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -84798,7 +84766,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -84818,7 +84786,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -84903,7 +84871,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -84916,7 +84884,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -84957,7 +84925,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -84977,7 +84945,7 @@ } }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -85012,7 +84980,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -85121,7 +85089,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -85198,7 +85166,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -85221,7 +85189,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -85241,7 +85209,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -85318,7 +85286,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -85395,7 +85363,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -85418,7 +85386,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -85476,10 +85444,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -85502,7 +85470,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -85595,7 +85563,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -85835,7 +85803,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -85858,7 +85826,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -85959,7 +85927,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -86186,7 +86154,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -86209,7 +86177,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -86229,7 +86197,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -86325,7 +86293,7 @@ } }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -86420,7 +86388,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -86433,7 +86401,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -86456,7 +86424,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -86486,7 +86454,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -86545,7 +86513,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -86801,7 +86769,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -86824,7 +86792,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -86922,7 +86890,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -87181,7 +87149,7 @@ "description": "Response if the authenticated user does not have access to the project" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -87208,7 +87176,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -87248,7 +87216,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -87318,7 +87286,7 @@ "description": "Delete Success" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -87345,7 +87313,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -87385,7 +87353,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -87477,7 +87445,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -87633,7 +87601,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -87653,7 +87621,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -87675,7 +87643,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -87744,7 +87712,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -87767,7 +87735,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -87856,10 +87824,10 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -87879,7 +87847,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -87901,7 +87869,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -87970,7 +87938,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -87993,7 +87961,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -88058,13 +88026,13 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -88084,7 +88052,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -88126,7 +88094,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -88195,7 +88163,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -88262,7 +88230,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -88427,7 +88395,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -88447,7 +88415,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -88469,7 +88437,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -88538,7 +88506,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -88561,7 +88529,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -88638,7 +88606,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -88728,7 +88696,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -88751,7 +88719,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -88827,7 +88795,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -88900,7 +88868,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -88923,7 +88891,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -88953,7 +88921,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -89005,7 +88973,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -89231,10 +89199,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -89289,10 +89257,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -89315,7 +89283,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -89355,7 +89323,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -89427,7 +89395,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -94139,7 +94107,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -94159,7 +94127,7 @@ } }, "301": { - "description": "Moved Permanently" + "description": "Moved permanently" } }, "x-github": { @@ -94308,7 +94276,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -98508,7 +98476,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -98577,7 +98545,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -98647,7 +98615,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "If an organization owner has configured the organization to prevent members from deleting organization-owned repositories, a member will get this response:", @@ -98672,7 +98640,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -98753,7 +98721,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -98931,7 +98899,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -99067,7 +99035,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -99130,7 +99098,7 @@ ], "responses": { "302": { - "description": "response", + "description": "Response", "headers": { "Location": { "example": "https://pipelines.actions.githubusercontent.com/OhgS4QRKqmgx7bKC27GKU83jnQjyeqG8oIMTge8eqtheppcmw8/_apis/pipelines/1/runs/176/signedlogcontent?urlExpires=2020-01-24T18%3A10%3A31.5729946Z&urlSigningMethod=HMACV1&urlSignature=agG73JakPYkHrh06seAkvmH7rBR4Ji4c2%2B6a2ejYh3E%3D", @@ -99193,7 +99161,7 @@ ], "responses": { "202": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -99499,7 +99467,7 @@ ], "responses": { "302": { - "description": "response", + "description": "Response", "headers": { "Location": { "example": "https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/jobs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D", @@ -99553,7 +99521,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -99636,7 +99604,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "requestBody": { @@ -99713,7 +99681,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -99793,7 +99761,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "requestBody": { @@ -99895,7 +99863,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -100092,7 +100060,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -100206,7 +100174,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -101272,7 +101240,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -102347,7 +102315,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -102499,7 +102467,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -102614,7 +102582,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -106148,7 +106116,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -109652,7 +109620,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -109725,7 +109693,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -109903,7 +109871,7 @@ ], "responses": { "202": { - "description": "response" + "description": "Response" } }, "x-github": { @@ -109990,7 +109958,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -110324,7 +110292,7 @@ ], "responses": { "302": { - "description": "response", + "description": "Response", "headers": { "Location": { "example": "https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/runs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D", @@ -110385,7 +110353,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -110440,7 +110408,7 @@ ], "responses": { "201": { - "description": "response" + "description": "Response" } }, "x-github": { @@ -110504,7 +110472,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -110621,7 +110589,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -110725,7 +110693,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -110822,7 +110790,8 @@ "properties": { "encrypted_value": { "type": "string", - "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/enterprise-server@3.0/rest/reference/actions#get-a-repository-public-key) endpoint." + "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/enterprise-server@3.0/rest/reference/actions#get-a-repository-public-key) endpoint.", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" }, "key_id": { "type": "string", @@ -110831,7 +110800,7 @@ } }, "example": { - "encrypted_value": "****************************************************************************************", + "encrypted_value": "c2VjcmV0", "key_id": "012345678912345678" } } @@ -110895,7 +110864,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -110959,7 +110928,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -111151,7 +111120,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -111303,7 +111272,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -111365,7 +111334,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "requestBody": { @@ -111460,7 +111429,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -111591,7 +111560,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -115134,7 +115103,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -115290,7 +115259,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -115454,7 +115423,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -116180,18 +116149,6 @@ }, "examples": { "default": { - "value": [ - { - "name": "master", - "commit": { - "sha": "c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc", - "url": "https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc" - }, - "protected": true - } - ] - }, - "with-protection": { "value": [ { "name": "master", @@ -116227,7 +116184,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -116300,7 +116257,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -117618,7 +117575,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -117640,7 +117597,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -117713,7 +117670,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -118559,7 +118516,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -118798,7 +118755,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -119529,7 +119486,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -119551,7 +119508,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -119581,7 +119538,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -119656,7 +119613,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -119732,7 +119689,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -119818,7 +119775,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -119907,7 +119864,7 @@ "description": "No Content" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -119980,7 +119937,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/vnd.github.luke-cage-preview+json": { "schema": { @@ -120459,7 +120416,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -120827,7 +120784,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -120954,7 +120911,7 @@ "description": "No Content" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -121027,7 +120984,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -121062,7 +121019,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -121137,7 +121094,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -121172,7 +121129,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -121250,7 +121207,7 @@ "description": "No Content" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -121327,7 +121284,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -121382,7 +121339,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -121481,7 +121438,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -121536,7 +121493,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -121556,7 +121513,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -121732,7 +121689,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -121748,7 +121705,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -121845,7 +121802,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -121862,7 +121819,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -121951,7 +121908,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -122049,7 +122006,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -122065,7 +122022,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -122134,7 +122091,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -122232,7 +122189,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -122248,7 +122205,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -122268,7 +122225,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -122391,7 +122348,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -122762,7 +122719,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -122889,7 +122846,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -123188,7 +123145,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -123285,7 +123242,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -123584,7 +123541,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -123731,7 +123688,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -124030,7 +123987,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -124177,7 +124134,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -124476,7 +124433,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -124599,7 +124556,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -124770,7 +124727,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -124867,7 +124824,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -125038,7 +124995,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -125185,7 +125142,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -125356,7 +125313,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -125503,7 +125460,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -125674,7 +125631,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -125797,7 +125754,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -125945,7 +125902,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -126042,7 +125999,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -126190,7 +126147,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -126337,7 +126294,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -126485,7 +126442,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -126632,7 +126589,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -126780,7 +126737,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -127087,7 +127044,7 @@ "name", "head_sha" ], - "anyOf": [ + "oneOf": [ { "properties": { "status": { @@ -127097,6 +127054,7 @@ } }, "required": [ + "status", "conclusion" ], "additionalProperties": true @@ -127116,7 +127074,7 @@ }, "examples": { "example-of-in-progress-conclusion": { - "summary": "Example of in_progress conclusion", + "summary": "Response for in_progress conclusion", "value": { "name": "mighty_readme", "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -127131,7 +127089,7 @@ } }, "example-of-completed-conclusion": { - "summary": "Example of completed conclusion", + "summary": "Response for completed conclusion", "value": { "name": "mighty_readme", "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -127185,7 +127143,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -128001,101 +127959,8 @@ ] }, "examples": { - "example-of-in-progress-conclusion": { - "summary": "Example of in_progress conclusion", - "value": { - "id": 4, - "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", - "node_id": "MDg6Q2hlY2tSdW40", - "external_id": "42", - "url": "https://api.github.com/repos/github/hello-world/check-runs/4", - "html_url": "https://github.com/github/hello-world/runs/4", - "details_url": "https://example.com", - "status": "in_progress", - "conclusion": "neutral", - "started_at": "2018-05-04T01:14:52Z", - "completed_at": null, - "output": { - "title": "Mighty Readme Report", - "summary": "", - "text": "", - "annotations_count": 1, - "annotations_url": "https://api.github.com/repos/github/hello-world/check-runs/4/annotations" - }, - "name": "mighty_readme", - "check_suite": { - "id": 5 - }, - "app": { - "id": 1, - "slug": "octoapp", - "node_id": "MDExOkludGVncmF0aW9uMQ==", - "owner": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "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", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": true - }, - "name": "Octocat App", - "description": "", - "external_url": "https://example.com", - "html_url": "https://github.com/apps/octoapp", - "created_at": "2017-07-08T16:18:44-04:00", - "updated_at": "2017-07-08T16:18:44-04:00", - "permissions": { - "metadata": "read", - "contents": "read", - "issues": "write", - "single_file": "write" - }, - "events": [ - "push", - "pull_request" - ] - }, - "pull_requests": [ - { - "url": "https://api.github.com/repos/github/hello-world/pulls/1", - "id": 1934, - "number": 3956, - "head": { - "ref": "say-hello", - "sha": "3dca65fa3e8d4b3da3f3d056c59aee1c50f41390", - "repo": { - "id": 526, - "url": "https://api.github.com/repos/github/hello-world", - "name": "hello-world" - } - }, - "base": { - "ref": "master", - "sha": "e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f", - "repo": { - "id": 526, - "url": "https://api.github.com/repos/github/hello-world", - "name": "hello-world" - } - } - } - ] - } - }, "example-of-completed-conclusion": { - "summary": "Example of completed conclusion", + "summary": "Response for completed conclusion", "value": { "id": 4, "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -128244,7 +128109,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -129461,7 +129326,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -130444,7 +130309,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -130608,7 +130473,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -132993,7 +132858,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -134188,7 +134053,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -136596,7 +136461,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -137589,7 +137454,7 @@ ], "responses": { "201": { - "description": "response" + "description": "Response" } }, "x-github": { @@ -137606,7 +137471,7 @@ "/repos/{owner}/{repo}/code-scanning/alerts": { "get": { "summary": "List code scanning alerts for a repository", - "description": "Lists all open code scanning alerts for the default branch (usually `main`\nor `master`). You must use an access token with the `security_events` scope to use\nthis endpoint. GitHub Apps must have the `security_events` read permission to use\nthis endpoint.\n\nThe response includes a `most_recent_instance` object.\nThis provides details of the most recent instance of this alert\nfor the the default branch or for the specified Git reference\n(if you used `ref` in the request).", + "description": "Lists all open code scanning alerts for the default branch (usually `main`\nor `master`). You must use an access token with the `security_events` scope to use\nthis endpoint. GitHub Apps must have the `security_events` read permission to use\nthis endpoint.\n\nThe response includes a `most_recent_instance` object.\nThis provides details of the most recent instance of this alert\nfor the default branch or for the specified Git reference\n(if you used `ref` in the request).", "tags": [ "code-scanning" ], @@ -137678,7 +137543,7 @@ "required": false, "schema": { "type": "string", - "description": "The full Git reference, formatted as `refs/heads/`." + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." } }, { @@ -137691,6 +137556,7 @@ "description": "State of a code scanning alert.", "enum": [ "open", + "closed", "dismissed", "fixed" ] @@ -137699,7 +137565,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -137746,6 +137612,7 @@ "description": "State of a code scanning alert.", "enum": [ "open", + "closed", "dismissed", "fixed" ] @@ -137941,7 +137808,7 @@ "properties": { "ref": { "type": "string", - "description": "The full Git reference, formatted as `refs/heads/`." + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." }, "analysis_key": { "type": "string", @@ -137956,6 +137823,7 @@ "description": "State of a code scanning alert.", "enum": [ "open", + "closed", "dismissed", "fixed" ] @@ -138142,7 +138010,7 @@ } }, "403": { - "description": "Response if github advanced security is not enabled for this repository", + "description": "Response if GitHub Advanced Security is not enabled for this repository", "content": { "application/json": { "schema": { @@ -138162,7 +138030,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -138182,7 +138050,7 @@ } }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -138258,7 +138126,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -138303,6 +138171,7 @@ "description": "State of a code scanning alert.", "enum": [ "open", + "closed", "dismissed", "fixed" ] @@ -138513,7 +138382,7 @@ "properties": { "ref": { "type": "string", - "description": "The full Git reference, formatted as `refs/heads/`." + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." }, "analysis_key": { "type": "string", @@ -138528,6 +138397,7 @@ "description": "State of a code scanning alert.", "enum": [ "open", + "closed", "dismissed", "fixed" ] @@ -138675,7 +138545,7 @@ } }, "403": { - "description": "Response if github advanced security is not enabled for this repository", + "description": "Response if GitHub Advanced Security is not enabled for this repository", "content": { "application/json": { "schema": { @@ -138695,7 +138565,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -138715,7 +138585,7 @@ } }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -138834,7 +138704,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -138879,6 +138749,7 @@ "description": "State of a code scanning alert.", "enum": [ "open", + "closed", "dismissed", "fixed" ] @@ -139089,7 +138960,7 @@ "properties": { "ref": { "type": "string", - "description": "The full Git reference, formatted as `refs/heads/`." + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." }, "analysis_key": { "type": "string", @@ -139104,6 +138975,7 @@ "description": "State of a code scanning alert.", "enum": [ "open", + "closed", "dismissed", "fixed" ] @@ -139271,7 +139143,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -139291,7 +139163,7 @@ } }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -139397,7 +139269,7 @@ "required": false, "schema": { "type": "string", - "description": "The full Git reference, formatted as `refs/heads/`." + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." } }, { @@ -139415,7 +139287,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -139425,7 +139297,7 @@ "properties": { "ref": { "type": "string", - "description": "The full Git reference, formatted as `refs/heads/`." + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." }, "commit_sha": { "description": "The SHA of the commit to which the analysis you are uploading relates.", @@ -139566,7 +139438,7 @@ } }, "403": { - "description": "Response if github advanced security is not enabled for this repository", + "description": "Response if GitHub Advanced Security is not enabled for this repository", "content": { "application/json": { "schema": { @@ -139586,7 +139458,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -139606,7 +139478,7 @@ } }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -139640,7 +139512,7 @@ "/repos/{owner}/{repo}/code-scanning/sarifs": { "post": { "summary": "Upload an analysis as SARIF data", - "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint.\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64\n```\n\nSARIF upload supports a maximum of 1000 results per analysis run. Any results over this limit are ignored. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.\n\nThe `202 Accepted`, response includes an `id` value.\nYou can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload).\"", + "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint.\n\nThere are two places where you can upload code scanning results.\n - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see \"[Triaging code scanning alerts in pull requests](/github/finding-security-vulnerabilities-and-errors-in-your-code/triaging-code-scanning-alerts-in-pull-requests).\"\n - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see \"[Managing code scanning alerts for your repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository).\"\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64\n```\n\nSARIF upload supports a maximum of 1000 results per analysis run. Any results over this limit are ignored. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.\n\nThe `202 Accepted`, response includes an `id` value.\nYou can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload).\"", "operationId": "code-scanning/upload-sarif", "tags": [ "code-scanning" @@ -139682,7 +139554,7 @@ }, "ref": { "type": "string", - "description": "The full Git reference, formatted as `refs/heads/`." + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." }, "sarif": { "description": "A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using [`gzip`](http://www.gnu.org/software/gzip/manual/gzip.html) and then translate the contents of the file into a Base64 encoding string. For more information, see \"[SARIF support for code scanning](https://docs.github.com/enterprise-server@3.0/github/finding-security-vulnerabilities-and-errors-in-your-code/sarif-support-for-code-scanning).\"", @@ -139715,7 +139587,7 @@ }, "responses": { "202": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -139772,7 +139644,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -139795,7 +139667,7 @@ "description": "Response if the sarif field is too large" }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -139891,7 +139763,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -140066,7 +139938,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -142125,7 +141997,7 @@ "description": "Response when person is already a collaborator" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -142264,7 +142136,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -142483,7 +142355,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -142564,7 +142436,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -142922,7 +142794,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -143211,7 +143083,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -143306,7 +143178,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -143595,7 +143467,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -143665,10 +143537,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -143777,7 +143649,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -143986,7 +143858,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -144006,7 +143878,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -144505,7 +144377,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -144527,7 +144399,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -144660,7 +144532,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -144769,11 +144641,31 @@ "type": "integer", "default": 1 } + }, + { + "name": "top", + "description": "legacy parameter for pagination.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "last_sha", + "description": "legacy parameter for pagination.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -145426,7 +145318,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -145519,7 +145411,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -145576,7 +145468,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -145598,7 +145490,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -145742,7 +145634,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -146135,7 +146027,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -146452,7 +146344,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -146593,7 +146485,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -150423,7 +150315,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -150489,9 +150381,27 @@ "type": "string" } }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -150502,7 +150412,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -151085,7 +150995,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -151154,7 +151064,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -151236,7 +151146,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -151298,11 +151208,19 @@ "type": "integer", "default": 1 } + }, + { + "name": "app_id", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -152285,7 +152203,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -152333,7 +152251,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -154583,18 +154501,36 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true + }, + { + "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", + "description": "Response", "content": { "application/json": { "schema": { @@ -156289,7 +156225,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -156351,7 +156287,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -156380,7 +156316,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -156599,7 +156535,7 @@ } }, "301": { - "description": "Moved Permanently" + "description": "Moved permanently" } }, "x-github": { @@ -156661,7 +156597,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -158524,7 +158460,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -158586,7 +158522,7 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { @@ -158606,7 +158542,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/vnd.github.v3.object": { "schema": { @@ -159218,7 +159154,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -159301,7 +159237,7 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { @@ -159412,7 +159348,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -159628,7 +159564,7 @@ } }, "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -159844,7 +159780,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -159864,7 +159800,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -159993,7 +159929,7 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { @@ -160067,7 +160003,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -160268,7 +160204,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -160337,7 +160273,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -160377,7 +160313,7 @@ } }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -160619,7 +160555,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -160716,7 +160652,8 @@ "required": false, "schema": { "type": "string", - "default": "none" + "default": "none", + "nullable": true } }, { @@ -160740,7 +160677,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -161407,7 +161344,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -161916,48 +161853,6 @@ "transient_environment": false, "production_environment": true } - }, - "advanced-example": { - "summary": "Advanced example", - "value": { - "url": "https://api.github.com/repos/octocat/example/deployments/1", - "id": 1, - "node_id": "MDEwOkRlcGxveW1lbnQx", - "sha": "a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d", - "ref": "topic-branch", - "task": "deploy", - "payload": { - }, - "original_environment": "staging", - "environment": "production", - "description": "Deploy request from hubot", - "creator": { - "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 - }, - "created_at": "2012-07-20T01:19:13Z", - "updated_at": "2012-07-20T01:19:13Z", - "statuses_url": "https://api.github.com/repos/octocat/example/deployments/1/statuses", - "repository_url": "https://api.github.com/repos/octocat/example", - "transient_environment": false, - "production_environment": true - } } } } @@ -161986,40 +161881,10 @@ } }, "409": { - "description": "response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string", - "example": "\"https://docs.github.com/enterprise-server@3.0/rest/reference/repos#create-a-deployment\"" - } - } - }, - "examples": { - "merge-conflict-response": { - "summary": "Merge conflict response", - "value": { - "message": "Conflict merging master into topic-branch" - } - }, - "failed-commit-status-checks": { - "summary": "Failed commit status checks", - "value": { - "message": "Conflict: Commit status checks failed for topic-branch." - } - } - } - } - } + "description": "Response when there is a merge conflict or the commit's status checks failed" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -162144,7 +162009,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -162658,7 +162523,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -162732,10 +162597,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -162755,7 +162620,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -162855,7 +162720,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -163379,7 +163244,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -163524,7 +163389,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -164043,7 +163908,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -164181,7 +164046,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -164692,7 +164557,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -164712,7 +164577,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -164816,10 +164681,10 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -164949,7 +164814,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -167667,7 +167532,8 @@ "enum": [ "newest", "oldest", - "stargazers" + "stargazers", + "watchers" ], "default": "newest" } @@ -167689,11 +167555,31 @@ "type": "integer", "default": 1 } + }, + { + "name": "org", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "organization", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -169409,6 +169295,26 @@ "schema": { "type": "string" } + }, + { + "name": "org", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "organization", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } } ], "requestBody": { @@ -169416,6 +169322,7 @@ "application/json": { "schema": { "type": "object", + "nullable": true, "properties": { "organization": { "type": "string", @@ -169428,7 +169335,7 @@ }, "responses": { "202": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -170577,7 +170484,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -170666,7 +170573,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -170756,7 +170663,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -170796,7 +170703,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -170856,7 +170763,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -170976,7 +170883,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -171033,7 +170940,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -171053,7 +170960,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -171268,7 +171175,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -171484,7 +171391,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -171553,7 +171460,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -171626,7 +171533,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -171834,7 +171741,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -171896,7 +171803,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -171925,7 +171832,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -172058,7 +171965,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -172069,7 +171976,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -172137,7 +172044,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -172231,7 +172138,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -172307,7 +172214,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -172418,7 +172325,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -172456,7 +172363,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -172524,7 +172431,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -172633,7 +172540,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -172644,10 +172551,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -172826,7 +172733,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -172973,7 +172880,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -173093,7 +173000,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -173232,7 +173139,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -173366,7 +173273,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -173494,7 +173401,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -173563,7 +173470,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -173649,7 +173556,8 @@ "required": true, "schema": { "type": "string" - } + }, + "x-multi-segment": true }, { "name": "recursive", @@ -173663,7 +173571,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -173817,7 +173725,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -173886,7 +173794,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -173967,7 +173875,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -174164,7 +174072,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -174309,7 +174217,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -174501,7 +174409,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -174521,7 +174429,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -174661,7 +174569,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -174845,7 +174753,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -174998,7 +174906,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -175182,7 +175090,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -175251,7 +175159,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -175320,10 +175228,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -175394,7 +175302,7 @@ ], "responses": { "200": { - "description": "Default response", + "description": "Response", "content": { "application/json": { "schema": { @@ -175526,7 +175434,7 @@ }, "responses": { "200": { - "description": "Default response", + "description": "Response", "content": { "application/json": { "schema": { @@ -175622,10 +175530,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -175696,10 +175604,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -175762,7 +175670,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -176269,10 +176177,10 @@ } }, "301": { - "description": "Moved Permanently" + "description": "Moved permanently" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -176353,7 +176261,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -178343,7 +178251,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -180297,7 +180205,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -180459,7 +180367,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -182629,10 +182537,10 @@ } }, "301": { - "description": "Moved Permanently" + "description": "Moved permanently" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -182701,7 +182609,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -182860,7 +182768,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -185216,7 +185124,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -185285,7 +185193,7 @@ } }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -185306,7 +185214,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -185444,7 +185352,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -185989,7 +185897,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -186058,7 +185966,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -186134,7 +186042,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -186666,7 +186574,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -186761,7 +186669,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -187293,7 +187201,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -187412,7 +187320,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -187504,7 +187412,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -187713,7 +187621,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -187733,7 +187641,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -188232,7 +188140,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -188254,7 +188162,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -188387,7 +188295,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -188455,7 +188363,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -191557,7 +191465,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -191681,7 +191589,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -194770,7 +194678,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -194886,7 +194794,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -197214,10 +197122,10 @@ } }, "301": { - "description": "Moved Permanently" + "description": "Moved permanently" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -197257,7 +197165,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -197416,7 +197324,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -199744,7 +199652,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -199813,7 +199721,7 @@ } }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -199854,10 +199762,10 @@ } }, "301": { - "description": "Moved Permanently" + "description": "Moved permanently" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -199973,7 +199881,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -202244,7 +202152,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -204520,7 +204428,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -205065,7 +204973,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -205180,7 +205088,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -205760,7 +205668,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -205829,7 +205737,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -205920,7 +205828,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -206273,7 +206181,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -206461,7 +206369,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -206564,7 +206472,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -206707,7 +206615,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -206810,7 +206718,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -206929,7 +206837,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "410": { "description": "Gone", @@ -207012,7 +206920,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -207086,7 +206994,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -207200,7 +207108,7 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -207243,7 +207151,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -207263,7 +207171,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -207382,7 +207290,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -207405,7 +207313,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -207514,7 +207422,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -207723,7 +207631,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -207763,7 +207671,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -207870,7 +207778,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -208066,7 +207974,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -208088,7 +207996,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -208221,7 +208129,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -208298,7 +208206,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -208557,7 +208465,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -208597,7 +208505,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -208689,7 +208597,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -208831,7 +208739,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -208896,7 +208804,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -209017,7 +208925,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -209074,7 +208982,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -209144,7 +209052,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -209208,7 +209116,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -209299,7 +209207,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -209391,7 +209299,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -209468,7 +209376,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -209537,7 +209445,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -209608,7 +209516,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -209677,7 +209585,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -209774,7 +209682,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -209892,7 +209800,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -209938,7 +209846,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -210004,7 +209912,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -210830,63 +210738,10 @@ } }, "404": { - "description": "response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string", - "example": "\"https://docs.github.com/enterprise-server@3.0/rest/reference/repos#perform-a-merge\"" - } - } - }, - "examples": { - "missing-base-response": { - "summary": "Missing base response", - "value": { - "message": "Base does not exist" - } - }, - "missing-head-response": { - "summary": "Missing head response", - "value": { - "message": "Head does not exist" - } - } - } - } - } + "description": "Response when the base or head does not exist" }, "409": { - "description": "Merge conflict response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string", - "example": "\"https://docs.github.com/enterprise-server@3.0/rest/reference/repos#perform-a-merge\"" - } - } - }, - "examples": { - "merge-conflict-response": { - "value": { - "message": "Merge Conflict" - } - } - } - } - } + "description": "Response when there is a merge conflict" }, "403": { "description": "Forbidden", @@ -210909,7 +210764,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -211082,7 +210937,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -211363,7 +211218,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -211465,7 +211320,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -211741,7 +211596,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -211761,7 +211616,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -211882,7 +211737,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -212150,7 +212005,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -212258,7 +212113,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -212576,10 +212431,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -212669,7 +212524,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -212859,7 +212714,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -214574,7 +214429,7 @@ }, "responses": { "202": { - "description": "response" + "description": "Response" } }, "x-github": { @@ -214620,7 +214475,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -214713,7 +214568,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -214817,7 +214672,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -214910,7 +214765,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -214979,7 +214834,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -215131,10 +214986,10 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -215298,10 +215153,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -215370,7 +215225,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -215392,7 +215247,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -215477,7 +215332,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -215740,7 +215595,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -215818,7 +215673,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -216078,7 +215933,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -216344,11 +216199,39 @@ "type": "integer", "default": 1 } + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -216442,7 +216325,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -216529,7 +216412,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -216748,7 +216631,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -217017,7 +216900,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -217057,7 +216940,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -217097,7 +216980,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -217198,7 +217081,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -217454,7 +217337,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -217494,7 +217377,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -217534,7 +217417,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -217691,7 +217574,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -221521,10 +221404,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -221683,7 +221566,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -224714,7 +224597,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -224826,16 +224709,15 @@ }, { "name": "sort", - "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to).", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "created", - "updated" - ], - "default": "created" + "updated", + "created_at" + ] } }, { @@ -224881,7 +224763,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -225407,7 +225289,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -225859,7 +225741,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -225959,7 +225841,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -226465,10 +226347,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -226577,7 +226459,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -226786,7 +226668,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -226806,7 +226688,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -227305,7 +227187,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -227327,7 +227209,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -227460,7 +227342,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -230521,7 +230403,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "500": { "description": "Internal Error", @@ -230544,7 +230426,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -230654,7 +230536,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -233657,7 +233539,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -233851,7 +233733,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -234457,7 +234339,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -234917,7 +234799,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -235092,7 +234974,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -235552,7 +235434,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -235642,7 +235524,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -236290,7 +236172,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -236391,7 +236273,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -236706,7 +236588,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -236795,7 +236677,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -236885,7 +236767,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -237247,7 +237129,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -241215,10 +241097,10 @@ }, "responses": { "200": { - "description": "response" + "description": "Response" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -241775,7 +241657,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -242051,7 +241933,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -242162,7 +242044,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -242438,7 +242320,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -242537,7 +242419,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -242813,7 +242695,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -242901,7 +242783,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -243177,7 +243059,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -243207,7 +243089,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -243305,7 +243187,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -243706,7 +243588,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -243808,7 +243690,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -244084,7 +243966,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -244104,7 +243986,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -244221,7 +244103,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -244497,7 +244379,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -244517,7 +244399,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -244637,7 +244519,7 @@ }, "responses": { "202": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -244659,7 +244541,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -244748,7 +244630,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -244824,6 +244706,279 @@ } } ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Content File", + "description": "Content File", + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "encoding": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "path": { + "type": "string" + }, + "content": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "git_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "download_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "_links": { + "type": "object", + "properties": { + "git": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html": { + "type": "string", + "format": "uri", + "nullable": true + }, + "self": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "git", + "html", + "self" + ] + }, + "target": { + "type": "string", + "example": "\"actual/actual.md\"" + }, + "submodule_git_url": { + "type": "string", + "example": "\"git://example.com/defunkt/dotjs.git\"" + } + }, + "required": [ + "_links", + "git_url", + "html_url", + "download_url", + "name", + "path", + "sha", + "size", + "type", + "url", + "content", + "encoding" + ] + }, + "examples": { + "default": { + "value": { + "type": "file", + "encoding": "base64", + "size": 5362, + "name": "README.md", + "path": "README.md", + "content": "encoded content ...", + "sha": "3d21ec53a331a6f037a91c368710b99387d012c1", + "url": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md", + "git_url": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1", + "html_url": "https://github.com/octokit/octokit.rb/blob/master/README.md", + "download_url": "https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md", + "_links": { + "git": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1", + "self": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md", + "html": "https://github.com/octokit/octokit.rb/blob/master/README.md" + } + } + } + } + } + } + }, + "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" + } + } + } + } + } + }, + "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" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "repos", + "subcategory": "contents" + } + } + }, + "/repos/{owner}/{repo}/readme/{dir}": { + "get": { + "summary": "Get a repository README", + "description": "Gets the preferred README for a repository.\n\nREADMEs support [custom media types](https://docs.github.com/enterprise-server@3.0/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML.", + "tags": [ + "repos" + ], + "operationId": "repos/get-readme-from-alt-path", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#get-a-repository-readme" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "dir", + "description": "The alternate path to look for a README file", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + }, + { + "name": "ref", + "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], "responses": { "200": { "description": "response", @@ -244948,7 +245103,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -244968,7 +245123,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -245098,7 +245253,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -245598,7 +245753,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -245707,7 +245862,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -246202,7 +246357,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -246556,7 +246711,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -246576,7 +246731,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -246678,7 +246833,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -246960,7 +247115,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -247006,7 +247161,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -247535,7 +247690,7 @@ }, { "name": "tag", - "description": "tag+ parameter", + "description": "tag parameter", "in": "path", "required": true, "schema": { @@ -247546,7 +247701,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -248033,7 +248188,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -248592,7 +248747,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -248705,7 +248860,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -249242,7 +249397,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -249315,7 +249470,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -249938,7 +250093,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -250262,7 +250417,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -250446,7 +250601,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -250947,7 +251102,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -251144,7 +251299,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -251419,7 +251574,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -251763,7 +251918,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -251866,7 +252021,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -251930,7 +252085,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -252062,7 +252217,7 @@ ], "responses": { "302": { - "description": "response", + "description": "Response", "headers": { "Location": { "example": "https://codeload.github.com/me/myprivate/legacy.zip/master?login=me&token=thistokenexpires", @@ -252134,7 +252289,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -252352,11 +252507,29 @@ "schema": { "type": "string" } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -252391,7 +252564,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -252413,7 +252586,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -252507,7 +252680,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -252542,7 +252715,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -252564,7 +252737,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -252584,7 +252757,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -252693,7 +252866,7 @@ }, "responses": { "202": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -253831,7 +254004,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -253879,7 +254052,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -253937,7 +254110,7 @@ ], "responses": { "302": { - "description": "response", + "description": "Response", "headers": { "Location": { "example": "https://codeload.github.com/me/myprivate/legacy.zip/master?login=me&token=thistokenexpires", @@ -253962,7 +254135,7 @@ "/repos/{template_owner}/{template_repo}/generate": { "post": { "summary": "Create a repository using a template", - "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@3.0/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", + "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@3.0/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository", "tags": [ "repos" ], @@ -254034,7 +254207,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -255148,7 +255321,7 @@ "/repositories": { "get": { "summary": "List public repositories", - "description": "Lists all public repositories in the order that they were created.\n\nNote: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.0/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.", + "description": "Lists all public repositories in the order that they were created.\n\nNotes:\n- For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise.\n- Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.0/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.", "tags": [ "repos" ], @@ -255169,7 +255342,7 @@ }, { "name": "visibility", - "description": "Specifies the types of repositories to return. Can be one of `all` or `public`. Default: `public`.", + "description": "Specifies the types of repositories to return. Can be one of `all` or `public`. Default: `public`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise.", "in": "query", "required": false, "schema": { @@ -255185,7 +255358,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -256765,7 +256938,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -256834,7 +257007,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -256917,7 +257090,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -258617,10 +258790,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -258641,7 +258814,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -258811,7 +258984,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -260804,10 +260977,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -260923,7 +261096,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -263069,7 +263242,7 @@ } }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -263090,7 +263263,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -263159,7 +263332,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -263254,7 +263427,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -263392,10 +263565,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -263435,7 +263608,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -263587,7 +263760,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -264296,7 +264469,7 @@ } }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -264317,7 +264490,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -264386,7 +264559,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -264429,7 +264602,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -264703,10 +264876,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -264814,7 +264987,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -265058,10 +265231,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -265082,7 +265255,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -265176,7 +265349,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -265263,7 +265436,7 @@ }, "responses": { "202": { - "description": "response" + "description": "Response" } }, "x-github": { @@ -265291,7 +265464,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -265372,7 +265545,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -265473,7 +265646,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -266082,7 +266255,7 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "requestBody": { @@ -266128,7 +266301,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -266190,7 +266363,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -266270,7 +266443,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -266352,7 +266525,7 @@ }, "responses": { "202": { - "description": "response" + "description": "Response" } }, "requestBody": { @@ -266406,7 +266579,7 @@ }, "responses": { "202": { - "description": "response" + "description": "Response" } }, "requestBody": { @@ -266459,7 +266632,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -266949,7 +267122,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -267055,7 +267228,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -267545,7 +267718,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -267565,7 +267738,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -267690,10 +267863,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -267713,7 +267886,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -267852,7 +268025,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -268267,7 +268440,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -268648,7 +268821,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -269048,7 +269221,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -269426,7 +269599,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -269507,7 +269680,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -269885,7 +270058,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -270240,7 +270413,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -270613,7 +270786,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -270965,7 +271138,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -271059,7 +271232,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -271355,7 +271528,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -271638,7 +271811,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -271926,7 +272099,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -272197,7 +272370,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -272353,7 +272526,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -272469,74 +272642,13 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { "description": "Response if team synchronization is set up" }, "422": { - "description": "response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "field": { - "type": "string" - }, - "resource": { - "type": "string" - } - } - } - }, - "documentation_url": { - "type": "string", - "example": "\"https://docs.github.com/enterprise-server@3.0/rest\"" - } - } - }, - "examples": { - "response-if-you-attempt-to-add-an-organization-to-a-team": { - "summary": "Response if you attempt to add an organization to a team", - "value": { - "message": "Cannot add an organization as a member.", - "errors": [ - { - "code": "org", - "field": "user", - "resource": "TeamMember" - } - ] - } - }, - "response-if-you-attempt-to-add-a-user-to-a-team-when-they-are-not-a-member-of-at-least-one-other-team-in-the-same-organization": { - "summary": "Response if you attempt to add a user to a team when they are not a member of at least one other team in the same organization", - "value": { - "message": "User isn't a member of this organization. Please invite them first.", - "errors": [ - { - "code": "unaffiliated", - "field": "user", - "resource": "TeamMember" - } - ] - } - } - } - } - } + "description": "Response if you attempt to add an organization to a team or you attempt to add a user to a team when they are not a member of at least one other team in the same organization" }, "403": { "description": "Forbidden", @@ -272603,7 +272715,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { "description": "Response if team synchronization is setup" @@ -272626,7 +272738,7 @@ "/teams/{team_id}/memberships/{username}": { "get": { "summary": "Get team membership for a user (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 [Get team membership for a user](https://docs.github.com/enterprise-server@3.0/rest/reference/teams#get-team-membership-for-a-user) endpoint.\n\nTeam members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:** The `role` for organization owners returns as `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@3.0/rest/reference/teams#create-a-team).", + "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 [Get team membership for a user](https://docs.github.com/enterprise-server@3.0/rest/reference/teams#get-team-membership-for-a-user) endpoint.\n\nTeam members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:**\nThe response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@3.0/rest/reference/teams#create-a-team).", "tags": [ "teams" ], @@ -272655,7 +272767,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -272678,7 +272790,12 @@ "type": "string" }, "state": { - "type": "string" + "description": "The state of the user's membership in the team.", + "type": "string", + "enum": [ + "active", + "pending" + ] } }, "required": [ @@ -272688,14 +272805,6 @@ ] }, "examples": { - "response-if-user-has-an-active-membership-with-team": { - "summary": "Response if user has an active membership with team", - "value": { - "url": "https://api.github.com/teams/1/memberships/octocat", - "role": "member", - "state": "active" - } - }, "response-if-user-is-a-team-maintainer": { "summary": "Response if user is a team maintainer", "value": { @@ -272703,21 +272812,13 @@ "role": "maintainer", "state": "active" } - }, - "response-if-user-has-a-pending-membership-with-team": { - "summary": "Response if user has a pending membership with team", - "value": { - "url": "https://api.github.com/teams/1/memberships/octocat", - "role": "member", - "state": "pending" - } } } } } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -272801,7 +272902,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -272824,7 +272925,12 @@ "type": "string" }, "state": { - "type": "string" + "description": "The state of the user's membership in the team.", + "type": "string", + "enum": [ + "active", + "pending" + ] } }, "required": [ @@ -272834,14 +272940,6 @@ ] }, "examples": { - "response-if-users-membership-with-team-is-now-active": { - "summary": "Response if user's membership with team is now active", - "value": { - "url": "https://api.github.com/teams/1/memberships/octocat", - "role": "member", - "state": "active" - } - }, "response-if-users-membership-with-team-is-now-pending": { "summary": "Response if user's membership with team is now pending", "value": { @@ -272858,57 +272956,10 @@ "description": "Response if team synchronization is set up" }, "422": { - "description": "Response if you attempt to add an organization to a team", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "field": { - "type": "string" - }, - "resource": { - "type": "string" - } - } - } - }, - "documentation_url": { - "type": "string", - "example": "\"https://help.github.com/articles/github-and-trade-controls\"" - } - } - }, - "examples": { - "response-if-you-attempt-to-add-an-organization-to-a-team": { - "value": { - "message": "Cannot add an organization as a member.", - "errors": [ - { - "code": "org", - "field": "user", - "resource": "TeamMember" - } - ] - } - } - } - } - } + "description": "Response if you attempt to add an organization to a team" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -272972,7 +273023,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Response if team synchronization is set up" @@ -273034,7 +273085,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -273298,7 +273349,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -273318,7 +273369,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -273390,7 +273441,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -273644,7 +273695,7 @@ "description": "Response if project is not managed by this team" }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -273734,7 +273785,7 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Response if the project is not owned by the organization", @@ -273763,7 +273814,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -273783,7 +273834,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -273805,7 +273856,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -273922,10 +273973,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -273945,7 +273996,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -273967,7 +274018,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -274092,7 +274143,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -275827,7 +275878,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -277842,7 +277893,7 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -277865,7 +277916,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -277986,7 +278037,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -278236,7 +278287,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -278276,7 +278327,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -278376,7 +278427,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -278919,7 +278970,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -278942,7 +278993,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -279038,7 +279089,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -279339,10 +279390,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -279382,7 +279433,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -279402,7 +279453,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -279516,7 +279567,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -279577,10 +279628,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -279620,7 +279671,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -279713,7 +279764,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -279778,7 +279829,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -279847,10 +279898,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -279890,7 +279941,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -279981,13 +280032,13 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -280027,7 +280078,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -280047,7 +280098,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -280161,7 +280212,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -280317,7 +280368,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -280340,7 +280391,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -280405,7 +280456,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -280561,7 +280612,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -280584,7 +280635,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -280662,7 +280713,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -280685,7 +280736,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -280738,13 +280789,13 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -280784,7 +280835,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -280837,13 +280888,13 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -280883,7 +280934,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -280948,7 +280999,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -281170,10 +281221,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -281213,7 +281264,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -281277,7 +281328,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -281486,7 +281537,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -281555,10 +281606,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -281598,7 +281649,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -281654,7 +281705,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -281863,7 +281914,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -281883,7 +281934,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -281906,7 +281957,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -281960,10 +282011,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -281983,7 +282034,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -282052,7 +282103,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -282075,7 +282126,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -282723,7 +282774,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -282746,7 +282797,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -282766,7 +282817,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -283968,7 +284019,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -284008,7 +284059,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -284059,7 +284110,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -284082,10 +284133,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -284147,7 +284198,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -284170,10 +284221,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -284229,6 +284280,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -284317,7 +284369,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -286760,7 +286812,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -286780,7 +286832,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -286832,7 +286884,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -286918,10 +286970,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -286961,7 +287013,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -287031,7 +287083,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -287094,7 +287146,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -287163,10 +287215,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -287206,7 +287258,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -287262,7 +287314,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -287325,7 +287377,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -287345,7 +287397,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -287368,7 +287420,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -287422,13 +287474,13 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -287468,7 +287520,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -287546,7 +287598,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -287563,11 +287615,21 @@ }, "state": { "type": "string", - "example": "active" + "description": "The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.", + "example": "active", + "enum": [ + "active", + "pending" + ] }, "role": { "type": "string", - "example": "admin" + "description": "The user's membership type in the organization.", + "example": "admin", + "enum": [ + "admin", + "member" + ] }, "organization_url": { "type": "string", @@ -287884,7 +287946,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -287907,7 +287969,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -287927,7 +287989,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -288031,7 +288093,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -288046,11 +288108,21 @@ }, "state": { "type": "string", - "example": "active" + "description": "The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.", + "example": "active", + "enum": [ + "active", + "pending" + ] }, "role": { "type": "string", - "example": "admin" + "description": "The user's membership type in the organization.", + "example": "admin", + "enum": [ + "admin", + "member" + ] }, "organization_url": { "type": "string", @@ -288336,7 +288408,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -288413,7 +288485,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -288428,11 +288500,21 @@ }, "state": { "type": "string", - "example": "active" + "description": "The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.", + "example": "active", + "enum": [ + "active", + "pending" + ] }, "role": { "type": "string", - "example": "admin" + "description": "The user's membership type in the organization.", + "example": "admin", + "enum": [ + "admin", + "member" + ] }, "organization_url": { "type": "string", @@ -288718,7 +288800,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -288738,7 +288820,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -288852,7 +288934,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -288963,7 +289045,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -288986,7 +289068,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -289059,7 +289141,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -289315,7 +289397,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -289338,7 +289420,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -289358,7 +289440,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -289380,7 +289462,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -289459,7 +289541,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -289520,10 +289602,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -289563,7 +289645,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -289609,7 +289691,7 @@ "parameters": [ { "name": "visibility", - "description": "Can be one of `all`, `public`, or `private`.", + "description": "Can be one of `all`, `public`, or `private`. Note: For GitHub AE, can be one of `all`, `internal`, or `private`.", "in": "query", "required": false, "schema": { @@ -289634,7 +289716,7 @@ }, { "name": "type", - "description": "Can be one of `all`, `owner`, `public`, `private`, `member`. Default: `all` \n \nWill cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.", + "description": "Can be one of `all`, `owner`, `public`, `private`, `member`. Note: For GitHub AE, can be one of `all`, `owner`, `internal`, `private`, `member`. Default: `all` \n \nWill cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.", "in": "query", "required": false, "schema": { @@ -289717,7 +289799,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -290818,7 +290900,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -290887,7 +290969,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -290910,7 +290992,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -290942,7 +291024,7 @@ }, "post": { "summary": "Create a repository for the authenticated user", - "description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", + "description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository.", "tags": [ "repos" ], @@ -290973,7 +291055,7 @@ "type": "string" }, "private": { - "description": "Whether the repository is private or public.", + "description": "Whether the repository is private.", "default": false, "type": "boolean" }, @@ -291061,7 +291143,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -292164,7 +292246,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -292184,10 +292266,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -292227,7 +292309,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -292404,7 +292486,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -294320,10 +294402,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -294363,7 +294445,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -294419,7 +294501,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -294462,7 +294544,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -294482,7 +294564,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -294519,7 +294601,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "409": { "description": "Conflict", @@ -294542,10 +294624,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -294658,7 +294740,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -296881,7 +296963,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -296904,7 +296986,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -296990,7 +297072,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -297010,7 +297092,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -297074,7 +297156,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -297097,7 +297179,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -297117,7 +297199,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -297137,7 +297219,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -297181,10 +297263,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -297204,7 +297286,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -297224,7 +297306,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -297292,7 +297374,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -299027,7 +299109,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -299050,7 +299132,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -299115,7 +299197,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -299618,10 +299700,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -299706,7 +299788,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -299862,7 +299944,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -299900,7 +299982,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -300439,7 +300521,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -300512,7 +300594,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -303241,7 +303323,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -305962,7 +306044,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -308683,7 +308765,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -308892,7 +308974,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -309159,7 +309241,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -309577,7 +309659,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -309699,7 +309781,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -309980,7 +310062,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -310027,7 +310109,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -310047,7 +310129,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -310151,7 +310233,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -310711,7 +310793,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -310809,7 +310891,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -310988,7 +311070,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -311257,7 +311339,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -311279,7 +311361,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -311405,7 +311487,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -314126,7 +314208,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -316808,7 +316890,7 @@ "/users/{username}/repos": { "get": { "summary": "List repositories for a user", - "description": "Lists public repositories for the specified user.", + "description": "Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user.", "tags": [ "repos" ], @@ -316891,7 +316973,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -318665,7 +318747,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -318701,7 +318783,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -318785,7 +318867,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -321061,7 +321143,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -322831,7 +322913,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "requestBody": { @@ -322882,7 +322964,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "requestBody": { @@ -322921,7 +323003,7 @@ "operationId": "meta/get-zen", "responses": { "200": { - "description": "response", + "description": "Response", "content": { "text/plain": { "schema": { diff --git a/lib/rest/static/dereferenced/github.ae.deref.json b/lib/rest/static/dereferenced/github.ae.deref.json index 51aea78fb5..d0c111263a 100644 --- a/lib/rest/static/dereferenced/github.ae.deref.json +++ b/lib/rest/static/dereferenced/github.ae.deref.json @@ -134,7 +134,7 @@ ], "servers": [ { - "url": "{protocol}://{hostname}", + "url": "{protocol}://api.{hostname}", "variables": { "hostname": { "description": "Self-hosted GitHub AE hostname", @@ -162,7 +162,7 @@ "operationId": "meta/root", "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -394,7 +394,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -529,7 +529,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -729,7 +729,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -859,7 +859,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -1040,7 +1040,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -1092,7 +1092,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -1140,11 +1140,48 @@ "type": "integer", "default": 1 } + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "accessed" + ], + "default": "created" + } + }, + { + "name": "since", + "description": "Only show public keys accessed after the given time.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -1242,7 +1279,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -1270,7 +1307,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -1435,7 +1472,7 @@ ], "responses": { "202": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -1519,11 +1556,39 @@ "type": "integer", "default": 1 } + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -1646,7 +1711,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -1787,7 +1852,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -1899,7 +1964,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -2076,7 +2141,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "422": { "description": "Client Errors", @@ -2164,7 +2229,7 @@ ], "responses": { "202": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -2285,7 +2350,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -2370,7 +2435,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -3068,7 +3133,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -3106,7 +3171,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -3144,7 +3209,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -3845,7 +3910,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -3876,7 +3941,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -4205,7 +4270,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -4531,7 +4596,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -4551,7 +4616,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -4606,7 +4671,7 @@ }, "responses": { "200": { - "description": "Default response", + "description": "Response", "content": { "application/json": { "schema": { @@ -4712,7 +4777,7 @@ }, "responses": { "200": { - "description": "Default response", + "description": "Response", "content": { "application/json": { "schema": { @@ -5375,7 +5440,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -5882,7 +5947,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -5902,7 +5967,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -5958,10 +6023,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -6298,7 +6363,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -7488,7 +7553,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -7510,7 +7575,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -7530,7 +7595,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -7550,7 +7615,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -7655,10 +7720,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -7712,10 +7777,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -7789,10 +7854,10 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -7905,7 +7970,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -7965,7 +8030,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -8636,7 +8701,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -8705,7 +8770,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -8777,7 +8842,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -9448,7 +9513,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -9559,7 +9624,10 @@ "type": "string", "description": "The OAuth access token used to authenticate to the GitHub API." } - } + }, + "required": [ + "access_token" + ] }, "example": { "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a" @@ -9569,10 +9637,10 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -9685,7 +9753,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -10361,7 +10429,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -10426,7 +10494,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -11142,7 +11210,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -11183,7 +11251,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -11497,7 +11565,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -11517,7 +11585,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -11567,7 +11635,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -11630,10 +11698,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -11694,7 +11762,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -11747,7 +11815,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -11767,10 +11835,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -11858,7 +11926,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -11908,7 +11976,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -11977,7 +12045,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -12017,7 +12085,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -12039,7 +12107,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -12104,10 +12172,10 @@ } } }, - "description": "response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -12135,7 +12203,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -12222,7 +12290,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -12282,7 +12350,7 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -12310,7 +12378,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -12403,7 +12471,7 @@ }, "responses": { "202": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -12455,7 +12523,7 @@ }, "responses": { "202": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -12520,7 +12588,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -12578,7 +12646,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -12655,7 +12723,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -12890,6 +12958,2013 @@ } } }, + "/enterprises/{enterprise}/actions/permissions": { + "get": { + "summary": "Get GitHub Actions permissions for an enterprise", + "description": "Gets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/get-github-actions-permissions-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#get-github-actions-permissions-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "enabled_organizations": { + "type": "string", + "description": "The policy that controls the organizations in the enterprise that are allowed to run GitHub Actions. Can be one of: `all`, `none`, or `selected`.", + "enum": [ + "all", + "none", + "selected" + ] + }, + "selected_organizations_url": { + "type": "string", + "description": "The API URL to use to get or set the selected organizations that are allowed to run GitHub Actions, when `enabled_organizations` is set to `selected`." + }, + "allowed_actions": { + "type": "string", + "description": "The permissions policy that controls the actions that are allowed to run. Can be one of: `all`, `local_only`, or `selected`.", + "enum": [ + "all", + "local_only", + "selected" + ] + }, + "selected_actions_url": { + "type": "string", + "description": "The API URL to use to get or set the actions that are allowed to run, when `allowed_actions` is set to `selected`." + } + }, + "required": [ + "enabled_organizations", + "allowed_actions" + ] + }, + "examples": { + "default": { + "value": { + "enabled_organizations": "all", + "allowed_actions": "selected", + "selected_actions_url": "https://api.github.com/enterprises/2/actions/permissions/selected-actions" + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "actions" + } + }, + "put": { + "summary": "Set GitHub Actions permissions for an enterprise", + "description": "Sets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/set-github-actions-permissions-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#set-github-actions-permissions-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "enabled_organizations": { + "type": "string", + "description": "The policy that controls the organizations in the enterprise that are allowed to run GitHub Actions. Can be one of: `all`, `none`, or `selected`.", + "enum": [ + "all", + "none", + "selected" + ] + }, + "allowed_actions": { + "type": "string", + "description": "The permissions policy that controls the actions that are allowed to run. Can be one of: `all`, `local_only`, or `selected`.", + "enum": [ + "all", + "local_only", + "selected" + ] + } + }, + "required": [ + "enabled_organizations" + ] + }, + "example": { + "enabled_organizations": "all", + "allowed_actions": "selected" + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "actions" + } + } + }, + "/enterprises/{enterprise}/actions/permissions/organizations": { + "get": { + "summary": "List selected organizations enabled for GitHub Actions in an enterprise", + "description": "Lists the organizations that are selected to have GitHub Actions enabled in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/list-selected-organizations-enabled-github-actions-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#list-selected-organizations-enabled-for-github-actions-in-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "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": "object", + "properties": { + "total_count": { + "type": "number" + }, + "organizations": { + "type": "array", + "items": { + "title": "Organization Simple", + "description": "Organization Simple", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + } + } + }, + "required": [ + "total_count", + "organizations" + ] + }, + "examples": { + "default": { + "value": { + "total_count": 1, + "organizations": [ + { + "login": "octocat", + "id": 161335, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "url": "https://api.github.com/orgs/octo-org", + "repos_url": "https://api.github.com/orgs/octo-org/repos", + "events_url": "https://api.github.com/orgs/octo-org/events", + "hooks_url": "https://api.github.com/orgs/octo-org/hooks", + "issues_url": "https://api.github.com/orgs/octo-org/issues", + "members_url": "https://api.github.com/orgs/octo-org/members{/member}", + "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + } + ] + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "actions" + } + }, + "put": { + "summary": "Set selected organizations enabled for GitHub Actions in an enterprise", + "description": "Replaces the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/set-selected-organizations-enabled-github-actions-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#set-selected-organizations-enabled-for-github-actions-in-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "selected_organization_ids": { + "description": "List of organization IDs to enable for GitHub Actions.", + "type": "array", + "items": { + "type": "integer", + "description": "Unique identifier of the organization." + } + } + }, + "required": [ + "selected_organization_ids" + ] + }, + "example": { + "selected_organization_ids": [ + 32, + 91 + ] + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "actions" + } + } + }, + "/enterprises/{enterprise}/actions/permissions/organizations/{org_id}": { + "put": { + "summary": "Enable a selected organization for GitHub Actions in an enterprise", + "description": "Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/enable-selected-organization-github-actions-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#enable-a-selected-organization-for-github-actions-in-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "org_id", + "description": "Unique identifier of an organization.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "actions" + } + }, + "delete": { + "summary": "Disable a selected organization for GitHub Actions in an enterprise", + "description": "Removes an organization from the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/disable-selected-organization-github-actions-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#disable-a-selected-organization-for-github-actions-in-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "org_id", + "description": "Unique identifier of an organization.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "actions" + } + } + }, + "/enterprises/{enterprise}/actions/permissions/selected-actions": { + "get": { + "summary": "Get allowed actions for an enterprise", + "description": "Gets the selected actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/get-allowed-actions-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#get-allowed-actions-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "github_owned_allowed": { + "type": "boolean", + "description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization." + }, + "verified_allowed": { + "type": "boolean", + "description": "Whether actions in GitHub Marketplace from verified creators are allowed. Set to `true` to allow all GitHub Marketplace actions by verified creators." + }, + "patterns_allowed": { + "type": "array", + "description": "Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"", + "items": { + "type": "string" + } + } + }, + "required": [ + "github_owned_allowed", + "patterns_allowed", + "verified_allowed" + ] + }, + "examples": { + "default": { + "value": { + "github_owned_allowed": true, + "verified_allowed": false, + "patterns_allowed": [ + "monalisa/octocat@*", + "docker/*" + ] + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "actions" + } + }, + "put": { + "summary": "Set allowed actions for an enterprise", + "description": "Sets the actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/set-allowed-actions-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#set-allowed-actions-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "github_owned_allowed": { + "type": "boolean", + "description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization." + }, + "verified_allowed": { + "type": "boolean", + "description": "Whether actions in GitHub Marketplace from verified creators are allowed. Set to `true` to allow all GitHub Marketplace actions by verified creators." + }, + "patterns_allowed": { + "type": "array", + "description": "Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"", + "items": { + "type": "string" + } + } + }, + "required": [ + "github_owned_allowed", + "patterns_allowed", + "verified_allowed" + ] + }, + "examples": { + "selected_actions": { + "value": { + "github_owned_allowed": true, + "verified_allowed": false, + "patterns_allowed": [ + "monalisa/octocat@*", + "docker/*" + ] + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "actions" + } + } + }, + "/enterprises/{enterprise}/actions/runner-groups": { + "get": { + "summary": "List self-hosted runner groups for an enterprise", + "description": "Lists all self-hosted runner groups for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/list-self-hosted-runner-groups-for-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#list-self-hosted-runner-groups-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "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": "object", + "properties": { + "total_count": { + "type": "number" + }, + "runner_groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "name": { + "type": "string" + }, + "visibility": { + "type": "string" + }, + "default": { + "type": "boolean" + }, + "selected_organizations_url": { + "type": "string" + }, + "runners_url": { + "type": "string" + }, + "allows_public_repositories": { + "type": "boolean" + } + }, + "required": [ + "id", + "name", + "visibility", + "allows_public_repositories", + "default", + "runners_url" + ] + } + } + }, + "required": [ + "total_count", + "runner_groups" + ] + }, + "examples": { + "default": { + "value": { + "total_count": 3, + "runner_groups": [ + { + "id": 1, + "name": "Default", + "visibility": "all", + "default": true, + "runners_url": "https://api.github.com/enterprises/octo-corp/actions/runner_groups/1/runners", + "allows_public_repositories": false + }, + { + "id": 2, + "name": "octo-runner-group", + "visibility": "selected", + "default": false, + "selected_organizations_url": "https://api.github.com/enterprises/octo-corp/actions/runner_groups/2/organizations", + "runners_url": "https://api.github.com/enterprises/octo-corp/actions/runner_groups/2/runners", + "allows_public_repositories": true + }, + { + "id": 3, + "name": "expensive-hardware", + "visibility": "private", + "default": false, + "runners_url": "https://api.github.com/enterprises/octo-corp/actions/runner_groups/3/runners", + "allows_public_repositories": true + } + ] + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "actions" + } + }, + "post": { + "summary": "Create a self-hosted runner group for an enterprise", + "description": "Creates a new self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/create-self-hosted-runner-group-for-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#create-self-hosted-runner-group-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "description": "Name of the runner group.", + "type": "string" + }, + "visibility": { + "description": "Visibility of a runner group. You can select all organizations or select individual organization. Can be one of: `all` or `selected`", + "type": "string", + "enum": [ + "selected", + "all" + ] + }, + "selected_organization_ids": { + "description": "List of organization IDs that can access the runner group.", + "type": "array", + "items": { + "type": "integer", + "description": "Unique identifier of the organization." + } + }, + "runners": { + "description": "List of runner IDs to add to the runner group.", + "type": "array", + "items": { + "type": "integer", + "description": "Unique identifier of the runner." + } + } + }, + "required": [ + "name" + ] + }, + "example": { + "name": "Expensive hardware runners", + "visibility": "selected", + "selected_organization_ids": [ + 32, + 91 + ], + "runners": [ + 9, + 2 + ] + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "name": { + "type": "string" + }, + "visibility": { + "type": "string" + }, + "default": { + "type": "boolean" + }, + "selected_organizations_url": { + "type": "string" + }, + "runners_url": { + "type": "string" + }, + "allows_public_repositories": { + "type": "boolean" + } + }, + "required": [ + "id", + "name", + "visibility", + "allows_public_repositories", + "default", + "runners_url" + ] + }, + "examples": { + "default": { + "value": { + "id": 2, + "name": "octo-runner-group", + "visibility": "selected", + "default": false, + "selected_organizations_url": "https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/organizations", + "runners_url": "https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/runners", + "allows_public_repositories": false + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "actions" + } + } + }, + "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}": { + "get": { + "summary": "Get a self-hosted runner group for an enterprise", + "description": "Gets a specific self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/get-self-hosted-runner-group-for-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#get-a-self-hosted-runner-group-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "name": { + "type": "string" + }, + "visibility": { + "type": "string" + }, + "default": { + "type": "boolean" + }, + "selected_organizations_url": { + "type": "string" + }, + "runners_url": { + "type": "string" + }, + "allows_public_repositories": { + "type": "boolean" + } + }, + "required": [ + "id", + "name", + "visibility", + "allows_public_repositories", + "default", + "runners_url" + ] + }, + "examples": { + "default": { + "value": { + "id": 2, + "name": "octo-runner-group", + "visibility": "selected", + "default": false, + "selected_organizations_url": "https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/organizations", + "runners_url": "https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/runners", + "allows_public_repositories": false + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "actions" + } + }, + "patch": { + "summary": "Update a self-hosted runner group for an enterprise", + "description": "Updates the `name` and `visibility` of a self-hosted runner group in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/update-self-hosted-runner-group-for-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#update-a-self-hosted-runner-group-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "description": "Name of the runner group.", + "type": "string" + }, + "visibility": { + "description": "Visibility of a runner group. You can select all organizations or select individual organizations. Can be one of: `all` or `selected`", + "type": "string", + "enum": [ + "selected", + "all" + ], + "default": "all" + } + } + }, + "example": { + "name": "Expensive hardware runners", + "visibility": "selected" + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "name": { + "type": "string" + }, + "visibility": { + "type": "string" + }, + "default": { + "type": "boolean" + }, + "selected_organizations_url": { + "type": "string" + }, + "runners_url": { + "type": "string" + }, + "allows_public_repositories": { + "type": "boolean" + } + }, + "required": [ + "id", + "name", + "visibility", + "allows_public_repositories", + "default", + "runners_url" + ] + }, + "examples": { + "default": { + "value": { + "id": 2, + "name": "Expensive hardware runners", + "visibility": "selected", + "default": false, + "selected_organizations_url": "https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/organizations", + "runners_url": "https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/runners", + "allows_public_repositories": true + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "actions" + } + }, + "delete": { + "summary": "Delete a self-hosted runner group from an enterprise", + "description": "Deletes a self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/delete-self-hosted-runner-group-from-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#delete-a-self-hosted-runner-group-from-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "actions" + } + } + }, + "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners": { + "get": { + "summary": "List self-hosted runners in a group for an enterprise", + "description": "Lists the self-hosted runners that are in a specific enterprise group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/list-self-hosted-runners-in-group-for-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#list-self-hosted-runners-in-a-group-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "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": "object", + "properties": { + "total_count": { + "type": "number" + }, + "runners": { + "type": "array", + "items": { + "title": "Self hosted runners", + "description": "A self hosted runner", + "type": "object", + "properties": { + "id": { + "description": "The id of the runner.", + "type": "integer", + "example": 5 + }, + "name": { + "description": "The name of the runner.", + "type": "string", + "example": "iMac" + }, + "os": { + "description": "The Operating System of the runner.", + "type": "string", + "example": "macos" + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "example": "online" + }, + "busy": { + "type": "boolean" + }, + "labels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the label." + }, + "name": { + "type": "string", + "description": "Name of the label." + }, + "type": { + "type": "string", + "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", + "enum": [ + "read-only", + "custom" + ] + } + } + } + } + }, + "required": [ + "id", + "name", + "os", + "status", + "busy", + "labels" + ] + } + } + }, + "required": [ + "total_count", + "runners" + ] + }, + "examples": { + "default": { + "value": { + "total_count": 2, + "runners": [ + { + "id": 23, + "name": "linux_runner", + "os": "linux", + "status": "online", + "busy": true, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 11, + "name": "Linux", + "type": "read-only" + } + ] + }, + { + "id": 24, + "name": "mac_runner", + "os": "macos", + "status": "offline", + "busy": false, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 20, + "name": "macOS", + "type": "read-only" + }, + { + "id": 21, + "name": "no-gpu", + "type": "custom" + } + ] + } + ] + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "actions" + } + }, + "put": { + "summary": "Set self-hosted runners in a group for an enterprise", + "description": "Replaces the list of self-hosted runners that are part of an enterprise runner group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/set-self-hosted-runners-in-group-for-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#set-self-hosted-runners-in-a-group-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "runners": { + "description": "List of runner IDs to add to the runner group.", + "type": "array", + "items": { + "type": "integer", + "description": "Unique identifier of the runner." + } + } + }, + "required": [ + "runners" + ] + }, + "example": { + "runners": [ + 9, + 2 + ] + } + } + } + }, + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "actions" + } + } + }, + "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": { + "put": { + "summary": "Add a self-hosted runner to a group for an enterprise", + "description": "Adds a self-hosted runner to a runner group configured in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise`\nscope to use this endpoint.", + "operationId": "enterprise-admin/add-self-hosted-runner-to-group-for-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#add-a-self-hosted-runner-to-a-group-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "actions" + } + }, + "delete": { + "summary": "Remove a self-hosted runner from a group for an enterprise", + "description": "Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#remove-a-self-hosted-runner-from-a-group-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "actions" + } + } + }, + "/enterprises/{enterprise}/actions/runners": { + "get": { + "summary": "List self-hosted runners for an enterprise", + "description": "Lists all self-hosted runners configured for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/list-self-hosted-runners-for-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#list-self-hosted-runners-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "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": "object", + "properties": { + "total_count": { + "type": "number" + }, + "runners": { + "type": "array", + "items": { + "title": "Self hosted runners", + "description": "A self hosted runner", + "type": "object", + "properties": { + "id": { + "description": "The id of the runner.", + "type": "integer", + "example": 5 + }, + "name": { + "description": "The name of the runner.", + "type": "string", + "example": "iMac" + }, + "os": { + "description": "The Operating System of the runner.", + "type": "string", + "example": "macos" + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "example": "online" + }, + "busy": { + "type": "boolean" + }, + "labels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the label." + }, + "name": { + "type": "string", + "description": "Name of the label." + }, + "type": { + "type": "string", + "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", + "enum": [ + "read-only", + "custom" + ] + } + } + } + } + }, + "required": [ + "id", + "name", + "os", + "status", + "busy", + "labels" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 2, + "runners": [ + { + "id": 23, + "name": "linux_runner", + "os": "linux", + "status": "online", + "busy": true, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 11, + "name": "Linux", + "type": "read-only" + } + ] + }, + { + "id": 24, + "name": "mac_runner", + "os": "macos", + "status": "offline", + "busy": false, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 20, + "name": "macOS", + "type": "read-only" + }, + { + "id": 21, + "name": "no-gpu", + "type": "custom" + } + ] + } + ] + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "actions" + } + } + }, + "/enterprises/{enterprise}/actions/runners/{runner_id}": { + "get": { + "summary": "Get a self-hosted runner for an enterprise", + "description": "Gets a specific self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/get-self-hosted-runner-for-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#get-a-self-hosted-runner-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Self hosted runners", + "description": "A self hosted runner", + "type": "object", + "properties": { + "id": { + "description": "The id of the runner.", + "type": "integer", + "example": 5 + }, + "name": { + "description": "The name of the runner.", + "type": "string", + "example": "iMac" + }, + "os": { + "description": "The Operating System of the runner.", + "type": "string", + "example": "macos" + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "example": "online" + }, + "busy": { + "type": "boolean" + }, + "labels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the label." + }, + "name": { + "type": "string", + "description": "Name of the label." + }, + "type": { + "type": "string", + "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", + "enum": [ + "read-only", + "custom" + ] + } + } + } + } + }, + "required": [ + "id", + "name", + "os", + "status", + "busy", + "labels" + ] + }, + "examples": { + "default": { + "value": { + "id": 23, + "name": "MBP", + "os": "macos", + "status": "online", + "busy": true, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 20, + "name": "macOS", + "type": "read-only" + }, + { + "id": 21, + "name": "no-gpu", + "type": "custom" + } + ] + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "actions" + } + }, + "delete": { + "summary": "Delete a self-hosted runner from an enterprise", + "description": "Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/delete-self-hosted-runner-from-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#delete-self-hosted-runner-from-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "actions" + } + } + }, "/events": { "get": { "summary": "List public events", @@ -12924,7 +14999,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -15592,7 +17667,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -15615,7 +17690,7 @@ } }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -15664,7 +17739,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -15975,7 +18050,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -16393,7 +18468,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -16502,7 +18577,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -16735,7 +18810,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -16804,10 +18879,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -16901,7 +18976,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -17319,7 +19394,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -17388,7 +19463,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -17465,7 +19540,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -17883,7 +19958,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -17903,7 +19978,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -17962,7 +20037,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -18220,7 +20295,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -18240,7 +20315,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -18347,7 +20422,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -18572,7 +20647,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -18641,7 +20716,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -18695,10 +20770,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -18718,7 +20793,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -18795,7 +20870,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -19027,10 +21102,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -19124,7 +21199,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -19351,10 +21426,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -19439,7 +21514,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -19658,10 +21733,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -19777,7 +21852,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -19996,7 +22071,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -20059,13 +22134,13 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -20159,7 +22234,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -20372,7 +22447,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -20392,7 +22467,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -20469,7 +22544,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -20738,7 +22813,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -20758,7 +22833,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -20815,7 +22890,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -21228,7 +23303,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -21248,7 +23323,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -21317,7 +23392,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -21392,7 +23467,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -21449,10 +23524,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -21472,7 +23547,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -21529,13 +23604,13 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -21619,7 +23694,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -21844,7 +23919,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -21913,7 +23988,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -21981,7 +24056,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -22003,7 +24078,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -22041,7 +24116,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -22075,7 +24150,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -22123,7 +24198,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -23265,10 +25340,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -23320,7 +25395,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -23359,6 +25434,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -23479,7 +25555,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -25922,7 +27998,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -25991,10 +28067,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -26058,11 +28134,20 @@ "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", + "description": "Response", "content": { "application/json": { "schema": { @@ -26168,7 +28253,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -26206,7 +28291,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -26359,7 +28444,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -26379,7 +28464,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -26442,7 +28527,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "headers": { "Content-Type": { "example": "text/html", @@ -26472,7 +28557,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -26517,7 +28602,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "headers": { "X-CommonMarker-Version": { "example": "0.17.4", @@ -26535,7 +28620,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -26566,7 +28651,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -26701,7 +28786,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -26765,7 +28850,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -29433,7 +31518,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -29473,10 +31558,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "301": { - "description": "Moved Permanently" + "description": "Moved permanently" } }, "x-github": { @@ -29562,7 +31647,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -31221,7 +33306,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -31244,7 +33329,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -31264,7 +33349,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -31379,7 +33464,7 @@ }, "responses": { "202": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -31394,10 +33479,10 @@ } }, "205": { - "description": "response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -31420,7 +33505,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -31476,7 +33561,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -33122,7 +35207,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -33145,7 +35230,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -33199,10 +35284,10 @@ ], "responses": { "205": { - "description": "response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -33261,7 +35346,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -33326,7 +35411,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -33349,7 +35434,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -33419,7 +35504,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -33484,7 +35569,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -33507,7 +35592,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -33561,10 +35646,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -33587,7 +35672,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -33639,7 +35724,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/octocat-stream": { "schema": { @@ -33693,7 +35778,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -33804,7 +35889,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -33842,7 +35927,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -34131,7 +36216,9 @@ "plan": { "name": "Medium", "space": 400, - "private_repos": 20 + "private_repos": 20, + "filled_seats": 4, + "seats": 5 }, "default_repository_permission": "read", "members_can_create_repositories": true, @@ -34142,54 +36229,13 @@ "members_can_create_internal_repositories": false, "members_can_create_pages": true } - }, - "response-with-git-hub-plan-information": { - "summary": "Response with GitHub plan information", - "value": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization", - "name": "github", - "company": "GitHub", - "blog": "https://github.com/blog", - "location": "San Francisco", - "email": "octocat@github.com", - "twitter_username": "github", - "is_verified": true, - "has_organization_projects": true, - "has_repository_projects": true, - "public_repos": 2, - "public_gists": 1, - "followers": 20, - "following": 0, - "html_url": "https://github.com/octocat", - "created_at": "2008-01-14T04:33:35Z", - "updated_at": "2014-03-03T18:58:10Z", - "type": "Organization", - "plan": { - "name": "team", - "space": 976562499, - "private_repos": 999999, - "filled_seats": 4, - "seats": 5 - } - } } } } } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -34361,7 +36407,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -34666,7 +36712,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -34782,7 +36828,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -34819,6 +36865,4334 @@ } } }, + "/orgs/{org}/actions/permissions": { + "get": { + "summary": "Get GitHub Actions permissions for an organization", + "description": "Gets the GitHub Actions permissions policy for repositories and allowed actions in an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", + "operationId": "actions/get-github-actions-permissions-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#get-github-actions-permissions-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "enabled_repositories": { + "type": "string", + "description": "The policy that controls the repositories in the organization that are allowed to run GitHub Actions. Can be one of: `all`, `none`, or `selected`.", + "enum": [ + "all", + "none", + "selected" + ] + }, + "selected_repositories_url": { + "type": "string", + "description": "The API URL to use to get or set the selected repositories that are allowed to run GitHub Actions, when `enabled_repositories` is set to `selected`." + }, + "allowed_actions": { + "type": "string", + "description": "The permissions policy that controls the actions that are allowed to run. Can be one of: `all`, `local_only`, or `selected`.", + "enum": [ + "all", + "local_only", + "selected" + ] + }, + "selected_actions_url": { + "type": "string", + "description": "The API URL to use to get or set the actions that are allowed to run, when `allowed_actions` is set to `selected`." + } + }, + "required": [ + "enabled_repositories", + "allowed_actions" + ] + }, + "examples": { + "default": { + "value": { + "enabled_repositories": "all", + "allowed_actions": "selected", + "selected_actions_url": "https://api.github.com/organizations/42/actions/permissions/selected-actions" + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set GitHub Actions permissions for an organization", + "description": "Sets the GitHub Actions permissions policy for repositories and allowed actions in an organization.\n\nIf the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as `allowed_actions` to `selected` actions, then you cannot override them for the organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", + "operationId": "actions/set-github-actions-permissions-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#set-github-actions-permissions-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "enabled_repositories": { + "type": "string", + "description": "The policy that controls the repositories in the organization that are allowed to run GitHub Actions. Can be one of: `all`, `none`, or `selected`.", + "enum": [ + "all", + "none", + "selected" + ] + }, + "allowed_actions": { + "type": "string", + "description": "The permissions policy that controls the actions that are allowed to run. Can be one of: `all`, `local_only`, or `selected`.", + "enum": [ + "all", + "local_only", + "selected" + ] + } + }, + "required": [ + "enabled_repositories" + ] + }, + "example": { + "enabled_repositories": "all", + "allowed_actions": "selected" + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/orgs/{org}/actions/permissions/repositories": { + "get": { + "summary": "List selected repositories enabled for GitHub Actions in an organization", + "description": "Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", + "operationId": "actions/list-selected-repositories-enabled-github-actions-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#list-selected-repositories-enabled-for-github-actions-in-an-organization" + }, + "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": "object", + "required": [ + "total_count", + "repositories" + ], + "properties": { + "total_count": { + "type": "number" + }, + "repositories": { + "type": "array", + "items": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "nullable": true, + "allOf": [ + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "nullable": true, + "allOf": [ + { + "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 + } + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "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" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 1, + "repositories": [ + { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "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 + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "template_repository": null, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + ] + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set selected repositories enabled for GitHub Actions in an organization", + "description": "Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", + "operationId": "actions/set-selected-repositories-enabled-github-actions-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#set-selected-repositories-enabled-for-github-actions-in-an-organization" + }, + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "selected_repository_ids": { + "description": "List of repository IDs to enable for GitHub Actions.", + "type": "array", + "items": { + "type": "integer", + "description": "Unique identifier of the repository." + } + } + }, + "required": [ + "selected_repository_ids" + ] + }, + "example": { + "selected_repository_ids": [ + 32, + 42 + ] + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/orgs/{org}/actions/permissions/repositories/{repository_id}": { + "put": { + "summary": "Enable a selected repository for GitHub Actions in an organization", + "description": "Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", + "operationId": "actions/enable-selected-repository-github-actions-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#enable-a-selected-repository-for-github-actions-in-an-organization" + }, + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repository_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "actions", + "subcategory": "permissions" + } + }, + "delete": { + "summary": "Disable a selected repository for GitHub Actions in an organization", + "description": "Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", + "operationId": "actions/disable-selected-repository-github-actions-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#disable-a-selected-repository-for-github-actions-in-an-organization" + }, + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repository_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/orgs/{org}/actions/permissions/selected-actions": { + "get": { + "summary": "Get allowed actions for an organization", + "description": "Gets the selected actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", + "operationId": "actions/get-allowed-actions-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#get-allowed-actions-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "github_owned_allowed": { + "type": "boolean", + "description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization." + }, + "verified_allowed": { + "type": "boolean", + "description": "Whether actions in GitHub Marketplace from verified creators are allowed. Set to `true` to allow all GitHub Marketplace actions by verified creators." + }, + "patterns_allowed": { + "type": "array", + "description": "Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"", + "items": { + "type": "string" + } + } + }, + "required": [ + "github_owned_allowed", + "patterns_allowed", + "verified_allowed" + ] + }, + "examples": { + "default": { + "value": { + "github_owned_allowed": true, + "verified_allowed": false, + "patterns_allowed": [ + "monalisa/octocat@*", + "docker/*" + ] + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set allowed actions for an organization", + "description": "Sets the actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nIf the organization belongs to an enterprise that has `selected` actions set at the enterprise level, then you cannot override any of the enterprise's allowed actions settings.\n\nTo use the `patterns_allowed` setting for private repositories, the organization must belong to an enterprise. If the organization does not belong to an enterprise, then the `patterns_allowed` setting only applies to public repositories in the organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", + "operationId": "actions/set-allowed-actions-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#set-allowed-actions-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "github_owned_allowed": { + "type": "boolean", + "description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization." + }, + "verified_allowed": { + "type": "boolean", + "description": "Whether actions in GitHub Marketplace from verified creators are allowed. Set to `true` to allow all GitHub Marketplace actions by verified creators." + }, + "patterns_allowed": { + "type": "array", + "description": "Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"", + "items": { + "type": "string" + } + } + }, + "required": [ + "github_owned_allowed", + "patterns_allowed", + "verified_allowed" + ] + }, + "examples": { + "selected_actions": { + "value": { + "github_owned_allowed": true, + "verified_allowed": false, + "patterns_allowed": [ + "monalisa/octocat@*", + "docker/*" + ] + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/orgs/{org}/actions/runner-groups": { + "post": { + "summary": "Create a self-hosted runner group for an organization", + "description": "The self-hosted runner groups REST API is available with GitHub Enterprise Cloud and GitHub Enterprise Server. For more information, see \"[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products).\"\n\nCreates a new self-hosted runner group for an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", + "operationId": "actions/create-self-hosted-runner-group-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#create-a-self-hosted-runner-group-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "description": "Name of the runner group.", + "type": "string" + }, + "visibility": { + "description": "Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories. Can be one of: `all`, `selected`, or `private`.", + "type": "string", + "enum": [ + "selected", + "all", + "private" + ], + "default": "all" + }, + "selected_repository_ids": { + "description": "List of repository IDs that can access the runner group.", + "type": "array", + "items": { + "type": "integer", + "description": "Unique identifier of the repository." + } + }, + "runners": { + "description": "List of runner IDs to add to the runner group.", + "type": "array", + "items": { + "type": "integer", + "description": "Unique identifier of the runner." + } + } + }, + "required": [ + "name" + ] + }, + "example": { + "name": "Expensive hardware runners", + "visibility": "selected", + "selected_repository_ids": [ + 32, + 91 + ], + "runners": [ + 9, + 2 + ] + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "name": { + "type": "string" + }, + "visibility": { + "type": "string" + }, + "default": { + "type": "boolean" + }, + "selected_repositories_url": { + "description": "Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected`", + "type": "string" + }, + "runners_url": { + "type": "string" + }, + "inherited": { + "type": "boolean" + }, + "inherited_allows_public_repositories": { + "type": "boolean" + }, + "allows_public_repositories": { + "type": "boolean" + } + }, + "required": [ + "id", + "name", + "visibility", + "default", + "runners_url", + "inherited", + "allows_public_repositories" + ] + }, + "examples": { + "default": { + "value": { + "id": 2, + "name": "octo-runner-group", + "visibility": "selected", + "default": false, + "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner-groups/2/repositories", + "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners", + "inherited": false, + "allows_public_repositories": true + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "actions", + "subcategory": "self-hosted-runner-groups" + } + } + }, + "/orgs/{org}/actions/runner-groups/{runner_group_id}": { + "patch": { + "summary": "Update a self-hosted runner group for an organization", + "description": "The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products).\"\n\nUpdates the `name` and `visibility` of a self-hosted runner group in an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", + "operationId": "actions/update-self-hosted-runner-group-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#update-a-self-hosted-runner-group-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "description": "Name of the runner group.", + "type": "string" + }, + "visibility": { + "description": "Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories. Can be one of: `all`, `selected`, or `private`.", + "type": "string", + "enum": [ + "selected", + "all", + "private" + ] + } + } + }, + "example": { + "name": "Expensive hardware runners", + "visibility": "selected" + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "name": { + "type": "string" + }, + "visibility": { + "type": "string" + }, + "default": { + "type": "boolean" + }, + "selected_repositories_url": { + "description": "Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected`", + "type": "string" + }, + "runners_url": { + "type": "string" + }, + "inherited": { + "type": "boolean" + }, + "inherited_allows_public_repositories": { + "type": "boolean" + }, + "allows_public_repositories": { + "type": "boolean" + } + }, + "required": [ + "id", + "name", + "visibility", + "default", + "runners_url", + "inherited", + "allows_public_repositories" + ] + }, + "examples": { + "default": { + "value": { + "id": 2, + "name": "octo-runner-group", + "visibility": "selected", + "default": false, + "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner-groups/2/repositories", + "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners", + "inherited": false, + "allows_public_repositories": true + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "actions", + "subcategory": "self-hosted-runner-groups" + } + }, + "delete": { + "summary": "Delete a self-hosted runner group from an organization", + "description": "The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products).\"\n\nDeletes a self-hosted runner group for an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", + "operationId": "actions/delete-self-hosted-runner-group-from-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#delete-a-self-hosted-runner-group-from-an-organization" + }, + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "actions", + "subcategory": "self-hosted-runner-groups" + } + } + }, + "/orgs/{org}/actions/runners/{runner_id}": { + "delete": { + "summary": "Delete a self-hosted runner from an organization", + "description": "Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-self-hosted-runner-from-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#delete-a-self-hosted-runner-from-an-organization" + }, + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "self-hosted-runners" + } + } + }, + "/orgs/{org}/actions/secrets": { + "get": { + "summary": "List organization secrets", + "description": "Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/list-org-secrets", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#list-organization-secrets" + }, + "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": "object", + "required": [ + "total_count", + "secrets" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "secrets": { + "type": "array", + "items": { + "title": "Actions Secret for an Organization", + "description": "Secrets for GitHub Actions for an organization.", + "type": "object", + "properties": { + "name": { + "description": "The name of the secret.", + "example": "SECRET_TOKEN", + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "visibility": { + "description": "Visibility of a secret", + "enum": [ + "all", + "private", + "selected" + ], + "type": "string" + }, + "selected_repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/org/secrets/my_secret/repositories" + } + }, + "required": [ + "name", + "created_at", + "updated_at", + "visibility" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 3, + "secrets": [ + { + "name": "GIST_ID", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "private" + }, + { + "name": "DEPLOY_TOKEN", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "all" + }, + { + "name": "GH_TOKEN", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "selected", + "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories" + } + ] + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "secrets" + } + } + }, + "/orgs/{org}/actions/secrets/public-key": { + "get": { + "summary": "Get an organization public key", + "description": "Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-org-public-key", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#get-an-organization-public-key" + }, + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "ActionsPublicKey", + "description": "The public key used for setting Actions Secrets.", + "type": "object", + "properties": { + "key_id": { + "description": "The identifier for the key.", + "type": "string", + "example": "1234567" + }, + "key": { + "description": "The Base64 encoded public key.", + "type": "string", + "example": "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=" + }, + "id": { + "type": "integer", + "example": 2 + }, + "url": { + "type": "string", + "example": "https://api.github.com/user/keys/2" + }, + "title": { + "type": "string", + "example": "ssh-rsa AAAAB3NzaC1yc2EAAA" + }, + "created_at": { + "type": "string", + "example": "2011-01-26T19:01:12Z" + } + }, + "required": [ + "key_id", + "key" + ] + }, + "examples": { + "default": { + "value": { + "key_id": "012345678912345678", + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "secrets" + } + } + }, + "/orgs/{org}/actions/secrets/{secret_name}": { + "get": { + "summary": "Get an organization secret", + "description": "Gets a single organization secret without revealing its encrypted value. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#get-an-organization-secret" + }, + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "secret_name", + "description": "secret_name parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Actions Secret for an Organization", + "description": "Secrets for GitHub Actions for an organization.", + "type": "object", + "properties": { + "name": { + "description": "The name of the secret.", + "example": "SECRET_TOKEN", + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "visibility": { + "description": "Visibility of a secret", + "enum": [ + "all", + "private", + "selected" + ], + "type": "string" + }, + "selected_repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/org/secrets/my_secret/repositories" + } + }, + "required": [ + "name", + "created_at", + "updated_at", + "visibility" + ] + }, + "examples": { + "default": { + "value": { + "name": "GH_TOKEN", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "selected", + "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "secrets" + } + }, + "put": { + "summary": "Create or update an organization secret", + "description": "Creates or updates an organization secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access\ntoken with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to\nuse this endpoint.\n\n#### Example encrypting a secret using Node.js\n\nEncrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library.\n\n```\nconst sodium = require('tweetsodium');\n\nconst key = \"base64-encoded-public-key\";\nconst value = \"plain-text-secret\";\n\n// Convert the message and key to Uint8Array's (Buffer implements that interface)\nconst messageBytes = Buffer.from(value);\nconst keyBytes = Buffer.from(key, 'base64');\n\n// Encrypt using LibSodium.\nconst encryptedBytes = sodium.seal(messageBytes, keyBytes);\n\n// Base64 the encrypted secret\nconst encrypted = Buffer.from(encryptedBytes).toString('base64');\n\nconsole.log(encrypted);\n```\n\n\n#### Example encrypting a secret using Python\n\nEncrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/stable/public/#nacl-public-sealedbox) with Python 3.\n\n```\nfrom base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n sealed_box = public.SealedBox(public_key)\n encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n return b64encode(encrypted).decode(\"utf-8\")\n```\n\n#### Example encrypting a secret using C#\n\nEncrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.\n\n```\nvar secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\n```\n\n#### Example encrypting a secret using Ruby\n\nEncrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.\n\n```ruby\nrequire \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\n```", + "tags": [ + "actions" + ], + "operationId": "actions/create-or-update-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#create-or-update-an-organization-secret" + }, + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "secret_name", + "description": "secret_name parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "encrypted_value": { + "type": "string", + "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/github-ae@latest/rest/reference/actions#get-an-organization-public-key) endpoint.", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" + }, + "key_id": { + "type": "string", + "description": "ID of the key you used to encrypt the secret." + }, + "visibility": { + "type": "string", + "description": "Configures the access that repositories have to the organization secret. Can be one of: \n\\- `all` - All repositories in an organization can access the secret. \n\\- `private` - Private repositories in an organization can access the secret. \n\\- `selected` - Only specific repositories can access the secret.", + "enum": [ + "all", + "private", + "selected" + ] + }, + "selected_repository_ids": { + "type": "array", + "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/github-ae@latest/rest/reference/actions#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/github-ae@latest/rest/reference/actions#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/github-ae@latest/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints.", + "items": { + "type": "string" + } + } + } + }, + "example": { + "encrypted_value": "c2VjcmV0", + "key_id": "012345678912345678", + "visibility": "selected", + "selected_repository_ids": [ + "1296269", + "1296280" + ] + } + } + } + }, + "responses": { + "201": { + "description": "Response when creating a secret" + }, + "204": { + "description": "Response when updating a secret" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "secrets" + } + }, + "delete": { + "summary": "Delete an organization secret", + "description": "Deletes a secret in an organization using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#delete-an-organization-secret" + }, + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "secret_name", + "description": "secret_name parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "secrets" + } + } + }, + "/orgs/{org}/actions/secrets/{secret_name}/repositories": { + "get": { + "summary": "List selected repositories for an organization secret", + "description": "Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/list-selected-repos-for-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#list-selected-repositories-for-an-organization-secret" + }, + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "secret_name", + "description": "secret_name parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "repositories" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "repositories": { + "type": "array", + "items": { + "title": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 1296269 + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "type": "string", + "example": "Hello-World" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "owner": { + "type": "object", + "nullable": true, + "allOf": [ + { + "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 + } + ] + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "template_repository": { + "nullable": true, + "type": "object", + "allOf": [ + { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "nullable": true, + "allOf": [ + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "nullable": true, + "allOf": [ + { + "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 + } + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "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" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + } + ] + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "license": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + }, + "nullable": true + }, + "forks": { + "type": "integer", + "example": 0 + }, + "open_issues": { + "type": "integer", + "example": 0 + }, + "watchers": { + "type": "integer", + "example": 0 + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 1, + "repositories": [ + { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "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 + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + } + ] + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "secrets" + } + }, + "put": { + "summary": "Set selected repositories for an organization secret", + "description": "Replaces all repositories for an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/github-ae@latest/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/set-selected-repos-for-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#set-selected-repositories-for-an-organization-secret" + }, + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "secret_name", + "description": "secret_name parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "selected_repository_ids": { + "type": "array", + "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/github-ae@latest/rest/reference/actions#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/github-ae@latest/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints.", + "items": { + "type": "integer" + } + } + } + }, + "example": { + "selected_repository_ids": [ + 64780797 + ] + } + } + } + }, + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "secrets" + } + } + }, + "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}": { + "put": { + "summary": "Add selected repository to an organization secret", + "description": "Adds a repository to an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/github-ae@latest/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/add-selected-repo-to-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#add-selected-repository-to-an-organization-secret" + }, + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "secret_name", + "description": "secret_name parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repository_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response when repository was added to the selected list" + }, + "409": { + "description": "Response when visibility type is not set to selected" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "secrets" + } + }, + "delete": { + "summary": "Remove selected repository from an organization secret", + "description": "Removes a repository from an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/github-ae@latest/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/remove-selected-repo-from-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#remove-selected-repository-from-an-organization-secret" + }, + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "secret_name", + "description": "secret_name parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repository_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response when repository was removed from the selected list" + }, + "409": { + "description": "Response when visibility type not set to selected" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "secrets" + } + } + }, "/orgs/{org}/events": { "get": { "summary": "List public organization events", @@ -34861,7 +41235,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -37582,7 +43956,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -37709,7 +44083,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -37846,7 +44220,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -37968,7 +44342,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -38037,7 +44411,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -38100,7 +44474,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -38214,7 +44588,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -38341,7 +44715,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -38454,7 +44828,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -38523,7 +44897,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -38584,10 +44958,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -38650,7 +45024,7 @@ ], "responses": { "200": { - "description": "Default response", + "description": "Response", "content": { "application/json": { "schema": { @@ -38774,7 +45148,7 @@ }, "responses": { "200": { - "description": "Default response", + "description": "Response", "content": { "application/json": { "schema": { @@ -38862,10 +45236,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -38920,7 +45294,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -39480,7 +45854,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -40060,6 +46434,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -40148,7 +46523,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -42591,7 +48966,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -42697,7 +49072,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -42864,7 +49239,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -43034,7 +49409,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -43071,7 +49446,7 @@ "/orgs/{org}/memberships/{username}": { "get": { "summary": "Get organization membership for a user", - "description": "In order to get a user's membership with an organization, the authenticated user must be an organization member.", + "description": "In order to get a user's membership with an organization, the authenticated user must be an organization member. The `state` parameter in the response can be used to identify the user's membership status.", "tags": [ "orgs" ], @@ -43100,7 +49475,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -43115,11 +49490,21 @@ }, "state": { "type": "string", - "example": "active" + "description": "The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.", + "example": "active", + "enum": [ + "active", + "pending" + ] }, "role": { "type": "string", - "example": "admin" + "description": "The user's membership type in the organization.", + "example": "admin", + "enum": [ + "admin", + "member" + ] }, "organization_url": { "type": "string", @@ -43380,99 +49765,13 @@ "site_admin": false } } - }, - "response-if-user-has-an-active-membership-with-organization": { - "summary": "Response if user has an active membership with organization", - "value": { - "url": "https://api.github.com/orgs/octocat/memberships/defunkt", - "state": "active", - "role": "member", - "organization_url": "https://api.github.com/orgs/octocat", - "organization": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization" - }, - "user": { - "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 - } - } - }, - "response-if-user-has-a-pending-membership-with-organization": { - "summary": "Response if user has a pending membership with organization", - "value": { - "url": "https://api.github.com/orgs/invitocat/memberships/defunkt", - "state": "pending", - "role": "member", - "organization_url": "https://api.github.com/orgs/invitocat", - "organization": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization" - }, - "user": { - "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 - } - } } } } } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -43573,7 +49872,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -43588,11 +49887,21 @@ }, "state": { "type": "string", - "example": "active" + "description": "The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.", + "example": "active", + "enum": [ + "active", + "pending" + ] }, "role": { "type": "string", - "example": "admin" + "description": "The user's membership type in the organization.", + "example": "admin", + "enum": [ + "admin", + "member" + ] }, "organization_url": { "type": "string", @@ -43811,51 +50120,8 @@ ] }, "examples": { - "response-if-user-was-previously-unaffiliated-with-organization": { - "summary": "Response if user was previously unaffiliated with organization", - "value": { - "url": "https://api.github.com/orgs/invitocat/memberships/defunkt", - "state": "pending", - "role": "admin", - "organization_url": "https://api.github.com/orgs/invitocat", - "organization": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization" - }, - "user": { - "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 - } - } - }, "response-if-user-already-had-membership-with-organization": { - "summary": "Response if user already had membership with organization", + "summary": "Response if user has an active admin membership with organization", "value": { "url": "https://api.github.com/orgs/octocat/memberships/defunkt", "state": "active", @@ -43902,7 +50168,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -44032,7 +50298,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -44055,7 +50321,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -44142,7 +50408,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -44347,41 +50613,10 @@ "description": "User was converted" }, "403": { - "description": "response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - }, - "examples": { - "response-if-user-is-the-last-owner-of-the-organization": { - "summary": "Response if user is the last owner of the organization", - "value": { - "message": "Cannot convert the last owner to an outside collaborator", - "documentation_url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#convert-member-to-outside-collaborator" - } - }, - "response-if-user-is-not-a-member-of-the-organization": { - "summary": "Response if user is not a member of the organization", - "value": { - "message": " is not a member of the organization.", - "documentation_url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#convert-member-to-outside-collaborator" - } - } - } - } - } + "description": "Response if user is the last owner of the organization or not a member of the organization" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -44442,7 +50677,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "422": { "description": "Response if user is a member of the organization", @@ -44539,7 +50774,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -44808,7 +51043,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -44901,7 +51136,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -45157,7 +51392,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -45197,7 +51432,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -45237,7 +51472,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -45324,7 +51559,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -45570,7 +51805,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -45634,7 +51869,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -45671,7 +51906,7 @@ }, { "name": "type", - "description": "Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`.", + "description": "Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Note: For GitHub AE, can be one of `all`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`.", "in": "query", "required": false, "schema": { @@ -45737,7 +51972,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -47493,7 +53728,7 @@ }, "post": { "summary": "Create an organization repository", - "description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", + "description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository", "tags": [ "repos" ], @@ -47532,12 +53767,12 @@ }, "private": { "type": "boolean", - "description": "Either `true` to create a private repository or `false` to create a public one.", + "description": "Whether the repository is private.", "default": false }, "visibility": { "type": "string", - "description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", + "description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", "enum": [ "public", "private", @@ -47621,7 +53856,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -48744,7 +54979,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -48875,7 +55110,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -49171,7 +55406,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -49662,7 +55897,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -49795,7 +56030,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -50286,7 +56521,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -50395,7 +56630,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -50928,7 +57163,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -51003,11 +57238,20 @@ "type": "integer", "default": 1 } + }, + { + "name": "pinned", + "in": "query", + "required": false, + "description": "Pinned discussions only filter", + "schema": { + "type": "string" + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -51428,7 +57672,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -51815,7 +58059,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -52221,7 +58465,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -52605,7 +58849,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -52692,7 +58936,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -53076,7 +59320,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -53437,7 +59681,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -53816,7 +60060,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -54174,7 +60418,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -54274,7 +60518,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -54576,7 +60820,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -54844,7 +61088,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -54940,7 +61184,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -55234,7 +61478,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -55494,7 +61738,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -55578,7 +61822,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -55748,7 +61992,7 @@ "/orgs/{org}/teams/{team_slug}/memberships/{username}": { "get": { "summary": "Get team membership for a user", - "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.\n\n**Note:** The `role` for organization owners returns as `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/github-ae@latest/rest/reference/teams#create-a-team).", + "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.\n\n**Note:**\nThe response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see see [Create a team](https://docs.github.com/github-ae@latest/rest/reference/teams#create-a-team).", "tags": [ "teams" ], @@ -55786,7 +62030,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -55809,7 +62053,12 @@ "type": "string" }, "state": { - "type": "string" + "description": "The state of the user's membership in the team.", + "type": "string", + "enum": [ + "active", + "pending" + ] } }, "required": [ @@ -55819,14 +62068,6 @@ ] }, "examples": { - "response-if-user-has-an-active-membership-with-team": { - "summary": "Response if user has an active membership with team", - "value": { - "url": "https://api.github.com/teams/1/memberships/octocat", - "role": "member", - "state": "active" - } - }, "response-if-user-is-a-team-maintainer": { "summary": "Response if user is a team maintainer", "value": { @@ -55834,14 +62075,6 @@ "role": "maintainer", "state": "active" } - }, - "response-if-user-has-a-pending-membership-with-team": { - "summary": "Response if user has a pending membership with team", - "value": { - "url": "https://api.github.com/teams/1/memberships/octocat", - "role": "member", - "state": "pending" - } } } } @@ -55921,7 +62154,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -55944,7 +62177,12 @@ "type": "string" }, "state": { - "type": "string" + "description": "The state of the user's membership in the team.", + "type": "string", + "enum": [ + "active", + "pending" + ] } }, "required": [ @@ -55954,14 +62192,6 @@ ] }, "examples": { - "response-if-users-membership-with-team-is-now-active": { - "summary": "Response if user's membership with team is now active", - "value": { - "url": "https://api.github.com/teams/1/memberships/octocat", - "role": "member", - "state": "active" - } - }, "response-if-users-membership-with-team-is-now-pending": { "summary": "Response if user's membership with team is now pending", "value": { @@ -55978,50 +62208,7 @@ "description": "Response if team synchronization is set up" }, "422": { - "description": "Response if you attempt to add an organization to a team", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "field": { - "type": "string" - }, - "resource": { - "type": "string" - } - } - } - } - } - }, - "examples": { - "response-if-you-attempt-to-add-an-organization-to-a-team": { - "value": { - "message": "Cannot add an organization as a member.", - "errors": [ - { - "code": "org", - "field": "user", - "resource": "TeamMember" - } - ] - } - } - } - } - } + "description": "Response if you attempt to add an organization to a team" } }, "x-github": { @@ -56074,7 +62261,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Response if team synchronization is set up" @@ -56142,7 +62329,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -56462,7 +62649,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -56791,7 +62978,7 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Response if the project is not owned by the organization", @@ -56874,7 +63061,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -56939,7 +63126,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -60683,7 +66870,7 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -60744,7 +66931,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -61036,7 +67223,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -61263,7 +67450,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -61286,7 +67473,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -61306,7 +67493,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -61386,7 +67573,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -61613,7 +67800,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -61636,7 +67823,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -61656,7 +67843,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -61676,7 +67863,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -61744,10 +67931,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -61774,7 +67961,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -61794,7 +67981,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -61879,7 +68066,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -61892,7 +68079,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -61933,7 +68120,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -61953,7 +68140,7 @@ } }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -61988,7 +68175,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -62097,7 +68284,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -62174,7 +68361,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -62197,7 +68384,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -62217,7 +68404,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -62294,7 +68481,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -62371,7 +68558,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -62394,7 +68581,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -62452,10 +68639,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -62478,7 +68665,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -62571,7 +68758,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -62811,7 +68998,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -62834,7 +69021,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -62935,7 +69122,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -63162,7 +69349,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -63185,7 +69372,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -63205,7 +69392,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -63301,7 +69488,7 @@ } }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -63396,7 +69583,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -63409,7 +69596,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -63432,7 +69619,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -63462,7 +69649,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -63521,7 +69708,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -63777,7 +69964,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -63800,7 +69987,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -63898,7 +70085,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -64157,7 +70344,7 @@ "description": "Response if the authenticated user does not have access to the project" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -64184,7 +70371,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -64224,7 +70411,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -64294,7 +70481,7 @@ "description": "Delete Success" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -64321,7 +70508,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -64361,7 +70548,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -64453,7 +70640,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -64609,7 +70796,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -64629,7 +70816,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -64651,7 +70838,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -64720,7 +70907,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -64743,7 +70930,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -64832,10 +71019,10 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -64855,7 +71042,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -64877,7 +71064,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -64946,7 +71133,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -64969,7 +71156,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -65034,13 +71221,13 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -65060,7 +71247,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -65102,7 +71289,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -65171,7 +71358,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -65238,7 +71425,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -65403,7 +71590,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -65423,7 +71610,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -65445,7 +71632,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -65514,7 +71701,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -65537,7 +71724,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -65614,7 +71801,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -65704,7 +71891,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -65727,7 +71914,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -65803,7 +71990,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -65876,7 +72063,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -65899,7 +72086,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -65929,7 +72116,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -65981,7 +72168,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -66207,10 +72394,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -66265,10 +72452,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -66291,7 +72478,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -66331,7 +72518,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -66403,7 +72590,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -71115,7 +77302,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -71135,7 +77322,7 @@ } }, "301": { - "description": "Moved Permanently" + "description": "Moved permanently" } }, "x-github": { @@ -71284,7 +77471,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -75484,7 +81671,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -75553,7 +81740,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -75623,7 +81810,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "If an organization owner has configured the organization to prevent members from deleting organization-owned repositories, a member will get this response:", @@ -75648,7 +81835,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -75679,6 +81866,15554 @@ } } }, + "/repos/{owner}/{repo}/actions/artifacts": { + "get": { + "summary": "List artifacts for a repository", + "description": "Lists all artifacts for a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/list-artifacts-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#list-artifacts-for-a-repository" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "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": "object", + "required": [ + "total_count", + "artifacts" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "artifacts": { + "type": "array", + "items": { + "title": "Artifact", + "description": "An artifact", + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 5 + }, + "node_id": { + "type": "string", + "example": "MDEwOkNoZWNrU3VpdGU1" + }, + "name": { + "description": "The name of the artifact.", + "type": "string", + "example": "AdventureWorks.Framework" + }, + "size_in_bytes": { + "description": "The size in bytes of the artifact.", + "type": "integer", + "example": 12345 + }, + "url": { + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/artifacts/5" + }, + "archive_download_url": { + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/artifacts/5/zip" + }, + "expired": { + "description": "Whether or not the artifact has expired.", + "type": "boolean" + }, + "created_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "expires_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "nullable": true + } + }, + "required": [ + "id", + "node_id", + "name", + "size_in_bytes", + "url", + "archive_download_url", + "expired", + "created_at", + "expires_at", + "updated_at" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 2, + "artifacts": [ + { + "id": 11, + "node_id": "MDg6QXJ0aWZhY3QxMQ==", + "name": "Rails", + "size_in_bytes": 556, + "url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11", + "archive_download_url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11/zip", + "expired": false, + "created_at": "2020-01-10T14:59:22Z", + "expires_at": "2020-03-21T14:59:22Z", + "updated_at": "2020-02-21T14:59:22Z" + }, + { + "id": 13, + "node_id": "MDg6QXJ0aWZhY3QxMw==", + "name": "", + "size_in_bytes": 453, + "url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13", + "archive_download_url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13/zip", + "expired": false, + "created_at": "2020-01-10T14:59:22Z", + "expires_at": "2020-03-21T14:59:22Z", + "updated_at": "2020-02-21T14:59:22Z" + } + ] + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "artifacts" + } + } + }, + "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}": { + "get": { + "summary": "Get an artifact", + "description": "Gets a specific artifact for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-artifact", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#get-an-artifact" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "artifact_id", + "description": "artifact_id parameter", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Artifact", + "description": "An artifact", + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 5 + }, + "node_id": { + "type": "string", + "example": "MDEwOkNoZWNrU3VpdGU1" + }, + "name": { + "description": "The name of the artifact.", + "type": "string", + "example": "AdventureWorks.Framework" + }, + "size_in_bytes": { + "description": "The size in bytes of the artifact.", + "type": "integer", + "example": 12345 + }, + "url": { + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/artifacts/5" + }, + "archive_download_url": { + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/artifacts/5/zip" + }, + "expired": { + "description": "Whether or not the artifact has expired.", + "type": "boolean" + }, + "created_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "expires_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "nullable": true + } + }, + "required": [ + "id", + "node_id", + "name", + "size_in_bytes", + "url", + "archive_download_url", + "expired", + "created_at", + "expires_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "id": 11, + "node_id": "MDg6QXJ0aWZhY3QxMQ==", + "name": "Rails", + "size_in_bytes": 556, + "url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11", + "archive_download_url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11/zip", + "expired": false, + "created_at": "2020-01-10T14:59:22Z", + "expires_at": "2020-01-21T14:59:22Z", + "updated_at": "2020-01-21T14:59:22Z" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "artifacts" + } + }, + "delete": { + "summary": "Delete an artifact", + "description": "Deletes an artifact for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-artifact", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#delete-an-artifact" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "artifact_id", + "description": "artifact_id parameter", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "artifacts" + } + } + }, + "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}": { + "get": { + "summary": "Download an artifact", + "description": "Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in\nthe response header to find the URL for the download. The `:archive_format` must be `zip`. Anyone with read access to\nthe repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions:read` permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/download-artifact", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#download-an-artifact" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "artifact_id", + "description": "artifact_id parameter", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "archive_format", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "302": { + "description": "Response", + "headers": { + "Location": { + "example": "https://pipelines.actions.githubusercontent.com/OhgS4QRKqmgx7bKC27GKU83jnQjyeqG8oIMTge8eqtheppcmw8/_apis/pipelines/1/runs/176/signedlogcontent?urlExpires=2020-01-24T18%3A10%3A31.5729946Z&urlSigningMethod=HMACV1&urlSignature=agG73JakPYkHrh06seAkvmH7rBR4Ji4c2%2B6a2ejYh3E%3D", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "artifacts" + } + } + }, + "/repos/{owner}/{repo}/actions/jobs/{job_id}": { + "get": { + "summary": "Get a job for a workflow run", + "description": "Gets a specific job in a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-job-for-workflow-run", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#get-a-job-for-a-workflow-run" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "job_id", + "description": "job_id parameter", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "202": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Job", + "description": "Information of a job execution in a workflow run", + "type": "object", + "properties": { + "id": { + "description": "The id of the job.", + "example": 21, + "type": "integer" + }, + "run_id": { + "description": "The id of the associated workflow run.", + "example": 5, + "type": "integer" + }, + "run_url": { + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/runs/5" + }, + "node_id": { + "type": "string", + "example": "MDg6Q2hlY2tSdW40" + }, + "head_sha": { + "description": "The SHA of the commit that is being run.", + "example": "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d", + "type": "string" + }, + "url": { + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/jobs/21" + }, + "html_url": { + "type": "string", + "example": "https://github.com/github/hello-world/runs/4", + "nullable": true + }, + "status": { + "description": "The phase of the lifecycle that the job is currently in.", + "example": "queued", + "type": "string", + "enum": [ + "queued", + "in_progress", + "completed" + ] + }, + "conclusion": { + "description": "The outcome of the job.", + "example": "success", + "type": "string", + "nullable": true + }, + "started_at": { + "description": "The time that the job started, in ISO 8601 format.", + "example": "2019-08-08T08:00:00-07:00", + "format": "date-time", + "type": "string" + }, + "completed_at": { + "description": "The time that the job finished, in ISO 8601 format.", + "example": "2019-08-08T08:00:00-07:00", + "format": "date-time", + "type": "string", + "nullable": true + }, + "name": { + "description": "The name of the job.", + "example": "test-coverage", + "type": "string" + }, + "steps": { + "description": "Steps in this job.", + "type": "array", + "items": { + "type": "object", + "required": [ + "name", + "status", + "conclusion", + "number" + ], + "properties": { + "status": { + "description": "The phase of the lifecycle that the job is currently in.", + "example": "queued", + "type": "string", + "enum": [ + "queued", + "in_progress", + "completed" + ] + }, + "conclusion": { + "description": "The outcome of the job.", + "example": "success", + "type": "string", + "nullable": true + }, + "name": { + "description": "The name of the job.", + "example": "test-coverage", + "type": "string" + }, + "number": { + "type": "integer", + "example": 1 + }, + "started_at": { + "description": "The time that the step started, in ISO 8601 format.", + "example": "2019-08-08T08:00:00-07:00", + "format": "date-time", + "type": "string", + "nullable": true + }, + "completed_at": { + "description": "The time that the job finished, in ISO 8601 format.", + "example": "2019-08-08T08:00:00-07:00", + "format": "date-time", + "type": "string", + "nullable": true + } + } + } + }, + "check_run_url": { + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/check-runs/4" + } + }, + "required": [ + "id", + "node_id", + "run_id", + "run_url", + "head_sha", + "name", + "url", + "html_url", + "status", + "conclusion", + "started_at", + "completed_at", + "check_run_url" + ] + }, + "examples": { + "default": { + "value": { + "id": 399444496, + "run_id": 29679449, + "run_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/29679449", + "node_id": "MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==", + "head_sha": "f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0", + "url": "https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496", + "html_url": "https://github.com/octo-org/octo-repo/runs/399444496", + "status": "completed", + "conclusion": "success", + "started_at": "2020-01-20T17:42:40Z", + "completed_at": "2020-01-20T17:44:39Z", + "name": "build", + "steps": [ + { + "name": "Set up job", + "status": "completed", + "conclusion": "success", + "number": 1, + "started_at": "2020-01-20T09:42:40.000-08:00", + "completed_at": "2020-01-20T09:42:41.000-08:00" + }, + { + "name": "Run actions/checkout@v2", + "status": "completed", + "conclusion": "success", + "number": 2, + "started_at": "2020-01-20T09:42:41.000-08:00", + "completed_at": "2020-01-20T09:42:45.000-08:00" + }, + { + "name": "Set up Ruby", + "status": "completed", + "conclusion": "success", + "number": 3, + "started_at": "2020-01-20T09:42:45.000-08:00", + "completed_at": "2020-01-20T09:42:45.000-08:00" + }, + { + "name": "Run actions/cache@v2", + "status": "completed", + "conclusion": "success", + "number": 4, + "started_at": "2020-01-20T09:42:45.000-08:00", + "completed_at": "2020-01-20T09:42:48.000-08:00" + }, + { + "name": "Install Bundler", + "status": "completed", + "conclusion": "success", + "number": 5, + "started_at": "2020-01-20T09:42:48.000-08:00", + "completed_at": "2020-01-20T09:42:52.000-08:00" + }, + { + "name": "Install Gems", + "status": "completed", + "conclusion": "success", + "number": 6, + "started_at": "2020-01-20T09:42:52.000-08:00", + "completed_at": "2020-01-20T09:42:53.000-08:00" + }, + { + "name": "Run Tests", + "status": "completed", + "conclusion": "success", + "number": 7, + "started_at": "2020-01-20T09:42:53.000-08:00", + "completed_at": "2020-01-20T09:42:59.000-08:00" + }, + { + "name": "Deploy to Heroku", + "status": "completed", + "conclusion": "success", + "number": 8, + "started_at": "2020-01-20T09:42:59.000-08:00", + "completed_at": "2020-01-20T09:44:39.000-08:00" + }, + { + "name": "Post actions/cache@v2", + "status": "completed", + "conclusion": "success", + "number": 16, + "started_at": "2020-01-20T09:44:39.000-08:00", + "completed_at": "2020-01-20T09:44:39.000-08:00" + }, + { + "name": "Complete job", + "status": "completed", + "conclusion": "success", + "number": 17, + "started_at": "2020-01-20T09:44:39.000-08:00", + "completed_at": "2020-01-20T09:44:39.000-08:00" + } + ], + "check_run_url": "https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "workflow-jobs" + } + } + }, + "/repos/{owner}/{repo}/actions/jobs/{job_id}/logs": { + "get": { + "summary": "Download job logs for a workflow run", + "description": "Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look\nfor `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can\nuse this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must\nhave the `actions:read` permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/download-job-logs-for-workflow-run", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#download-job-logs-for-a-workflow-run" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "job_id", + "description": "job_id parameter", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "302": { + "description": "Response", + "headers": { + "Location": { + "example": "https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/jobs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "workflow-jobs" + } + } + }, + "/repos/{owner}/{repo}/actions/permissions": { + "get": { + "summary": "Get GitHub Actions permissions for a repository", + "description": "Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions allowed to run in the repository.\n\nYou must authenticate using an access token with the `repo` scope to use this\nendpoint. GitHub Apps must have the `administration` repository permission to use this API.", + "operationId": "actions/get-github-actions-permissions-repository", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#get-github-actions-permissions-for-a-repository" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether GitHub Actions is enabled on the repository." + }, + "allowed_actions": { + "type": "string", + "description": "The permissions policy that controls the actions that are allowed to run. Can be one of: `all`, `local_only`, or `selected`.", + "enum": [ + "all", + "local_only", + "selected" + ] + }, + "selected_actions_url": { + "type": "string", + "description": "The API URL to use to get or set the actions that are allowed to run, when `allowed_actions` is set to `selected`." + } + }, + "required": [ + "enabled", + "allowed_actions" + ] + }, + "examples": { + "default": { + "value": { + "enabled": true, + "allowed_actions": "selected", + "selected_actions_url": "https://api.github.com/repositories/42/actions/permissions/selected-actions" + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set GitHub Actions permissions for a repository", + "description": "Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions in the repository.\n\nIf the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as `allowed_actions` to `selected` actions, then you cannot override them for the repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.", + "operationId": "actions/set-github-actions-permissions-repository", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#set-github-actions-permissions-for-a-repository" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether GitHub Actions is enabled on the repository." + }, + "allowed_actions": { + "type": "string", + "description": "The permissions policy that controls the actions that are allowed to run. Can be one of: `all`, `local_only`, or `selected`.", + "enum": [ + "all", + "local_only", + "selected" + ] + } + }, + "required": [ + "enabled" + ] + }, + "example": { + "enabled": true, + "allowed_actions": "selected" + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/repos/{owner}/{repo}/actions/permissions/selected-actions": { + "get": { + "summary": "Get allowed actions for a repository", + "description": "Gets the settings for selected actions that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.", + "operationId": "actions/get-allowed-actions-repository", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#get-allowed-actions-for-a-repository" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "github_owned_allowed": { + "type": "boolean", + "description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization." + }, + "verified_allowed": { + "type": "boolean", + "description": "Whether actions in GitHub Marketplace from verified creators are allowed. Set to `true` to allow all GitHub Marketplace actions by verified creators." + }, + "patterns_allowed": { + "type": "array", + "description": "Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"", + "items": { + "type": "string" + } + } + }, + "required": [ + "github_owned_allowed", + "patterns_allowed", + "verified_allowed" + ] + }, + "examples": { + "default": { + "value": { + "github_owned_allowed": true, + "verified_allowed": false, + "patterns_allowed": [ + "monalisa/octocat@*", + "docker/*" + ] + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set allowed actions for a repository", + "description": "Sets the actions that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository).\"\n\nIf the repository belongs to an organization or enterprise that has `selected` actions set at the organization or enterprise levels, then you cannot override any of the allowed actions settings.\n\nTo use the `patterns_allowed` setting for private repositories, the repository must belong to an enterprise. If the repository does not belong to an enterprise, then the `patterns_allowed` setting only applies to public repositories.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.", + "operationId": "actions/set-allowed-actions-repository", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#set-allowed-actions-for-a-repository" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "github_owned_allowed": { + "type": "boolean", + "description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization." + }, + "verified_allowed": { + "type": "boolean", + "description": "Whether actions in GitHub Marketplace from verified creators are allowed. Set to `true` to allow all GitHub Marketplace actions by verified creators." + }, + "patterns_allowed": { + "type": "array", + "description": "Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"", + "items": { + "type": "string" + } + } + }, + "required": [ + "github_owned_allowed", + "patterns_allowed", + "verified_allowed" + ] + }, + "examples": { + "selected_actions": { + "value": { + "github_owned_allowed": true, + "verified_allowed": false, + "patterns_allowed": [ + "monalisa/octocat@*", + "docker/*" + ] + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/repos/{owner}/{repo}/actions/runners": { + "get": { + "summary": "List self-hosted runners for a repository", + "description": "Lists all self-hosted runners configured in a repository. You must authenticate using an access token with the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/list-self-hosted-runners-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#list-self-hosted-runners-for-a-repository" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "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": "object", + "required": [ + "total_count", + "runners" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "runners": { + "type": "array", + "items": { + "title": "Self hosted runners", + "description": "A self hosted runner", + "type": "object", + "properties": { + "id": { + "description": "The id of the runner.", + "type": "integer", + "example": 5 + }, + "name": { + "description": "The name of the runner.", + "type": "string", + "example": "iMac" + }, + "os": { + "description": "The Operating System of the runner.", + "type": "string", + "example": "macos" + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "example": "online" + }, + "busy": { + "type": "boolean" + }, + "labels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the label." + }, + "name": { + "type": "string", + "description": "Name of the label." + }, + "type": { + "type": "string", + "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", + "enum": [ + "read-only", + "custom" + ] + } + } + } + } + }, + "required": [ + "id", + "name", + "os", + "status", + "busy", + "labels" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 2, + "runners": [ + { + "id": 23, + "name": "linux_runner", + "os": "linux", + "status": "online", + "busy": true, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 11, + "name": "Linux", + "type": "read-only" + } + ] + }, + { + "id": 24, + "name": "mac_runner", + "os": "macos", + "status": "offline", + "busy": false, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 20, + "name": "macOS", + "type": "read-only" + }, + { + "id": 21, + "name": "no-gpu", + "type": "custom" + } + ] + } + ] + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "self-hosted-runners" + } + } + }, + "/repos/{owner}/{repo}/actions/runners/{runner_id}": { + "delete": { + "summary": "Delete a self-hosted runner from a repository", + "description": "Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `repo`\nscope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-self-hosted-runner-from-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#delete-a-self-hosted-runner-from-a-repository" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "self-hosted-runners" + } + } + }, + "/repos/{owner}/{repo}/actions/runs": { + "get": { + "summary": "List workflow runs for a repository", + "description": "Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/list-workflow-runs-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#list-workflow-runs-for-a-repository" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "actor", + "description": "Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "branch", + "description": "Returns workflow runs associated with a branch. Use the name of the branch of the `push`.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "event", + "description": "Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see \"[Events that trigger workflows](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows).\"", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "status", + "description": "Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`. For a list of the possible `status` and `conclusion` options, see \"[Create a check run](https://docs.github.com/github-ae@latest/rest/reference/checks#create-a-check-run).\"", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "completed", + "action_required", + "cancelled", + "failure", + "neutral", + "skipped", + "stale", + "success", + "timed_out", + "in_progress", + "queued", + "requested", + "waiting" + ] + } + }, + { + "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": "object", + "required": [ + "total_count", + "workflow_runs" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "workflow_runs": { + "type": "array", + "items": { + "title": "Workflow Run", + "description": "An invocation of a workflow", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the workflow run.", + "example": 5 + }, + "name": { + "type": "string", + "description": "The name of the workflow run.", + "example": "Build" + }, + "node_id": { + "type": "string", + "example": "MDEwOkNoZWNrU3VpdGU1" + }, + "head_branch": { + "type": "string", + "nullable": true, + "example": "master" + }, + "head_sha": { + "description": "The SHA of the head commit that points to the version of the worflow being run.", + "example": "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d", + "type": "string" + }, + "run_number": { + "type": "integer", + "description": "The auto incrementing run number for the workflow run.", + "example": 106 + }, + "event": { + "type": "string", + "example": "push" + }, + "status": { + "type": "string", + "nullable": true, + "example": "completed" + }, + "conclusion": { + "type": "string", + "nullable": true, + "example": "neutral" + }, + "workflow_id": { + "type": "integer", + "description": "The ID of the parent workflow.", + "example": 5 + }, + "url": { + "type": "string", + "description": "The URL to the workflow run.", + "example": "https://api.github.com/repos/github/hello-world/actions/runs/5" + }, + "html_url": { + "type": "string", + "example": "https://github.com/github/hello-world/suites/4" + }, + "pull_requests": { + "type": "array", + "nullable": true, + "items": { + "title": "Pull Request Minimal", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "number": { + "type": "integer" + }, + "url": { + "type": "string" + }, + "head": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "id", + "url", + "name" + ] + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + }, + "base": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "id", + "url", + "name" + ] + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + } + }, + "required": [ + "id", + "number", + "url", + "head", + "base" + ] + } + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "jobs_url": { + "description": "The URL to the jobs for the workflow run.", + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/jobs" + }, + "logs_url": { + "description": "The URL to download the logs for the workflow run.", + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/logs" + }, + "check_suite_url": { + "description": "The URL to the associated check suite.", + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/check-suites/12" + }, + "artifacts_url": { + "description": "The URL to the artifacts for the workflow run.", + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/rerun/artifacts" + }, + "cancel_url": { + "description": "The URL to cancel the workflow run.", + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/cancel" + }, + "rerun_url": { + "description": "The URL to rerun the workflow run.", + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/rerun" + }, + "workflow_url": { + "description": "The URL to the workflow.", + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/workflows/main.yaml" + }, + "head_commit": { + "title": "Simple Commit", + "description": "Simple Commit", + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "tree_id": { + "type": "string" + }, + "message": { + "type": "string" + }, + "timestamp": { + "type": "string", + "format": "date-time" + }, + "author": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "email": { + "type": "string" + } + }, + "required": [ + "name", + "email" + ], + "nullable": true + }, + "committer": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "email": { + "type": "string" + } + }, + "required": [ + "name", + "email" + ], + "nullable": true + } + }, + "required": [ + "id", + "tree_id", + "message", + "timestamp", + "author", + "committer" + ] + }, + "repository": { + "title": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 1296269 + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "type": "string", + "example": "Hello-World" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "owner": { + "type": "object", + "nullable": true, + "allOf": [ + { + "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 + } + ] + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "template_repository": { + "nullable": true, + "type": "object", + "allOf": [ + { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "nullable": true, + "allOf": [ + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "nullable": true, + "allOf": [ + { + "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 + } + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "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" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + } + ] + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "license": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + }, + "nullable": true + }, + "forks": { + "type": "integer", + "example": 0 + }, + "open_issues": { + "type": "integer", + "example": 0 + }, + "watchers": { + "type": "integer", + "example": 0 + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" + ] + }, + "head_repository": { + "title": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 1296269 + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "type": "string", + "example": "Hello-World" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "owner": { + "type": "object", + "nullable": true, + "allOf": [ + { + "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 + } + ] + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "template_repository": { + "nullable": true, + "type": "object", + "allOf": [ + { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "nullable": true, + "allOf": [ + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "nullable": true, + "allOf": [ + { + "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 + } + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "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" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + } + ] + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "license": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + }, + "nullable": true + }, + "forks": { + "type": "integer", + "example": 0 + }, + "open_issues": { + "type": "integer", + "example": 0 + }, + "watchers": { + "type": "integer", + "example": 0 + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" + ] + }, + "head_repository_id": { + "type": "integer", + "example": 5 + } + }, + "required": [ + "id", + "node_id", + "head_branch", + "run_number", + "event", + "status", + "conclusion", + "head_sha", + "workflow_id", + "url", + "html_url", + "created_at", + "updated_at", + "head_commit", + "head_repository", + "repository", + "jobs_url", + "logs_url", + "check_suite_url", + "cancel_url", + "rerun_url", + "artifacts_url", + "workflow_url", + "pull_requests" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 1, + "workflow_runs": [ + { + "id": 30433642, + "name": "Build", + "node_id": "MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==", + "head_branch": "master", + "head_sha": "acb5820ced9479c074f688cc328bf03f341a511d", + "run_number": 562, + "event": "push", + "status": "queued", + "conclusion": null, + "workflow_id": 159038, + "url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642", + "html_url": "https://github.com/octo-org/octo-repo/actions/runs/30433642", + "pull_requests": [ + + ], + "created_at": "2020-01-22T19:33:08Z", + "updated_at": "2020-01-22T19:33:08Z", + "jobs_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs", + "logs_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs", + "check_suite_url": "https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374", + "artifacts_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts", + "cancel_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel", + "rerun_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun", + "workflow_url": "https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038", + "head_commit": { + "id": "acb5820ced9479c074f688cc328bf03f341a511d", + "tree_id": "d23f6eedb1e1b9610bbc754ddb5197bfe7271223", + "message": "Create linter.yaml", + "timestamp": "2020-01-22T19:33:05Z", + "author": { + "name": "Octo Cat", + "email": "octocat@github.com" + }, + "committer": { + "name": "GitHub", + "email": "noreply@github.com" + } + }, + "repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "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 + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "head_repository": { + "id": 217723378, + "node_id": "MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=", + "name": "octo-repo", + "full_name": "octo-org/octo-repo", + "private": true, + "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 + }, + "html_url": "https://github.com/octo-org/octo-repo", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/octo-org/octo-repo", + "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks", + "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams", + "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks", + "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}", + "events_url": "https://api.github.com/repos/octo-org/octo-repo/events", + "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}", + "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}", + "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags", + "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}", + "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages", + "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers", + "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors", + "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers", + "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription", + "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}", + "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges", + "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads", + "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}", + "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}", + "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}", + "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}", + "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments" + } + } + ] + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "workflow-runs" + } + } + }, + "/repos/{owner}/{repo}/actions/runs/{run_id}": { + "get": { + "summary": "Get a workflow run", + "description": "Gets a specific workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-workflow-run", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#get-a-workflow-run" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "run_id", + "description": "The id of the workflow run", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Workflow Run", + "description": "An invocation of a workflow", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the workflow run.", + "example": 5 + }, + "name": { + "type": "string", + "description": "The name of the workflow run.", + "example": "Build" + }, + "node_id": { + "type": "string", + "example": "MDEwOkNoZWNrU3VpdGU1" + }, + "head_branch": { + "type": "string", + "nullable": true, + "example": "master" + }, + "head_sha": { + "description": "The SHA of the head commit that points to the version of the worflow being run.", + "example": "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d", + "type": "string" + }, + "run_number": { + "type": "integer", + "description": "The auto incrementing run number for the workflow run.", + "example": 106 + }, + "event": { + "type": "string", + "example": "push" + }, + "status": { + "type": "string", + "nullable": true, + "example": "completed" + }, + "conclusion": { + "type": "string", + "nullable": true, + "example": "neutral" + }, + "workflow_id": { + "type": "integer", + "description": "The ID of the parent workflow.", + "example": 5 + }, + "url": { + "type": "string", + "description": "The URL to the workflow run.", + "example": "https://api.github.com/repos/github/hello-world/actions/runs/5" + }, + "html_url": { + "type": "string", + "example": "https://github.com/github/hello-world/suites/4" + }, + "pull_requests": { + "type": "array", + "nullable": true, + "items": { + "title": "Pull Request Minimal", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "number": { + "type": "integer" + }, + "url": { + "type": "string" + }, + "head": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "id", + "url", + "name" + ] + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + }, + "base": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "id", + "url", + "name" + ] + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + } + }, + "required": [ + "id", + "number", + "url", + "head", + "base" + ] + } + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "jobs_url": { + "description": "The URL to the jobs for the workflow run.", + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/jobs" + }, + "logs_url": { + "description": "The URL to download the logs for the workflow run.", + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/logs" + }, + "check_suite_url": { + "description": "The URL to the associated check suite.", + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/check-suites/12" + }, + "artifacts_url": { + "description": "The URL to the artifacts for the workflow run.", + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/rerun/artifacts" + }, + "cancel_url": { + "description": "The URL to cancel the workflow run.", + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/cancel" + }, + "rerun_url": { + "description": "The URL to rerun the workflow run.", + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/rerun" + }, + "workflow_url": { + "description": "The URL to the workflow.", + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/workflows/main.yaml" + }, + "head_commit": { + "title": "Simple Commit", + "description": "Simple Commit", + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "tree_id": { + "type": "string" + }, + "message": { + "type": "string" + }, + "timestamp": { + "type": "string", + "format": "date-time" + }, + "author": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "email": { + "type": "string" + } + }, + "required": [ + "name", + "email" + ], + "nullable": true + }, + "committer": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "email": { + "type": "string" + } + }, + "required": [ + "name", + "email" + ], + "nullable": true + } + }, + "required": [ + "id", + "tree_id", + "message", + "timestamp", + "author", + "committer" + ] + }, + "repository": { + "title": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 1296269 + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "type": "string", + "example": "Hello-World" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "owner": { + "type": "object", + "nullable": true, + "allOf": [ + { + "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 + } + ] + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "template_repository": { + "nullable": true, + "type": "object", + "allOf": [ + { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "nullable": true, + "allOf": [ + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "nullable": true, + "allOf": [ + { + "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 + } + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "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" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + } + ] + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "license": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + }, + "nullable": true + }, + "forks": { + "type": "integer", + "example": 0 + }, + "open_issues": { + "type": "integer", + "example": 0 + }, + "watchers": { + "type": "integer", + "example": 0 + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" + ] + }, + "head_repository": { + "title": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 1296269 + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "type": "string", + "example": "Hello-World" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "owner": { + "type": "object", + "nullable": true, + "allOf": [ + { + "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 + } + ] + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "template_repository": { + "nullable": true, + "type": "object", + "allOf": [ + { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "nullable": true, + "allOf": [ + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "nullable": true, + "allOf": [ + { + "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 + } + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "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" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + } + ] + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "license": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + }, + "nullable": true + }, + "forks": { + "type": "integer", + "example": 0 + }, + "open_issues": { + "type": "integer", + "example": 0 + }, + "watchers": { + "type": "integer", + "example": 0 + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" + ] + }, + "head_repository_id": { + "type": "integer", + "example": 5 + } + }, + "required": [ + "id", + "node_id", + "head_branch", + "run_number", + "event", + "status", + "conclusion", + "head_sha", + "workflow_id", + "url", + "html_url", + "created_at", + "updated_at", + "head_commit", + "head_repository", + "repository", + "jobs_url", + "logs_url", + "check_suite_url", + "cancel_url", + "rerun_url", + "artifacts_url", + "workflow_url", + "pull_requests" + ] + }, + "examples": { + "default": { + "value": { + "id": 30433642, + "name": "Build", + "node_id": "MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==", + "head_branch": "master", + "head_sha": "acb5820ced9479c074f688cc328bf03f341a511d", + "run_number": 562, + "event": "push", + "status": "queued", + "conclusion": null, + "workflow_id": 159038, + "url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642", + "html_url": "https://github.com/octo-org/octo-repo/actions/runs/30433642", + "pull_requests": [ + + ], + "created_at": "2020-01-22T19:33:08Z", + "updated_at": "2020-01-22T19:33:08Z", + "jobs_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs", + "logs_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs", + "check_suite_url": "https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374", + "artifacts_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts", + "cancel_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel", + "rerun_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun", + "workflow_url": "https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038", + "head_commit": { + "id": "acb5820ced9479c074f688cc328bf03f341a511d", + "tree_id": "d23f6eedb1e1b9610bbc754ddb5197bfe7271223", + "message": "Create linter.yaml", + "timestamp": "2020-01-22T19:33:05Z", + "author": { + "name": "Octo Cat", + "email": "octocat@github.com" + }, + "committer": { + "name": "GitHub", + "email": "noreply@github.com" + } + }, + "repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "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 + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "head_repository": { + "id": 217723378, + "node_id": "MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=", + "name": "octo-repo", + "full_name": "octo-org/octo-repo", + "private": true, + "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 + }, + "html_url": "https://github.com/octo-org/octo-repo", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/octo-org/octo-repo", + "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks", + "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams", + "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks", + "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}", + "events_url": "https://api.github.com/repos/octo-org/octo-repo/events", + "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}", + "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}", + "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags", + "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}", + "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages", + "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers", + "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors", + "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers", + "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription", + "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}", + "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges", + "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads", + "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}", + "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}", + "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}", + "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}", + "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments" + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "workflow-runs" + } + }, + "delete": { + "summary": "Delete a workflow run", + "description": "Delete a specific workflow run. Anyone with write access to the repository can use this endpoint. If the repository is\nprivate you must use an access token with the `repo` scope. GitHub Apps must have the `actions:write` permission to use\nthis endpoint.", + "operationId": "actions/delete-workflow-run", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#delete-a-workflow-run" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "run_id", + "description": "The id of the workflow run", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "workflow-runs" + } + } + }, + "/repos/{owner}/{repo}/actions/runs/{run_id}/approvals": { + "get": { + "summary": "Get the review history for a workflow run", + "description": "Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-reviews-for-run", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#get-the-review-history-for-a-workflow-run" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "run_id", + "description": "The id of the workflow run", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Environment Approval", + "description": "An entry in the reviews log for environment deployments", + "type": "object", + "properties": { + "environments": { + "description": "The list of environments that were approved or rejected", + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "description": "The id of the environment.", + "example": 56780428, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDExOkVudmlyb25tZW50NTY3ODA0Mjg=" + }, + "name": { + "description": "The name of the environment.", + "example": "staging", + "type": "string" + }, + "url": { + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/environments/staging" + }, + "html_url": { + "type": "string", + "example": "https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging" + }, + "created_at": { + "description": "The time that the environment was created, in ISO 8601 format.", + "example": "2020-11-23T22:00:40Z", + "format": "date-time", + "type": "string" + }, + "updated_at": { + "description": "The time that the environment was last updated, in ISO 8601 format.", + "example": "2020-11-23T22:00:40Z", + "format": "date-time", + "type": "string" + } + } + } + }, + "state": { + "description": "Whether deployment to the environment(s) was approved or rejected", + "enum": [ + "approved", + "rejected" + ], + "example": "approved", + "type": "string" + }, + "user": { + "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 + }, + "comment": { + "type": "string", + "description": "The comment submitted with the deployment review", + "example": "Ship it!" + } + }, + "required": [ + "environments", + "state", + "user", + "comment" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "state": "approved", + "comment": "Ship it!", + "environments": [ + { + "id": 161088068, + "node_id": "MDExOkVudmlyb25tZW50MTYxMDg4MDY4", + "name": "staging", + "url": "https://api.github.com/repos/github/hello-world/environments/staging", + "html_url": "https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging", + "created_at": "2020-11-23T22:00:40Z", + "updated_at": "2020-11-23T22:00:40Z" + } + ], + "user": { + "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 + } + } + ] + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "workflow-runs" + } + } + }, + "/repos/{owner}/{repo}/actions/runs/{run_id}/artifacts": { + "get": { + "summary": "List workflow run artifacts", + "description": "Lists artifacts for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/list-workflow-run-artifacts", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#list-workflow-run-artifacts" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "run_id", + "description": "The id of the workflow run", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "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": "object", + "required": [ + "total_count", + "artifacts" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "artifacts": { + "type": "array", + "items": { + "title": "Artifact", + "description": "An artifact", + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 5 + }, + "node_id": { + "type": "string", + "example": "MDEwOkNoZWNrU3VpdGU1" + }, + "name": { + "description": "The name of the artifact.", + "type": "string", + "example": "AdventureWorks.Framework" + }, + "size_in_bytes": { + "description": "The size in bytes of the artifact.", + "type": "integer", + "example": 12345 + }, + "url": { + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/artifacts/5" + }, + "archive_download_url": { + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/artifacts/5/zip" + }, + "expired": { + "description": "Whether or not the artifact has expired.", + "type": "boolean" + }, + "created_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "expires_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "nullable": true + } + }, + "required": [ + "id", + "node_id", + "name", + "size_in_bytes", + "url", + "archive_download_url", + "expired", + "created_at", + "expires_at", + "updated_at" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 2, + "artifacts": [ + { + "id": 11, + "node_id": "MDg6QXJ0aWZhY3QxMQ==", + "name": "Rails", + "size_in_bytes": 556, + "url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11", + "archive_download_url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11/zip", + "expired": false, + "created_at": "2020-01-10T14:59:22Z", + "expires_at": "2020-03-21T14:59:22Z", + "updated_at": "2020-02-21T14:59:22Z" + }, + { + "id": 13, + "node_id": "MDg6QXJ0aWZhY3QxMw==", + "name": "", + "size_in_bytes": 453, + "url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13", + "archive_download_url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13/zip", + "expired": false, + "created_at": "2020-01-10T14:59:22Z", + "expires_at": "2020-03-21T14:59:22Z", + "updated_at": "2020-02-21T14:59:22Z" + } + ] + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "artifacts" + } + } + }, + "/repos/{owner}/{repo}/actions/runs/{run_id}/cancel": { + "post": { + "summary": "Cancel a workflow run", + "description": "Cancels a workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/cancel-workflow-run", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#cancel-a-workflow-run" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "run_id", + "description": "The id of the workflow run", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "202": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "workflow-runs" + } + } + }, + "/repos/{owner}/{repo}/actions/runs/{run_id}/jobs": { + "get": { + "summary": "List jobs for a workflow run", + "description": "Lists jobs for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#parameters).", + "tags": [ + "actions" + ], + "operationId": "actions/list-jobs-for-workflow-run", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#list-jobs-for-a-workflow-run" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "run_id", + "description": "The id of the workflow run", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "filter", + "description": "Filters jobs by their `completed_at` timestamp. Can be one of: \n\\* `latest`: Returns jobs from the most recent execution of the workflow run. \n\\* `all`: Returns all jobs for a workflow run, including from old executions of the workflow run.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "latest", + "all" + ], + "default": "latest" + } + }, + { + "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": "object", + "required": [ + "total_count", + "jobs" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "jobs": { + "type": "array", + "items": { + "title": "Job", + "description": "Information of a job execution in a workflow run", + "type": "object", + "properties": { + "id": { + "description": "The id of the job.", + "example": 21, + "type": "integer" + }, + "run_id": { + "description": "The id of the associated workflow run.", + "example": 5, + "type": "integer" + }, + "run_url": { + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/runs/5" + }, + "node_id": { + "type": "string", + "example": "MDg6Q2hlY2tSdW40" + }, + "head_sha": { + "description": "The SHA of the commit that is being run.", + "example": "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d", + "type": "string" + }, + "url": { + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/jobs/21" + }, + "html_url": { + "type": "string", + "example": "https://github.com/github/hello-world/runs/4", + "nullable": true + }, + "status": { + "description": "The phase of the lifecycle that the job is currently in.", + "example": "queued", + "type": "string", + "enum": [ + "queued", + "in_progress", + "completed" + ] + }, + "conclusion": { + "description": "The outcome of the job.", + "example": "success", + "type": "string", + "nullable": true + }, + "started_at": { + "description": "The time that the job started, in ISO 8601 format.", + "example": "2019-08-08T08:00:00-07:00", + "format": "date-time", + "type": "string" + }, + "completed_at": { + "description": "The time that the job finished, in ISO 8601 format.", + "example": "2019-08-08T08:00:00-07:00", + "format": "date-time", + "type": "string", + "nullable": true + }, + "name": { + "description": "The name of the job.", + "example": "test-coverage", + "type": "string" + }, + "steps": { + "description": "Steps in this job.", + "type": "array", + "items": { + "type": "object", + "required": [ + "name", + "status", + "conclusion", + "number" + ], + "properties": { + "status": { + "description": "The phase of the lifecycle that the job is currently in.", + "example": "queued", + "type": "string", + "enum": [ + "queued", + "in_progress", + "completed" + ] + }, + "conclusion": { + "description": "The outcome of the job.", + "example": "success", + "type": "string", + "nullable": true + }, + "name": { + "description": "The name of the job.", + "example": "test-coverage", + "type": "string" + }, + "number": { + "type": "integer", + "example": 1 + }, + "started_at": { + "description": "The time that the step started, in ISO 8601 format.", + "example": "2019-08-08T08:00:00-07:00", + "format": "date-time", + "type": "string", + "nullable": true + }, + "completed_at": { + "description": "The time that the job finished, in ISO 8601 format.", + "example": "2019-08-08T08:00:00-07:00", + "format": "date-time", + "type": "string", + "nullable": true + } + } + } + }, + "check_run_url": { + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/check-runs/4" + } + }, + "required": [ + "id", + "node_id", + "run_id", + "run_url", + "head_sha", + "name", + "url", + "html_url", + "status", + "conclusion", + "started_at", + "completed_at", + "check_run_url" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 1, + "jobs": [ + { + "id": 399444496, + "run_id": 29679449, + "run_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/29679449", + "node_id": "MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==", + "head_sha": "f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0", + "url": "https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496", + "html_url": "https://github.com/octo-org/octo-repo/runs/399444496", + "status": "completed", + "conclusion": "success", + "started_at": "2020-01-20T17:42:40Z", + "completed_at": "2020-01-20T17:44:39Z", + "name": "build", + "steps": [ + { + "name": "Set up job", + "status": "completed", + "conclusion": "success", + "number": 1, + "started_at": "2020-01-20T09:42:40.000-08:00", + "completed_at": "2020-01-20T09:42:41.000-08:00" + }, + { + "name": "Run actions/checkout@v2", + "status": "completed", + "conclusion": "success", + "number": 2, + "started_at": "2020-01-20T09:42:41.000-08:00", + "completed_at": "2020-01-20T09:42:45.000-08:00" + }, + { + "name": "Set up Ruby", + "status": "completed", + "conclusion": "success", + "number": 3, + "started_at": "2020-01-20T09:42:45.000-08:00", + "completed_at": "2020-01-20T09:42:45.000-08:00" + }, + { + "name": "Run actions/cache@v2", + "status": "completed", + "conclusion": "success", + "number": 4, + "started_at": "2020-01-20T09:42:45.000-08:00", + "completed_at": "2020-01-20T09:42:48.000-08:00" + }, + { + "name": "Install Bundler", + "status": "completed", + "conclusion": "success", + "number": 5, + "started_at": "2020-01-20T09:42:48.000-08:00", + "completed_at": "2020-01-20T09:42:52.000-08:00" + }, + { + "name": "Install Gems", + "status": "completed", + "conclusion": "success", + "number": 6, + "started_at": "2020-01-20T09:42:52.000-08:00", + "completed_at": "2020-01-20T09:42:53.000-08:00" + }, + { + "name": "Run Tests", + "status": "completed", + "conclusion": "success", + "number": 7, + "started_at": "2020-01-20T09:42:53.000-08:00", + "completed_at": "2020-01-20T09:42:59.000-08:00" + }, + { + "name": "Deploy to Heroku", + "status": "completed", + "conclusion": "success", + "number": 8, + "started_at": "2020-01-20T09:42:59.000-08:00", + "completed_at": "2020-01-20T09:44:39.000-08:00" + }, + { + "name": "Post actions/cache@v2", + "status": "completed", + "conclusion": "success", + "number": 16, + "started_at": "2020-01-20T09:44:39.000-08:00", + "completed_at": "2020-01-20T09:44:39.000-08:00" + }, + { + "name": "Complete job", + "status": "completed", + "conclusion": "success", + "number": 17, + "started_at": "2020-01-20T09:44:39.000-08:00", + "completed_at": "2020-01-20T09:44:39.000-08:00" + } + ], + "check_run_url": "https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496" + } + ] + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "workflow-jobs" + } + } + }, + "/repos/{owner}/{repo}/actions/runs/{run_id}/logs": { + "get": { + "summary": "Download workflow run logs", + "description": "Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for\n`Location:` in the response header to find the URL for the download. Anyone with read access to the repository can use\nthis endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have\nthe `actions:read` permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/download-workflow-run-logs", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#download-workflow-run-logs" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "run_id", + "description": "The id of the workflow run", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "302": { + "description": "Response", + "headers": { + "Location": { + "example": "https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/runs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "workflow-runs" + } + }, + "delete": { + "summary": "Delete workflow run logs", + "description": "Deletes all logs for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-workflow-run-logs", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#delete-workflow-run-logs" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "run_id", + "description": "The id of the workflow run", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "workflow-runs" + } + } + }, + "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments": { + "get": { + "summary": "Get pending deployments for a workflow run", + "description": "Get all deployment environments for a workflow run that are waiting for protection rules to pass.\n\nAnyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-pending-deployments-for-run", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#get-pending-deployments-for-a-workflow-run" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "run_id", + "description": "The id of the workflow run", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Pending Deployment", + "description": "Details of a deployment that is waiting for protection rules to pass", + "type": "object", + "properties": { + "environment": { + "type": "object", + "properties": { + "id": { + "description": "The id of the environment.", + "example": 56780428, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDExOkVudmlyb25tZW50NTY3ODA0Mjg=" + }, + "name": { + "description": "The name of the environment.", + "example": "staging", + "type": "string" + }, + "url": { + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/environments/staging" + }, + "html_url": { + "type": "string", + "example": "https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging" + } + } + }, + "wait_timer": { + "type": "integer", + "description": "The set duration of the wait timer", + "example": 30 + }, + "wait_timer_started_at": { + "description": "The time that the wait timer began.", + "example": "2020-11-23T22:00:40Z", + "format": "date-time", + "type": "string", + "nullable": true + }, + "current_user_can_approve": { + "description": "Whether the currently authenticated user can approve the deployment", + "type": "boolean", + "example": true + }, + "reviewers": { + "type": "array", + "description": "The people or teams that may approve jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of reviewer. Must be one of: `User` or `Team`", + "enum": [ + "User", + "Team" + ], + "example": "User" + }, + "reviewer": { + "anyOf": [ + { + "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 + }, + { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VGVhbTE=" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/organizations/1/team/1/members{/member}" + }, + "name": { + "description": "Name of the team", + "type": "string", + "example": "Justice League" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true, + "example": "A great team." + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "example": "admin" + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "example": "closed" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1/repos" + }, + "slug": { + "type": "string", + "example": "justice-league" + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "example": "uid=example,ou=users,dc=github,dc=com", + "type": "string" + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ], + "nullable": true + } + ] + } + } + } + } + }, + "required": [ + "environment", + "wait_timer", + "wait_timer_started_at", + "current_user_can_approve", + "reviewers" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "environment": { + "id": 161088068, + "node_id": "MDExOkVudmlyb25tZW50MTYxMDg4MDY4", + "name": "staging", + "url": "https://api.github.com/repos/github/hello-world/environments/staging", + "html_url": "https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging" + }, + "wait_timer": 30, + "wait_timer_started_at": "2020-11-23T22:00:40Z", + "current_user_can_approve": true, + "reviewers": [ + { + "type": "User", + "reviewer": { + "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 + } + }, + { + "type": "Team", + "reviewer": { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos" + } + } + ] + } + ] + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "workflow-runs" + } + }, + "post": { + "summary": "Review pending deployments for a workflow run", + "description": "Approve or reject pending deployments that are waiting on approval by a required reviewer.\n\nAnyone with read access to the repository contents and deployments can use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/review-pending-deployments-for-run", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#review-pending-deployments-for-a-workflow-run" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "run_id", + "description": "The id of the workflow run", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "environment_ids": { + "type": "array", + "description": "The list of environment ids to approve or reject", + "example": [ + 161171787, + 161171795 + ], + "items": { + "type": "integer", + "example": 161171787 + } + }, + "state": { + "type": "string", + "description": "Whether to approve or reject deployment to the specified environments. Must be one of: `approved` or `rejected`", + "enum": [ + "approved", + "rejected" + ], + "example": "approved" + }, + "comment": { + "type": "string", + "description": "A comment to accompany the deployment review", + "example": "Ship it!" + } + }, + "required": [ + "environment_ids", + "state", + "comment" + ] + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Deployment", + "description": "A request for a specific ref(branch,sha,tag) to be deployed", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/example/deployments/1" + }, + "id": { + "description": "Unique identifier of the deployment", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOkRlcGxveW1lbnQx" + }, + "sha": { + "type": "string", + "example": "a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d" + }, + "ref": { + "description": "The ref to deploy. This can be a branch, tag, or sha.", + "example": "topic-branch", + "type": "string" + }, + "task": { + "description": "Parameter to specify a task to execute", + "example": "deploy", + "type": "string" + }, + "payload": { + "type": "object", + "properties": { + } + }, + "original_environment": { + "type": "string", + "example": "staging" + }, + "environment": { + "description": "Name for the target deployment environment.", + "example": "production", + "type": "string" + }, + "description": { + "type": "string", + "example": "Deploy request from hubot", + "nullable": true + }, + "creator": { + "nullable": true, + "allOf": [ + { + "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 + } + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2012-07-20T01:19:13Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2012-07-20T01:19:13Z" + }, + "statuses_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/example/deployments/1/statuses" + }, + "repository_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/example" + }, + "transient_environment": { + "description": "Specifies if the given environment is will no longer exist at some point in the future. Default: false.", + "example": true, + "type": "boolean" + }, + "production_environment": { + "description": "Specifies if the given environment is one that end-users directly interact with. Default: false.", + "example": true, + "type": "boolean" + }, + "performed_via_github_app": { + "nullable": true, + "allOf": [ + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "example": 37, + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "example": "probot-owners", + "type": "string" + }, + "node_id": { + "type": "string", + "example": "MDExOkludGVncmF0aW9uMQ==" + }, + "owner": { + "nullable": true, + "allOf": [ + { + "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 + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "example": "Probot Owners", + "type": "string" + }, + "description": { + "type": "string", + "example": "The description of the app.", + "nullable": true + }, + "external_url": { + "type": "string", + "format": "uri", + "example": "https://example.com" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/apps/super-ci" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "example": [ + "label", + "deployment" + ], + "type": "array", + "items": { + "type": "string" + } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "example": 5, + "type": "integer" + }, + "client_id": { + "type": "string", + "example": "\"Iv1.25b5d1e65ffc4022\"" + }, + "client_secret": { + "type": "string", + "example": "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + }, + "webhook_secret": { + "type": "string", + "example": "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + }, + "pem": { + "type": "string", + "example": "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ], + "additionalProperties": true + } + ] + } + }, + "required": [ + "id", + "node_id", + "sha", + "ref", + "task", + "environment", + "creator", + "payload", + "description", + "statuses_url", + "repository_url", + "url", + "created_at", + "updated_at" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "url": "https://api.github.com/repos/octocat/example/deployments/1", + "id": 1, + "node_id": "MDEwOkRlcGxveW1lbnQx", + "sha": "a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d", + "ref": "topic-branch", + "task": "deploy", + "payload": { + }, + "original_environment": "staging", + "environment": "production", + "description": "Deploy request from hubot", + "creator": { + "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 + }, + "created_at": "2012-07-20T01:19:13Z", + "updated_at": "2012-07-20T01:19:13Z", + "statuses_url": "https://api.github.com/repos/octocat/example/deployments/1/statuses", + "repository_url": "https://api.github.com/repos/octocat/example", + "transient_environment": false, + "production_environment": true + } + ] + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "workflow-runs" + } + } + }, + "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun": { + "post": { + "summary": "Re-run a workflow", + "description": "Re-runs your workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/re-run-workflow", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#re-run-a-workflow" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "run_id", + "description": "The id of the workflow run", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "201": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [ + + ], + "category": "actions", + "subcategory": "workflow-runs" + } + } + }, + "/repos/{owner}/{repo}/actions/runs/{run_id}/timing": { + "get": { + "summary": "Get workflow run usage", + "description": "Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub AE-hosted runners. Usage is listed for each GitHub AE-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nAnyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-workflow-run-usage", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#get-workflow-run-usage" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "run_id", + "description": "The id of the workflow run", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Workflow Run Usage", + "description": "Workflow Run Usage", + "type": "object", + "properties": { + "billable": { + "type": "object", + "properties": { + "UBUNTU": { + "type": "object", + "required": [ + "total_ms", + "jobs" + ], + "properties": { + "total_ms": { + "type": "integer" + }, + "jobs": { + "type": "integer" + } + } + }, + "MACOS": { + "type": "object", + "required": [ + "total_ms", + "jobs" + ], + "properties": { + "total_ms": { + "type": "integer" + }, + "jobs": { + "type": "integer" + } + } + }, + "WINDOWS": { + "type": "object", + "required": [ + "total_ms", + "jobs" + ], + "properties": { + "total_ms": { + "type": "integer" + }, + "jobs": { + "type": "integer" + } + } + } + } + }, + "run_duration_ms": { + "type": "integer" + } + }, + "required": [ + "billable", + "run_duration_ms" + ] + }, + "examples": { + "default": { + "value": { + "billable": { + "UBUNTU": { + "total_ms": 180000, + "jobs": 1 + }, + "MACOS": { + "total_ms": 240000, + "jobs": 4 + }, + "WINDOWS": { + "total_ms": 300000, + "jobs": 2 + } + }, + "run_duration_ms": 500000 + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [ + + ], + "category": "actions", + "subcategory": "workflow-runs" + } + } + }, + "/repos/{owner}/{repo}/actions/secrets": { + "get": { + "summary": "List repository secrets", + "description": "Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/list-repo-secrets", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#list-repository-secrets" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "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": "object", + "required": [ + "total_count", + "secrets" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "secrets": { + "type": "array", + "items": { + "title": "Actions Secret", + "description": "Set secrets for GitHub Actions.", + "type": "object", + "properties": { + "name": { + "description": "The name of the secret.", + "example": "SECRET_TOKEN", + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "name", + "created_at", + "updated_at" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 2, + "secrets": [ + { + "name": "GH_TOKEN", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z" + }, + { + "name": "GIST_ID", + "created_at": "2020-01-10T10:59:22Z", + "updated_at": "2020-01-11T11:59:22Z" + } + ] + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "secrets" + } + } + }, + "/repos/{owner}/{repo}/actions/secrets/public-key": { + "get": { + "summary": "Get a repository public key", + "description": "Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `secrets` repository permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-repo-public-key", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#get-a-repository-public-key" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "ActionsPublicKey", + "description": "The public key used for setting Actions Secrets.", + "type": "object", + "properties": { + "key_id": { + "description": "The identifier for the key.", + "type": "string", + "example": "1234567" + }, + "key": { + "description": "The Base64 encoded public key.", + "type": "string", + "example": "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=" + }, + "id": { + "type": "integer", + "example": 2 + }, + "url": { + "type": "string", + "example": "https://api.github.com/user/keys/2" + }, + "title": { + "type": "string", + "example": "ssh-rsa AAAAB3NzaC1yc2EAAA" + }, + "created_at": { + "type": "string", + "example": "2011-01-26T19:01:12Z" + } + }, + "required": [ + "key_id", + "key" + ] + }, + "examples": { + "default": { + "value": { + "key_id": "012345678912345678", + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "secrets" + } + } + }, + "/repos/{owner}/{repo}/actions/secrets/{secret_name}": { + "get": { + "summary": "Get a repository secret", + "description": "Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-repo-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#get-a-repository-secret" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "secret_name", + "description": "secret_name parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Actions Secret", + "description": "Set secrets for GitHub Actions.", + "type": "object", + "properties": { + "name": { + "description": "The name of the secret.", + "example": "SECRET_TOKEN", + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "name", + "created_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "name": "GH_TOKEN", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "secrets" + } + }, + "put": { + "summary": "Create or update a repository secret", + "description": "Creates or updates a repository secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access\ntoken with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use\nthis endpoint.\n\n#### Example encrypting a secret using Node.js\n\nEncrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library.\n\n```\nconst sodium = require('tweetsodium');\n\nconst key = \"base64-encoded-public-key\";\nconst value = \"plain-text-secret\";\n\n// Convert the message and key to Uint8Array's (Buffer implements that interface)\nconst messageBytes = Buffer.from(value);\nconst keyBytes = Buffer.from(key, 'base64');\n\n// Encrypt using LibSodium.\nconst encryptedBytes = sodium.seal(messageBytes, keyBytes);\n\n// Base64 the encrypted secret\nconst encrypted = Buffer.from(encryptedBytes).toString('base64');\n\nconsole.log(encrypted);\n```\n\n\n#### Example encrypting a secret using Python\n\nEncrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/stable/public/#nacl-public-sealedbox) with Python 3.\n\n```\nfrom base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n sealed_box = public.SealedBox(public_key)\n encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n return b64encode(encrypted).decode(\"utf-8\")\n```\n\n#### Example encrypting a secret using C#\n\nEncrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.\n\n```\nvar secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\n```\n\n#### Example encrypting a secret using Ruby\n\nEncrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.\n\n```ruby\nrequire \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\n```", + "tags": [ + "actions" + ], + "operationId": "actions/create-or-update-repo-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#create-or-update-a-repository-secret" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "secret_name", + "description": "secret_name parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "encrypted_value": { + "type": "string", + "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/github-ae@latest/rest/reference/actions#get-a-repository-public-key) endpoint.", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" + }, + "key_id": { + "type": "string", + "description": "ID of the key you used to encrypt the secret." + } + } + }, + "example": { + "encrypted_value": "c2VjcmV0", + "key_id": "012345678912345678" + } + } + } + }, + "responses": { + "201": { + "description": "Response when creating a secret" + }, + "204": { + "description": "Response when updating a secret" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "secrets" + } + }, + "delete": { + "summary": "Delete a repository secret", + "description": "Deletes a secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-repo-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#delete-a-repository-secret" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "secret_name", + "description": "secret_name parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "secrets" + } + } + }, + "/repos/{owner}/{repo}/actions/workflows": { + "get": { + "summary": "List repository workflows", + "description": "Lists the workflows in a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/list-repo-workflows", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#list-repository-workflows" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "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": "object", + "required": [ + "total_count", + "workflows" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "workflows": { + "type": "array", + "items": { + "title": "Workflow", + "description": "A GitHub Actions workflow", + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 5 + }, + "node_id": { + "type": "string", + "example": "MDg6V29ya2Zsb3cxMg==" + }, + "name": { + "type": "string", + "example": "CI" + }, + "path": { + "type": "string", + "example": "ruby.yaml" + }, + "state": { + "type": "string", + "example": "active", + "enum": [ + "active", + "deleted" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2019-12-06T14:20:20.000Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2019-12-06T14:20:20.000Z" + }, + "url": { + "type": "string", + "example": "https://api.github.com/repos/actions/setup-ruby/workflows/5" + }, + "html_url": { + "type": "string", + "example": "https://github.com/actions/setup-ruby/blob/master/.github/workflows/ruby.yaml" + }, + "badge_url": { + "type": "string", + "example": "https://github.com/actions/setup-ruby/workflows/CI/badge.svg" + }, + "deleted_at": { + "type": "string", + "format": "date-time", + "example": "2019-12-06T14:20:20.000Z" + } + }, + "required": [ + "id", + "node_id", + "name", + "path", + "state", + "url", + "html_url", + "badge_url", + "created_at", + "updated_at" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 2, + "workflows": [ + { + "id": 161335, + "node_id": "MDg6V29ya2Zsb3cxNjEzMzU=", + "name": "CI", + "path": ".github/workflows/blank.yaml", + "state": "active", + "created_at": "2020-01-08T23:48:37.000-08:00", + "updated_at": "2020-01-08T23:50:21.000-08:00", + "url": "https://api.github.com/repos/octo-org/octo-repo/actions/workflows/161335", + "html_url": "https://github.com/octo-org/octo-repo/blob/master/.github/workflows/161335", + "badge_url": "https://github.com/octo-org/octo-repo/workflows/CI/badge.svg" + }, + { + "id": 269289, + "node_id": "MDE4OldvcmtmbG93IFNlY29uZGFyeTI2OTI4OQ==", + "name": "Linter", + "path": ".github/workflows/linter.yaml", + "state": "active", + "created_at": "2020-01-08T23:48:37.000-08:00", + "updated_at": "2020-01-08T23:50:21.000-08:00", + "url": "https://api.github.com/repos/octo-org/octo-repo/actions/workflows/269289", + "html_url": "https://github.com/octo-org/octo-repo/blob/master/.github/workflows/269289", + "badge_url": "https://github.com/octo-org/octo-repo/workflows/Linter/badge.svg" + } + ] + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "workflows" + } + } + }, + "/repos/{owner}/{repo}/actions/workflows/{workflow_id}": { + "get": { + "summary": "Get a workflow", + "description": "Gets a specific workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-workflow", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#get-a-workflow" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "workflow_id", + "in": "path", + "description": "The ID of the workflow. You can also pass the workflow file name as a string.", + "required": true, + "schema": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string" + } + ] + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Workflow", + "description": "A GitHub Actions workflow", + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 5 + }, + "node_id": { + "type": "string", + "example": "MDg6V29ya2Zsb3cxMg==" + }, + "name": { + "type": "string", + "example": "CI" + }, + "path": { + "type": "string", + "example": "ruby.yaml" + }, + "state": { + "type": "string", + "example": "active", + "enum": [ + "active", + "deleted" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2019-12-06T14:20:20.000Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2019-12-06T14:20:20.000Z" + }, + "url": { + "type": "string", + "example": "https://api.github.com/repos/actions/setup-ruby/workflows/5" + }, + "html_url": { + "type": "string", + "example": "https://github.com/actions/setup-ruby/blob/master/.github/workflows/ruby.yaml" + }, + "badge_url": { + "type": "string", + "example": "https://github.com/actions/setup-ruby/workflows/CI/badge.svg" + }, + "deleted_at": { + "type": "string", + "format": "date-time", + "example": "2019-12-06T14:20:20.000Z" + } + }, + "required": [ + "id", + "node_id", + "name", + "path", + "state", + "url", + "html_url", + "badge_url", + "created_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "id": 161335, + "node_id": "MDg6V29ya2Zsb3cxNjEzMzU=", + "name": "CI", + "path": ".github/workflows/blank.yaml", + "state": "active", + "created_at": "2020-01-08T23:48:37.000-08:00", + "updated_at": "2020-01-08T23:50:21.000-08:00", + "url": "https://api.github.com/repos/octo-org/octo-repo/actions/workflows/161335", + "html_url": "https://github.com/octo-org/octo-repo/blob/master/.github/workflows/161335", + "badge_url": "https://github.com/octo-org/octo-repo/workflows/CI/badge.svg" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "workflows" + } + } + }, + "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable": { + "put": { + "summary": "Disable a workflow", + "description": "Disables a workflow and sets the `state` of the workflow to `disabled_manually`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/disable-workflow", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#disable-a-workflow" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "workflow_id", + "in": "path", + "description": "The ID of the workflow. You can also pass the workflow file name as a string.", + "required": true, + "schema": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string" + } + ] + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "workflows" + } + } + }, + "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches": { + "post": { + "summary": "Create a workflow dispatch event", + "description": "You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.\n\nYou must configure your GitHub Actions workflow to run when the [`workflow_dispatch` webhook](/developers/webhooks-and-events/webhook-events-and-payloads#workflow_dispatch) event occurs. The `inputs` are configured in the workflow file. For more information about how to configure the `workflow_dispatch` event in the workflow file, see \"[Events that trigger workflows](/actions/reference/events-that-trigger-workflows#workflow_dispatch).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see \"[Creating a personal access token for the command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line).\"", + "operationId": "actions/create-workflow-dispatch", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#create-a-workflow-dispatch-event" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "workflow_id", + "in": "path", + "description": "The ID of the workflow. You can also pass the workflow file name as a string.", + "required": true, + "schema": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string" + } + ] + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "ref": { + "type": "string", + "description": "The git reference for the workflow. The reference can be a branch or tag name." + }, + "inputs": { + "type": "object", + "description": "Input keys and values configured in the workflow file. The maximum number of properties is 10. Any default properties configured in the workflow file will be used when `inputs` are omitted.", + "additionalProperties": { + "type": "string" + }, + "maxProperties": 10 + } + }, + "required": [ + "ref" + ] + }, + "example": { + "ref": "topic-branch", + "inputs": { + "name": "Mona the Octocat", + "home": "San Francisco, CA" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "workflows" + } + } + }, + "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable": { + "put": { + "summary": "Enable a workflow", + "description": "Enables a workflow and sets the `state` of the workflow to `active`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/enable-workflow", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#enable-a-workflow" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "workflow_id", + "in": "path", + "description": "The ID of the workflow. You can also pass the workflow file name as a string.", + "required": true, + "schema": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string" + } + ] + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "workflows" + } + } + }, + "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs": { + "get": { + "summary": "List workflow runs", + "description": "List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope.", + "tags": [ + "actions" + ], + "operationId": "actions/list-workflow-runs", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#list-workflow-runs" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "workflow_id", + "in": "path", + "description": "The ID of the workflow. You can also pass the workflow file name as a string.", + "required": true, + "schema": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string" + } + ] + } + }, + { + "name": "actor", + "description": "Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "branch", + "description": "Returns workflow runs associated with a branch. Use the name of the branch of the `push`.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "event", + "description": "Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see \"[Events that trigger workflows](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows).\"", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "status", + "description": "Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`. For a list of the possible `status` and `conclusion` options, see \"[Create a check run](https://docs.github.com/github-ae@latest/rest/reference/checks#create-a-check-run).\"", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "completed", + "action_required", + "cancelled", + "failure", + "neutral", + "skipped", + "stale", + "success", + "timed_out", + "in_progress", + "queued", + "requested", + "waiting" + ] + } + }, + { + "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": "object", + "required": [ + "total_count", + "workflow_runs" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "workflow_runs": { + "type": "array", + "items": { + "title": "Workflow Run", + "description": "An invocation of a workflow", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the workflow run.", + "example": 5 + }, + "name": { + "type": "string", + "description": "The name of the workflow run.", + "example": "Build" + }, + "node_id": { + "type": "string", + "example": "MDEwOkNoZWNrU3VpdGU1" + }, + "head_branch": { + "type": "string", + "nullable": true, + "example": "master" + }, + "head_sha": { + "description": "The SHA of the head commit that points to the version of the worflow being run.", + "example": "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d", + "type": "string" + }, + "run_number": { + "type": "integer", + "description": "The auto incrementing run number for the workflow run.", + "example": 106 + }, + "event": { + "type": "string", + "example": "push" + }, + "status": { + "type": "string", + "nullable": true, + "example": "completed" + }, + "conclusion": { + "type": "string", + "nullable": true, + "example": "neutral" + }, + "workflow_id": { + "type": "integer", + "description": "The ID of the parent workflow.", + "example": 5 + }, + "url": { + "type": "string", + "description": "The URL to the workflow run.", + "example": "https://api.github.com/repos/github/hello-world/actions/runs/5" + }, + "html_url": { + "type": "string", + "example": "https://github.com/github/hello-world/suites/4" + }, + "pull_requests": { + "type": "array", + "nullable": true, + "items": { + "title": "Pull Request Minimal", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "number": { + "type": "integer" + }, + "url": { + "type": "string" + }, + "head": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "id", + "url", + "name" + ] + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + }, + "base": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "id", + "url", + "name" + ] + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + } + }, + "required": [ + "id", + "number", + "url", + "head", + "base" + ] + } + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "jobs_url": { + "description": "The URL to the jobs for the workflow run.", + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/jobs" + }, + "logs_url": { + "description": "The URL to download the logs for the workflow run.", + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/logs" + }, + "check_suite_url": { + "description": "The URL to the associated check suite.", + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/check-suites/12" + }, + "artifacts_url": { + "description": "The URL to the artifacts for the workflow run.", + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/rerun/artifacts" + }, + "cancel_url": { + "description": "The URL to cancel the workflow run.", + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/cancel" + }, + "rerun_url": { + "description": "The URL to rerun the workflow run.", + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/rerun" + }, + "workflow_url": { + "description": "The URL to the workflow.", + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/workflows/main.yaml" + }, + "head_commit": { + "title": "Simple Commit", + "description": "Simple Commit", + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "tree_id": { + "type": "string" + }, + "message": { + "type": "string" + }, + "timestamp": { + "type": "string", + "format": "date-time" + }, + "author": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "email": { + "type": "string" + } + }, + "required": [ + "name", + "email" + ], + "nullable": true + }, + "committer": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "email": { + "type": "string" + } + }, + "required": [ + "name", + "email" + ], + "nullable": true + } + }, + "required": [ + "id", + "tree_id", + "message", + "timestamp", + "author", + "committer" + ] + }, + "repository": { + "title": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 1296269 + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "type": "string", + "example": "Hello-World" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "owner": { + "type": "object", + "nullable": true, + "allOf": [ + { + "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 + } + ] + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "template_repository": { + "nullable": true, + "type": "object", + "allOf": [ + { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "nullable": true, + "allOf": [ + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "nullable": true, + "allOf": [ + { + "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 + } + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "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" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + } + ] + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "license": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + }, + "nullable": true + }, + "forks": { + "type": "integer", + "example": 0 + }, + "open_issues": { + "type": "integer", + "example": 0 + }, + "watchers": { + "type": "integer", + "example": 0 + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" + ] + }, + "head_repository": { + "title": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 1296269 + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "type": "string", + "example": "Hello-World" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "owner": { + "type": "object", + "nullable": true, + "allOf": [ + { + "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 + } + ] + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "template_repository": { + "nullable": true, + "type": "object", + "allOf": [ + { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "nullable": true, + "allOf": [ + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "nullable": true, + "allOf": [ + { + "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 + } + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "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" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + } + ] + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "license": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + }, + "nullable": true + }, + "forks": { + "type": "integer", + "example": 0 + }, + "open_issues": { + "type": "integer", + "example": 0 + }, + "watchers": { + "type": "integer", + "example": 0 + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" + ] + }, + "head_repository_id": { + "type": "integer", + "example": 5 + } + }, + "required": [ + "id", + "node_id", + "head_branch", + "run_number", + "event", + "status", + "conclusion", + "head_sha", + "workflow_id", + "url", + "html_url", + "created_at", + "updated_at", + "head_commit", + "head_repository", + "repository", + "jobs_url", + "logs_url", + "check_suite_url", + "cancel_url", + "rerun_url", + "artifacts_url", + "workflow_url", + "pull_requests" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 1, + "workflow_runs": [ + { + "id": 30433642, + "name": "Build", + "node_id": "MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==", + "head_branch": "master", + "head_sha": "acb5820ced9479c074f688cc328bf03f341a511d", + "run_number": 562, + "event": "push", + "status": "queued", + "conclusion": null, + "workflow_id": 159038, + "url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642", + "html_url": "https://github.com/octo-org/octo-repo/actions/runs/30433642", + "pull_requests": [ + + ], + "created_at": "2020-01-22T19:33:08Z", + "updated_at": "2020-01-22T19:33:08Z", + "jobs_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs", + "logs_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs", + "check_suite_url": "https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374", + "artifacts_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts", + "cancel_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel", + "rerun_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun", + "workflow_url": "https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038", + "head_commit": { + "id": "acb5820ced9479c074f688cc328bf03f341a511d", + "tree_id": "d23f6eedb1e1b9610bbc754ddb5197bfe7271223", + "message": "Create linter.yaml", + "timestamp": "2020-01-22T19:33:05Z", + "author": { + "name": "Octo Cat", + "email": "octocat@github.com" + }, + "committer": { + "name": "GitHub", + "email": "noreply@github.com" + } + }, + "repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "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 + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "head_repository": { + "id": 217723378, + "node_id": "MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=", + "name": "octo-repo", + "full_name": "octo-org/octo-repo", + "private": true, + "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 + }, + "html_url": "https://github.com/octo-org/octo-repo", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/octo-org/octo-repo", + "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks", + "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams", + "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks", + "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}", + "events_url": "https://api.github.com/repos/octo-org/octo-repo/events", + "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}", + "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}", + "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags", + "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}", + "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages", + "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers", + "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors", + "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers", + "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription", + "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}", + "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges", + "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads", + "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}", + "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}", + "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}", + "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}", + "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments" + } + } + ] + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "workflow-runs" + } + } + }, + "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing": { + "get": { + "summary": "Get workflow usage", + "description": "Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub AE-hosted runners. Usage is listed for each GitHub AE-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nYou can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-workflow-usage", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#get-workflow-usage" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "workflow_id", + "in": "path", + "description": "The ID of the workflow. You can also pass the workflow file name as a string.", + "required": true, + "schema": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string" + } + ] + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Workflow Usage", + "description": "Workflow Usage", + "type": "object", + "properties": { + "billable": { + "type": "object", + "properties": { + "UBUNTU": { + "type": "object", + "properties": { + "total_ms": { + "type": "integer" + } + } + }, + "MACOS": { + "type": "object", + "properties": { + "total_ms": { + "type": "integer" + } + } + }, + "WINDOWS": { + "type": "object", + "properties": { + "total_ms": { + "type": "integer" + } + } + } + } + } + }, + "required": [ + "billable" + ] + }, + "examples": { + "default": { + "value": { + "billable": { + "UBUNTU": { + "total_ms": 180000 + }, + "MACOS": { + "total_ms": 240000 + }, + "WINDOWS": { + "total_ms": 300000 + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [ + + ], + "category": "actions", + "subcategory": "workflows" + } + } + }, "/repos/{owner}/{repo}/assignees": { "get": { "summary": "List assignees", @@ -75729,7 +97464,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -75885,7 +97620,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -76049,7 +97784,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -76775,18 +98510,6 @@ }, "examples": { "default": { - "value": [ - { - "name": "master", - "commit": { - "sha": "c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc", - "url": "https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc" - }, - "protected": true - } - ] - }, - "with-protection": { "value": [ { "name": "master", @@ -76822,7 +98545,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -76895,7 +98618,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -78213,7 +99936,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -78235,7 +99958,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -78308,7 +100031,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -79154,7 +100877,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -79393,7 +101116,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -80124,7 +101847,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -80146,7 +101869,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -80176,7 +101899,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -80251,7 +101974,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -80327,7 +102050,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -80413,7 +102136,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -80502,7 +102225,7 @@ "description": "No Content" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -80575,7 +102298,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/vnd.github.luke-cage-preview+json": { "schema": { @@ -81054,7 +102777,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -81422,7 +103145,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -81549,7 +103272,7 @@ "description": "No Content" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -81622,7 +103345,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -81657,7 +103380,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -81732,7 +103455,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -81767,7 +103490,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -81845,7 +103568,7 @@ "description": "No Content" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -81922,7 +103645,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -81977,7 +103700,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -82076,7 +103799,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -82131,7 +103854,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -82151,7 +103874,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -82327,7 +104050,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -82343,7 +104066,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -82440,7 +104163,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -82457,7 +104180,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -82546,7 +104269,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -82644,7 +104367,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -82660,7 +104383,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -82729,7 +104452,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -82827,7 +104550,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -82843,7 +104566,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -82863,7 +104586,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -82986,7 +104709,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -83357,7 +105080,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -83484,7 +105207,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -83783,7 +105506,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -83880,7 +105603,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -84179,7 +105902,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -84326,7 +106049,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -84625,7 +106348,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -84772,7 +106495,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -85071,7 +106794,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -85194,7 +106917,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -85365,7 +107088,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -85462,7 +107185,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -85633,7 +107356,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -85780,7 +107503,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -85951,7 +107674,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -86098,7 +107821,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -86269,7 +107992,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -86392,7 +108115,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -86540,7 +108263,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -86637,7 +108360,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -86785,7 +108508,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -86932,7 +108655,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -87080,7 +108803,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -87227,7 +108950,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -87375,7 +109098,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -87682,7 +109405,7 @@ "name", "head_sha" ], - "anyOf": [ + "oneOf": [ { "properties": { "status": { @@ -87692,6 +109415,7 @@ } }, "required": [ + "status", "conclusion" ], "additionalProperties": true @@ -87711,7 +109435,7 @@ }, "examples": { "example-of-in-progress-conclusion": { - "summary": "Example of in_progress conclusion", + "summary": "Response for in_progress conclusion", "value": { "name": "mighty_readme", "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -87726,7 +109450,7 @@ } }, "example-of-completed-conclusion": { - "summary": "Example of completed conclusion", + "summary": "Response for completed conclusion", "value": { "name": "mighty_readme", "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -87780,7 +109504,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -88596,101 +110320,8 @@ ] }, "examples": { - "example-of-in-progress-conclusion": { - "summary": "Example of in_progress conclusion", - "value": { - "id": 4, - "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", - "node_id": "MDg6Q2hlY2tSdW40", - "external_id": "42", - "url": "https://api.github.com/repos/github/hello-world/check-runs/4", - "html_url": "https://github.com/github/hello-world/runs/4", - "details_url": "https://example.com", - "status": "in_progress", - "conclusion": "neutral", - "started_at": "2018-05-04T01:14:52Z", - "completed_at": null, - "output": { - "title": "Mighty Readme Report", - "summary": "", - "text": "", - "annotations_count": 1, - "annotations_url": "https://api.github.com/repos/github/hello-world/check-runs/4/annotations" - }, - "name": "mighty_readme", - "check_suite": { - "id": 5 - }, - "app": { - "id": 1, - "slug": "octoapp", - "node_id": "MDExOkludGVncmF0aW9uMQ==", - "owner": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "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", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": true - }, - "name": "Octocat App", - "description": "", - "external_url": "https://example.com", - "html_url": "https://github.com/apps/octoapp", - "created_at": "2017-07-08T16:18:44-04:00", - "updated_at": "2017-07-08T16:18:44-04:00", - "permissions": { - "metadata": "read", - "contents": "read", - "issues": "write", - "single_file": "write" - }, - "events": [ - "push", - "pull_request" - ] - }, - "pull_requests": [ - { - "url": "https://api.github.com/repos/github/hello-world/pulls/1", - "id": 1934, - "number": 3956, - "head": { - "ref": "say-hello", - "sha": "3dca65fa3e8d4b3da3f3d056c59aee1c50f41390", - "repo": { - "id": 526, - "url": "https://api.github.com/repos/github/hello-world", - "name": "hello-world" - } - }, - "base": { - "ref": "master", - "sha": "e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f", - "repo": { - "id": 526, - "url": "https://api.github.com/repos/github/hello-world", - "name": "hello-world" - } - } - } - ] - } - }, "example-of-completed-conclusion": { - "summary": "Example of completed conclusion", + "summary": "Response for completed conclusion", "value": { "id": 4, "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -88839,7 +110470,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -90056,7 +111687,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -91039,7 +112670,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -91203,7 +112834,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -93588,7 +115219,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -94783,7 +116414,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -97191,7 +118822,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -98184,7 +119815,7 @@ ], "responses": { "201": { - "description": "response" + "description": "Response" } }, "x-github": { @@ -98198,6 +119829,2884 @@ } } }, + "/repos/{owner}/{repo}/code-scanning/alerts": { + "get": { + "summary": "List code scanning alerts for a repository", + "description": "Lists all open code scanning alerts for the default branch (usually `main`\nor `master`). You must use an access token with the `security_events` scope to use\nthis endpoint. GitHub Apps must have the `security_events` read permission to use\nthis endpoint.\n\nThe response includes a `most_recent_instance` object.\nThis provides details of the most recent instance of this alert\nfor the default branch or for the specified Git reference\n(if you used `ref` in the request).", + "tags": [ + "code-scanning" + ], + "operationId": "code-scanning/list-alerts-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/code-scanning#list-code-scanning-alerts-for-a-repository" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "tool_name", + "description": "The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "description": "The name of the tool used to generate the code scanning analysis." + } + }, + { + "name": "tool_guid", + "description": "The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both.", + "in": "query", + "required": false, + "schema": { + "nullable": true, + "type": "string", + "description": "The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data." + } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "ref", + "description": "The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." + } + }, + { + "name": "state", + "description": "Set to `open`, `fixed`, or `dismissed` to list code scanning alerts in a specific state.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "description": "State of a code scanning alert.", + "enum": [ + "open", + "closed", + "dismissed", + "fixed" + ] + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "number": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true, + "nullable": false + }, + "created_at": { + "type": "string", + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true, + "nullable": false + }, + "url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true, + "nullable": false + }, + "html_url": { + "type": "string", + "description": "The GitHub URL of the alert resource.", + "format": "uri", + "readOnly": true, + "nullable": false + }, + "instances_url": { + "type": "string", + "description": "The REST API URL for fetching the list of instances for an alert.", + "format": "uri", + "readOnly": true, + "nullable": false + }, + "state": { + "type": "string", + "description": "State of a code scanning alert.", + "enum": [ + "open", + "closed", + "dismissed", + "fixed" + ] + }, + "dismissed_by": { + "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 + }, + "dismissed_at": { + "type": "string", + "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true, + "nullable": true + }, + "dismissed_reason": { + "type": "string", + "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "nullable": true, + "oneOf": [ + { + "enum": [ + "false positive", + "won't fix", + "used in tests" + ] + }, + { + "enum": [ + null + ] + } + ] + }, + "rule": { + "type": "object", + "properties": { + "id": { + "nullable": true, + "type": "string", + "description": "A unique identifier for the rule used to detect the alert." + }, + "name": { + "type": "string", + "description": "The name of the rule used to detect the alert." + }, + "severity": { + "nullable": true, + "type": "string", + "description": "The severity of the alert.", + "enum": [ + "none", + "note", + "warning", + "error" + ] + }, + "description": { + "type": "string", + "description": "A short description of the rule used to detect the alert." + } + } + }, + "tool": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the tool used to generate the code scanning analysis." + }, + "version": { + "nullable": true, + "type": "string", + "description": "The version of the tool used to generate the code scanning analysis." + }, + "guid": { + "nullable": true, + "type": "string", + "description": "The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data." + } + } + }, + "most_recent_instance": { + "type": "object", + "properties": { + "ref": { + "type": "string", + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." + }, + "analysis_key": { + "type": "string", + "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name." + }, + "environment": { + "type": "string", + "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed." + }, + "state": { + "type": "string", + "description": "State of a code scanning alert.", + "enum": [ + "open", + "closed", + "dismissed", + "fixed" + ] + }, + "commit_sha": { + "type": "string" + }, + "message": { + "type": "object", + "properties": { + "text": { + "type": "string" + } + } + }, + "location": { + "type": "object", + "description": "Describe a region within a file for the alert.", + "properties": { + "path": { + "type": "string" + }, + "start_line": { + "type": "integer" + }, + "end_line": { + "type": "integer" + }, + "start_column": { + "type": "integer" + }, + "end_column": { + "type": "integer" + } + } + }, + "html_url": { + "type": "string" + }, + "classifications": { + "type": "array", + "description": "Classifications that have been applied to the file that triggered the alert.\nFor example identifying it as documentation, or a generated file.", + "items": { + "type": "string", + "description": "A classification of the file. For example to identify it as generated.", + "nullable": true, + "enum": [ + "source", + "generated", + "test", + "library" + ] + } + } + } + } + }, + "required": [ + "number", + "created_at", + "url", + "html_url", + "instances_url", + "state", + "dismissed_by", + "dismissed_at", + "dismissed_reason", + "rule", + "tool", + "most_recent_instance" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "number": 4, + "created_at": "2020-02-13T12:29:18Z", + "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4", + "html_url": "https://github.com/octocat/hello-world/code-scanning/4", + "state": "open", + "dismissed_by": null, + "dismissed_at": null, + "dismissed_reason": null, + "rule": { + "id": "js/zipslip", + "severity": "error", + "description": "Arbitrary file write during zip extraction", + "name": "js/zipslip" + }, + "tool": { + "name": "CodeQL", + "guid": null, + "version": "2.4.0" + }, + "most_recent_instance": { + "ref": "refs/heads/main", + "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", + "environment": "{}", + "state": "open", + "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", + "message": { + "text": "This path depends on a user-provided value." + }, + "location": { + "path": "spec-main/api-session-spec.ts", + "start_line": 917, + "end_line": 917, + "start_column": 7, + "end_column": 18 + }, + "classifications": [ + "test" + ] + }, + "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4/instances" + }, + { + "number": 3, + "created_at": "2020-02-13T12:29:18Z", + "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3", + "html_url": "https://github.com/octocat/hello-world/code-scanning/3", + "state": "dismissed", + "dismissed_by": { + "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 + }, + "dismissed_at": "2020-02-14T12:29:18Z", + "dismissed_reason": "false positive", + "rule": { + "id": "js/zipslip", + "severity": "error", + "description": "Arbitrary file write during zip extraction", + "name": "js/zipslip" + }, + "tool": { + "name": "CodeQL", + "guid": null, + "version": "2.4.0" + }, + "most_recent_instance": { + "ref": "refs/heads/main", + "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", + "environment": "{}", + "state": "open", + "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", + "message": { + "text": "This path depends on a user-provided value." + }, + "location": { + "path": "lib/ab12-gen.js", + "start_line": 917, + "end_line": 917, + "start_column": 7, + "end_column": 18 + }, + "classifications": [ + + ] + }, + "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances" + } + ] + } + } + } + } + }, + "403": { + "description": "Response if GitHub Advanced Security is not enabled for this repository", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "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" + } + } + } + } + } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "code-scanning", + "subcategory": null + } + } + }, + "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}": { + "get": { + "summary": "Get a code scanning alert", + "description": "Gets a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` read permission to use this endpoint.\n\n**Deprecation notice**:\nThe instances field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The same information can now be retrieved via a GET request to the URL specified by `instances_url`.", + "tags": [ + "code-scanning" + ], + "operationId": "code-scanning/get-alert", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/code-scanning#get-a-code-scanning-alert" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "alert_number", + "in": "path", + "description": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation.", + "required": true, + "schema": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true, + "nullable": false + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "number": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true, + "nullable": false + }, + "created_at": { + "type": "string", + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true, + "nullable": false + }, + "url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true, + "nullable": false + }, + "html_url": { + "type": "string", + "description": "The GitHub URL of the alert resource.", + "format": "uri", + "readOnly": true, + "nullable": false + }, + "instances_url": { + "type": "string", + "description": "The REST API URL for fetching the list of instances for an alert.", + "format": "uri", + "readOnly": true, + "nullable": false + }, + "state": { + "type": "string", + "description": "State of a code scanning alert.", + "enum": [ + "open", + "closed", + "dismissed", + "fixed" + ] + }, + "dismissed_by": { + "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 + }, + "dismissed_at": { + "type": "string", + "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true, + "nullable": true + }, + "dismissed_reason": { + "type": "string", + "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "nullable": true, + "oneOf": [ + { + "enum": [ + "false positive", + "won't fix", + "used in tests" + ] + }, + { + "enum": [ + null + ] + } + ] + }, + "rule": { + "type": "object", + "properties": { + "id": { + "nullable": true, + "type": "string", + "description": "A unique identifier for the rule used to detect the alert." + }, + "name": { + "type": "string", + "description": "The name of the rule used to detect the alert." + }, + "severity": { + "nullable": true, + "type": "string", + "description": "The severity of the alert.", + "enum": [ + "none", + "note", + "warning", + "error" + ] + }, + "description": { + "type": "string", + "description": "A short description of the rule used to detect the alert." + }, + "full_description": { + "type": "string", + "description": "description of the rule used to detect the alert." + }, + "tags": { + "type": "array", + "description": "A set of tags applicable for the rule.", + "items": { + "type": "string" + } + }, + "help": { + "type": "string", + "description": "Detailed documentation for the rule as GitHub Flavored Markdown." + } + } + }, + "tool": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the tool used to generate the code scanning analysis." + }, + "version": { + "nullable": true, + "type": "string", + "description": "The version of the tool used to generate the code scanning analysis." + }, + "guid": { + "nullable": true, + "type": "string", + "description": "The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data." + } + } + }, + "most_recent_instance": { + "type": "object", + "properties": { + "ref": { + "type": "string", + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." + }, + "analysis_key": { + "type": "string", + "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name." + }, + "environment": { + "type": "string", + "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed." + }, + "state": { + "type": "string", + "description": "State of a code scanning alert.", + "enum": [ + "open", + "closed", + "dismissed", + "fixed" + ] + }, + "commit_sha": { + "type": "string" + }, + "message": { + "type": "object", + "properties": { + "text": { + "type": "string" + } + } + }, + "location": { + "type": "object", + "description": "Describe a region within a file for the alert.", + "properties": { + "path": { + "type": "string" + }, + "start_line": { + "type": "integer" + }, + "end_line": { + "type": "integer" + }, + "start_column": { + "type": "integer" + }, + "end_column": { + "type": "integer" + } + } + }, + "html_url": { + "type": "string" + }, + "classifications": { + "type": "array", + "description": "Classifications that have been applied to the file that triggered the alert.\nFor example identifying it as documentation, or a generated file.", + "items": { + "type": "string", + "description": "A classification of the file. For example to identify it as generated.", + "nullable": true, + "enum": [ + "source", + "generated", + "test", + "library" + ] + } + } + } + } + }, + "required": [ + "number", + "created_at", + "url", + "html_url", + "instances_url", + "state", + "dismissed_by", + "dismissed_at", + "dismissed_reason", + "rule", + "tool", + "most_recent_instance" + ] + }, + "examples": { + "default": { + "value": { + "number": 42, + "created_at": "2020-06-19T11:21:34Z", + "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42", + "html_url": "https://github.com/octocat/hello-world/code-scanning/42", + "state": "dismissed", + "dismissed_by": { + "login": "octocat", + "id": 54933897, + "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 + }, + "dismissed_at": "2020-02-14T12:29:18Z", + "dismissed_reason": "false positive", + "rule": { + "id": "js/zipslip", + "severity": "error", + "description": "Arbitrary file write during zip extraction (\"Zip Slip\")", + "name": "js/zipslip", + "full_description": "Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.", + "tags": [ + "security", + "external/cwe/cwe-022" + ], + "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ..." + }, + "tool": { + "name": "CodeQL", + "guid": null, + "version": "2.4.0" + }, + "most_recent_instance": { + "ref": "refs/heads/main", + "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", + "environment": "{}", + "state": "dismissed", + "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", + "message": { + "text": "This path depends on a user-provided value." + }, + "location": { + "path": "spec-main/api-session-spec.ts", + "start_line": 917, + "end_line": 917, + "start_column": 7, + "end_column": 18 + }, + "classifications": [ + "test" + ] + }, + "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances" + } + } + } + } + } + }, + "403": { + "description": "Response if GitHub Advanced Security is not enabled for this repository", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "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" + } + } + } + } + } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "code-scanning", + "subcategory": null + } + }, + "patch": { + "summary": "Update a code scanning alert", + "description": "Updates the status of a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint.", + "operationId": "code-scanning/update-alert", + "tags": [ + "code-scanning" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/code-scanning#update-a-code-scanning-alert" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "alert_number", + "in": "path", + "description": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation.", + "required": true, + "schema": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true, + "nullable": false + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "state": { + "description": "Sets the state of the code scanning alert. Can be one of `open` or `dismissed`. You must provide `dismissed_reason` when you set the state to `dismissed`.", + "type": "string", + "enum": [ + "open", + "dismissed" + ] + }, + "dismissed_reason": { + "type": "string", + "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "nullable": true, + "oneOf": [ + { + "enum": [ + "false positive", + "won't fix", + "used in tests" + ] + }, + { + "enum": [ + null + ] + } + ] + } + }, + "required": [ + "state" + ] + }, + "example": { + "state": "dismissed", + "dismissed_reason": "false positive" + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "number": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true, + "nullable": false + }, + "created_at": { + "type": "string", + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true, + "nullable": false + }, + "url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true, + "nullable": false + }, + "html_url": { + "type": "string", + "description": "The GitHub URL of the alert resource.", + "format": "uri", + "readOnly": true, + "nullable": false + }, + "instances_url": { + "type": "string", + "description": "The REST API URL for fetching the list of instances for an alert.", + "format": "uri", + "readOnly": true, + "nullable": false + }, + "state": { + "type": "string", + "description": "State of a code scanning alert.", + "enum": [ + "open", + "closed", + "dismissed", + "fixed" + ] + }, + "dismissed_by": { + "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 + }, + "dismissed_at": { + "type": "string", + "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true, + "nullable": true + }, + "dismissed_reason": { + "type": "string", + "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "nullable": true, + "oneOf": [ + { + "enum": [ + "false positive", + "won't fix", + "used in tests" + ] + }, + { + "enum": [ + null + ] + } + ] + }, + "rule": { + "type": "object", + "properties": { + "id": { + "nullable": true, + "type": "string", + "description": "A unique identifier for the rule used to detect the alert." + }, + "name": { + "type": "string", + "description": "The name of the rule used to detect the alert." + }, + "severity": { + "nullable": true, + "type": "string", + "description": "The severity of the alert.", + "enum": [ + "none", + "note", + "warning", + "error" + ] + }, + "description": { + "type": "string", + "description": "A short description of the rule used to detect the alert." + }, + "full_description": { + "type": "string", + "description": "description of the rule used to detect the alert." + }, + "tags": { + "type": "array", + "description": "A set of tags applicable for the rule.", + "items": { + "type": "string" + } + }, + "help": { + "type": "string", + "description": "Detailed documentation for the rule as GitHub Flavored Markdown." + } + } + }, + "tool": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the tool used to generate the code scanning analysis." + }, + "version": { + "nullable": true, + "type": "string", + "description": "The version of the tool used to generate the code scanning analysis." + }, + "guid": { + "nullable": true, + "type": "string", + "description": "The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data." + } + } + }, + "most_recent_instance": { + "type": "object", + "properties": { + "ref": { + "type": "string", + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." + }, + "analysis_key": { + "type": "string", + "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name." + }, + "environment": { + "type": "string", + "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed." + }, + "state": { + "type": "string", + "description": "State of a code scanning alert.", + "enum": [ + "open", + "closed", + "dismissed", + "fixed" + ] + }, + "commit_sha": { + "type": "string" + }, + "message": { + "type": "object", + "properties": { + "text": { + "type": "string" + } + } + }, + "location": { + "type": "object", + "description": "Describe a region within a file for the alert.", + "properties": { + "path": { + "type": "string" + }, + "start_line": { + "type": "integer" + }, + "end_line": { + "type": "integer" + }, + "start_column": { + "type": "integer" + }, + "end_column": { + "type": "integer" + } + } + }, + "html_url": { + "type": "string" + }, + "classifications": { + "type": "array", + "description": "Classifications that have been applied to the file that triggered the alert.\nFor example identifying it as documentation, or a generated file.", + "items": { + "type": "string", + "description": "A classification of the file. For example to identify it as generated.", + "nullable": true, + "enum": [ + "source", + "generated", + "test", + "library" + ] + } + } + } + } + }, + "required": [ + "number", + "created_at", + "url", + "html_url", + "instances_url", + "state", + "dismissed_by", + "dismissed_at", + "dismissed_reason", + "rule", + "tool", + "most_recent_instance" + ] + }, + "examples": { + "default": { + "value": { + "number": 42, + "created_at": "2020-08-25T21:28:36Z", + "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42", + "html_url": "https://github.com/octocat/hello-world/code-scanning/42", + "state": "dismissed", + "dismissed_by": { + "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 + }, + "dismissed_at": "2020-09-02T22:34:56Z", + "dismissed_reason": "false positive", + "rule": { + "id": "js/zipslip", + "severity": "error", + "description": "Arbitrary file write during zip extraction (\"Zip Slip\")", + "name": "js/zipslip", + "full_description": "Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.", + "tags": [ + "security", + "external/cwe/cwe-022" + ], + "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ..." + }, + "tool": { + "name": "CodeQL", + "guid": null, + "version": "2.4.0" + }, + "most_recent_instance": { + "ref": "refs/heads/main", + "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", + "environment": "{}", + "state": "dismissed", + "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", + "message": { + "text": "This path depends on a user-provided value." + }, + "location": { + "path": "spec-main/api-session-spec.ts", + "start_line": 917, + "end_line": 917, + "start_column": 7, + "end_column": 18 + }, + "classifications": [ + "test" + ] + }, + "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances" + } + } + } + } + } + }, + "403": { + "description": "Response if the repository is archived or if github advanced security is not enabled for this repository", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "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" + } + } + } + } + } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "code-scanning" + } + } + }, + "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances": { + "get": { + "summary": "List instances of a code scanning alert", + "description": "Lists all instances of the specified code scanning alert. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` read permission to use this endpoint.", + "tags": [ + "code-scanning" + ], + "operationId": "code-scanning/list-alerts-instances", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/code-scanning#list-instances-of-a-code-scanning-alert" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "alert_number", + "in": "path", + "description": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation.", + "required": true, + "schema": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true, + "nullable": false + } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "ref", + "description": "The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "ref": { + "type": "string", + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." + }, + "analysis_key": { + "type": "string", + "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name." + }, + "environment": { + "type": "string", + "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed." + }, + "state": { + "type": "string", + "description": "State of a code scanning alert.", + "enum": [ + "open", + "closed", + "dismissed", + "fixed" + ] + }, + "commit_sha": { + "type": "string" + }, + "message": { + "type": "object", + "properties": { + "text": { + "type": "string" + } + } + }, + "location": { + "type": "object", + "description": "Describe a region within a file for the alert.", + "properties": { + "path": { + "type": "string" + }, + "start_line": { + "type": "integer" + }, + "end_line": { + "type": "integer" + }, + "start_column": { + "type": "integer" + }, + "end_column": { + "type": "integer" + } + } + }, + "html_url": { + "type": "string" + }, + "classifications": { + "type": "array", + "description": "Classifications that have been applied to the file that triggered the alert.\nFor example identifying it as documentation, or a generated file.", + "items": { + "type": "string", + "description": "A classification of the file. For example to identify it as generated.", + "nullable": true, + "enum": [ + "source", + "generated", + "test", + "library" + ] + } + } + } + } + }, + "examples": { + "default": { + "value": [ + { + "ref": "refs/heads/main", + "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", + "environment": "", + "state": "open", + "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", + "message": { + "text": "This path depends on a user-provided value." + }, + "location": { + "path": "lib/ab12-gen.js", + "start_line": 917, + "end_line": 917, + "start_column": 7, + "end_column": 18 + }, + "classifications": [ + "library" + ] + }, + { + "ref": "refs/pull/3740/merge", + "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", + "environment": "", + "state": "fixed", + "commit_sha": "b09da05606e27f463a2b49287684b4ae777092f2", + "message": { + "text": "This suffix check is missing a length comparison to correctly handle lastIndexOf returning -1." + }, + "location": { + "path": "app/script.js", + "start_line": 2, + "end_line": 2, + "start_column": 10, + "end_column": 50 + }, + "classifications": [ + "source" + ] + } + ] + } + } + } + } + }, + "403": { + "description": "Response if GitHub Advanced Security is not enabled for this repository", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "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" + } + } + } + } + } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "code-scanning", + "subcategory": null + } + } + }, + "/repos/{owner}/{repo}/code-scanning/analyses": { + "get": { + "summary": "List code scanning analyses for a repository", + "description": "Lists the details of all code scanning analyses for a repository,\nstarting with the most recent.\nThe response is paginated and you can use the `page` and `per_page` parameters\nto list the analyses you're interested in.\nBy default 30 analyses are listed per page.\n\nThe `rules_count` field in the response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand `0` is returned in this field.\n\nYou must use an access token with the `security_events` scope to use this endpoint.\nGitHub Apps must have the `security_events` read permission to use this endpoint.\n\n**Deprecation notice**:\nThe `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field.", + "operationId": "code-scanning/list-recent-analyses", + "tags": [ + "code-scanning" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/code-scanning#list-code-scanning-analyses-for-a-repository" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "tool_name", + "description": "The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "description": "The name of the tool used to generate the code scanning analysis." + } + }, + { + "name": "tool_guid", + "description": "The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both.", + "in": "query", + "required": false, + "schema": { + "nullable": true, + "type": "string", + "description": "The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data." + } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "ref", + "in": "query", + "description": "The Git reference for the analyses you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`.", + "required": false, + "schema": { + "type": "string", + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." + } + }, + { + "name": "sarif_id", + "in": "query", + "description": "Filter analyses belonging to the same SARIF upload.", + "required": false, + "schema": { + "type": "string", + "description": "An identifier for the upload.", + "example": "6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53", + "nullable": false + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "ref": { + "type": "string", + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." + }, + "commit_sha": { + "description": "The SHA of the commit to which the analysis you are uploading relates.", + "type": "string", + "minLength": 40, + "maxLength": 40, + "pattern": "^[0-9a-fA-F]+$" + }, + "analysis_key": { + "type": "string", + "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name." + }, + "environment": { + "type": "string", + "description": "Identifies the variable values associated with the environment in which this analysis was performed." + }, + "error": { + "type": "string", + "example": "error reading field xyz" + }, + "created_at": { + "type": "string", + "description": "The time that the analysis was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true, + "nullable": false + }, + "results_count": { + "type": "integer", + "description": "The total number of results in the analysis." + }, + "rules_count": { + "type": "integer", + "description": "The total number of rules used in the analysis." + }, + "id": { + "type": "integer", + "description": "Unique identifier for this analysis." + }, + "url": { + "type": "string", + "description": "The REST API URL of the analysis resource.", + "format": "uri", + "readOnly": true, + "nullable": false + }, + "sarif_id": { + "type": "string", + "description": "An identifier for the upload.", + "example": "6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53", + "nullable": false + }, + "tool": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the tool used to generate the code scanning analysis." + }, + "version": { + "nullable": true, + "type": "string", + "description": "The version of the tool used to generate the code scanning analysis." + }, + "guid": { + "nullable": true, + "type": "string", + "description": "The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data." + } + } + }, + "deletable": { + "type": "boolean" + } + }, + "required": [ + "ref", + "commit_sha", + "analysis_key", + "environment", + "error", + "created_at", + "results_count", + "rules_count", + "id", + "url", + "sarif_id", + "tool", + "deletable" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "ref": "refs/heads/main", + "commit_sha": "d99612c3e1f2970085cfbaeadf8f010ef69bad83", + "analysis_key": ".github/workflows/codeql-analysis.yml:analyze", + "environment": "{\"language\":\"python\"}", + "error": "", + "created_at": "2020-08-27T15:05:21Z", + "results_count": 17, + "rules_count": 49, + "id": 201, + "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/201", + "sarif_id": "6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53", + "tool": { + "name": "CodeQL", + "guid": null, + "version": "2.4.0" + }, + "deletable": true + }, + { + "ref": "refs/heads/my-branch", + "commit_sha": "c8cff6510d4d084fb1b4aa13b64b97ca12b07321", + "analysis_key": ".github/workflows/shiftleft.yml:build", + "environment": "{}", + "error": "", + "created_at": "2020-08-31T22:46:44Z", + "results_count": 17, + "rules_count": 32, + "id": 200, + "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/200", + "sarif_id": "8981cd8e-b078-4ac3-a3be-1dad7dbd0b582", + "tool": { + "name": "Python Security Analysis", + "guid": null, + "version": "1.2.0" + }, + "deletable": true + } + ] + } + } + } + } + }, + "403": { + "description": "Response if GitHub Advanced Security is not enabled for this repository", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "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" + } + } + } + } + } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "code-scanning" + } + } + }, + "/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}": { + "get": { + "summary": "Get a code scanning analysis for a repository", + "description": "Gets a specified code scanning analysis for a repository.\nYou must use an access token with the `security_events` scope to use this endpoint.\nGitHub Apps must have the `security_events` read permission to use this endpoint.\n\nThe default JSON response contains fields that describe the analysis.\nThis includes the Git reference and commit SHA to which the analysis relates,\nthe datetime of the analysis, the name of the code scanning tool,\nand the number of alerts.\n\nThe `rules_count` field in the default response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand `0` is returned in this field.\n\nIf you use the Accept header `application/sarif+json`,\nthe response contains the analysis data that was uploaded.\nThis is formatted as\n[SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html).\nFor an example response, see \"[Custom media type for code scanning](#custom-media-type-for-code-scanning).\"\n\n**Deprecation notice**:\nThe `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field.", + "operationId": "code-scanning/get-analysis", + "tags": [ + "code-scanning" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/code-scanning#get-a-code-scanning-analysis-for-a-repository" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "analysis_id", + "in": "path", + "description": "The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` operation.", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "ref": { + "type": "string", + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." + }, + "commit_sha": { + "description": "The SHA of the commit to which the analysis you are uploading relates.", + "type": "string", + "minLength": 40, + "maxLength": 40, + "pattern": "^[0-9a-fA-F]+$" + }, + "analysis_key": { + "type": "string", + "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name." + }, + "environment": { + "type": "string", + "description": "Identifies the variable values associated with the environment in which this analysis was performed." + }, + "error": { + "type": "string", + "example": "error reading field xyz" + }, + "created_at": { + "type": "string", + "description": "The time that the analysis was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true, + "nullable": false + }, + "results_count": { + "type": "integer", + "description": "The total number of results in the analysis." + }, + "rules_count": { + "type": "integer", + "description": "The total number of rules used in the analysis." + }, + "id": { + "type": "integer", + "description": "Unique identifier for this analysis." + }, + "url": { + "type": "string", + "description": "The REST API URL of the analysis resource.", + "format": "uri", + "readOnly": true, + "nullable": false + }, + "sarif_id": { + "type": "string", + "description": "An identifier for the upload.", + "example": "6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53", + "nullable": false + }, + "tool": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the tool used to generate the code scanning analysis." + }, + "version": { + "nullable": true, + "type": "string", + "description": "The version of the tool used to generate the code scanning analysis." + }, + "guid": { + "nullable": true, + "type": "string", + "description": "The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data." + } + } + }, + "deletable": { + "type": "boolean" + } + }, + "required": [ + "ref", + "commit_sha", + "analysis_key", + "environment", + "error", + "created_at", + "results_count", + "rules_count", + "id", + "url", + "sarif_id", + "tool", + "deletable" + ] + }, + "examples": { + "response": { + "summary": "Default response", + "value": { + "ref": "refs/heads/main", + "commit_sha": "c18c69115654ff0166991962832dc2bd7756e655", + "analysis_key": ".github/workflows/codeql-analysis.yml:analyze", + "environment": "{\"language\":\"javascript\"}", + "error": "", + "created_at": "2021-01-13T11:55:49Z", + "results_count": 3, + "rules_count": 67, + "id": 3602840, + "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/201", + "sarif_id": "47177e22-5596-11eb-80a1-c1e54ef945c6", + "tool": { + "name": "CodeQL", + "guid": null, + "version": "2.4.0" + }, + "deletable": true + } + } + } + } + } + }, + "403": { + "description": "Response if GitHub Advanced Security is not enabled for this repository", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "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" + } + } + } + } + } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "code-scanning" + } + } + }, + "/repos/{owner}/{repo}/code-scanning/sarifs": { + "post": { + "summary": "Upload an analysis as SARIF data", + "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint.\n\nThere are two places where you can upload code scanning results.\n - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see \"[Triaging code scanning alerts in pull requests](/github/finding-security-vulnerabilities-and-errors-in-your-code/triaging-code-scanning-alerts-in-pull-requests).\"\n - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see \"[Managing code scanning alerts for your repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository).\"\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64\n```\n\nSARIF upload supports a maximum of 1000 results per analysis run. Any results over this limit are ignored. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.\n\nThe `202 Accepted`, response includes an `id` value.\nYou can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload).\"", + "operationId": "code-scanning/upload-sarif", + "tags": [ + "code-scanning" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/code-scanning#upload-an-analysis-as-sarif-data" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "commit_sha": { + "description": "The SHA of the commit to which the analysis you are uploading relates.", + "type": "string", + "minLength": 40, + "maxLength": 40, + "pattern": "^[0-9a-fA-F]+$" + }, + "ref": { + "type": "string", + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." + }, + "sarif": { + "description": "A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using [`gzip`](http://www.gnu.org/software/gzip/manual/gzip.html) and then translate the contents of the file into a Base64 encoding string. For more information, see \"[SARIF support for code scanning](https://docs.github.com/github-ae@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/sarif-support-for-code-scanning).\"", + "type": "string" + }, + "checkout_uri": { + "description": "The base directory used in the analysis, as it appears in the SARIF file.\nThis property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository.", + "example": "file:///github/workspace/", + "type": "string", + "format": "uri" + }, + "started_at": { + "description": "The time that the analysis run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date", + "type": "string" + }, + "tool_name": { + "description": "The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to \"API\". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the `tool_guid` parameter of operations such as `GET /repos/{owner}/{repo}/code-scanning/alerts`.", + "type": "string" + } + }, + "required": [ + "commit_sha", + "ref", + "sarif" + ] + } + } + } + }, + "responses": { + "202": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "An identifier for the upload.", + "example": "6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53", + "nullable": false + }, + "url": { + "type": "string", + "description": "The REST API URL for checking the status of the upload.", + "format": "uri", + "readOnly": true, + "nullable": false + } + } + }, + "examples": { + "default": { + "summary": "Default response", + "value": { + "id": "47177e22-5596-11eb-80a1-c1e54ef945c6", + "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/sarifs/47177e22-5596-11eb-80a1-c1e54ef945c6" + } + } + } + } + } + }, + "400": { + "description": "Response if the sarif field is invalid" + }, + "403": { + "description": "Response if the repository is archived or if github advanced security is not enabled for this repository", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "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" + } + } + } + } + } + }, + "413": { + "description": "Response if the sarif field is too large" + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "code-scanning" + } + } + }, + "/repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}": { + "get": { + "summary": "Get information about a SARIF upload", + "description": "Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see \"[Get a code scanning analysis for a repository](/rest/reference/code-scanning#get-a-code-scanning-analysis-for-a-repository).\" You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` read permission to use this endpoint.", + "operationId": "code-scanning/get-sarif", + "tags": [ + "code-scanning" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/code-scanning#get-information-about-a-sarif-upload" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "sarif_id", + "description": "The SARIF ID obtained after uploading.", + "in": "path", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "processing_status": { + "type": "string", + "enum": [ + "pending", + "complete" + ], + "description": "`pending` files have not yet been processed, while `complete` means all results in the SARIF have been stored." + }, + "analyses_url": { + "type": "string", + "description": "The REST API URL for getting the analyses associated with the upload.", + "format": "uri", + "readOnly": true, + "nullable": true + } + } + }, + "examples": { + "default": { + "summary": "Default response", + "value": { + "processing_status": "complete", + "analyses_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses?sarif_id=47177e22-5596-11eb-80a1-c1e54ef945c6" + } + } + } + } + } + }, + "403": { + "description": "Response if GitHub Advanced Security is not enabled for this repository", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Response if the sarif id does not match any upload" + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "code-scanning" + } + } + }, "/repos/{owner}/{repo}/collaborators": { "get": { "summary": "List repository collaborators", @@ -98263,7 +122772,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -98438,7 +122947,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -100497,7 +125006,7 @@ "description": "Response when person is already a collaborator" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -100636,7 +125145,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -100855,7 +125364,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -100936,7 +125445,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -101294,7 +125803,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -101583,7 +126092,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -101678,7 +126187,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -101967,7 +126476,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -102037,10 +126546,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -102149,7 +126658,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -102358,7 +126867,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -102378,7 +126887,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -102877,7 +127386,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -102899,7 +127408,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -103032,7 +127541,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -103141,11 +127650,31 @@ "type": "integer", "default": 1 } + }, + { + "name": "top", + "description": "legacy parameter for pagination.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "last_sha", + "description": "legacy parameter for pagination.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -103798,7 +128327,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -103891,7 +128420,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -103948,7 +128477,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -103970,7 +128499,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -104114,7 +128643,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -104507,7 +129036,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -104824,7 +129353,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -104965,7 +129494,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -108940,7 +133469,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -109006,9 +133535,27 @@ "type": "string" } }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -109019,7 +133566,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -109602,7 +134149,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -109671,7 +134218,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -109753,7 +134300,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -109815,11 +134362,19 @@ "type": "integer", "default": 1 } + }, + { + "name": "app_id", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -110802,7 +135357,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -110850,7 +135405,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -113100,18 +137655,36 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true + }, + { + "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", + "description": "Response", "content": { "application/json": { "schema": { @@ -114806,7 +139379,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -114868,7 +139441,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -114897,7 +139470,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -115116,7 +139689,7 @@ } }, "301": { - "description": "Moved Permanently" + "description": "Moved permanently" } }, "x-github": { @@ -115178,7 +139751,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -117041,7 +141614,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -117103,7 +141676,7 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { @@ -117123,7 +141696,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/vnd.github.v3.object": { "schema": { @@ -117735,7 +142308,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -117818,7 +142391,7 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { @@ -117929,7 +142502,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -118145,7 +142718,7 @@ } }, "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -118361,7 +142934,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -118381,7 +142954,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -118510,7 +143083,7 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { @@ -118584,7 +143157,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -118785,7 +143358,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -118854,7 +143427,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -118894,7 +143467,7 @@ } }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -119136,7 +143709,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -119233,7 +143806,8 @@ "required": false, "schema": { "type": "string", - "default": "none" + "default": "none", + "nullable": true } }, { @@ -119257,7 +143831,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -119924,7 +144498,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -120433,48 +145007,6 @@ "transient_environment": false, "production_environment": true } - }, - "advanced-example": { - "summary": "Advanced example", - "value": { - "url": "https://api.github.com/repos/octocat/example/deployments/1", - "id": 1, - "node_id": "MDEwOkRlcGxveW1lbnQx", - "sha": "a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d", - "ref": "topic-branch", - "task": "deploy", - "payload": { - }, - "original_environment": "staging", - "environment": "production", - "description": "Deploy request from hubot", - "creator": { - "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 - }, - "created_at": "2012-07-20T01:19:13Z", - "updated_at": "2012-07-20T01:19:13Z", - "statuses_url": "https://api.github.com/repos/octocat/example/deployments/1/statuses", - "repository_url": "https://api.github.com/repos/octocat/example", - "transient_environment": false, - "production_environment": true - } } } } @@ -120503,40 +145035,10 @@ } }, "409": { - "description": "response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string", - "example": "\"https://docs.github.com/github-ae@latest/rest/reference/repos#create-a-deployment\"" - } - } - }, - "examples": { - "merge-conflict-response": { - "summary": "Merge conflict response", - "value": { - "message": "Conflict merging master into topic-branch" - } - }, - "failed-commit-status-checks": { - "summary": "Failed commit status checks", - "value": { - "message": "Conflict: Commit status checks failed for topic-branch." - } - } - } - } - } + "description": "Response when there is a merge conflict or the commit's status checks failed" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -120661,7 +145163,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -121175,7 +145677,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -121249,10 +145751,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -121272,7 +145774,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -121372,7 +145874,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -121896,7 +146398,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -122041,7 +146543,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -122560,7 +147062,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -122698,7 +147200,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -123209,7 +147711,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -123229,7 +147731,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -123271,6 +147773,1632 @@ } } }, + "/repos/{owner}/{repo}/environments": { + "get": { + "summary": "Get all environments", + "description": "Get all environments for a repository.\n\nAnyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "tags": [ + "repos" + ], + "operationId": "repos/get-all-environments", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/repos#get-all-environments" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "total_count": { + "description": "The number of environments in this repository", + "example": 5, + "type": "integer" + }, + "environments": { + "type": "array", + "items": { + "title": "Environment", + "description": "Details of a deployment environment", + "type": "object", + "properties": { + "id": { + "description": "The id of the environment.", + "example": 56780428, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDExOkVudmlyb25tZW50NTY3ODA0Mjg=" + }, + "name": { + "description": "The name of the environment.", + "example": "staging", + "type": "string" + }, + "url": { + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/environments/staging" + }, + "html_url": { + "type": "string", + "example": "https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging" + }, + "created_at": { + "description": "The time that the environment was created, in ISO 8601 format.", + "example": "2020-11-23T22:00:40Z", + "format": "date-time", + "type": "string" + }, + "updated_at": { + "description": "The time that the environment was last updated, in ISO 8601 format.", + "example": "2020-11-23T22:00:40Z", + "format": "date-time", + "type": "string" + }, + "protection_rules": { + "type": "array", + "items": { + "anyOf": [ + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 3515 + }, + "node_id": { + "type": "string", + "example": "MDQ6R2F0ZTM1MTU=" + }, + "type": { + "type": "string", + "example": "wait_timer" + }, + "wait_timer": { + "type": "integer", + "example": 30, + "description": "The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days)." + } + }, + "required": [ + "id", + "node_id", + "type" + ] + }, + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 3755 + }, + "node_id": { + "type": "string", + "example": "MDQ6R2F0ZTM3NTU=" + }, + "type": { + "type": "string", + "example": "required_reviewers" + }, + "reviewers": { + "type": "array", + "description": "The people or teams that may approve jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of reviewer. Must be one of: `User` or `Team`", + "enum": [ + "User", + "Team" + ], + "example": "User" + }, + "reviewer": { + "anyOf": [ + { + "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 + }, + { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VGVhbTE=" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/organizations/1/team/1/members{/member}" + }, + "name": { + "description": "Name of the team", + "type": "string", + "example": "Justice League" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true, + "example": "A great team." + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "example": "admin" + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "example": "closed" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1/repos" + }, + "slug": { + "type": "string", + "example": "justice-league" + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "example": "uid=example,ou=users,dc=github,dc=com", + "type": "string" + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ], + "nullable": true + } + ] + } + } + } + } + }, + "required": [ + "id", + "node_id", + "type" + ] + }, + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 3515 + }, + "node_id": { + "type": "string", + "example": "MDQ6R2F0ZTM1MTU=" + }, + "type": { + "type": "string", + "example": "branch_policy" + } + }, + "required": [ + "id", + "node_id", + "type" + ] + } + ] + } + }, + "deployment_branch_policy": { + "type": "object", + "description": "The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`.", + "properties": { + "protected_branches": { + "type": "boolean", + "description": "Whether only branches with branch protection rules can deploy to this environment. If `protected_branches` is `true`, `custom_branch_policies` must be `false`; if `protected_branches` is `false`, `custom_branch_policies` must be `true`." + }, + "custom_branch_policies": { + "type": "boolean", + "description": "Whether only branches that match the specified name patterns can deploy to this environment. If `custom_branch_policies` is `true`, `protected_branches` must be `false`; if `custom_branch_policies` is `false`, `protected_branches` must be `true`." + } + }, + "nullable": true, + "required": [ + "protected_branches", + "custom_branch_policies" + ] + } + }, + "required": [ + "id", + "node_id", + "name", + "url", + "html_url", + "created_at", + "updated_at" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 1, + "environments": [ + { + "id": 161088068, + "node_id": "MDExOkVudmlyb25tZW50MTYxMDg4MDY4", + "name": "staging", + "url": "https://api.github.com/repos/github/hello-world/environments/staging", + "html_url": "https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging", + "created_at": "2020-11-23T22:00:40Z", + "updated_at": "2020-11-23T22:00:40Z", + "protection_rules": [ + { + "id": 3736, + "node_id": "MDQ6R2F0ZTM3MzY=", + "type": "wait_timer", + "wait_timer": 30 + }, + { + "id": 3755, + "node_id": "MDQ6R2F0ZTM3NTU=", + "type": "required_reviewers", + "reviewers": [ + { + "type": "User", + "reviewer": { + "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 + } + }, + { + "type": "Team", + "reviewer": { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos" + } + } + ] + }, + { + "id": 3756, + "node_id": "MDQ6R2F0ZTM3NTY=", + "type": "branch_policy" + } + ], + "deployment_branch_policy": { + "protected_branches": false, + "custom_branch_policies": true + } + } + ] + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "repos", + "subcategory": "environments" + } + } + }, + "/repos/{owner}/{repo}/environments/{environment_name}": { + "get": { + "summary": "Get an environment", + "description": "Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "tags": [ + "repos" + ], + "operationId": "repos/get-environment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/repos#get-an-environment" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "environment_name", + "in": "path", + "required": true, + "description": "The name of the environment", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "Environment", + "description": "Details of a deployment environment", + "type": "object", + "properties": { + "id": { + "description": "The id of the environment.", + "example": 56780428, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDExOkVudmlyb25tZW50NTY3ODA0Mjg=" + }, + "name": { + "description": "The name of the environment.", + "example": "staging", + "type": "string" + }, + "url": { + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/environments/staging" + }, + "html_url": { + "type": "string", + "example": "https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging" + }, + "created_at": { + "description": "The time that the environment was created, in ISO 8601 format.", + "example": "2020-11-23T22:00:40Z", + "format": "date-time", + "type": "string" + }, + "updated_at": { + "description": "The time that the environment was last updated, in ISO 8601 format.", + "example": "2020-11-23T22:00:40Z", + "format": "date-time", + "type": "string" + }, + "protection_rules": { + "type": "array", + "items": { + "anyOf": [ + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 3515 + }, + "node_id": { + "type": "string", + "example": "MDQ6R2F0ZTM1MTU=" + }, + "type": { + "type": "string", + "example": "wait_timer" + }, + "wait_timer": { + "type": "integer", + "example": 30, + "description": "The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days)." + } + }, + "required": [ + "id", + "node_id", + "type" + ] + }, + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 3755 + }, + "node_id": { + "type": "string", + "example": "MDQ6R2F0ZTM3NTU=" + }, + "type": { + "type": "string", + "example": "required_reviewers" + }, + "reviewers": { + "type": "array", + "description": "The people or teams that may approve jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of reviewer. Must be one of: `User` or `Team`", + "enum": [ + "User", + "Team" + ], + "example": "User" + }, + "reviewer": { + "anyOf": [ + { + "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 + }, + { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VGVhbTE=" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/organizations/1/team/1/members{/member}" + }, + "name": { + "description": "Name of the team", + "type": "string", + "example": "Justice League" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true, + "example": "A great team." + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "example": "admin" + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "example": "closed" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1/repos" + }, + "slug": { + "type": "string", + "example": "justice-league" + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "example": "uid=example,ou=users,dc=github,dc=com", + "type": "string" + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ], + "nullable": true + } + ] + } + } + } + } + }, + "required": [ + "id", + "node_id", + "type" + ] + }, + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 3515 + }, + "node_id": { + "type": "string", + "example": "MDQ6R2F0ZTM1MTU=" + }, + "type": { + "type": "string", + "example": "branch_policy" + } + }, + "required": [ + "id", + "node_id", + "type" + ] + } + ] + } + }, + "deployment_branch_policy": { + "type": "object", + "description": "The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`.", + "properties": { + "protected_branches": { + "type": "boolean", + "description": "Whether only branches with branch protection rules can deploy to this environment. If `protected_branches` is `true`, `custom_branch_policies` must be `false`; if `protected_branches` is `false`, `custom_branch_policies` must be `true`." + }, + "custom_branch_policies": { + "type": "boolean", + "description": "Whether only branches that match the specified name patterns can deploy to this environment. If `custom_branch_policies` is `true`, `protected_branches` must be `false`; if `custom_branch_policies` is `false`, `protected_branches` must be `true`." + } + }, + "nullable": true, + "required": [ + "protected_branches", + "custom_branch_policies" + ] + } + }, + "required": [ + "id", + "node_id", + "name", + "url", + "html_url", + "created_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "id": 161088068, + "node_id": "MDExOkVudmlyb25tZW50MTYxMDg4MDY4", + "name": "staging", + "url": "https://api.github.com/repos/github/hello-world/environments/staging", + "html_url": "https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging", + "created_at": "2020-11-23T22:00:40Z", + "updated_at": "2020-11-23T22:00:40Z", + "protection_rules": [ + { + "id": 3736, + "node_id": "MDQ6R2F0ZTM3MzY=", + "type": "wait_timer", + "wait_timer": 30 + }, + { + "id": 3755, + "node_id": "MDQ6R2F0ZTM3NTU=", + "type": "required_reviewers", + "reviewers": [ + { + "type": "User", + "reviewer": { + "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 + } + }, + { + "type": "Team", + "reviewer": { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos" + } + } + ] + }, + { + "id": 3756, + "node_id": "MDQ6R2F0ZTM3NTY=", + "type": "branch_policy" + } + ], + "deployment_branch_policy": { + "protected_branches": false, + "custom_branch_policies": true + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "repos", + "subcategory": "environments" + } + }, + "put": { + "summary": "Create or update an environment", + "description": "Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see \"[Environments](/actions/reference/environments#environment-protection-rules).\"\n\n**Note:** Although you can use this operation to specify that only branches that match specified name patterns can deploy to this environment, you must use the UI to set the name patterns. For more information, see \"[Environments](/actions/reference/environments#deployment-branches).\"\n\n**Note:** To create or update secrets for an environment, see \"[Secrets](/rest/reference/actions#secrets).\"\n\nYou must authenticate using an access token with the repo scope to use this endpoint.", + "tags": [ + "repos" + ], + "operationId": "repos/create-or-update-environment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/repos#create-or-update-an-environment" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "environment_name", + "in": "path", + "required": true, + "description": "The name of the environment", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "nullable": true, + "properties": { + "wait_timer": { + "type": "integer", + "example": 30, + "description": "The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days)." + }, + "reviewers": { + "type": "array", + "nullable": true, + "description": "The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of reviewer. Must be one of: `User` or `Team`", + "enum": [ + "User", + "Team" + ], + "example": "User" + }, + "id": { + "type": "integer", + "description": "The id of the user or team who can review the deployment", + "example": 4532992 + } + } + } + }, + "deployment_branch_policy": { + "type": "object", + "description": "The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`.", + "properties": { + "protected_branches": { + "type": "boolean", + "description": "Whether only branches with branch protection rules can deploy to this environment. If `protected_branches` is `true`, `custom_branch_policies` must be `false`; if `protected_branches` is `false`, `custom_branch_policies` must be `true`." + }, + "custom_branch_policies": { + "type": "boolean", + "description": "Whether only branches that match the specified name patterns can deploy to this environment. If `custom_branch_policies` is `true`, `protected_branches` must be `false`; if `custom_branch_policies` is `false`, `protected_branches` must be `true`." + } + }, + "nullable": true, + "required": [ + "protected_branches", + "custom_branch_policies" + ] + } + }, + "additionalProperties": false + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "Environment", + "description": "Details of a deployment environment", + "type": "object", + "properties": { + "id": { + "description": "The id of the environment.", + "example": 56780428, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDExOkVudmlyb25tZW50NTY3ODA0Mjg=" + }, + "name": { + "description": "The name of the environment.", + "example": "staging", + "type": "string" + }, + "url": { + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/environments/staging" + }, + "html_url": { + "type": "string", + "example": "https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging" + }, + "created_at": { + "description": "The time that the environment was created, in ISO 8601 format.", + "example": "2020-11-23T22:00:40Z", + "format": "date-time", + "type": "string" + }, + "updated_at": { + "description": "The time that the environment was last updated, in ISO 8601 format.", + "example": "2020-11-23T22:00:40Z", + "format": "date-time", + "type": "string" + }, + "protection_rules": { + "type": "array", + "items": { + "anyOf": [ + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 3515 + }, + "node_id": { + "type": "string", + "example": "MDQ6R2F0ZTM1MTU=" + }, + "type": { + "type": "string", + "example": "wait_timer" + }, + "wait_timer": { + "type": "integer", + "example": 30, + "description": "The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days)." + } + }, + "required": [ + "id", + "node_id", + "type" + ] + }, + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 3755 + }, + "node_id": { + "type": "string", + "example": "MDQ6R2F0ZTM3NTU=" + }, + "type": { + "type": "string", + "example": "required_reviewers" + }, + "reviewers": { + "type": "array", + "description": "The people or teams that may approve jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of reviewer. Must be one of: `User` or `Team`", + "enum": [ + "User", + "Team" + ], + "example": "User" + }, + "reviewer": { + "anyOf": [ + { + "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 + }, + { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VGVhbTE=" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/organizations/1/team/1/members{/member}" + }, + "name": { + "description": "Name of the team", + "type": "string", + "example": "Justice League" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true, + "example": "A great team." + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "example": "admin" + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "example": "closed" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1/repos" + }, + "slug": { + "type": "string", + "example": "justice-league" + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "example": "uid=example,ou=users,dc=github,dc=com", + "type": "string" + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ], + "nullable": true + } + ] + } + } + } + } + }, + "required": [ + "id", + "node_id", + "type" + ] + }, + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 3515 + }, + "node_id": { + "type": "string", + "example": "MDQ6R2F0ZTM1MTU=" + }, + "type": { + "type": "string", + "example": "branch_policy" + } + }, + "required": [ + "id", + "node_id", + "type" + ] + } + ] + } + }, + "deployment_branch_policy": { + "type": "object", + "description": "The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`.", + "properties": { + "protected_branches": { + "type": "boolean", + "description": "Whether only branches with branch protection rules can deploy to this environment. If `protected_branches` is `true`, `custom_branch_policies` must be `false`; if `protected_branches` is `false`, `custom_branch_policies` must be `true`." + }, + "custom_branch_policies": { + "type": "boolean", + "description": "Whether only branches that match the specified name patterns can deploy to this environment. If `custom_branch_policies` is `true`, `protected_branches` must be `false`; if `custom_branch_policies` is `false`, `protected_branches` must be `true`." + } + }, + "nullable": true, + "required": [ + "protected_branches", + "custom_branch_policies" + ] + } + }, + "required": [ + "id", + "node_id", + "name", + "url", + "html_url", + "created_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "id": 161088068, + "node_id": "MDExOkVudmlyb25tZW50MTYxMDg4MDY4", + "name": "staging", + "url": "https://api.github.com/repos/github/hello-world/environments/staging", + "html_url": "https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging", + "created_at": "2020-11-23T22:00:40Z", + "updated_at": "2020-11-23T22:00:40Z", + "protection_rules": [ + { + "id": 3736, + "node_id": "MDQ6R2F0ZTM3MzY=", + "type": "wait_timer", + "wait_timer": 30 + }, + { + "id": 3755, + "node_id": "MDQ6R2F0ZTM3NTU=", + "type": "required_reviewers", + "reviewers": [ + { + "type": "User", + "reviewer": { + "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 + } + }, + { + "type": "Team", + "reviewer": { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos" + } + } + ] + }, + { + "id": 3756, + "node_id": "MDQ6R2F0ZTM3NTY=", + "type": "branch_policy" + } + ], + "deployment_branch_policy": { + "protected_branches": false, + "custom_branch_policies": true + } + } + } + } + } + } + }, + "422": { + "description": "Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` are set to the same value", + "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": "repos", + "subcategory": "environments" + } + }, + "delete": { + "summary": "Delete an environment", + "description": "You must authenticate using an access token with the repo scope to use this endpoint.", + "tags": [ + "repos" + ], + "operationId": "repos/delete-an-environment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/repos#delete-an-environment" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "environment_name", + "in": "path", + "required": true, + "description": "The name of the environment", + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "repos", + "subcategory": "environments" + } + } + }, "/repos/{owner}/{repo}/events": { "get": { "summary": "List repository events", @@ -123321,7 +149449,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -126039,7 +152167,8 @@ "enum": [ "newest", "oldest", - "stargazers" + "stargazers", + "watchers" ], "default": "newest" } @@ -126061,11 +152190,31 @@ "type": "integer", "default": 1 } + }, + { + "name": "org", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "organization", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -127781,6 +153930,26 @@ "schema": { "type": "string" } + }, + { + "name": "org", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "organization", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } } ], "requestBody": { @@ -127788,6 +153957,7 @@ "application/json": { "schema": { "type": "object", + "nullable": true, "properties": { "organization": { "type": "string", @@ -127800,7 +153970,7 @@ }, "responses": { "202": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -128949,7 +155119,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -129038,7 +155208,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -129128,7 +155298,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -129168,7 +155338,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -129228,7 +155398,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -129348,7 +155518,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -129405,7 +155575,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -129425,7 +155595,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -129640,7 +155810,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -129856,7 +156026,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -129925,7 +156095,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -129998,7 +156168,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -130206,7 +156376,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -130268,7 +156438,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -130297,7 +156467,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -130430,7 +156600,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -130441,7 +156611,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -130509,7 +156679,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -130603,7 +156773,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -130679,7 +156849,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -130790,7 +156960,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -130828,7 +156998,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -130896,7 +157066,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -131005,7 +157175,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -131016,10 +157186,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -131198,7 +157368,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -131345,7 +157515,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -131465,7 +157635,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -131604,7 +157774,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -131738,7 +157908,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -131866,7 +158036,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -131935,7 +158105,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -132021,7 +158191,8 @@ "required": true, "schema": { "type": "string" - } + }, + "x-multi-segment": true }, { "name": "recursive", @@ -132035,7 +158206,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -132189,7 +158360,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -132258,7 +158429,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -132339,7 +158510,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -132536,7 +158707,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -132681,7 +158852,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -132873,7 +159044,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -132893,7 +159064,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -133033,7 +159204,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -133217,7 +159388,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -133370,7 +159541,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -133554,7 +159725,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -133623,7 +159794,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -133692,10 +159863,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -133766,7 +159937,7 @@ ], "responses": { "200": { - "description": "Default response", + "description": "Response", "content": { "application/json": { "schema": { @@ -133898,7 +160069,7 @@ }, "responses": { "200": { - "description": "Default response", + "description": "Response", "content": { "application/json": { "schema": { @@ -133994,10 +160165,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -134068,10 +160239,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -134134,7 +160305,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -134641,10 +160812,10 @@ } }, "301": { - "description": "Moved Permanently" + "description": "Moved permanently" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -134725,7 +160896,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -136715,7 +162886,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -138669,7 +164840,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -138831,7 +165002,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -141001,10 +167172,10 @@ } }, "301": { - "description": "Moved Permanently" + "description": "Moved permanently" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -141073,7 +167244,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -141232,7 +167403,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -143588,7 +169759,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -143657,7 +169828,7 @@ } }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -143678,7 +169849,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -143816,7 +169987,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -144361,7 +170532,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -144430,7 +170601,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -144506,7 +170677,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -145038,7 +171209,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -145133,7 +171304,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -145665,7 +171836,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -145784,7 +171955,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -145876,7 +172047,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -146085,7 +172256,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -146105,7 +172276,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -146604,7 +172775,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -146626,7 +172797,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -146759,7 +172930,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -146827,7 +172998,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -149929,7 +176100,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -150053,7 +176224,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -153142,7 +179313,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -153258,7 +179429,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -155586,10 +181757,10 @@ } }, "301": { - "description": "Moved Permanently" + "description": "Moved permanently" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -155629,7 +181800,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -155788,7 +181959,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -158116,7 +184287,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -158185,7 +184356,7 @@ } }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -158226,10 +184397,10 @@ } }, "301": { - "description": "Moved Permanently" + "description": "Moved permanently" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -158345,7 +184516,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -160616,7 +186787,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -162892,7 +189063,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -163437,7 +189608,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -163552,7 +189723,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -164132,7 +190303,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -164201,7 +190372,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -164292,7 +190463,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -164645,7 +190816,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -164833,7 +191004,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -164936,7 +191107,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -165079,7 +191250,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -165182,7 +191353,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -165301,7 +191472,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "410": { "description": "Gone", @@ -165384,7 +191555,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -165458,7 +191629,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -165572,7 +191743,7 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -165615,7 +191786,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -165635,7 +191806,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -165754,7 +191925,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -165777,7 +191948,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -165886,7 +192057,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -166095,7 +192266,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -166135,7 +192306,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -166242,7 +192413,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -166438,7 +192609,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -166460,7 +192631,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -166593,7 +192764,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -166670,7 +192841,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -166929,7 +193100,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -166969,7 +193140,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -167061,7 +193232,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -167203,7 +193374,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -167268,7 +193439,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -167389,7 +193560,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -167446,7 +193617,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -167516,7 +193687,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -167580,7 +193751,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -167671,7 +193842,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -167763,7 +193934,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -167840,7 +194011,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -167909,7 +194080,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -167980,7 +194151,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -168049,7 +194220,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -168146,7 +194317,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -168264,7 +194435,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -168310,7 +194481,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -168376,7 +194547,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -169202,63 +195373,10 @@ } }, "404": { - "description": "response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string", - "example": "\"https://docs.github.com/github-ae@latest/rest/reference/repos#perform-a-merge\"" - } - } - }, - "examples": { - "missing-base-response": { - "summary": "Missing base response", - "value": { - "message": "Base does not exist" - } - }, - "missing-head-response": { - "summary": "Missing head response", - "value": { - "message": "Head does not exist" - } - } - } - } - } + "description": "Response when the base or head does not exist" }, "409": { - "description": "Merge conflict response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string", - "example": "\"https://docs.github.com/github-ae@latest/rest/reference/repos#perform-a-merge\"" - } - } - }, - "examples": { - "merge-conflict-response": { - "value": { - "message": "Merge Conflict" - } - } - } - } - } + "description": "Response when there is a merge conflict" }, "403": { "description": "Forbidden", @@ -169281,7 +195399,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -169454,7 +195572,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -169735,7 +195853,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -169837,7 +195955,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -170113,7 +196231,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -170133,7 +196251,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -170254,7 +196372,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -170522,7 +196640,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -170630,7 +196748,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -170948,10 +197066,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -171041,7 +197159,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -171231,7 +197349,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -172946,7 +199064,7 @@ }, "responses": { "202": { - "description": "response" + "description": "Response" } }, "x-github": { @@ -172992,7 +199110,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -173085,7 +199203,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -173189,7 +199307,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -173282,7 +199400,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -173351,7 +199469,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -173503,10 +199621,10 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -173670,10 +199788,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -173742,7 +199860,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -173764,7 +199882,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -173849,7 +199967,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -174112,7 +200230,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -174190,7 +200308,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -174450,7 +200568,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -174735,7 +200853,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -175004,7 +201122,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -175044,7 +201162,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -175084,7 +201202,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -175185,7 +201303,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -175441,7 +201559,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -175481,7 +201599,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -175521,7 +201639,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -175678,7 +201796,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -179653,10 +205771,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -179815,7 +205933,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -182991,7 +209109,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -183103,16 +209221,15 @@ }, { "name": "sort", - "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to).", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "created", - "updated" - ], - "default": "created" + "updated", + "created_at" + ] } }, { @@ -183158,7 +209275,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -183684,7 +209801,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -184136,7 +210253,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -184236,7 +210353,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -184742,10 +210859,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -184854,7 +210971,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -185063,7 +211180,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -185083,7 +211200,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -185582,7 +211699,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -185604,7 +211721,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -185737,7 +211854,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -188943,7 +215060,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "500": { "description": "Internal Error", @@ -188966,7 +215083,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -189076,7 +215193,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -192224,7 +218341,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -192418,7 +218535,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -193024,7 +219141,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -193484,7 +219601,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -193659,7 +219776,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -194119,7 +220236,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -194209,7 +220326,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -194857,7 +220974,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -194958,7 +221075,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -195273,7 +221390,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -195362,7 +221479,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -195452,7 +221569,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -195814,7 +221931,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -199927,10 +226044,10 @@ }, "responses": { "200": { - "description": "response" + "description": "Response" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -200487,7 +226604,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -200763,7 +226880,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -200874,7 +226991,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -201150,7 +227267,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -201249,7 +227366,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -201525,7 +227642,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -201613,7 +227730,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -201889,7 +228006,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -201919,7 +228036,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -202017,7 +228134,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -202418,7 +228535,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -202520,7 +228637,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -202796,7 +228913,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -202816,7 +228933,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -202933,7 +229050,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -203209,7 +229326,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -203229,7 +229346,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -203349,7 +229466,7 @@ }, "responses": { "202": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -203371,7 +229488,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -203460,7 +229577,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -203536,6 +229653,279 @@ } } ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Content File", + "description": "Content File", + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "encoding": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "path": { + "type": "string" + }, + "content": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "git_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "download_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "_links": { + "type": "object", + "properties": { + "git": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html": { + "type": "string", + "format": "uri", + "nullable": true + }, + "self": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "git", + "html", + "self" + ] + }, + "target": { + "type": "string", + "example": "\"actual/actual.md\"" + }, + "submodule_git_url": { + "type": "string", + "example": "\"git://example.com/defunkt/dotjs.git\"" + } + }, + "required": [ + "_links", + "git_url", + "html_url", + "download_url", + "name", + "path", + "sha", + "size", + "type", + "url", + "content", + "encoding" + ] + }, + "examples": { + "default": { + "value": { + "type": "file", + "encoding": "base64", + "size": 5362, + "name": "README.md", + "path": "README.md", + "content": "encoded content ...", + "sha": "3d21ec53a331a6f037a91c368710b99387d012c1", + "url": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md", + "git_url": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1", + "html_url": "https://github.com/octokit/octokit.rb/blob/master/README.md", + "download_url": "https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md", + "_links": { + "git": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1", + "self": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md", + "html": "https://github.com/octokit/octokit.rb/blob/master/README.md" + } + } + } + } + } + } + }, + "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" + } + } + } + } + } + }, + "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" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "repos", + "subcategory": "contents" + } + } + }, + "/repos/{owner}/{repo}/readme/{dir}": { + "get": { + "summary": "Get a repository README", + "description": "Gets the preferred README for a repository.\n\nREADMEs support [custom media types](https://docs.github.com/github-ae@latest/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML.", + "tags": [ + "repos" + ], + "operationId": "repos/get-readme-from-alt-path", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/repos#get-a-repository-readme" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "dir", + "description": "The alternate path to look for a README file", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + }, + { + "name": "ref", + "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], "responses": { "200": { "description": "response", @@ -203660,7 +230050,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -203680,7 +230070,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -203810,7 +230200,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -204310,7 +230700,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -204419,7 +230809,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -204914,7 +231304,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -205268,7 +231658,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -205288,7 +231678,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -205390,7 +231780,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -205672,7 +232062,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -205718,7 +232108,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -206247,7 +232637,7 @@ }, { "name": "tag", - "description": "tag+ parameter", + "description": "tag parameter", "in": "path", "required": true, "schema": { @@ -206258,7 +232648,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -206745,7 +233135,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -207304,7 +233694,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -207417,7 +233807,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -207954,7 +234344,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -208027,7 +234417,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -208650,7 +235040,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -208974,7 +235364,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -209158,7 +235548,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -209659,7 +236049,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -209856,7 +236246,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -210131,7 +236521,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -210475,7 +236865,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -210578,7 +236968,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -210642,7 +237032,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -210774,7 +237164,7 @@ ], "responses": { "302": { - "description": "response", + "description": "Response", "headers": { "Location": { "example": "https://codeload.github.com/me/myprivate/legacy.zip/master?login=me&token=thistokenexpires", @@ -210846,7 +237236,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -211064,11 +237454,29 @@ "schema": { "type": "string" } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -211103,7 +237511,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -211125,7 +237533,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -211219,7 +237627,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -211254,7 +237662,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -211276,7 +237684,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -211296,7 +237704,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -211405,7 +237813,7 @@ }, "responses": { "202": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -212543,7 +238951,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -212591,7 +238999,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -212649,7 +239057,7 @@ ], "responses": { "302": { - "description": "response", + "description": "Response", "headers": { "Location": { "example": "https://codeload.github.com/me/myprivate/legacy.zip/master?login=me&token=thistokenexpires", @@ -212674,7 +239082,7 @@ "/repos/{template_owner}/{template_repo}/generate": { "post": { "summary": "Create a repository using a template", - "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/github-ae@latest/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", + "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/github-ae@latest/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository", "tags": [ "repos" ], @@ -212746,7 +239154,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -213860,7 +240268,7 @@ "/repositories": { "get": { "summary": "List public repositories", - "description": "Lists all public repositories in the order that they were created.\n\nNote: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.", + "description": "Lists all public repositories in the order that they were created.\n\nNotes:\n- For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise.\n- Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.", "tags": [ "repos" ], @@ -213882,7 +240290,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -215462,7 +241870,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -215531,7 +241939,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -215545,6 +241953,1483 @@ } } }, + "/repositories/{repository_id}/environments/{environment_name}/secrets": { + "get": { + "summary": "List environment secrets", + "description": "Lists all secrets available in an environment without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/list-environment-secrets", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#list-environment-secrets" + }, + "parameters": [ + { + "name": "repository_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "environment_name", + "in": "path", + "required": true, + "description": "The name of the environment", + "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": "object", + "required": [ + "total_count", + "secrets" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "secrets": { + "type": "array", + "items": { + "title": "Actions Secret", + "description": "Set secrets for GitHub Actions.", + "type": "object", + "properties": { + "name": { + "description": "The name of the secret.", + "example": "SECRET_TOKEN", + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "name", + "created_at", + "updated_at" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 2, + "secrets": [ + { + "name": "GH_TOKEN", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z" + }, + { + "name": "GIST_ID", + "created_at": "2020-01-10T10:59:22Z", + "updated_at": "2020-01-11T11:59:22Z" + } + ] + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "secrets" + } + } + }, + "/repositories/{repository_id}/environments/{environment_name}/secrets/public-key": { + "get": { + "summary": "Get an environment public key", + "description": "Get the public key for an environment, which you need to encrypt environment secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `secrets` repository permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-environment-public-key", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#get-an-environment-public-key" + }, + "parameters": [ + { + "name": "repository_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "environment_name", + "in": "path", + "required": true, + "description": "The name of the environment", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "ActionsPublicKey", + "description": "The public key used for setting Actions Secrets.", + "type": "object", + "properties": { + "key_id": { + "description": "The identifier for the key.", + "type": "string", + "example": "1234567" + }, + "key": { + "description": "The Base64 encoded public key.", + "type": "string", + "example": "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=" + }, + "id": { + "type": "integer", + "example": 2 + }, + "url": { + "type": "string", + "example": "https://api.github.com/user/keys/2" + }, + "title": { + "type": "string", + "example": "ssh-rsa AAAAB3NzaC1yc2EAAA" + }, + "created_at": { + "type": "string", + "example": "2011-01-26T19:01:12Z" + } + }, + "required": [ + "key_id", + "key" + ] + }, + "examples": { + "default": { + "value": { + "key_id": "012345678912345678", + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "secrets" + } + } + }, + "/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}": { + "get": { + "summary": "Get an environment secret", + "description": "Gets a single environment secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-environment-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#get-an-environment-secret" + }, + "parameters": [ + { + "name": "repository_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "environment_name", + "in": "path", + "required": true, + "description": "The name of the environment", + "schema": { + "type": "string" + } + }, + { + "name": "secret_name", + "description": "secret_name parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "Actions Secret", + "description": "Set secrets for GitHub Actions.", + "type": "object", + "properties": { + "name": { + "description": "The name of the secret.", + "example": "SECRET_TOKEN", + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "name", + "created_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "name": "GH_TOKEN", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "secrets" + } + }, + "put": { + "summary": "Create or update an environment secret", + "description": "Creates or updates an environment secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access\ntoken with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use\nthis endpoint.\n\n#### Example encrypting a secret using Node.js\n\nEncrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library.\n\n```\nconst sodium = require('tweetsodium');\n\nconst key = \"base64-encoded-public-key\";\nconst value = \"plain-text-secret\";\n\n// Convert the message and key to Uint8Array's (Buffer implements that interface)\nconst messageBytes = Buffer.from(value);\nconst keyBytes = Buffer.from(key, 'base64');\n\n// Encrypt using LibSodium.\nconst encryptedBytes = sodium.seal(messageBytes, keyBytes);\n\n// Base64 the encrypted secret\nconst encrypted = Buffer.from(encryptedBytes).toString('base64');\n\nconsole.log(encrypted);\n```\n\n\n#### Example encrypting a secret using Python\n\nEncrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/stable/public/#nacl-public-sealedbox) with Python 3.\n\n```\nfrom base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n sealed_box = public.SealedBox(public_key)\n encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n return b64encode(encrypted).decode(\"utf-8\")\n```\n\n#### Example encrypting a secret using C#\n\nEncrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.\n\n```\nvar secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\n```\n\n#### Example encrypting a secret using Ruby\n\nEncrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.\n\n```ruby\nrequire \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\n```", + "tags": [ + "actions" + ], + "operationId": "actions/create-or-update-environment-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#create-or-update-an-environment-secret" + }, + "parameters": [ + { + "name": "repository_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "environment_name", + "in": "path", + "required": true, + "description": "The name of the environment", + "schema": { + "type": "string" + } + }, + { + "name": "secret_name", + "description": "secret_name parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "encrypted_value": { + "type": "string", + "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/github-ae@latest/rest/reference/actions#get-an-environment-public-key) endpoint.", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" + }, + "key_id": { + "type": "string", + "description": "ID of the key you used to encrypt the secret." + } + } + }, + "example": { + "encrypted_value": "c2VjcmV0", + "key_id": "012345678912345678" + } + } + } + }, + "responses": { + "201": { + "description": "Response when creating a secret" + }, + "204": { + "description": "Response when updating a secret" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "secrets" + } + }, + "delete": { + "summary": "Delete an environment secret", + "description": "Deletes a secret in an environment using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-environment-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#delete-an-environment-secret" + }, + "parameters": [ + { + "name": "repository_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "environment_name", + "in": "path", + "required": true, + "description": "The name of the environment", + "schema": { + "type": "string" + } + }, + { + "name": "secret_name", + "description": "secret_name parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "secrets" + } + } + }, + "/scim/v2/enterprises/{enterprise}/Groups": { + "get": { + "summary": "List provisioned SCIM groups for an enterprise", + "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.", + "operationId": "enterprise-admin/list-provisioned-groups-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#list-provisioned-scim-groups-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "startIndex", + "description": "Used for pagination: the index of the first result to return.", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } + }, + { + "name": "count", + "description": "Used for pagination: the number of results to return.", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } + }, + { + "name": "filter", + "description": "filter results", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "excludedAttributes", + "description": "attributes to exclude", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "schemas": { + "type": "array", + "items": { + "type": "string" + } + }, + "totalResults": { + "type": "number" + }, + "itemsPerPage": { + "type": "number" + }, + "startIndex": { + "type": "number" + }, + "Resources": { + "type": "array", + "items": { + "type": "object", + "properties": { + "schemas": { + "type": "array", + "items": { + "type": "string" + } + }, + "id": { + "type": "string" + }, + "externalId": { + "type": "string", + "nullable": true + }, + "displayName": { + "type": "string" + }, + "members": { + "type": "array", + "items": { + "type": "object", + "properties": { + "value": { + "type": "string" + }, + "$ref": { + "type": "string" + }, + "display": { + "type": "string" + } + } + } + }, + "meta": { + "type": "object", + "properties": { + "resourceType": { + "type": "string" + }, + "created": { + "type": "string" + }, + "lastModified": { + "type": "string" + }, + "location": { + "type": "string" + } + } + } + }, + "required": [ + "schemas", + "id" + ] + } + } + }, + "required": [ + "schemas", + "totalResults", + "itemsPerPage", + "startIndex", + "Resources" + ] + }, + "examples": { + "default": { + "value": { + "schemas": [ + "urn:ietf:params:scim:api:messages:2.0:ListResponse" + ], + "totalResults": 2, + "itemsPerPage": 2, + "startIndex": 1, + "Resources": [ + { + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ], + "id": "abcd27f8-a9aa-11ea-8221-f59b2be9cccc", + "externalId": null, + "displayName": "octo-org", + "members": [ + { + "value": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", + "$ref": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", + "display": "octocat@github.com" + }, + { + "value": "aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5", + "$ref": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5", + "display": "hubot@example.com" + } + ], + "meta": { + "resourceType": "Group", + "created": "2020-06-09T03:10:17.000+10:00", + "lastModified": "2020-06-09T03:10:17.000+10:00", + "location": "https://api.github.com/scim/v2/enterprises/octo-corp/Groups/abcd27f8-a9aa-11ea-8221-f59b2be9cccc" + } + }, + { + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ], + "id": "5e75bbbb-aa1a-11ea-8644-75ff655cdddd", + "externalId": null, + "displayName": "octo-docs-org", + "members": [ + { + "value": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", + "$ref": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", + "display": "octocat@github.com" + } + ], + "meta": { + "resourceType": "Group", + "created": "2020-06-09T16:28:01.000+10:00", + "lastModified": "2020-06-09T16:28:01.000+10:00", + "location": "https://api.github.com/scim/v2/enterprises/octo-corp/Groups/5e75bbbb-aa1a-11ea-8644-75ff655cdddd" + } + } + ] + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": true, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "scim" + } + }, + "post": { + "summary": "Provision a SCIM enterprise group and invite users", + "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.\n\nProvision an enterprise group, and invite users to the group. This sends invitation emails to the email address of the invited users to join the GitHub organization that the SCIM group corresponds to.", + "operationId": "enterprise-admin/provision-and-invite-enterprise-group", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#provision-a-scim-enterprise-group-and-invite-users" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "schemas": { + "type": "array", + "description": "The SCIM schema URIs.", + "items": { + "type": "string" + } + }, + "displayName": { + "type": "string", + "description": "The name of the SCIM group. This must match the GitHub organization that the group maps to." + }, + "members": { + "type": "array", + "items": { + "type": "object", + "properties": { + "value": { + "type": "string", + "description": "The SCIM user ID for a user." + } + }, + "required": [ + "value" + ] + } + } + }, + "required": [ + "schemas", + "displayName" + ] + }, + "example": { + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ], + "displayName": "octo-org", + "members": [ + { + "value": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc" + }, + { + "value": "aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5" + } + ] + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "schemas": { + "type": "array", + "items": { + "type": "string" + } + }, + "id": { + "type": "string" + }, + "externalId": { + "type": "string", + "nullable": true + }, + "displayName": { + "type": "string" + }, + "members": { + "type": "array", + "items": { + "type": "object", + "properties": { + "value": { + "type": "string" + }, + "$ref": { + "type": "string" + }, + "display": { + "type": "string" + } + } + } + }, + "meta": { + "type": "object", + "properties": { + "resourceType": { + "type": "string" + }, + "created": { + "type": "string" + }, + "lastModified": { + "type": "string" + }, + "location": { + "type": "string" + } + } + } + }, + "required": [ + "schemas", + "id" + ] + }, + "examples": { + "default": { + "value": { + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ], + "id": "abcd27f8-a9aa-11ea-8221-f59b2be9cccc", + "externalId": null, + "displayName": "octo-org", + "members": [ + { + "value": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", + "$ref": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", + "display": "octocat@github.com" + }, + { + "value": "aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5", + "$ref": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5", + "display": "hubot@example.com" + } + ], + "meta": { + "resourceType": "Group", + "created": "2020-06-09T03:10:17.000+10:0", + "lastModified": "2020-06-09T03:10:17.000+10:00", + "location": "https://api.github.com/scim/v2/enterprises/octo-corp/Groups/abcd27f8-a9aa-11ea-8221-f59b2be9cccc" + } + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": true, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "scim" + } + } + }, + "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}": { + "get": { + "summary": "Get SCIM provisioning information for an enterprise group", + "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.", + "operationId": "enterprise-admin/get-provisioning-information-for-enterprise-group", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#get-scim-provisioning-information-for-an-enterprise-group" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "scim_group_id", + "description": "Identifier generated by the GitHub SCIM endpoint.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "excludedAttributes", + "description": "Attributes to exclude.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "schemas": { + "type": "array", + "items": { + "type": "string" + } + }, + "id": { + "type": "string" + }, + "externalId": { + "type": "string", + "nullable": true + }, + "displayName": { + "type": "string" + }, + "members": { + "type": "array", + "items": { + "type": "object", + "properties": { + "value": { + "type": "string" + }, + "$ref": { + "type": "string" + }, + "display": { + "type": "string" + } + } + } + }, + "meta": { + "type": "object", + "properties": { + "resourceType": { + "type": "string" + }, + "created": { + "type": "string" + }, + "lastModified": { + "type": "string" + }, + "location": { + "type": "string" + } + } + } + }, + "required": [ + "schemas", + "id" + ] + }, + "examples": { + "default": { + "value": { + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ], + "id": "abcd27f8-a9aa-11ea-8221-f59b2be9cccc", + "externalId": null, + "displayName": "octo-org", + "members": [ + { + "value": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", + "$ref": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", + "display": "octocat@github.com" + }, + { + "value": "aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5", + "$ref": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5", + "display": "hubot@example.com" + } + ], + "meta": { + "resourceType": "Group", + "created": "2020-06-09T03:10:17.000+10:0", + "lastModified": "2020-06-09T03:10:17.000+10:00", + "location": "https://api.github.com/scim/v2/enterprises/octo-corp/Groups/abcd27f8-a9aa-11ea-8221-f59b2be9cccc" + } + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": true, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "scim" + } + }, + "put": { + "summary": "Set SCIM information for a provisioned enterprise group", + "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.\n\nReplaces an existing provisioned group’s information. You must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the [Update an attribute for a SCIM enterprise group](#update-an-attribute-for-a-scim-enterprise-group) endpoint instead.", + "operationId": "enterprise-admin/set-information-for-provisioned-enterprise-group", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#set-scim-information-for-a-provisioned-enterprise-group" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "scim_group_id", + "description": "Identifier generated by the GitHub SCIM endpoint.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "schemas": { + "type": "array", + "description": "The SCIM schema URIs.", + "items": { + "type": "string" + } + }, + "displayName": { + "type": "string", + "description": "The name of the SCIM group. This must match the GitHub organization that the group maps to." + }, + "members": { + "type": "array", + "items": { + "type": "object", + "properties": { + "value": { + "type": "string", + "description": "The SCIM user ID for a user." + } + }, + "required": [ + "value" + ] + } + } + }, + "required": [ + "schemas", + "displayName" + ] + }, + "example": { + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ], + "displayName": "octo-org", + "members": [ + { + "value": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc" + }, + { + "value": "aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5" + } + ] + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "schemas": { + "type": "array", + "items": { + "type": "string" + } + }, + "id": { + "type": "string" + }, + "externalId": { + "type": "string", + "nullable": true + }, + "displayName": { + "type": "string" + }, + "members": { + "type": "array", + "items": { + "type": "object", + "properties": { + "value": { + "type": "string" + }, + "$ref": { + "type": "string" + }, + "display": { + "type": "string" + } + } + } + }, + "meta": { + "type": "object", + "properties": { + "resourceType": { + "type": "string" + }, + "created": { + "type": "string" + }, + "lastModified": { + "type": "string" + }, + "location": { + "type": "string" + } + } + } + }, + "required": [ + "schemas", + "id" + ] + }, + "examples": { + "default": { + "value": { + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ], + "id": "abcd27f8-a9aa-11ea-8221-f59b2be9cccc", + "externalId": null, + "displayName": "octo-org", + "members": [ + { + "value": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", + "$ref": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", + "display": "octocat@github.com" + }, + { + "value": "aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5", + "$ref": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5", + "display": "hubot@example.com" + } + ], + "meta": { + "resourceType": "Group", + "created": "2020-06-09T03:10:17.000+10:0", + "lastModified": "2020-06-09T03:10:17.000+10:00", + "location": "https://api.github.com/scim/v2/enterprises/octo-corp/Groups/abcd27f8-a9aa-11ea-8221-f59b2be9cccc" + } + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": true, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "scim" + } + }, + "patch": { + "summary": "Update an attribute for a SCIM enterprise group", + "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.\n\nAllows you to change a provisioned group’s individual attributes. To change a group’s values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2).", + "operationId": "enterprise-admin/update-attribute-for-enterprise-group", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#update-an-attribute-for-a-scim-enterprise-group" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "scim_group_id", + "description": "Identifier generated by the GitHub SCIM endpoint.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "schemas": { + "type": "array", + "description": "The SCIM schema URIs.", + "items": { + "type": "string" + } + }, + "Operations": { + "type": "array", + "description": "Array of [SCIM operations](https://tools.ietf.org/html/rfc7644#section-3.5.2).", + "minItems": 1, + "items": { + "type": "object", + "properties": { + "op": { + "type": "string", + "enum": [ + "add", + "Add", + "remove", + "Remove", + "replace", + "Replace" + ] + }, + "path": { + "type": "string" + }, + "value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object" + }, + { + "type": "array" + } + ] + } + }, + "required": [ + "op" + ] + } + } + }, + "required": [ + "schemas", + "Operations" + ] + }, + "example": { + "schemas": [ + "urn:ietf:params:scim:api:messages:2.0:PatchOp" + ], + "Operations": [ + { + "op": "remove", + "path": "members", + "value": [ + { + "value": "aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5" + } + ] + } + ] + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "schemas": { + "type": "array", + "items": { + "type": "string" + } + }, + "id": { + "type": "string" + }, + "externalId": { + "type": "string", + "nullable": true + }, + "displayName": { + "type": "string" + }, + "members": { + "type": "array", + "items": { + "type": "object", + "properties": { + "value": { + "type": "string" + }, + "$ref": { + "type": "string" + }, + "display": { + "type": "string" + } + } + } + }, + "meta": { + "type": "object", + "properties": { + "resourceType": { + "type": "string" + }, + "created": { + "type": "string" + }, + "lastModified": { + "type": "string" + }, + "location": { + "type": "string" + } + } + } + }, + "required": [ + "schemas", + "id" + ] + }, + "examples": { + "default": { + "value": { + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ], + "id": "abcd27f8-a9aa-11ea-8221-f59b2be9cccc", + "externalId": null, + "displayName": "octo-org", + "members": [ + { + "value": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", + "$ref": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", + "display": "octocat@github.com" + } + ], + "meta": { + "resourceType": "Group", + "created": "2020-06-09T03:10:17.000+10:00", + "lastModified": "2020-06-09T03:10:17.000+10:00", + "location": "https://api.github.com/scim/v2/enterprises/octo-corp/Groups/abcd27f8-a9aa-11ea-8221-f59b2be9cccc" + } + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": true, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "scim" + } + }, + "delete": { + "summary": "Delete a SCIM group from an enterprise", + "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.", + "operationId": "enterprise-admin/delete-scim-group-from-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#delete-a-scim-group-from-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "scim_group_id", + "description": "Identifier generated by the GitHub SCIM endpoint.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": true, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "scim" + } + } + }, "/search/code": { "get": { "summary": "Search code", @@ -215614,7 +243499,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -217314,10 +245199,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -217338,7 +245223,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -217508,7 +245393,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -219501,10 +247386,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -219620,7 +247505,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -221766,7 +249651,7 @@ } }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -221787,7 +249672,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -221856,7 +249741,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -221951,7 +249836,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -222089,10 +249974,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -222132,7 +250017,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -222284,7 +250169,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -222993,7 +250878,7 @@ } }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -223014,7 +250899,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -223083,7 +250968,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -223126,7 +251011,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -223400,10 +251285,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -223511,7 +251396,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -223755,10 +251640,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -223779,7 +251664,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -223883,7 +251768,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -224374,7 +252259,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -224480,7 +252365,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -224971,7 +252856,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -224991,7 +252876,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -225116,10 +253001,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -225139,7 +253024,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -225278,7 +253163,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -225693,7 +253578,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -226074,7 +253959,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -226474,7 +254359,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -226852,7 +254737,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -226933,7 +254818,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -227311,7 +255196,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -227666,7 +255551,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -228039,7 +255924,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -228391,7 +256276,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -228485,7 +256370,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -228781,7 +256666,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -229064,7 +256949,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -229352,7 +257237,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -229623,7 +257508,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -229779,7 +257664,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -229895,74 +257780,13 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { "description": "Response if team synchronization is set up" }, "422": { - "description": "response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "field": { - "type": "string" - }, - "resource": { - "type": "string" - } - } - } - }, - "documentation_url": { - "type": "string", - "example": "\"https://docs.github.com/github-ae@latest/rest\"" - } - } - }, - "examples": { - "response-if-you-attempt-to-add-an-organization-to-a-team": { - "summary": "Response if you attempt to add an organization to a team", - "value": { - "message": "Cannot add an organization as a member.", - "errors": [ - { - "code": "org", - "field": "user", - "resource": "TeamMember" - } - ] - } - }, - "response-if-you-attempt-to-add-a-user-to-a-team-when-they-are-not-a-member-of-at-least-one-other-team-in-the-same-organization": { - "summary": "Response if you attempt to add a user to a team when they are not a member of at least one other team in the same organization", - "value": { - "message": "User isn't a member of this organization. Please invite them first.", - "errors": [ - { - "code": "unaffiliated", - "field": "user", - "resource": "TeamMember" - } - ] - } - } - } - } - } + "description": "Response if you attempt to add an organization to a team or you attempt to add a user to a team when they are not a member of at least one other team in the same organization" }, "403": { "description": "Forbidden", @@ -230029,7 +257853,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { "description": "Response if team synchronization is setup" @@ -230052,7 +257876,7 @@ "/teams/{team_id}/memberships/{username}": { "get": { "summary": "Get team membership for a user (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 [Get team membership for a user](https://docs.github.com/github-ae@latest/rest/reference/teams#get-team-membership-for-a-user) endpoint.\n\nTeam members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:** The `role` for organization owners returns as `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/github-ae@latest/rest/reference/teams#create-a-team).", + "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 [Get team membership for a user](https://docs.github.com/github-ae@latest/rest/reference/teams#get-team-membership-for-a-user) endpoint.\n\nTeam members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:**\nThe response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/github-ae@latest/rest/reference/teams#create-a-team).", "tags": [ "teams" ], @@ -230081,7 +257905,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -230104,7 +257928,12 @@ "type": "string" }, "state": { - "type": "string" + "description": "The state of the user's membership in the team.", + "type": "string", + "enum": [ + "active", + "pending" + ] } }, "required": [ @@ -230114,14 +257943,6 @@ ] }, "examples": { - "response-if-user-has-an-active-membership-with-team": { - "summary": "Response if user has an active membership with team", - "value": { - "url": "https://api.github.com/teams/1/memberships/octocat", - "role": "member", - "state": "active" - } - }, "response-if-user-is-a-team-maintainer": { "summary": "Response if user is a team maintainer", "value": { @@ -230129,21 +257950,13 @@ "role": "maintainer", "state": "active" } - }, - "response-if-user-has-a-pending-membership-with-team": { - "summary": "Response if user has a pending membership with team", - "value": { - "url": "https://api.github.com/teams/1/memberships/octocat", - "role": "member", - "state": "pending" - } } } } } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -230227,7 +258040,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -230250,7 +258063,12 @@ "type": "string" }, "state": { - "type": "string" + "description": "The state of the user's membership in the team.", + "type": "string", + "enum": [ + "active", + "pending" + ] } }, "required": [ @@ -230260,14 +258078,6 @@ ] }, "examples": { - "response-if-users-membership-with-team-is-now-active": { - "summary": "Response if user's membership with team is now active", - "value": { - "url": "https://api.github.com/teams/1/memberships/octocat", - "role": "member", - "state": "active" - } - }, "response-if-users-membership-with-team-is-now-pending": { "summary": "Response if user's membership with team is now pending", "value": { @@ -230284,57 +258094,10 @@ "description": "Response if team synchronization is set up" }, "422": { - "description": "Response if you attempt to add an organization to a team", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "field": { - "type": "string" - }, - "resource": { - "type": "string" - } - } - } - }, - "documentation_url": { - "type": "string", - "example": "\"https://help.github.com/articles/github-and-trade-controls\"" - } - } - }, - "examples": { - "response-if-you-attempt-to-add-an-organization-to-a-team": { - "value": { - "message": "Cannot add an organization as a member.", - "errors": [ - { - "code": "org", - "field": "user", - "resource": "TeamMember" - } - ] - } - } - } - } - } + "description": "Response if you attempt to add an organization to a team" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -230398,7 +258161,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Response if team synchronization is set up" @@ -230460,7 +258223,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -230724,7 +258487,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -230744,7 +258507,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -230816,7 +258579,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -231070,7 +258833,7 @@ "description": "Response if project is not managed by this team" }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -231160,7 +258923,7 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Response if the project is not owned by the organization", @@ -231189,7 +258952,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -231209,7 +258972,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -231231,7 +258994,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -231348,10 +259111,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -231371,7 +259134,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -231393,7 +259156,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -231518,7 +259281,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -233253,7 +261016,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -235268,7 +263031,7 @@ }, "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -235291,7 +263054,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -235412,7 +263175,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "x-github": { @@ -235662,7 +263425,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -235702,7 +263465,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -235802,7 +263565,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -236356,7 +264119,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -236379,7 +264142,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -236475,7 +264238,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -236782,10 +264545,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -236825,7 +264588,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -236845,7 +264608,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -236959,7 +264722,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -237115,7 +264878,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -237138,7 +264901,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -237203,7 +264966,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -237359,7 +265122,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -237382,7 +265145,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -237460,7 +265223,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -237483,7 +265246,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -237536,13 +265299,13 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -237582,7 +265345,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -237635,13 +265398,13 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -237681,7 +265444,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -237746,7 +265509,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -237968,10 +265731,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -238011,7 +265774,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -238075,7 +265838,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -238284,7 +266047,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -238353,10 +266116,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -238396,7 +266159,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -238452,7 +266215,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -238661,7 +266424,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -238681,7 +266444,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -238704,7 +266467,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -238758,10 +266521,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -238781,7 +266544,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -238850,7 +266613,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -238873,7 +266636,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -239521,7 +267284,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -239544,7 +267307,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -239564,7 +267327,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -240766,7 +268529,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -240806,7 +268569,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -240857,7 +268620,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -240880,10 +268643,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -240945,7 +268708,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -240968,10 +268731,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -241027,6 +268790,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -241115,7 +268879,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -243558,7 +271322,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -243578,7 +271342,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -243630,7 +271394,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -243716,10 +271480,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -243759,7 +271523,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -243829,7 +271593,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -243892,7 +271656,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -243961,10 +271725,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -244004,7 +271768,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -244060,7 +271824,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -244123,7 +271887,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -244143,7 +271907,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -244166,7 +271930,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -244220,13 +271984,13 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -244266,7 +272030,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -244344,7 +272108,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -244361,11 +272125,21 @@ }, "state": { "type": "string", - "example": "active" + "description": "The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.", + "example": "active", + "enum": [ + "active", + "pending" + ] }, "role": { "type": "string", - "example": "admin" + "description": "The user's membership type in the organization.", + "example": "admin", + "enum": [ + "admin", + "member" + ] }, "organization_url": { "type": "string", @@ -244682,7 +272456,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -244705,7 +272479,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -244725,7 +272499,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -244829,7 +272603,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -244844,11 +272618,21 @@ }, "state": { "type": "string", - "example": "active" + "description": "The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.", + "example": "active", + "enum": [ + "active", + "pending" + ] }, "role": { "type": "string", - "example": "admin" + "description": "The user's membership type in the organization.", + "example": "admin", + "enum": [ + "admin", + "member" + ] }, "organization_url": { "type": "string", @@ -245134,7 +272918,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -245211,7 +272995,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -245226,11 +273010,21 @@ }, "state": { "type": "string", - "example": "active" + "description": "The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.", + "example": "active", + "enum": [ + "active", + "pending" + ] }, "role": { "type": "string", - "example": "admin" + "description": "The user's membership type in the organization.", + "example": "admin", + "enum": [ + "admin", + "member" + ] }, "organization_url": { "type": "string", @@ -245516,7 +273310,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -245536,7 +273330,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -245650,7 +273444,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -245761,7 +273555,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -245784,7 +273578,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -245857,7 +273651,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -246113,7 +273907,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -246136,7 +273930,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -246156,7 +273950,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -246178,7 +273972,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -246238,7 +274032,7 @@ "parameters": [ { "name": "visibility", - "description": "Can be one of `all`, `public`, or `private`.", + "description": "Can be one of `all`, `public`, or `private`. Note: For GitHub AE, can be one of `all`, `internal`, or `private`.", "in": "query", "required": false, "schema": { @@ -246263,7 +274057,7 @@ }, { "name": "type", - "description": "Can be one of `all`, `owner`, `public`, `private`, `member`. Default: `all` \n \nWill cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.", + "description": "Can be one of `all`, `owner`, `public`, `private`, `member`. Note: For GitHub AE, can be one of `all`, `owner`, `internal`, `private`, `member`. Default: `all` \n \nWill cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.", "in": "query", "required": false, "schema": { @@ -246346,7 +274140,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -247447,7 +275241,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -247516,7 +275310,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -247539,7 +275333,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -247571,7 +275365,7 @@ }, "post": { "summary": "Create a repository for the authenticated user", - "description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", + "description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository.", "tags": [ "repos" ], @@ -247602,7 +275396,7 @@ "type": "string" }, "private": { - "description": "Whether the repository is private or public.", + "description": "Whether the repository is private.", "default": false, "type": "boolean" }, @@ -247690,7 +275484,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -248793,7 +276587,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -248813,10 +276607,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -248856,7 +276650,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -249033,7 +276827,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -250949,10 +278743,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -250992,7 +278786,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -251048,7 +278842,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -251091,7 +278885,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -251111,7 +278905,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -251148,7 +278942,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "409": { "description": "Conflict", @@ -251171,10 +278965,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -251287,7 +279081,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -253510,7 +281304,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -253533,7 +281327,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -253619,7 +281413,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -253639,7 +281433,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -253703,7 +281497,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "403": { "description": "Forbidden", @@ -253726,7 +281520,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -253746,7 +281540,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -253766,7 +281560,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -253810,10 +281604,10 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -253833,7 +281627,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -253853,7 +281647,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -253921,7 +281715,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -255656,7 +283450,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -255679,7 +283473,7 @@ } }, "401": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -255744,7 +283538,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -256248,10 +284042,10 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -256336,7 +284130,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -256492,7 +284286,7 @@ } }, "304": { - "description": "Not Modified" + "description": "Not modified" } }, "x-github": { @@ -256530,7 +284324,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -257078,7 +284872,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -257151,7 +284945,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -259880,7 +287674,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -262601,7 +290395,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -265322,7 +293116,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -265531,7 +293325,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -265798,7 +293592,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -266216,7 +294010,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -266338,7 +294132,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -266619,7 +294413,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -266666,7 +294460,7 @@ } }, "404": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -266686,7 +294480,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -266790,7 +294584,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -267350,7 +295144,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -267448,7 +295242,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -267627,7 +295421,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -267896,7 +295690,7 @@ } }, "415": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -267918,7 +295712,7 @@ } }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -268044,7 +295838,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -270765,7 +298559,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -273447,7 +301241,7 @@ "/users/{username}/repos": { "get": { "summary": "List repositories for a user", - "description": "Lists public repositories for the specified user.", + "description": "Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user.", "tags": [ "repos" ], @@ -273530,7 +301324,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -275350,7 +303144,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -277626,7 +305420,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -279396,7 +307190,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "requestBody": { @@ -279447,7 +307241,7 @@ ], "responses": { "204": { - "description": "Empty response" + "description": "Response" } }, "requestBody": { @@ -279486,7 +307280,7 @@ "operationId": "meta/get-zen", "responses": { "200": { - "description": "response", + "description": "Response", "content": { "text/plain": { "schema": { diff --git a/lib/schema-event.js b/lib/schema-event.js index fbb37060f2..913cf1d9a3 100644 --- a/lib/schema-event.js +++ b/lib/schema-event.js @@ -73,7 +73,7 @@ const context = { os: { type: 'string', description: 'The type of operating system the user is working with.', - enum: ['windows', 'mac', 'linux', 'ios', 'android', 'other'], + enum: ['windows', 'mac', 'linux', 'ios', 'android', 'cros', 'other'], default: 'other' }, os_version: { diff --git a/lib/search/algolia-search.js b/lib/search/algolia-search.js index e14b4e4524..4f415a9c5c 100644 --- a/lib/search/algolia-search.js +++ b/lib/search/algolia-search.js @@ -6,7 +6,7 @@ const { namePrefix } = require('./config') // This API key is public. There's also a private API key for writing to the Algolia API const searchClient = algoliasearch('ZI5KPY1HBE', '685df617246c3a10abba589b4599288f') -module.exports = async function loadAlgoliaResults ({ version, language, query, limit }) { +module.exports = async function loadAlgoliaResults ({ version, language, query, filters, limit }) { const indexName = `${namePrefix}-${version}-${language}` const index = searchClient.initIndex(indexName) @@ -16,7 +16,8 @@ module.exports = async function loadAlgoliaResults ({ version, language, query, hitsPerPage: limit, advancedSyntax: true, highlightPreTag: '', - highlightPostTag: '' + highlightPostTag: '', + filters }) return hits.map(hit => ({ @@ -24,6 +25,7 @@ module.exports = async function loadAlgoliaResults ({ version, language, query, breadcrumbs: get(hit, '_highlightResult.breadcrumbs.value'), heading: get(hit, '_highlightResult.heading.value'), title: get(hit, '_highlightResult.title.value'), - content: get(hit, '_highlightResult.content.value') + content: get(hit, '_highlightResult.content.value'), + topics: hit.topics })) } diff --git a/lib/search/lunr-search-index.js b/lib/search/lunr-search-index.js index 05eb88ddc3..bde23b7f7e 100644 --- a/lib/search/lunr-search-index.js +++ b/lib/search/lunr-search-index.js @@ -46,6 +46,7 @@ module.exports = class LunrIndex { this.field('heading') this.field('title') this.field('content') + this.field('topics') this.field('customRanking') this.metadataWhitelist = ['position'] diff --git a/lib/search/lunr-search.js b/lib/search/lunr-search.js index e081206a45..1a0d5db2b5 100644 --- a/lib/search/lunr-search.js +++ b/lib/search/lunr-search.js @@ -1,7 +1,7 @@ -const fs = require('fs').promises const path = require('path') const lunr = require('lunr') const { get } = require('lodash') +const readFileAsync = require('../readfile-async') const { namePrefix } = require('./config') const { decompress } = require('./compress') @@ -25,7 +25,9 @@ module.exports = async function loadLunrResults ({ version, language, query, lim breadcrumbs: field(result, record, 'breadcrumbs'), heading: field(result, record, 'heading'), title: field(result, record, 'title'), - content: field(result, record, 'content') + content: field(result, record, 'content'), + // don't highlight the topics array + topics: record.topics } }) return results @@ -34,7 +36,7 @@ module.exports = async function loadLunrResults ({ version, language, query, lim async function loadLunrIndex (indexName) { const filePath = path.posix.join(__dirname, LUNR_DIR, `${indexName}.json.br`) // Do not set to 'utf8' on file reads - return fs.readFile(filePath) + return readFileAsync(filePath) .then(decompress) .then(JSON.parse) .then(lunr.Index.load) @@ -43,11 +45,12 @@ async function loadLunrIndex (indexName) { async function loadLunrRecords (indexName) { const filePath = path.posix.join(__dirname, LUNR_DIR, `${indexName}-records.json.br`) // Do not set to 'utf8' on file reads - return fs.readFile(filePath) + return readFileAsync(filePath) .then(decompress) .then(JSON.parse) } +// Highlight a match within an attribute field function field (result, record, name) { const text = record[name] if (!text) return text diff --git a/lib/search/parse-page-sections-into-records.js b/lib/search/parse-page-sections-into-records.js index 79ac651f83..3c253ae617 100644 --- a/lib/search/parse-page-sections-into-records.js +++ b/lib/search/parse-page-sections-into-records.js @@ -12,7 +12,7 @@ const { maxContentLength } = require('./config') module.exports = function parsePageSectionsIntoRecords (href, $) { const title = $('h1').text().trim() - const breadcrumbs = $('nav.breadcrumbs a') + const breadcrumbsArray = $('nav.breadcrumbs a') .map((i, el) => { return $(el) .text() @@ -21,7 +21,18 @@ module.exports = function parsePageSectionsIntoRecords (href, $) { .replace(/\s+/g, ' ') }) .get() - .join(' / ') + .slice(0, -1) + + const breadcrumbs = breadcrumbsArray.join(' / ') || '' + const metaKeywords = $('meta[name="keywords"]').attr('content') + const topics = metaKeywords ? metaKeywords.split(',') : [] + + const productName = breadcrumbsArray[0] || '' + topics.push(productName) + // Remove "github" to make filter queries shorter + if (productName.includes('GitHub ')) { + topics.push(productName.replace('GitHub ', '')) + } let records @@ -54,7 +65,8 @@ module.exports = function parsePageSectionsIntoRecords (href, $) { breadcrumbs, heading, title, - content + content, + topics } }) .get() @@ -74,7 +86,8 @@ module.exports = function parsePageSectionsIntoRecords (href, $) { url, breadcrumbs, title, - content + content, + topics }] } diff --git a/lib/warm-server.js b/lib/warm-server.js index 687de15dcc..0b6622914f 100644 --- a/lib/warm-server.js +++ b/lib/warm-server.js @@ -9,7 +9,7 @@ const loadSiteTree = require('./site-tree') const dog = { loadPages: statsd.asyncTimer(loadPages, 'load_pages'), loadPageMap: statsd.asyncTimer(loadPageMap, 'load_page_map'), - loadRedirects: statsd.timer(loadRedirects, 'load_redirects'), + loadRedirects: statsd.asyncTimer(loadRedirects, 'load_redirects'), loadSiteData: statsd.timer(loadSiteData, 'load_site_data'), loadSiteTree: statsd.asyncTimer(loadSiteTree, 'load_site_tree') } @@ -52,7 +52,7 @@ async function warmServer () { } if (!redirects) { - redirects = dog.loadRedirects(pageList, pageMap) + redirects = await dog.loadRedirects(pageList, pageMap) } if (!siteTree) { diff --git a/lib/webhooks/static/dotcom/code_scanning_alert.reopened.payload.json b/lib/webhooks/static/dotcom/code_scanning_alert.reopened.payload.json index 6f56c67b04..4acbc806be 100644 --- a/lib/webhooks/static/dotcom/code_scanning_alert.reopened.payload.json +++ b/lib/webhooks/static/dotcom/code_scanning_alert.reopened.payload.json @@ -7,7 +7,7 @@ "html_url": "https://github.com/Codertocat/Hello-World/security/code-scanning/10", "instances": [ { - "ref": "refs/heads/master", + "ref": "refs/heads/main", "analysis_key": ".github/workflows/workflow.yml:upload", "environment": "{}", "state": "open" @@ -27,7 +27,7 @@ "version": null } }, - "ref": "refs/heads/master", + "ref": "refs/heads/main", "commit_oid": "d6e4c75c141dbacecc279b721b8b9393d5405795", "repository": { "id": 186853002, @@ -121,7 +121,7 @@ "forks": 0, "open_issues": 2, "watchers": 0, - "default_branch": "master" + "default_branch": "main" }, "organization": { "login": "Octocoders", diff --git a/lib/webhooks/static/dotcom/repository_vulnerability_alert.create.payload.json b/lib/webhooks/static/dotcom/repository_vulnerability_alert.create.payload.json index d2e45f2a07..a034401623 100644 --- a/lib/webhooks/static/dotcom/repository_vulnerability_alert.create.payload.json +++ b/lib/webhooks/static/dotcom/repository_vulnerability_alert.create.payload.json @@ -4,9 +4,11 @@ "id": 91095730, "affected_range": ">= 2.0.4, < 2.0.6", "affected_package_name": "rack", + "fixed_in": "2.0.6", "external_reference": "https://nvd.nist.gov/vuln/detail/CVE-2018-16470", "external_identifier": "CVE-2018-16470", - "fixed_in": "2.0.6" + "ghsa_id": "GHSA-hg78-4f6x-99wq", + "created_at": "2021-03-01T01:23:45Z" }, "repository": { "id": 186853002, diff --git a/lib/webhooks/static/dotcom/repository_vulnerability_alert.dismiss.payload.json b/lib/webhooks/static/dotcom/repository_vulnerability_alert.dismiss.payload.json index 6f47df008a..0a9f355f75 100644 --- a/lib/webhooks/static/dotcom/repository_vulnerability_alert.dismiss.payload.json +++ b/lib/webhooks/static/dotcom/repository_vulnerability_alert.dismiss.payload.json @@ -4,9 +4,11 @@ "id": 7649605, "affected_range": "0.2.0", "affected_package_name": "many_versioned_gem", + "fixed_in": "0.2.5", "external_reference": "https://nvd.nist.gov/vuln/detail/CVE-2018-3728", "external_identifier": "CVE-2018-3728", - "fixed_in": "0.2.5", + "ghsa_id": "GHSA-jp4x-w63m-7wgm", + "created_at": "2017-10-24T00:00:00Z", "dismisser": { "login":"octocat", "id":1, @@ -28,6 +30,6 @@ "site_admin":true }, "dismiss_reason": "No bandwidth to fix this", - "dismissed_at": "2017-10-25T00:00:00+00:00" + "dismissed_at": "2017-10-25T00:00:00Z" } } diff --git a/lib/webhooks/static/ghae/check_run.completed.payload.json b/lib/webhooks/static/ghae/check_run.completed.payload.json index cbab42def2..ed6b34b672 100644 --- a/lib/webhooks/static/ghae/check_run.completed.payload.json +++ b/lib/webhooks/static/ghae/check_run.completed.payload.json @@ -250,7 +250,20 @@ } } } - ] + ], + "deployment": { + "url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/326191728", + "id": 326191728, + "node_id": "MDEwOkRlcGxveW1lbnQzMjYxOTE3Mjg=", + "task": "deploy", + "original_environment": "lab", + "environment": "lab", + "description": null, + "created_at": "2021-02-18T08:22:48Z", + "updated_at": "2021-02-18T09:47:16Z", + "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/326191728/statuses", + "repository_url": "https://api.github.com/repos/Codertocat/Hello-World" + } }, "repository": { "id": 118, diff --git a/lib/webhooks/static/ghae/check_run.created.payload.json b/lib/webhooks/static/ghae/check_run.created.payload.json index a85f42c207..f6d24e30d9 100644 --- a/lib/webhooks/static/ghae/check_run.created.payload.json +++ b/lib/webhooks/static/ghae/check_run.created.payload.json @@ -250,7 +250,20 @@ } } } - ] + ], + "deployment": { + "url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/326191728", + "id": 326191728, + "node_id": "MDEwOkRlcGxveW1lbnQzMjYxOTE3Mjg=", + "task": "deploy", + "original_environment": "lab", + "environment": "lab", + "description": null, + "created_at": "2021-02-18T08:22:48Z", + "updated_at": "2021-02-18T09:47:16Z", + "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/326191728/statuses", + "repository_url": "https://api.github.com/repos/Codertocat/Hello-World" + } }, "repository": { "id": 118, diff --git a/lib/webhooks/static/ghae/code_scanning_alert.reopened.payload.json b/lib/webhooks/static/ghae/code_scanning_alert.reopened.payload.json index f2271f33d4..1789c8ac9b 100644 --- a/lib/webhooks/static/ghae/code_scanning_alert.reopened.payload.json +++ b/lib/webhooks/static/ghae/code_scanning_alert.reopened.payload.json @@ -7,7 +7,7 @@ "html_url": "https://octocoders.github.io/Codertocat/Hello-World/security/code-scanning/10", "instances": [ { - "ref": "refs/heads/master", + "ref": "refs/heads/main", "analysis_key": ".github/workflows/workflow.yml:upload", "environment": "{}", "state": "open" @@ -27,7 +27,7 @@ "version": null } }, - "ref": "refs/heads/master", + "ref": "refs/heads/main", "commit_oid": "d6e4c75c141dbacecc279b721b8b9393d5405795", "repository": { "id": 186853002, @@ -121,7 +121,7 @@ "forks": 0, "open_issues": 2, "watchers": 0, - "default_branch": "master" + "default_branch": "main" }, "organization": { "login": "Octocoders", diff --git a/lib/webhooks/static/ghes-2.22/code_scanning_alert.reopened.payload.json b/lib/webhooks/static/ghes-2.22/code_scanning_alert.reopened.payload.json index f2271f33d4..1789c8ac9b 100644 --- a/lib/webhooks/static/ghes-2.22/code_scanning_alert.reopened.payload.json +++ b/lib/webhooks/static/ghes-2.22/code_scanning_alert.reopened.payload.json @@ -7,7 +7,7 @@ "html_url": "https://octocoders.github.io/Codertocat/Hello-World/security/code-scanning/10", "instances": [ { - "ref": "refs/heads/master", + "ref": "refs/heads/main", "analysis_key": ".github/workflows/workflow.yml:upload", "environment": "{}", "state": "open" @@ -27,7 +27,7 @@ "version": null } }, - "ref": "refs/heads/master", + "ref": "refs/heads/main", "commit_oid": "d6e4c75c141dbacecc279b721b8b9393d5405795", "repository": { "id": 186853002, @@ -121,7 +121,7 @@ "forks": 0, "open_issues": 2, "watchers": 0, - "default_branch": "master" + "default_branch": "main" }, "organization": { "login": "Octocoders", diff --git a/lib/webhooks/static/ghes-3.0/code_scanning_alert.reopened.payload.json b/lib/webhooks/static/ghes-3.0/code_scanning_alert.reopened.payload.json index f2271f33d4..1789c8ac9b 100644 --- a/lib/webhooks/static/ghes-3.0/code_scanning_alert.reopened.payload.json +++ b/lib/webhooks/static/ghes-3.0/code_scanning_alert.reopened.payload.json @@ -7,7 +7,7 @@ "html_url": "https://octocoders.github.io/Codertocat/Hello-World/security/code-scanning/10", "instances": [ { - "ref": "refs/heads/master", + "ref": "refs/heads/main", "analysis_key": ".github/workflows/workflow.yml:upload", "environment": "{}", "state": "open" @@ -27,7 +27,7 @@ "version": null } }, - "ref": "refs/heads/master", + "ref": "refs/heads/main", "commit_oid": "d6e4c75c141dbacecc279b721b8b9393d5405795", "repository": { "id": 186853002, @@ -121,7 +121,7 @@ "forks": 0, "open_issues": 2, "watchers": 0, - "default_branch": "master" + "default_branch": "main" }, "organization": { "login": "Octocoders", diff --git a/middleware/abort.js b/middleware/abort.js new file mode 100644 index 0000000000..387a965ead --- /dev/null +++ b/middleware/abort.js @@ -0,0 +1,15 @@ +module.exports = function abort (req, res, next) { + // If the client aborts the connection, send an error + req.once('aborted', () => { + // NOTE: Node.js will also automatically set `req.aborted = true` + + const abortError = new Error('Client closed request') + abortError.statusCode = 499 + abortError.code = 'ECONNRESET' + + // Pass the error to the Express error handler + return next(abortError) + }) + + return next() +} diff --git a/middleware/archived-enterprise-versions-assets.js b/middleware/archived-enterprise-versions-assets.js index c1f1253712..81ca646078 100644 --- a/middleware/archived-enterprise-versions-assets.js +++ b/middleware/archived-enterprise-versions-assets.js @@ -11,7 +11,7 @@ const ONE_DAY = 24 * 60 * 60 // 1 day in seconds // // See also ./archived-enterprise-versions.js for non-CSS/JS paths -module.exports = async (req, res, next) => { +module.exports = async function archivedEnterpriseVersionsAssets (req, res, next) { const { isArchived, requestedVersion } = isArchivedVersion(req) if (!isArchived) return next() diff --git a/middleware/archived-enterprise-versions.js b/middleware/archived-enterprise-versions.js index 422484f977..3a5cd96f7f 100644 --- a/middleware/archived-enterprise-versions.js +++ b/middleware/archived-enterprise-versions.js @@ -11,7 +11,7 @@ const archivedFrontmatterFallbacks = require('../lib/redirects/static/archived-f // This module handles requests for deprecated GitHub Enterprise versions // by routing them to static content in help-docs-archived-enterprise-versions -module.exports = async (req, res, next) => { +module.exports = async function archivedEnterpriseVersions (req, res, next) { const { isArchived, requestedVersion } = isArchivedVersion(req) if (!isArchived) return next() diff --git a/middleware/block-robots.js b/middleware/block-robots.js index 7a437972de..286920acaa 100644 --- a/middleware/block-robots.js +++ b/middleware/block-robots.js @@ -30,7 +30,7 @@ function blockIndex (path) { return pathRegExps.some(pathRe => pathRe.test(path)) } -const middleware = (req, res, next) => { +const middleware = function blockRobots (req, res, next) { if (blockIndex(req.path)) res.set('x-robots-tag', 'noindex') return next() } diff --git a/middleware/breadcrumbs.js b/middleware/breadcrumbs.js index 86970bde35..e26545c400 100644 --- a/middleware/breadcrumbs.js +++ b/middleware/breadcrumbs.js @@ -3,7 +3,7 @@ const { getPathWithoutLanguage } = require('../lib/path-utils') const nonEnterpriseDefaultVersion = require('../lib/non-enterprise-default-version') const removeFPTFromPath = require('../lib/remove-fpt-from-path') -module.exports = async (req, res, next) => { +module.exports = async function breadcrumbs (req, res, next) { if (!req.context.page) return next() if (req.context.page.hidden) return next() diff --git a/middleware/categories-for-support-team.js b/middleware/categories-for-support-team.js index 4b550a566e..b288bc3b13 100644 --- a/middleware/categories-for-support-team.js +++ b/middleware/categories-for-support-team.js @@ -2,13 +2,13 @@ // to quickly search for Help articles by title and insert the link to // the article into a reply to a customer. const path = require('path') -const fs = require('fs').promises const matter = require('gray-matter') +const readFileAsync = require('../lib/readfile-async') const dotcomDir = path.join(__dirname, '../content/github') const dotcomIndex = path.join(dotcomDir, 'index.md') const linkRegex = /{% (?:topic_)?link_in_list ?\/(.*?) ?%}/g -module.exports = async (req, res, next) => { +module.exports = async function categoriesForSupportTeam (req, res, next) { if (req.path !== '/categories.json') return next() const categories = await generateCategories() return res.json(categories) @@ -18,14 +18,14 @@ async function generateCategories () { // get links included in dotcom index page. // each link corresponds to a dotcom subdirectory // example: getting-started-with-github - const links = getLinks(await fs.readFile(dotcomIndex, 'utf8')) + const links = getLinks(await readFileAsync(dotcomIndex, 'utf8')) // get links included in each subdir's index page // these are links to articles const categories = await Promise.all(links.map(async link => { const category = {} const indexPath = getPath(link, 'index') - const indexContents = await fs.readFile(indexPath, 'utf8') + const indexContents = await readFileAsync(indexPath, 'utf8') const { data, content } = matter(indexContents) // get name from title frontmatter @@ -37,7 +37,7 @@ async function generateCategories () { category.published_articles = (await Promise.all(articleLinks.map(async articleLink => { // get title from frontmatter const articlePath = getPath(link, articleLink) - const articleContents = await fs.readFile(articlePath, 'utf8') + const articleContents = await readFileAsync(articlePath, 'utf8') const { data } = matter(articleContents) // do not include map topics in list of published articles diff --git a/middleware/context.js b/middleware/context.js index a2508138aa..3a00064c90 100644 --- a/middleware/context.js +++ b/middleware/context.js @@ -3,7 +3,12 @@ const enterpriseServerReleases = require('../lib/enterprise-server-releases') const allVersions = require('../lib/all-versions') const allProducts = require('../lib/all-products') const activeProducts = Object.values(allProducts).filter(product => !product.wip && !product.hidden) -const { getVersionStringFromPath, getProductStringFromPath, getPathWithoutLanguage } = require('../lib/path-utils') +const { + getVersionStringFromPath, + getProductStringFromPath, + getCategoryStringFromPath, + getPathWithoutLanguage +} = require('../lib/path-utils') const productNames = require('../lib/product-names') const warmServer = require('../lib/warm-server') const featureFlags = Object.keys(require('../feature-flags')) @@ -31,6 +36,7 @@ module.exports = async function contextualize (req, res, next) { req.context.currentLanguage = req.language req.context.currentVersion = getVersionStringFromPath(req.path) req.context.currentProduct = getProductStringFromPath(req.path) + req.context.currentCategory = getCategoryStringFromPath(req.path) req.context.allProducts = allProducts req.context.activeProducts = activeProducts req.context.allVersions = allVersions diff --git a/middleware/contextualizers/enterprise-release-notes.js b/middleware/contextualizers/enterprise-release-notes.js index e616f49c18..0e36c55e68 100644 --- a/middleware/contextualizers/enterprise-release-notes.js +++ b/middleware/contextualizers/enterprise-release-notes.js @@ -18,6 +18,8 @@ function sortPatchKeys (release, version) { ...release[key] } }) + // Filter out any deprecated patches + .filter(key => !key.deprecated) return keys .sort((a, b) => { let aTemp = a.version @@ -64,7 +66,7 @@ async function renderPatchNotes (patch, ctx) { return patch } -module.exports = async (req, res, next) => { +module.exports = async function enterpriseReleaseNotesContext (req, res, next) { // The `/release-notes` sub-path if (!req.path.endsWith('/release-notes')) return next() diff --git a/middleware/contextualizers/graphql.js b/middleware/contextualizers/graphql.js index e07094dba7..91575be17a 100644 --- a/middleware/contextualizers/graphql.js +++ b/middleware/contextualizers/graphql.js @@ -8,7 +8,7 @@ const explorerUrl = process.env.NODE_ENV === 'production' ? 'https://graphql.github.com/explorer' : 'http://localhost:3000' -module.exports = async (req, res, next) => { +module.exports = function graphqlContext (req, res, next) { const currentVersionObj = allVersions[req.context.currentVersion] // ignore requests to non-GraphQL reference paths // and to versions that don't exist diff --git a/middleware/contextualizers/rest.js b/middleware/contextualizers/rest.js index 198a4d312a..5b49cbfa19 100644 --- a/middleware/contextualizers/rest.js +++ b/middleware/contextualizers/rest.js @@ -2,7 +2,7 @@ const path = require('path') const rest = require('../../lib/rest') const removeFPTFromPath = require('../../lib/remove-fpt-from-path') -module.exports = async function (req, res, next) { +module.exports = function restContext (req, res, next) { req.context.rest = rest // link to include in `Works with GitHub Apps` notes diff --git a/middleware/contextualizers/webhooks.js b/middleware/contextualizers/webhooks.js index f2ed9a6cc7..90347b36fd 100644 --- a/middleware/contextualizers/webhooks.js +++ b/middleware/contextualizers/webhooks.js @@ -4,7 +4,7 @@ const webhookPayloads = require(path.join(process.cwd(), 'lib/webhooks')) const nonEnterpriseDefaultVersion = require('../../lib/non-enterprise-default-version') const allVersions = require('../../lib/all-versions') -module.exports = async (req, res, next) => { +module.exports = function webhooksContext (req, res, next) { const currentVersionObj = allVersions[req.context.currentVersion] // ignore requests to non-webhook reference paths // and to versions that don't exist diff --git a/middleware/csp.js b/middleware/csp.js index 9f054036f7..08b618eac6 100644 --- a/middleware/csp.js +++ b/middleware/csp.js @@ -7,7 +7,7 @@ const versionSatisfiesRange = require('../lib/version-satisfies-range') const AZURE_STORAGE_URL = 'githubdocs.azureedge.net' // module.exports = contentSecurityPolicy({ -module.exports = async (req, res, next) => { +module.exports = function csp (req, res, next) { const csp = { directives: { defaultSrc: ["'none'"], diff --git a/middleware/detect-language.js b/middleware/detect-language.js index 9c46c3e0b3..1c407fe3e5 100644 --- a/middleware/detect-language.js +++ b/middleware/detect-language.js @@ -1,7 +1,7 @@ const languageCodes = Object.keys(require('../lib/languages')) // determine language code from first part of URL, or default to English -module.exports = async function detectLanguage (req, res, next) { +module.exports = function detectLanguage (req, res, next) { // /en/articles/foo // ^^ const firstPartOfPath = req.path.split('/')[1] diff --git a/middleware/dev-toc.js b/middleware/dev-toc.js index 5e00093e55..9e5e5f2e51 100644 --- a/middleware/dev-toc.js +++ b/middleware/dev-toc.js @@ -1,7 +1,7 @@ const { liquid } = require('../lib/render-content') const layouts = require('../lib/layouts') -module.exports = async (req, res, next) => { +module.exports = async function devToc (req, res, next) { if (process.env.NODE_ENV !== 'development') return next() if (!req.path.endsWith('/dev-toc')) return next() diff --git a/middleware/disable-caching-on-safari.js b/middleware/disable-caching-on-safari.js index 4281b37c91..123bdffbe0 100644 --- a/middleware/disable-caching-on-safari.js +++ b/middleware/disable-caching-on-safari.js @@ -1,4 +1,4 @@ -module.exports = (req, res, next) => { +module.exports = function disableCachingOnSafari (req, res, next) { const isSafari = /^((?!chrome|android).)*safari/i.test(req.headers['user-agent']) if (isSafari) { res.header('Last-Modified', (new Date()).toUTCString()) diff --git a/middleware/early-access-breadcrumbs.js b/middleware/early-access-breadcrumbs.js index 2b7c95ca76..5ada437c47 100644 --- a/middleware/early-access-breadcrumbs.js +++ b/middleware/early-access-breadcrumbs.js @@ -5,7 +5,7 @@ const removeFPTFromPath = require('../lib/remove-fpt-from-path') // Early Access content doesn't conform to the same structure as other products, so we // can't derive breadcrumbs from the siteTree in the same way. Hence, this separate middleware. -module.exports = async (req, res, next) => { +module.exports = async function earlyAccessBreadcrumbs (req, res, next) { if (!req.context.page) return next() if (!req.context.page.hidden) return next() diff --git a/middleware/enterprise-server-releases.js b/middleware/enterprise-server-releases.js index a3f331d97c..0c7035c46a 100644 --- a/middleware/enterprise-server-releases.js +++ b/middleware/enterprise-server-releases.js @@ -2,7 +2,7 @@ const { liquid } = require('../lib/render-content') const layouts = require('../lib/layouts') const getMiniTocItems = require('../lib/get-mini-toc-items') -module.exports = async (req, res, next) => { +module.exports = async function enterpriseServerReleases (req, res, next) { if (!req.path.endsWith('/enterprise-server-releases')) return next() const html = await liquid.parseAndRender(layouts['enterprise-server-releases'], req.context) diff --git a/middleware/events.js b/middleware/events.js index e687954e83..11871b4fd5 100644 --- a/middleware/events.js +++ b/middleware/events.js @@ -10,7 +10,7 @@ const ajv = new Ajv() const router = express.Router() -router.post('/', async (req, res, next) => { +router.post('/', async function postEvents (req, res, next) { const isDev = process.env.NODE_ENV === 'development' const fields = omit(req.body, '_csrf') diff --git a/middleware/featured-links.js b/middleware/featured-links.js index 0430d06af5..e0a779ce17 100644 --- a/middleware/featured-links.js +++ b/middleware/featured-links.js @@ -1,7 +1,7 @@ const getLinkData = require('../lib/get-link-data') // this middleware adds properties to the context object -module.exports = async (req, res, next) => { +module.exports = async function featuredLinks (req, res, next) { if (!req.context.page) return next() if (!(req.context.page.relativePath.endsWith('index.md') || req.context.page.layout === 'product-landing')) return next() diff --git a/middleware/halt-on-dropped-connection.js b/middleware/halt-on-dropped-connection.js new file mode 100644 index 0000000000..9745723a84 --- /dev/null +++ b/middleware/halt-on-dropped-connection.js @@ -0,0 +1,18 @@ +function isConnectionDropped (req, res) { + // Have the flags been set for: + // - a global request timeout (via the express-timeout-handler middleware)? + // - an aborted request connection (via Node.js core's HTTP IncomingMessage)? + return Boolean(res.globalTimeout || req.aborted) +} + +function haltOnDroppedConnection (req, res, next) { + // Only proceed if the flag has not been set for the express-timeout-handler middleware + if (!isConnectionDropped(req, res)) { + return next() + } +} + +// Export this logic, too +haltOnDroppedConnection.isConnectionDropped = isConnectionDropped + +module.exports = haltOnDroppedConnection diff --git a/middleware/handle-csrf-errors.js b/middleware/handle-csrf-errors.js index 738bbbf0e3..be673ec4e3 100644 --- a/middleware/handle-csrf-errors.js +++ b/middleware/handle-csrf-errors.js @@ -1,4 +1,4 @@ -module.exports = async function handleCSRFError (error, req, res, next) { +module.exports = function handleCSRFError (error, req, res, next) { // If the CSRF token is bad if (error.code === 'EBADCSRFTOKEN') { return res.sendStatus(403) diff --git a/middleware/handle-errors.js b/middleware/handle-errors.js index 0170a59ca3..98448486f3 100644 --- a/middleware/handle-errors.js +++ b/middleware/handle-errors.js @@ -6,7 +6,9 @@ const loadSiteData = require('../lib/site-data') function shouldLogException (error) { const IGNORED_ERRORS = [ // avoid sending CSRF token errors (from bad-actor POST requests) - 'EBADCSRFTOKEN' + 'EBADCSRFTOKEN', + // Client connected aborted + 'ECONNRESET' ] if (IGNORED_ERRORS.includes(error.code)) { @@ -17,42 +19,61 @@ function shouldLogException (error) { return true } -module.exports = async function handleError (error, req, res, next) { - // if the error is thrown before req.context is created (say, in the Page class), - // set req.context.site here so we can pass data/ui.yml text to the 500 layout - if (!req.context) { - const site = await loadSiteData() - req.context = { site: site[req.language || 'en'].site } +async function logException (error, req) { + if (process.env.NODE_ENV !== 'test' && shouldLogException(error)) { + await FailBot.report(error, { + path: req.path + }) + } +} + +module.exports = async function handleError (error, req, res, next) { + try { + // If the headers have already been sent or the request was aborted... + if (res.headersSent || req.aborted) { + // Report to Failbot + await logException(error, req) + + // We MUST delegate to the default Express error handler + return next(error) + } + + // if the error is thrown before req.context is created (say, in the Page class), + // set req.context.site here so we can pass data/ui.yml text to the 500 layout + if (!req.context) { + const site = await loadSiteData() + req.context = { site: site[req.language || 'en'].site } + } + + // display error on the page in development, but not in production + if (process.env.NODE_ENV !== 'production' && req.context) { + req.context.error = error + } + + // Special handling for when a middleware calls `next(404)` + if (error === 404) { + return res + .status(404) + .send(await liquid.parseAndRender(layouts['error-404'], req.context)) + } + + // If the error contains a status code, just send that back. This is usually + // from a middleware like `express.json()` or `csrf`. + if (error.statusCode || error.status) { + return res.sendStatus(error.statusCode || error.status) + } + + if (process.env.NODE_ENV !== 'test') { + console.error('500 error!', req.path) + console.error(error) + } + + res.status(500).send(await liquid.parseAndRender(layouts['error-500'], req.context)) + + // Report to Failbot AFTER responding to the user + await logException(error, req) + } catch (error) { + console.error('An error occurred in the error handling middleware!', error) + return next(error) } - - // display error on the page in development, but not in production - if (process.env.NODE_ENV !== 'production' && req.context) { - req.context.error = error - } - - // Special handling for when a middleware calls `next(404)` - if (error === 404) { - return res - .status(404) - .send(await liquid.parseAndRender(layouts['error-404'], req.context)) - } - - // If the error contains a status code, just send that back. This is usually - // from a middleware like `express.json()` or `csrf`. - if (error.statusCode || error.status) { - return res.sendStatus(error.statusCode || error.status) - } - - if (process.env.NODE_ENV !== 'test') { - console.error('500 error!', req.path) - console.error(error) - - if (shouldLogException(error)) { - await FailBot.report(error, { - path: req.path - }) - } - } - - res.status(500).send(await liquid.parseAndRender(layouts['error-500'], req.context)) } diff --git a/middleware/handle-invalid-paths.js b/middleware/handle-invalid-paths.js index 151887ce54..3a8d9eb0c0 100644 --- a/middleware/handle-invalid-paths.js +++ b/middleware/handle-invalid-paths.js @@ -1,6 +1,6 @@ const patterns = require('../lib/patterns') -module.exports = (req, res, next) => { +module.exports = function handleInvalidPaths (req, res, next) { // prevent open redirect vulnerability if (req.path.match(patterns.multipleSlashes)) { return next(404) @@ -10,12 +10,33 @@ module.exports = (req, res, next) => { // for paths like /%7B% try { decodeURIComponent(req.path) - return next() } catch (err) { if (process.env.NODE_ENV !== 'test') { - console.log('unable to decode path', req.path, err) + console.error('unable to decode path', req.path, err) } return res.sendStatus(400) } + + // Prevent spammy request URLs from getting through by checking how they + // handle being normalized twice in a row + try { + const origin = 'https://docs.github.com' + const normalizedPath = new URL(req.path, origin).pathname + + // This may also throw an error with code `ERR_INVALID_URL` + const reNormalizedPath = new URL(normalizedPath, origin).pathname + + if (reNormalizedPath !== normalizedPath) { + throw new Error('URI keeps changing') + } + } catch (err) { + if (process.env.NODE_ENV !== 'test') { + console.error('unable to normalize path', req.path, err) + } + + return res.sendStatus(400) + } + + return next() } diff --git a/middleware/index.js b/middleware/index.js index 6d39616432..779fd3c22c 100644 --- a/middleware/index.js +++ b/middleware/index.js @@ -1,7 +1,10 @@ const express = require('express') const instrument = require('../lib/instrument-middleware') +const haltOnDroppedConnection = require('./halt-on-dropped-connection') -const isDevelopment = process.env.NODE_ENV === 'development' +const { NODE_ENV } = process.env +const isDevelopment = NODE_ENV === 'development' +const isTest = NODE_ENV === 'test' || process.env.GITHUB_ACTIONS === 'true' // Catch unhandled promise rejections and passing them to Express's error handler // https://medium.com/@Abazhenov/using-async-await-in-express-with-node-8-b8af872c0016 @@ -11,6 +14,10 @@ const asyncMiddleware = fn => } module.exports = function (app) { + // *** Request connection management *** + if (!isTest) app.use(require('./timeout')) + app.use(require('./abort')) + // *** Development tools *** app.use(require('morgan')('dev', { skip: (req, res) => !isDevelopment })) if (isDevelopment) app.use(require('./webpack')) @@ -57,12 +64,15 @@ module.exports = function (app) { app.use(instrument('./redirects/handle-redirects')) // Must come before contextualizers // *** Config and context for rendering *** - app.use(instrument('./find-page')) // Must come before archived-enterprise-versions, breadcrumbs, featured-links, products, render-page + app.use(asyncMiddleware(instrument('./find-page'))) // Must come before archived-enterprise-versions, breadcrumbs, featured-links, products, render-page app.use(instrument('./block-robots')) + // Check for a dropped connection before proceeding + app.use(haltOnDroppedConnection) + // *** Rendering, 2xx responses *** // I largely ordered these by use frequency - app.use(instrument('./archived-enterprise-versions-assets')) // Must come before static/assets + app.use(asyncMiddleware(instrument('./archived-enterprise-versions-assets'))) // Must come before static/assets app.use('/dist', express.static('dist', { index: false, etag: false, @@ -82,31 +92,39 @@ module.exports = function (app) { lastModified: false, maxAge: '7 days' // A bit longer since releases are more sparse })) - app.use('/events', instrument('./events')) - app.use('/search', instrument('./search')) - app.use(instrument('./archived-enterprise-versions')) + app.use('/events', asyncMiddleware(instrument('./events'))) + app.use('/search', asyncMiddleware(instrument('./search'))) + app.use(asyncMiddleware(instrument('./archived-enterprise-versions'))) app.use(instrument('./robots')) app.use(/(\/.*)?\/early-access$/, instrument('./contextualizers/early-access-links')) - app.use(instrument('./categories-for-support-team')) + app.use(asyncMiddleware(instrument('./categories-for-support-team'))) app.use(instrument('./loaderio-verification')) app.get('/_500', asyncMiddleware(instrument('./trigger-error'))) + // Check for a dropped connection before proceeding (again) + app.use(haltOnDroppedConnection) + // *** Preparation for render-page *** app.use(asyncMiddleware(instrument('./contextualizers/enterprise-release-notes'))) app.use(instrument('./contextualizers/graphql')) app.use(instrument('./contextualizers/rest')) app.use(instrument('./contextualizers/webhooks')) - app.use(instrument('./breadcrumbs')) - app.use(instrument('./early-access-breadcrumbs')) - app.use(instrument('./enterprise-server-releases')) - app.use(instrument('./dev-toc')) - app.use(instrument('./featured-links')) - app.use(instrument('./learning-track')) + app.use(asyncMiddleware(instrument('./breadcrumbs'))) + app.use(asyncMiddleware(instrument('./early-access-breadcrumbs'))) + app.use(asyncMiddleware(instrument('./enterprise-server-releases'))) + app.use(asyncMiddleware(instrument('./dev-toc'))) + app.use(asyncMiddleware(instrument('./featured-links'))) + app.use(asyncMiddleware(instrument('./learning-track'))) // *** Headers for pages only *** app.use(require('./set-fastly-cache-headers')) - // *** Rendering, must go last *** + // Check for a dropped connection before proceeding (again) + app.use(haltOnDroppedConnection) + + // *** Rendering, must go almost last *** app.get('/*', asyncMiddleware(instrument('./render-page'))) + + // *** Error handling, must go last *** app.use(require('./handle-errors')) } diff --git a/middleware/learning-track.js b/middleware/learning-track.js index 2dbb6c6c20..dd55b0745f 100644 --- a/middleware/learning-track.js +++ b/middleware/learning-track.js @@ -1,7 +1,7 @@ const { getPathWithoutLanguage, getPathWithoutVersion } = require('../lib/path-utils') const getLinkData = require('../lib/get-link-data') -module.exports = async (req, res, next) => { +module.exports = async function learningTrack (req, res, next) { const noTrack = () => { req.context.currentLearningTrack = {} return next() diff --git a/middleware/loaderio-verification.js b/middleware/loaderio-verification.js index f31f980c29..08a4577a31 100644 --- a/middleware/loaderio-verification.js +++ b/middleware/loaderio-verification.js @@ -1,6 +1,6 @@ // prove to loader.io that we own this site // by responding to requests like `/loaderio-12345/` with `loaderio-12345` -module.exports = (req, res, next) => { +module.exports = function loaderIoVerification (req, res, next) { if (!req.path.startsWith('/loaderio-')) return next() return res.send(req.path.replace(/\//g, '')) } diff --git a/middleware/record-redirect.js b/middleware/record-redirect.js index b72e975db3..b574180334 100644 --- a/middleware/record-redirect.js +++ b/middleware/record-redirect.js @@ -1,6 +1,6 @@ const { v4: uuidv4 } = require('uuid') -module.exports = function (req, res, next) { +module.exports = function recordRedirects (req, res, next) { if (!req.hydro.maySend()) return next() res.on('finish', async function recordRedirect () { diff --git a/middleware/redirects/external.js b/middleware/redirects/external.js index 3500af3759..b6172696e3 100644 --- a/middleware/redirects/external.js +++ b/middleware/redirects/external.js @@ -1,7 +1,7 @@ const externalSites = require('../../lib/redirects/external-sites') // blanket redirects to external websites -module.exports = async function externalRedirects (req, res, next) { +module.exports = function externalRedirects (req, res, next) { if (req.path in externalSites) { return res.redirect(301, externalSites[req.path]) } else { diff --git a/middleware/redirects/handle-redirects.js b/middleware/redirects/handle-redirects.js index a6db5bc168..8fc89af056 100644 --- a/middleware/redirects/handle-redirects.js +++ b/middleware/redirects/handle-redirects.js @@ -1,7 +1,7 @@ const patterns = require('../../lib/patterns') const { URL } = require('url') -module.exports = async function handleRedirects (req, res, next) { +module.exports = function handleRedirects (req, res, next) { // never redirect assets if (patterns.assetPaths.test(req.path)) return next() diff --git a/middleware/redirects/help-to-docs.js b/middleware/redirects/help-to-docs.js index d57c2136bb..508e283dbf 100644 --- a/middleware/redirects/help-to-docs.js +++ b/middleware/redirects/help-to-docs.js @@ -3,7 +3,7 @@ const patterns = require('../../lib/patterns') // redirect help.github.com requests to docs.github.com -module.exports = async (req, res, next) => { +module.exports = function helpToDocs (req, res, next) { if (req.hostname === 'help.github.com') { // prevent open redirect security vulnerability const path = req.originalUrl.replace(patterns.multipleSlashes, '/') diff --git a/middleware/redirects/language-code-redirects.js b/middleware/redirects/language-code-redirects.js index 25f16d91a5..d0d2ff733b 100644 --- a/middleware/redirects/language-code-redirects.js +++ b/middleware/redirects/language-code-redirects.js @@ -5,7 +5,7 @@ const languages = require('../../lib/languages') // Examples: // /jp* -> /ja* // /zh-TW* -> /cn* -module.exports = async function languageCodeRedirects (req, res, next) { +module.exports = function languageCodeRedirects (req, res, next) { for (const code in languages) { const language = languages[code] const redirectPatterns = language.redirectPatterns || [] diff --git a/middleware/render-page.js b/middleware/render-page.js index 1ee5b3d161..0bb4e62774 100644 --- a/middleware/render-page.js +++ b/middleware/render-page.js @@ -6,6 +6,7 @@ const getMiniTocItems = require('../lib/get-mini-toc-items') const Page = require('../lib/page') const statsd = require('../lib/statsd') const RedisAccessor = require('../lib/redis-accessor') +const { isConnectionDropped } = require('./halt-on-dropped-connection') const { HEROKU_RELEASE_VERSION } = process.env const pageCacheDatabaseNumber = 1 @@ -28,31 +29,6 @@ function addCsrf (req, text) { module.exports = async function renderPage (req, res, next) { const page = req.context.page - // Remove any query string (?...) and/or fragment identifier (#...) - const { pathname, searchParams } = new URL(req.originalUrl, 'https://docs.github.com') - - for (const queryKey in req.query) { - if (!cacheableQueries.includes(queryKey)) { - searchParams.delete(queryKey) - } - } - const originalUrl = pathname + ([...searchParams].length > 0 ? `?${searchParams}` : '') - - // Serve from the cache if possible (skip during tests) - const isCacheable = !process.env.CI && process.env.NODE_ENV !== 'test' && req.method === 'GET' - - // Is the request for JSON debugging info? - const isRequestingJsonForDebugging = 'json' in req.query && process.env.NODE_ENV !== 'production' - - if (isCacheable && !isRequestingJsonForDebugging) { - const cachedHtml = await pageCache.get(originalUrl) - if (cachedHtml) { - console.log(`Serving from cached version of ${originalUrl}`) - statsd.increment('page.sent_from_cache') - return res.send(addCsrf(req, cachedHtml)) - } - } - // render a 404 page if (!page) { if (process.env.NODE_ENV !== 'test' && req.context.redirectNotFound) { @@ -70,15 +46,52 @@ module.exports = async function renderPage (req, res, next) { return res.status(200).end() } + // Remove any query string (?...) and/or fragment identifier (#...) + const { pathname, searchParams } = new URL(req.originalUrl, 'https://docs.github.com') + + for (const queryKey in req.query) { + if (!cacheableQueries.includes(queryKey)) { + searchParams.delete(queryKey) + } + } + const originalUrl = pathname + ([...searchParams].length > 0 ? `?${searchParams}` : '') + + // Serve from the cache if possible (skip during tests) + const isCacheable = !process.env.CI && process.env.NODE_ENV !== 'test' && req.method === 'GET' + + // Is the request for JSON debugging info? + const isRequestingJsonForDebugging = 'json' in req.query && process.env.NODE_ENV !== 'production' + + if (isCacheable && !isRequestingJsonForDebugging) { + // Stop processing if the connection was already dropped + if (isConnectionDropped(req, res)) return + + const cachedHtml = await pageCache.get(originalUrl) + if (cachedHtml) { + // Stop processing if the connection was already dropped + if (isConnectionDropped(req, res)) return + + console.log(`Serving from cached version of ${originalUrl}`) + statsd.increment('page.sent_from_cache') + return res.send(addCsrf(req, cachedHtml)) + } + } + // add page context const context = Object.assign({}, req.context, { page }) // collect URLs for variants of this page in all languages context.page.languageVariants = Page.getLanguageVariants(req.path) + // Stop processing if the connection was already dropped + if (isConnectionDropped(req, res)) return + // render page context.renderedPage = await page.render(context) + // Stop processing if the connection was already dropped + if (isConnectionDropped(req, res)) return + // get mini TOC items on articles if (page.showMiniToc) { context.miniTocItems = getMiniTocItems(context.renderedPage, page.miniTocMaxHeadingLevel) diff --git a/middleware/req-utils.js b/middleware/req-utils.js index d82bb959ed..3072de4265 100644 --- a/middleware/req-utils.js +++ b/middleware/req-utils.js @@ -1,6 +1,6 @@ const Hydro = require('../lib/hydro') -module.exports = (req, res, next) => { +module.exports = function reqUtils (req, res, next) { req.hydro = new Hydro() return next() } diff --git a/middleware/robots.js b/middleware/robots.js index 967d1f21dd..8e12c8c1bc 100644 --- a/middleware/robots.js +++ b/middleware/robots.js @@ -3,7 +3,7 @@ const defaultResponse = 'User-agent: *' const disallowAll = `User-agent: * Disallow: /` -module.exports = function (req, res, next) { +module.exports = function robots (req, res, next) { if (req.path !== '/robots.txt') return next() res.type('text/plain') diff --git a/middleware/search.js b/middleware/search.js index 58025beef6..149ad4285a 100644 --- a/middleware/search.js +++ b/middleware/search.js @@ -6,13 +6,13 @@ const loadAlgoliaResults = require('../lib/search/algolia-search') const router = express.Router() -router.get('/', async (req, res) => { +router.get('/', async function postSearch (req, res, next) { res.set({ 'surrogate-control': 'private, no-store', 'cache-control': 'private, no-store' }) - const { query, version, language, limit: limit_ } = req.query + const { query, version, language, filters, limit: limit_ } = req.query const limit = Math.min(parseInt(limit_, 10) || 10, 100) if (!versions.has(version) || !languages.has(language)) { return res.status(400).json([]) @@ -23,8 +23,8 @@ router.get('/', async (req, res) => { try { const results = process.env.AIRGAP - ? await loadLunrResults({ version, language, query, limit }) - : await loadAlgoliaResults({ version, language, query, limit }) + ? await loadLunrResults({ version, language, query: `${query} ${filters || ''}`, limit }) + : await loadAlgoliaResults({ version, language, query, filters, limit }) return res.status(200).json(results) } catch (err) { console.error(err) diff --git a/middleware/set-fastly-cache-headers.js b/middleware/set-fastly-cache-headers.js index 2463e63ea5..2a044da3f4 100644 --- a/middleware/set-fastly-cache-headers.js +++ b/middleware/set-fastly-cache-headers.js @@ -1,4 +1,4 @@ -module.exports = (req, res, next) => { +module.exports = function setFastlyCacheHeaders (req, res, next) { // Disallow both Fastly AND the browser from caching HTML pages res.set({ 'surrogate-control': 'private, no-store', diff --git a/middleware/set-fastly-surrogate-key.js b/middleware/set-fastly-surrogate-key.js index 5ca1eda829..4912435c1a 100644 --- a/middleware/set-fastly-surrogate-key.js +++ b/middleware/set-fastly-surrogate-key.js @@ -1,4 +1,4 @@ -module.exports = (req, res, next) => { +module.exports = function setFastlySurrogateKey (req, res, next) { // Fastly provides a Soft Purge feature that allows you to mark content as outdated (stale) instead of permanently // purging and thereby deleting it from Fastly's caches. Objects invalidated with Soft Purge will be treated as // outdated (stale) while Fastly fetches a new version from origin. diff --git a/middleware/timeout.js b/middleware/timeout.js new file mode 100644 index 0000000000..b8190719ed --- /dev/null +++ b/middleware/timeout.js @@ -0,0 +1,27 @@ +const timeout = require('express-timeout-handler') + +// Heroku router requests timeout after 30 seconds. We should stop them earlier! +const maxRequestTimeout = parseInt(process.env.REQUEST_TIMEOUT, 10) || 25000 + +module.exports = timeout.handler({ + // Default timeout for all endpoints + // To override for a given router/endpoint, use `require('express-timeout-handler').set(...)` + timeout: maxRequestTimeout, + + // IMPORTANT: + // We cannot allow the middleware to disable the `res` object's methods like + // it does by default if we want to use `next` in the `onTimeout` handler! + disable: [], + + onTimeout: function (req, res, next) { + // Create a custom timeout error + const timeoutError = new Error('Request timed out') + timeoutError.statusCode = 503 + timeoutError.code = 'ETIMEDOUT' + + // Pass the error to our Express error handler for consolidated processing + return next(timeoutError) + } + + // Can also set an `onDelayedResponse` property IF AND ONLY IF you allow for disabling methods +}) diff --git a/middleware/trigger-error.js b/middleware/trigger-error.js index 74bacee0ab..271e523a38 100644 --- a/middleware/trigger-error.js +++ b/middleware/trigger-error.js @@ -1,6 +1,11 @@ // This module is for testing our handling of uncaught async rejections on incoming requests +// IMPORTANT: Leave this function as `async` even though it doesn't need to be! module.exports = async function triggerError (req, res, next) { + // IMPORTANT: + // Do NOT wrap this method's contents in the usual `try-catch+next(error)` + // pattern used on async middleware! This is an intentional omission! + // prevent this from being used in production if (process.env.NODE_ENV === 'production') return next() diff --git a/package-lock.json b/package-lock.json index 847d8365d3..f1fbcf0d12 100644 --- a/package-lock.json +++ b/package-lock.json @@ -5519,6 +5519,16 @@ } } }, + "adler-32": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/adler-32/-/adler-32-1.2.0.tgz", + "integrity": "sha1-aj5r8KY5ALoVZSgIyxXGgT0aXyU=", + "dev": true, + "requires": { + "exit-on-epipe": "~1.0.1", + "printj": "~1.1.0" + } + }, "agent-base": { "version": "5.1.1", "resolved": "https://registry.npmjs.org/agent-base/-/agent-base-5.1.1.tgz", @@ -7498,6 +7508,17 @@ "resolved": "https://registry.npmjs.org/ccount/-/ccount-1.0.5.tgz", "integrity": "sha512-MOli1W+nfbPLlKEhInaxhRdp7KVLFxLN5ykwzHgLsLI3H3gs5jjFAK4Eoj3OzzcxCtumDaI8onoVDeQyWaNTkw==" }, + "cfb": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/cfb/-/cfb-1.2.0.tgz", + "integrity": "sha512-sXMvHsKCICVR3Naq+J556K+ExBo9n50iKl6LGarlnvuA2035uMlGA/qVrc0wQtow5P1vJEw9UyrKLCbtIKz+TQ==", + "dev": true, + "requires": { + "adler-32": "~1.2.0", + "crc-32": "~1.2.0", + "printj": "~1.1.2" + } + }, "chalk": { "version": "4.1.0", "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.0.tgz", @@ -8568,6 +8589,16 @@ "integrity": "sha1-v1JMJWJrJPCMxUooWZzXH97Wt6k=", "dev": true }, + "crc-32": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/crc-32/-/crc-32-1.2.0.tgz", + "integrity": "sha512-1uBwHxF+Y/4yF5G48fwnKq6QsIXheor3ZLPT80yGBV1oEUwpPojlEhQbWKVw1VwcTQyMGHK1/XMmTjmlsmTTGA==", + "dev": true, + "requires": { + "exit-on-epipe": "~1.0.1", + "printj": "~1.1.0" + } + }, "create-ecdh": { "version": "4.0.3", "resolved": "https://registry.npmjs.org/create-ecdh/-/create-ecdh-4.0.3.tgz", @@ -10625,6 +10656,12 @@ "integrity": "sha1-BjJjj42HfMghB9MKD/8aF8uhzQw=", "dev": true }, + "exit-on-epipe": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/exit-on-epipe/-/exit-on-epipe-1.0.1.tgz", + "integrity": "sha512-h2z5mrROTxce56S+pnvAV890uu7ls7f1kEvVGJbw1OlFH3/mlJ5bkXu0KRyW94v37zzHPiUd55iLn3DA7TjWpw==", + "dev": true + }, "expand-brackets": { "version": "2.1.4", "resolved": "https://registry.npmjs.org/expand-brackets/-/expand-brackets-2.1.4.tgz", @@ -10914,6 +10951,11 @@ "resolved": "https://registry.npmjs.org/express-rate-limit/-/express-rate-limit-5.1.3.tgz", "integrity": "sha512-TINcxve5510pXj4n9/1AMupkj3iWxl3JuZaWhCdYDlZeoCPqweGZrxbrlqTCFb1CT5wli7s8e2SH/Qz2c9GorA==" }, + "express-timeout-handler": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/express-timeout-handler/-/express-timeout-handler-2.2.0.tgz", + "integrity": "sha512-Ae9M32r3T+RmrY1MGwBvyVjnzVo1iD4s0YQHgvJqzPlT0d4qS84pr87LHyiUtnD7qDQLMYw6rl2fhsgH4TH8aQ==" + }, "ext": { "version": "1.4.0", "resolved": "https://registry.npmjs.org/ext/-/ext-1.4.0.tgz", @@ -13338,6 +13380,12 @@ "integrity": "sha512-Hiyv+mXHfFEP7LzUL/llg9RwFxxY+o9N3JVLIeG5E7iFIFAalxvRU9UZthBdYDEVnzHMgjnKJPPpay5BWf1g9g==", "dev": true }, + "immediate": { + "version": "3.0.6", + "resolved": "https://registry.npmjs.org/immediate/-/immediate-3.0.6.tgz", + "integrity": "sha1-nbHb0Pr43m++D13V5Wu2BigN5ps=", + "dev": true + }, "import-fresh": { "version": "3.2.1", "resolved": "https://registry.npmjs.org/import-fresh/-/import-fresh-3.2.1.tgz", @@ -17768,6 +17816,18 @@ } } }, + "jszip": { + "version": "3.6.0", + "resolved": "https://registry.npmjs.org/jszip/-/jszip-3.6.0.tgz", + "integrity": "sha512-jgnQoG9LKnWO3mnVNBnfhkh0QknICd1FGSrXcgrl67zioyJ4wgx25o9ZqwNtrROSflGBCGYnJfjrIyRIby1OoQ==", + "dev": true, + "requires": { + "lie": "~3.3.0", + "pako": "~1.0.2", + "readable-stream": "~2.3.6", + "set-immediate-shim": "~1.0.1" + } + }, "keycode": { "version": "2.2.0", "resolved": "https://registry.npmjs.org/keycode/-/keycode-2.2.0.tgz", @@ -17832,6 +17892,15 @@ "type-check": "~0.3.2" } }, + "lie": { + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/lie/-/lie-3.3.0.tgz", + "integrity": "sha512-UaiMJzeWRlEujzAuw5LokY1L5ecNQYZKfmyZ9L7wDHb/p5etKaxXhohBcrw0EYby+G/NA52vRSN4N39dxHAIwQ==", + "dev": true, + "requires": { + "immediate": "~3.0.5" + } + }, "lines-and-columns": { "version": "1.1.6", "resolved": "https://registry.npmjs.org/lines-and-columns/-/lines-and-columns-1.1.6.tgz", @@ -20493,6 +20562,12 @@ "integrity": "sha512-16c7K+x4qVlJg9rEbXl7HEGmQyZlG4R9AgP+oHKRMsMsuk8s+ATStlf1NpDqyBI1HpVyfjLOeMhH2LvuNvV5Vg==", "dev": true }, + "printj": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/printj/-/printj-1.1.2.tgz", + "integrity": "sha512-zA2SmoLaxZyArQTOPj5LXecR+RagfPSU5Kw1qP+jkWeNlrq+eJZyY2oS68SU1Z/7/myXM4lo9716laOFAVStCQ==", + "dev": true + }, "private": { "version": "0.1.8", "resolved": "https://registry.npmjs.org/private/-/private-0.1.8.tgz", @@ -22031,6 +22106,12 @@ "resolved": "https://registry.npmjs.org/set-blocking/-/set-blocking-2.0.0.tgz", "integrity": "sha1-BF+XgtARrppoA93TgrJDkrPYkPc=" }, + "set-immediate-shim": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/set-immediate-shim/-/set-immediate-shim-1.0.1.tgz", + "integrity": "sha1-SysbJ+uAip+NzEgaWOXlb1mfP2E=", + "dev": true + }, "set-value": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/set-value/-/set-value-2.0.1.tgz", @@ -25201,6 +25282,26 @@ "xtend": "^4.0.0" } }, + "xlsx-populate": { + "version": "1.21.0", + "resolved": "https://registry.npmjs.org/xlsx-populate/-/xlsx-populate-1.21.0.tgz", + "integrity": "sha512-8v2Gm8BehXo6LU7KT802QoXTPkYY1SKk5V8g/UuYZnNB3JzXqud/P99Pxr2yXeKyt+sKlCatmidz6jQNie1hRw==", + "dev": true, + "requires": { + "cfb": "^1.1.3", + "jszip": "^3.2.2", + "lodash": "^4.17.15", + "sax": "^1.2.4" + }, + "dependencies": { + "sax": { + "version": "1.2.4", + "resolved": "https://registry.npmjs.org/sax/-/sax-1.2.4.tgz", + "integrity": "sha512-NqVDv9TpANUjFm0N8uM5GxL36UgKi9/atZw+x7YFnQ8ckwFGKrl4xX4yWtrey3UJm5nP1kUbnYgLopqWNSRhWw==", + "dev": true + } + } + }, "xml-name-validator": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/xml-name-validator/-/xml-name-validator-3.0.0.tgz", diff --git a/package.json b/package.json index 008ddf8da0..9543819557 100644 --- a/package.json +++ b/package.json @@ -43,6 +43,7 @@ "dotenv": "^8.2.0", "express": "^4.17.1", "express-rate-limit": "^5.1.3", + "express-timeout-handler": "^2.2.0", "flat": "^5.0.0", "github-slugger": "^1.2.1", "got": "^9.6.0", @@ -158,7 +159,8 @@ "supertest": "^4.0.2", "url-template": "^2.0.8", "webpack-dev-middleware": "^3.7.2", - "website-scraper": "^4.2.0" + "website-scraper": "^4.2.0", + "xlsx-populate": "^1.21.0" }, "scripts": { "start": "cross-env NODE_ENV=development ENABLED_LANGUAGES='en,ja' nodemon server.js", diff --git a/script/content-migrations/add-tags-to-articles.js b/script/content-migrations/add-tags-to-articles.js new file mode 100755 index 0000000000..e98e7fe172 --- /dev/null +++ b/script/content-migrations/add-tags-to-articles.js @@ -0,0 +1,62 @@ +#!/usr/bin/env node + +const fs = require('fs') +const path = require('path') +const XlsxPopulate = require('xlsx-populate') +const readFrontmatter = require('../../lib/read-frontmatter') + +const START_ROW = 2 + +// Load an existing workbook +XlsxPopulate.fromFileAsync('./SanitizedInformationArchitecture.xlsx') + .then(workbook => { + const sheet = workbook.sheet('New content architecture') + + for (let row = START_ROW; sheet.row(row).cell(1).value() !== undefined; row++) { + const pageUrl = sheet.row(row).cell(1).hyperlink() + // article, learning path, or category + const contentStructure = sheet.row(row).cell(2).value() + // comma-separated keywords + const topics = sheet.row(row).cell(5).value() + + // The spreadsheet cell sometimes contains the string "null" + if (!topics || topics === 'null') continue + + // enterprise admin article urls will always include enterprise-server@3.0 + let fileName = pageUrl.replace('https://docs.github.com/en', 'content') + .replace('enterprise-server@3.0', '') + + // Only category files use the index.md format + if (contentStructure === 'article' || contentStructure === 'learning path') { + fileName = fileName + '.md' + } else { + fileName = fileName + '/index.md' + } + + const topicsArray = topics.split(',').map(topic => topic.trim()) || [] + updateFrontmatter(path.join(process.cwd(), fileName), topicsArray) + } + }) + +function updateFrontmatter (filePath, newTopics) { + const articleContents = fs.readFileSync(filePath, 'utf8') + const { content, data } = readFrontmatter(articleContents) + + let topics = [] + if (typeof data.topics === 'string') { + topics = [data.topics] + } else if (Array.isArray(data.topics)) { + topics = topics.concat(data.topics) + } + + newTopics.forEach(topic => { + topics.push(topic) + }) + + // remove any duplicates + const uniqueTopics = [...new Set(topics)] + data.topics = uniqueTopics + + const newContents = readFrontmatter.stringify(content, data, { lineWidth: 10000 }) + fs.writeFileSync(filePath, newContents) +} diff --git a/script/early-access/clone-for-build.js b/script/early-access/clone-for-build.js index 6ba9fbebdb..6bf2cf239d 100755 --- a/script/early-access/clone-for-build.js +++ b/script/early-access/clone-for-build.js @@ -12,7 +12,7 @@ require('dotenv').config() const { DOCUBOT_REPO_PAT, HEROKU_PRODUCTION_APP, - GIT_BRANCH // Set by the deployer with the name of the docs-internal branch + GIT_BRANCH // Set by Actions and/or the deployer with the name of the docs-internal branch } = process.env // Exit if PAT is not found diff --git a/script/enterprise-server-releases/ghes-to-ghae-versioning.js b/script/enterprise-server-releases/ghes-to-ghae-versioning.js index 0813f03962..c497890d9d 100755 --- a/script/enterprise-server-releases/ghes-to-ghae-versioning.js +++ b/script/enterprise-server-releases/ghes-to-ghae-versioning.js @@ -14,7 +14,7 @@ const versionSatisfiesRange = require('../../lib/version-satisfies-range') // [start-readme] // // Run this script to add versions frontmatter and Liquid conditionals for -// GitHub AE, based on anything currently versioned for the provided release +// GitHub AE, based on anything currently versioned for the specified release // of Enterprise Server. This script should be run as part of the Enterprise // Server release process. // @@ -23,28 +23,23 @@ const versionSatisfiesRange = require('../../lib/version-satisfies-range') program .description('Add versions frontmatter and Liquid conditionals for GitHub AE based on a given Enterprise Server release. Runs on all content by default.') .option('-r, --ghes-release ', 'The Enterprise Server release to base AE versioning on. Example: 2.23') - .option('-p, --products [PRODUCT_IDS...]', 'List of space-separated product IDs. Example: admin github developers') - .option('-c, --currentServerReleases', 'Also add AE versioning to conditionals for current Enterprise Server releases.') - .option('-t, --translations', 'Run the script on content and data in translations, too.') + .option('-p, --products [OPTIONAL PRODUCT_IDS...]', 'Optional list of space-separated product IDs. Example: admin github developers') + .option('-t, --translations', 'Run the script on content and data in translations too.') .parse(process.argv) if (!program.ghesRelease) { - console.log('Must provide an Enterprise Server release number!') - process.exit() + console.error('Must provide an Enterprise Server release number!') + process.exit(1) } +console.log(`✅ Adding AE versioning based on GHES ${program.ghesRelease} versioning`) + if (program.products) { console.log(`✅ Running on the following products: ${program.products}`) } else { console.log('✅ Running on all products') } -if (program.currentServerReleases) { - console.log(`✅ Adding AE versioning based on GHES ${program.ghesRelease} versioning and all currently supported GHES versions`) -} else { - console.log(`✅ Adding AE versioning based only on GHES ${program.ghesRelease} versioning`) -} - if (program.translations) { console.log('✅ Running on both English and translated content and data\n') } else { @@ -54,17 +49,14 @@ if (program.translations) { // The new conditional to add const githubAEConditional = 'currentVersion == "github-ae@latest"' -// Existing conditionals to hook on (if program.currentServerReleases is true) -const notDotcomConditional = /currentVersion != "free-pro-team@latest" (or)?(?!and)/ -const allGHESVersionsConditional = /enterpriseServerVersions contains currentVersion (or)?/ - // Match: currentVersion "enterprise-server@(\d+\.\d+)" -const getEnterpriseServerConditional = new RegExp(`currentVersion (\\S+?) "${getEnterpriseServerNumber.source}"`) +// Example: currentVersion ver_gt "enterprise-server@2.21" +const enterpriseServerConditionalRegex = new RegExp(`currentVersion (\\S+?) "${getEnterpriseServerNumber.source}"`) console.log('Working...\n') const englishContentFiles = walkContent(contentPath) -const englishDataFiles = walkData(dataPath, englishContentFiles) +const englishDataFiles = walkData(dataPath) function walkContent (dirPath) { const products = program.products || [''] @@ -77,7 +69,7 @@ function walkContent (dirPath) { }).flat() } -function walkData (dirPath, contentFiles) { +function walkData (dirPath) { return walk(dirPath, { includeBasePath: true, directories: false }) .filter(file => file.includes('/data/reusables') || file.includes('/data/variables')) .filter(file => !file.endsWith('README.md')) @@ -86,7 +78,7 @@ function walkData (dirPath, contentFiles) { let allContentFiles, allDataFiles if (program.translations) { const translatedContentFiles = walkContent(translationsPath) - const translatedDataFiles = walkData(translationsPath, translatedContentFiles) + const translatedDataFiles = walkData(translationsPath) allContentFiles = englishContentFiles.concat(translatedContentFiles) allDataFiles = englishDataFiles.concat(translatedDataFiles) } else { @@ -101,16 +93,21 @@ const operators = { '==': '=' } +// Update the data files allDataFiles .forEach(file => { const dataContent = fs.readFileSync(file, 'utf8') + const conditionalsToUpdate = getConditionalsToUpdate(dataContent) + if (!conditionalsToUpdate.length) return + // Update Liquid in data files - const newDataContent = updateLiquid(dataContent, file) + const newDataContent = updateLiquid(conditionalsToUpdate, dataContent) fs.writeFileSync(file, newDataContent) }) +// Update the content files allContentFiles .forEach(file => { const { data, content } = frontmatter(fs.readFileSync(file, 'utf8')) @@ -118,63 +115,42 @@ allContentFiles // Return early if the current page frontmatter does not apply to either GHAE or the given GHES release if (!(data.versions['github-ae'] || versionSatisfiesRange(program.ghesRelease, data.versions['enterprise-server']))) return - // Add frontmatter version - data.versions['github-ae'] = '*' + const conditionalsToUpdate = getConditionalsToUpdate(content) + if (!conditionalsToUpdate.length) return // Update Liquid in content files - const newContent = updateLiquid(content, file) + const newContent = updateLiquid(conditionalsToUpdate, content) + + // Add frontmatter version + data.versions['github-ae'] = '*' // Update Liquid in frontmatter props Object.keys(data) .filter(key => typeof data[key] === 'string') .forEach(key => { - data[key] = updateLiquid(data[key], file) + const conditionalsToUpdate = getConditionalsToUpdate(data[key]) + if (!conditionalsToUpdate.length) return + data[key] = updateLiquid(conditionalsToUpdate, data[key]) }) fs.writeFileSync(file, frontmatter.stringify(newContent, data, { lineWidth: 10000 })) }) -function updateLiquid (content, file) { - // We need to match on all conditionals first because we have to do replacements _within_ conditionals +function getConditionalsToUpdate (content) { const allConditionals = content.match(/{% if .+?%}/g) - if (!allConditionals) return content + return (allConditionals || []) + .filter(conditional => !conditional.includes('github-ae')) + .filter(conditional => doesReleaseSatisfyConditional(conditional.match(enterpriseServerConditionalRegex))) +} + +function updateLiquid (conditionalsToUpdate, content) { let newContent = content - allConditionals.forEach(conditional => { - // Do not process a conditional that already includes github-ae - if (conditional.includes('github-ae')) return - + conditionalsToUpdate.forEach(conditional => { let newConditional = conditional - // Example match: currentVersion ver_gt "enterprise-server@2.21" - const enterpriseServerMatch = newConditional.match(getEnterpriseServerConditional) - - // Add AE conditional to any `currentVersion != "free-pro-team@latest"` - if (program.currentServerReleases && newConditional.match(notDotcomConditional)) { - if (enterpriseServerMatch && !doesReleaseSatisfyConditional(enterpriseServerMatch)) return - - newConditional = newConditional.replace(/( ?)%}/, `$1or ${githubAEConditional} %}`) - newContent = newContent.replace(conditional, newConditional) - return - } - - // Add AE conditional to any `enterpriseServerVersions contains currentVersion` - if (program.currentServerReleases && newConditional.match(allGHESVersionsConditional)) { - if (enterpriseServerMatch && !doesReleaseSatisfyConditional(enterpriseServerMatch)) return - - newConditional = newConditional.replace(/( ?)%}/, `$1or ${githubAEConditional} %}`) - newContent = newContent.replace(conditional, newConditional) - return - } - - // Add AE conditional to any conditional that applies to enterprise-server@ - if (!enterpriseServerMatch) return - - const releaseSatisfiesConditional = doesReleaseSatisfyConditional(enterpriseServerMatch) - - // Return early if the conditional does not apply to the given GHES release - if (!releaseSatisfiesConditional) return + const enterpriseServerMatch = conditional.match(enterpriseServerConditionalRegex) // First do the replacement within the conditional // Old: {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %} @@ -191,6 +167,8 @@ function updateLiquid (content, file) { console.log('Done!') function doesReleaseSatisfyConditional (enterpriseServerMatch) { + if (!enterpriseServerMatch) return + // Example liquid operator: ver_gt const liquidOperator = enterpriseServerMatch[1] diff --git a/script/fix-translation-errors.js b/script/fix-translation-errors.js index ea3ee1af5d..7d5d5cdc31 100644 --- a/script/fix-translation-errors.js +++ b/script/fix-translation-errors.js @@ -2,6 +2,7 @@ const { execSync } = require('child_process') const { get, set } = require('lodash') const fs = require('fs') const path = require('path') +const readFileAsync = require('../lib/readfile-async') const fm = require('../lib/frontmatter') const matter = require('gray-matter') const chalk = require('chalk') @@ -23,7 +24,7 @@ const fixableYmlProps = ['date'] const loadAndValidateContent = async (path, schema) => { let fileContents try { - fileContents = await fs.promises.readFile(path, 'utf8') + fileContents = await readFileAsync(path, 'utf8') } catch (e) { console.error(e.message) return null diff --git a/script/rest/update-files.js b/script/rest/update-files.js index 8b42275334..ee1fe72985 100755 --- a/script/rest/update-files.js +++ b/script/rest/update-files.js @@ -91,17 +91,23 @@ async function decorate () { }, {}) for (const [schemaName, schema] of Object.entries(dereferencedSchemas)) { - // munge OpenAPI definitions object in an array of operations objects - const operations = await getOperations(schema) + try { + // munge OpenAPI definitions object in an array of operations objects + const operations = await getOperations(schema) - // process each operation, asynchronously rendering markdown and stuff - await Promise.all(operations.map(operation => operation.process())) + // process each operation, asynchronously rendering markdown and stuff + await Promise.all(operations.map(operation => operation.process())) - const filename = path.join(decoratedPath, `${schemaName}.json`) - .replace('.deref', '') - // write processed operations to disk - fs.writeFileSync(filename, JSON.stringify(operations, null, 2)) + const filename = path.join(decoratedPath, `${schemaName}.json`) + .replace('.deref', '') + // write processed operations to disk + fs.writeFileSync(filename, JSON.stringify(operations, null, 2)) - console.log('Wrote', path.relative(process.cwd(), filename)) + console.log('Wrote', path.relative(process.cwd(), filename)) + } catch (error) { + console.error(error) + console.log('🐛 Whoops! It looks like the decorator script wasn\'t able to parse the dereferenced schema. A recent change may not yet be supported by the decorator. Please reach out in the #docs-engineering slack channel for help.') + process.exit(1) + } } } diff --git a/script/rest/utils/create-code-samples.js b/script/rest/utils/create-code-samples.js index ddb1d7bf6c..3ff74cc4a3 100644 --- a/script/rest/utils/create-code-samples.js +++ b/script/rest/utils/create-code-samples.js @@ -1,6 +1,5 @@ module.exports = createCodeSamples -const { URL } = require('url') const urlTemplate = require('url-template') const { stringify } = require('javascript-stringify') const { get, mapValues, snakeCase } = require('lodash') @@ -45,7 +44,7 @@ function toShellExample ({ route, serverUrl }) { const args = [ method !== 'GET' && `-X ${method}`, defaultAcceptHeader ? `-H "Accept: ${defaultAcceptHeader}"` : '', - new URL(path, serverUrl).href, + `${serverUrl}${path}`, Object.keys(params).length && `-d '${JSON.stringify(params)}'` ].filter(Boolean) return `curl \\\n ${args.join(' \\\n ')}` @@ -114,15 +113,18 @@ function getExampleBodyParams ({ operation }) { return { [paramName]: getExampleParamValue(paramName, schema) } } - if (schema.oneOf) { + if (schema.oneOf && schema.oneOf[0].type) { schema = schema.oneOf[0] } + const props = schema.required && schema.required.length > 0 ? schema.required : Object.keys(schema.properties).slice(0, 1) + return props.reduce((dict, propName) => { const propSchema = schema.properties[propName] + if (!propSchema.deprecated) { dict[propName] = getExampleParamValue(propName, propSchema) } @@ -137,8 +139,8 @@ function getExampleParamValue (name, schema) { } // TODO: figure out the right behavior here - if (schema.oneOf) return getExampleParamValue(name, schema.oneOf[0]) - if (schema.anyOf) return getExampleParamValue(name, schema.anyOf[0]) + if (schema.oneOf && schema.oneOf[0].type) return getExampleParamValue(name, schema.oneOf[0]) + if (schema.anyOf && schema.anyOf[0].type) return getExampleParamValue(name, schema.anyOf[0]) switch (schema.type) { case 'string': diff --git a/script/rest/utils/get-operations.js b/script/rest/utils/get-operations.js index 37b2fe61c8..dd408e87b2 100644 --- a/script/rest/utils/get-operations.js +++ b/script/rest/utils/get-operations.js @@ -10,8 +10,7 @@ module.exports = async function getOperations (schema) { for (const [requestPath, operationsAtPath] of Object.entries(schema.paths)) { for (const [verb, props] of Object.entries(operationsAtPath)) { const serverUrl = schema.servers[0].url - .replace('{protocol}', 'https') - .replace('{hostname}', 'api.github.com') + .replace('{protocol}', 'http(s)') const operation = new Operation(verb, requestPath, props, serverUrl) operations.push(operation) } diff --git a/script/update-internal-links.js b/script/update-internal-links.js new file mode 100755 index 0000000000..2089937bec --- /dev/null +++ b/script/update-internal-links.js @@ -0,0 +1,197 @@ +#!/usr/bin/env node + +const fs = require('fs') +const walk = require('walk-sync') +const path = require('path') +const astFromMarkdown = require('mdast-util-from-markdown') +const visit = require('unist-util-visit') +const { loadPages, loadPageMap } = require('../lib/pages') +const loadSiteData = require('../lib/site-data') +const loadRedirects = require('../lib/redirects/precompile') +const { getPathWithoutLanguage, getPathWithoutVersion } = require('../lib/path-utils') +const allVersions = Object.keys(require('../lib/all-versions')) +const frontmatter = require('../lib/read-frontmatter') +const renderContent = require('../lib/render-content') +const patterns = require('../lib/patterns') + +const walkFiles = (pathToWalk) => { + return walk(path.posix.join(__dirname, '..', pathToWalk), { includeBasePath: true, directories: false }) + .filter(file => file.endsWith('.md') && !file.endsWith('README.md')) + .filter(file => !file.includes('/early-access/')) // ignore EA for now +} + +const allFiles = walkFiles('content').concat(walkFiles('data')) + +// The script will throw an error if it finds any markup not represented here. +// Hacky but it captures the current rare edge cases. +const linkInlineMarkup = { + emphasis: '*', + strong: '**' +} + +const currentVersionWithSpacesRegex = /\/enterprise\/{{ currentVersion }}/g +const currentVersionWithoutSpaces = '/enterprise/{{currentVersion}}' + +// [start-readme] +// +// Run this script to find internal links in all content and data Markdown files, check if either the title or link +// (or both) are outdated, and automatically update them if so. +// +// Exceptions: +// * Links with fragments (e.g., [Bar](/foo#bar)) will get their root links updated if necessary, but the fragment +// and title will be unchanged (e.g., [Bar](/noo#bar)). +// * Links with hardcoded versions (e.g., [Foo](/enterprise-server/baz)) will get their root links updated if +// necessary, but the hardcoded versions will be preserved (e.g., [Foo](/enterprise-server/qux)). +// * Links with Liquid in the titles will have their root links updated if necessary, but the titles will be preserved. +// +// [end-readme] + +main() + +async function main () { + console.log('Working...') + const pageList = await loadPages() + const pageMap = await loadPageMap(pageList) + const redirects = await loadRedirects(pageList) + const site = await loadSiteData() + + const context = { + pages: pageMap, + redirects, + site: site.en.site, + currentLanguage: 'en' + } + + for (const file of allFiles) { + const { data, content } = frontmatter(fs.readFileSync(file, 'utf8')) + let newContent = content + + // Do a blanket find-replace for /enterprise/{{ currentVersion }}/ to /enterprise/{{currentVersion}}/ + // so that the AST parser recognizes the link as a link node. The spaces prevent it from doing so. + newContent = newContent.replace(currentVersionWithSpacesRegex, currentVersionWithoutSpaces) + + const ast = astFromMarkdown(newContent) + + // We can't do async functions within visit, so gather the nodes upfront + const nodesPerFile = [] + + visit(ast, node => { + if (node.type !== 'link') return + if (!node.url.startsWith('/')) return + if (node.url.startsWith('/assets')) return + if (node.url.startsWith('/public')) return + if (node.url.includes('/11.10.340/')) return + if (node.url.includes('/2.1/')) return + if (node.url === '/') return + + nodesPerFile.push(node) + }) + + // For every Markdown link... + for (const node of nodesPerFile) { + const oldLink = node.url + + // Find and preserve any inline markup in link titles, like [*Foo*](/foo) + let inlineMarkup = '' + if (node.children[0].children) { + inlineMarkup = linkInlineMarkup[node.children[0].type] + + if (!inlineMarkup) { + console.error(`Cannot find an inline markup entry for ${node.children[0].type}!`) + process.exit(1) + } + } + + const oldTitle = node.children[0].value || node.children[0].children[0].value + const oldMarkdownLink = `[${inlineMarkup}${oldTitle}${inlineMarkup}](${oldLink})` + + // As a blanket rule, only update titles in links that begin with quotes. (Many links + // have punctuation before the closing quotes, so we'll only check for opening quotes.) + // Update: "[Foo](/foo) + // Do not update: [Bar](/bar) + const hasQuotesAroundLink = newContent.includes(`"${oldMarkdownLink}`) + + let foundPage, fragmentMatch, versionMatch + + // Run through all supported versions... + for (const version of allVersions) { + context.currentVersion = version + // Render the link for each version using the renderContent pipeline, which includes the rewrite-local-links plugin. + const $ = await renderContent(oldMarkdownLink, context, { cheerioObject: true }) + let linkToCheck = $('a').attr('href') + + // We need to preserve fragments and hardcoded versions if any are found. + fragmentMatch = oldLink.match(/(#.*$)/) + versionMatch = oldLink.match(/(enterprise-server(?:@.[^/]*?)?)\//) + + // Remove the fragment for now. + linkToCheck = linkToCheck + .replace(/#.*$/, '') + .replace(patterns.trailingSlash, '$1') + + // Try to find the rendered link in the set of pages! + foundPage = findPage(linkToCheck, pageMap, redirects) + + // Once a page is found for a particular version, exit immediately; we don't need to check the other versions + // because all we care about is the page title and path. + if (foundPage) { + break + } + } + + if (!foundPage) { + console.error(`Can't find link in pageMap! ${oldLink} in ${file.replace(process.cwd(), '')}`) + process.exit(1) + } + + // If the original link includes a fragment OR the original title includes Liquid, do not change; + // otherwise, use the found page title. (We don't want to update the title if a fragment is found because + // the title likely points to the fragment section header, not the page title.) + const newTitle = fragmentMatch || oldTitle.includes('{%') || !hasQuotesAroundLink ? oldTitle : foundPage.title + + // If the original link includes a fragment, append it to the found page path. + // Also remove the language code because Markdown links don't include language codes. + let newLink = getPathWithoutLanguage(fragmentMatch ? foundPage.path + fragmentMatch[1] : foundPage.path) + + // If the original link includes a hardcoded version, preserve it; otherwise, remove versioning + // because Markdown links don't include versioning. + newLink = versionMatch ? `/${versionMatch[1]}${getPathWithoutVersion(newLink)}` : getPathWithoutVersion(newLink) + + let newMarkdownLink = `[${inlineMarkup}${newTitle}${inlineMarkup}](${newLink})` + + // Handle a few misplaced quotation marks. + if (oldMarkdownLink.includes('["')) { + newMarkdownLink = `"${newMarkdownLink}` + } + + // Stream the results to console as we find them. + if (oldMarkdownLink !== newMarkdownLink) { + console.log('old link', oldMarkdownLink) + console.log('new link', newMarkdownLink) + console.log('-------') + } + + newContent = newContent.replace(oldMarkdownLink, newMarkdownLink) + } + + fs.writeFileSync(file, frontmatter.stringify(newContent, data, { lineWidth: 10000 })) + } + + console.log('Done!') +} + +function findPage (tryPath, pageMap, redirects) { + if (pageMap[tryPath]) { + return { + title: pageMap[tryPath].title, + path: tryPath + } + } + + if (pageMap[redirects[tryPath]]) { + return { + title: pageMap[redirects[tryPath]].title, + path: redirects[tryPath] + } + } +} diff --git a/server.js b/server.js index b26751cbaa..26417bd285 100644 --- a/server.js +++ b/server.js @@ -1,3 +1,5 @@ +require('dotenv').config() + require('./lib/check-node-version') require('./lib/handle-exceptions') require('./lib/feature-flags') diff --git a/stylesheets/overrides.scss b/stylesheets/overrides.scss index ec003fd721..5657740df5 100644 --- a/stylesheets/overrides.scss +++ b/stylesheets/overrides.scss @@ -65,7 +65,7 @@ color: $text-gray-dark; } -.product-callout p { +.product-callout p, .contributor-callout p { margin: 0; } @@ -172,3 +172,12 @@ pre .bluebox { fill: $white; } } + +.markdown-body li img { + max-width: calc(100% - 32px); +} + +.markdown-body img { + max-height: 600px; +} + diff --git a/tests/content/category-pages.js b/tests/content/category-pages.js index cc9febf9c3..8db57821a6 100644 --- a/tests/content/category-pages.js +++ b/tests/content/category-pages.js @@ -5,6 +5,7 @@ const matter = require('../../lib/read-frontmatter') const { zip, difference } = require('lodash') const GithubSlugger = require('github-slugger') const { XmlEntities } = require('html-entities') +const readFileAsync = require('../../lib/readfile-async') const loadSiteData = require('../../lib/site-data') const renderContent = require('../../lib/render-content') const getApplicableVersions = require('../../lib/get-applicable-versions') @@ -72,7 +73,7 @@ describe('category pages', () => { const categoryDir = path.dirname(indexAbsPath) // Get child article links included in each subdir's index page - const indexContents = await fs.promises.readFile(indexAbsPath, 'utf8') + const indexContents = await readFileAsync(indexAbsPath, 'utf8') const { data, content } = matter(indexContents) categoryVersions = getApplicableVersions(data.versions, indexAbsPath) const articleLinks = getLinks(content) @@ -83,7 +84,7 @@ describe('category pages', () => { publishedArticlePaths = (await Promise.all( articleLinks.map(async (articleLink) => { const articlePath = getPath(productDir, indexLink, articleLink) - const articleContents = await fs.promises.readFile(articlePath, 'utf8') + const articleContents = await readFileAsync(articlePath, 'utf8') const { data } = matter(articleContents) // Do not include map topics in list of published articles @@ -101,7 +102,7 @@ describe('category pages', () => { availableArticlePaths = (await Promise.all( childFilePaths.map(async (articlePath) => { - const articleContents = await fs.promises.readFile(articlePath, 'utf8') + const articleContents = await readFileAsync(articlePath, 'utf8') const { data } = matter(articleContents) // Do not include map topics nor hidden pages in list of available articles @@ -114,7 +115,7 @@ describe('category pages', () => { await Promise.all( childFilePaths.map(async (articlePath) => { - const articleContents = await fs.promises.readFile(articlePath, 'utf8') + const articleContents = await readFileAsync(articlePath, 'utf8') const { data } = matter(articleContents) articleVersions[articlePath] = getApplicableVersions(data.versions, articlePath) diff --git a/tests/content/lint-files.js b/tests/content/lint-files.js index 56fb2a85e7..e5d899ac82 100644 --- a/tests/content/lint-files.js +++ b/tests/content/lint-files.js @@ -1,12 +1,12 @@ const path = require('path') const slash = require('slash') -const fs = require('fs') const walk = require('walk-sync') const { zip, groupBy } = require('lodash') const yaml = require('js-yaml') const revalidator = require('revalidator') const generateMarkdownAST = require('mdast-util-from-markdown') const visit = require('unist-util-visit') +const readFileAsync = require('../../lib/readfile-async') const frontmatter = require('../../lib/frontmatter') const languages = require('../../lib/languages') const { tags } = require('../../lib/liquid-tags/extended-markdown') @@ -250,7 +250,7 @@ describe('lint markdown content', () => { let content, ast, links, isHidden, isEarlyAccess, isSitePolicy, frontmatterErrors, frontmatterData beforeAll(async () => { - const fileContents = await fs.promises.readFile(markdownAbsPath, 'utf8') + const fileContents = await readFileAsync(markdownAbsPath, 'utf8') const { data, content: bodyContent, errors } = frontmatter(fileContents) content = bodyContent @@ -417,7 +417,7 @@ describe('lint yaml content', () => { let dictionary, isEarlyAccess beforeAll(async () => { - const fileContents = await fs.promises.readFile(yamlAbsPath, 'utf8') + const fileContents = await readFileAsync(yamlAbsPath, 'utf8') dictionary = yaml.safeLoad(fileContents, { filename: yamlRelPath }) isEarlyAccess = yamlRelPath.split('/').includes('early-access') @@ -606,7 +606,7 @@ describe('lint release notes', () => { let dictionary beforeAll(async () => { - const fileContents = await fs.promises.readFile(yamlAbsPath, 'utf8') + const fileContents = await readFileAsync(yamlAbsPath, 'utf8') dictionary = yaml.safeLoad(fileContents, { filename: yamlRelPath }) }) diff --git a/tests/content/liquid-line-breaks.js b/tests/content/liquid-line-breaks.js index a675e52639..6f7eaaaff1 100644 --- a/tests/content/liquid-line-breaks.js +++ b/tests/content/liquid-line-breaks.js @@ -1,9 +1,9 @@ const path = require('path') -const fs = require('fs') const walk = require('walk-sync') const matter = require('../../lib/read-frontmatter') const { zip } = require('lodash') const yaml = require('js-yaml') +const readFileAsync = require('../../lib/readfile-async') const rootDir = path.join(__dirname, '../..') const contentDir = path.join(rootDir, 'content') @@ -52,7 +52,7 @@ describe('Liquid references', () => { test.each([...contentMarkdownTuples, ...reusableMarkdownTuples])( 'in "%s"', async (markdownRelPath, markdownAbsPath) => { - const fileContents = await fs.promises.readFile(markdownAbsPath, 'utf8') + const fileContents = await readFileAsync(markdownAbsPath, 'utf8') const { content } = matter(fileContents) const matches = (content.match(liquidRefsWithLinkBreaksRegex) || []) @@ -75,7 +75,7 @@ describe('Liquid references', () => { test.each(variableYamlTuples)( 'in "%s"', async (yamlRelPath, yamlAbsPath) => { - const fileContents = await fs.promises.readFile(yamlAbsPath, 'utf8') + const fileContents = await readFileAsync(yamlAbsPath, 'utf8') const dictionary = yaml.safeLoad(fileContents, { filename: yamlRelPath }) const matches = [] diff --git a/tests/content/remove-liquid-statements.js b/tests/content/remove-liquid-statements.js index f94dd5ae5c..a7ba5ed1db 100644 --- a/tests/content/remove-liquid-statements.js +++ b/tests/content/remove-liquid-statements.js @@ -1,7 +1,7 @@ -const fs = require('fs').promises const path = require('path') const cheerio = require('cheerio') const matter = require('gray-matter') +const readFileAsync = require('../../lib/readfile-async') const removeLiquidStatements = require('../../lib/remove-liquid-statements') const removeDeprecatedFrontmatter = require('../../lib/remove-deprecated-frontmatter') const removeLiquidStatementsFixtures = path.join(__dirname, '../fixtures/remove-liquid-statements') @@ -36,7 +36,7 @@ function processFrontmatter (contents, file) { describe('removing liquid statements only', () => { test('removes liquid statements that specify "greater than version to deprecate"', async () => { - let contents = await fs.readFile(greaterThan, 'utf8') + let contents = await readFileAsync(greaterThan, 'utf8') contents = removeLiquidStatements(contents, versionToDeprecate, nextOldestVersion) const $ = cheerio.load(contents) expect($('.example1').text().trim()).toBe('Alpha') @@ -58,7 +58,7 @@ Alpha\n\n{% else %}\n\nBravo\n\n{% if currentVersion ver_gt "enterprise-server@2 }) test('removes liquid statements that specify "and greater than version to deprecate"', async () => { - let contents = await fs.readFile(andGreaterThan1, 'utf8') + let contents = await readFileAsync(andGreaterThan1, 'utf8') contents = removeLiquidStatements(contents, versionToDeprecate, nextOldestVersion) const $ = cheerio.load(contents) expect($('.example1').text().trim()).toBe('{% if currentVersion != "free-pro-team@latest" %}\n\nAlpha\n\n{% endif %}') @@ -72,7 +72,7 @@ Alpha\n\n{% if currentVersion ver_gt "enterprise-server@2.16" %}\n\nBravo\n\n{% }) test('removes liquid statements that specify "and greater than version to deprecate" (alternate format)', async () => { - let contents = await fs.readFile(andGreaterThan2, 'utf8') + let contents = await readFileAsync(andGreaterThan2, 'utf8') contents = removeLiquidStatements(contents, versionToDeprecate, nextOldestVersion) const $ = cheerio.load(contents) expect($('.example1').text().trim()).toBe('{% if currentVersion ver_lt "enterprise-server@2.16" %}\n\nAlpha\n\n{% endif %}') @@ -86,7 +86,7 @@ Alpha\n\n{% if currentVersion != "free-pro-team@latest" %}\n\nBravo\n\n{% endif }) test('removes liquid statements that specify "not equals version to deprecate"', async () => { - let contents = await fs.readFile(notEquals, 'utf8') + let contents = await readFileAsync(notEquals, 'utf8') contents = removeLiquidStatements(contents, versionToDeprecate, nextOldestVersion) const $ = cheerio.load(contents) expect($('.example1').text().trim()).toBe('Alpha') @@ -104,7 +104,7 @@ Alpha\n\n{% endif %}`) describe('removing liquid statements and content', () => { test('removes interior content and liquid statements that specify "equals version to deprecate"', async () => { - let contents = await fs.readFile(equals, 'utf8') + let contents = await readFileAsync(equals, 'utf8') contents = removeLiquidStatements(contents, versionToDeprecate, nextOldestVersion) const $ = cheerio.load(contents) expect($('.example1').text().trim()).toBe('') @@ -118,7 +118,7 @@ Alpha\n\n{% else %}\n\nCharlie\n\n{% endif %}`) }) test('removes interior content and liquid statements that specify "less than next oldest than version to deprecate"', async () => { - let contents = await fs.readFile(lessThanNextOldest, 'utf8') + let contents = await readFileAsync(lessThanNextOldest, 'utf8') contents = removeLiquidStatements(contents, versionToDeprecate, nextOldestVersion) const $ = cheerio.load(contents) expect($('.example1').text().trim()).toBe('Alpha') @@ -138,7 +138,7 @@ Charlie\n\n{% else %}\n\nDelta\n\n{% endif %}\n\nEcho`) describe('updating frontmatter', () => { test('updates frontmatter versions Enterprise if set to greater-than-or-equal-to version to deprecate', async () => { - let contents = await fs.readFile(frontmatter1, 'utf8') + let contents = await readFileAsync(frontmatter1, 'utf8') contents = processFrontmatter(contents, frontmatter1) const $ = cheerio.load(contents) // console.log('foo') @@ -148,7 +148,7 @@ describe('updating frontmatter', () => { }) test('updates frontmatter versions Enterprise if set to greater-than-or-equal-to next oldest version', async () => { - let contents = await fs.readFile(frontmatter2, 'utf8') + let contents = await readFileAsync(frontmatter2, 'utf8') contents = processFrontmatter(contents, frontmatter2) const $ = cheerio.load(contents) expect($.text().includes('enterprise-server: \'*\'')).toBe(true) @@ -158,7 +158,7 @@ describe('updating frontmatter', () => { describe('whitespace', () => { test('does not add newlines when whitespace control is used', async () => { - let contents = await fs.readFile(whitespace, 'utf8') + let contents = await readFileAsync(whitespace, 'utf8') contents = removeLiquidStatements(contents, versionToDeprecate, nextOldestVersion) const $ = cheerio.load(contents) expect($('.example1').text()).toBe('\n Alpha\n') @@ -168,7 +168,7 @@ describe('whitespace', () => { }) test('does not add newlines when no newlines are present', async () => { - let contents = await fs.readFile(whitespace, 'utf8') + let contents = await readFileAsync(whitespace, 'utf8') contents = removeLiquidStatements(contents, versionToDeprecate, nextOldestVersion) const $ = cheerio.load(contents) expect($('.example5').text()).toBe('\n Alpha\n') diff --git a/tests/content/site-data-references.js b/tests/content/site-data-references.js index 9f8fa6b9ab..0b56d8f69a 100644 --- a/tests/content/site-data-references.js +++ b/tests/content/site-data-references.js @@ -5,6 +5,7 @@ const getDataReferences = require('../../lib/get-liquid-data-references') const frontmatter = require('../../lib/read-frontmatter') const fs = require('fs').promises const path = require('path') +const readFileAsync = require('../../lib/readfile-async') describe('data references', () => { jest.setTimeout(60 * 1000) @@ -41,7 +42,7 @@ describe('data references', () => { await Promise.all(pages.map(async page => { const metadataFile = path.join('content', page.relativePath) - const fileContents = await fs.readFile(path.join(__dirname, '../..', metadataFile)) + const fileContents = await readFileAsync(path.join(__dirname, '../..', metadataFile)) const { data: metadata } = frontmatter(fileContents, { filepath: page.fullPath }) const metadataRefs = getDataReferences(JSON.stringify(metadata)) metadataRefs.forEach(key => { diff --git a/tests/fixtures/page-versioned-for-ghae-next.md b/tests/fixtures/page-versioned-for-ghae-next.md new file mode 100644 index 0000000000..7829f629ad --- /dev/null +++ b/tests/fixtures/page-versioned-for-ghae-next.md @@ -0,0 +1,5 @@ +--- +title: Page versioned for next GitHub AE release +versions: + github-ae: 'next' +--- diff --git a/tests/fixtures/page-versioned-for-next-enterprise-release.md b/tests/fixtures/page-versioned-for-next-enterprise-release.md new file mode 100644 index 0000000000..46a30ad849 --- /dev/null +++ b/tests/fixtures/page-versioned-for-next-enterprise-release.md @@ -0,0 +1,5 @@ +--- +title: Page versioned for next Enterprise release +versions: + enterprise-server: '>=3.1' +--- diff --git a/tests/graphql/build-changelog-test.js b/tests/graphql/build-changelog-test.js index 4620d4aeee..d0fb0a6625 100644 --- a/tests/graphql/build-changelog-test.js +++ b/tests/graphql/build-changelog-test.js @@ -2,6 +2,7 @@ const yaml = require('js-yaml') const { createChangelogEntry, cleanPreviewTitle, previewAnchor, prependDatedEntry } = require('../../script/graphql/build-changelog') const fs = require('fs').promises const MockDate = require('mockdate') +const readFileAsync = require('../../lib/readfile-async') const expectedChangelogEntry = require('../fixtures/changelog-entry') const expectedUpdatedChangelogFile = require('../fixtures/updated-changelog-file') @@ -113,14 +114,14 @@ describe('updating the changelog file', () => { it('modifies the entry object and the file on disk', async () => { const testTargetPath = 'tests/graphql/example_changelog.json' - const previousContents = await fs.readFile(testTargetPath) + const previousContents = await readFileAsync(testTargetPath) const exampleEntry = { someStuff: true } const expectedDate = '2020-11-20' MockDate.set(expectedDate) prependDatedEntry(exampleEntry, testTargetPath) - const newContents = await fs.readFile(testTargetPath, 'utf8') + const newContents = await readFileAsync(testTargetPath, 'utf8') // reset the file: await fs.writeFile(testTargetPath, previousContents) diff --git a/tests/meta/repository-references.js b/tests/meta/repository-references.js index e9ffef4a84..d8571239ab 100644 --- a/tests/meta/repository-references.js +++ b/tests/meta/repository-references.js @@ -1,5 +1,5 @@ const walkSync = require('walk-sync') -const fs = require('fs').promises +const readFileAsync = require('../../lib/readfile-async') const REPO_REGEXP = /\/\/github\.com\/github\/(?!docs[/'"\n])([\w-.]+)/gi @@ -31,10 +31,16 @@ const ALLOW_LIST = new Set([ 'rest-api-description', 'smimesign', 'tweetsodium', - 'choosealicense.com' + 'choosealicense.com', + 'renaming' ]) describe('check for repository references', () => { + // This tests exists to make sure we don't reference private GitHub owned repositories + // in our open-soure repository. If this is failing, and the repo is public, + // feel free to add it to the list above. Or if the feature requires referencing an + // internal repo, add the feature to the ignore list below. + const filenames = walkSync(process.cwd(), { directories: false, ignore: [ @@ -55,7 +61,7 @@ describe('check for repository references', () => { }) test.each(filenames)('in file %s', async (filename) => { - const file = await fs.readFile(filename, 'utf8') + const file = await readFileAsync(filename, 'utf8') const matches = Array.from(file.matchAll(REPO_REGEXP)) .map(([, repoName]) => repoName) .filter(repoName => !ALLOW_LIST.has(repoName)) diff --git a/tests/rendering/breadcrumbs.js b/tests/rendering/breadcrumbs.js index 81f4249207..b95fe1b0cd 100644 --- a/tests/rendering/breadcrumbs.js +++ b/tests/rendering/breadcrumbs.js @@ -49,13 +49,13 @@ describe('breadcrumbs', () => { }) test('English breadcrumbs link to English pages', async () => { - const $ = await getDOM('/en/github/getting-started-with-github') + const $ = await getDOM('/en/github/setting-up-and-managing-your-github-user-account') const $breadcrumbs = $('.breadcrumbs a') expect($breadcrumbs.eq(0).attr('href')).toBe('/en/github') }) test('localized breadcrumbs link to localize pages', async () => { - const $ = await getDOM('/ja/github/getting-started-with-github') + const $ = await getDOM('/ja/github/setting-up-and-managing-your-github-user-account') const $breadcrumbs = $('.breadcrumbs a') expect($breadcrumbs.eq(0).attr('href')).toBe('/ja/github') }) diff --git a/tests/rendering/server.js b/tests/rendering/server.js index c9cabb77d0..7b7e316c30 100644 --- a/tests/rendering/server.js +++ b/tests/rendering/server.js @@ -756,15 +756,15 @@ describe('static routes', () => { }) describe('index pages', () => { - const nonEnterpriseOnlyPath = '/en/github/getting-started-with-github/verifying-your-email-address' + const nonEnterpriseOnlyPath = '/en/github/setting-up-and-managing-your-github-user-account/managing-user-account-settings' test('includes dotcom-only links in dotcom TOC', async () => { - const $ = await getDOM('/en/github/getting-started-with-github') + const $ = await getDOM('/en/github/setting-up-and-managing-your-github-user-account') expect($(`article a[href="${nonEnterpriseOnlyPath}"]`).length).toBe(1) }) test('excludes dotcom-only from GHE TOC', async () => { - const $ = await getDOM(`/en/enterprise/${enterpriseServerReleases.latest}/user/github/getting-started-with-github`) + const $ = await getDOM(`/en/enterprise/${enterpriseServerReleases.latest}/user/github/setting-up-and-managing-your-github-user-account`) expect($(`a[href="${nonEnterpriseOnlyPath}"]`).length).toBe(0) }) diff --git a/tests/routing/redirects.js b/tests/routing/redirects.js index 90178cc663..e3614da787 100644 --- a/tests/routing/redirects.js +++ b/tests/routing/redirects.js @@ -159,6 +159,12 @@ describe('redirects', () => { expect(res.statusCode).toBe(301) expect(res.headers.location).toBe(japaneseEnterpriseHome) }) + + test('hardcoded @latest redirects to latest version', async () => { + const res = await get('/en/enterprise-server@latest') + expect(res.statusCode).toBe(301) + expect(res.headers.location).toBe(enterpriseHome) + }) }) describe('2.13+ deprecated enterprise', () => { diff --git a/tests/unit/page.js b/tests/unit/page.js index 3843e0abd7..988b278426 100644 --- a/tests/unit/page.js +++ b/tests/unit/page.js @@ -190,6 +190,36 @@ describe('Page class', () => { expect($.text()).not.toBe('This text should render on any actively supported version of Enterprise Server') expect($.text()).toBe('This text should only render on non-Enterprise') }) + + test('support next to-be-released Enterprise Server version in frontmatter', async () => { + // This fixture has `enterprise-server: '>=3.1'` hardcoded in the frontmatter + const page = await Page.init({ + relativePath: 'page-versioned-for-next-enterprise-release.md', + basePath: path.join(__dirname, '../fixtures'), + languageCode: 'en' + }) + // set version to 3.0 + const context = { + currentVersion: 'enterprise-server@3.0', + currentLanguage: 'en' + } + await expect(() => { return page.render(context) }).not.toThrow() + }) + + test('support next GitHub AE version in frontmatter', async () => { + // This fixture has `github-ae: 'next'` hardcoded in the frontmatter + const page = await Page.init({ + relativePath: 'page-versioned-for-ghae-next.md', + basePath: path.join(__dirname, '../fixtures'), + languageCode: 'en' + }) + // set version to @latest + const context = { + currentVersion: 'github-ae@latest', + currentLanguage: 'en' + } + await expect(() => { return page.render(context) }).not.toThrow() + }) }) test('preserves `languageCode`', async () => { diff --git a/tests/unit/algolia/fixtures/page-with-sections.html b/tests/unit/search/fixtures/page-with-sections.html similarity index 75% rename from tests/unit/algolia/fixtures/page-with-sections.html rename to tests/unit/search/fixtures/page-with-sections.html index f61318d4c4..f6da35c328 100644 --- a/tests/unit/algolia/fixtures/page-with-sections.html +++ b/tests/unit/search/fixtures/page-with-sections.html @@ -1,8 +1,11 @@ + + +

    I am the page title

    diff --git a/tests/unit/algolia/fixtures/page-without-sections.html b/tests/unit/search/fixtures/page-without-sections.html similarity index 56% rename from tests/unit/algolia/fixtures/page-without-sections.html rename to tests/unit/search/fixtures/page-without-sections.html index 2c137527e6..4046e0a66c 100644 --- a/tests/unit/algolia/fixtures/page-without-sections.html +++ b/tests/unit/search/fixtures/page-without-sections.html @@ -1,10 +1,13 @@ + + +

    I am outside the article and should not be included

    A page without sections

    diff --git a/tests/unit/algolia/parse-page-sections-into-records.js b/tests/unit/search/parse-page-sections-into-records.js similarity index 79% rename from tests/unit/algolia/parse-page-sections-into-records.js rename to tests/unit/search/parse-page-sections-into-records.js index e328f846f0..982a72a086 100644 --- a/tests/unit/algolia/parse-page-sections-into-records.js +++ b/tests/unit/search/parse-page-sections-into-records.js @@ -20,19 +20,21 @@ describe('search parsePageSectionsIntoRecords module', () => { objectID: '/example/href#first', url: 'https://docs.github.com/example/href#first', slug: 'first', - breadcrumbs: 'a / b / c', + breadcrumbs: 'GitHub Actions / actions learning path', heading: 'First heading', title: 'I am the page title', - content: "Here's a paragraph. And another." + content: "Here's a paragraph. And another.", + topics: ['topic1', 'topic2', 'GitHub Actions', 'Actions'] }, { objectID: '/example/href#second', url: 'https://docs.github.com/example/href#second', slug: 'second', - breadcrumbs: 'a / b / c', + breadcrumbs: 'GitHub Actions / actions learning path', heading: 'Second heading', title: 'I am the page title', - content: "Here's a paragraph in the second section. And another." + content: "Here's a paragraph in the second section. And another.", + topics: ['topic1', 'topic2', 'GitHub Actions', 'Actions'] } ] @@ -50,9 +52,10 @@ describe('search parsePageSectionsIntoRecords module', () => { { objectID: '/example/href', url: 'https://docs.github.com/example/href', - breadcrumbs: 'x / y / z', + breadcrumbs: 'Education / map topic', title: 'A page without sections', - content: 'First paragraph. Second paragraph.' + content: 'First paragraph. Second paragraph.', + topics: ['key1', 'key2', 'key3', 'Education'] } ] expect(records).toEqual(expected) diff --git a/tests/unit/algolia/rank.js b/tests/unit/search/rank.js similarity index 100% rename from tests/unit/algolia/rank.js rename to tests/unit/search/rank.js diff --git a/tests/unit/search/topics.js b/tests/unit/search/topics.js new file mode 100644 index 0000000000..67e31554bb --- /dev/null +++ b/tests/unit/search/topics.js @@ -0,0 +1,32 @@ +const path = require('path') +const fs = require('fs') +const readFrontmatter = require('../../../lib/read-frontmatter') +const walk = require('walk-sync') +const { difference } = require('lodash') +const allowedTopics = require('../../../data/allowed-topics') + +const contentDir = path.join(process.cwd(), 'content') +const topics = walk(contentDir, { includeBasePath: true }) + .filter(filename => filename.endsWith('.md') && !filename.includes('README')) + .map(filename => { + const fileContent = fs.readFileSync(filename, 'utf8') + const { data } = readFrontmatter(fileContent) + return data.topics || [] + }) + .flat() + +const allUsedTopics = [...new Set(topics)].sort() + +describe('Check for allowed frontmatter topics', () => { + test('all used topics are allowed in /data/allowed-topics.js', () => { + expect(allUsedTopics.length).toBeGreaterThan(0) + const unusedTopics = difference(allUsedTopics, allowedTopics) + expect(unusedTopics).toEqual([]) + }) + + test('all allowed topics are used by at least one content file', () => { + expect(allowedTopics.length).toBeGreaterThan(0) + const disallowedTopics = difference(allowedTopics, allUsedTopics) + expect(disallowedTopics).toEqual([]) + }) +}) diff --git a/translations/de-DE/content/github/site-policy/github-ae-data-protection-agreement.md b/translations/de-DE/content/github/site-policy/github-ae-data-protection-agreement.md index 65b61b7f27..57940b3c39 100644 --- a/translations/de-DE/content/github/site-policy/github-ae-data-protection-agreement.md +++ b/translations/de-DE/content/github/site-policy/github-ae-data-protection-agreement.md @@ -328,7 +328,7 @@ Data exporter: Customer is the data exporter. However, because the data importer provides storage services and does not control the categories of data it stores, the data exporter may choose to transfer special categories of data. Consequently, the data exporter is solely responsible for ensuring that it complies with all obligations imposed by applicable laws and regulations relating to the collection and processing of any special categories of data, including obtaining the explicit consent of the data subject prior to processing sensitive personal data. -**Processing operations:** The personal data transferred will be subject to the following basic processing activities: GitHub uses personal data for the limited purposes set forth in the GitHub Privacy Statement, available at https://help.github.com/articles/github-privacy-statement/, and the “Data Processing” section of the DPA. +**Processing operations:** The personal data transferred will be subject to the following basic processing activities: GitHub uses personal data for the limited purposes set forth in the GitHub Privacy Statement, available at https://docs.github.com/articles/github-privacy-statement/, and the “Data Processing” section of the DPA. **Subcontractors:** In accordance with the DPA, the data importer may hire other companies to provide limited services on data importer’s behalf, such as providing customer support. Any such subcontractors will be permitted to obtain Customer Personal Data only to deliver the services the data importer has retained them to provide, and they are prohibited from using Customer Personal Data for any other purpose. diff --git a/translations/de-DE/content/github/site-policy/github-enterprise-cloud-evaluation-agreement.md b/translations/de-DE/content/github/site-policy/github-enterprise-cloud-evaluation-agreement.md index ff4f574e70..ac1cbc7c50 100644 --- a/translations/de-DE/content/github/site-policy/github-enterprise-cloud-evaluation-agreement.md +++ b/translations/de-DE/content/github/site-policy/github-enterprise-cloud-evaluation-agreement.md @@ -10,7 +10,7 @@ VIELEN DANK, DASS SIE SICH FÜR GITHUB ENTSCHIEDEN HABEN, UM DIE ANFORDERUNGEN I ### 1. Unternehmensnutzungsbedingungen -Der Kunde benötigt ein Unternehmenskonto bei GitHub.com, um Auswertungszugriff zu haben. Customer's evaluation of Enterprise Cloud will be governed by these terms and the Corporate Terms of Service (found at [https://docs.github.com/articles/github-corporate-terms-of-service](/articles/github-corporate-terms-of-service)) (together, the "**Evaluation Agreement**"). Alle zusätzlichen Bedingungen, die mit dem [Enterprise Cloud-Nachtrag](https://help.github.com/articles/github-enterprise-cloud-addendum) verbunden sind, gelten **nicht**, bis der Kunde sein Produkt auf ein kostenpflichtiges Abonnement von Enterprise Cloud heraufstuft.Alle großgeschriebenen Begriffe, die in dieser Auswertungsvereinbarung nicht definiert werden, sind in den Unternehmensnutzungsbedingungen definiert. +Der Kunde benötigt ein Unternehmenskonto bei GitHub.com, um Auswertungszugriff zu haben. Customer's evaluation of Enterprise Cloud will be governed by these terms and the Corporate Terms of Service (found at [https://docs.github.com/articles/github-corporate-terms-of-service](/articles/github-corporate-terms-of-service)) (together, the "**Evaluation Agreement**"). Alle zusätzlichen Bedingungen, die mit dem [Enterprise Cloud-Nachtrag](https://docs.github.com/articles/github-enterprise-cloud-addendum) verbunden sind, gelten **nicht**, bis der Kunde sein Produkt auf ein kostenpflichtiges Abonnement von Enterprise Cloud heraufstuft.Alle großgeschriebenen Begriffe, die in dieser Auswertungsvereinbarung nicht definiert werden, sind in den Unternehmensnutzungsbedingungen definiert. ### 2. Laufzeit und Kündigung diff --git a/translations/de-DE/data/ui.yml b/translations/de-DE/data/ui.yml index dcdf70a038..28806956a1 100644 --- a/translations/de-DE/data/ui.yml +++ b/translations/de-DE/data/ui.yml @@ -5,7 +5,7 @@ header: notices: ghae_silent_launch: GitHub AE is currently under limited release. Please contact our Sales Team to find out more. release_candidate: '# The version name is rendered before the below text via includes/header-notification.html '' is currently available as a release candidate. For more information, see "About upgrades to new releases."''' - localization_complete: Wir veröffentlichen regelmäßig Aktualisierungen unserer Dokumentation, und die Übersetzung dieser Seite kann noch im Gange sein. Die neuesten Informationen findest Du in der englischsprachigen Dokumentation. Informieren Sie uns bitte, falls auf dieser Seite ein Problem mit den Übersetzungen vorliegt. + localization_complete: Wir veröffentlichen regelmäßig Aktualisierungen unserer Dokumentation, und die Übersetzung dieser Seite kann noch im Gange sein. Die neuesten Informationen findest Du in der englischsprachigen Dokumentation. Informieren Sie uns bitte, falls auf dieser Seite ein Problem mit den Übersetzungen vorliegt. localization_in_progress: Hallo, Entdecker! An dieser Seite wird aktiv gearbeitet, oder sie wird noch übersetzt. Die neuesten und genauesten Informationen findest Du in unserer englischsprachigen Dokumentation. early_access: '📣 Please do not share this URL publicly. This page contains content about an early access feature.' search: diff --git a/translations/es-ES/data/ui.yml b/translations/es-ES/data/ui.yml index c6b10f8c07..f21a7f5057 100644 --- a/translations/es-ES/data/ui.yml +++ b/translations/es-ES/data/ui.yml @@ -5,7 +5,7 @@ header: notices: ghae_silent_launch: GitHub AE está actualmente en un lanzamiento limitado. Por favor, contacta a nuestro equipo de ventas para conocer más sobre esto. release_candidate: '# El nombre de la versión se interpreta antes del texto siguiente a través de '' includes/header-notification.html '' se encuentra disponible actualmente como un candidato de lanzamiento. Para obtener más información, consulta la sección "Acerca de las mejoras para los lanzamientos nuevos".' - localization_complete: Frecuentemente publicamos actualizaciones de nuestra documentación. Es posible que la traducción de esta página esté en curso. Para conocer la información más actual, visita la documentación en inglés. Si existe un problema con las traducciones en esta página, por favor infórmanos. + localization_complete: Frecuentemente publicamos actualizaciones de nuestra documentación. Es posible que la traducción de esta página esté en curso. Para conocer la información más actual, visita la documentación en inglés. Si existe un problema con las traducciones en esta página, por favor infórmanos. localization_in_progress: '¡Hola, explorador! Esta página está bajo desarrollo activo o todavía está en la etapa de traducción. Para obtener información más actualizada y precisa, visita nuestra documentación en inglés.' early_access: '📣 Por favor, no compartas esta URL públicamente. Esta página tiene contenido sobre una característica de acceso temprano.' search: diff --git a/translations/es-XL/content/github/site-policy/github-enterprise-cloud-evaluation-agreement.md b/translations/es-XL/content/github/site-policy/github-enterprise-cloud-evaluation-agreement.md index 44c158ca7d..9afe00a785 100644 --- a/translations/es-XL/content/github/site-policy/github-enterprise-cloud-evaluation-agreement.md +++ b/translations/es-XL/content/github/site-policy/github-enterprise-cloud-evaluation-agreement.md @@ -10,7 +10,7 @@ GRACIAS POR ELEGIR GITHUB PARA LAS NECESIDADES COMERCIALES DE SU EMPRESA. LEA ES ### 1. Términos de servicio corporativos -El cliente debe tener una cuenta corporativa en GitHub.com para poder acceder a la evaluación. La evaluación del Cliente sobre Enterprise Cloud se regirá mediante estas condiciones y las Condiciones Corporativas del Servicio (las cuales se pueden encontrar en [https://docs.github.com/articles/github-corporate-terms-of-service](/articles/github-corporate-terms-of-service)) (en conjunto conocidas como el "**Acuerdo de Evaluación**"). Sin embargo, los términos adicionales asociados con el [Anexo de Enterprise Cloud](https://help.github.com/articles/github-enterprise-cloud-addendum) **no** se aplicarán hasta que el Cliente actualice su compra a una suscripción remunerada de Enterprise Cloud.Todos los términos en mayúscula que no están definidos en este Acuerdo de evaluación están definidos en los Términos de servicio corporativos. +El cliente debe tener una cuenta corporativa en GitHub.com para poder acceder a la evaluación. La evaluación del Cliente sobre Enterprise Cloud se regirá mediante estas condiciones y las Condiciones Corporativas del Servicio (las cuales se pueden encontrar en [https://docs.github.com/articles/github-corporate-terms-of-service](/articles/github-corporate-terms-of-service)) (en conjunto conocidas como el "**Acuerdo de Evaluación**"). Sin embargo, los términos adicionales asociados con el [Anexo de Enterprise Cloud](https://docs.github.com/articles/github-enterprise-cloud-addendum) **no** se aplicarán hasta que el Cliente actualice su compra a una suscripción remunerada de Enterprise Cloud.Todos los términos en mayúscula que no están definidos en este Acuerdo de evaluación están definidos en los Términos de servicio corporativos. ### 2. Plazo y terminación diff --git a/translations/es-XL/data/glossaries/external.yml b/translations/es-XL/data/glossaries/external.yml index f511b72218..b28af95451 100644 --- a/translations/es-XL/data/glossaries/external.yml +++ b/translations/es-XL/data/glossaries/external.yml @@ -35,7 +35,7 @@ - term: biografía description: >- - La descripción generada por el usuario encontrada en un perfil: https://help.github.com/articles/adding-a-bio-to-your-profile/ + La descripción generada por el usuario encontrada en un perfil: https://docs.github.com/articles/adding-a-bio-to-your-profile/ - term: ciclo de facturación description: El intervalo de tiempo para tu plan de facturación específico. @@ -155,7 +155,7 @@ - term: contribuciones description: >- - Actividades específicas en GitHub que: - Agregarán un cuadrado al gráfico de contribuciones de un usuario: "[Que cuenta como una contribución](https://help.github.com/articles/viewing-contributions-on-your-profile/#what-counts-as-a-contribution)" - Agregarán actividades a la cronología de un usuario en su perfil: "[Actividad de contribución](https://help.github.com/articles/viewing-contributions-on-your-profile/#contribution-activity)" + Actividades específicas en GitHub que: - Agregarán un cuadrado al gráfico de contribuciones de un usuario: "[Que cuenta como una contribución](https://docs.github.com/articles/viewing-contributions-on-your-profile/#what-counts-as-a-contribution)" - Agregarán actividades a la cronología de un usuario en su perfil: "[Actividad de contribución](https://docs.github.com/articles/viewing-contributions-on-your-profile/#contribution-activity)" - term: colaborador description: >- @@ -228,7 +228,7 @@ Una rama usada para experimentar con una nueva función o corregir una propuesta que no está en producción. También llamada rama de tema. - term: bloque de código cercado - description: 'Un bloque de código sangrado que puedes crear con el formato Markdown de GitHub utilizando triple diagonal inversa \`\`\` antes y después del mismo. Consulta el [example](https://help.github.com/en/articles/creating-and-highlighting-code-blocks#fenced-code-blocks).' + description: 'Un bloque de código sangrado que puedes crear con el formato Markdown de GitHub utilizando triple diagonal inversa \`\`\` antes y después del mismo. Consulta el [example](https://docs.github.com/en/articles/creating-and-highlighting-code-blocks#fenced-code-blocks).' - term: extraer description: >- diff --git a/translations/es-XL/data/ui.yml b/translations/es-XL/data/ui.yml index 6c0154aba5..3e6d70b597 100644 --- a/translations/es-XL/data/ui.yml +++ b/translations/es-XL/data/ui.yml @@ -4,7 +4,7 @@ header: contact: Contacto notices: ghe_release_candidate: GitHub Enterprise Server 2.22 is currently under limited release as a release candidate. - localization_complete: Frecuentemente publicamos actualizaciones de nuestra documentación. Es posible que la traducción de esta página esté en curso. Para conocer la información más actual, visita la documentación en inglés. Si existe un problema con las traducciones en esta página, por favor infórmanos. + localization_complete: Frecuentemente publicamos actualizaciones de nuestra documentación. Es posible que la traducción de esta página esté en curso. Para conocer la información más actual, visita la documentación en inglés. Si existe un problema con las traducciones en esta página, por favor infórmanos. localization_in_progress: '¡Hola, explorador! Esta página está bajo desarrollo activo o todavía está en la etapa de traducción. Para obtener información más actualizada y precisa, visita nuestra documentación en inglés.' product_in_progress: '👋 ¡Hola, explorador! Esta página está en desarrollo activo. Para la información más actualizada y precisa, por favor visita nuestra documentación del desarrollador.' search: diff --git a/translations/ja-JP/content/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization.md b/translations/ja-JP/content/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization.md index afbf2c1e5a..3eb96aa01c 100644 --- a/translations/ja-JP/content/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization.md +++ b/translations/ja-JP/content/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization.md @@ -49,7 +49,7 @@ Organization レベルの設定を管理することに加え、Organization の **Note:** Repository permissions required to use security features are listed in "[Permission requirements for security features](#permission-requirements-for-security-features)" below. {% endnote %} -| + {% endif %} | リポジトリアクション | Read | Triage | Write | Maintain | Admin | |:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |:-----:|:------:|:-----:|:--------:|:--------------------------------------------------------------------------------------------------------------------------------------------------:| @@ -63,16 +63,13 @@ Organization レベルの設定を管理することに加え、Organization の | Team の割り当てリポジトリのフォークからのプルリクエストの送信 | **X** | **X** | **X** | **X** | **X** | | プルリクエストについてのレビューのサブミット | **X** | **X** | **X** | **X** | **X** | | 公開済みリリースの表示 | **X** | **X** | **X** | **X** | **X** |{% if currentVersion == "free-pro-team@latest" %} -| [[GitHub Actions workflow runs](/actions/automating-your-workflow-with-github-actions/managing-a-workflow-run)] の表示 | **X** | **X** | **X** | **X** | **X** -{% endif %} +| [[GitHub Actions workflow runs](/actions/automating-your-workflow-with-github-actions/managing-a-workflow-run)] の表示 | **X** | **X** | **X** | **X** | **X** |{% endif %} | wiki の編集 | **X** | **X** | **X** | **X** | **X** |{% if currentVersion == "free-pro-team@latest" %} -| [悪用あるいはスパムの可能性があるコンテンツのレポート](/articles/reporting-abuse-or-spam) | **X** | **X** | **X** | **X** | **X** -{% endif %} +| [悪用あるいはスパムの可能性があるコンテンツのレポート](/articles/reporting-abuse-or-spam) | **X** | **X** | **X** | **X** | **X** |{% endif %} | Apply/dismiss labels | | **X** | **X** | **X** | **X** | | Create, edit, delete labels | | | **X** | **X** | **X** | | すべての Issue およびプルリクエストのクローズ、再オープン、割り当て | | **X** | **X** | **X** | **X** |{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} -| [Enable and disable auto-merge on a pull request](/github/administering-a-repository/managing-auto-merge-for-pull-requests-in-your-repository) | | | **X** | **X** | **X** -{% endif %} +| [Enable and disable auto-merge on a pull request](/github/administering-a-repository/managing-auto-merge-for-pull-requests-in-your-repository) | | | **X** | **X** | **X** |{% endif %} | マイルストーンの適用 | | **X** | **X** | **X** | **X** | | [重複した Issue とプルリクエスト](/articles/about-duplicate-issues-and-pull-requests)のマーク付け | | **X** | **X** | **X** | **X** | | [プルリクエストのレビュー](/articles/requesting-a-pull-request-review)の要求 | | **X** | **X** | **X** | **X** | @@ -83,13 +80,11 @@ Organization レベルの設定を管理することに加え、Organization の | Issue の移譲 (詳細は「[他のリポジトリへ Issue を移譲する](/articles/transferring-an-issue-to-another-repository)」を参照) | | | **X** | **X** | **X** | | [リポジトリに指定されたコードオーナーとしてのアクション](/articles/about-code-owners) | | | **X** | **X** | **X** | | [プルリクエストのドラフトに、レビューの準備ができたことを示すマークを付ける](/articles/changing-the-stage-of-a-pull-request) | | | **X** | **X** | **X** |{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" or currentVersion == "github-ae@latest" %} -| [プルリクエストをドラフトに変換する](/articles/changing-the-stage-of-a-pull-request) | | | **X** | **X** | **X** -{% endif %} +| [プルリクエストをドラフトに変換する](/articles/changing-the-stage-of-a-pull-request) | | | **X** | **X** | **X** |{% endif %} | プルリクエストのマージ可能性に影響するレビューのサブミット | | | **X** | **X** | **X** | | プルリクエストに[提案された変更を適用する](/articles/incorporating-feedback-in-your-pull-request) | | | **X** | **X** | **X** | | [ステータスチェック](/articles/about-status-checks)の作成 | | | **X** | **X** | **X** |{% if currentVersion == "free-pro-team@latest" %} -| [GitHub Actions ワークフロー](/actions/automating-your-workflow-with-github-actions/) の作成、編集、実行、再実行、キャンセル | | | **X** | **X** | **X** -{% endif %} +| [GitHub Actions ワークフロー](/actions/automating-your-workflow-with-github-actions/) の作成、編集、実行、再実行、キャンセル | | | **X** | **X** | **X** |{% endif %} | リリースの作成と編集 | | | **X** | **X** | **X** | | ドラフトリリースの表示 | | | **X** | **X** | **X** | | リポジトリの説明の編集 | | | | **X** | **X** |{% if currentVersion == "free-pro-team@latest" %} @@ -103,8 +98,7 @@ Organization レベルの設定を管理することに加え、Organization の | [{% data variables.product.prodname_pages %} の公開ソース](/articles/configuring-a-publishing-source-for-github-pages)の設定 | | | | **X** | **X** | | [保護されたブランチへのプッシュ](/articles/about-protected-branches) | | | | **X** | **X** | | [リポジトリソーシャルカードの作成と編集](/articles/customizing-your-repositorys-social-media-preview) | | | | **X** | **X** |{% if currentVersion == "free-pro-team@latest" %} -| [リポジトリでのインタラクション](/github/building-a-strong-community/limiting-interactions-in-your-repository)を制限する | | | | **X** | **X** -{% endif %} +| [リポジトリでのインタラクション](/github/building-a-strong-community/limiting-interactions-in-your-repository)を制限する | | | | **X** | **X** |{% endif %} | Issue の削除 (「[Issue を削除する](/articles/deleting-an-issue)」を参照) | | | | | **X** | | 保護されたブランチでのプルリクエストのマージ(レビューの承認がなくても) | | | | | **X** | | [リポジトリのコードオーナーの定義](/articles/about-code-owners) | | | | | **X** | @@ -116,17 +110,14 @@ Organization レベルの設定を管理することに加え、Organization の | Team およびコラボレータのリポジトリへのアクセス管理 | | | | | **X** | | リポジトリのデフォルトブランチ編集 | | | | | **X** |{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} | Rename the repository's default branch (see "[Renaming a branch](/github/administering-a-repository/renaming-a-branch)") | | | | | **X** | -| Rename a branch other than the repository's default branch (see "[Renaming a branch](/github/administering-a-repository/renaming-a-branch)") | | | **X** | **X** | **X** -{% endif %} +| Rename a branch other than the repository's default branch (see "[Renaming a branch](/github/administering-a-repository/renaming-a-branch)") | | | **X** | **X** | **X** |{% endif %} | Webhookおよびデプロイキーの管理 | | | | | **X** |{% if currentVersion == "free-pro-team@latest" %} -| [プライベートリポジトリ用のデータ利用設定を管理する](/github/understanding-how-github-uses-and-protects-your-data/managing-data-use-settings-for-your-private-repository) | | | | | **X** -{% endif %} +| [プライベートリポジトリ用のデータ利用設定を管理する](/github/understanding-how-github-uses-and-protects-your-data/managing-data-use-settings-for-your-private-repository) | | | | | **X** |{% endif %} | [リポジトリのフォークポリシーを管理する](/github/administering-a-repository/managing-the-forking-policy-for-your-repository) | | | | | **X** | | [リポジトリの Organization への移譲](/articles/restricting-repository-creation-in-your-organization) | | | | | **X** | | [リポジトリの削除または Organization 外への移譲](/articles/setting-permissions-for-deleting-or-transferring-repositories) | | | | | **X** | | [リポジトリのアーカイブ](/articles/about-archiving-repositories) | | | | | **X** |{% if currentVersion == "free-pro-team@latest" %} -| スポンサーボタンの表示 (「[リポジトリにスポンサーボタンを表示する](/articles/displaying-a-sponsor-button-in-your-repository)」を参照) | | | | | **X** -{% endif %} +| スポンサーボタンの表示 (「[リポジトリにスポンサーボタンを表示する](/articles/displaying-a-sponsor-button-in-your-repository)」を参照) | | | | | **X** |{% endif %} | JIRA や Zendesk などの外部リソースに対する自動リンク参照を作成します (「[外部リソースを参照する自動リンクの設定](/articles/configuring-autolinks-to-reference-external-resources)」を参照)。 | | | | | **X** |{% if currentVersion == "free-pro-team@latest" %} | [Enable {% data variables.product.prodname_discussions %}](/github/administering-a-repository/enabling-or-disabling-github-discussions-for-a-repository) in a repository | | | | **X** | **X** | | [Create and edit categories](/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository) for {% data variables.product.prodname_discussions %} | | | | **X** | **X** | @@ -137,8 +128,7 @@ Organization レベルの設定を管理することに加え、Organization の | [Lock and unlock discussions](/discussions/managing-discussions-for-your-community/moderating-discussions) | | **X** | **X** | **X** | **X** | | [Individually convert issues to discussions](/discussions/managing-discussions-for-your-community/moderating-discussions) | | **X** | **X** | **X** | **X** | | [Create new discussions and comment on existing discussions](/discussions/collaborating-with-your-community-using-discussions/participating-in-a-discussion) | **X** | **X** | **X** | **X** | **X** | -| [ディスカッションの削除](/discussions/managing-discussions-for-your-community/managing-discussions-in-your-repository#deleting-a-discussion) | | | | **X** | **X** -{% endif %} +| [ディスカッションの削除](/discussions/managing-discussions-for-your-community/managing-discussions-in-your-repository#deleting-a-discussion) | | | | **X** | **X** |{% endif %} {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %} #### Permission requirements for security features @@ -158,8 +148,7 @@ In this section, you can find the repository permission levels required for secu | [List, dismiss, and delete {% data variables.product.prodname_code_scanning %} alerts](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository) | | | **X** | **X** | **X** |{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} | [View {% data variables.product.prodname_secret_scanning %} alerts in a repository](/github/administering-a-repository/managing-alerts-from-secret-scanning) | | | | | **X** | | [Resolve, revoke or re-open {% data variables.product.prodname_secret_scanning %} alerts](/github/administering-a-repository/managing-alerts-from-secret-scanning) | | | | | **X** | -| [Designate additional people or teams to receive {% data variables.product.prodname_secret_scanning %} alerts](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts) in repositories | | | | | **X** -{% endif %} +| [Designate additional people or teams to receive {% data variables.product.prodname_secret_scanning %} alerts](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts) in repositories | | | | | **X** |{% endif %} {% endif %} ### 参考リンク diff --git a/translations/ja-JP/content/github/site-policy/github-ae-data-protection-agreement.md b/translations/ja-JP/content/github/site-policy/github-ae-data-protection-agreement.md index 7fab15d3ce..43f85aac2d 100644 --- a/translations/ja-JP/content/github/site-policy/github-ae-data-protection-agreement.md +++ b/translations/ja-JP/content/github/site-policy/github-ae-data-protection-agreement.md @@ -328,7 +328,7 @@ Data exporter: Customer is the data exporter. However, because the data importer provides storage services and does not control the categories of data it stores, the data exporter may choose to transfer special categories of data. Consequently, the data exporter is solely responsible for ensuring that it complies with all obligations imposed by applicable laws and regulations relating to the collection and processing of any special categories of data, including obtaining the explicit consent of the data subject prior to processing sensitive personal data. -**Processing operations:** The personal data transferred will be subject to the following basic processing activities: GitHub uses personal data for the limited purposes set forth in the GitHub Privacy Statement, available at https://help.github.com/articles/github-privacy-statement/, and the “Data Processing” section of the DPA. +**Processing operations:** The personal data transferred will be subject to the following basic processing activities: GitHub uses personal data for the limited purposes set forth in the GitHub Privacy Statement, available at https://docs.github.com/articles/github-privacy-statement/, and the “Data Processing” section of the DPA. **Subcontractors:** In accordance with the DPA, the data importer may hire other companies to provide limited services on data importer’s behalf, such as providing customer support. Any such subcontractors will be permitted to obtain Customer Personal Data only to deliver the services the data importer has retained them to provide, and they are prohibited from using Customer Personal Data for any other purpose. diff --git a/translations/ja-JP/content/github/site-policy/github-enterprise-cloud-evaluation-agreement.md b/translations/ja-JP/content/github/site-policy/github-enterprise-cloud-evaluation-agreement.md index eea815cb5f..cd2113166f 100644 --- a/translations/ja-JP/content/github/site-policy/github-enterprise-cloud-evaluation-agreement.md +++ b/translations/ja-JP/content/github/site-policy/github-enterprise-cloud-evaluation-agreement.md @@ -10,7 +10,7 @@ versions: ### 1. 企業向け利用規約 -評価版にアクセスするお客様には、GitHub.comの法人アカウントが必要です。 Customer's evaluation of Enterprise Cloud will be governed by these terms and the Corporate Terms of Service (found at [https://docs.github.com/articles/github-corporate-terms-of-service](/articles/github-corporate-terms-of-service)) (together, the "**Evaluation Agreement**"). ただし、[Enterprise Cloudの付属文書](https://help.github.com/articles/github-enterprise-cloud-addendum)に伴う補足条項は、お客様が購入した製品をEnterprise Cloudの有料サブスクリプションにアップグレードするまでは**適用されません**。本評価契約で定義されていない大文字表記の条件は、企業向け利用規約で定義されています。 +評価版にアクセスするお客様には、GitHub.comの法人アカウントが必要です。 Customer's evaluation of Enterprise Cloud will be governed by these terms and the Corporate Terms of Service (found at [https://docs.github.com/articles/github-corporate-terms-of-service](/articles/github-corporate-terms-of-service)) (together, the "**Evaluation Agreement**"). ただし、[Enterprise Cloudの付属文書](https://docs.github.com/articles/github-enterprise-cloud-addendum)に伴う補足条項は、お客様が購入した製品をEnterprise Cloudの有料サブスクリプションにアップグレードするまでは**適用されません**。本評価契約で定義されていない大文字表記の条件は、企業向け利用規約で定義されています。 ### 2. 契約期間および解約 diff --git a/translations/ja-JP/content/rest/overview/libraries.md b/translations/ja-JP/content/rest/overview/libraries.md index 5fd19e461a..859e816866 100644 --- a/translations/ja-JP/content/rest/overview/libraries.md +++ b/translations/ja-JP/content/rest/overview/libraries.md @@ -25,68 +25,123 @@ versions: ### Clojure -Library name | Repository |---|---| **Tentacles**| [Raynes/tentacles](https://github.com/Raynes/tentacles) +Library name | Repository +|---|---| +**Tentacles**| [Raynes/tentacles](https://github.com/Raynes/tentacles) ### Dart -ライブラリ名 | リポジトリ |---|---| **github.dart** | [DirectMyFile/github.dart](https://github.com/DirectMyFile/github.dart) +ライブラリ名 | リポジトリ +|---|---| +**github.dart** | [DirectMyFile/github.dart](https://github.com/DirectMyFile/github.dart) ### Emacs Lisp -ライブラリ名 | リポジトリ |---|---| **gh.el** | [sigma/gh.el](https://github.com/sigma/gh.el) +ライブラリ名 | リポジトリ +|---|---| +**gh.el** | [sigma/gh.el](https://github.com/sigma/gh.el) ### Erlang -ライブラリ名 | リポジトリ |---|---| **octo-erl** | [sdepold/octo.erl](https://github.com/sdepold/octo.erl) +ライブラリ名 | リポジトリ +|---|---| +**octo-erl** | [sdepold/octo.erl](https://github.com/sdepold/octo.erl) ### Go -ライブラリ名 | リポジトリ |---|---| **go-github**| [google/go-github](https://github.com/google/go-github) +ライブラリ名 | リポジトリ +|---|---| +**go-github**| [google/go-github](https://github.com/google/go-github) ### Haskell -ライブラリ名 | リポジトリ |---|---| **haskell-github** | [fpco/Github](https://github.com/fpco/GitHub) +ライブラリ名 | リポジトリ +|---|---| +**haskell-github** | [fpco/Github](https://github.com/fpco/GitHub) ### Java -ライブラリ名 | リポジトリ | 詳細 |---|---|---| **GitHub Java API**| [org.eclipse.egit.github.core](https://github.com/eclipse/egit-github/tree/master/org.eclipse.egit.github.core) | [GitHub Mylyn Connector](https://github.com/eclipse/egit-github) の一部であり、GitHub v3 API 全体のサポートを目指します。 ビルドは [Maven Central](http://search.maven.org/#search%7Cga%7C1%7Ca%3A%22org.eclipse.egit.github.core%22) で利用できます。 **GitHub API for Java**| [org.kohsuke.github (From github-api)](http://github-api.kohsuke.org/)| GitHub API のオブジェクト指向の表現を定義します。 **JCabi GitHub API**|[github.jcabi.com (Personal Website)](http://github.jcabi.com)| Java7 JSON API (JSR-353) に基づいており、ランタイム GitHub スタブを使用してテストを簡素化し、API 全体をカバーします。 +ライブラリ名 | リポジトリ | 詳細 +|---|---|---| +**GitHub Java API**| [org.eclipse.egit.github.core](https://github.com/eclipse/egit-github/tree/master/org.eclipse.egit.github.core) | [GitHub Mylyn Connector](https://github.com/eclipse/egit-github) の一部であり、GitHub v3 API 全体のサポートを目指します。 ビルドは [Maven Central](http://search.maven.org/#search%7Cga%7C1%7Ca%3A%22org.eclipse.egit.github.core%22) で利用できます。 +**GitHub API for Java**| [org.kohsuke.github (From github-api)](http://github-api.kohsuke.org/)| GitHub API のオブジェクト指向の表現を定義します。 +**JCabi GitHub API**|[github.jcabi.com (Personal Website)](http://github.jcabi.com)| Java7 JSON API (JSR-353) に基づいており、ランタイム GitHub スタブを使用してテストを簡素化し、API 全体をカバーします。 ### JavaScript -ライブラリ名 | リポジトリ | |---|---| **NodeJS GitHub library**| [pksunkara/octonode](https://github.com/pksunkara/octonode) **gh3 client-side API v3 wrapper**| [k33g/gh3](https://github.com/k33g/gh3) **Github.js wrapper around the GitHub API**|[michael/github](https://github.com/michael/github) **Promise-Based CoffeeScript library for the Browser or NodeJS**|[philschatz/github-client](https://github.com/philschatz/github-client) +ライブラリ名 | リポジトリ | +|---|---| +**NodeJS GitHub library**| [pksunkara/octonode](https://github.com/pksunkara/octonode) +**gh3 client-side API v3 wrapper**| [k33g/gh3](https://github.com/k33g/gh3) +**Github.js wrapper around the GitHub API**|[michael/github](https://github.com/michael/github) **Promise-Based CoffeeScript library for the Browser or NodeJS**|[philschatz/github-client](https://github.com/philschatz/github-client) ### Julia -Library name | Repository | |---|---| **GitHub.jl**|[WestleyArgentum/GitHub.jl](https://github.com/WestleyArgentum/GitHub.jl) +Library name | Repository | +|---|---| +**GitHub.jl**|[WestleyArgentum/GitHub.jl](https://github.com/WestleyArgentum/GitHub.jl) ### OCaml -ライブラリ名 | リポジトリ | |---|---| **ocaml-github**|[mirage/ocaml-github](https://github.com/mirage/ocaml-github) +ライブラリ名 | リポジトリ | +|---|---| +**ocaml-github**|[mirage/ocaml-github](https://github.com/mirage/ocaml-github) ### Perl -Library name | Repository | metacpan Website for the Library |---|---|---| **Pithub**|[plu/Pithub](https://github.com/plu/Pithub)|[Pithub CPAN](http://metacpan.org/module/Pithub) **Net::GitHub**|[fayland/perl-net-github](https://github.com/fayland/perl-net-github)|[Net:GitHub CPAN](https://metacpan.org/pod/Net::GitHub) +Library name | Repository | metacpan Website for the Library +|---|---|---| +**Pithub**|[plu/Pithub](https://github.com/plu/Pithub)|[Pithub CPAN](http://metacpan.org/module/Pithub) **Net::GitHub**|[fayland/perl-net-github](https://github.com/fayland/perl-net-github)|[Net:GitHub CPAN](https://metacpan.org/pod/Net::GitHub) ### PHP -ライブラリ名 | リポジトリ |---|---| **GitHub PHP Client**|[tan-tan-kanarek/github-php-client](https://github.com/tan-tan-kanarek/github-php-client) **PHP GitHub API**|[KnpLabs/php-github-api](https://github.com/KnpLabs/php-github-api) **GitHub API**|[yiiext/github-api](https://github.com/yiiext/github-api) **GitHub Joomla! Package**|[joomla-framework/github-api](https://github.com/joomla-framework/github-api) **GitHub Nette Extension**|[kdyby/github](https://github.com/kdyby/github) **GitHub API Easy Access**|[milo/github-api](https://github.com/milo/github-api) **GitHub bridge for Laravel**|[GrahamCampbell/Laravel-GitHub](https://github.com/GrahamCampbell/Laravel-GitHub) **PHP7 Client & WebHook wrapper**|[FlexyProject/GitHubAPI](https://github.com/FlexyProject/GitHubAPI) +ライブラリ名 | リポジトリ +|---|---| +**GitHub PHP Client**|[tan-tan-kanarek/github-php-client](https://github.com/tan-tan-kanarek/github-php-client) +**PHP GitHub API**|[KnpLabs/php-github-api](https://github.com/KnpLabs/php-github-api) +**GitHub API**|[yiiext/github-api](https://github.com/yiiext/github-api) +**GitHub Joomla! Package**|[joomla-framework/github-api](https://github.com/joomla-framework/github-api) **GitHub Nette Extension**|[kdyby/github](https://github.com/kdyby/github) +**GitHub API Easy Access**|[milo/github-api](https://github.com/milo/github-api) +**GitHub bridge for Laravel**|[GrahamCampbell/Laravel-GitHub](https://github.com/GrahamCampbell/Laravel-GitHub) +**PHP7 Client & WebHook wrapper**|[FlexyProject/GitHubAPI](https://github.com/FlexyProject/GitHubAPI) ### Python -Library name | Repository |---|---| **gidgethub**|[brettcannon/gidgethub](https://github.com/brettcannon/gidgethub) **ghapi**|[fastai/ghapi](https://github.com/fastai/ghapi) **PyGithub**|[PyGithub/PyGithub](https://github.com/PyGithub/PyGithub) **libsaas**|[duckboard/libsaas](https://github.com/ducksboard/libsaas) **github3.py**|[sigmavirus24/github3.py](https://github.com/sigmavirus24/github3.py) **sanction**|[demianbrecht/sanction](https://github.com/demianbrecht/sanction) **agithub**|[jpaugh/agithub](https://github.com/jpaugh/agithub) **octohub**|[turnkeylinux/octohub](https://github.com/turnkeylinux/octohub) **github-flask**|[github-flask (Official Website)](http://github-flask.readthedocs.org) **torngithub**|[jkeylu/torngithub](https://github.com/jkeylu/torngithub) +Library name | Repository +|---|---| +**gidgethub**|[brettcannon/gidgethub](https://github.com/brettcannon/gidgethub) +**ghapi**|[fastai/ghapi](https://github.com/fastai/ghapi) +**PyGithub**|[PyGithub/PyGithub](https://github.com/PyGithub/PyGithub) +**libsaas**|[duckboard/libsaas](https://github.com/ducksboard/libsaas) +**github3.py**|[sigmavirus24/github3.py](https://github.com/sigmavirus24/github3.py) +**sanction**|[demianbrecht/sanction](https://github.com/demianbrecht/sanction) +**agithub**|[jpaugh/agithub](https://github.com/jpaugh/agithub) +**octohub**|[turnkeylinux/octohub](https://github.com/turnkeylinux/octohub) +**github-flask**|[github-flask (Official Website)](http://github-flask.readthedocs.org) +**torngithub**|[jkeylu/torngithub](https://github.com/jkeylu/torngithub) ### Ruby -ライブラリ名 | リポジトリ |---|---| **GitHub API Gem**|[peter-murach/github](https://github.com/peter-murach/github) **Ghee**|[rauhryan/ghee](https://github.com/rauhryan/ghee) +ライブラリ名 | リポジトリ +|---|---| +**GitHub API Gem**|[peter-murach/github](https://github.com/peter-murach/github) +**Ghee**|[rauhryan/ghee](https://github.com/rauhryan/ghee) ### Rust -Library name | Repository |---|---| **Octocrab**|[XAMPPRocky/octocrab](https://github.com/XAMPPRocky/octocrab) +Library name | Repository +|---|---| +**Octocrab**|[XAMPPRocky/octocrab](https://github.com/XAMPPRocky/octocrab) ### Scala -ライブラリ名 | リポジトリ |---|---| **Hubcat**|[softprops/hubcat](https://github.com/softprops/hubcat) **Github4s**|[47deg/github4s](https://github.com/47deg/github4s) +ライブラリ名 | リポジトリ +|---|---| +**Hubcat**|[softprops/hubcat](https://github.com/softprops/hubcat) +**Github4s**|[47deg/github4s](https://github.com/47deg/github4s) ### Shell -ライブラリ名 | リポジトリ |---|---| **ok.sh**|[whiteinge/ok.sh](https://github.com/whiteinge/ok.sh) +ライブラリ名 | リポジトリ +|---|---| +**ok.sh**|[whiteinge/ok.sh](https://github.com/whiteinge/ok.sh) diff --git a/translations/ja-JP/data/ui.yml b/translations/ja-JP/data/ui.yml index f36f53a2bb..82bd8a57c8 100644 --- a/translations/ja-JP/data/ui.yml +++ b/translations/ja-JP/data/ui.yml @@ -5,7 +5,7 @@ header: notices: ghae_silent_launch: GitHub AE is currently under limited release. Please contact our Sales Team to find out more. release_candidate: '# The version name is rendered before the below text via includes/header-notification.html '' is currently available as a release candidate. For more information, see "About upgrades to new releases."''' - localization_complete: ドキュメントには頻繁に更新が加えられ、その都度公開されています。本ページの翻訳はまだ未完成な部分があることをご了承ください。最新の情報については、英語のドキュメンテーションをご参照ください。本ページの翻訳に問題がある場合はこちらまでご連絡ください。 + localization_complete: ドキュメントには頻繁に更新が加えられ、その都度公開されています。本ページの翻訳はまだ未完成な部分があることをご了承ください。最新の情報については、英語のドキュメンテーションをご参照ください。本ページの翻訳に問題がある場合はこちらまでご連絡ください。 localization_in_progress: こんにちは!このページは開発中か、まだ翻訳中です。最新の正しい情報を得るには、英語のドキュメンテーションにアクセスしてください。 early_access: '📣 Please do not share this URL publicly. This page contains content about an early access feature.' search: diff --git a/translations/ko-KR/content/github/site-policy/github-ae-data-protection-agreement.md b/translations/ko-KR/content/github/site-policy/github-ae-data-protection-agreement.md index 80cdc66842..500686841b 100644 --- a/translations/ko-KR/content/github/site-policy/github-ae-data-protection-agreement.md +++ b/translations/ko-KR/content/github/site-policy/github-ae-data-protection-agreement.md @@ -328,7 +328,7 @@ Data exporter: Customer is the data exporter. However, because the data importer provides storage services and does not control the categories of data it stores, the data exporter may choose to transfer special categories of data. Consequently, the data exporter is solely responsible for ensuring that it complies with all obligations imposed by applicable laws and regulations relating to the collection and processing of any special categories of data, including obtaining the explicit consent of the data subject prior to processing sensitive personal data. -**Processing operations:** The personal data transferred will be subject to the following basic processing activities: GitHub uses personal data for the limited purposes set forth in the GitHub Privacy Statement, available at https://help.github.com/articles/github-privacy-statement/, and the “Data Processing” section of the DPA. +**Processing operations:** The personal data transferred will be subject to the following basic processing activities: GitHub uses personal data for the limited purposes set forth in the GitHub Privacy Statement, available at https://docs.github.com/articles/github-privacy-statement/, and the “Data Processing” section of the DPA. **Subcontractors:** In accordance with the DPA, the data importer may hire other companies to provide limited services on data importer’s behalf, such as providing customer support. Any such subcontractors will be permitted to obtain Customer Personal Data only to deliver the services the data importer has retained them to provide, and they are prohibited from using Customer Personal Data for any other purpose. diff --git a/translations/ko-KR/data/ui.yml b/translations/ko-KR/data/ui.yml index a48fc65c38..a45f828aca 100644 --- a/translations/ko-KR/data/ui.yml +++ b/translations/ko-KR/data/ui.yml @@ -5,7 +5,7 @@ header: notices: ghae_silent_launch: GitHub AE is currently under limited release. Please contact our Sales Team to find out more. release_candidate: '# The version name is rendered before the below text via includes/header-notification.html '' is currently available as a release candidate. For more information, see "About upgrades to new releases."''' - localization_complete: 문서에 대한 업데이트가 자주 게시되며, 이 페이지의 번역이 아직 진행 중일 수 있습니다. 최신 정보는영어 설명서를 방문하십시오. 이 페이지에서 번역에 문제가 있는 경우 알려주십시오. + localization_complete: 문서에 대한 업데이트가 자주 게시되며, 이 페이지의 번역이 아직 진행 중일 수 있습니다. 최신 정보는영어 설명서를 방문하십시오. 이 페이지에서 번역에 문제가 있는 경우 알려주십시오. localization_in_progress: 안녕하세요! 이 페이지는 현재 개발 중이거나 아직 번역 중입니다. 정확한 최신 정보를 확인하려면 영어 설명서를 방문하십시오. early_access: '📣 Please do not share this URL publicly. This page contains content about an early access feature.' search: diff --git a/translations/pt-BR/content/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning.md b/translations/pt-BR/content/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning.md index 50dcf8d90b..6a4cad90c3 100644 --- a/translations/pt-BR/content/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning.md +++ b/translations/pt-BR/content/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning.md @@ -278,7 +278,7 @@ paths-ignore: Para linguagens compiladas, se você deseja limitar {% data variables.product.prodname_code_scanning %} a diretórios específicos no seu projeto, você deverá especificar os passos de compilação adequados no fluxo de trabalho. Os comandos que você precisa usar para excluir um diretório da criação dependerão do seu sistema de criação. Para obter mais informações, consulte "[Configurar o fluxo de trabalho do {% data variables.product.prodname_codeql %} para linguagens compiladas](/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-the-codeql-workflow-for-compiled-languages#adding-build-steps-for-a-compiled-language)". -Você pode rapidamente analisar pequenas partes de um monorepo ao modificar o código em diretórios específicos. Você deverá excluir diretórios nas suas etapas de criação e usar as palavras-chave `paths-ignore` e `caminhos` para [`on.`](https://help.github.com/actions/reference/workflow-syntax-for-github-actions#onpushpull_requestpaths) no seu arquivo de fluxo de trabalho. +Você pode rapidamente analisar pequenas partes de um monorepo ao modificar o código em diretórios específicos. Você deverá excluir diretórios nas suas etapas de criação e usar as palavras-chave `paths-ignore` e `caminhos` para [`on.`](https://docs.github.com/actions/reference/workflow-syntax-for-github-actions#onpushpull_requestpaths) no seu arquivo de fluxo de trabalho. #### Exemplo de arquivo de configuração diff --git a/translations/pt-BR/content/github/site-policy/github-ae-data-protection-agreement.md b/translations/pt-BR/content/github/site-policy/github-ae-data-protection-agreement.md index 77b0431692..1e73d26938 100644 --- a/translations/pt-BR/content/github/site-policy/github-ae-data-protection-agreement.md +++ b/translations/pt-BR/content/github/site-policy/github-ae-data-protection-agreement.md @@ -328,7 +328,7 @@ Exportador de dados: Cliente é o exportador de dados. No entanto, uma vez que o importador de dados fornece serviços de armazenamento e não controla as categorias de dados que armazena, o exportador de dados pode optar por transferir as categorias especiais de dados. Consequentemente, o exportador de dados é o único responsável por assegurar que cumpre todas as obrigações impostas por leis e regulamentos aplicáveis relativos à coleta e processamento de quaisquer categorias especiais de dados, incluindo a obtenção do consentimento explícito dos dados sujeitos antes de processar dados pessoais confidenciais. -**Processamento de operações:** Os dados pessoais transferidos estarão sujeitos às seguintes atividades básicas de processamento: O GitHub usa dados pessoais para fins limitados definidos na Declaração de Privacidade do GitHub, disponível em https://help.github.com/articles/github-privacy-statement/, e a seção "Processamento de Dados" da DPA. +**Processamento de operações:** Os dados pessoais transferidos estarão sujeitos às seguintes atividades básicas de processamento: O GitHub usa dados pessoais para fins limitados definidos na Declaração de Privacidade do GitHub, disponível em https://docs.github.com/articles/github-privacy-statement/, e a seção "Processamento de Dados" da DPA. **Subcontratantes:** De acordo com a DPA, o importador de dados pode contratar outras empresas para prestar serviços limitados em nome do importador de dados, tais como fornecer suporte ao cliente. Esses subcontratantes terão a permissão de obter Dados Pessoais do Cliente apenas para fornecer os serviços que o importador de dados os manteve para fornecer, e são proibidos de usar os Dados Pessoais do Cliente para qualquer outra finalidade. diff --git a/translations/pt-BR/content/github/site-policy/github-corporate-terms-of-service.md b/translations/pt-BR/content/github/site-policy/github-corporate-terms-of-service.md index d2c46ae272..2c1c905685 100644 --- a/translations/pt-BR/content/github/site-policy/github-corporate-terms-of-service.md +++ b/translations/pt-BR/content/github/site-policy/github-corporate-terms-of-service.md @@ -108,7 +108,7 @@ O Cliente é responsável por: (i) todo o Conteúdo publicado e a atividade que Em algumas situações, os termos de terceiros podem ser aplicados ao uso do GitHub pelo Cliente. Por exemplo, o Cliente pode ser integrante de uma Organização com seus próprios termos ou contratos de licença. O cliente poderá baixar um aplicativo que se integra ao Serviço ou utilizar o Serviço para autenticar em outro serviço. Embora este Contrato seja o acordo completo do GitHub com o Cliente, os termos de outras partes regem as relações delas com o Cliente. #### 5. EUA Termos do Governo Federal -Se o cliente é dos EUA. Se o Cliente for uma entidade do governo dos EUA ou que acessa ou usa o Serviço em instalações governamentais, a [Emenda do Governo Federal dos EUA](https://help.github.com/articles/amendment-to-github-terms-of-service-applicable-to-us-federal-government-users) se aplicará e o Cliente concorda com as disposições dela. Aplica-se a alteração do Governo Federal e o Cliente concorda com suas disposições. +Se o cliente é dos EUA. Se o Cliente for uma entidade do governo dos EUA ou que acessa ou usa o Serviço em instalações governamentais, a [Emenda do Governo Federal dos EUA](https://docs.github.com/articles/amendment-to-github-terms-of-service-applicable-to-us-federal-government-users) se aplicará e o Cliente concorda com as disposições dela. Aplica-se a alteração do Governo Federal e o Cliente concorda com suas disposições. #### 6. Acordo de Nível de Serviço de Nuvem Empresarial O compromisso trimestral de tempo de atividade do GitHub para o GitHub Enterprise Cloud é fornecido no [Contrato de Nível de Serviço Empresarial](/github/site-policy/github-enterprise-service-level-agreement). Se o cliente inscreveu-se no GitHub Enterprise Cloud, ele terá direito a um crédito de serviço se o GitHub não atender ao seu nível de serviço. diff --git a/translations/pt-BR/content/github/site-policy/github-data-protection-addendum.md b/translations/pt-BR/content/github/site-policy/github-data-protection-addendum.md index 84afabfc25..c1b0fdca6f 100644 --- a/translations/pt-BR/content/github/site-policy/github-data-protection-addendum.md +++ b/translations/pt-BR/content/github/site-policy/github-data-protection-addendum.md @@ -107,7 +107,7 @@ O GitHub fornecerá a assistência cabível ao Cliente com preocupações como a O GitHub não usará os Dados Protegidos para fins de publicidade de conteúdo de terceiros nem os venderá a terceiros, exceto como parte de uma fusão ou aquisição. #### 5.2 Declaração de Privacidade do GitHub. -A Declaração de Privacidade do GitHub, disponível publicamente em [https://help.github.com/articles/github-privacy-statement/](/articles/github-privacy-statement), fornece um aviso detalhado sobre as práticas de privacidade e uso de dados do GitHub, como o uso de cookies, o processo de resolução de disputas e mais informações sobre a conformidade do GitHub com a GDPR. +A Declaração de Privacidade do GitHub, disponível publicamente em [https://docs.github.com/articles/github-privacy-statement/](/articles/github-privacy-statement), fornece um aviso detalhado sobre as práticas de privacidade e uso de dados do GitHub, como o uso de cookies, o processo de resolução de disputas e mais informações sobre a conformidade do GitHub com a GDPR. ### 6. Transferência progressiva e subprocessamento. @@ -125,7 +125,7 @@ a. Qualquer subprocessador progressivo deve concordar por escrito em somente pr b. b. O GitHub restringirá o acesso do subprocessador progressivo a Dados pessoais do cliente apenas ao estritamente necessário para executar os serviços e proibirá o subprocessador de processar os Dados pessoais do cliente para qualquer outra finalidade. #### 6.4 - Divulgação de Acordos de Subprocessador. -O GitHub mantém uma lista de subprocessadores progressivos que utilizou para processar Dados Pessoais do Cliente em [https://help.github.com/articles/github-subprocessors-and-cookies/](/articles/github-subprocessors-and-cookies), incluindo as categorias de Dados Pessoais do Cliente processados, uma descrição do tipo de processamento que o subprocessador executa e a localização do seu processamento. Mediante solicitação por escrito do Cliente, o GitHub fornecerá esta lista de subprocessadores e os termos em que eles processarão os Dados pessoais do cliente. De acordo com as restrições de confidencialidade de subprocessadores, o GitHub pode remover informações confidenciais ou comercialmente confidenciais antes de fornecer a lista e os termos ao Cliente. Caso o GitHub não possa divulgar informações confidenciais ao Cliente, as Partes concordam que o GitHub fornecerá todas as informações razoavelmente possíveis relacionadas aos contratos de subprocessamento. +O GitHub mantém uma lista de subprocessadores progressivos que utilizou para processar Dados Pessoais do Cliente em [https://docs.github.com/articles/github-subprocessors-and-cookies/](/articles/github-subprocessors-and-cookies), incluindo as categorias de Dados Pessoais do Cliente processados, uma descrição do tipo de processamento que o subprocessador executa e a localização do seu processamento. Mediante solicitação por escrito do Cliente, o GitHub fornecerá esta lista de subprocessadores e os termos em que eles processarão os Dados pessoais do cliente. De acordo com as restrições de confidencialidade de subprocessadores, o GitHub pode remover informações confidenciais ou comercialmente confidenciais antes de fornecer a lista e os termos ao Cliente. Caso o GitHub não possa divulgar informações confidenciais ao Cliente, as Partes concordam que o GitHub fornecerá todas as informações razoavelmente possíveis relacionadas aos contratos de subprocessamento. #### 6.5 Objeção para subprocessadores. O GitHub fornecerá um aviso por escrito no prazo de 30 (trinta), além da remoção de qualquer subprocessador, incluindo as categorias listadas na Seção 6.4, anunciando mudanças no seu site . Se o Cliente tiver uma objeção razoável à utilização do GitHub em um novo subprocessador, deverá notificar o GitHub prontamente por escrito. Sempre que possível, o GitHub envidará esforços comercialmente razoáveis para fornecer uma solução alternativa ao Serviço afetado para evitar o processamento de dados pelo subprocessador questionável. Caso o GitHub não consiga oferecer uma solução alternativa e as Partes não resolvam o conflito em 90 (noventa) dias, o Cliente poderá rescindir o Contrato. diff --git a/translations/pt-BR/content/github/site-policy/github-enterprise-cloud-evaluation-agreement.md b/translations/pt-BR/content/github/site-policy/github-enterprise-cloud-evaluation-agreement.md index a5c9375fe2..fc67e76c46 100644 --- a/translations/pt-BR/content/github/site-policy/github-enterprise-cloud-evaluation-agreement.md +++ b/translations/pt-BR/content/github/site-policy/github-enterprise-cloud-evaluation-agreement.md @@ -10,7 +10,7 @@ OBRIGADO POR ESCOLHER O GITHUB PARA AS NECESSIDADES COMERCIAIS DE SUA EMPRESA. L ### 1. Termos de serviço corporativos -O cliente deve ter uma conta corporativa no GitHub.com para poder ter acesso de avaliação. A avaliação do Cliente do Enterprise Cloud será regida por estes termos e pelos Termos de Serviços Corporativos (encontrado em [https://docs.github.com/articles/github-corporate-terms-of-service](/articles/github-corporate-terms-of-service)) (juntamente com o "**Contrato de Avaliação**"). Entretanto, quaisquer termos suplementares associados ao [Adendo do Enterprise Cloud](https://help.github.com/articles/github-enterprise-cloud-addendum) **não se** aplicarão até o Cliente atualizar sua compra para uma assinatura paga do Enterprise Cloud.Quaisquer termos com a inicial em maiúscula não definidos neste Contrato de Avaliação são definidos nos Termos de serviço corporativos. +O cliente deve ter uma conta corporativa no GitHub.com para poder ter acesso de avaliação. A avaliação do Cliente do Enterprise Cloud será regida por estes termos e pelos Termos de Serviços Corporativos (encontrado em [https://docs.github.com/articles/github-corporate-terms-of-service](/articles/github-corporate-terms-of-service)) (juntamente com o "**Contrato de Avaliação**"). Entretanto, quaisquer termos suplementares associados ao [Adendo do Enterprise Cloud](https://docs.github.com/articles/github-enterprise-cloud-addendum) **não se** aplicarão até o Cliente atualizar sua compra para uma assinatura paga do Enterprise Cloud.Quaisquer termos com a inicial em maiúscula não definidos neste Contrato de Avaliação são definidos nos Termos de serviço corporativos. ### 2. Vigência e rescisão diff --git a/translations/pt-BR/content/github/site-policy/github-supplemental-terms-for-microsoft-volume-licensing.md b/translations/pt-BR/content/github/site-policy/github-supplemental-terms-for-microsoft-volume-licensing.md index f46c443b31..d497aef48b 100644 --- a/translations/pt-BR/content/github/site-policy/github-supplemental-terms-for-microsoft-volume-licensing.md +++ b/translations/pt-BR/content/github/site-policy/github-supplemental-terms-for-microsoft-volume-licensing.md @@ -109,7 +109,7 @@ Em algumas situações, os termos de terceiros podem ser aplicados ao uso do ser #### 2.1.5 Termos do Governo Federal do EUA. Termos do Governo Federal. -Se o cliente é dos EUA. Se o Cliente for uma agência do Governo Federal dos EUA ou que acessa ou usa qualquer parte do Serviço em instalações governamentais, a [Emenda do Governo Federal dos EUA](https://help.github.com/github/site-policy/amendment-to-github-terms-of-service-applicable-to-us-federal-government-users) se aplicará e o cliente concordará com as disposições dela. Aplica-se a alteração do Governo Federal e o Cliente concorda com suas disposições. +Se o cliente é dos EUA. Se o Cliente for uma agência do Governo Federal dos EUA ou que acessa ou usa qualquer parte do Serviço em instalações governamentais, a [Emenda do Governo Federal dos EUA](https://docs.github.com/github/site-policy/amendment-to-github-terms-of-service-applicable-to-us-federal-government-users) se aplicará e o cliente concordará com as disposições dela. Aplica-se a alteração do Governo Federal e o Cliente concorda com suas disposições. ### 2.2 Cumprimento das leis; Uso aceitável; Privacidade. diff --git a/translations/pt-BR/content/rest/overview/libraries.md b/translations/pt-BR/content/rest/overview/libraries.md index 1086cfdcd5..f143d63276 100644 --- a/translations/pt-BR/content/rest/overview/libraries.md +++ b/translations/pt-BR/content/rest/overview/libraries.md @@ -25,68 +25,123 @@ versions: ### Clojure -Library name | Repository |---|---| **Tentacles**| [Raynes/tentacles](https://github.com/Raynes/tentacles) +Library name | Repository +|---|---| +**Tentacles**| [Raynes/tentacles](https://github.com/Raynes/tentacles) ### Dart -Nome da biblioteca | Repositório |---|---| **github.dart** | [DirectMyFile/github.dart](https://github.com/DirectMyFile/github.dart) +Nome da biblioteca | Repositório +|---|---| +**github.dart** | [DirectMyFile/github.dart](https://github.com/DirectMyFile/github.dart) ### Emacs Lisp -Nome da biblioteca | Repositório |---|---| **gh.el** | [sigma/gh.el](https://github.com/sigma/gh.el) +Nome da biblioteca | Repositório +|---|---| +**gh.el** | [sigma/gh.el](https://github.com/sigma/gh.el) ### Erlang -Nome da biblioteca | Repositório |---|---| **octo-erl** | [sdepold/octo.erl](https://github.com/sdepold/octo.erl) +Nome da biblioteca | Repositório +|---|---| +**octo-erl** | [sdepold/octo.erl](https://github.com/sdepold/octo.erl) ### Go -Nome da biblioteca | Repositório |---|---| **go-github**| [google/go-github](https://github.com/google/go-github) +Nome da biblioteca | Repositório +|---|---| +**go-github**| [google/go-github](https://github.com/google/go-github) ### Haskell -Nome da biblioteca | Repositório |---|---| **haskell-github** | [fpco/Github](https://github.com/fpco/GitHub) +Nome da biblioteca | Repositório +|---|---| +**haskell-github** | [fpco/Github](https://github.com/fpco/GitHub) ### Java -Nome da biblioteca | Repositório | Mais informações |---|---|---| **GitHub Java API**| [org.eclipse.egit.github.core](https://github.com/eclipse/egit-github/tree/master/org.eclipse.egit.github.core) | É parte do [GitHub Mylyn Connector](https://github.com/eclipse/egit-github) e tem o objetivo de dar suporte a toda a API do GitHub v3. As construções estão disponíveis em [Maven Central](http://search.maven.org/#search%7Cga%7C1%7Ca%3A%22org.eclipse.egit.github.core%22). **GitHub API para Java**| [org.kohsuke.github (From github-api)](http://github-api.kohsuke.org/)|define uma representação orientada por objeto da API do GitHub. **JCabi GitHub API**|[github.jcabi.com (Personal Website)](http://github.jcabi.com)|é baseado Java7 JSON API (JSR-353), simplifica testes com uma amostra de tempo de execução do GitHub e abrange toda a API. +Nome da biblioteca | Repositório | Mais informações +|---|---|---| +**GitHub Java API**| [org.eclipse.egit.github.core](https://github.com/eclipse/egit-github/tree/master/org.eclipse.egit.github.core) | É parte do [GitHub Mylyn Connector](https://github.com/eclipse/egit-github) e tem o objetivo de dar suporte a toda a API do GitHub v3. As construções estão disponíveis em [Maven Central](http://search.maven.org/#search%7Cga%7C1%7Ca%3A%22org.eclipse.egit.github.core%22). +**GitHub API para Java**| [org.kohsuke.github (From github-api)](http://github-api.kohsuke.org/)|define uma representação orientada por objeto da API do GitHub. +**JCabi GitHub API**|[github.jcabi.com (Personal Website)](http://github.jcabi.com)|é baseado Java7 JSON API (JSR-353), simplifica testes com uma amostra de tempo de execução do GitHub e abrange toda a API. ### JavaScript -Nome da biblioteca | Repositório | |---|---| **NodeJS GitHub library**| [pksunkara/octonode](https://github.com/pksunkara/octonode) **gh3 client-side API v3 wrapper**| [k33g/gh3](https://github.com/k33g/gh3) **Github.js wrapper around the GitHub API**|[michael/github](https://github.com/michael/github) **Promise-Based CoffeeScript library for the Browser or NodeJS**|[philschatz/github-client](https://github.com/philschatz/github-client) +Nome da biblioteca | Repositório | +|---|---| +**NodeJS GitHub library**| [pksunkara/octonode](https://github.com/pksunkara/octonode) +**gh3 client-side API v3 wrapper**| [k33g/gh3](https://github.com/k33g/gh3) +**Github.js wrapper around the GitHub API**|[michael/github](https://github.com/michael/github) **Promise-Based CoffeeScript library for the Browser or NodeJS**|[philschatz/github-client](https://github.com/philschatz/github-client) ### Julia -Library name | Repository | |---|---| **GitHub.jl**|[WestleyArgentum/GitHub.jl](https://github.com/WestleyArgentum/GitHub.jl) +Library name | Repository | +|---|---| +**GitHub.jl**|[WestleyArgentum/GitHub.jl](https://github.com/WestleyArgentum/GitHub.jl) ### OCaml -Nome da biblioteca | Repositório | |---|---| **ocaml-github**|[mirage/ocaml-github](https://github.com/mirage/ocaml-github) +Nome da biblioteca | Repositório | +|---|---| +**ocaml-github**|[mirage/ocaml-github](https://github.com/mirage/ocaml-github) ### Perl -Library name | Repository | metacpan Website for the Library |---|---|---| **Pithub**|[plu/Pithub](https://github.com/plu/Pithub)|[Pithub CPAN](http://metacpan.org/module/Pithub) **Net::GitHub**|[fayland/perl-net-github](https://github.com/fayland/perl-net-github)|[Net:GitHub CPAN](https://metacpan.org/pod/Net::GitHub) +Library name | Repository | metacpan Website for the Library +|---|---|---| +**Pithub**|[plu/Pithub](https://github.com/plu/Pithub)|[Pithub CPAN](http://metacpan.org/module/Pithub) **Net::GitHub**|[fayland/perl-net-github](https://github.com/fayland/perl-net-github)|[Net:GitHub CPAN](https://metacpan.org/pod/Net::GitHub) ### PHP -Nome da biblioteca | Repositório |---|---| **GitHub PHP Client**|[tan-tan-kanarek/github-php-client](https://github.com/tan-tan-kanarek/github-php-client) **PHP GitHub API**|[KnpLabs/php-github-api](https://github.com/KnpLabs/php-github-api) **GitHub API**|[yiiext/github-api](https://github.com/yiiext/github-api) **GitHub Joomla! Package**|[joomla-framework/github-api](https://github.com/joomla-framework/github-api) **GitHub Nette Extension**|[kdyby/github](https://github.com/kdyby/github) **GitHub API Easy Access**|[milo/github-api](https://github.com/milo/github-api) **GitHub bridge for Laravel**|[GrahamCampbell/Laravel-GitHub](https://github.com/GrahamCampbell/Laravel-GitHub) **PHP7 Client & WebHook wrapper**|[FlexyProject/GitHubAPI](https://github.com/FlexyProject/GitHubAPI) +Nome da biblioteca | Repositório +|---|---| +**GitHub PHP Client**|[tan-tan-kanarek/github-php-client](https://github.com/tan-tan-kanarek/github-php-client) +**PHP GitHub API**|[KnpLabs/php-github-api](https://github.com/KnpLabs/php-github-api) +**GitHub API**|[yiiext/github-api](https://github.com/yiiext/github-api) +**GitHub Joomla! Package**|[joomla-framework/github-api](https://github.com/joomla-framework/github-api) **GitHub Nette Extension**|[kdyby/github](https://github.com/kdyby/github) +**GitHub API Easy Access**|[milo/github-api](https://github.com/milo/github-api) +**GitHub bridge for Laravel**|[GrahamCampbell/Laravel-GitHub](https://github.com/GrahamCampbell/Laravel-GitHub) +**PHP7 Client & WebHook wrapper**|[FlexyProject/GitHubAPI](https://github.com/FlexyProject/GitHubAPI) ### Python -Library name | Repository |---|---| **gidgethub**|[brettcannon/gidgethub](https://github.com/brettcannon/gidgethub) **ghapi**|[fastai/ghapi](https://github.com/fastai/ghapi) **PyGithub**|[PyGithub/PyGithub](https://github.com/PyGithub/PyGithub) **libsaas**|[duckboard/libsaas](https://github.com/ducksboard/libsaas) **github3.py**|[sigmavirus24/github3.py](https://github.com/sigmavirus24/github3.py) **sanction**|[demianbrecht/sanction](https://github.com/demianbrecht/sanction) **agithub**|[jpaugh/agithub](https://github.com/jpaugh/agithub) **octohub**|[turnkeylinux/octohub](https://github.com/turnkeylinux/octohub) **github-flask**|[github-flask (Official Website)](http://github-flask.readthedocs.org) **torngithub**|[jkeylu/torngithub](https://github.com/jkeylu/torngithub) +Library name | Repository +|---|---| +**gidgethub**|[brettcannon/gidgethub](https://github.com/brettcannon/gidgethub) +**ghapi**|[fastai/ghapi](https://github.com/fastai/ghapi) +**PyGithub**|[PyGithub/PyGithub](https://github.com/PyGithub/PyGithub) +**libsaas**|[duckboard/libsaas](https://github.com/ducksboard/libsaas) +**github3.py**|[sigmavirus24/github3.py](https://github.com/sigmavirus24/github3.py) +**sanction**|[demianbrecht/sanction](https://github.com/demianbrecht/sanction) +**agithub**|[jpaugh/agithub](https://github.com/jpaugh/agithub) +**octohub**|[turnkeylinux/octohub](https://github.com/turnkeylinux/octohub) +**github-flask**|[github-flask (Official Website)](http://github-flask.readthedocs.org) +**torngithub**|[jkeylu/torngithub](https://github.com/jkeylu/torngithub) ### Ruby -Nome da biblioteca | Repositório |---|---| **GitHub API Gem**|[peter-murach/github](https://github.com/peter-murach/github) **Ghee**|[rauhryan/ghee](https://github.com/rauhryan/ghee) +Nome da biblioteca | Repositório +|---|---| +**GitHub API Gem**|[peter-murach/github](https://github.com/peter-murach/github) +**Ghee**|[rauhryan/ghee](https://github.com/rauhryan/ghee) ### Rust -Nome da biblioteca | Repositório |---|---| **Octocrab**|[XAMPPRocky/octocrab](https://github.com/XAMPPRocky/octocrab) +Nome da biblioteca | Repositório +|---|---| +**Octocrab**|[XAMPPRocky/octocrab](https://github.com/XAMPPRocky/octocrab) ### Scala -Nome da biblioteca | Repositório |---|---| **Hubcat**|[softprops/hubcat](https://github.com/softprops/hubcat) **Github4s**|[47deg/github4s](https://github.com/47deg/github4s) +Nome da biblioteca | Repositório +|---|---| +**Hubcat**|[softprops/hubcat](https://github.com/softprops/hubcat) +**Github4s**|[47deg/github4s](https://github.com/47deg/github4s) ### Shell -Nome da biblioteca | Repositório |---|---| **ok.sh**|[whiteinge/ok.sh](https://github.com/whiteinge/ok.sh) +Nome da biblioteca | Repositório +|---|---| +**ok.sh**|[whiteinge/ok.sh](https://github.com/whiteinge/ok.sh) diff --git a/translations/pt-BR/data/ui.yml b/translations/pt-BR/data/ui.yml index 6c6b5845e9..f2260f755d 100644 --- a/translations/pt-BR/data/ui.yml +++ b/translations/pt-BR/data/ui.yml @@ -5,7 +5,7 @@ header: notices: ghae_silent_launch: GitHub AE is currently under limited release. Please contact our Sales Team to find out more. release_candidate: '# The version name is rendered before the below text via includes/header-notification.html '' is currently available as a release candidate. For more information, see "About upgrades to new releases."''' - localization_complete: Publicamos atualizações frequentes em nossa documentação, e a tradução desta página ainda pode estar em andamento. Para obter as informações mais recentes, acesse a documentação em inglês. Se houver problemas com a tradução desta página, entre em contato conosco. + localization_complete: Publicamos atualizações frequentes em nossa documentação, e a tradução desta página ainda pode estar em andamento. Para obter as informações mais recentes, acesse a documentação em inglês. Se houver problemas com a tradução desta página, entre em contato conosco. localization_in_progress: Olá! No momento, esta página ainda está sendo desenvolvida ou traduzida. Para obter as informações mais recentes, acesse a documentação em inglês. early_access: '📣 Please do not share this URL publicly. This page contains content about an early access feature.' search: diff --git a/translations/ru-RU/content/github/site-policy/github-ae-data-protection-agreement.md b/translations/ru-RU/content/github/site-policy/github-ae-data-protection-agreement.md index 1444d4681a..b893bb1210 100644 --- a/translations/ru-RU/content/github/site-policy/github-ae-data-protection-agreement.md +++ b/translations/ru-RU/content/github/site-policy/github-ae-data-protection-agreement.md @@ -328,7 +328,7 @@ Data exporter: Customer is the data exporter. However, because the data importer provides storage services and does not control the categories of data it stores, the data exporter may choose to transfer special categories of data. Consequently, the data exporter is solely responsible for ensuring that it complies with all obligations imposed by applicable laws and regulations relating to the collection and processing of any special categories of data, including obtaining the explicit consent of the data subject prior to processing sensitive personal data. -**Processing operations:** The personal data transferred will be subject to the following basic processing activities: GitHub uses personal data for the limited purposes set forth in the GitHub Privacy Statement, available at https://help.github.com/articles/github-privacy-statement/, and the “Data Processing” section of the DPA. +**Processing operations:** The personal data transferred will be subject to the following basic processing activities: GitHub uses personal data for the limited purposes set forth in the GitHub Privacy Statement, available at https://docs.github.com/articles/github-privacy-statement/, and the “Data Processing” section of the DPA. **Subcontractors:** In accordance with the DPA, the data importer may hire other companies to provide limited services on data importer’s behalf, such as providing customer support. Any such subcontractors will be permitted to obtain Customer Personal Data only to deliver the services the data importer has retained them to provide, and they are prohibited from using Customer Personal Data for any other purpose. diff --git a/translations/ru-RU/data/ui.yml b/translations/ru-RU/data/ui.yml index f29f6523f2..4b48fc7e1e 100644 --- a/translations/ru-RU/data/ui.yml +++ b/translations/ru-RU/data/ui.yml @@ -5,7 +5,7 @@ header: notices: ghae_silent_launch: GitHub AE is currently under limited release. Please contact our Sales Team to find out more. release_candidate: '# The version name is rendered before the below text via includes/header-notification.html '' is currently available as a release candidate. For more information, see "About upgrades to new releases."''' - localization_complete: We publish frequent updates to our documentation, and translation of this page may still be in progress. For the most current information, please visit the English documentation. If there's a problem with translations on this page, please let us know. + localization_complete: We publish frequent updates to our documentation, and translation of this page may still be in progress. For the most current information, please visit the English documentation. If there's a problem with translations on this page, please let us know. localization_in_progress: Hello, explorer! This page is under active development or still in translation. For the most up-to-date and accurate information, please visit our English documentation. early_access: '📣 Please do not share this URL publicly. This page contains content about an early access feature.' search: diff --git a/translations/zh-CN/content/github/getting-started-with-github/faq-about-changes-to-githubs-plans.md b/translations/zh-CN/content/github/getting-started-with-github/faq-about-changes-to-githubs-plans.md index 1f29e95815..209b194166 100644 --- a/translations/zh-CN/content/github/getting-started-with-github/faq-about-changes-to-githubs-plans.md +++ b/translations/zh-CN/content/github/getting-started-with-github/faq-about-changes-to-githubs-plans.md @@ -85,6 +85,6 @@ GitHub Community Support 包括通过我们的[社区论坛](https://github.comm ### How will this impact users and organizations in regions where U.S. government sanctions are applied? 政府制裁是否适用? -由于美国 Due to U.S. trade controls law restrictions, GitHub is unable to provide private repository services and paid services to accounts in U.S. sanctioned regions. GitHub has preserved, however, access to free public repository services. 请阅读 [GitHub 和贸易管制](https://help.github.com/github/site-policy/github-and-trade-controls)了解更多信息。 受制裁区域。 但是,GitHub 保留了对免费公共仓库服务的使用权。 请阅读 [GitHub 和贸易管制](/github/site-policy/github-and-trade-controls)了解更多信息。 +由于美国 Due to U.S. trade controls law restrictions, GitHub is unable to provide private repository services and paid services to accounts in U.S. sanctioned regions. GitHub has preserved, however, access to free public repository services. 请阅读 [GitHub 和贸易管制](https://docs.github.com/github/site-policy/github-and-trade-controls)了解更多信息。 受制裁区域。 但是,GitHub 保留了对免费公共仓库服务的使用权。 请阅读 [GitHub 和贸易管制](/github/site-policy/github-and-trade-controls)了解更多信息。 GitHub will continue advocating with U.S. regulators for the greatest possible access to free code collaboration services to developers in sanctioned regions, including free private repositories. We believe that offering those free services supports U.S. foreign policy of encouraging the free flow of information and free speech in those regions. 监管机构提倡让受制裁地区的开发者尽可能获得免费代码协作服务,包括访问免费私有仓库。 我们认为,提供这些免费服务有助于美国关于鼓励这些地区的信息自由流动和言论自由的外交政策。 关于鼓励这些市场的信息自由流动和言论自由的外交政策。 diff --git a/translations/zh-CN/content/github/site-policy/github-ae-data-protection-agreement.md b/translations/zh-CN/content/github/site-policy/github-ae-data-protection-agreement.md index 7879552159..b225166d72 100644 --- a/translations/zh-CN/content/github/site-policy/github-ae-data-protection-agreement.md +++ b/translations/zh-CN/content/github/site-policy/github-ae-data-protection-agreement.md @@ -328,7 +328,7 @@ For the purposes of Article 46 (2) of the General Data Protection Regulation (EU 但是,由于数据进口方提供存储服务,并且不控制其存储的数据类别,因此数据出口方可以选择传输特殊类别的数据。 所以,数据出口方应全权负责确保其遵守适用法律和法规规定的与收集和处理任何特殊类别数据有关的所有义务,包括在处理敏感个人数据之前获得数据主体的明确同意。 -**Processing operations:** The personal data transferred will be subject to the following basic processing activities: GitHub uses personal data for the limited purposes set forth in the GitHub Privacy Statement, available at https://help.github.com/articles/github-privacy-statement/, and the “Data Processing” section of the DPA. +**Processing operations:** The personal data transferred will be subject to the following basic processing activitiews: GitHub uses personal data for the limited purposes set forth in the GitHub Privacy Statement, available at https://docs.github.com/articles/github-privacy-statement/, and the “Data Processing” section of the DPA. **Subcontractors:** In accordance with the DPA, the data importer may hire other companies to provide limited services on data importer’s behalf, such as providing customer support. 任何此类分包商只能以提供数据进口商委托的服务为目的而获取客户个人数据,并且不得将客户个人数据用于任何其他目的。 diff --git a/translations/zh-CN/content/github/site-policy/github-data-protection-addendum.md b/translations/zh-CN/content/github/site-policy/github-data-protection-addendum.md index 886048eae4..3b58f8df28 100644 --- a/translations/zh-CN/content/github/site-policy/github-data-protection-addendum.md +++ b/translations/zh-CN/content/github/site-policy/github-data-protection-addendum.md @@ -107,7 +107,7 @@ GitHub 将根据 GitHub 安全附录第 2.3 条提供安全合规报告,并根 GitHub 不将受保护数据用于宣传第三方内容,也不向任何第三方销售受保护数据,因合并或收购而造成的数据转移除外。 #### 5.2 GitHub 隐私声明。 -“GitHub 隐私声明”公布在 [https://help.github.com/articles/github-privacy-statement/](/articles/github-privacy-statement) 上,详细说明 GitHub 的隐私和数据使用做法,包括对 cookie 的使用、争议解决流程以及 GitHub 的 GDPR 合规的进一步详情。 +“GitHub 隐私声明”公布在 [https://docs.github.com/articles/github-privacy-statement/](/articles/github-privacy-statement) 上,详细说明 GitHub 的隐私和数据使用做法,包括对 cookie 的使用、争议解决流程以及 GitHub 的 GDPR 合规的进一步详情。 ### 6. 再处理和向外传输。 diff --git a/translations/zh-CN/content/github/site-policy/github-enterprise-cloud-evaluation-agreement.md b/translations/zh-CN/content/github/site-policy/github-enterprise-cloud-evaluation-agreement.md index 7bf52a7d03..5d7f2ba12f 100644 --- a/translations/zh-CN/content/github/site-policy/github-enterprise-cloud-evaluation-agreement.md +++ b/translations/zh-CN/content/github/site-policy/github-enterprise-cloud-evaluation-agreement.md @@ -10,7 +10,7 @@ versions: ### 1. 公司服务条款 -客户必须在 GitHub.com 上拥有公司帐户才能获得评估权限。 客户对 Enterprise Cloud 的评估受这些条款和公司服务条款(见 [https://docs.github.com/articles/github-corporate-terms-of-service](/articles/github-corporate-terms-of-service))(统称为“**评估协议**”)的约束。 但是,在客户升级为付费订阅 Enterprise Cloud 之前,与 [Enterprise Cloud 附录](https://help.github.com/articles/github-enterprise-cloud-addendum)相关的任何补充条款**均不**适用。本评估协议中未定义的任何大写术语采用公司服务条款中的定义。 +客户必须在 GitHub.com 上拥有公司帐户才能获得评估权限。 客户对 Enterprise Cloud 的评估受这些条款和公司服务条款(见 [https://docs.github.com/articles/github-corporate-terms-of-service](/articles/github-corporate-terms-of-service))(统称为“**评估协议**”)的约束。 但是,在客户升级为付费订阅 Enterprise Cloud 之前,与 [Enterprise Cloud 附录](https://docs.github.com/articles/github-enterprise-cloud-addendum)相关的任何补充条款**均不**适用。本评估协议中未定义的任何大写术语采用公司服务条款中的定义。 ### 2. 期限与终止 diff --git a/translations/zh-CN/content/github/site-policy/github-supplemental-terms-for-microsoft-volume-licensing.md b/translations/zh-CN/content/github/site-policy/github-supplemental-terms-for-microsoft-volume-licensing.md index a0b08b029b..c39ec8f535 100644 --- a/translations/zh-CN/content/github/site-policy/github-supplemental-terms-for-microsoft-volume-licensing.md +++ b/translations/zh-CN/content/github/site-policy/github-supplemental-terms-for-microsoft-volume-licensing.md @@ -109,7 +109,7 @@ GitHub 保证,自首次下载之日起九十 (90) 天内,未经修改的软 #### 2.1.5 U.S. 联邦政府条款。 5. 美国联邦政府条款. -如果客户是美国 如果客户是美国联邦政府机构或者在政府部门访问或使用服务的任何部分,则[美国联邦政府修正](https://help.github.com/github/site-policy/amendment-to-github-terms-of-service-applicable-to-us-federal-government-users)适用,并且客户同意其条款。 联邦政府修正适用,并且客户同意其条款。 +如果客户是美国 如果客户是美国联邦政府机构或者在政府部门访问或使用服务的任何部分,则[美国联邦政府修正](https://docs.github.com/github/site-policy/amendment-to-github-terms-of-service-applicable-to-us-federal-government-users)适用,并且客户同意其条款。 联邦政府修正适用,并且客户同意其条款。 ### 2.2 遵守法律;可接受的使用;隐私。 diff --git a/translations/zh-CN/content/rest/overview/libraries.md b/translations/zh-CN/content/rest/overview/libraries.md index 2c64f6bf41..e34484ac7f 100644 --- a/translations/zh-CN/content/rest/overview/libraries.md +++ b/translations/zh-CN/content/rest/overview/libraries.md @@ -25,68 +25,123 @@ versions: ### Clojure -Library name | Repository |---|---| **Tentacles**| [Raynes/tentacles](https://github.com/Raynes/tentacles) +Library name | Repository +|---|---| +**Tentacles**| [Raynes/tentacles](https://github.com/Raynes/tentacles) ### Dart -Library name | Repository |---|---| **github.dart** | [DirectMyFile/github.dart](https://github.com/DirectMyFile/github.dart) +Library name | Repository +|---|---| +**github.dart** | [DirectMyFile/github.dart](https://github.com/DirectMyFile/github.dart) ### Emacs Lisp -Library name | Repository |---|---| **gh.el** | [sigma/gh.el](https://github.com/sigma/gh.el) +Library name | Repository +|---|---| +**gh.el** | [sigma/gh.el](https://github.com/sigma/gh.el) ### Erlang -Library name | Repository |---|---| **octo-erl** | [sdepold/octo.erl](https://github.com/sdepold/octo.erl) +Library name | Repository +|---|---| +**octo-erl** | [sdepold/octo.erl](https://github.com/sdepold/octo.erl) ### Go -Library name | Repository |---|---| **go-github**| [google/go-github](https://github.com/google/go-github) +Library name | Repository +|---|---| +**go-github**| [google/go-github](https://github.com/google/go-github) ### Haskell -Library name | Repository |---|---| **haskell-github** | [fpco/Github](https://github.com/fpco/GitHub) +Library name | Repository +|---|---| +**haskell-github** | [fpco/Github](https://github.com/fpco/GitHub) ### Java -Library name | Repository | More information |---|---|---| **GitHub Java API**| [org.eclipse.egit.github.core](https://github.com/eclipse/egit-github/tree/master/org.eclipse.egit.github.core) | Is part of the [GitHub Mylyn Connector](https://github.com/eclipse/egit-github) and aims to support the entire GitHub v3 API. 可在 [Maven Central](http://search.maven.org/#search%7Cga%7C1%7Ca%3A%22org.eclipse.egit.github.core%22) 中构建。 **用于 Java 的 GitHub API**| [org.kohsuke.github (From github-api)](http://github-api.kohsuke.org/)|定义面向对象的 GitHub API 表示形式。 **JCabi GitHub API**|[github.jcabi.com(个人网站)](http://github.jcabi.com)|基于 Java7 JSON API (JSR-353),简化 runtime GitHub stub 测试,涵盖整个 API。 +Library name | Repository | More information +|---|---|---| +**GitHub Java API**| [org.eclipse.egit.github.core](https://github.com/eclipse/egit-github/tree/master/org.eclipse.egit.github.core) | Is part of the [GitHub Mylyn Connector](https://github.com/eclipse/egit-github) and aims to support the entire GitHub v3 API. 可在 [Maven Central](http://search.maven.org/#search%7Cga%7C1%7Ca%3A%22org.eclipse.egit.github.core%22) 中构建。 +**用于 Java 的 GitHub API**| [org.kohsuke.github (From github-api)](http://github-api.kohsuke.org/)|定义面向对象的 GitHub API 表示形式。 +**JCabi GitHub API**|[github.jcabi.com(个人网站)](http://github.jcabi.com)|基于 Java7 JSON API (JSR-353),简化 runtime GitHub stub 测试,涵盖整个 API。 ### JavaScript -Library name | Repository | |---|---| **NodeJS GitHub library**| [pksunkara/octonode](https://github.com/pksunkara/octonode) **gh3 client-side API v3 wrapper**| [k33g/gh3](https://github.com/k33g/gh3) **Github.js wrapper around the GitHub API**|[michael/github](https://github.com/michael/github) **Promise-Based CoffeeScript library for the Browser or NodeJS**|[philschatz/github-client](https://github.com/philschatz/github-client) +Library name | Repository | +|---|---| +**NodeJS GitHub library**| [pksunkara/octonode](https://github.com/pksunkara/octonode) +**gh3 client-side API v3 wrapper**| [k33g/gh3](https://github.com/k33g/gh3) +**Github.js wrapper around the GitHub API**|[michael/github](https://github.com/michael/github) **Promise-Based CoffeeScript library for the Browser or NodeJS**|[philschatz/github-client](https://github.com/philschatz/github-client) ### Julia -Library name | Repository | |---|---| **GitHub.jl**|[WestleyArgentum/GitHub.jl](https://github.com/WestleyArgentum/GitHub.jl) +Library name | Repository | +|---|---| +**GitHub.jl**|[WestleyArgentum/GitHub.jl](https://github.com/WestleyArgentum/GitHub.jl) ### OCaml -Library name | Repository | |---|---| **ocaml-github**|[mirage/ocaml-github](https://github.com/mirage/ocaml-github) +Library name | Repository | +|---|---| +**ocaml-github**|[mirage/ocaml-github](https://github.com/mirage/ocaml-github) ### Perl -Library name | Repository | metacpan Website for the Library |---|---|---| **Pithub**|[plu/Pithub](https://github.com/plu/Pithub)|[Pithub CPAN](http://metacpan.org/module/Pithub) **Net::GitHub**|[fayland/perl-net-github](https://github.com/fayland/perl-net-github)|[Net:GitHub CPAN](https://metacpan.org/pod/Net::GitHub) +Library name | Repository | metacpan Website for the Library +|---|---|---| +**Pithub**|[plu/Pithub](https://github.com/plu/Pithub)|[Pithub CPAN](http://metacpan.org/module/Pithub) **Net::GitHub**|[fayland/perl-net-github](https://github.com/fayland/perl-net-github)|[Net:GitHub CPAN](https://metacpan.org/pod/Net::GitHub) ### PHP -Library name | Repository |---|---| **GitHub PHP Client**|[tan-tan-kanarek/github-php-client](https://github.com/tan-tan-kanarek/github-php-client) **PHP GitHub API**|[KnpLabs/php-github-api](https://github.com/KnpLabs/php-github-api) **GitHub API**|[yiiext/github-api](https://github.com/yiiext/github-api) **GitHub Joomla! Package**|[joomla-framework/github-api](https://github.com/joomla-framework/github-api) **GitHub Nette Extension**|[kdyby/github](https://github.com/kdyby/github) **GitHub API Easy Access**|[milo/github-api](https://github.com/milo/github-api) **GitHub bridge for Laravel**|[GrahamCampbell/Laravel-GitHub](https://github.com/GrahamCampbell/Laravel-GitHub) **PHP7 Client & WebHook wrapper**|[FlexyProject/GitHubAPI](https://github.com/FlexyProject/GitHubAPI) +Library name | Repository +|---|---| +**GitHub PHP Client**|[tan-tan-kanarek/github-php-client](https://github.com/tan-tan-kanarek/github-php-client) +**PHP GitHub API**|[KnpLabs/php-github-api](https://github.com/KnpLabs/php-github-api) +**GitHub API**|[yiiext/github-api](https://github.com/yiiext/github-api) +**GitHub Joomla! Package**|[joomla-framework/github-api](https://github.com/joomla-framework/github-api) **GitHub Nette Extension**|[kdyby/github](https://github.com/kdyby/github) +**GitHub API Easy Access**|[milo/github-api](https://github.com/milo/github-api) +**GitHub bridge for Laravel**|[GrahamCampbell/Laravel-GitHub](https://github.com/GrahamCampbell/Laravel-GitHub) +**PHP7 Client & WebHook wrapper**|[FlexyProject/GitHubAPI](https://github.com/FlexyProject/GitHubAPI) ### Python -Library name | Repository |---|---| **gidgethub**|[brettcannon/gidgethub](https://github.com/brettcannon/gidgethub) **ghapi**|[fastai/ghapi](https://github.com/fastai/ghapi) **PyGithub**|[PyGithub/PyGithub](https://github.com/PyGithub/PyGithub) **libsaas**|[duckboard/libsaas](https://github.com/ducksboard/libsaas) **github3.py**|[sigmavirus24/github3.py](https://github.com/sigmavirus24/github3.py) **sanction**|[demianbrecht/sanction](https://github.com/demianbrecht/sanction) **agithub**|[jpaugh/agithub](https://github.com/jpaugh/agithub) **octohub**|[turnkeylinux/octohub](https://github.com/turnkeylinux/octohub) **github-flask**|[github-flask (Official Website)](http://github-flask.readthedocs.org) **torngithub**|[jkeylu/torngithub](https://github.com/jkeylu/torngithub) +Library name | Repository +|---|---| +**gidgethub**|[brettcannon/gidgethub](https://github.com/brettcannon/gidgethub) +**ghapi**|[fastai/ghapi](https://github.com/fastai/ghapi) +**PyGithub**|[PyGithub/PyGithub](https://github.com/PyGithub/PyGithub) +**libsaas**|[duckboard/libsaas](https://github.com/ducksboard/libsaas) +**github3.py**|[sigmavirus24/github3.py](https://github.com/sigmavirus24/github3.py) +**sanction**|[demianbrecht/sanction](https://github.com/demianbrecht/sanction) +**agithub**|[jpaugh/agithub](https://github.com/jpaugh/agithub) +**octohub**|[turnkeylinux/octohub](https://github.com/turnkeylinux/octohub) +**github-flask**|[github-flask (Official Website)](http://github-flask.readthedocs.org) +**torngithub**|[jkeylu/torngithub](https://github.com/jkeylu/torngithub) ### Ruby -Library name | Repository |---|---| **GitHub API Gem**|[peter-murach/github](https://github.com/peter-murach/github) **Ghee**|[rauhryan/ghee](https://github.com/rauhryan/ghee) +Library name | Repository +|---|---| +**GitHub API Gem**|[peter-murach/github](https://github.com/peter-murach/github) +**Ghee**|[rauhryan/ghee](https://github.com/rauhryan/ghee) ### Rust -Library name | Repository |---|---| **Octocrab**|[XAMPPRocky/octocrab](https://github.com/XAMPPRocky/octocrab) +Library name | Repository +|---|---| +**Octocrab**|[XAMPPRocky/octocrab](https://github.com/XAMPPRocky/octocrab) ### Scala -Library name | Repository |---|---| **Hubcat**|[softprops/hubcat](https://github.com/softprops/hubcat) **Github4s**|[47deg/github4s](https://github.com/47deg/github4s) +Library name | Repository +|---|---| +**Hubcat**|[softprops/hubcat](https://github.com/softprops/hubcat) +**Github4s**|[47deg/github4s](https://github.com/47deg/github4s) ### Shell -Library name | Repository |---|---| **ok.sh**|[whiteinge/ok.sh](https://github.com/whiteinge/ok.sh) +Library name | Repository +|---|---| +**ok.sh**|[whiteinge/ok.sh](https://github.com/whiteinge/ok.sh) diff --git a/translations/zh-CN/content/rest/reference/teams.md b/translations/zh-CN/content/rest/reference/teams.md index 9886f75dca..86296bb3b8 100644 --- a/translations/zh-CN/content/rest/reference/teams.md +++ b/translations/zh-CN/content/rest/reference/teams.md @@ -16,7 +16,7 @@ versions: ## 讨论 -团队讨论 API 允许您获取、创建、编辑和删除团队页面上的讨论帖子。 您可以使用团队讨论进行不特定于存储库或项目的对话。 团队[组织](/rest/reference/orgs)的任何成员都可以创建和阅读公共讨论帖子。 有关详细信息,请参阅“[关于团队讨论](https://help.github.com/articles/about-team-discussions/)”。 要详细了解对讨论帖子的评论,请参阅[团队讨论评论 API](/rest/reference/teams#discussion-comments)。 此 API 仅适用于团队组织中经过身份验证的成员。 +团队讨论 API 允许您获取、创建、编辑和删除团队页面上的讨论帖子。 您可以使用团队讨论进行不特定于存储库或项目的对话。 团队[组织](/rest/reference/orgs)的任何成员都可以创建和阅读公共讨论帖子。 有关详细信息,请参阅“[关于团队讨论](https://docs.github.com/articles/about-team-discussions/)”。 要详细了解对讨论帖子的评论,请参阅[团队讨论评论 API](/rest/reference/teams#discussion-comments)。 此 API 仅适用于团队组织中经过身份验证的成员。 {% for operation in currentRestOperations %} {% if operation.subcategory == 'discussions' %}{% include rest_operation %}{% endif %} @@ -24,7 +24,7 @@ versions: ## 讨论评论 -团队讨论评论 API 允许您在[团队讨论](/rest/reference/teams#discussions)帖子上获取、 创建、编辑和删除讨论评论。 团队[组织](/rest/reference/orgs)的任何成员都可以创建和阅读公共讨论上的评论。 有关详细信息,请参阅“[关于团队讨论](https://help.github.com/articles/about-team-discussions/)”。 此 API 仅适用于团队组织中经过身份验证的成员。 +团队讨论评论 API 允许您在[团队讨论](/rest/reference/teams#discussions)帖子上获取、 创建、编辑和删除讨论评论。 团队[组织](/rest/reference/orgs)的任何成员都可以创建和阅读公共讨论上的评论。 有关详细信息,请参阅“[关于团队讨论](https://docs.github.com/articles/about-team-discussions/)”。 此 API 仅适用于团队组织中经过身份验证的成员。 {% for operation in currentRestOperations %} {% if operation.subcategory == 'discussion-comments' %}{% include rest_operation %}{% endif %} diff --git a/translations/zh-CN/data/ui.yml b/translations/zh-CN/data/ui.yml index 763fb0c90e..897926eaf6 100644 --- a/translations/zh-CN/data/ui.yml +++ b/translations/zh-CN/data/ui.yml @@ -5,7 +5,7 @@ header: notices: ghae_silent_launch: GitHub AE 目前是有限发行版。请联系我们的销售团队了解更多信息。 release_candidate: '# 版本名称是通过 includes/header-notification.html 在以下文本之前呈现:目前可用作发行版候选。更多信息请参阅“关于升级到新版本”。' - localization_complete: 我们经常发布文档更新,此页面的翻译可能仍在进行中。有关最新信息,请访问英文文档。如果此页面上的翻译有问题,请告诉我们。 + localization_complete: 我们经常发布文档更新,此页面的翻译可能仍在进行中。有关最新信息,请访问英文文档。如果此页面上的翻译有问题,请告诉我们。 localization_in_progress: 你好,探索者! 此页面正在积极开发或仍在翻译中。有关最新和最准确的信息,请访问我们的英文文档。 early_access: '📣请不要公开分享此 URL。此页包含有关早期访问功能的内容。' search: